mirror of
https://github.com/TombEngine/TombEngine.git
synced 2025-05-13 05:57:05 +03:00
275 lines
8.1 KiB
HTML
275 lines
8.1 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 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>Contents</h2>
|
|
<ul>
|
|
<li><a href="#Members">Members</a></li>
|
|
<li><a href="#Functions">Functions</a></li>
|
|
</ul>
|
|
|
|
|
|
<h2>Misc classes</h2>
|
|
<ul class="nowrap">
|
|
<li><a href="../misc classes/Color.html">Color</a></li>
|
|
<li><strong>DisplayString</strong></li>
|
|
<li><a href="../misc classes/Position.html">Position</a></li>
|
|
<li><a href="../misc classes/Rotation.html">Rotation</a></li>
|
|
</ul>
|
|
<h2>Script Files</h2>
|
|
<ul class="nowrap">
|
|
<li><a href="../script files/Pre-game.html">Pre-game scripts</a></li>
|
|
<li><a href="../script files/Level-specific.html">Level-specific scripts</a></li>
|
|
</ul>
|
|
<h2>Enums</h2>
|
|
<ul class="nowrap">
|
|
<li><a href="../enums/InvItem.html">InvItem</a></li>
|
|
<li><a href="../enums/ObjID.html">ObjID</a></li>
|
|
</ul>
|
|
<h2>Entity classes</h2>
|
|
<ul class="nowrap">
|
|
<li><a href="../entity classes/AIObject.html">AIObject</a></li>
|
|
<li><a href="../entity classes/CameraInfo.html">CameraInfo</a></li>
|
|
<li><a href="../entity classes/ItemInfo.html">ItemInfo</a></li>
|
|
<li><a href="../entity classes/MeshInfo.html">MeshInfo</a></li>
|
|
<li><a href="../entity classes/SinkInfo.html">SinkInfo</a></li>
|
|
<li><a href="../entity classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
|
</ul>
|
|
<h2>Pre-game script classes</h2>
|
|
<ul class="nowrap">
|
|
<li><a href="../pre-game script classes/Animations.html">Animations</a></li>
|
|
<li><a href="../pre-game script classes/AudioTrack.html">AudioTrack</a></li>
|
|
<li><a href="../pre-game script classes/InventoryObject.html">InventoryObject</a></li>
|
|
<li><a href="../pre-game script classes/Level.html">Level</a></li>
|
|
<li><a href="../pre-game script classes/Mirror.html">Mirror</a></li>
|
|
<li><a href="../pre-game script classes/Settings.html">Settings</a></li>
|
|
<li><a href="../pre-game script classes/SkyLayer.html">SkyLayer</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
|
|
<div id="content">
|
|
|
|
<h1>Class <code>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="../script files/Level-specific.html#ScreenToPercent">ScreenToPercent</a> and <a href="../script files/Level-specific.html#PercentToScreen">PercentToScreen</a>
|
|
when you need to use screen-space coordinates.</p>
|
|
|
|
|
|
<h2><a href="#Members">Members</a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" ><a href="#col">col</a></td>
|
|
<td class="summary">(<a href="../misc classes/Color.html#">Color</a>) RBG color</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#key">key</a></td>
|
|
<td class="summary">(string) String key to use.</td>
|
|
</tr>
|
|
</table>
|
|
<h2><a href="#Functions">Functions</a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" ><a href="#DisplayString.new">DisplayString.new(str, x, y, color, flags, translated)</a></td>
|
|
<td class="summary">Create a DisplayString.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#DisplayString:SetPos">DisplayString:SetPos(x, y)</a></td>
|
|
<td class="summary">Set the position of the string.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#DisplayString:GetPos">DisplayString:GetPos()</a></td>
|
|
<td class="summary">Get the position of the string.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br/>
|
|
<br/>
|
|
|
|
|
|
<h2 class="section-header "><a name="Members"></a>Members</h2>
|
|
|
|
<dl class="function">
|
|
<dt>
|
|
<a name = "col"></a>
|
|
<strong>col</strong>
|
|
</dt>
|
|
<dd>
|
|
(<a href="../misc classes/Color.html#">Color</a>) RBG color
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "key"></a>
|
|
<strong>key</strong>
|
|
</dt>
|
|
<dd>
|
|
(string) String key to use. If <code>translated</code> is true when <a href="../misc classes/DisplayString.html#DisplayString.new">DisplayString.new</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.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
|
|
|
<dl class="function">
|
|
<dt>
|
|
<a name = "DisplayString.new"></a>
|
|
<strong>DisplayString.new(str, x, y, color, flags, translated)</strong>
|
|
</dt>
|
|
<dd>
|
|
Create a DisplayString.
|
|
For use in <a href="../script files/Level-specific.html#ShowString">ShowString</a> and <a href="../script files/Level-specific.html#HideString">HideString</a>.
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">str</span>
|
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
|
string to print or key of translated string
|
|
</li>
|
|
<li><span class="parameter">x</span>
|
|
<span class="types"><span class="type">int</span></span>
|
|
x-coordinate of top-left of string (or the center if DisplayStringOption.CENTER is given)
|
|
</li>
|
|
<li><span class="parameter">y</span>
|
|
<span class="types"><span class="type">int</span></span>
|
|
y-coordinate of top-left of string (or the center if DisplayStringOption.CENTER is given)
|
|
</li>
|
|
<li><span class="parameter">color</span>
|
|
<span class="types"><span class="type">Color</span></span>
|
|
the color of the text
|
|
</li>
|
|
<li><span class="parameter">flags</span>
|
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
|
|
a table of display options. Can be empty or omitted. The possible values and their effects are...</p>
|
|
<pre><code>DisplayStringOption.CENTER -- see x and y parameters
|
|
DisplayStringOption.SHADOW -- will give the text a small shadow
|
|
</code></pre>
|
|
<p><strong>Default: empty</strong>
|
|
</li>
|
|
<li><span class="parameter">translated</span>
|
|
<span class="types"><span class="type">bool</span></span>
|
|
if false or omitted, the str argument will be printed.
|
|
If true, the str argument will be the key of a translated string specified in
|
|
strings.lua. <strong>Default: false</strong>.
|
|
</li>
|
|
</ul>
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
A new DisplayString object.
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "DisplayString:SetPos"></a>
|
|
<strong>DisplayString:SetPos(x, y)</strong>
|
|
</dt>
|
|
<dd>
|
|
Set the position of the string.
|
|
Screen-space coordinates are expected.
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">x</span>
|
|
<span class="types"><span class="type">int</span></span>
|
|
x-coordinate of the string
|
|
</li>
|
|
<li><span class="parameter">y</span>
|
|
<span class="types"><span class="type">int</span></span>
|
|
y-coordinate of the string
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "DisplayString:GetPos"></a>
|
|
<strong>DisplayString:GetPos()</strong>
|
|
</dt>
|
|
<dd>
|
|
Get the position of the string.
|
|
Screen-space coordinates are returned.
|
|
|
|
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
<li>
|
|
<span class="types"><span class="type">int</span></span>
|
|
x x-coordinate of the string</li>
|
|
<li>
|
|
<span class="types"><span class="type">int</span></span>
|
|
y y-coordinate of the string</li>
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div> <!-- id="content" -->
|
|
</div> <!-- id="main" -->
|
|
<div id="about">
|
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
|
<i style="float:right;">Last updated 2022-01-15 12:32:01 </i>
|
|
</div> <!-- id="about" -->
|
|
</div> <!-- id="container" -->
|
|
</body>
|
|
</html>
|