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 Sep 18, 2024
2 parents 74186e3 + 1351561 commit d807d68
Show file tree
Hide file tree
Showing 11 changed files with 101 additions and 18 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ <h4>Returns:</h4>
<h4>Example:</h4>
<p class="code">audio_sound_loop_start(snd_machine, 4);<br />
<span data-field="title" data-format="default">audio_sound_loop_end</span>(snd_machine, 10);<br />
ins_sound = audio_play_sound(snd_snd_machine, 100, true);
ins_sound = audio_play_sound(snd_machine, 100, true);
</p>
<p>The above code sets the loop start point for the existing sound asset <span class="inline2">snd_machine</span> to 4 seconds and the loop end point to 10 seconds. The sound is then played with a priority of 100 and <span class="inline2">loop</span> set to <span class="inline2">true</span>. The new sound <em>instance</em> gets its loop start and end position from the sound <em>asset</em>. Its ID is stored in a variable <span class="inline2">ins_sound</span>.</p>
<p> </p>
Expand All @@ -72,4 +72,4 @@ <h5><span data-keyref="Copyright Notice">© Copyright YoYo Games Ltd. 2023 All R
audio_sound_loop_end
-->
</body>
</html>
</html>
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ <h4>Returns:</h4>
<h4>Example:</h4>
<p class="code"><span data-field="title" data-format="default">audio_sound_loop_start</span>(snd_machine, 4);<br />
audio_sound_loop_end(snd_machine, 10);<br />
ins_sound = audio_play_sound(snd_snd_machine, 100, true);</p>
ins_sound = audio_play_sound(snd_machine, 100, true);</p>
<p>The above code sets the loop start point for the existing sound asset <span class="inline2">snd_machine</span> to 4 seconds and the loop end point to 10 seconds. The sound is then played with a priority of 100 and <span class="inline2">loop</span> set to <span class="inline2">true</span>. The new sound <em>instance</em> gets its loop start and end position from the sound <em>asset</em>. Its ID is stored in a variable <span class="inline2">ins_sound</span>.</p>
<p> </p>
<p> </p>
Expand All @@ -72,4 +72,4 @@ <h5><span data-keyref="Copyright Notice">© Copyright YoYo Games Ltd. 2023 All R
audio_sound_loop_start
-->
</body>
</html>
</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>audio_play_in_sync_group</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>audio_sync_group_debug</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>audio_channel_num</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>audio_system_is_initialised</title>
<meta name="generator" content="Adobe RoboHelp 2020" />
<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="" />
Expand All @@ -27,7 +27,7 @@ <h4>Syntax:</h4>
<p class="code"><span data-field="title" data-format="default">audio_system_is_initialised</span>();</p>
<p> </p>
<h4>Returns:</h4>
<p class="code"><span data-keyref="Type_Bool"><a href="../../../../../GameMaker_Language/GML_Overview/Data_Types.htm" target="_blank">Boolean</a></span></p>
<p class="code"><span data-keyref="Type_Bool"><a href="../../../GML_Overview/Data_Types.htm" target="_blank">Boolean</a></span></p>
<p> </p>
<h4>Example:</h4>
<p> </p>
Expand All @@ -51,7 +51,7 @@ <h4>Example:</h4>
    audio_emitter_bus(em_emitter, bus_special_effects);<br />
}<br />
<br />
if (audio_initialised) <br />
if (audio_initialised)<br />
{<br />
    // The audio system can be used here<br />
    // ...<br />
Expand All @@ -64,10 +64,10 @@ <h4>Example:</h4>
<div class="buttons">
<div class="clear">
<div>Back: <a data-xref="{title}" href="Audio.htm">Audio</a></div>
<div>Next: <a data-xref="{title}" href="audio_debug.htm">audio_debug</a></div>
<div>Next: <a data-xref="{title}" href="audio_throw_on_error.htm">audio_throw_on_error</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_system_is_initialised
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
<?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>audio_throw_on_error</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="audio_throw_on_error" />
<meta name="search-keywords" content="audio_throw_on_error" />
<meta name="template" content="assets/masterpages/Manual_Keyword_Page.htt" />
</head>
<body>
<h1><span data-field="title" data-format="default">audio_throw_on_error</span></h1>
<p>This function enables or disables audio functions throwing fatal errors (as described in <a data-xref="{text}" href="Audio.htm#h1">Audio Error Handling</a>). By default, throwing is enabled and you can pass <span class="inline2">false</span> to this function to disable that behaviour and instead make such errors print a message to the Output Log.</p>
<p>The following functions are exceptions and will always throw errors regardless of what you pass this function:</p>
<ul class="colour">
<li><a data-xref="{title}" href="audio_play_sound.htm">audio_play_sound</a></li>
<li><a data-xref="{title}" href="audio_play_sound_at.htm">audio_play_sound_at</a></li>
<li><a data-xref="{title}" href="Audio_Emitters/audio_play_sound_on.htm">audio_play_sound_on</a></li>
<li><a data-xref="{title}" href="Audio_Synchronisation/audio_play_in_sync_group.htm">audio_play_in_sync_group</a></li>
</ul>
<p> </p>
<ul class="colour">
</ul>
<h4>Syntax:</h4>
<p class="code"><span data-field="title" data-format="default">audio_throw_on_error</span>(enable);</p>
<table>
<colgroup>
<col />
<col />
<col />
</colgroup>
<tbody>
<tr>
<th>Argument</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td>enable</td>
<td><span data-keyref="Type_Bool"><a href="../../../GML_Overview/Data_Types.htm" target="_blank">Boolean</a></span></td>
<td>Whether errors should be thrown (<span class="inline2">true</span>, default) or logged (<span class="inline2">false</span>)</td>
</tr>
</tbody>
</table>
<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"><span data-field="title" data-format="default">audio_throw_on_error</span>(false);</p>
<p>This disables audio functions throwing errors.</p>
<p> </p>
<p> </p>
<div class="footer">
<div class="buttons">
<div class="clear">
<div>Back: <a data-xref="{title}" href="Audio.htm">Audio</a></div>
<div>Next: <a data-xref="{title}" href="audio_debug.htm">audio_debug</a></div>
</div>
</div>
<h5><span data-keyref="Copyright Notice">© Copyright YoYo Games Ltd. 2024 All Rights Reserved</span></h5>
</div>
<!-- KEYWORDS
audio_throw_on_error
-->
<!-- TAGS
audio_throw_on_error
-->
</body>
</html>
Original file line number Diff line number Diff line change
Expand Up @@ -90,11 +90,19 @@ <h3 id="audio">Audio</h3>
<p>This window shows debug information related to the audio playing in your game.</p>
<p>The graph displays the most recent output buffer on the audio thread. This is the output signal that <span data-keyref="GameMaker Name">GameMaker</span> sends to the audio device, after all mixing and processing.</p>
<p>The horizontal axis in this graph is the frame number in the buffer, and the vertical axis is the amplitude, typically ranging between -1 and 1.</p>
<p><img class="center" src="../../../assets/Images/Scripting_Reference/GML/Reference/Debug/debug_overlay_audio.png" />The list at the bottom shows you each sound &quot;source&quot; that is currently playing, or may potentially play a sound. The columns display the following values:</p>
<p><img class="center" src="../../../assets/Images/Scripting_Reference/GML/Reference/Debug/debug_overlay_audio.png" />The list at the bottom shows you each sound &quot;source&quot; that is currently playing or may potentially play a sound (including individual sources from <a href="../Asset_Management/Audio/Audio_Synchronisation/Audio_Synchronisation.htm">sync groups</a>). These appear coloured depending on the state of the source:</p>
<ul class="colour">
<li><strong>White</strong>: Sources that are currently playing.</li>
<li><strong>Red</strong>: Sources that have finished playing.</li>
<li><strong>Yellow</strong>: Sources that are paused.</li>
<li><strong>Magenta</strong>: Sources that are preparing to be played, waiting on internal conditions. This is a transient state and will not be visible for more than some milliseconds.</li>
<li><strong>Cyan</strong>: Sources that are stopping. This is a transient state and will not be visible for more than some milliseconds.</li>
</ul>
<p>The columns display the following values:</p>
<ul class="colour">
<li><strong>source</strong>: The ID of the source</li>
<li><strong>buffer</strong>: The ID of the buffer attached to this source</li>
<li><strong>numProcessed</strong>: The number of queued buffers that the source has played through (which gets cleaned up at certain points)</li>
<li><strong>syncSource</strong>: The source that this source is synchronised to. This will be -1 for sources that are not synchronising to any source and for sources that are being synchronised to by others.</li>
<li><strong>numQueued</strong>: The number of buffers that are queued on this source (including processed ones)</li>
<li><strong>gain</strong>: The source gain as a 16-bit value (0-65535)</li>
<li><strong>name</strong>: The name of the asset. Dynamically created assets (such as buffer sounds) will not show a name.</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ <h2>Property List</h2>
<li><span class="inline2">justifyContent</span></li>
<li><span class="inline2">direction</span></li>
<li><span class="inline2">gap</span>, <span class="inline2">gapRow</span>, <span class="inline2">gapColumn</span></li>
<li><span class="inline2">margin</span>, <span class="inline2">marginLeft</span>, <span class="inline2">marginRight</span>, <span class="inline2">marginTop</span>, <span class="inline2">marginBottom</span>, <span class="inline2">marginStart</span>, <span class="inline2">marginEnd</span>, <span class="inline2">marginHorizontal</span>, <span class="inline2">marginVertical</span></li>
<li><span class="inline2">margin</span>, <span class="inline2">marginInline</span><span class="inline2">marginLeft</span>, <span class="inline2">marginRight</span>, <span class="inline2">marginTop</span>, <span class="inline2">marginBottom</span>, <span class="inline2">marginStart</span>, <span class="inline2">marginEnd</span>, <span class="inline2">marginHorizontal</span>, <span class="inline2">marginVertical</span></li>
<li><span class="inline2">padding</span>, <span class="inline2">paddingLeft</span>, <span class="inline2">paddingRight</span>, <span class="inline2">paddingTop</span>, <span class="inline2">paddingBottom</span>, <span class="inline2">paddingStart</span>, <span class="inline2">paddingEnd</span>, <span class="inline2">paddingHorizontal</span>, <span class="inline2">paddingVertical</span></li>
<li><span class="inline2">border</span>, <span class="inline2">borderLeft</span>, <span class="inline2">borderRight</span>, <span class="inline2">borderTop</span>, <span class="inline2">borderBottom</span>, <span class="inline2">borderStart</span>, <span class="inline2">borderEnd</span>, <span class="inline2">borderHorizontal</span>, <span class="inline2">borderVertical</span></li>
<li><span class="inline2">start</span>, <span class="inline2">end</span></li>
Expand Down Expand Up @@ -105,7 +105,7 @@ <h3 id="h17">Position Type</h3>
<li><span class="inline2">&quot;static&quot;</span>: The node will behave like relative except it will ignore insets and will not form a <a data-xref="{text}" href="Flex_Panels.htm#h">Containing Block</a> for its children.</li>
</ul>
<h3 id="h14">Margin</h3>
<p class="note">Struct properties: <span class="inline2">margin</span>, <span class="inline2">marginLeft</span>, <span class="inline2">marginRight</span>, <span class="inline2">marginTop</span>, <span class="inline2">marginBottom</span>, <span class="inline2">marginStart</span>, <span class="inline2">marginEnd</span>, <span class="inline2">marginHorizontal</span>, <span class="inline2">marginVertical</span><br />
<p class="note">Struct properties: <span class="inline2">margin</span>, <span class="inline2">marginInline</span><span class="inline2">marginLeft</span>, <span class="inline2">marginRight</span>, <span class="inline2">marginTop</span>, <span class="inline2">marginBottom</span>, <span class="inline2">marginStart</span>, <span class="inline2">marginEnd</span>, <span class="inline2">marginHorizontal</span>, <span class="inline2">marginVertical</span><br />
Functions: <span class="inline3_func"><a data-xref="{title}" href="Function_Reference/Styling_Functions/flexpanel_node_style_set_margin.htm">flexpanel_node_style_set_margin</a></span><span class="inline3_func"><a data-xref="{title}" href="Function_Reference/Styling_Functions/flexpanel_node_style_get_margin.htm">flexpanel_node_style_get_margin</a></span></p>
<p>This is the space around the outside of the node. You can define it for all edges or for a specific edge. Accepts pixel values and percentages.</p>
<h3 id="h15">Padding</h3>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ <h2 id="h">Code-Injektion</h2>
YYAndroidGradleEnd<br />
YYAndroidGradleAndroid<br />
YYAndroidGradleDependencies <br />
YYAndroidGradleProperties<span class="misspell-word"><br />
<bdi>YYAndroidBuildTypesRelease</bdi></span><br />
YYAndroidGradleProperties<br />
<span class="misspell-word"><bdi>YYAndroidBuildTypesRelease</bdi></span><br />
YYAndroidManifestAttributes<br />
YYAndroidManifestApplicationAttributes<br />
YYAndroidManifestActivityAttributes<br />
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d807d68

Please sign in to comment.