2024.6

Manual/_page_generation/Template_Code_Page.htm

@@ -19,7 +19,7 @@ <h1><span data-field="title" data-format="default">INSERT_TITLE</span></h1>
   <p>Additional Information Goes Here.</p>
   <p> </p>
   <h4>Syntax:</h4>
-  <p class="code">keyword_name(arguments);</p>
+  <p class="code"><span data-field="title" data-format="default"></span>(arguments);</p>
   <table>
     <colgroup>
       <col />

Manual/contents/GameMaker_Language/GML_Overview/Accessors.htm

@@ -105,7 +105,7 @@ <h1><span data-field="title" data-format="default">Accessors</span></h1>
   <div class="droptext" data-targetname="drop-down16">
     <p class="dropspot"><span>The struct accessor uses the <span class="inline2"><a id="$"></a>$</span> sign as the identifier symbol. This makes the accessor syntax for <a href="Structs.htm">structs</a>: </span></p>
     <p class="code">struct[$ &quot;name&quot;]</p>
-    <p class="dropspot">This accessor is essentially a wrapper for the functions <span><a href="../GML_Reference/Variable_Functions/variable_struct_get.htm"><span class="inline2">variable_struct_get()</span></a> and <a href="../GML_Reference/Variable_Functions/variable_struct_set.htm"><span class="inline2">variable_struct_set()</span></a>, and <span class="inline3_func"><a data-xref="{title}" href="../GML_Reference/Variable_Functions/variable_global_get.htm">variable_global_get</a></span> and <span class="inline3_func"><a data-xref="{title}" href="../GML_Reference/Variable_Functions/variable_global_set.htm">variable_global_set</a></span> if you access <a data-xref="{text}" href="Variables/Global_Variables.htm#the_global_struct">The Global Struct</a> using the <span class="inline2">global</span> keyword.</span></p>
+    <p class="dropspot">This accessor is essentially a wrapper for the functions <span class="inline3_func"><a data-xref="{title}" href="../GML_Reference/Variable_Functions/variable_struct_get.htm">struct_get</a></span><span> and <span class="inline3_func"><a data-xref="{title}" href="../GML_Reference/Variable_Functions/variable_struct_set.htm">struct_set</a></span>, and <span class="inline3_func"><a data-xref="{title}" href="../GML_Reference/Variable_Functions/variable_global_get.htm">variable_global_get</a></span> and <span class="inline3_func"><a data-xref="{title}" href="../GML_Reference/Variable_Functions/variable_global_set.htm">variable_global_set</a></span> if you access <a data-xref="{text}" href="Variables/Global_Variables.htm#the_global_struct">The Global Struct</a> using the <span class="inline2">global</span> keyword.</span></p>
     <p class="dropspot"><span>You would use it much like the accessor for a DS map. For example, if you have created a struct and want to retrieve a value from a variable called &quot;my_health&quot; then you&#39;d do:</span></p>
     <p class="code">var _hp = struct[$ &quot;my_health&quot;];</p>
     <p class="dropspot">As you can see, you don&#39;t supply the variable itself, but rather a <em>string</em> with the variable&#39;s name.</p>
@@ -178,7 +178,7 @@ <h1><span data-field="title" data-format="default">Accessors</span></h1>
         <div style="float:right">Next: <a data-xref="{title}" href="Language_Features.htm">Language Features</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
 div

Manual/contents/GameMaker_Language/GML_Overview/Language_Features/If_Else_and_Conditional_Operators.htm

@@ -68,7 +68,7 @@ <h2>Grouping Expressions &amp; Statements</h2>
         variable = true;<br />
     }
   </p>
-  <p>Note that while this is slightly more verbose, it means that there is no ambiguity in the code and that it will compile correctly on ail platforms at all times. However, the initial example may not, as explained on the section in the <a href="../Expressions_And_Operators.htm">Expressions And Operators</a> page.</p>
+  <p>Note that while this is slightly more verbose, it means that there is no ambiguity in the code and that it will compile correctly on all platforms at all times. However, the initial example may not, as explained on the section in the <a href="../Expressions_And_Operators.htm">Expressions And Operators</a> page.</p>
   <p class="note"><span data-conref="../../../assets/snippets/Tag_note.hts"> </span> When comparing two values to see if they are equal, you should use the &quot;<span class="inline">==</span>&quot; operator, and only use the &quot;<span class="inline">=</span>&quot; one for assignment. Currently GameMaker will treat them as interchangeable, but this may change in the future and your code is cleaner and more obvious when using the correct operators for comparisons and assignments.</p>
   <p>To give a proper example of using <span class="inline">if</span>, consider the following code which will move an instance towards the position <span class="inline">x=200</span> in the room when placed in the Step Event:</p>
   <p class="code">if (x &lt; 200)<br />
