Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/develop' into develop
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Feb 26, 2025
2 parents 9f74afd + e4c0cf2 commit 3a9ad2e
Show file tree
Hide file tree
Showing 17 changed files with 179 additions and 30 deletions.
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>object_get_persistent</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"></script>
<meta name="rh-authors" content="Mark Alexander" />
Expand Down
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>object_get_solid</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"></script>
<meta name="rh-authors" content="Mark Alexander" />
Expand Down
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>object_get_visible</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"></script>
<meta name="rh-authors" content="Mark Alexander" />
Expand Down
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>image_index</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"></script>
<meta name="rh-authors" content="Mark Alexander" />
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
<?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>buffer_get_used_size</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="buffer_get_used_size" />
<meta name="search-keywords" content="buffer_get_used_size" />
<meta name="template" content="assets/masterpages/Manual_Keyword_Page.htt" />
</head>
<body>
<h1><span data-field="title" data-format="default">buffer_get_used_size</span></h1>
<p>This function returns the used size of the given buffer.</p>
<p>The used size is the number of bytes that have been written to the buffer. It starts out at 0 for a new buffer created with <span class="inline3_func"><a data-xref="{title}" href="buffer_create.htm">buffer_create</a></span> and increases when you write to it. It can be set manually using <span class="inline3_func"><a data-xref="{title}" href="buffer_set_used_size.htm">buffer_set_used_size</a></span>.</p>
<p> </p>
<h4>Syntax:</h4>
<p class="code"><span data-field="title" data-format="default">buffer_get_used_size</span>(buffer)</p>
<table>
<colgroup>
<col />
<col />
<col />
</colgroup>
<tbody>
<tr>
<th>Argument</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td>buffer</td>
<td><span data-keyref="Type_ID_Buffer"><a href="buffer_create.htm" target="_blank">Buffer</a></span></td>
<td>The buffer to get the used size of</td>
</tr>
</tbody>
</table>
<p> </p>
<h4>Returns:</h4>
<p class="code"><span data-keyref="Type_Real"><a href="../../GML_Overview/Data_Types.htm" target="_blank">Real</a></span></p>
<p> </p>
<h4>Example:</h4>
<p class="code">var _buffer = buffer_create(16, buffer_grow, 1);<br />
repeat(6)<br />
{<br />
    buffer_write(_buffer, buffer_f32, 4);<br />
}<br />
var _used_size = <span data-field="title" data-format="default">buffer_get_used_size</span>(_buffer);<br />
var _size = buffer_get_size(_buffer);<br />
<br />
show_debug_message($&quot;size: {_size}, used: {_used_size}&quot;);
</p>
<p>The above code creates a new grow buffer with an initial size of 16 bytes and then writes 6 values of type <span class="inline2">buffer_f32</span> to it in a <span class="inline2"><a data-xref="{title}" href="../../GML_Overview/Language_Features/repeat.htm">repeat</a></span> loop. Each value of this data type takes up 4 bytes in the buffer, bringing the total size to 24 bytes, which is more than the initial size of the buffer. After the writes the used size and actual size of the buffer are retrieved using <span class="inline3_func"><span data-field="title" data-format="default">buffer_get_used_size</span></span> and <span class="inline3_func"><a data-xref="{title}" href="buffer_get_size.htm">buffer_get_size</a></span> respectively and are output in a debug message. While the used size shows the exact number of bytes written (24), the size shows a larger number of bytes, indicating that the buffer was resized to accommodate more data than was written.</p>
<p> </p>
<p> </p>
<div class="footer">
<div class="buttons">
<div class="clear">
<div>Back: <a data-xref="{title}" href="Buffers.htm">Buffers</a></div>
<div>Next: <a data-xref="{title}" href="buffer_copy.htm">buffer_copy</a></div>
</div>
</div>
<h5><span data-keyref="Copyright Notice">© Copyright YoYo Games Ltd. 2025 All Rights Reserved</span></h5>
</div>
<!-- KEYWORDS
buffer_get_used_size
-->
<!-- TAGS
buffer_get_used_size
-->
</body>
</html>
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?>
<?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"/>
Expand All @@ -16,7 +16,9 @@
</div>
<!-- KEYWORDS
ds_grid_add
--><!-- TAGS
-->
<!-- TAGS
ds_grid_add
--></body>
-->
</body>
</html>
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?>
<?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"/>
Expand All @@ -16,7 +16,9 @@
</div>
<!-- KEYWORDS
ds_grid_add_disk
--><!-- TAGS
-->
<!-- TAGS
ds_grid_add_disk
--></body>
-->
</body>
</html>
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?>
<?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"/>
Expand All @@ -16,7 +16,9 @@
</div>
<!-- KEYWORDS
ds_grid_add_region
--><!-- TAGS
-->
<!-- TAGS
ds_grid_add_region
--></body>
-->
</body>
</html>
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<?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"/>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>base64_decode</title>
<meta name="generator" content="Adobe RoboHelp 2019"/>
<link rel="stylesheet" href="../../../../assets/css/default.css" type="text/css"/>
Expand All @@ -22,5 +22,5 @@
<!-- TAGS
base64_decode
-->

