<?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.1.0_5";
<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>variable_instance_set</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 explaining the function variable_instance_set"/>
<meta name="rh-index-keywords" content="variable_instance_set"/>
<meta name="search-keywords" content="variable_instance_set"/>
</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="variable_instance_set">
<span>variable_instance_set</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>variable_instance_set</h1>
<p>With this function you can set the value of a given variable in an instance. You supply the unique instance ID value (which can be found from the <a href="../../../The_Asset_Editors/Room_Properties/Layer_Properties.htm">Instance Properties</a> in the
room editor, or is returned when you call the function <a href="../Asset_Management/Instances/instance_create_layer.htm"><tt>instance_create_layer()</tt></a>) as well as the name of the variable to set the value of <i>as a string</i> (see example
code below), and then finally the value to set (can be any valid <a href="../../GML_Overview/Data_Types.htm">data type</a>). If the variable does not exist already in the instance it will be created and then assigned the value.</p>
<p> </p>
<h4>Syntax:</h4>
<p class="code">variable_instance_set(instance_id, name, val);</p>
<table>
<tbody>
<tr>
<th>Argument</th>
<th>Description</th>
</tr>
<tr>
<td>instance_id</td>
<td>The unique ID value of the instance to use</td>
</tr>
<tr>
<td>name</td>
<td>The name of the variable to set (as a string)</td>
</tr>
<tr>
<td>val</td>
<td>The value to set the variable to</td>
</tr>
</tbody>
</table>
<p> </p>
<h4>Returns:</h4>
<p class="code">N/A</p>
<p> </p>
<h4>Example:</h4>
<p class="code">if !variable_instance_exists(id, "shields")<br/> {
<br/> variable_instance_set(id, "shields", 0);<br/> }
</p>
<p>The above code will check to see if an instance variable exists in the calling instance and if it does not then it is created and set to 0.</p>
<p> </p>
<p> </p>
<p> </p>
<div class="footer">
<div class="buttons">
<div class="clear">
<div style="float:left">Back: <a href="Variable_Functions.htm">Variable Functions</a></div>
<div style="float:right">Next: <a href="variable_global_exists.htm">variable_global_exists</a></div>
</div>
</div>
<h5>© Copyright YoYo Games Ltd. 2020 All Rights Reserved</h5>
</div>
</body></html>