@@ -89,7 +89,7 @@ <h2>Compound Checks</h2>
   <p>Here we are checking using the <span class="inline">&amp;&amp;</span> &quot;and&quot; operator, so it&#39;s checking if <em>both </em>of the conditions in the <span class="inline">if</span> evaluate to <span class="inline">true</span>, and if the first one is <span class="inline">false</span> then the second one won&#39;t even be checked.</p>
   <p>This is called &quot;short circuiting&quot; the code, so when combining expressions to check, you should ensure that the &quot;cheapest&quot; one for performance is always the first to avoid evaluating the more expensive ones if the first evaluates to <span class="inline">false</span>.</p>
   <p>In a similar vein, if a condition will can be evaluated as <span class="inline">true</span> or <span class="inline">false</span> at compile time, then the entire condition will be removed from the code, for example, say you have a <a href="../Variables/Constants.htm">macro</a> <span class="inline">DEBUG_ON</span> for debugging and it can be either <span class="inline">true</span> or <span class="inline">false</span> - when it is set to <span class="inline">false</span> then the following code block will be stripped from the game when it is compiled:</p>
-  <p class="code">if (DEBUG_ON == true) <br />
+  <p class="code">if (DEBUG_ON == true)<br />
     {<br />
         show_debug_message(&quot;Instances = &quot; + string(instance_count));<br />
     }</p>
@@ -115,7 +115,7 @@ <h2>Ternary Operators</h2>
         <div style="float:right">Next: <a data-xref="{title}" href="../Addressing_Variables_In_Other_Instances.htm">Addressing Variables In Other Instances</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
 if

Manual/contents/GameMaker_Language/GML_Overview/Language_Features/do___until.htm

@@ -4,18 +4,18 @@
 <head>
   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   <title>do / until</title>
-  <meta name="generator" content="Adobe RoboHelp 2020" />
+  <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" />
-  <meta name="topic-comment" content="Page outlining the do / until functions" />
+  <meta name="topic-comment" content="Page outlining the do / until loop" />
   <meta name="rh-index-keywords" content="do,until" />
   <meta name="search-keywords" content="do,until" />
 </head>
 <body>
   <!--<div class="body-scroll" style="top: 150px;">-->
-  <h1>do / until</h1>
-  <p>A <span class="inline">do</span> function is another way of iterating over one or more <a class="glossterm" data-glossterm="statement" href="#">statement</a><span class="glossextra">s</span> multiple times, and is really a &quot;<span class="inline">do... until</span>&quot; statement as you cannot have one without the other since you are telling <span data-keyref="GameMaker Name">GameMaker</span> to do something until a specific <a class="glossterm" data-glossterm="expression" href="#">expression</a> returns <span class="inline">true</span>. It has this form:</p>
+  <h1><span data-field="title" data-format="default">do / until</span></h1>
+  <p>A <span class="inline">do</span> statement is another way of iterating over one or more <a class="glossterm" data-glossterm="statement" href="#">statement</a><span class="glossextra">s</span> multiple times, and is really a &quot;<span class="inline">do... until</span>&quot; statement as you cannot have one without the other since you are telling <span data-keyref="GameMaker Name">GameMaker</span> to do something until a specific <a class="glossterm" data-glossterm="expression" href="#">expression</a> returns <span class="inline">true</span>. It has this form:</p>
   <p class="code">do<br />
     {<br />
         &lt;statement&gt;;<br />
@@ -30,16 +30,16 @@ <h1>do / until</h1>
         y = random(room_height);<br />
     }<br />
     until (place_free(x, y));</p>
-  <p>The above code tries to place the current object at a free position and will set the x/y variables at least once, and then perform as many <a class="glossterm" data-glossterm="iteration" href="#">iteration</a><span class="glossextra">s</span> as required until the <span class="inline">place_free()</span> expression returns <span class="inline">true</span>.</p>
+  <p>The above code tries to place the current object at a free position and will set the x and y variables at least once, and then perform as many <a class="glossterm" data-glossterm="iteration" href="#">iteration</a><span class="glossextra">s</span> as required until the <span class="inline">place_free()</span> expression returns <span class="inline">true</span>.</p>
   <p><strong>When should you use a <span class="inline">do</span> / <span class="inline">until</span> loop?</strong> It should be used any time you want to repeat one or more statements, but don&#39;t actually know how many times it has to repeat, and want to ensure that the statements are run <em>at least once</em> before the loop ends.</p>
