-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'upstream/develop' into develop
- Loading branch information
Showing
11 changed files
with
456 additions
and
26 deletions.
There are no files selected for viewing
52 changes: 52 additions & 0 deletions
52
Manual/contents/GameMaker_Language/GML_Overview/Instance Keywords/all.htm
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| <?xml version="1.0" encoding="utf-8" ?> | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"> | ||
| <head> | ||
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | ||
| <title>all</title> | ||
| <meta name="generator" content="Adobe RoboHelp 2022" /> | ||
| <link rel="stylesheet" type="text/css" href="../../../assets/css/default.css" /> | ||
| <script src="../../../assets/scripts/main_script.js" type="module"></script> | ||
| <meta name="rh-authors" content="" /> | ||
| <meta name="topic-comment" content="" /> | ||
| <meta name="rh-index-keywords" content="all" /> | ||
| <meta name="search-keywords" content="all" /> | ||
| <meta name="template" content="assets/masterpages/Manual_Keyword_Page.htt" /> | ||
| </head> | ||
| <body> | ||
| <h1><span data-field="title" data-format="default">all</span></h1> | ||
| <p>This keyword is used to tell <span data-keyref="GameMaker Name">GameMaker</span> that a function is to be applied, or to check, <strong>all active instances</strong> within a room (deactivated instances will not be checked or accessed). You <b>cannot</b> use <span class="inline2">all</span> to access or set variables in other instances using the point method (see <a href="../Addressing_Variables_In_Other_Instances.htm">here</a>), but you <strong>can </strong>use it when using <span class="inline2"><a data-xref="{title}" href="../Language_Features/with.htm">with</a></span>, for example:</p> | ||
| <p class="code">with (all)<br /> | ||
| {<br /> | ||
| speed = 0;<br /> | ||
| }</p> | ||
| <p>The above code will set the speed of all instances in the room to 0. You can also use <span class="inline2">all</span> within functions to target or check all instances in the room for example:</p> | ||
| <p class="code">// Check a point for any active instance in the room<br /> | ||
| inst = instance_position(mouse_x, mouse_y, all);<br /> | ||
| <br /> | ||
| // Check all instances for a collision along a line<br /> | ||
| if collision_line(x, y, mouse_x, mouse_y, all, false, true) {}<br /> | ||
| <br /> | ||
| // Add all instances in the room into a motion planning grid<br /> | ||
| mp_grid_add_instances(grid, all, false); | ||
| </p> | ||
| <p><span class="inline2">all</span> is a very useful keyword and can be used in numerous situations within your code and actions, often cutting down on the amount of code you need to write to achieve a desired effect.</p> | ||
| <p> </p> | ||
| <p> </p> | ||
| <div class="footer"> | ||
| <div class="buttons"> | ||
| <div class="clear"> | ||
| <div>Back: <a data-xref="{title}" href="../Instance_Keywords.htm">Instance Keywords</a></div> | ||
| <div>Next: <a data-xref="{title}" href="noone.htm">noone</a></div> | ||
| </div> | ||
| </div> | ||
| <h5><span data-keyref="Copyright Notice">© Copyright YoYo Games Ltd. 2024 All Rights Reserved</span></h5> | ||
| </div> | ||
| <!-- KEYWORDS | ||
| all | ||
| --> | ||
| <!-- TAGS | ||
| all | ||
| --> | ||
| </body> | ||
| </html> |
53 changes: 53 additions & 0 deletions
53
Manual/contents/GameMaker_Language/GML_Overview/Instance Keywords/noone.htm
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| <?xml version="1.0" encoding="utf-8" ?> | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"> | ||
| <head> | ||
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | ||
| <title>noone</title> | ||
| <meta name="generator" content="Adobe RoboHelp 2022" /> | ||
| <link rel="stylesheet" type="text/css" href="../../../assets/css/default.css" /> | ||
| <script src="../../../assets/scripts/main_script.js" type="module"></script> | ||
| <meta name="rh-authors" content="" /> | ||
| <meta name="topic-comment" content="" /> | ||
| <meta name="rh-index-keywords" content="noone" /> | ||
| <meta name="search-keywords" content="noone" /> | ||
| <meta name="template" content="assets/masterpages/Manual_Keyword_Page.htt" /> | ||
| </head> | ||
| <body> | ||
| <h1><span data-field="title" data-format="default">noone</span></h1> | ||
| <p>It may seem odd, but many times while programming your games will you find the need to check if there are <strong>no instances</strong> found at a location, in a collision, etc. In those cases you would use this keyword to check for nothing, something like this:</p> | ||
| <p class="code">if (instance_nearest(x, y, obj_enemy) != noone)<br /> | ||
| {<br /> | ||
| //do something as there is an enemy instance near<br /> | ||
| }</p> | ||
| <p>In this example, the function <span class="inline3_func"><a data-xref="{title}" href="../../GML_Reference/Asset_Management/Instances/instance_nearest.htm">instance_nearest</a></span> will return either <span class="inline2" id="">noone</span> or the nearest found instance. Basically, any time that you need to check for an instance, you can expect to get either <span class="inline2" id="">noone</span> or an instance returned.</p> | ||
| <p>This can also be useful in combination with a <span class="inline2"><a data-xref="{title}" href="../Language_Features/with.htm">with</a></span> statement: </p> | ||
| <p class="code">with (instance_nearest(x, y, obj_enemy))<br /> | ||
| {<br /> | ||
| //do something as there is an enemy instance near<br /> | ||
| }</p> | ||
| <p>If the function returns an instance, the code between the curly braces <span class="inline2">{ }</span> will run once. If the function returns <span class="inline2">noone</span>, the code won't be executed.</p> | ||
| <p>You can also assign <span class="inline2">noone</span> as a value to a variable to store the result of such a function: </p> | ||
| <p class="code_heading">Create Event</p> | ||
| <p class="code">ins_last_collided_with = noone;</p> | ||
| <p class="code_heading">Collision Event</p> | ||
| <p class="code">ins_last_collided_with = other.id;</p> | ||
| <p> </p> | ||
| <p> </p> | ||
| <div class="footer"> | ||
| <div class="buttons"> | ||
| <div class="clear"> | ||
| <div>Back: <a data-xref="{title}" href="../Instance_Keywords.htm">Instance Keywords</a></div> | ||
| <div>Next: <a data-xref="{title}" href="self.htm">self</a></div> | ||
| </div> | ||
| </div> | ||
| <h5><span data-keyref="Copyright Notice">© Copyright YoYo Games Ltd. 2024 All Rights Reserved</span></h5> | ||
| </div> | ||
| <!-- KEYWORDS | ||
| noone | ||
| --> | ||
| <!-- TAGS | ||
| noone | ||
| --> | ||
| </body> | ||
| </html> |
143 changes: 143 additions & 0 deletions
143
Manual/contents/GameMaker_Language/GML_Overview/Instance Keywords/other.htm
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,143 @@ | ||
| <?xml version="1.0" encoding="utf-8" ?> | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"> | ||
| <head> | ||
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | ||
| <title>other</title> | ||
| <meta name="generator" content="Adobe RoboHelp 2022" /> | ||
| <link rel="stylesheet" type="text/css" href="../../../assets/css/default.css" /> | ||
| <script src="../../../assets/scripts/main_script.js" type="module"></script> | ||
| <meta name="rh-authors" content="" /> | ||
| <meta name="topic-comment" content="" /> | ||
| <meta name="rh-index-keywords" content="other" /> | ||
| <meta name="search-keywords" content="other" /> | ||
| <meta name="template" content="assets/masterpages/Manual_Keyword_Page.htt" /> | ||
| </head> | ||
| <body> | ||
| <h1><span data-field="title" data-format="default">other</span></h1> | ||
| <p><span class="inline2">other</span> has two definitions:</p> | ||
| <ul class="colour"> | ||
| <li>In Collision events, <span class="inline2">other</span> refers to the "other" instance that collided with the current instance.</li> | ||
| <li>Anywhere else, this is the previous scope before the <span class="inline2"><a href="self.htm">self</a></span> changed, for example, the instance or struct that executed a <span class="inline2"><a data-xref="{title}" href="../Language_Features/with.htm">with</a></span> statement or called a bound method. As such it is only useful in those specific cases and outside of those cases it remains the same as <span class="inline2">self</span>.</li> | ||
| </ul> | ||
| <p><span class="inline2">other</span> has multiple ways that it can be used to reference a specific instance or struct: it can be used in a <span class="inline2"><a data-xref="{title}" href="../Language_Features/with.htm">with</a></span> statement, in a <a href="../../../The_Asset_Editors/Object_Properties/Object_Events.htm">collision event</a>, or in a function. This page is going to explain the last two use cases.</p> | ||
| <h2>Collision Event</h2> | ||
| <p>A collision event can only happen between <strong>two </strong>instances. You <i>can</i> have multiple collisions between multiple instances, but they are all resolved by <span data-keyref="GameMaker Name">GameMaker</span> on a 1-on-1 basis, with the "self" instance that has the collision event and the "other" instance that is colliding with it.</p> | ||
| <p>Imagine you have a player instance, multiple enemy instances and multiple bullet instances that the enemy can fire at you. You can assign each enemy a single bullet instance but with a different damage variable randomly assigned to it when created, for example:</p> | ||
| <p class="code">var bullet;<br /> | ||
| bullet = instance_create_layer(x, y, "Bullets", obj_Bullet);<br /> | ||
| bullet.damage = 5 + irandom(5);<br /> | ||
| bullet.speed = 8;<br /> | ||
| bullet.direction = point_direction(x, y, obj_Player.x, obj_Player.y);</p> | ||
| <p>You can see how we set its variables using the dot notation as outlined in the section on <a href="../Addressing_Variables_In_Other_Instances.htm">Addressing Variables In Other Instances</a>. This will give each bullet instance a different damage value, but how will the player detect the damage that it has to take when it's hit by a bullet?</p> | ||
| <p>For this, the player will need to have a collision event with <span class="inline2">obj_Bullet</span>, and within that event use <span class="inline2">other</span> to read variables from the colliding bullet instance:</p> | ||
| <p class="code">hp -= other.damage;<br /> | ||
| if (hp <= 0) instance_destroy();</p> | ||
| <p>The above code will deduct the amount stored in the <i>other</i> instance's <span class="inline2">damage</span> variable from the player's <span class="inline2">hp</span> variable, then it will check to see if the <span class="inline2">hp</span> is lower than or equal to 0. If it is then it will destroy the player instance. Please note that the other instance must have the variable being checked or else an error will be thrown.</p> | ||
| <p class="note"><span data-conref="../../../assets/snippets/Tag_note.hts"> </span> The Collision event is the only event that has a special meaning for the <span class="inline2">other</span> keyword. In all other events and scripts, the behaviour of <span class="inline2">other</span> will be defined by the context it is being used in (such as a <span class="inline2">with()</span> block, a function, struct declaration, etc.).</p> | ||
| <p>You can assign values to variables, or even create new ones, using <span class="inline2">other</span> in the collision event, like this:</p> | ||
| <p class="code">// add ten to the other instance's "mana" variable<br /> | ||
| other.mana += 10;<br /> | ||
| // set the other instance variable "hit" to true, creating the variable if it doesn't already exist<br /> | ||
| other.hit = true;</p> | ||
| <h2 id="h">When 'other' changes</h2> | ||
| <p>The page on <span class="inline2"><a data-xref="{title}" href="self.htm">self</a></span> contains a section on <a data-xref="{text}" href="self.htm#h">When 'self' changes</a>.</p> | ||
| <p>This section will describe those cases in relation to how <span class="inline2">other</span> changes:</p> | ||
| <ul class="colour"> | ||
| <li>Inside a <span class="inline3_func"><a data-xref="{title}" href="../Language_Features/with.htm">with</a></span> block, <span class="inline2">other</span> will be the instance or struct that called the <span class="inline2">with()</span> function</li> | ||
| <li>When calling a <a href="../Method_Variables.htm">method</a> that is bound to an instance or a struct, <span class="inline2">other</span> will be the instance or struct that called that method</li> | ||
| <li>When calling an unbound constructor function, <span class="inline2">other</span> will be the instance or struct that called that function. If the constructor is bound as a method, then <span class="inline2">other</span> will be the instance or struct to which the constructor method is bound.</li> | ||
| <li>When stored as a reference through a struct literal, covered below under "<strong>'other' as a reference</strong>".</li> | ||
| </ul> | ||
| <h2>Struct Declaration</h2> | ||
| <p>Scope doesn't change inside a struct declaration, so <span class="inline2">other</span> refers to the same scope as <span class="inline2">self</span> (the <strong>current</strong> scope), meaning the struct or instance that's initialising the struct:</p> | ||
| <p class="code">var _struct =<br /> | ||
| {<br /> | ||
| parent_instance : other<br /> | ||
| }<br /> | ||
| <br /> | ||
| show_debug_message(_struct.parent_instance == self);<br /> | ||
| // This prints '1' (true) meaning that both sides refer to the same instance | ||
| </p> | ||
| <p>However, you do not need to use <span class="inline2">other</span> to read variables from the instance as any variables you reference directly will be read from that instance's scope, as described <a href="../Structs.htm#inst_in_struct">in this section</a> of the manual. You would only need to use this if you wanted to store a reference to that instance's struct.</p> | ||
| <h3 id="h1">'other' as a reference</h3> | ||
| <p>The page on <span class="inline2"><a data-xref="{title}" href="self.htm">self</a></span> contains a section on <a data-xref="{text}" href="self.htm#h1">'self' as a reference</a> with an example, which you should read before this section. This will cover that same example and how it would affect the <span class="inline2">other</span> reference.</p> | ||
| <p>Both rules covered on the aforementioned page regarding storing <span class="inline2">self</span> as a reference also apply to storing <span class="inline2">other</span> as a reference. However <span class="inline2">other</span> would be the previous <span class="inline2">self</span> as it would be if <span class="inline2">self</span> was stored.</p> | ||
| <p>Let's take that same example and replace <span class="inline2">self</span> with <span class="inline2">other</span>:</p> | ||
| <p class="code">name = "instance";<br /> | ||
| <br /> | ||
| struct = {<br /> | ||
| name : "struct",<br /> | ||
| other_ref : other,<br /> | ||
| other_name : other.name<br /> | ||
| }<br /> | ||
| <br /> | ||
| show_debug_message( struct.other_ref.name );<br /> | ||
| show_debug_message( struct.other_name ); | ||
| </p> | ||
| <p>This prints:</p> | ||
| <p class="code_plain">instance<br /> | ||
| instance</p> | ||
| <p>The base scope in the code example is an instance, so with <span class="inline2">self</span> changing in <span class="inline2">other_ref</span> it stays as the instance scope (which was the "previous" scope) and for <span class="inline2">other_name</span> it also remains the instance scope as the <span class="inline2">self</span> there is unchanged and there is no previous scope before the instance (as it is the base scope).</p> | ||
| <p>However, what would happen in the second case if there were another scope before the instance scope?</p> | ||
| <p>We can answer that question by placing this code inside a <span class="inline2">with()</span> block:</p> | ||
| <p class="code">name = "other_instance";<br /> | ||
| <br /> | ||
| with (inst)<br /> | ||
| {<br /> | ||
| name = "instance";<br /> | ||
| <br /> | ||
| struct = {<br /> | ||
| name : "struct",<br /> | ||
| other_ref : other,<br /> | ||
| other_name : other.name<br /> | ||
| }<br /> | ||
| <br /> | ||
| show_debug_message( struct.other_ref.name );<br /> | ||
| show_debug_message( struct.other_name );<br /> | ||
| } | ||
| </p> | ||
| <p>This prints:</p> | ||
| <p class="code_plain">instance<br /> | ||
| other_instance</p> | ||
| <p>In the first case, as <span class="inline2">self</span> changes to be the struct, the instance that is inside the <span class="inline2">with()</span> block becomes the previous scope and is stored in <span class="inline2">other</span>.</p> | ||
| <p>However in the second case, as <span class="inline2">self</span> remains the <span class="inline2">with()</span> instance, <span class="inline2">other</span> retains the scope before that, which is the base scope (<span class="inline2">"other_instance"</span>). You can visualise the hierarchy of scopes as such:</p> | ||
| <p class="code_plain">other_instance<br /> | ||
| > instance<br /> | ||
| > struct</p> | ||
| <p> </p> | ||
| <h2>Instance Method</h2> | ||
| <p>Using <span class="inline2">other</span> within another instance's <a href="../Method_Variables.htm">method</a> refers to the instance that called that method.</p> | ||
| <p>For example, let's say <span class="inline2">Object2</span> has a method that references <span class="inline2">self</span> and <span class="inline2">other</span>. This method is then called in <span class="inline2">Object1</span>. Since the method was created in <span class="inline2">Object2</span>, it is <strong>bound</strong> to it and will always use the <span class="inline2">Object2</span> instance as the "self", no matter which instance calls it. In such a case, the calling instance becomes <span class="inline2">other</span>.</p> | ||
| <p class="code">// In Object2<br /> | ||
| my_method = function()<br /> | ||
| {<br /> | ||
| show_debug_message(object_get_name(self.object_index));<br /> | ||
| show_debug_message(object_get_name(other.object_index));<br /> | ||
| }<br /> | ||
| <br /> | ||
| // In Object1<br /> | ||
| Object2.my_method(); | ||
| </p> | ||
| <p>This would cause the instance to first print its own object name ("Object2") and then the object name of the calling instance ("Object1").</p> | ||
| <p>The same will apply to a method that is bound to a struct.</p> | ||
| <p> </p> | ||
| <p> </p> | ||
| <p> </p> | ||
| <div class="footer"> | ||
| <div class="buttons"> | ||
| <div class="clear"> | ||
| <div>Back: <a data-xref="{title}" href="../Instance_Keywords.htm">Instance Keywords</a></div> | ||
| <div>Next: <a data-xref="{title}" href="all.htm">all</a></div> | ||
| </div> | ||
| </div> | ||
| <h5><span data-keyref="Copyright Notice">© Copyright YoYo Games Ltd. 2024 All Rights Reserved</span></h5> | ||
| </div> | ||
| <!-- KEYWORDS | ||
| other | ||
| --> | ||
| <!-- TAGS | ||
| other | ||
| --> | ||
| </body> | ||
| </html> |
Oops, something went wrong.