https://sourceforge.net/p/hpg-projects/wiki/Instance/Recent changes to InstanceenFri, 20 Jan 2023 12:16:59 -0000https://sourceforge.net/p/hpg-projects/wiki/Instance/<div class="markdown_content"><p>In ENIGMA, an <a class="" href="../instance" title="wikilink">instance</a> refers to an actual<br/> instance, or representation, or copy, if you will, of an<br/> <a class="" href="../object" title="wikilink">object</a>. An instance is to an object as you are to<br/> the human species. An object can have any number of instances, each<br/> functioning independently of one another with their own set of <a class="" href="../locals" title="wikilink">local<br/> variables</a>.</p> <h2 id="uses">Uses</h2> <p>When an object is created and its behavior programmed (e.g. a bullet),<br/> then when it is created in the game that is an instance of that object.<br/> So when a player shoots, then every bullet is its own instance.</p> <h2 id="built-in-variables">Built-in variables</h2> <p>Every instance have built in variables that are local to the instance<br/> itself. They are updated automatically or can be set.</p> <ul> <li>x - x position of the instance.</li> <li>y - y position of the instance.</li> <li>xprevious - x position the instance was in the previous step.</li> <li>yprevious - y position the instance was in the previous step.</li> <li>direction - This is the direction of the instance. Its position is<br/> updated every step according to the speed and direction.</li> <li>speed - The amount of pixels the instance will move every step in<br/> the set direction.</li> <li>hspeed - Horizontal speed component. It changes automatically<br/> according to the speed and direction.</li> <li>vspeed - Vertical speed component. It also changes according to the<br/> speed and direction.</li> <li>friction - Amount of speed the instance will lose every step.</li> <li>gravity - Amount of gravity in pixels per second.</li> <li>gravity_direction - The direction gravity will pull.</li> <li>solid - Whether the instance is solid or not.</li> <li>persistent - Whether the instance is persistent.</li> <li>object_index<strong>*</strong> - Index of the object this is an instance of.</li> <li>id<strong>*</strong> - The unique identifier for the instance (&gt;= 100000).</li> </ul> <p><strong>*</strong>These variables are constant and cannot be changed.</p> <h2 id="functions">Functions</h2> <ul> <li> <p>- Create an instance of the specified object at the position (x,y).</p> </li> <li> <p>- Destroys the calling instance.</p> </li> <li> <p>- Returns whether an instance of type obj exists. obj can be an<br/> object, an instance id, or the keyword all.</p> </li> <li> <p>- Returns the id of the (n+1)'th instance of type obj. obj can be<br/> an object or the keyword all.</p> </li> <li> <p>- Returns the number of instances of type obj. obj can be an object<br/> or the keyword all.</p> </li> <li> <p>- Returns the id of the instance of type obj furthest away from<br/> (x,y). obj can be an object or the keyword all.</p> </li> <li> <p>- Returns the id of the instance of type obj nearest to (x,y). obj<br/> can be an object or the keyword all.</p> </li> <li> <p>- Returns the id of the instance of type obj at position (x,y).<br/> When multiple instances are at that position the first is returned.<br/> obj can be an object or the keyword all.</p> </li> <li> <p>- Returns the id of the instance of type obj met when the current<br/> instance is placed at position (x,y). obj can be an object or the<br/> keyword all.</p> </li> </ul></div>Hugh GreeneFri, 20 Jan 2023 12:16:59 -0000https://sourceforge.netd930c377ae56d99b3f7d8b1eef4600a1a315e268