-  <p>You can also use the <a href="break.htm"><span class="inline">break</span></a> and <a href="continue.htm"><span class="inline">continue</span></a> statements within your <span class="inline">do</span> loops. Using <span class="inline">break</span> will immediately exit the loop and move on to any code that is in the event or function after the loop should have finished, eg:</p>
+  <p>You can also use the <a href="break.htm"><span class="inline">break</span></a> and <a href="continue.htm"><span class="inline">continue</span></a> statements within your <span class="inline">do</span> loops. Using <span class="inline">break</span> will immediately exit the loop and move on to any code that is in the event or function after the loop should have finished, e.g.:</p>
   <p class="code">var _id = noone;<br />
     do<br />
     {<br />
         _id = list[| 0];<br />
-        if (instance_exists(_id)) <br />
+        if (instance_exists(_id))<br />
         {<br />
-            _break;<br />
+            break;<br />
         }<br />
         ds_list_delete(list, 0);<br />
     }<br />
@@ -59,7 +59,7 @@ <h1>do / until</h1>
         }<br />
         instance_create_layer(_x, _y, &quot;Instances&quot;, obj_Enemy);<br />
     }<br />
-    until (instance_count(obj_Enemy) &gt;= 10);</p>
+    until (instance_number(obj_Enemy) &gt;= 10);</p>
   <p>This code will generate a random room position then check if an instance of the object <span class="inline">obj_Enemy</span> exists at that position. If it does, the current loop iteration is terminated using <span class="inline">continue</span> and a new iteration is started, and if it doesn&#39;t then an instance of the object <span class="inline">obj_Enemy</span> is created at the random position. The loop will only terminate when there are 10 or more instances of the object in the room.</p>
   <p>One final note: be careful with your <span class="inline">do</span> loops, as you can easily make them loop forever, in which case your game will hang and not react to any user input anymore and they will have to force close it.</p>
   <p>For more examples of loop keywords please see the sections on <a href="repeat.htm"><span class="inline">repeat</span></a>, <a href="while.htm"><span class="inline">while</span></a>, and <a href="for.htm"><span class="inline">for</span></a>.</p>
@@ -73,7 +73,7 @@ <h1>do / until</h1>
         <div style="float:right">Next: <a href="for.htm">for</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
 do

Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Audio/Audio.htm

@@ -96,6 +96,7 @@ <h3>Asset Info</h3>
     <li><a data-xref="{title}" href="audio_exists.htm">audio_exists</a></li>
     <li><a data-xref="{title}" href="audio_get_name.htm">audio_get_name</a></li>
     <li><a data-xref="{title}" href="audio_get_type.htm">audio_get_type</a></li>
+    <li><a data-xref="{title}" href="audio_sound_get_asset.htm">audio_sound_get_asset</a></li>
     <li><a data-xref="{title}" href="audio_sound_length.htm">audio_sound_length</a></li>
     <li><a data-xref="{title}" href="audio_sound_is_playable.htm">audio_sound_is_playable</a></li>
   </ul>
@@ -175,7 +176,7 @@ <h3>Advanced Audio</h3>
         <div style="float:right">Next: <a data-xref="{title}" href="../Paths/Paths.htm">Paths</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
 Audio

Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Audio/Audio_Buffers/audio_create_buffer_sound.htm

@@ -4,13 +4,13 @@
 <head>
   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   <title>audio_create_buffer_sound</title>
-  <meta name="generator" content="Adobe RoboHelp 2020" />
+  <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" />
   <meta name="topic-comment" content="Page explaining the function audio_create_buffer_sound" />
   <meta name="rh-index-keywords" content="audio_create_buffer_sound" />
-  <meta name="search-keywords" content="audio_create_buffer_sound,audio_mono,audio_stereo,audio_3D" />
+  <meta name="search-keywords" content="audio_create_buffer_sound,audio_mono,audio_stereo,audio_3d" />
   <meta name="is_pure" content="true" />
 </head>
 <body>
@@ -27,7 +27,7 @@ <h1>audio_create_buffer_sound</h1>
     </colgroup>
     <tbody>
       <tr>
-        <th colspan="2"><span data-keyref="Type_Constant_Audio_Channel_Type"><a href="../../../../../../GameMaker_Language/GML_Reference/Asset_Management/Audio/Audio_Buffers/audio_create_buffer_sound.htm" target="_blank">Audio Channel Constant</a></span></th>
+        <th colspan="2"><span data-keyref="Type_Constant_Audio_Channel_Type"><a href="audio_create_buffer_sound.htm" target="_blank">Audio Channel Constant</a></span></th>
       </tr>
       <tr>
         <th>Constant</th>
