Archive/TombEngine
0
0
Fork 0
mirror of https://github.com/TombEngine/TombEngine.git synced 2025-04-28 15:57:59 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions
TombEngine/Documentation/doc/2 classes/Objects.Static.html

686 lines
17 KiB
HTML
Raw Blame History

<!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.8 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>&nbsp;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/Collision.Probe.html">Collision.Probe</a></li>
<li> <a href="../2 classes/Flow.Level.html">Flow.Level</a></li>
<li> <a href="../2 classes/Flow.Settings.html">Flow.Settings</a></li>
<li> <a href="../2 classes/Flow.Statistics.html">Flow.Statistics</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>
<li> <a href="../2 classes/View.DisplaySprite.html">View.DisplaySprite</a></li>
</ul>
<h2>3 Primitive Classes</h2>
<ul class="nowrap">
<li> <a href="../3 primitive classes/Flow.Fog.html">Flow.Fog</a></li>
<li> <a href="../3 primitive classes/Flow.Horizon.html">Flow.Horizon</a></li>
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
<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/Time.html">Time</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/Collision.MaterialType.html">Collision.MaterialType</a></li>
<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/Effects.FeatherMode.html">Effects.FeatherMode</a></li>
<li> <a href="../4 enums/Effects.ParticleAnimationType.html">Effects.ParticleAnimationType</a></li>
<li> <a href="../4 enums/Flow.ErrorMode.html">Flow.ErrorMode</a></li>
<li> <a href="../4 enums/Flow.FreezeMode.html">Flow.FreezeMode</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.HandStatus.html">Objects.HandStatus</a></li>
<li> <a href="../4 enums/Objects.WeaponType.html">Objects.WeaponType</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/Strings.DisplayStringOption.html">Strings.DisplayStringOption</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.PostProcessMode.html">View.PostProcessMode</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/CustomBar.html">CustomBar</a></li>
<li> <a href="../5 lua utility modules/Diary.html">Diary</a></li>
<li> <a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li>
<li> <a href="../5 lua utility modules/Timer.html">Timer</a></li>
<li> <a href="../5 lua utility modules/Type.html">Type</a></li>
</ul>
</div>
<div id="content">
<h1>Class <code>Objects.Static</code></h1>
<p>Represents a static object in the game world.</p>
<p>
</p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" ><a href="#Static:GetName">Static:GetName()</a></td>
<td class="summary">Get this static's unique string identifier.</td>
</tr>
<tr>
<td class="name" ><a href="#Static:GetSlot">Static:GetSlot()</a></td>
<td class="summary">Get this static's slot ID.</td>
</tr>
<tr>
<td class="name" ><a href="#Static:GetPosition">Static:GetPosition()</a></td>
<td class="summary">Get this static's world position.</td>
</tr>
<tr>
<td class="name" ><a href="#Static:GetRotation">Static:GetRotation()</a></td>
<td class="summary">Get this static's world rotation.</td>
</tr>
<tr>
<td class="name" ><a href="#Static:GetScale">Static:GetScale()</a></td>
<td class="summary">Get this static's world scale.</td>
</tr>
<tr>
<td class="name" ><a href="#Static:GetColor">Static:GetColor()</a></td>
<td class="summary">Get this static's color.</td>
</tr>
<tr>
<td class="name" ><a href="#Static:GetHP">Static:GetHP()</a></td>
<td class="summary">Get this static's hit points.</td>
</tr>
<tr>
<td class="name" ><a href="#Static:GetActive">Static:GetActive()</a></td>
<td class="summary">Get this static's visibility status.</td>
</tr>
<tr>
<td class="name" ><a href="#Static:GetCollidable">Static:GetCollidable()</a></td>
<td class="summary">Get this static's collision status.</td>
</tr>
<tr>
<td class="name" ><a href="#Static:GetSolid">Static:GetSolid()</a></td>
<td class="summary">Get this static's solid collision status.</td>
</tr>
<tr>
<td class="name" ><a href="#Static:SetName">Static:SetName(name)</a></td>
<td class="summary">Set this static's unique identifier string.</td>
</tr>
<tr>
<td class="name" ><a href="#Static:SetSlot">Static:SetSlot(slotID)</a></td>
<td class="summary">Set this static's slot ID.</td>
</tr>
<tr>
<td class="name" ><a href="#Static:SetPosition">Static:SetPosition(pos)</a></td>
<td class="summary">Set this static's world position.</td>
</tr>
<tr>
<td class="name" ><a href="#Static:SetRotation">Static:SetRotation(rot)</a></td>
<td class="summary">Set this static's rotation.</td>
</tr>
<tr>
<td class="name" ><a href="#Static:SetScale">Static:SetScale(scale)</a></td>
<td class="summary">Set this static's world scale.</td>
</tr>
<tr>
<td class="name" ><a href="#Static:SetColor">Static:SetColor(color)</a></td>
<td class="summary">Set this static's color.</td>
</tr>
<tr>
<td class="name" ><a href="#Static:SetHP">Static:SetHP(hitPoints)</a></td>
<td class="summary">Set this static's hit points.</td>
</tr>
<tr>
<td class="name" ><a href="#Static:SetSolid">Static:SetSolid(status)</a></td>
<td class="summary">Set this static's solid collision status.</td>
</tr>
<tr>
<td class="name" ><a href="#Static:SetCollidable">Static:SetCollidable(collidable)</a></td>
<td class="summary">Set this static's collision status.</td>
</tr>
<tr>
<td class="name" ><a href="#Static:Enable">Static:Enable()</a></td>
<td class="summary">Enable this static.</td>
</tr>
<tr>
<td class="name" ><a href="#Static:Disable">Static:Disable()</a></td>
<td class="summary">Disable this static.</td>
</tr>
<tr>
<td class="name" ><a href="#Static:Shatter">Static:Shatter()</a></td>
<td class="summary">Shatter this static.</td>
</tr>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "Static:GetName"></a>
<strong>Static:GetName()</strong>
</dt>
<dd>
Get this 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>
Name string.
</ol>
</dd>
<dt>
<a name = "Static:GetSlot"></a>
<strong>Static:GetSlot()</strong>
</dt>
<dd>
Get this static's slot ID.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">int</span></span>
Slot ID.
</ol>
</dd>
<dt>
<a name = "Static:GetPosition"></a>
<strong>Static:GetPosition()</strong>
</dt>
<dd>
Get this static's world position.
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../3 primitive classes/Vec3.html#">Vec3</a></span>
World position.
</ol>
</dd>
<dt>
<a name = "Static:GetRotation"></a>
<strong>Static:GetRotation()</strong>
</dt>
<dd>
Get this static's world rotation.
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../3 primitive classes/Rotation.html#">Rotation</a></span>
World rotation.
</ol>
</dd>
<dt>
<a name = "Static:GetScale"></a>
<strong>Static:GetScale()</strong>
</dt>
<dd>
Get this static's world scale.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">float</span></span>
World scale.
</ol>
</dd>
<dt>
<a name = "Static:GetColor"></a>
<strong>Static:GetColor()</strong>
</dt>
<dd>
Get this static's color.
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../3 primitive classes/Color.html#">Color</a></span>
Color.
</ol>
</dd>
<dt>
<a name = "Static:GetHP"></a>
<strong>Static:GetHP()</strong>
</dt>
<dd>
Get this static's hit points. Used only with shatterable statics.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">int</span></span>
Hit points.
</ol>
</dd>
<dt>
<a name = "Static:GetActive"></a>
<strong>Static:GetActive()</strong>
</dt>
<dd>
Get this static's visibility status.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
Status. <strong>true: visible</strong>, <strong>false: invisible</strong>
</ol>
</dd>
<dt>
<a name = "Static:GetCollidable"></a>
<strong>Static:GetCollidable()</strong>
</dt>
<dd>
Get this static's collision status.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
Collision status. <strong>true: can be collided with</strong>, <strong>false: no collision</strong>
</ol>
</dd>
<dt>
<a name = "Static:GetSolid"></a>
<strong>Static:GetSolid()</strong>
</dt>
<dd>
Get this static's solid collision status.
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">bool</span></span>
Solid Status. <strong>true: solid</strong>, <strong>false: soft</strong>
</ol>
</dd>
<dt>
<a name = "Static:SetName"></a>
<strong>Static:SetName(name)</strong>
</dt>
<dd>
Set this static's unique identifier string.
<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>
New name.
</li>
</ul>
</dd>
<dt>
<a name = "Static:SetSlot"></a>
<strong>Static:SetSlot(slotID)</strong>
</dt>
<dd>
Set this static's slot ID.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">slotID</span>
<span class="types"><span class="type">int</span></span>
New slot ID.
</li>
</ul>
</dd>
<dt>
<a name = "Static:SetPosition"></a>
<strong>Static:SetPosition(pos)</strong>
</dt>
<dd>
Set this static's world position.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">pos</span>
<span class="types"><a class="type" href="../3 primitive classes/Vec3.html#">Vec3</a></span>
New world position.
</li>
</ul>
</dd>
<dt>
<a name = "Static:SetRotation"></a>
<strong>Static:SetRotation(rot)</strong>
</dt>
<dd>
Set this static's rotation.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">rot</span>
<span class="types"><a class="type" href="../3 primitive classes/Rotation.html#">Rotation</a></span>
New rotation.
</li>
</ul>
</dd>
<dt>
<a name = "Static:SetScale"></a>
<strong>Static:SetScale(scale)</strong>
</dt>
<dd>
Set this static's world scale.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">scale</span>
<span class="types"><span class="type">float</span></span>
New world scale.
</li>
</ul>
</dd>
<dt>
<a name = "Static:SetColor"></a>
<strong>Static:SetColor(color)</strong>
</dt>
<dd>
Set this 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>
New color.
</li>
</ul>
</dd>
<dt>
<a name = "Static:SetHP"></a>
<strong>Static:SetHP(hitPoints)</strong>
</dt>
<dd>
Set this static's hit points. Used only with shatterable statics.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">hitPoints</span>
<span class="types"><span class="type">int</span></span>
New hit points.
</li>
</ul>
</dd>
<dt>
<a name = "Static:SetSolid"></a>
<strong>Static:SetSolid(status)</strong>
</dt>
<dd>
Set this static's solid collision status.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">status</span>
<span class="types"><span class="type">bool</span></span>
New status. <strong>true: solid</strong>, <strong>false: soft</strong>
</li>
</ul>
</dd>
<dt>
<a name = "Static:SetCollidable"></a>
<strong>Static:SetCollidable(collidable)</strong>
</dt>
<dd>
Set this static's collision status.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">collidable</span>
<span class="types"><span class="type">bool</span></span>
New collision status. <strong>true: can be collided with</strong>, <strong>false: no collision</strong>
</li>
</ul>
</dd>
<dt>
<a name = "Static:Enable"></a>
<strong>Static:Enable()</strong>
</dt>
<dd>
Enable this static. Used when previously shattered disabled manually.
</dd>
<dt>
<a name = "Static:Disable"></a>
<strong>Static:Disable()</strong>
</dt>
<dd>
Disable this static.
</dd>
<dt>
<a name = "Static:Shatter"></a>
<strong>Static:Shatter()</strong>
</dt>
<dd>
Shatter this static.
</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>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>
Reference in a new issue View git blame Copy permalink