mirror of
https://github.com/TombEngine/TombEngine.git
synced 2025-04-28 15:57:59 +03:00
d19d56acee
* First Commit * Make ScriptCollision class * Fix typo * Return correct types * Use NO_HEIGHT * Implement GetSurfaceMaterial * Add enums * Added death, climbable wall, monkeybar * FIx angle * Revise things * Make "Collision" script module; add IsOutOfBounds() method * Rename IsOutOfBounds() * Allow getting floor or ceiling material type * Don't need IsWall() * Update Collision.cpp * Restore IsWall() * Rename class to "Probe"; start docs; make steepness inquirers return an optional * Update Probe.cpp * Update class name in doc * Update Probe.cpp * add GetRoomName * UpdateEnums * Update MaterialType enum; make room name getting more local * Revise constructors; update doc * Update Probe.cpp * Generate html docs * Slightly clearer doc comments * Convert spaces to tabs * Update Probe.cpp * Update Probe.cpp * Rename parameters * Update Probe.cpp * ScriptProbe -> Probe * ExposeGetRoom * Register Collision.MaterialType table; Enable ClimbWall again. * Cleanup * Docs revision * Update CHANGELOG.md * Moved names to script reserved names * Fixed incorrect namespace for probe * Use consistent names; cleanup * Make argument optional; fix doc * Update Probe.cpp * Add missing includes * Add Preview() method; update docs * Add constant --------- Co-authored-by: Sezz <sezzary@outlook.com> Co-authored-by: Lwmte <3331699+Lwmte@users.noreply.github.com>
477 lines
16 KiB
HTML
477 lines
16 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.7.2 (Developer) 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/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> <a href="../2 classes/Objects.Static.html">Objects.Static</a></li>
|
|
<li> <a href="../2 classes/Objects.Volume.html">Objects.Volume</a></li>
|
|
<li> <here>Strings.DisplayString</here></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.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/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/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>Strings.DisplayString</code></h1>
|
|
<p>A string appearing on the screen.</p>
|
|
<p>Can be used for subtitles and "2001, somewhere in Egypt"-style messages.</p>
|
|
|
|
<p>Uses screen-space coordinates, with x values specifying the number of pixels from the left of the window,
|
|
and y values specifying the number of pixels from the top of the window.</p>
|
|
|
|
<p>Since different players will have different resolutions, you should work in terms of percentages where possible,
|
|
and use <a href="../1 modules/Util.html#ScreenToPercent">ScreenToPercent</a> and <a href="../1 modules/Util.html#PercentToScreen">PercentToScreen</a>
|
|
when you need to use screen-space coordinates.</p>
|
|
|
|
|
|
<h2><a href="#Functions">Functions</a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" ><a href="#DisplayString">DisplayString(string, Position[, scale][, color][, translated], table)</a></td>
|
|
<td class="summary">Create a DisplayString.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#DisplayString:GetColor">DisplayString:GetColor()</a></td>
|
|
<td class="summary">Get the display string's color</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#DisplayString:SetColor">DisplayString:SetColor(color)</a></td>
|
|
<td class="summary">Set the display string's color</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#DisplayString:GetKey">DisplayString:GetKey()</a></td>
|
|
<td class="summary">Get the string key to use.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#DisplayString:SetKey">DisplayString:SetKey(string)</a></td>
|
|
<td class="summary">Set the string key to use.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#DisplayString:SetScale">DisplayString:SetScale(scale)</a></td>
|
|
<td class="summary">Set the scale of the string.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#DisplayString:GetScale">DisplayString:GetScale()</a></td>
|
|
<td class="summary">Get the scale of the string.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#DisplayString:SetPosition">DisplayString:SetPosition(pos)</a></td>
|
|
<td class="summary">Set the position of the string.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#DisplayString:GetPosition">DisplayString:GetPosition()</a></td>
|
|
<td class="summary">Get the position of the string.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#DisplayString:SetFlags">DisplayString:SetFlags(table)</a></td>
|
|
<td class="summary">Set the display string's flags</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#DisplayString:SetTranslated">DisplayString:SetTranslated(shouldTranslate)</a></td>
|
|
<td class="summary">Set translated parameter of the string</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br/>
|
|
<br/>
|
|
|
|
|
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
|
|
|
<dl class="function">
|
|
<dt>
|
|
<a name = "DisplayString"></a>
|
|
<strong>DisplayString(string, Position[, scale][, color][, translated], table)</strong>
|
|
</dt>
|
|
<dd>
|
|
Create a DisplayString.
|
|
For use in <a href="../1 modules/Strings.html#ShowString">ShowString</a> and <a href="../1 modules/Strings.html#HideString">HideString</a>.
|
|
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">string</span>
|
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
|
|
The string to display or key of the translated string.
|
|
</li>
|
|
<li><span class="parameter">Position</span>
|
|
<span class="types"><a class="type" href="../3 primitive classes/Vec2.html#">Vec2</a></span>
|
|
of the string in pixel coordinates.
|
|
</li>
|
|
<li><span class="parameter">scale</span>
|
|
<span class="types"><span class="type">float</span></span>
|
|
size of the string, relative to the default size. <strong>Default: 1.0</strong>
|
|
(<em>optional</em>)
|
|
</li>
|
|
<li><span class="parameter">color</span>
|
|
<span class="types"><a class="type" href="../3 primitive classes/Color.html#">Color</a></span>
|
|
the color of the text. <strong>Default: white</strong>
|
|
(<em>optional</em>)
|
|
</li>
|
|
<li><span class="parameter">translated</span>
|
|
<span class="types"><span class="type">bool</span></span>
|
|
If false or omitted, the input string argument will be displayed.
|
|
If true, the string argument will be the key of a translated string specified in strings.lua. <strong>Default: false</strong>.
|
|
(<em>optional</em>)
|
|
</li>
|
|
<li><span class="parameter">table</span>
|
|
<span class="types"><a class="type" href="../4 enums/Strings.DisplayStringOption.html#">DisplayStringOption</a></span>
|
|
<strong>Default: None.</strong> <em>Please note that Strings are automatically aligned to the LEFT</em>
|
|
</li>
|
|
</ul>
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><a class="type" href="../2 classes/Strings.DisplayString.html#DisplayString">DisplayString</a></span>
|
|
A new DisplayString object.
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "DisplayString:GetColor"></a>
|
|
<strong>DisplayString:GetColor()</strong>
|
|
</dt>
|
|
<dd>
|
|
Get the display string'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 display string's color
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "DisplayString:SetColor"></a>
|
|
<strong>DisplayString:SetColor(color)</strong>
|
|
</dt>
|
|
<dd>
|
|
Set the display string'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 display string
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "DisplayString:GetKey"></a>
|
|
<strong>DisplayString:GetKey()</strong>
|
|
</dt>
|
|
<dd>
|
|
Get the string key to use. If <code>isTranslated</code> is true when <a href="../2 classes/Strings.DisplayString.html#DisplayString">DisplayString</a>
|
|
is called, this will be the string key for the translation that will be displayed.
|
|
If false or omitted, this will be the string that's displayed.()
|
|
|
|
|
|
|
|
|
|
<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 string to use
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "DisplayString:SetKey"></a>
|
|
<strong>DisplayString:SetKey(string)</strong>
|
|
</dt>
|
|
<dd>
|
|
Set the string key to use. If <code>isTranslated</code> is true when <a href="../2 classes/Strings.DisplayString.html#DisplayString">DisplayString</a>
|
|
is called, this will be the string key for the translation that will be displayed.
|
|
If false or omitted, this will be the string that's displayed.()
|
|
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">string</span>
|
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
|
|
the new key for the display string
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "DisplayString:SetScale"></a>
|
|
<strong>DisplayString:SetScale(scale)</strong>
|
|
</dt>
|
|
<dd>
|
|
Set the scale of the string. ()
|
|
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">scale</span>
|
|
<span class="types"><span class="type">float</span></span>
|
|
New scale of the string relative to the default size.
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "DisplayString:GetScale"></a>
|
|
<strong>DisplayString:GetScale()</strong>
|
|
</dt>
|
|
<dd>
|
|
Get the scale of the string. ()
|
|
|
|
|
|
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><span class="type">float</span></span>
|
|
Scale.
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "DisplayString:SetPosition"></a>
|
|
<strong>DisplayString:SetPosition(pos)</strong>
|
|
</dt>
|
|
<dd>
|
|
Set the position of the string.
|
|
Screen-space coordinates are expected.()
|
|
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">pos</span>
|
|
<span class="types"><a class="type" href="../3 primitive classes/Vec2.html#">Vec2</a></span>
|
|
New position in pixel coordinates.
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "DisplayString:GetPosition"></a>
|
|
<strong>DisplayString:GetPosition()</strong>
|
|
</dt>
|
|
<dd>
|
|
Get the position of the string.
|
|
Screen-space coordinates are returned.()
|
|
|
|
|
|
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><a class="type" href="../3 primitive classes/Vec2.html#">Vec2</a></span>
|
|
pos Position in pixel coordinates.
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "DisplayString:SetFlags"></a>
|
|
<strong>DisplayString:SetFlags(table)</strong>
|
|
</dt>
|
|
<dd>
|
|
Set the display string's flags ()
|
|
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">table</span>
|
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.6">table</a></span>
|
|
the new table with display flags options
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<h3>Usage:</h3>
|
|
<ul>
|
|
<pre class="example"><span class="keyword">local</span> varDisplayString = DisplayString(<span class="string">'example string'</span>, <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>)
|
|
possible values:
|
|
varDisplayString:SetFlags({})
|
|
varDisplayString:SetFlags({ TEN.Strings.DisplayStringOption.SHADOW })
|
|
varDisplayString:SetFlags({ TEN.Strings.DisplayStringOption.CENTER })
|
|
varDisplayString:SetFlags({ TEN.Strings.DisplayStringOption.SHADOW, TEN.Strings.DisplayStringOption.CENTER })
|
|
<span class="comment">-- When passing a table to a function, you can omit the parentheses
|
|
</span>varDisplayString:SetFlags{ TEN.Strings.DisplayStringOption.CENTER }</pre>
|
|
</ul>
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "DisplayString:SetTranslated"></a>
|
|
<strong>DisplayString:SetTranslated(shouldTranslate)</strong>
|
|
</dt>
|
|
<dd>
|
|
Set translated parameter of the string
|
|
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">shouldTranslate</span>
|
|
<span class="types"><span class="type">bool</span></span>
|
|
if true, the string's key will be used as the key for the translation that will be displayed.
|
|
If false, the key itself will be displayed
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</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>
|