mirror of
https://github.com/TombEngine/TombEngine.git
synced 2025-04-28 15:57:59 +03:00
562 lines
13 KiB
HTML
562 lines
13 KiB
HTML
<!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.1.0 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/Inventory.html">Inventory</a></li>
|
|
<li> <a href="../1 modules/Logic.html">Logic</a></li>
|
|
<li> <a href="../1 modules/Misc.html">Misc</a></li>
|
|
<li> <a href="../1 modules/Objects.html">Objects</a></li>
|
|
<li> <a href="../1 modules/Strings.html">Strings</a></li>
|
|
</ul>
|
|
<h2>2 Classes</h2>
|
|
<ul class="nowrap">
|
|
<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> <here>Objects.Static</here></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/Misc.ActionID.html">Misc.ActionID</a></li>
|
|
<li> <a href="../4 enums/Misc.CameraType.html">Misc.CameraType</a></li>
|
|
<li> <a href="../4 enums/Misc.LogLevel.html">Misc.LogLevel</a></li>
|
|
<li> <a href="../4 enums/Misc.SoundTrackType.html">Misc.SoundTrackType</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>
|
|
</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>Class <code>Objects.Static</code></h1>
|
|
<p>Statics</p>
|
|
<p>
|
|
|
|
</p>
|
|
|
|
|
|
<h2><a href="#Functions">Functions</a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" ><a href="#Static:Enable">Static:Enable()</a></td>
|
|
<td class="summary">Enable the static, for cases when it was shattered or manually disabled before.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#Static:Disable">Static:Disable()</a></td>
|
|
<td class="summary">Disable the static</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#Static:GetActive">Static:GetActive()</a></td>
|
|
<td class="summary">Get static mesh visibility</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#Static:GetSolid">Static:GetSolid()</a></td>
|
|
<td class="summary">Get static mesh solid collision state</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#Static:SetSolid">Static:SetSolid(solidState)</a></td>
|
|
<td class="summary">Set static mesh solid collision state</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#Static:GetPosition">Static:GetPosition()</a></td>
|
|
<td class="summary">Get the static's position</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#Static:SetPosition">Static:SetPosition(position)</a></td>
|
|
<td class="summary">Set the static's position</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#Static:GetRotation">Static:GetRotation()</a></td>
|
|
<td class="summary">Get the static's rotation</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#Static:SetRotation">Static:SetRotation(rotation)</a></td>
|
|
<td class="summary">Set the static's rotation</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#Static:GetScale">Static:GetScale()</a></td>
|
|
<td class="summary">Get the static's scale</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#Static:SetScale">Static:SetScale(scale)</a></td>
|
|
<td class="summary">Set the static's scale</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#Static:GetName">Static:GetName()</a></td>
|
|
<td class="summary">Get the static's unique string identifier</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#Static:SetName">Static:SetName(name)</a></td>
|
|
<td class="summary">Set the static's name (its unique string identifier)
|
|
e.g.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#Static:GetSlot">Static:GetSlot()</a></td>
|
|
<td class="summary">Get the static's slot number (as listed in Tomb Editor and WadTool)</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#Static:SetSlot">Static:SetSlot(slot)</a></td>
|
|
<td class="summary">Set the static's slot number (as listed in Tomb Editor and WadTool)</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#Static:GetColor">Static:GetColor()</a></td>
|
|
<td class="summary">Get the static's color</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#Static:SetColor">Static:SetColor(color)</a></td>
|
|
<td class="summary">Set the static's color</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#Static:Shatter">Static:Shatter()</a></td>
|
|
<td class="summary">Shatter static mesh</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br/>
|
|
<br/>
|
|
|
|
|
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
|
|
|
<dl class="function">
|
|
<dt>
|
|
<a name = "Static:Enable"></a>
|
|
<strong>Static:Enable()</strong>
|
|
</dt>
|
|
<dd>
|
|
Enable the static, for cases when it was shattered or manually disabled before.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "Static:Disable"></a>
|
|
<strong>Static:Disable()</strong>
|
|
</dt>
|
|
<dd>
|
|
Disable the static
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "Static:GetActive"></a>
|
|
<strong>Static:GetActive()</strong>
|
|
</dt>
|
|
<dd>
|
|
Get static mesh visibility
|
|
|
|
|
|
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><span class="type">bool</span></span>
|
|
visibility state
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "Static:GetSolid"></a>
|
|
<strong>Static:GetSolid()</strong>
|
|
</dt>
|
|
<dd>
|
|
Get static mesh solid collision state
|
|
|
|
|
|
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><span class="type">bool</span></span>
|
|
solid collision state (true if solid, false if soft)
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "Static:SetSolid"></a>
|
|
<strong>Static:SetSolid(solidState)</strong>
|
|
</dt>
|
|
<dd>
|
|
Set static mesh solid collision state
|
|
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">solidState</span>
|
|
<span class="types"><span class="type">bool</span></span>
|
|
if set, collision will be solid, if not, will be soft
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "Static:GetPosition"></a>
|
|
<strong>Static:GetPosition()</strong>
|
|
</dt>
|
|
<dd>
|
|
Get the static's position
|
|
|
|
|
|
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><a class="type" href="../3 primitive classes/Vec3.html#">Vec3</a></span>
|
|
a copy of the static's position
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "Static:SetPosition"></a>
|
|
<strong>Static:SetPosition(position)</strong>
|
|
</dt>
|
|
<dd>
|
|
Set the static's position
|
|
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">position</span>
|
|
<span class="types"><a class="type" href="../3 primitive classes/Vec3.html#">Vec3</a></span>
|
|
the new position of the static
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "Static:GetRotation"></a>
|
|
<strong>Static:GetRotation()</strong>
|
|
</dt>
|
|
<dd>
|
|
Get the static's rotation
|
|
|
|
|
|
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><a class="type" href="../3 primitive classes/Rotation.html#">Rotation</a></span>
|
|
a copy of the static's rotation
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "Static:SetRotation"></a>
|
|
<strong>Static:SetRotation(rotation)</strong>
|
|
</dt>
|
|
<dd>
|
|
Set the static's rotation
|
|
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">rotation</span>
|
|
<span class="types"><a class="type" href="../3 primitive classes/Rotation.html#">Rotation</a></span>
|
|
the static's new rotation
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "Static:GetScale"></a>
|
|
<strong>Static:GetScale()</strong>
|
|
</dt>
|
|
<dd>
|
|
Get the static's scale
|
|
|
|
|
|
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><span class="type">float</span></span>
|
|
current static scale
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "Static:SetScale"></a>
|
|
<strong>Static:SetScale(scale)</strong>
|
|
</dt>
|
|
<dd>
|
|
Set the static's scale
|
|
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">scale</span>
|
|
<span class="types"><span class="type">Scale</span></span>
|
|
the static's new scale
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "Static:GetName"></a>
|
|
<strong>Static:GetName()</strong>
|
|
</dt>
|
|
<dd>
|
|
Get the static's unique string identifier
|
|
|
|
|
|
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
|
|
the static's name
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "Static:SetName"></a>
|
|
<strong>Static:SetName(name)</strong>
|
|
</dt>
|
|
<dd>
|
|
Set the static's name (its unique string identifier)
|
|
e.g. "my_vase" or "oldrubble"
|
|
|
|
|
|
|
|
<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>
|
|
The static's new name
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "Static:GetSlot"></a>
|
|
<strong>Static:GetSlot()</strong>
|
|
</dt>
|
|
<dd>
|
|
Get the static's slot number (as listed in Tomb Editor and WadTool)
|
|
|
|
|
|
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
|
|
the static's slot number
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "Static:SetSlot"></a>
|
|
<strong>Static:SetSlot(slot)</strong>
|
|
</dt>
|
|
<dd>
|
|
Set the static's slot number (as listed in Tomb Editor and WadTool)
|
|
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">slot</span>
|
|
<span class="types"><span class="type">int</span></span>
|
|
The static's slot number
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "Static:GetColor"></a>
|
|
<strong>Static:GetColor()</strong>
|
|
</dt>
|
|
<dd>
|
|
Get the static's color
|
|
|
|
|
|
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><a class="type" href="../3 primitive classes/Color.html#">Color</a></span>
|
|
a copy of the static's color
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "Static:SetColor"></a>
|
|
<strong>Static:SetColor(color)</strong>
|
|
</dt>
|
|
<dd>
|
|
Set the static's color
|
|
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">color</span>
|
|
<span class="types"><a class="type" href="../3 primitive classes/Color.html#">Color</a></span>
|
|
the new color of the static
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "Static:Shatter"></a>
|
|
<strong>Static:Shatter()</strong>
|
|
</dt>
|
|
<dd>
|
|
Shatter static mesh
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</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-07-20 12:10:11 </i>
|
|
</div> <!-- id="about" -->
|
|
</div> <!-- id="container" -->
|
|
</body>
|
|
</html>
|