@@ -42,7 +42,7 @@ <h1>audio_create_buffer_sound</h1>
         <td>Stereo (dual channel) audio</td>
       </tr>
       <tr>
-        <td><span class="inline">audio_3D</span></td>
+        <td><span class="inline">audio_3d</span></td>
         <td>3D (5.1) audio</td>
       </tr>
     </tbody>
@@ -62,39 +62,39 @@ <h4>Syntax:</h4>
       </tr>
       <tr>
         <td>bufferId</td>
-        <td><span data-keyref="Type_ID_Buffer"><a href="../../../../../../GameMaker_Language/GML_Reference/Buffers/buffer_create.htm" target="_blank">Buffer ID</a></span></td>
+        <td><span data-keyref="Type_ID_Buffer"><a href="../../../Buffers/buffer_create.htm" target="_blank">Buffer</a></span></td>
         <td>The ID of the buffer to use.</td>
       </tr>
       <tr>
         <td>bufferFormat</td>
-        <td><span data-keyref="Type_Constant_Buffer_Data_Type"><a href="../../../../../../GameMaker_Language/GML_Reference/Buffers/buffer_write.htm" target="_blank">Buffer Data Type Constant</a></span></td>
+        <td><span data-keyref="Type_Constant_Buffer_Data_Type"><a href="../../../Buffers/buffer_write.htm" target="_blank">Buffer Data Type Constant</a></span></td>
         <td>The format of the data in the buffer (<span class="inline">buffer_u8</span> or <span class="inline">buffer_s16</span>).</td>
       </tr>
       <tr>
         <td>bufferRate</td>
-        <td><span data-keyref="Type_Real"><a href="../../../../../../GameMaker_Language/GML_Overview/Data_Types.htm" target="_blank">Real</a></span></td>
+        <td><span data-keyref="Type_Real"><a href="../../../../GML_Overview/Data_Types.htm" target="_blank">Real</a></span></td>
         <td>The sample rate of the data in the buffer.</td>
       </tr>
       <tr>
         <td>bufferOffset</td>
-        <td><span data-keyref="Type_Real"><a href="../../../../../../GameMaker_Language/GML_Overview/Data_Types.htm" target="_blank">Real</a></span></td>
+        <td><span data-keyref="Type_Real"><a href="../../../../GML_Overview/Data_Types.htm" target="_blank">Real</a></span></td>
         <td>The offset into the buffer to read the sample data from (in bytes).</td>
       </tr>
       <tr>
         <td>bufferLength</td>
-        <td><span data-keyref="Type_Real"><a href="../../../../../../GameMaker_Language/GML_Overview/Data_Types.htm" target="_blank">Real</a></span></td>
+        <td><span data-keyref="Type_Real"><a href="../../../../GML_Overview/Data_Types.htm" target="_blank">Real</a></span></td>
         <td>The length of the buffer (the number of bytes of audio data, excluding the header).</td>
       </tr>
       <tr>
         <td>bufferChannels</td>
-        <td><span data-keyref="Type_Constant_Audio_Channel_Type"><a href="../../../../../../GameMaker_Language/GML_Reference/Asset_Management/Audio/Audio_Buffers/audio_create_buffer_sound.htm" target="_blank">Audio Channel Constant</a></span></td>
+        <td><span data-keyref="Type_Constant_Audio_Channel_Type"><a href="audio_create_buffer_sound.htm" target="_blank">Audio Channel Constant</a></span></td>
         <td>The channels to use from one of the constants listed above.</td>
       </tr>
     </tbody>
   </table>
   <p> </p>
   <h4>Returns:</h4>
-  <p class="code"><span data-keyref="Type_Asset_Sound"><a href="../../../../../../The_Asset_Editors/Sounds.htm" target="_blank">Sound Asset</a></span></p>
+  <p class="code"><span data-keyref="Type_Asset_Sound"><a href="../../../../../The_Asset_Editors/Sounds.htm" target="_blank">Sound Asset</a></span></p>
   <p> </p>
   <h4>Example:</h4>
   <p class="code">var rate = 44100;<br />
@@ -130,13 +130,13 @@ <h4>Example:</h4>
         <div style="float:right">Next: <a href="audio_free_buffer_sound.htm">audio_free_buffer_sound</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
 audio_create_buffer_sound
 audio_mono
 audio_stereo
-audio_3D
+audio_3d
 -->
   <!-- TAGS
 audio_create_buffer_sound