mirror of
https://github.com/TombEngine/TombEngine.git
synced 2025-04-29 00:07:58 +03:00
Regen docs and fix some doc comments
This commit is contained in:
hispidence
parent
b22584baf6
commit
a70159d95b
55 changed files with 1210 additions and 244 deletions
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -500,7 +502,7 @@
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -157,6 +159,10 @@ scripts too.</p>
|
|||
<td class="summary">Finishes the current level, with optional level index provided.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#GetGameStatus">GetGameStatus()</a></td>
|
||||
<td class="summary">Get current game status, such as normal game loop, exiting to title, etc.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#SaveGame">SaveGame(slotID)</a></td>
|
||||
<td class="summary">Save the game to a savegame slot.</td>
|
||||
</tr>
|
||||
|
|
@ -517,6 +523,27 @@ level count, jumps to title.
|
|||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "GetGameStatus"></a>
|
||||
<strong>GetGameStatus()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Get current game status, such as normal game loop, exiting to title, etc.
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../4 enums/Flow.GameStatus.html#">GameStatus</a></span>
|
||||
the current game status
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "SaveGame"></a>
|
||||
|
|
@ -840,7 +867,7 @@ Specify which translations in the strings table correspond to which languages.
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -126,7 +128,7 @@
|
|||
<td class="summary">Clear an action key.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#GetCursorDisplayPosition">GetCursorDisplayPosition()</a></td>
|
||||
<td class="name" ><a href="#GetMouseDisplayPosition">GetMouseDisplayPosition()</a></td>
|
||||
<td class="summary">Get the display position of the cursor in percent.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
|
@ -253,8 +255,8 @@
|
|||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "GetCursorDisplayPosition"></a>
|
||||
<strong>GetCursorDisplayPosition()</strong>
|
||||
<a name = "GetMouseDisplayPosition"></a>
|
||||
<strong>GetMouseDisplayPosition()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Get the display position of the cursor in percent. ()
|
||||
|
|
@ -280,7 +282,7 @@
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -250,7 +252,7 @@
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -106,16 +108,24 @@
|
|||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#AddCallback">AddCallback(CallbackPoint, func)</a></td>
|
||||
<td class="name" ><a href="#AddCallback">AddCallback(point, func)</a></td>
|
||||
<td class="summary">Register a function as a callback.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#RemoveCallback">RemoveCallback(CallbackPoint, LevelFunc)</a></td>
|
||||
<td class="name" ><a href="#RemoveCallback">RemoveCallback(point, func)</a></td>
|
||||
<td class="summary">Deregister a function as a callback.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#HandleEvent">HandleEvent(string, EventType, Moveable)</a></td>
|
||||
<td class="summary">Attempt to find an event set and exectute a particular event from it.</td>
|
||||
<td class="name" ><a href="#HandleEvent">HandleEvent(name, type, activator)</a></td>
|
||||
<td class="summary">Attempt to find an event set and execute a particular event from it.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#EnableEvent">EnableEvent(name, type)</a></td>
|
||||
<td class="summary">Attempt to find an event set and enable specified event in it.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#DisableEvent">DisableEvent(name, type)</a></td>
|
||||
<td class="summary">Attempt to find an event set and disable specified event in it.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Special_objects">Special objects </a></h2>
|
||||
|
|
@ -150,7 +160,7 @@
|
|||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "AddCallback"></a>
|
||||
<strong>AddCallback(CallbackPoint, func)</strong>
|
||||
<strong>AddCallback(point, func)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Register a function as a callback.
|
||||
|
|
@ -159,7 +169,7 @@
|
|||
stuff during level start/load/end/save/control phase, but don't want the level
|
||||
designer to add calls to <code>OnStart</code>, <code>OnLoad</code>, etc. in their level script.</p>
|
||||
|
||||
<p>Possible values for CallbackPoint:</p>
|
||||
<p>Possible values for <code>point</code>:</p>
|
||||
<pre class="example"><span class="comment">-- These take functions which accept no arguments
|
||||
</span>PRESTART <span class="comment">-- will be called immediately before OnStart
|
||||
</span>POSTSTART <span class="comment">-- will be called immediately after OnStart
|
||||
|
|
@ -175,23 +185,23 @@ PRELOAD <span class="comment">-- will be called immediately before OnLoad
|
|||
</span>POSTEND <span class="comment">-- will be called immediately after OnEnd
|
||||
</span>
|
||||
<span class="comment">-- These take functions which accepts a deltaTime argument
|
||||
</span>PRECONTROLPHASE <span class="comment">-- will be called immediately before OnControlPhase
|
||||
</span>POSTCONTROLPHASE <span class="comment">-- will be called immediately after OnControlPhase
|
||||
</span>PRELOOP <span class="comment">-- will be called in the beginning of game loop
|
||||
</span>POSTLOOP <span class="comment">-- will be called at the end of game loop
|
||||
</span></pre>
|
||||
<p>The order in which two functions with the same CallbackPoint are called is undefined.
|
||||
i.e. if you register <code>MyFunc</code> and <code>MyFunc2</code> with <code>PRECONTROLPHASE</code>, both will be called before <code>OnControlPhase</code>, but there is no guarantee that <code>MyFunc</code> will be called before <code>MyFunc2</code>, or vice-versa.</p>
|
||||
i.e. if you register <code>MyFunc</code> and <code>MyFunc2</code> with <code>PRELOOP</code>, both will be called in the beginning of game loop, but there is no guarantee that <code>MyFunc</code> will be called before <code>MyFunc2</code>, or vice-versa.</p>
|
||||
|
||||
<p>Any returned value will be discarded.</p>
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">CallbackPoint</span>
|
||||
<span class="types"><span class="type">point</span></span>
|
||||
<li><span class="parameter">point</span>
|
||||
<span class="types"><span class="type">CallbackPoint</span></span>
|
||||
When should the callback be called?
|
||||
</li>
|
||||
<li><span class="parameter">func</span>
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
<span class="types"><span class="type">LevelFunc</span></span>
|
||||
The function to be called (must be in the <a href="../1 modules/Logic.html#LevelFuncs">LevelFuncs</a> hierarchy). Will receive, as an argument, the time in seconds since the last frame.
|
||||
</li>
|
||||
</ul>
|
||||
|
|
@ -202,13 +212,13 @@ i.e. if you register <code>MyFunc</code> and <code>MyFunc2</code> with <code>PRE
|
|||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">LevelFuncs.MyFunc = <span class="keyword">function</span>(dt) <span class="global">print</span>(dt) <span class="keyword">end</span>
|
||||
TEN.Logic.AddCallback(TEN.Logic.CallbackPoint.PRECONTROLPHASE, LevelFuncs.MyFunc)</pre>
|
||||
TEN.Logic.AddCallback(TEN.Logic.CallbackPoint.PRELOOP, LevelFuncs.MyFunc)</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "RemoveCallback"></a>
|
||||
<strong>RemoveCallback(CallbackPoint, LevelFunc)</strong>
|
||||
<strong>RemoveCallback(point, func)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Deregister a function as a callback.
|
||||
|
|
@ -218,13 +228,13 @@ Will have no effect if the function was not registered as a callback
|
|||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">CallbackPoint</span>
|
||||
<span class="types"><span class="type">point</span></span>
|
||||
<li><span class="parameter">point</span>
|
||||
<span class="types"><span class="type">CallbackPoint</span></span>
|
||||
The callback point the function was registered with. See <a href="../1 modules/Logic.html#AddCallback">AddCallback</a>
|
||||
</li>
|
||||
<li><span class="parameter">LevelFunc</span>
|
||||
<span class="types"><span class="type">func</span></span>
|
||||
the function to remove; must be in the LevelFuncs hierarchy.
|
||||
<li><span class="parameter">func</span>
|
||||
<span class="types"><span class="type">LevelFunc</span></span>
|
||||
The function to remove; must be in the LevelFuncs hierarchy.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
|
@ -233,32 +243,93 @@ Will have no effect if the function was not registered as a callback
|
|||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">TEN.Logic.RemoveCallback(TEN.Logic.CallbackPoint.PRECONTROLPHASE, LevelFuncs.MyFunc)</pre>
|
||||
<pre class="example">TEN.Logic.RemoveCallback(TEN.Logic.CallbackPoint.PRELOOP, LevelFuncs.MyFunc)</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "HandleEvent"></a>
|
||||
<strong>HandleEvent(string, EventType, Moveable)</strong>
|
||||
<strong>HandleEvent(name, type, activator)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Attempt to find an event set and exectute a particular event from it.
|
||||
Attempt to find an event set and execute a particular event from it.
|
||||
|
||||
<p>Possible event type values:</p>
|
||||
<pre class="example">ENTER
|
||||
INSIDE
|
||||
LEAVE
|
||||
LOAD
|
||||
SAVE
|
||||
START
|
||||
END
|
||||
LOOP</pre>
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">name</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
|
||||
Name of the event set to find.
|
||||
</li>
|
||||
<li><span class="parameter">type</span>
|
||||
<span class="types"><span class="type">EventType</span></span>
|
||||
Event to execute.
|
||||
</li>
|
||||
<li><span class="parameter">activator</span>
|
||||
<span class="types"><a class="type" href="../2 classes/Objects.Moveable.html#">Moveable</a></span>
|
||||
Optional activator. Default is the player object.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "EnableEvent"></a>
|
||||
<strong>EnableEvent(name, type)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Attempt to find an event set and enable specified event in it.
|
||||
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">string</span>
|
||||
<span class="types"><span class="type">name</span></span>
|
||||
<li><span class="parameter">name</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
|
||||
Name of the event set to find.
|
||||
</li>
|
||||
<li><span class="parameter">EventType</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#pdf-type">type</a></span>
|
||||
Event to execute.
|
||||
<li><span class="parameter">type</span>
|
||||
<span class="types"><span class="type">EventType</span></span>
|
||||
Event to enable.
|
||||
</li>
|
||||
<li><span class="parameter">Moveable</span>
|
||||
<span class="types"><span class="type">activator</span></span>
|
||||
Optional activator. Default is the player object.
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "DisableEvent"></a>
|
||||
<strong>DisableEvent(name, type)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Attempt to find an event set and disable specified event in it.
|
||||
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">name</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
|
||||
Name of the event set to find.
|
||||
</li>
|
||||
<li><span class="parameter">type</span>
|
||||
<span class="types"><span class="type">EventType</span></span>
|
||||
Event to disable.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
|
@ -390,7 +461,7 @@ you can just leave out <code>LevelFuncs.OnStart</code>.</p>
|
|||
<li>The level script itself is run (i.e. any code you put outside the <a href="../1 modules/Logic.html#LevelFuncs">LevelFuncs</a> callbacks is executed).</li>
|
||||
<li>Save data is loaded, if saving from a saved game (will empty <a href="../1 modules/Logic.html#LevelVars">LevelVars</a> and <a href="../1 modules/Logic.html#GameVars">GameVars</a> and repopulate them with what they contained when the game was saved).</li>
|
||||
<li>If loading from a save, <code>OnLoaded</code> will be called. Otherwise, <code>OnStart</code> will be called.</li>
|
||||
<li>The control loop, in which <code>OnControlPhase</code> will be called once per frame, begins.</li>
|
||||
<li>The control loop, in which <code>OnLoop</code> will be called once per frame, begins.</li>
|
||||
</ol>
|
||||
|
||||
</p>
|
||||
|
|
@ -406,7 +477,7 @@ you can just leave out <code>LevelFuncs.OnStart</code>.</p>
|
|||
<span class="types"><span class="type">function</span></span>
|
||||
Will be called when a saved game is loaded, just <em>after</em> data is loaded
|
||||
</li>
|
||||
<li><span class="parameter">OnControlPhase</span>
|
||||
<li><span class="parameter">OnLoop</span>
|
||||
<span class="types"><span class="type">function(float)</span></span>
|
||||
Will be called during the game's update loop,
|
||||
and provides the delta time (a float representing game time since last call) via its argument.
|
||||
|
|
@ -450,7 +521,7 @@ end
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -473,7 +475,7 @@
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -390,7 +392,7 @@ Returns nil if no voice track is playing or no subtitle present.
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -213,7 +215,7 @@ with a call to <a href="../1 modules/Strings.html#ShowString">ShowString</a>, or
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -118,6 +120,10 @@
|
|||
<td class="summary">Calculate the horizontal distance between two positions.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#GetDisplayPosition">GetDisplayPosition(worldPos)</a></td>
|
||||
<td class="summary">Get the projected display space position of a 3D world position.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#PercentToScreen">PercentToScreen(x, y)</a></td>
|
||||
<td class="summary">Translate a pair display position coordinates to pixel coordinates.</td>
|
||||
</tr>
|
||||
|
|
@ -126,17 +132,18 @@
|
|||
<td class="summary">Translate a pair of pixel coordinates to display position coordinates.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#PickMoveableByDisplayPosition">PickMoveableByDisplayPosition(Display)</a></td>
|
||||
<td class="summary">Pick a moveable by the given display position.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#PickStaticByDisplayPosition">PickStaticByDisplayPosition(Display)</a></td>
|
||||
<td class="summary">Pick a static mesh by the given display position.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#PrintLog">PrintLog(message, logLevel[, allowSpam])</a></td>
|
||||
<td class="summary">Write messages within the Log file</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Fields">Fields</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#worldPos">worldPos</a></td>
|
||||
<td class="summary">Get the projected display space position of a 3D world position.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
|
@ -250,6 +257,41 @@
|
|||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "GetDisplayPosition"></a>
|
||||
<strong>GetDisplayPosition(worldPos)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Get the projected display space position of a 3D world position. Returns nil if the world position is behind the camera view.
|
||||
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">worldPos</span>
|
||||
<span class="types"><a class="type" href="../3 primitive classes/Vec3.html#">Vec3</a></span>
|
||||
3D world position.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../3 primitive classes/Vec2.html#">Vec2</a></span>
|
||||
Projected display space position in percent.
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">Example: Display a <span class="global">string</span> at the player<span class="string">'s position.
|
||||
local string = DisplayString('</span>Example', <span class="number">0</span>, <span class="number">0</span>, Color(<span class="number">255</span>, <span class="number">255</span>, <span class="number">255</span>), <span class="keyword">false</span>)
|
||||
<span class="keyword">local</span> displayPos = GetDisplayPosition(Lara:GetPosition())
|
||||
<span class="global">string</span>:SetPosition(PercentToScreen(displayPos.x, displayPos.y))</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "PercentToScreen"></a>
|
||||
|
|
@ -333,6 +375,62 @@ To be used with <a href="../2 classes/Strings.DisplayString.html#DisplayString:G
|
|||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "PickMoveableByDisplayPosition"></a>
|
||||
<strong>PickMoveableByDisplayPosition(Display)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Pick a moveable by the given display position.
|
||||
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">Display</span>
|
||||
<span class="types"><a class="type" href="../3 primitive classes/Vec2.html#">Vec2</a></span>
|
||||
space position in percent.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../2 classes/Objects.Moveable.html#">Moveable</a></span>
|
||||
Picked moveable (nil if no moveable was found under the cursor).
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "PickStaticByDisplayPosition"></a>
|
||||
<strong>PickStaticByDisplayPosition(Display)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Pick a static mesh by the given display position.
|
||||
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">Display</span>
|
||||
<span class="types"><a class="type" href="../3 primitive classes/Vec2.html#">Vec2</a></span>
|
||||
space position in percent.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../2 classes/Objects.Static.html#">Static</a></span>
|
||||
Picked static mesh (nil if no static mesh was found under the cursor).
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "PrintLog"></a>
|
||||
|
|
@ -377,38 +475,6 @@ PrintLog(<span class="string">'test error log'</span>, LogLevel.ERROR)
|
|||
</span>PrintLog(<span class="string">'test spam log'</span>, LogLevel.INFO, <span class="keyword">true</span>) </pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2 class="section-header "><a name="Fields"></a>Fields</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "worldPos"></a>
|
||||
<strong>worldPos</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Get the projected display space position of a 3D world position. Returns nil if the world position is behind the camera view.
|
||||
|
||||
|
||||
|
||||
<ul>
|
||||
<li><span class="parameter">worldPos</span>
|
||||
<span class="types"><a class="type" href="../3 primitive classes/Vec3.html#">Vec3</a></span>
|
||||
3D world position.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">Example: Display a <span class="global">string</span> at the player<span class="string">'s position.
|
||||
local string = DisplayString('</span>Example', <span class="number">0</span>, <span class="number">0</span>, Color(<span class="number">255</span>, <span class="number">255</span>, <span class="number">255</span>), <span class="keyword">false</span>)
|
||||
<span class="keyword">local</span> displayPos = GetDisplayPosition(Lara:GetPosition())
|
||||
<span class="global">string</span>:SetPosition(PercentToScreen(displayPos.x, displayPos.y))</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
|
@ -417,7 +483,7 @@ local string = DisplayString('</span>Example', <span class="number">0</span>, <s
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -105,10 +107,6 @@
|
|||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#GetAspectRatio">GetAspectRatio()</a></td>
|
||||
<td class="summary">Get the display resolution's aspect ratio.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#FadeIn">FadeIn(speed)</a></td>
|
||||
<td class="summary">Do a full-screen fade-in from black.</td>
|
||||
|
|
@ -126,10 +124,26 @@
|
|||
<td class="summary">Set field of view.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#GetFOV">GetFOV()</a></td>
|
||||
<td class="summary">Get field of view.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#GetCameraType">GetCameraType()</a></td>
|
||||
<td class="summary">Shows the mode of the game camera.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#GetCameraRoom">GetCameraRoom()</a></td>
|
||||
<td class="summary">Gets current room where camera is positioned.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#GetCameraPosition">GetCameraPosition()</a></td>
|
||||
<td class="summary">Gets current camera position.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#GetCameraTarget">GetCameraTarget()</a></td>
|
||||
<td class="summary">Gets current camera target.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#PlayFlyBy">PlayFlyBy(flyby)</a></td>
|
||||
<td class="summary">Enable FlyBy with specific ID</td>
|
||||
</tr>
|
||||
|
|
@ -141,6 +155,10 @@
|
|||
<td class="name" ><a href="#FlashScreen">FlashScreen(color, speed)</a></td>
|
||||
<td class="summary">Flash screen.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#GetAspectRatio">GetAspectRatio()</a></td>
|
||||
<td class="summary">Get the display resolution's aspect ratio.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
|
|
@ -150,27 +168,6 @@
|
|||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "GetAspectRatio"></a>
|
||||
<strong>GetAspectRatio()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Get the display resolution's aspect ratio.
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">float</span></span>
|
||||
Display resolution's aspect ratio.
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "FadeIn"></a>
|
||||
<strong>FadeIn(speed)</strong>
|
||||
|
|
@ -262,6 +259,27 @@
|
|||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "GetFOV"></a>
|
||||
<strong>GetFOV()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Get field of view.
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">float</span></span>
|
||||
current FOV angle in degrees
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "GetCameraType"></a>
|
||||
|
|
@ -284,13 +302,76 @@
|
|||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">LevelFuncs.OnControlPhase = <span class="keyword">function</span>()
|
||||
<pre class="example">LevelFuncs.OnLoop = <span class="keyword">function</span>()
|
||||
<span class="keyword">if</span> (View.GetCameraType() == CameraType.Combat) <span class="keyword">then</span>
|
||||
<span class="comment">--Do your Actions here.
|
||||
</span> <span class="keyword">end</span>
|
||||
<span class="keyword">end</span></pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "GetCameraRoom"></a>
|
||||
<strong>GetCameraRoom()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Gets current room where camera is positioned.
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../2 classes/Objects.Room.html#">Room</a></span>
|
||||
current room of the camera
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "GetCameraPosition"></a>
|
||||
<strong>GetCameraPosition()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Gets current camera position.
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../3 primitive classes/Vec3.html#">Vec3</a></span>
|
||||
current camera position
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "GetCameraTarget"></a>
|
||||
<strong>GetCameraTarget()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Gets current camera target.
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../3 primitive classes/Vec3.html#">Vec3</a></span>
|
||||
current camera target
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "PlayFlyBy"></a>
|
||||
|
|
@ -354,6 +435,27 @@
|
|||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "GetAspectRatio"></a>
|
||||
<strong>GetAspectRatio()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Get the display resolution's aspect ratio.
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">float</span></span>
|
||||
Display resolution's aspect ratio.
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
|
@ -362,7 +464,7 @@
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -114,7 +116,7 @@
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -241,7 +243,7 @@
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -199,7 +201,7 @@ EXAMINE
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -544,7 +546,7 @@ Must be at least 4.</p>
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -114,7 +116,7 @@
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -154,7 +156,7 @@ has an unrecoverable error, the game will close.
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -212,7 +214,7 @@ Less is more. City of The Dead, for example, uses a speed value of 16.
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -415,7 +417,7 @@ aiObj:SetObjectID(TEN.Objects.ObjID.AI_PATROL1)</pre>
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -122,7 +124,7 @@
|
|||
<td class="summary">Set the camera's name (its unique string identifier)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#CameraObject:GetRoom">CameraObject:GetRoom()</a></td>
|
||||
<td class="name" ><a href="#Camera:GetRoom">Camera:GetRoom()</a></td>
|
||||
<td class="summary">Get the current room of the camera</td>
|
||||
</tr>
|
||||
<tr>
|
||||
|
|
@ -234,8 +236,8 @@
|
|||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "CameraObject:GetRoom"></a>
|
||||
<strong>CameraObject:GetRoom()</strong>
|
||||
<a name = "Camera:GetRoom"></a>
|
||||
<strong>Camera:GetRoom()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Get the current room of the camera
|
||||
|
|
@ -328,7 +330,7 @@
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -179,7 +181,11 @@
|
|||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#LaraObject:GetTarget">LaraObject:GetTarget()</a></td>
|
||||
<td class="summary">Get current target enemy, if it exists</td>
|
||||
<td class="summary">Get the player's current targeted moveable (if it exists).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#LaraObject:GetInteractedMoveable">LaraObject:GetInteractedMoveable()</a></td>
|
||||
<td class="summary">Get the player's current interacted moveable (if it exists).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#LaraObject:TorchIsLit">LaraObject:TorchIsLit()</a></td>
|
||||
|
|
@ -656,7 +662,7 @@ ROCKETLAUNCHER
|
|||
<strong>LaraObject:GetTarget()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Get current target enemy, if it exists
|
||||
Get the player's current targeted moveable (if it exists).
|
||||
|
||||
|
||||
|
||||
|
|
@ -665,7 +671,7 @@ ROCKETLAUNCHER
|
|||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../2 classes/Objects.Moveable.html#">Moveable</a></span>
|
||||
current target enemy (nil if no target present)
|
||||
Target moveable (nil if the player is not currently targeting a moveable).
|
||||
</ol>
|
||||
|
||||
|
||||
|
|
@ -675,6 +681,31 @@ ROCKETLAUNCHER
|
|||
<pre class="example"><span class="keyword">local</span> target = Lara:GetTarget()</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "LaraObject:GetInteractedMoveable"></a>
|
||||
<strong>LaraObject:GetInteractedMoveable()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Get the player's current interacted moveable (if it exists).
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../2 classes/Objects.Moveable.html#">Moveable</a></span>
|
||||
Interacted moveable (nil if the player is not interacting with a moveable).
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example"><span class="keyword">local</span> interactedMoveable = Lara:GetInteractedMoveable()</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "LaraObject:TorchIsLit"></a>
|
||||
|
|
@ -708,7 +739,7 @@ ROCKETLAUNCHER
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -131,7 +133,11 @@ associated getters and setters.</td>
|
|||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#Moveable:GetStatus">Moveable:GetStatus()</a></td>
|
||||
<td class="summary">Get the status of object.</td>
|
||||
<td class="summary">Get the moveable's status.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#Moveable:SetStatus">Moveable:SetStatus(status)</a></td>
|
||||
<td class="summary">Set the moveable's status.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#Moveable:SetOnHit">Moveable:SetOnHit(callback)</a></td>
|
||||
|
|
@ -317,9 +323,8 @@ associated getters and setters.</td>
|
|||
<td class="summary">Get the current room number of the object</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#Moveable:SetRoomNumber">Moveable:SetRoomNumber(ID)</a></td>
|
||||
<td class="summary">Set room number of object
|
||||
Use this if you are not using SetPosition's automatic room update - for example, when dealing with overlapping rooms.</td>
|
||||
<td class="name" ><a href="#Moveable:SetRoomNumber">Moveable:SetRoomNumber(roomID)</a></td>
|
||||
<td class="summary">Set the room ID of a moveable.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#Moveable:GetMeshVisible">Moveable:GetMeshVisible(index)</a></td>
|
||||
|
|
@ -430,7 +435,7 @@ most can just be ignored (see usage).
|
|||
</li>
|
||||
<li><span class="parameter">OCB</span>
|
||||
<span class="types"><span class="type">int</span></span>
|
||||
ocb of item (default 0)
|
||||
ocb of item
|
||||
(<em>default</em> 0)
|
||||
</li>
|
||||
<li><span class="parameter">AIBits</span>
|
||||
|
|
@ -570,12 +575,7 @@ most can just be ignored (see usage).
|
|||
<strong>Moveable:GetStatus()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Get the status of object.
|
||||
possible values:
|
||||
<br />0 - not active
|
||||
<br />1 - active
|
||||
<br />2 - deactivated
|
||||
<br />3 - invisible
|
||||
Get the moveable's status. ()
|
||||
|
||||
|
||||
|
||||
|
|
@ -583,13 +583,35 @@ most can just be ignored (see usage).
|
|||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">int</span></span>
|
||||
a number representing the status of the object
|
||||
<span class="types"><a class="type" href="../4 enums/Objects.MoveableStatus.html#">MoveableStatus</a></span>
|
||||
The moveable's status.
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Moveable:SetStatus"></a>
|
||||
<strong>Moveable:SetStatus(status)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Set the moveable's status. ()
|
||||
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">status</span>
|
||||
<span class="types"><a class="type" href="../4 enums/Objects.MoveableStatus.html#">MoveableStatus</a></span>
|
||||
The new status of the moveable.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Moveable:SetOnHit"></a>
|
||||
|
|
@ -1625,19 +1647,19 @@ sas:SetAIBits({<span class="number">1</span>, <span class="number">0</span>, <sp
|
|||
</dd>
|
||||
<dt>
|
||||
<a name = "Moveable:SetRoomNumber"></a>
|
||||
<strong>Moveable:SetRoomNumber(ID)</strong>
|
||||
<strong>Moveable:SetRoomNumber(roomID)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Set room number of object
|
||||
Use this if you are not using SetPosition's automatic room update - for example, when dealing with overlapping rooms.
|
||||
Set the room ID of a moveable.
|
||||
Use this if not using SetPosition's automatic room update - for example, when dealing with overlapping rooms.
|
||||
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">ID</span>
|
||||
<li><span class="parameter">roomID</span>
|
||||
<span class="types"><span class="type">int</span></span>
|
||||
the ID of the new room
|
||||
New room's ID.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
|
@ -1647,8 +1669,8 @@ sas:SetAIBits({<span class="number">1</span>, <span class="number">0</span>, <sp
|
|||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example"><span class="keyword">local</span> sas = TEN.Objects.GetMoveableByName(<span class="string">"sas_enemy"</span>)
|
||||
sas:SetRoomNumber(destinationRoom)
|
||||
sas:SetPosition(destinationPosition, <span class="keyword">false</span>)</pre>
|
||||
sas:SetRoomNumber(newRoomID)
|
||||
sas:SetPosition(newPos, <span class="keyword">false</span>)</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
|
|
@ -1892,7 +1914,7 @@ sas:SetPosition(destinationPosition, <span class="keyword">false</span>)</pre>
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -110,6 +112,10 @@
|
|||
<td class="summary">Determine whether the room is active or not</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#Room:GetColor">Room:GetColor()</a></td>
|
||||
<td class="summary">Get the room's ambient light color.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#Room:GetReverbType">Room:GetReverbType()</a></td>
|
||||
<td class="summary">Get the room's reverb type.</td>
|
||||
</tr>
|
||||
|
|
@ -166,6 +172,27 @@
|
|||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Room:GetColor"></a>
|
||||
<strong>Room:GetColor()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Get the room's ambient light color.
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../3 primitive classes/Color.html#">Color</a></span>
|
||||
ambient light color of the room
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Room:GetReverbType"></a>
|
||||
|
|
@ -342,7 +369,7 @@
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -278,7 +280,7 @@
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -276,7 +278,7 @@
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -562,7 +564,7 @@
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -439,7 +441,7 @@
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -464,7 +466,7 @@ varDisplayString:SetFlags({ TEN.Strings.DisplayStringOption.SHADOW, TEN.Strings.
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -489,7 +491,7 @@
|
|||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">priority</span>
|
||||
<span class="types"><a class="type" href="../4 enums/Objects.ObjID.html#">ObjID</a></span>
|
||||
<span class="types"><span class="type">int</span></span>
|
||||
Draw priority. Can be thought of as a layer, with higher values having precedence. <strong>Default: 0</strong>
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
|
|
@ -522,7 +524,7 @@
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -330,7 +332,7 @@
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -263,7 +265,7 @@
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -480,7 +482,7 @@
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -503,7 +505,7 @@
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <here>Effects.BlendID</here></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -160,7 +162,7 @@ ALPHABLEND
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <here>Effects.EffectID</here></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -158,7 +160,7 @@ CUSTOM
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
167
Documentation/doc/4 enums/Flow.GameStatus.html
Normal file
167
Documentation/doc/4 enums/Flow.GameStatus.html
Normal file
|
|
@ -0,0 +1,167 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||
<head>
|
||||
<title>TombEngine 1.2 Lua API</title>
|
||||
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<div id="container">
|
||||
|
||||
<div id="product">
|
||||
<div id="product_logo"></div>
|
||||
<div id="product_name"><big><b></b></big></div>
|
||||
<div id="product_description"></div>
|
||||
</div> <!-- id="product" -->
|
||||
|
||||
|
||||
<div id="main">
|
||||
|
||||
|
||||
<!-- Menu -->
|
||||
|
||||
<div id="navigation">
|
||||
<br/>
|
||||
<h1>TombEngine</h1>
|
||||
|
||||
<ul>
|
||||
<li><a href="../index.html">Index</a></li>
|
||||
</ul>
|
||||
|
||||
<h2>1 Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li> <a href="../1 modules/Effects.html">Effects</a></li>
|
||||
<li> <a href="../1 modules/Flow.html">Flow</a></li>
|
||||
<li> <a href="../1 modules/Input.html">Input</a></li>
|
||||
<li> <a href="../1 modules/Inventory.html">Inventory</a></li>
|
||||
<li> <a href="../1 modules/Logic.html">Logic</a></li>
|
||||
<li> <a href="../1 modules/Objects.html">Objects</a></li>
|
||||
<li> <a href="../1 modules/Sound.html">Sound</a></li>
|
||||
<li> <a href="../1 modules/Strings.html">Strings</a></li>
|
||||
<li> <a href="../1 modules/Util.html">Util</a></li>
|
||||
<li> <a href="../1 modules/View.html">View</a></li>
|
||||
</ul>
|
||||
<h2>2 Classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li> <a href="../2 classes/View.DisplaySprite.html">View.DisplaySprite</a></li>
|
||||
<li> <a href="../2 classes/Flow.Animations.html">Flow.Animations</a></li>
|
||||
<li> <a href="../2 classes/Flow.Fog.html">Flow.Fog</a></li>
|
||||
<li> <a href="../2 classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
|
||||
<li> <a href="../2 classes/Flow.Level.html">Flow.Level</a></li>
|
||||
<li> <a href="../2 classes/Flow.Mirror.html">Flow.Mirror</a></li>
|
||||
<li> <a href="../2 classes/Flow.Settings.html">Flow.Settings</a></li>
|
||||
<li> <a href="../2 classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
|
||||
<li> <a href="../2 classes/Objects.AIObject.html">Objects.AIObject</a></li>
|
||||
<li> <a href="../2 classes/Objects.Camera.html">Objects.Camera</a></li>
|
||||
<li> <a href="../2 classes/Objects.LaraObject.html">Objects.LaraObject</a></li>
|
||||
<li> <a href="../2 classes/Objects.Moveable.html">Objects.Moveable</a></li>
|
||||
<li> <a href="../2 classes/Objects.Room.html">Objects.Room</a></li>
|
||||
<li> <a href="../2 classes/Objects.Sink.html">Objects.Sink</a></li>
|
||||
<li> <a href="../2 classes/Objects.SoundSource.html">Objects.SoundSource</a></li>
|
||||
<li> <a href="../2 classes/Objects.Static.html">Objects.Static</a></li>
|
||||
<li> <a href="../2 classes/Objects.Volume.html">Objects.Volume</a></li>
|
||||
<li> <a href="../2 classes/Strings.DisplayString.html">Strings.DisplayString</a></li>
|
||||
</ul>
|
||||
<h2>3 Primitive Classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
|
||||
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
|
||||
<li> <a href="../3 primitive classes/Vec2.html">Vec2</a></li>
|
||||
<li> <a href="../3 primitive classes/Vec3.html">Vec3</a></li>
|
||||
</ul>
|
||||
<h2>4 Enums</h2>
|
||||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <here>Flow.GameStatus</here></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
<li> <a href="../4 enums/Sound.SoundTrackType.html">Sound.SoundTrackType</a></li>
|
||||
<li> <a href="../4 enums/Util.LogLevel.html">Util.LogLevel</a></li>
|
||||
<li> <a href="../4 enums/View.AlignMode.html">View.AlignMode</a></li>
|
||||
<li> <a href="../4 enums/View.CameraType.html">View.CameraType</a></li>
|
||||
<li> <a href="../4 enums/View.ScaleMode.html">View.ScaleMode</a></li>
|
||||
</ul>
|
||||
<h2>5 Lua utility modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li> <a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li>
|
||||
<li> <a href="../5 lua utility modules/Timer.html">Timer</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Enum <code>Flow.GameStatus</code></h1>
|
||||
<p>Constants for game statuses.</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
<h2><a href="#Flow_GameStatus_constants">Flow.GameStatus constants </a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#CONSTANT_STRING_HERE">CONSTANT_STRING_HERE</a></td>
|
||||
<td class="summary">Table of game statuses.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2 class="section-header has-description"><a name="Flow_GameStatus_constants"></a>Flow.GameStatus constants </h2>
|
||||
|
||||
<div class="section-description">
|
||||
|
||||
|
||||
|
||||
<p>The following constants are inside Flow.GameStatus.</p>
|
||||
|
||||
<pre><code>NORMAL
|
||||
NEW_GAME
|
||||
LOAD_GAME
|
||||
SAVE_GAME
|
||||
EXIT_TO_TITLE
|
||||
EXIT_GAME
|
||||
LARA_DEAD
|
||||
LEVEL_COMPLETE
|
||||
</code></pre>
|
||||
|
||||
|
||||
</div>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "CONSTANT_STRING_HERE"></a>
|
||||
<strong>CONSTANT_STRING_HERE</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Table of game statuses.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <here>Input.ActionID</here></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -194,7 +196,7 @@ LOAD
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <here>Objects.AmmoType</here></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -107,7 +109,7 @@
|
|||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#CONSTANT_STRING_HERE">CONSTANT_STRING_HERE</a></td>
|
||||
<td class="summary">PlayerAmmoType constants table.</td>
|
||||
<td class="summary">AmmoType constants table.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
|
@ -148,7 +150,7 @@ ROCKET
|
|||
<strong>CONSTANT_STRING_HERE</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
PlayerAmmoType constants table.
|
||||
AmmoType constants table.
|
||||
|
||||
|
||||
|
||||
|
|
@ -165,7 +167,7 @@ ROCKET
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
163
Documentation/doc/4 enums/Objects.MoveableStatus.html
Normal file
163
Documentation/doc/4 enums/Objects.MoveableStatus.html
Normal file
|
|
@ -0,0 +1,163 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||
<head>
|
||||
<title>TombEngine 1.2 Lua API</title>
|
||||
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<div id="container">
|
||||
|
||||
<div id="product">
|
||||
<div id="product_logo"></div>
|
||||
<div id="product_name"><big><b></b></big></div>
|
||||
<div id="product_description"></div>
|
||||
</div> <!-- id="product" -->
|
||||
|
||||
|
||||
<div id="main">
|
||||
|
||||
|
||||
<!-- Menu -->
|
||||
|
||||
<div id="navigation">
|
||||
<br/>
|
||||
<h1>TombEngine</h1>
|
||||
|
||||
<ul>
|
||||
<li><a href="../index.html">Index</a></li>
|
||||
</ul>
|
||||
|
||||
<h2>1 Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li> <a href="../1 modules/Effects.html">Effects</a></li>
|
||||
<li> <a href="../1 modules/Flow.html">Flow</a></li>
|
||||
<li> <a href="../1 modules/Input.html">Input</a></li>
|
||||
<li> <a href="../1 modules/Inventory.html">Inventory</a></li>
|
||||
<li> <a href="../1 modules/Logic.html">Logic</a></li>
|
||||
<li> <a href="../1 modules/Objects.html">Objects</a></li>
|
||||
<li> <a href="../1 modules/Sound.html">Sound</a></li>
|
||||
<li> <a href="../1 modules/Strings.html">Strings</a></li>
|
||||
<li> <a href="../1 modules/Util.html">Util</a></li>
|
||||
<li> <a href="../1 modules/View.html">View</a></li>
|
||||
</ul>
|
||||
<h2>2 Classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li> <a href="../2 classes/View.DisplaySprite.html">View.DisplaySprite</a></li>
|
||||
<li> <a href="../2 classes/Flow.Animations.html">Flow.Animations</a></li>
|
||||
<li> <a href="../2 classes/Flow.Fog.html">Flow.Fog</a></li>
|
||||
<li> <a href="../2 classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
|
||||
<li> <a href="../2 classes/Flow.Level.html">Flow.Level</a></li>
|
||||
<li> <a href="../2 classes/Flow.Mirror.html">Flow.Mirror</a></li>
|
||||
<li> <a href="../2 classes/Flow.Settings.html">Flow.Settings</a></li>
|
||||
<li> <a href="../2 classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
|
||||
<li> <a href="../2 classes/Objects.AIObject.html">Objects.AIObject</a></li>
|
||||
<li> <a href="../2 classes/Objects.Camera.html">Objects.Camera</a></li>
|
||||
<li> <a href="../2 classes/Objects.LaraObject.html">Objects.LaraObject</a></li>
|
||||
<li> <a href="../2 classes/Objects.Moveable.html">Objects.Moveable</a></li>
|
||||
<li> <a href="../2 classes/Objects.Room.html">Objects.Room</a></li>
|
||||
<li> <a href="../2 classes/Objects.Sink.html">Objects.Sink</a></li>
|
||||
<li> <a href="../2 classes/Objects.SoundSource.html">Objects.SoundSource</a></li>
|
||||
<li> <a href="../2 classes/Objects.Static.html">Objects.Static</a></li>
|
||||
<li> <a href="../2 classes/Objects.Volume.html">Objects.Volume</a></li>
|
||||
<li> <a href="../2 classes/Strings.DisplayString.html">Strings.DisplayString</a></li>
|
||||
</ul>
|
||||
<h2>3 Primitive Classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
|
||||
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
|
||||
<li> <a href="../3 primitive classes/Vec2.html">Vec2</a></li>
|
||||
<li> <a href="../3 primitive classes/Vec3.html">Vec3</a></li>
|
||||
</ul>
|
||||
<h2>4 Enums</h2>
|
||||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <here>Objects.MoveableStatus</here></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
<li> <a href="../4 enums/Sound.SoundTrackType.html">Sound.SoundTrackType</a></li>
|
||||
<li> <a href="../4 enums/Util.LogLevel.html">Util.LogLevel</a></li>
|
||||
<li> <a href="../4 enums/View.AlignMode.html">View.AlignMode</a></li>
|
||||
<li> <a href="../4 enums/View.CameraType.html">View.CameraType</a></li>
|
||||
<li> <a href="../4 enums/View.ScaleMode.html">View.ScaleMode</a></li>
|
||||
</ul>
|
||||
<h2>5 Lua utility modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li> <a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li>
|
||||
<li> <a href="../5 lua utility modules/Timer.html">Timer</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Enum <code>Objects.MoveableStatus</code></h1>
|
||||
<p>Constants for moveable statuses.</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
<h2><a href="#Objects_MoveableStatus_constants">Objects.MoveableStatus constants </a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#CONSTANT_STRING_HERE">CONSTANT_STRING_HERE</a></td>
|
||||
<td class="summary">Table of moveable statuses.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2 class="section-header has-description"><a name="Objects_MoveableStatus_constants"></a>Objects.MoveableStatus constants </h2>
|
||||
|
||||
<div class="section-description">
|
||||
|
||||
|
||||
|
||||
<p>The following constants are inside Objects.MoveableStatus.</p>
|
||||
|
||||
<pre><code>INACTIVE
|
||||
ACTIVE
|
||||
DEACTIVATED
|
||||
INVISIBLE
|
||||
</code></pre>
|
||||
|
||||
|
||||
</div>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "CONSTANT_STRING_HERE"></a>
|
||||
<strong>CONSTANT_STRING_HERE</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Table of moveable statuses.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <here>Objects.ObjID</here></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -738,10 +740,10 @@ SHOOT_SWITCH2
|
|||
SHOOT_SWITCH3
|
||||
SHOOT_SWITCH4
|
||||
AIRLOCK_SWITCH
|
||||
UNDERWATER_SWITCH1
|
||||
UNDERWATER_SWITCH2
|
||||
UNDERWATER_SWITCH3
|
||||
UNDERWATER_SWITCH4
|
||||
ID_UNDERWATER_WALL_SWITCH_1
|
||||
ID_UNDERWATER_WALL_SWITCH_2
|
||||
ID_UNDERWATER_CEILING_SWITCH_1
|
||||
ID_UNDERWATER_CEILING_SWITCH_2
|
||||
TURN_SWITCH
|
||||
COG_SWITCH
|
||||
LEVER_SWITCH
|
||||
|
|
@ -1330,7 +1332,7 @@ PC_SAVE_INV_ITEM
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <here>Objects.RoomFlagID</here></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -157,7 +159,7 @@ NOLENSFLARE
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <here>Objects.RoomReverb</here></li>
|
||||
|
|
@ -155,7 +157,7 @@ PIPE
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -153,7 +155,7 @@ VOICE
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -152,7 +154,7 @@ ERROR
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -159,7 +161,7 @@ BOTTOM_RIGHT
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -156,7 +158,7 @@ OBJECT
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -153,7 +155,7 @@ STRETCH
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -355,7 +357,7 @@ LevelFuncs.SpawnBaddy = <span class="keyword">function</span>(baddy, name, pos)
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -101,7 +103,7 @@
|
|||
<p>
|
||||
|
||||
|
||||
<p> Timers are updated automatically every frame before OnControlPhase.</p>
|
||||
<p> Timers are updated automatically every frame before OnLoop.</p>
|
||||
|
||||
<p> Example usage:</p>
|
||||
|
||||
|
|
@ -528,7 +530,7 @@ LevelFuncs.TriggerTimer = <span class="keyword">function</span>(obj)
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@
|
|||
<ul class="nowrap">
|
||||
<li> <a href="4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
||||
<li> <a href="4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
||||
<li> <a href="4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
|
||||
<li> <a href="4 enums/Input.ActionID.html">Input.ActionID</a></li>
|
||||
<li> <a href="4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
|
||||
<li> <a href="4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
|
||||
<li> <a href="4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||||
<li> <a href="4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
|
||||
<li> <a href="4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
|
||||
|
|
@ -266,6 +268,10 @@ local door = GetMoveableByName("door_type4_14")
|
|||
<td class="name" ><a href="4 enums/Effects.EffectID.html">Effects.EffectID</a></td>
|
||||
<td class="summary">Constants for effect IDs.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="4 enums/Flow.GameStatus.html">Flow.GameStatus</a></td>
|
||||
<td class="summary">Constants for game statuses.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="4 enums/Input.ActionID.html">Input.ActionID</a></td>
|
||||
<td class="summary">Constants for action key IDs.</td>
|
||||
|
|
@ -274,6 +280,10 @@ local door = GetMoveableByName("door_type4_14")
|
|||
<td class="name" ><a href="4 enums/Objects.AmmoType.html">Objects.AmmoType</a></td>
|
||||
<td class="summary">Constants for player weapon ammo types.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></td>
|
||||
<td class="summary">Constants for moveable statuses.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="4 enums/Objects.ObjID.html">Objects.ObjID</a></td>
|
||||
<td class="summary">Constants for object IDs.</td>
|
||||
|
|
@ -323,7 +333,7 @@ local door = GetMoveableByName("door_type4_14")
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="https://github.com/hispidence/TEN-LDoc">TEN-LDoc</a> (a fork of <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a>)</i>
|
||||
<i style="float:right;">Last updated 2023-11-11 12:12:55 </i>
|
||||
<i style="float:right;">Last updated 2023-12-26 20:44:45 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -304,7 +304,7 @@
|
|||
<parameters>
|
||||
<parameter>
|
||||
<name>priority</name>
|
||||
<type>Objects.ObjID</type>
|
||||
<type>int</type>
|
||||
<description>Draw priority. Can be thought of as a layer, with higher values having precedence. __Default: 0__</description>
|
||||
</parameter>
|
||||
<parameter>
|
||||
|
|
@ -764,6 +764,18 @@ level count, jumps to title.</description>
|
|||
</parameters>
|
||||
</function>
|
||||
|
||||
<function>
|
||||
<module>Flow</module>
|
||||
<name>GetGameStatus</name>
|
||||
<summary>Get current game status, such as normal game loop, exiting to title, etc.</summary>
|
||||
<returns>
|
||||
<return>
|
||||
<type>Flow.GameStatus</type>
|
||||
<description>the current game status</description>
|
||||
</return>
|
||||
</returns>
|
||||
</function>
|
||||
|
||||
<function>
|
||||
<module>Flow</module>
|
||||
<name>SaveGame</name>
|
||||
|
|
@ -1144,7 +1156,7 @@ e.g. `myItem.action = ItemAction.EXAMINE`</description>
|
|||
|
||||
<function>
|
||||
<module>Input</module>
|
||||
<name>GetCursorDisplayPosition</name>
|
||||
<name>GetMouseDisplayPosition</name>
|
||||
<summary>Get the display position of the cursor in percent.</summary>
|
||||
<description>()</description>
|
||||
<returns>
|
||||
|
|
@ -1239,13 +1251,13 @@ e.g. `myItem.action = ItemAction.EXAMINE`</description>
|
|||
<summary>Register a function as a callback.</summary>
|
||||
<parameters>
|
||||
<parameter>
|
||||
<name>CallbackPoint</name>
|
||||
<type>point</type>
|
||||
<name>point</name>
|
||||
<type>CallbackPoint</type>
|
||||
<description>When should the callback be called?</description>
|
||||
</parameter>
|
||||
<parameter>
|
||||
<name>func</name>
|
||||
<type>function</type>
|
||||
<type>LevelFunc</type>
|
||||
<description>The function to be called (must be in the `LevelFuncs` hierarchy). Will receive, as an argument, the time in seconds since the last frame.</description>
|
||||
</parameter>
|
||||
</parameters>
|
||||
|
|
@ -1258,14 +1270,14 @@ e.g. `myItem.action = ItemAction.EXAMINE`</description>
|
|||
<description>Will have no effect if the function was not registered as a callback</description>
|
||||
<parameters>
|
||||
<parameter>
|
||||
<name>CallbackPoint</name>
|
||||
<type>point</type>
|
||||
<name>point</name>
|
||||
<type>CallbackPoint</type>
|
||||
<description>The callback point the function was registered with. See @{AddCallback}</description>
|
||||
</parameter>
|
||||
<parameter>
|
||||
<name>LevelFunc</name>
|
||||
<type>func</type>
|
||||
<description>the function to remove; must be in the LevelFuncs hierarchy.</description>
|
||||
<name>func</name>
|
||||
<type>LevelFunc</type>
|
||||
<description>The function to remove; must be in the LevelFuncs hierarchy.</description>
|
||||
</parameter>
|
||||
</parameters>
|
||||
</function>
|
||||
|
|
@ -1273,26 +1285,62 @@ e.g. `myItem.action = ItemAction.EXAMINE`</description>
|
|||
<function>
|
||||
<module>Logic</module>
|
||||
<name>HandleEvent</name>
|
||||
<summary>Attempt to find an event set and exectute a particular event from it.</summary>
|
||||
<summary>Attempt to find an event set and execute a particular event from it.</summary>
|
||||
<parameters>
|
||||
<parameter>
|
||||
<name>string</name>
|
||||
<type>name</type>
|
||||
<name>name</name>
|
||||
<type>string</type>
|
||||
<description>Name of the event set to find.</description>
|
||||
</parameter>
|
||||
<parameter>
|
||||
<name>EventType</name>
|
||||
<type>type</type>
|
||||
<name>type</name>
|
||||
<type>EventType</type>
|
||||
<description>Event to execute.</description>
|
||||
</parameter>
|
||||
<parameter>
|
||||
<name>Moveable</name>
|
||||
<type>activator</type>
|
||||
<name>activator</name>
|
||||
<type>Objects.Moveable</type>
|
||||
<description>Optional activator. Default is the player object.</description>
|
||||
</parameter>
|
||||
</parameters>
|
||||
</function>
|
||||
|
||||
<function>
|
||||
<module>Logic</module>
|
||||
<name>EnableEvent</name>
|
||||
<summary>Attempt to find an event set and enable specified event in it.</summary>
|
||||
<parameters>
|
||||
<parameter>
|
||||
<name>name</name>
|
||||
<type>string</type>
|
||||
<description>Name of the event set to find.</description>
|
||||
</parameter>
|
||||
<parameter>
|
||||
<name>type</name>
|
||||
<type>EventType</type>
|
||||
<description>Event to enable.</description>
|
||||
</parameter>
|
||||
</parameters>
|
||||
</function>
|
||||
|
||||
<function>
|
||||
<module>Logic</module>
|
||||
<name>DisableEvent</name>
|
||||
<summary>Attempt to find an event set and disable specified event in it.</summary>
|
||||
<parameters>
|
||||
<parameter>
|
||||
<name>name</name>
|
||||
<type>string</type>
|
||||
<description>Name of the event set to find.</description>
|
||||
</parameter>
|
||||
<parameter>
|
||||
<name>type</name>
|
||||
<type>EventType</type>
|
||||
<description>Event to disable.</description>
|
||||
</parameter>
|
||||
</parameters>
|
||||
</function>
|
||||
|
||||
<function>
|
||||
<module>Objects.AIObject</module>
|
||||
<caller>AIObject</caller>
|
||||
|
|
@ -1506,7 +1554,7 @@ e.g. `myItem.action = ItemAction.EXAMINE`</description>
|
|||
|
||||
<function>
|
||||
<module>Objects.Camera</module>
|
||||
<caller>CameraObject</caller>
|
||||
<caller>Camera</caller>
|
||||
<name>GetRoom</name>
|
||||
<summary>Get the current room of the camera</summary>
|
||||
<returns>
|
||||
|
|
@ -1808,11 +1856,24 @@ e.g. `myItem.action = ItemAction.EXAMINE`</description>
|
|||
<module>Objects.LaraObject</module>
|
||||
<caller>LaraObject</caller>
|
||||
<name>GetTarget</name>
|
||||
<summary>Get current target enemy, if it exists</summary>
|
||||
<summary>Get the player's current targeted moveable (if it exists).</summary>
|
||||
<returns>
|
||||
<return>
|
||||
<type>Objects.Moveable</type>
|
||||
<description>current target enemy (nil if no target present)</description>
|
||||
<description>Target moveable (nil if the player is not currently targeting a moveable).</description>
|
||||
</return>
|
||||
</returns>
|
||||
</function>
|
||||
|
||||
<function>
|
||||
<module>Objects.LaraObject</module>
|
||||
<caller>LaraObject</caller>
|
||||
<name>GetInteractedMoveable</name>
|
||||
<summary>Get the player's current interacted moveable (if it exists).</summary>
|
||||
<returns>
|
||||
<return>
|
||||
<type>Objects.Moveable</type>
|
||||
<description>Interacted moveable (nil if the player is not interacting with a moveable).</description>
|
||||
</return>
|
||||
</returns>
|
||||
</function>
|
||||
|
|
@ -1881,7 +1942,7 @@ most can just be ignored (see usage).</description>
|
|||
<parameter>
|
||||
<name>OCB</name>
|
||||
<type>int</type>
|
||||
<description>ocb of item (default 0)</description>
|
||||
<description>ocb of item</description>
|
||||
</parameter>
|
||||
<parameter>
|
||||
<name>AIBits</name>
|
||||
|
|
@ -1973,20 +2034,31 @@ most can just be ignored (see usage).</description>
|
|||
<module>Objects.Moveable</module>
|
||||
<caller>Moveable</caller>
|
||||
<name>GetStatus</name>
|
||||
<summary>Get the status of object.</summary>
|
||||
<description>possible values:
|
||||
<br />0 - not active
|
||||
<br />1 - active
|
||||
<br />2 - deactivated
|
||||
<br />3 - invisible</description>
|
||||
<summary>Get the moveable's status.</summary>
|
||||
<description>()</description>
|
||||
<returns>
|
||||
<return>
|
||||
<type>int</type>
|
||||
<description>a number representing the status of the object</description>
|
||||
<type>Objects.MoveableStatus</type>
|
||||
<description>The moveable's status.</description>
|
||||
</return>
|
||||
</returns>
|
||||
</function>
|
||||
|
||||
<function>
|
||||
<module>Objects.Moveable</module>
|
||||
<caller>Moveable</caller>
|
||||
<name>SetStatus</name>
|
||||
<summary>Set the moveable's status.</summary>
|
||||
<description>()</description>
|
||||
<parameters>
|
||||
<parameter>
|
||||
<name>status</name>
|
||||
<type>Objects.MoveableStatus</type>
|
||||
<description>The new status of the moveable.</description>
|
||||
</parameter>
|
||||
</parameters>
|
||||
</function>
|
||||
|
||||
<function>
|
||||
<module>Objects.Moveable</module>
|
||||
<caller>Moveable</caller>
|
||||
|
|
@ -2664,13 +2736,13 @@ most can just be ignored (see usage).</description>
|
|||
<module>Objects.Moveable</module>
|
||||
<caller>Moveable</caller>
|
||||
<name>SetRoomNumber</name>
|
||||
<summary>Set room number of object
|
||||
Use this if you are not using SetPosition's automatic room update - for example, when dealing with overlapping rooms.</summary>
|
||||
<summary>Set the room ID of a moveable.</summary>
|
||||
<description>Use this if not using SetPosition's automatic room update - for example, when dealing with overlapping rooms.</description>
|
||||
<parameters>
|
||||
<parameter>
|
||||
<name>ID</name>
|
||||
<name>roomID</name>
|
||||
<type>int</type>
|
||||
<description>the ID of the new room</description>
|
||||
<description>New room's ID.</description>
|
||||
</parameter>
|
||||
</parameters>
|
||||
</function>
|
||||
|
|
@ -3055,6 +3127,19 @@ most can just be ignored (see usage).</description>
|
|||
</returns>
|
||||
</function>
|
||||
|
||||
<function>
|
||||
<module>Objects.Room</module>
|
||||
<caller>Room</caller>
|
||||
<name>GetColor</name>
|
||||
<summary>Get the room's ambient light color.</summary>
|
||||
<returns>
|
||||
<return>
|
||||
<type>Color</type>
|
||||
<description>ambient light color of the room</description>
|
||||
</return>
|
||||
</returns>
|
||||
</function>
|
||||
|
||||
<function>
|
||||
<module>Objects.Room</module>
|
||||
<caller>Room</caller>
|
||||
|
|
@ -4239,6 +4324,26 @@ with a call to @{ShowString}, or this function will have no effect.</description
|
|||
</returns>
|
||||
</function>
|
||||
|
||||
<function>
|
||||
<module>Util</module>
|
||||
<name>GetDisplayPosition</name>
|
||||
<summary>Get the projected display space position of a 3D world position.</summary>
|
||||
<description>Returns nil if the world position is behind the camera view.</description>
|
||||
<parameters>
|
||||
<parameter>
|
||||
<name>worldPos</name>
|
||||
<type>Vec3</type>
|
||||
<description>3D world position.</description>
|
||||
</parameter>
|
||||
</parameters>
|
||||
<returns>
|
||||
<return>
|
||||
<type>Vec2</type>
|
||||
<description>Projected display space position in percent.</description>
|
||||
</return>
|
||||
</returns>
|
||||
</function>
|
||||
|
||||
<function>
|
||||
<module>Util</module>
|
||||
<name>PercentToScreen</name>
|
||||
|
|
@ -4297,6 +4402,44 @@ with a call to @{ShowString}, or this function will have no effect.</description
|
|||
</returns>
|
||||
</function>
|
||||
|
||||
<function>
|
||||
<module>Util</module>
|
||||
<name>PickMoveableByDisplayPosition</name>
|
||||
<summary>Pick a moveable by the given display position.</summary>
|
||||
<parameters>
|
||||
<parameter>
|
||||
<name>Display</name>
|
||||
<type>Vec2</type>
|
||||
<description>space position in percent.</description>
|
||||
</parameter>
|
||||
</parameters>
|
||||
<returns>
|
||||
<return>
|
||||
<type>Objects.Moveable</type>
|
||||
<description>Picked moveable (nil if no moveable was found under the cursor).</description>
|
||||
</return>
|
||||
</returns>
|
||||
</function>
|
||||
|
||||
<function>
|
||||
<module>Util</module>
|
||||
<name>PickStaticByDisplayPosition</name>
|
||||
<summary>Pick a static mesh by the given display position.</summary>
|
||||
<parameters>
|
||||
<parameter>
|
||||
<name>Display</name>
|
||||
<type>Vec2</type>
|
||||
<description>space position in percent.</description>
|
||||
</parameter>
|
||||
</parameters>
|
||||
<returns>
|
||||
<return>
|
||||
<type>Objects.Static</type>
|
||||
<description>Picked static mesh (nil if no static mesh was found under the cursor).</description>
|
||||
</return>
|
||||
</returns>
|
||||
</function>
|
||||
|
||||
<function>
|
||||
<module>Util</module>
|
||||
<name>PrintLog</name>
|
||||
|
|
@ -4731,18 +4874,6 @@ with a call to @{ShowString}, or this function will have no effect.</description
|
|||
</returns>
|
||||
</function>
|
||||
|
||||
<function>
|
||||
<module>View</module>
|
||||
<name>GetAspectRatio</name>
|
||||
<summary>Get the display resolution's aspect ratio.</summary>
|
||||
<returns>
|
||||
<return>
|
||||
<type>float</type>
|
||||
<description>Display resolution's aspect ratio.</description>
|
||||
</return>
|
||||
</returns>
|
||||
</function>
|
||||
|
||||
<function>
|
||||
<module>View</module>
|
||||
<name>FadeIn</name>
|
||||
|
|
@ -4801,6 +4932,18 @@ with a call to @{ShowString}, or this function will have no effect.</description
|
|||
</parameters>
|
||||
</function>
|
||||
|
||||
<function>
|
||||
<module>View</module>
|
||||
<name>GetFOV</name>
|
||||
<summary>Get field of view.</summary>
|
||||
<returns>
|
||||
<return>
|
||||
<type>float</type>
|
||||
<description>current FOV angle in degrees</description>
|
||||
</return>
|
||||
</returns>
|
||||
</function>
|
||||
|
||||
<function>
|
||||
<module>View</module>
|
||||
<name>GetCameraType</name>
|
||||
|
|
@ -4813,6 +4956,42 @@ with a call to @{ShowString}, or this function will have no effect.</description
|
|||
</returns>
|
||||
</function>
|
||||
|
||||
<function>
|
||||
<module>View</module>
|
||||
<name>GetCameraRoom</name>
|
||||
<summary>Gets current room where camera is positioned.</summary>
|
||||
<returns>
|
||||
<return>
|
||||
<type>Objects.Room</type>
|
||||
<description>current room of the camera</description>
|
||||
</return>
|
||||
</returns>
|
||||
</function>
|
||||
|
||||
<function>
|
||||
<module>View</module>
|
||||
<name>GetCameraPosition</name>
|
||||
<summary>Gets current camera position.</summary>
|
||||
<returns>
|
||||
<return>
|
||||
<type>Vec3</type>
|
||||
<description>current camera position</description>
|
||||
</return>
|
||||
</returns>
|
||||
</function>
|
||||
|
||||
<function>
|
||||
<module>View</module>
|
||||
<name>GetCameraTarget</name>
|
||||
<summary>Gets current camera target.</summary>
|
||||
<returns>
|
||||
<return>
|
||||
<type>Vec3</type>
|
||||
<description>current camera target</description>
|
||||
</return>
|
||||
</returns>
|
||||
</function>
|
||||
|
||||
<function>
|
||||
<module>View</module>
|
||||
<name>PlayFlyBy</name>
|
||||
|
|
@ -4850,6 +5029,18 @@ with a call to @{ShowString}, or this function will have no effect.</description
|
|||
</parameters>
|
||||
</function>
|
||||
|
||||
<function>
|
||||
<module>View</module>
|
||||
<name>GetAspectRatio</name>
|
||||
<summary>Get the display resolution's aspect ratio.</summary>
|
||||
<returns>
|
||||
<return>
|
||||
<type>float</type>
|
||||
<description>Display resolution's aspect ratio.</description>
|
||||
</return>
|
||||
</returns>
|
||||
</function>
|
||||
|
||||
<function>
|
||||
<module>EventSequence</module>
|
||||
<name>Create</name>
|
||||
|
|
|
|||
|
|
@ -14,14 +14,14 @@ Constants for game statuses.
|
|||
|
||||
The following constants are inside Flow.GameStatus.
|
||||
|
||||
NORMAL
|
||||
NEW_GAME
|
||||
LOAD_GAME
|
||||
SAVE_GAME
|
||||
EXIT_TO_TITLE
|
||||
EXIT_GAME
|
||||
LARA_DEAD
|
||||
LEVEL_COMPLETE
|
||||
NORMAL
|
||||
NEW_GAME
|
||||
LOAD_GAME
|
||||
SAVE_GAME
|
||||
EXIT_TO_TITLE
|
||||
EXIT_GAME
|
||||
LARA_DEAD
|
||||
LEVEL_COMPLETE
|
||||
|
||||
@section Flow.GameStatus
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -209,7 +209,7 @@ This is intended for module/library developers who want their modules to do
|
|||
stuff during level start/load/end/save/control phase, but don't want the level
|
||||
designer to add calls to `OnStart`, `OnLoad`, etc. in their level script.
|
||||
|
||||
Possible values for CallbackPoint:
|
||||
Possible values for `point`:
|
||||
-- These take functions which accept no arguments
|
||||
PRESTART -- will be called immediately before OnStart
|
||||
POSTSTART -- will be called immediately after OnStart
|
||||
|
|
@ -281,12 +281,23 @@ void LogicHandler::RemoveCallback(CallbackPoint point, const LevelFunc& levelFun
|
|||
it->second->erase(levelFunc.m_funcName);
|
||||
}
|
||||
|
||||
/*** Attempt to find an event set and exectute a particular event from it.
|
||||
/*** Attempt to find an event set and execute a particular event from it.
|
||||
@advancedDesc
|
||||
|
||||
Possible event type values:
|
||||
ENTER
|
||||
INSIDE
|
||||
LEAVE
|
||||
LOAD
|
||||
SAVE
|
||||
START
|
||||
END
|
||||
LOOP
|
||||
|
||||
@function HandleEvent
|
||||
@tparam string name Name of the event set to find.
|
||||
@tparam EventType type Event to execute.
|
||||
@tparam Moveable activator Optional activator. Default is the player object.
|
||||
@tparam Objects.Moveable activator Optional activator. Default is the player object.
|
||||
*/
|
||||
void LogicHandler::HandleEvent(const std::string& name, EventType type, sol::optional<Moveable&> activator)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -193,12 +193,12 @@ void Moveable::Register(sol::state& state, sol::table& parent)
|
|||
|
||||
/// Get the moveable's status.
|
||||
// @function Moveable:GetStatus()
|
||||
// @treturn MoveableEnum.Status The moveable's status.
|
||||
// @treturn Objects.MoveableStatus The moveable's status.
|
||||
ScriptReserved_GetStatus, &Moveable::GetStatus,
|
||||
|
||||
/// Set the moveable's status.
|
||||
// @function Moveable:SetStatus()
|
||||
// @tparam MoveableEnum.Status status The new status of the moveable.
|
||||
// @tparam Objects.MoveableStatus status The new status of the moveable.
|
||||
ScriptReserved_SetStatus, &Moveable::SetStatus,
|
||||
|
||||
/// Set the name of the function to be called when the moveable is shot by Lara.
|
||||
|
|
|
|||
|
|
@ -14,10 +14,10 @@ Constants for moveable statuses.
|
|||
|
||||
The following constants are inside Objects.MoveableStatus.
|
||||
|
||||
INACTIVE
|
||||
ACTIVE
|
||||
DEACTIVATED
|
||||
INVISIBLE
|
||||
INACTIVE
|
||||
ACTIVE
|
||||
DEACTIVATED
|
||||
INVISIBLE
|
||||
|
||||
@section Objects.MoveableStatus
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -71,7 +71,7 @@ namespace TEN::Scripting::Util
|
|||
/// Get the projected display space position of a 3D world position. Returns nil if the world position is behind the camera view.
|
||||
// @function GetDisplayPosition
|
||||
// @tparam Vec3 worldPos 3D world position.
|
||||
// @return Vec2 Projected display space position in percent.
|
||||
// @treturn Vec2 Projected display space position in percent.
|
||||
// @usage
|
||||
// Example: Display a string at the player's position.
|
||||
// local string = DisplayString('Example', 0, 0, Color(255, 255, 255), false)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue