Skip to content

Commit

Permalink
Merge pull request #173 from YoYoGames/develop.gurpreet
Browse files Browse the repository at this point in the history 
Develop.gurpreet
  • Loading branch information
@gurpreetsinghmatharoo
gurpreetsinghmatharoo authored Sep 13, 2024
2 parents 1e36e5a + 7458eb9 commit 8f5fcf4
Show file tree
Hide file tree
Showing 325 changed files with 17,545 additions and 16,897 deletions.
4 changes: 2 additions & 2 deletions Manual/contents/Additional_Information/Guide_To_Using_Buffers.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ <h1><span data-field="title" data-format="default">Guide To Using Buffers</span>
<p>The actual code to create a buffer would look something like this:</p>
<p class="code">player_buffer = buffer_create(16384, buffer_fixed, 2);</p>
<p><br />
That would create a fixed buffer of 16384 bytes and byte-aligned to 2, with the function returning a unique ID value that is stored in a variable for later referencing of this buffer.</p>
That would create a fixed buffer of 16384 bytes and byte-aligned to 2, with the function returning a buffer handle that is stored in a variable for later referencing of this buffer.</p>
<p>When reading and writing data to a buffer, you do it in &quot;chunks&quot; of data defined by their &quot;data type&quot;. The &quot;data type&quot; sets the number of bytes allocated within the buffer for the value being written, and it is essential that you get this correct otherwise you will get some very strange results (or even errors) for your code.</p>
<p>Buffers are written to (and read from) <strong>sequentially</strong>, in that one piece of data is written after another, with each piece of data being of a set type. This means that you should ideally be aware of what data you are writing to the buffer at all times. These data types are defined in GML by the following constants:</p>
<div data-conref="../assets/snippets/buffer_data_type_constants.hts"> </div>
Expand Down Expand Up @@ -136,7 +136,7 @@ <h1><span data-field="title" data-format="default">Guide To Using Buffers</span>
<div style="float:right">Next: <a href="Bitwise_Operators.htm">Bitwise Operators</a></div>
</div>
</div>
<h5><span data-keyref="Copyright Notice">© Copyright YoYo Games Ltd. 2023 All Rights Reserved</span></h5>
<h5><span data-keyref="Copyright Notice">© Copyright YoYo Games Ltd. 2024 All Rights Reserved</span></h5>
</div>
<!-- KEYWORDS
Buffers
Expand Down
35 changes: 11 additions & 24 deletions Manual/contents/Drag_And_Drop/Drag_And_Drop_Overview/Applying_Actions_To_Other_Instances.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Applying Actions To Other Instances</title>
<meta name="generator" content="Adobe RoboHelp 2019" />
<meta name="generator" content="Adobe RoboHelp 2022" />
<link rel="stylesheet" href="../../assets/css/default.css" type="text/css" />
<script src="../../assets/scripts/main_script.js" type="module"></script>
<meta name="rh-authors" content="Mark Alexander" />
Expand All @@ -16,11 +16,8 @@
<!--<div class="body-scroll" style="top: 150px;">-->
<h1>Applying Actions To Other Instances</h1>
<p>Most actions in the GML Visual libraries have an option to apply the action in different ways. This is called setting the <strong>action scope</strong> and it can be one of several things:</p>
<p><img alt="GML Visual Applies To" class="center" src="../../assets/Images/Scripting_Reference/Drag_And_Drop/Overview/DnD_Applies_To.png" />Essentially what you are telling <span data-keyref="GameMaker Name">GameMaker</span> is the which instance should run the action. The default action scope
is <span class="inline">self</span>, which means that once the object is created as an instance in the room, that instance will run the action code. However this isn&#39;t always what you want, and you may want some actions to affect other, or even
all, instances in the room. This is where changing the action scope comes in.</p>
<p>The different scopes for performing actions are listed below, but it should be noted that changing the scope on an action in this way will only apply the new scope to that action <em>and not to subsequent actions in the chain</em>. If you want to apply
a change of action scope to multiple chained actions, then use the <a href="../Drag_And_Drop_Reference/Common/Apply_To...htm">Apply to...</a> action first.</p>
<p><img alt="GML Visual Applies To" class="center" src="../../assets/Images/Scripting_Reference/Drag_And_Drop/Overview/DnD_Applies_To.png" />Essentially what you are telling <span data-keyref="GameMaker Name">GameMaker</span> is the which instance should run the action. The default action scope is <span class="inline">self</span>, which means that once the object is created as an instance in the room, that instance will run the action code. However this isn&#39;t always what you want, and you may want some actions to affect other, or even all, instances in the room. This is where changing the action scope comes in.</p>
<p>The different scopes for performing actions are listed below, but it should be noted that changing the scope on an action in this way will only apply the new scope to that action <em>and not to subsequent actions in the chain</em>. If you want to apply a change of action scope to multiple chained actions, then use the <a href="../Drag_And_Drop_Reference/Common/Apply_To...htm">Apply to...</a> action first.</p>
<p> </p>
<p><img alt="Self Icon" class="icon" src="../../assets/Images/Scripting_Reference/Drag_And_Drop/Overview/i_Scope_Self.png" /><a class="dropspot" data-rhwidget="DropSpot" data-target="drop-down" href="#">Self</a></p>
<div class="droptext" data-targetname="drop-down">
Expand All @@ -29,35 +26,25 @@ <h1>Applying Actions To Other Instances</h1>
</div>
<p><img alt="Other Icon" class="icon" src="../../assets/Images/Scripting_Reference/Drag_And_Drop/Overview/i_Scope_Other.png" /><a class="dropspot" data-rhwidget="DropSpot" data-target="drop-down1" href="#">Other</a></p>
<div class="droptext" data-targetname="drop-down1">
<p class="dropspot">The <span class="inline">other</span> scope has two main functions, and the value it returns will depend on where and how you use it. In the <strong>Collision Event</strong>, <span class="inline">other</span> will return the unique instance ID value
(a unique value that is used to distinguish individual instances of every object), so you can, for example, create a &quot;bullet&quot; instance and have a collision event with a &quot;player&quot; instance and in that use the <span class="inline">other</span> scope to remove hit points from the &quot;player&quot; object and then return to <span class="inline">self</span> scope to destroy the &quot;bullet&quot; instance.</p>
<p class="dropspot">Outside of the collision event the <span class="inline">other</span> setting will behave as if it was set to <span class="inline">noone</span> unless it is being called from within a scoped block of actions. What this means is that if you change the
scope of a group of actions to a specific object, then while those actions are being called, the <span class="inline">other</span> scope will return the instance ID of the instance that initially called the action group. For example, you could run
an <a href="../Drag_And_Drop_Reference/Common/Apply_To...htm">Apply to...</a> action and then in the next code block set the scope to <span class="inline">other</span> to perform an action on the instance running the whole event block, and not the
instance that is being scoped in the apply to code blocks. The image below gives an example:</p>
<p class="dropspot"><img alt="GML Visual Scope" class="center" src="../../assets/Images/Scripting_Reference/Drag_And_Drop/Overview/DnD_Scope_Other.png" />In the image, we are checking for a mouse press in the instance, and if one is detected we change scope using the <strong>Apply To...</strong> action. The next two action blocks are now being called from the &quot;obj_Player&quot; instance (if there is more than one then it will run for all of them) and so the object will change its sprite and then create an object at the other position,
ie: the position of the object that is running the event and detected the mouse press.</p>
<p class="dropspot">The <span class="inline">other</span> scope has two main functions, and the value it returns will depend on where and how you use it. In the <strong>Collision Event</strong>, <span class="inline">other</span> will return the instance handle, so you can, for example, create a &quot;bullet&quot; instance and have a collision event with a &quot;player&quot; instance and in that use the <span class="inline">other</span> scope to remove hit points from the &quot;player&quot; object and then return to <span class="inline">self</span> scope to destroy the &quot;bullet&quot; instance.</p>
<p class="dropspot">Outside of the collision event the <span class="inline">other</span> setting will behave as if it was set to <span class="inline">noone</span> unless it is being called from within a scoped block of actions. What this means is that if you change the scope of a group of actions to a specific object, then while those actions are being called, the <span class="inline">other</span> scope will return the instance ID of the instance that initially called the action group. For example, you could run an <a href="../Drag_And_Drop_Reference/Common/Apply_To...htm">Apply to...</a> action and then in the next code block set the scope to <span class="inline">other</span> to perform an action on the instance running the whole event block, and not the instance that is being scoped in the apply to code blocks. The image below gives an example:</p>
<p class="dropspot"><img alt="GML Visual Scope" class="center" src="../../assets/Images/Scripting_Reference/Drag_And_Drop/Overview/DnD_Scope_Other.png" />In the image, we are checking for a mouse press in the instance, and if one is detected we change scope using the <strong>Apply To...</strong> action. The next two action blocks are now being called from the &quot;obj_Player&quot; instance (if there is more than one then it will run for all of them) and so the object will change its sprite and then create an object at the other position, ie: the position of the object that is running the event and detected the mouse press.</p>
<p class="dropspot"> </p>
</div>
<p><img alt="All Icon" class="icon" src="../../assets/Images/Scripting_Reference/Drag_And_Drop/Overview/i_Scope_All.png" /><a class="dropspot" data-rhwidget="DropSpot" data-target="drop-down2" href="#">All</a></p>
<div class="droptext" data-targetname="drop-down2">
<p class="dropspot">When you scope an action for all, you are telling <span data-keyref="GameMaker Name">GameMaker</span> to run that block for <strong>every single active instance within the current room</strong>. For example creating a <a href="../Drag_And_Drop_Reference/Instance/Destroy_Object_Instance.htm">Destroy Object Instance</a> action
and setting its scope to <span class="inline">all</span> will cause every instance in the room to disappear, no matter what object they have been created from.</p>
<p class="dropspot">When you scope an action for all, you are telling <span data-keyref="GameMaker Name">GameMaker</span> to run that block for <strong>every single active instance within the current room</strong>. For example creating a <a href="../Drag_And_Drop_Reference/Instance/Destroy_Object_Instance.htm">Destroy Object Instance</a> action and setting its scope to <span class="inline">all</span> will cause every instance in the room to disappear, no matter what object they have been created from.</p>
<p class="dropspot"> </p>
</div>
<p><img alt="Object Icon" class="icon" src="../../assets/Images/Scripting_Reference/Drag_And_Drop/Overview/i_Scope_Object.png" /><a class="dropspot" data-rhwidget="DropSpot" data-target="drop-down3" href="#">Object</a></p>
<div class="droptext" data-targetname="drop-down3">
<p class="dropspot">An action can also be given an <strong>object</strong> as it&#39;s scope. What this means is that all instances of the given object will run that action at the same time it is called. So if you have 100 enemy instances in the room, for example, and
you want to set them all to point towards a specific point. You&#39;d call the <a href="../Drag_And_Drop_Reference/Movement/Set_Point_Direction.htm">Set Point Direction</a> and set the action scope to the object &quot;obj_Enemy&quot; and when it
is called, all instances of that object will change direction.</p>
<p class="dropspot">An action can also be given an <strong>object</strong> as it&#39;s scope. What this means is that all instances of the given object will run that action at the same time it is called. So if you have 100 enemy instances in the room, for example, and you want to set them all to point towards a specific point. You&#39;d call the <a href="../Drag_And_Drop_Reference/Movement/Set_Point_Direction.htm">Set Point Direction</a> and set the action scope to the object &quot;obj_Enemy&quot; and when it is called, all instances of that object will change direction.</p>
<p class="dropspot"> </p>
</div>
<p><a class="dropspot" data-rhwidget="DropSpot" data-target="drop-down4" href="#">Expression</a></p>
<div class="droptext" data-targetname="drop-down4">
<p class="dropspot">The Expression input field is for you to input the ID of a specific instance that you want the action to work on. It can be the unique ID value assigned to an instance from the Room Editor or it can be the ID of an instance that you&#39;ve stored
in a variable (where the variable would be the input value) or it can even be an expression using code, as shown in the image below:</p>
<p class="dropspot"><img alt="GML Visual Target" class="center" src="../../assets/Images/Scripting_Reference/Drag_And_Drop/Overview/DnD_Scope_Target.png" />In this case, an instance calls the <a href="../Drag_And_Drop_Reference/Instance/Set_Sprite.htm">Set Sprite</a> from
the instance created by the code given for the Expression. Note that in this case, the instance being created will run its Create Event first before the action is applied to it.</p>
<p class="dropspot">The Expression input field is for you to input the ID of a specific instance that you want the action to work on. It can be the unique ID value assigned to an instance from the Room Editor or it can be the handle of an instance that you&#39;ve stored in a variable (where the variable would be the input value) or it can even be an expression using code, as shown in the image below:</p>
<p class="dropspot"><img alt="GML Visual Target" class="center" src="../../assets/Images/Scripting_Reference/Drag_And_Drop/Overview/DnD_Scope_Target.png" />In this case, an instance calls the <a href="../Drag_And_Drop_Reference/Instance/Set_Sprite.htm">Set Sprite</a> from the instance created by the code given for the Expression. Note that in this case, the instance being created will run its Create Event first before the action is applied to it.</p>
<p class="dropspot"> </p>
</div>
<p> </p>
Expand All @@ -70,7 +57,7 @@ <h1>Applying Actions To Other Instances</h1>
<div style="float:right">Next: <a href="Action_Block_Functions.htm">Action Block Scripts</a></div>
</div>
</div>
<h5><span data-keyref="Copyright Notice">© Copyright YoYo Games Ltd. 2021 All Rights Reserved</span></h5>
<h5><span data-keyref="Copyright Notice">© Copyright YoYo Games Ltd. 2024 All Rights Reserved</span></h5>
</div>
<!-- KEYWORDS
GML Visual Applying Actions
Expand Down
11 changes: 7 additions & 4 deletions Manual/contents/GameMaker_Language/GML_Overview/Data_Types.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,10 +81,13 @@ <h1><span data-field="title" data-format="default">Data Types</span></h1>
</ul>
<p class="dropspot">You get a handle when you create a new resource (with a <span class="inline2">_create()</span> function) or reference an existing resource in your code (like referencing an object, getting an instance through a function, etc.).</p>
<p class="dropspot">A handle is a 64-bit integer, where the first 32 bits contain information about the type of resource, and the next 32 bits contain the index number of the resource.</p>
<p class="dropspot">If you convert the handle to a number (using <span class="inline3_func"><a data-xref="{title}" href="../GML_Reference/Strings/real.htm">real</a></span> or <span class="inline3_func"><a data-xref="{title}" href="../GML_Reference/Variable_Functions/int64.htm">int64</a></span>), you get the index number.</p>
<p class="dropspot">The type information in a handle is used to make sure that you pass the correct type of resource into a function (e.g. making sure you pass a DS list into <span class="inline3_func"><a data-xref="{title}" href="../GML_Reference/Data_Structures/DS_Lists/ds_list_add.htm">ds_list_add</a></span> instead of a DS map, grid or something else).</p>
<p class="dropspot" style="text-align: left; ">If you convert a handle to a string or print it as an output, you will see a string in the format <span data-conref="../../assets/snippets/Handle_Format.hts"> </span>, e.g. <span class="inline2">&quot;ref ds_list 1&quot;</span>.</p>
<p class="dropspot">You can convert a string that&#39;s correctly formatted as <span data-conref="../../assets/snippets/Handle_Format.hts"> </span> back to a handle using the <span class="inline3_func"><a data-xref="{title}" href="../GML_Reference/Variable_Functions/handle.htm">handle_parse</a></span> function.</p>
<p class="dropspot">The type information in a handle is used to make sure that you pass the correct type of resource into a function (e.g. making sure you pass a DS list into <span class="inline3_func"><a data-xref="{title}" href="../GML_Reference/Data_Structures/DS_Lists/ds_list_add.htm">ds_list_add</a></span> instead of a DS map, DS grid or some other incompatible resource).</p>
<h3>Usage Notes</h3>
<ul class="colour">
<li class="dropspot">If you convert a handle to a number (using <span class="inline3_func"><a data-xref="{title}" href="../GML_Reference/Strings/real.htm">real</a></span> or <span class="inline3_func"><a data-xref="{title}" href="../GML_Reference/Variable_Functions/int64.htm">int64</a></span>) you will get the index number for the resource. This index number is also recycled, e.g. if you destroy a DS List with index <span class="inline2">0</span> and later create a new DS List, that same index <span class="inline2">0</span> will be reused. This means that any old variables holding a reference to the destroyed list will now hold a <em>new</em> active list, which may be unintended and so it is good practice to reset a handle variable to <span class="inline2">undefined</span> after destroying its resource if it continues to be used after destruction.</li>
<li class="dropspot">If you convert a handle to a string or print it as an output, you will see a string in the format <span data-conref="../../assets/snippets/Handle_Format.hts"> </span>, e.g. <span class="inline2">&quot;ref ds_list 1&quot;</span>.</li>
<li class="dropspot">You can convert a string that&#39;s correctly formatted as <span data-conref="../../assets/snippets/Handle_Format.hts"> </span> back to a handle using the <span class="inline3_func"><a data-xref="{title}" href="../GML_Reference/Variable_Functions/handle.htm">handle_parse</a></span> function.</li>
</ul>
<p class="dropspot"> </p>
</div>
<p><a class="dropspot" data-rhwidget="DropSpot" data-target="drop-down5" href="#">Hexadecimal Literals</a></p>
Expand Down
Loading

0 comments on commit 8f5fcf4

Please sign in to comment.