</body></html>
</body>
</html>
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>keyboard_get_numlock</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"></script>
<meta name="rh-authors" content="Mark Alexander" />
Expand Down
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>keyboard_set_numlock</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"></script>
<meta name="rh-authors" content="Mark Alexander" />
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
<?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>mac_refresh_receipt_validation</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="mac_refresh_receipt_validation" />
<meta name="search-keywords" content="mac_refresh_receipt_validation" />
<meta name="template" content="assets/masterpages/Manual_Keyword_Page.htt" />
</head>
<body>
<h1><span data-field="title" data-format="default">mac_refresh_receipt_validation</span></h1>
<p>This function attempts to revalidate a Mac App Store receipt.</p>
<p>It triggers an Async <a data-xref="{title}" href="../../../The_Asset_Editors/Object_Properties/Async_Events/System.htm">System</a> event of type <span class="inline2">&quot;receipt_validation&quot;</span>. If the receipt is valid, the <span class="inline2">valid</span> key in <span class="inline2">async_load</span> will be <span class="inline2">true</span>. See the example below.</p>
<p class="note"><span data-conref="../../../assets/snippets/Tag_note.hts"> </span> The async event is automatically triggered a single time at game start.</p>
<p> </p>
<h4>Syntax:</h4>
<p class="code"><span data-field="title" data-format="default">mac_refresh_receipt_validation</span>();</p>
<p> </p>
<h4>Returns:</h4>
<p class="code"><span data-keyref="Type_Void">N/A</span></p>
<p> </p>
<h4>Example:</h4>
<p class="code_heading">Left Pressed Event</p>
<p class="code"> <span data-field="title" data-format="default">mac_refresh_receipt_validation</span>();</p>
<p class="code_heading">Async - System Event</p>
<p class="code">if (async_load[? &quot;type&quot;] != &quot;receipt_validation&quot;) exit;<br />
<br />
if (async_load[? &quot;valid&quot;])<br />
{<br />
    // Unlock functionality<br />
    // ...<br />
}<br />
else<br />
{<br />
    // Show debug message and keep functionality unchanged<br />
    show_debug_message(&quot;Invalid receipt - staying in demo mode&quot;);<br />
}
</p>
<p>The above code shows a call to <span class="inline3_func"><span data-field="title" data-format="default">mac_refresh_receipt_validation</span></span> in a mouse Left Pressed event - on a button object, for example - and the code of the Async <a data-xref="{title}" href="../../../The_Asset_Editors/Object_Properties/Async_Events/System.htm">System</a> event. If the event type held in the <span class="inline2"><a data-xref="{title}" href="../../GML_Overview/Variables/Builtin_Global_Variables/async_load.htm">async_load</a></span> map doesn&#39;t equal <span class="inline2">&quot;receipt_validation&quot;</span>, the code is exited. If it does, code execution continues and the <span class="inline2">&quot;valid&quot;</span> key is checked in an <span class="inline2">if</span> statement. If the receipt is valid, additional functionality is unlocked. If not, a debug message is shown and no additional functionality is unlocked.</p>
<p> </p>
<p> </p>
<div class="footer">
<div class="buttons">
<div class="clear">
<div>Back: <a data-xref="{title}" href="In_App_Purchases.htm">In-App Purchases</a></div>
<div>Next: <a data-xref="{title}" href="../Asynchronous_Functions/Asynchronous_Functions.htm">Asynchronous Functions</a></div>
</div>
</div>
<h5><span data-keyref="Copyright Notice">© Copyright YoYo Games Ltd. 2025 All Rights Reserved</span></h5>
</div>
<!-- KEYWORDS
mac_refresh_receipt_validation
-->
<!-- TAGS
mac_refresh_receipt_validation
-->
</body>
</html>
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>date_date_of</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"></script>
<meta name="rh-authors" content="Mark Alexander" />
Expand All @@ -16,10 +16,10 @@
<body><!--<div class="body-scroll" style="top: 150px;">--><h1>date_date_of</h1><p> 주어진 datetime의 날짜 값을 반환합니다.</p><p></p><h4> 통사론:</h4><p class="code">date_date_of(date);</p><table><tbody><tr><th> 논쟁</th><th> 유형</th><th> 설명</th></tr><tr><td> <span class="notranslate">date</span></td><td><span data-keyref="Type_Real_Datetime"></span></td><td> <span class="notranslate">The datetime to extract the date from.</span></td></tr></tbody></table><p></p><h4> 보고:</h4><p class="code"><span data-keyref="Type_Real"></span></p><p></p><h4> 예시:</h4><p class="code">today = date_date_of(date_current_datetime());</p><p> 이것은 현재 날짜만 반환하고 &quot;오늘&quot; 변수에 값을 저장합니다. </p><p></p><p></p><p></p><div class="footer"><div class="buttons"><div class="clear"><div style="float:left"> 뒤로: <a href="Date_And_Time.htm">날짜 및 시간</a></div><div style="float:right"> 다음: <a href="date_time_of.htm"><span class="notranslate">date_time_of</span></a></div></div></div><h5> <span data-keyref="Copyright Notice">© Copyright YoYo Games Ltd. 2021 판권 소유</span></h5>
</div>
<!-- KEYWORDS
date_valid_datetime
date_date_of
-->
<!-- TAGS
date_valid_datetime
date_date_of
-->
</body>
</html>
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ <h4>Syntax:</h4>
</table>
<p> </p>
<h4>Returns:</h4>
<p class="code"><span data-keyref="Type_Handle"><a href="../../GML_Overview/Data_Types.htm" target="_blank">Handle</a></span> (or <span data-keyref="Type_Undefined"><a href="../../GML_Overview/Data_Types.htm" target="_blank">undefined</a></span> in case of an invalid handle type or an invalid string)</p>
<p class="code"><span data-keyref="Type_Handle"><a href="../../GML_Overview/Data_Types.htm" target="_blank">Handle</a></span> (or <span data-keyref="Type_Undefined"><a href="../../GML_Overview/Data_Types.htm" target="_blank">undefined</a></span> in case of an invalid handle type or an incorrectly formatted string)</p>
<p> </p>
<h4>Example:</h4>
<p class="code">sprite = spr_player;<br />
Expand Down
2 changes: 1 addition & 1 deletion Manual/contents/assets/snippets/Handle_Invalid.hts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@
<link rel="stylesheet" type="text/css" href="../css/default.css" />
</head>
<body>
<p>A handle can be invalid, in which case the index number it holds will be <span class="inline2">-1</span>, or <span class="inline2">-4</span> (<span class="inline2"><a data-xref="{title}" href="../../GameMaker_Language/GML_Overview/Instance Keywords/noone.htm">noone</a></span>) for instance handles. All handles can be compared against their &quot;invalid&quot; value to check whether they&#39;re valid or not (i.e. <span class="inline2">if (handle != -1) { // do something }</span> or <span class="inline2">if (handle != noone) { // execute this code in the instance }</span>).</p>
<p>A handle can be invalid, in which case the index number it holds will be <span class="inline2">-1</span>, or <span class="inline2">-4</span> (<span class="inline2"><a data-xref="{title}" href="../../GameMaker_Language/GML_Overview/Instance Keywords/noone.htm">noone</a></span>) for instance handles. All handles can be compared against their &quot;invalid&quot; value to check whether they&#39;re valid or not (i.e. <span class="inline2">if (handle != -1) { // do something }</span> or <span class="inline2">if (handle != noone) { // do something }</span>).</p>
</body>
</html>
Original file line number Diff line number Diff line change
Expand Up @@ -16,27 +16,27 @@
</colgroup>
<tbody>
<tr>
<th colspan="2"><span data-keyref="Type_Constant_Buffer_Type"><a href="../../../GameMaker_Language/GML_Reference/Buffers/buffer_create.htm" target="_blank">Buffer Type Constant</a></span></th>
<th colspan="2"><span data-keyref="Type_Constant_Buffer_Type"><a href="../../GameMaker_Language/GML_Reference/Buffers/buffer_create.htm" target="_blank">Buffer Type Constant</a></span></th>
</tr>
<tr>
<th>Constant</th>
<th>Description</th>
</tr>
<tr>
<td><span class="inline">buffer_fixed</span></td>
<td>A buffer of fixed size.</td>
<td>A buffer of a fixed size in bytes. The size is set when the buffer is created and cannot be changed again.</td>
</tr>
<tr>
<td><span class="inline">buffer_grow</span></td>
<td>A buffer that will &quot;grow&quot; dynamically as data is added</td>
<td>A buffer that will <i>grow</i> dynamically as data is added. You create it with an initial size (which should be an approximation of the size of the data expected to be stored), and then it will expand to accept further data that overflows this initial size.</td>
</tr>
<tr>
<td><span class="inline">buffer_wrap</span></td>
<td>A buffer where the data will &quot;wrap&quot;. When the data being added reaches the limit of the buffer size, the overwrite will be placed back at the start of the buffer, and further writing will continue from that point.</td>
</tr>
<tr>
<td><span class="inline">buffer_fast</span></td>
<td>A special &quot;stripped&quot; buffer that is extremely fast to read/write to. Can only be used with <span class="inline">buffer_u8</span> <a href="../../GameMaker_Language/GML_Reference/Buffers/buffer_write.htm">data types</a>, and <i>must</i> be 1 byte aligned.</td>
<td>A special &quot;stripped&quot; buffer that is extremely fast to read/write to. Can only be used with <span class="inline">buffer_u8</span> <a href="../../GameMaker_Language/GML_Reference/Buffers/buffer_write.htm">data types</a>, and <i>must</i> be 1 byte aligned.</td>
</tr>
</tbody>
</table>
Expand Down
Loading

0 comments on commit 3a9ad2e

Please sign in to comment.