<?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_3";
<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_destroy</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_destroy"/>
<meta name="rh-index-keywords" content="instance_destroy"/>
<meta name="search-keywords" content="instance_destroy"/>
</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_destroy">
<span>instance_destroy</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_destroy</h1>
<p>You call this function whenever you wish to "destroy" an instance, normally triggering a <a href="../../../../The_Asset_Editors/Object_Properties/Object_Events.htm">Destroy Event</a> and also a <a href="../../../../The_Asset_Editors/Object_Properties/Object_Events.htm">Clean Up Event</a>.
This will remove it from the room until the room is restarted (unless the room is persistent). Calling the function with no arguments will simply destroy the instance that is currently in scope and running the code, but you can provide an optional
"id" argument and target a specific instance by using the instance <span class="inline"><a href="Instance_Variables/id.htm">id</a></span> value, or you can target all instances of a particular object by using an <a href="../Objects/object_index.htm"><tt>object_index</tt></a>.
For example:</p>
<p class="code">instance_destroy(other); // destroy the "other" instance in a Collision Event<br/> instance_destroy(obj_Bullet); // destroy ALL instances of the object "obj_Bullet"</p>
<p>The second <i>optional</i> flag permits you to "switch off" the Destroy Event for the instance being destroyed. By default the Destroy Event will <i>always</i> be performed, but if you set this flag to <tt>false</tt> then you can make the
instance destroy itself and skip performing that event.</p>
<p class="note"><b>IMPORTANT!</b> This will skip the Destroy Event, but the Clean Up event will still be called.</p>
<p>It is worth noting that when you destroy an instance, its destroy event is called <i>immediately</i> after the code or action that calls the destroy fucntion. Also, although the destroy event is performed, the instance <i>is not immediately removed from the game</i>,
and it will continue to perform the code contained in the current event. Only when the current event is over will it be removed from the game.</p>
<p>So, if you have, for example, this code:</p>
<p class="code">f hp <= 0 instance_destroy();<br/> score += 10;</p>
<p>The variable "score" will be incremented <i>even though the <tt>instance_destroy</tt> function has been called</i>, and the instance will finally be removed from your game at the end of the event. Be careful of this, as if you have (for example)
created a dynamic resource for the instance, like a data structure, and then have destroyed that resource in the destroy event, if there are any references to it after the destroy function or action has been performed then you will get an "unknown
resource" error, as the destroy event removed it from the game.</p>
<p> </p>
<h4>Syntax:</h4>
<p class="code">instance_destroy([id, execute_event_flag]);</p>
<table>
<tbody>
<tr>
<th>Argument</th>
<th>Description</th>
</tr>
<tr>
<td>id</td>
<td>The instance ID or object_index to destroy (optional, default is the calling instance)</td>
</tr>
<tr>
<td>execute_event_flag</td>
<td>Set to <tt>true</tt> or <tt>false</tt> to perform the destroy event or not (optional, default is <tt>true</tt>)</td>
</tr>
</tbody>
</table>
<p> </p>
<h4>Returns:</h4>
<p class="code">N/A</p>
<p> </p>
<h4>Example:</h4>
<p class="code">if bbox_right < 0 || bbox_left > room_width || bbox_bottom < 0 || bbox_top > room_height<br/> {
<br/> instance_destroy(id, false);<br/> }
</p>
<p>The above code will destroy the instance running the code without calling the Destroy Event if the instance is outside the room bounds.</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_exists.htm">instance_exists</a></div>
</div>
</div>
<h5>© Copyright YoYo Games Ltd. 2020 All Rights Reserved</h5>
</div>
</body></html>