<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head>
<script type="text/javascript" language="JavaScript">
function reDo() {
if (innerWidth != origWidth || innerHeight != origHeight)
location.reload();
}
if ((parseInt(navigator.appVersion) == 4) && (navigator.appName == "Netscape")) {
origWidth = innerWidth;
origHeight = innerHeight;
onresize = reDo;
}
onerror = null;
</script>
<style type="text/css">
< !-- div.WebHelpPopupMenu {
position: absolute;
left: 0px;
top: 0px;
z-index: 4;
visibility: hidden;
}
p.WebHelpNavBar {
text-align: right;
}
-->
</style>
<script type="text/javascript">
gRootRelPath = "../../../..";
gCommonRootRelPath = "../../../..";
gTopicId = "9.2.2.13.2_13";
<script type="text/javascript" src="../../../../template/scripts/rh.min.js"></script>
<script type="text/javascript" src="../../../../template/scripts/common.min.js"></script>
<script type="text/javascript" src="../../../../template/scripts/topic.min.js"></script>
<script type="text/javascript" src="../../../../template/scripts/topicwidgets.min.js"></script>
<script type="text/javascript" src="../../../../whxdata/projectsettings.js"></script>
<link rel="stylesheet" type="text/css" href="../../../../template/styles/topic.min.css"/>
<link rel="stylesheet" type="text/css" href="../../../../template/Charcoal_Grey/topicheader.css"/>
<meta name="topic-status" content="Draft"/>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<title>instance_position</title>
<meta name="generator" content="Adobe RoboHelp 2019"/>
<link rel="stylesheet" href="../../../../assets/css/default.css" type="text/css"/>
<meta name="rh-authors" content="Mark Alexander"/>
<meta name="topic-comment" content="Page outlining the function instance_position"/>
<meta name="rh-index-keywords" content="instance_position"/>
<meta name="search-keywords" content="instance_position"/>
</head>
<body>
<div class="topic-header rh-hide" id="rh-topic-header" onclick="rh._.goToFullLayout()">
<div class="logo">
</div>
<div class="nav">
<div class="title" title="instance_position">
<span>instance_position</span>
</div>
<div class="gotohome" title="Click here to see this page in full context">
<span>Click here to see this page in full context</span>
</div>
</div>
</div>
<div class="topic-header-shadow rh-hide" id="rh-topic-header-shadow"></div>
<h1>instance_position</h1>
<p>With this function you can check a position for a collision with another instance or all instances of an object. When you use this you are checking a single point in the room for an instance or an object. This check will be done against the bounding
box of the instance or against the mask of the instance if that instance has precise collisions checked and will return the unique instance <a href="Instance_Variables/id.htm"><tt>id</tt></a>. If you do not need the id of the colliding instance you
should consider using <a href="../../Movement_And_Collisions/Collisions/position_meeting.htm"><tt>position_meeting()</tt></a> instead. This function also accepts the special <a href="../../../GML_Overview/Instance_Keywords.htm">keywords</a>
<span class="inline"><b>all</b></span> and <span class="inline"><b>other</b></span> and will return the keyword <span class="inline"><b>noone</b></span> if no collision occurs or the unique ID value of the instance found if a collision does occur.</p>
<p> </p>
<h4>Syntax:</h4>
<p class="code">instance_position( x, y, obj );</p>
<table>
<tbody>
<tr>
<th>Argument</th>
<th>Description</th>
</tr>
<tr>
<td>x</td>
<td>The x position to check for instances.</td>
</tr>
<tr>
<td>y</td>
<td>The y position to check for instances.</td>
</tr>
<tr>
<td>obj</td>
<td>The object to check for instances of.</td>
</tr>
</tbody>
</table>
<p> </p>
<h4>Returns:</h4>
<p class="code">Real (either an instance ID value or the keyword <tt>noone</tt>)</p>
<p> </p>
<h4>Example:</h4>
<p class="code">var inst;<br/> inst = instance_position(mouse_x, mouse_y, obj_Pause_Button);<br/> if (inst != noone)<br/> {
<br/> with (inst) image_index=1;<br/> instance_create_layer(room_width / 2, 0, "Controllers", obj_Menu);<br/> }
</p>
<p>The above code will check for a collision with an instance of "obj_Pause_Button" at the mouse position, and if there is one it will then use the returned id to set its image_index to a new value before creating a new instance of the object
"obj_Menu".</p>
<p> </p>
<p> </p>
<p> </p>
<div class="footer">
<div class="buttons">
<div class="clear">
<div style="float:left">Back: <a href="Instances.htm">Instances</a></div>
<div style="float:right">Next: <a href="instance_position_list.htm">instance_position_list</a></div>
</div>
</div>
<h5>© Copyright YoYo Games Ltd. 2020 All Rights Reserved</h5>
</div>
</body></html>