Skip to content

Commit

Permalink
Deployed 2f97c15 with MkDocs version: 1.2.3
Browse files Browse the repository at this point in the history
  • Loading branch information
alemart committed Feb 22, 2024
1 parent 6082051 commit e46b2aa
Show file tree
Hide file tree
Showing 8 changed files with 129 additions and 84 deletions.
1 change: 0 additions & 1 deletion CNAME

This file was deleted.

22 changes: 20 additions & 2 deletions engine/player/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1898,6 +1898,13 @@
forciblyUnderwater
</a>

</li>

<li class="md-nav__item">
<a href="#forciblyoutofwater" class="md-nav__link">
forciblyOutOfWater
</a>

</li>

<li class="md-nav__item">
Expand Down Expand Up @@ -2751,6 +2758,13 @@
forciblyUnderwater
</a>

</li>

<li class="md-nav__item">
<a href="#forciblyoutofwater" class="md-nav__link">
forciblyOutOfWater
</a>

</li>

<li class="md-nav__item">
Expand Down Expand Up @@ -3220,7 +3234,7 @@ <h4 id="winning">winning</h4>
<h4 id="underwater">underwater</h4>
<p><code>underwater</code>: boolean, read-only.</p>
<p>Is the player underwater? Players are considered to be underwater if they are below the <a href="/engine/level#waterlevel">water level</a> or if their <a href="#forciblyunderwater">forciblyUnderwater</a> flag is set to <code>true</code>.</p>
<p>See also: <a href="#secondstodrown">secondsToDrown</a>, <a href="#drowning">drowning</a>, <a href="#breathing">breathing</a>, <a href="#breathtime">breathTime</a>, <a href="#forciblyunderwater">forciblyUnderwater</a>, <a href="/engine/level#waterlevel">waterlevel</a>.</p>
<p>See also: <a href="#secondstodrown">secondsToDrown</a>, <a href="#drowning">drowning</a>, <a href="#breathing">breathing</a>, <a href="#breathtime">breathTime</a>, <a href="#forciblyunderwater">forciblyUnderwater</a>, <a href="#forciblyOutOfWater">forciblyOutOfWater</a>, <a href="/engine/level#waterlevel">waterlevel</a>.</p>
<h4 id="secondstodrown">secondsToDrown</h4>
<p><code>secondsToDrown</code>: number, read-only.</p>
<p>The number of seconds to drown, if underwater.</p>
Expand Down Expand Up @@ -3295,7 +3309,11 @@ <h4 id="breathtime">breathTime</h4>
<h4 id="forciblyunderwater">forciblyUnderwater</h4>
<p><code>forciblyUnderwater</code>: boolean.</p>
<p>If set to <code>true</code>, the <a href="#underwater">underwater</a> flag will be true regardless of the <a href="/engine/level#waterlevel">water level</a>. If set to <code>false</code>, the underwater flag will be true only if the player is below the water level. Defaults to <code>false</code>.</p>
<p>See also: <a href="#underwater">underwater</a>, <a href="/engine/level#waterlevel">waterlevel</a>.</p>
<p>See also: <a href="#underwater">underwater</a>, <a href="/engine/level#waterlevel">waterlevel</a>, <a href="#forciblyoutofwater">forciblyOutOfWater</a>.</p>
<p><em>Available since:</em> Open Surge 0.6.1</p>
<h4 id="forciblyoutofwater">forciblyOutOfWater</h4>
<p>If set to <code>true</code>, the <a href="#underwater">underwater</a> mechanics will be disabled, even if the player is below the <a href="/engine/level#waterlevel">water level</a>. If <a href="#forciblyunderwater">forciblyUnderwater</a> is also <code>true</code>, this flag will do nothing. Defaults to <code>false</code>.</p>
<p>See also: <a href="#underwater">underwater</a>, <a href="/engine/level#waterlevel">waterlevel</a>, <a href="#forciblyUnderwater">forciblyUnderwater</a>.</p>
<p><em>Available since:</em> Open Surge 0.6.1</p>
<h4 id="layer">layer</h4>
<p><code>layer</code>: string.</p>
Expand Down
5 changes: 3 additions & 2 deletions reference/gc/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1822,15 +1822,16 @@ <h1 id="gc">GC</h1>
<p>SurgeScript features a Garbage Collector (GC) that automatically disposes objects that cannot be reached from the root (i.e., their references are lost). The Garbage Collector is available at <code>System.gc</code>. Generally, you do not need to modify any of its settings.</p>
<h2 id="properties">Properties</h2>
<h4 id="interval">interval</h4>
<p><code>interval</code>: number.</p>
<p><code>interval</code>: number, read-only.</p>
<p>Every <code>interval</code> seconds, the garbage collector will be called automatically.</p>
<p><em>Note:</em> this property is read-only since SurgeScript 0.6.0.</p>
<h4 id="objectcount">objectCount</h4>
<p><code>objectCount</code>: number, read-only.</p>
<p>How many objects were disposed when the garbage collector was last called.</p>
<h2 id="functions">Functions</h2>
<h4 id="collect">collect</h4>
<p><code>collect()</code></p>
<p>Calls the Garbage Collector manually.</p>
<p>Calls the Garbage Collector manually. You generally don't need to call this.</p>


</article>
Expand Down
5 changes: 3 additions & 2 deletions reference/object/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2303,13 +2303,14 @@ <h4 id="hasfunction">hasFunction</h4>
<p>Returns <code>true</code> if the object has a function named <code>functionName</code>.</p>
<h4 id="hastag">hasTag</h4>
<p><code>hasTag(tagName)</code></p>
<p>Checks if the object has been tagged with <code>tagName</code>.</p>
<p>Checks if the object has been tagged <code>tagName</code>.</p>
<p>See also: <a href="/reference/tags#hastag">TagSystem.hasTag()</a>.</p>
<p><em>Arguments</em></p>
<ul>
<li><code>tagName</code>: string. The name of the tag.</li>
</ul>
<p><em>Returns</em></p>
<p>Returns <code>true</code> if the object has been tagged with <code>tagName</code>.</p>
<p>Returns <code>true</code> if the object has been tagged <code>tagName</code>.</p>
<h4 id="__invoke">__invoke</h4>
<p><code>__invoke(functionName, paramsArray)</code></p>
<p>Invokes function <code>functionName</code>, passing the parameters specified in <code>paramsArray</code>. The number of elements of <code>paramsArray</code> must be the same as the number of parameters required by the function to be invoked.</p>
Expand Down
28 changes: 27 additions & 1 deletion reference/tags/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -834,6 +834,13 @@
tagsOf
</a>

</li>

<li class="md-nav__item">
<a href="#hastag" class="md-nav__link">
hasTag
</a>

</li>

</ul>
Expand Down Expand Up @@ -1767,6 +1774,13 @@
tagsOf
</a>

</li>

<li class="md-nav__item">
<a href="#hastag" class="md-nav__link">
hasTag
</a>

</li>

</ul>
Expand Down Expand Up @@ -1802,7 +1816,7 @@ <h4 id="list">list</h4>
<p>A new <a href="/reference/array">Array</a> of strings with all tags used in all objects.</p>
<h4 id="select">select</h4>
<p><code>select(tagName)</code></p>
<p>Selects all objects that are tagged with <code>tagName</code>.</p>
<p>Selects all objects that are tagged <code>tagName</code>.</p>
<p><em>Arguments</em></p>
<ul>
<li><code>tagName</code>: string.</li>
Expand All @@ -1819,6 +1833,18 @@ <h4 id="tagsof">tagsOf</h4>
</ul>
<p><em>Returns</em></p>
<p>A new <a href="/reference/array">Array</a> of strings with the names of the tags associated with the objects named <code>objectName</code>. If the objects are untagged or do not exist, an empty array is returned.</p>
<h4 id="hastag">hasTag</h4>
<p><code>hasTag(objectName, tagName)</code></p>
<p>Checks if objects named <code>objectName</code> are tagged <code>tagName</code>. Prefer using <a href="/reference/object#hastag">Object.hasTag()</a> if possible.</p>
<p>See also: <a href="/reference/object#hastag">Object.hasTag()</a>.</p>
<p><em>Available since:</em> SurgeScript 0.6.0</p>
<p><em>Arguments</em></p>
<ul>
<li><code>objectName</code>: string.</li>
<li><code>tagName</code>: string.</li>
</ul>
<p><em>Returns</em></p>
<p>Returns <code>true</code> if the objects are tagged as specified, or <code>false</code> otherwise.</p>


</article>
Expand Down
2 changes: 1 addition & 1 deletion search/search_index.json

Large diffs are not rendered by default.

Loading

0 comments on commit e46b2aa

Please sign in to comment.