2021-08-12 20:16:28 +01:00
|
|
|
<!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>
|
2021-08-23 20:16:01 +01:00
|
|
|
<title>TombEngine Lua API</title>
|
2021-08-12 20:16:28 +01:00
|
|
|
<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>
|
|
|
|
|
|
|
|
|
|
|
2021-08-23 19:19:36 +01:00
|
|
|
<h2>Misc classes</h2>
|
2021-08-12 20:16:28 +01:00
|
|
|
<ul class="nowrap">
|
|
|
|
|
<li><strong>Color</strong></li>
|
2021-08-30 18:46:48 +01:00
|
|
|
<li><a href="../misc classes/DisplayString.html">DisplayString</a></li>
|
2021-08-23 19:19:36 +01:00
|
|
|
<li><a href="../misc classes/Position.html">Position</a></li>
|
|
|
|
|
<li><a href="../misc classes/Rotation.html">Rotation</a></li>
|
2021-08-12 20:16:28 +01:00
|
|
|
</ul>
|
2021-08-23 19:19:36 +01:00
|
|
|
<h2>Script Files</h2>
|
2021-08-12 20:16:28 +01:00
|
|
|
<ul class="nowrap">
|
2021-08-23 19:19:36 +01:00
|
|
|
<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/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>
|
2021-08-12 20:16:28 +01:00
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div id="content">
|
|
|
|
|
|
|
|
|
|
<h1>Class <code>Color</code></h1>
|
|
|
|
|
<p>An RGBA or RGB color.</p>
|
|
|
|
|
<p>Components are specified in bytes; all values are clamped to [0, 255].</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2><a href="#Members">Members</a></h2>
|
|
|
|
|
<table class="function_list">
|
|
|
|
|
<tr>
|
2021-08-23 19:19:36 +01:00
|
|
|
<td class="name" ><a href="#r">r</a></td>
|
2021-08-12 20:16:28 +01:00
|
|
|
<td class="summary">(int) red component</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2021-08-23 19:19:36 +01:00
|
|
|
<td class="name" ><a href="#g">g</a></td>
|
2021-08-12 20:16:28 +01:00
|
|
|
<td class="summary">(int) green component</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2021-08-23 19:19:36 +01:00
|
|
|
<td class="name" ><a href="#b">b</a></td>
|
2021-08-12 20:16:28 +01:00
|
|
|
<td class="summary">(int) blue component</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2021-08-23 19:19:36 +01:00
|
|
|
<td class="name" ><a href="#a">a</a></td>
|
2021-08-12 20:16:28 +01:00
|
|
|
<td class="summary">(int) alpha component (255 is opaque, 0 is invisible)</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
<h2><a href="#Functions">Functions</a></h2>
|
|
|
|
|
<table class="function_list">
|
|
|
|
|
<tr>
|
2021-08-23 19:19:36 +01:00
|
|
|
<td class="name" ><a href="#Color.new">Color.new(R, G, B)</a></td>
|
2021-08-12 20:16:28 +01:00
|
|
|
<td class="summary">
|
|
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2021-08-23 19:19:36 +01:00
|
|
|
<td class="name" ><a href="#Color.new">Color.new(R, G, B, A)</a></td>
|
2021-08-12 20:16:28 +01:00
|
|
|
<td class="summary">
|
|
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2021-08-23 19:19:36 +01:00
|
|
|
<td class="name" ><a href="#__tostring">__tostring(color)</a></td>
|
2021-08-12 20:16:28 +01:00
|
|
|
<td class="summary">
|
|
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
<br/>
|
|
|
|
|
<br/>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 class="section-header "><a name="Members"></a>Members</h2>
|
|
|
|
|
|
|
|
|
|
<dl class="function">
|
|
|
|
|
<dt>
|
2021-08-23 19:19:36 +01:00
|
|
|
<a name = "r"></a>
|
|
|
|
|
<strong>r</strong>
|
2021-08-12 20:16:28 +01:00
|
|
|
</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
(int) red component
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
<dt>
|
2021-08-23 19:19:36 +01:00
|
|
|
<a name = "g"></a>
|
|
|
|
|
<strong>g</strong>
|
2021-08-12 20:16:28 +01:00
|
|
|
</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
(int) green component
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
<dt>
|
2021-08-23 19:19:36 +01:00
|
|
|
<a name = "b"></a>
|
|
|
|
|
<strong>b</strong>
|
2021-08-12 20:16:28 +01:00
|
|
|
</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
(int) blue component
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
<dt>
|
2021-08-23 19:19:36 +01:00
|
|
|
<a name = "a"></a>
|
|
|
|
|
<strong>a</strong>
|
2021-08-12 20:16:28 +01:00
|
|
|
</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
(int) alpha component (255 is opaque, 0 is invisible)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
2021-08-23 19:19:36 +01:00
|
|
|
|
2021-08-12 20:16:28 +01:00
|
|
|
<dl class="function">
|
|
|
|
|
<dt>
|
|
|
|
|
<a name = "Color.new"></a>
|
2021-08-23 19:19:36 +01:00
|
|
|
<strong>Color.new(R, G, B)</strong>
|
2021-08-12 20:16:28 +01:00
|
|
|
</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
|
|
|
<ul>
|
|
|
|
|
<li><span class="parameter">R</span>
|
|
|
|
|
<span class="types"><span class="type">int</span></span>
|
|
|
|
|
red component
|
|
|
|
|
</li>
|
|
|
|
|
<li><span class="parameter">G</span>
|
|
|
|
|
<span class="types"><span class="type">int</span></span>
|
|
|
|
|
green component
|
|
|
|
|
</li>
|
|
|
|
|
<li><span class="parameter">B</span>
|
|
|
|
|
<span class="types"><span class="type">int</span></span>
|
|
|
|
|
blue component
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<h3>Returns:</h3>
|
|
|
|
|
<ol>
|
|
|
|
|
|
|
|
|
|
A Color object.
|
|
|
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
<dt>
|
|
|
|
|
<a name = "Color.new"></a>
|
2021-08-23 19:19:36 +01:00
|
|
|
<strong>Color.new(R, G, B, A)</strong>
|
2021-08-12 20:16:28 +01:00
|
|
|
</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
|
|
|
<ul>
|
|
|
|
|
<li><span class="parameter">R</span>
|
|
|
|
|
<span class="types"><span class="type">int</span></span>
|
|
|
|
|
red component
|
|
|
|
|
</li>
|
|
|
|
|
<li><span class="parameter">G</span>
|
|
|
|
|
<span class="types"><span class="type">int</span></span>
|
|
|
|
|
green component
|
|
|
|
|
</li>
|
|
|
|
|
<li><span class="parameter">B</span>
|
|
|
|
|
<span class="types"><span class="type">int</span></span>
|
|
|
|
|
blue component
|
|
|
|
|
</li>
|
|
|
|
|
<li><span class="parameter">A</span>
|
|
|
|
|
<span class="types"><span class="type">int</span></span>
|
|
|
|
|
alpha component (255 is opaque, 0 is invisible)
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<h3>Returns:</h3>
|
|
|
|
|
<ol>
|
|
|
|
|
|
|
|
|
|
A Color object.
|
|
|
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
<dt>
|
2021-08-23 19:19:36 +01:00
|
|
|
<a name = "__tostring"></a>
|
|
|
|
|
<strong>__tostring(color)</strong>
|
2021-08-12 20:16:28 +01:00
|
|
|
</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
|
|
|
<ul>
|
|
|
|
|
<li><span class="parameter">color</span>
|
2021-08-23 19:19:36 +01:00
|
|
|
<span class="types"><span class="type">Color</span></span>
|
2021-08-12 20:16:28 +01:00
|
|
|
this color
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<h3>Returns:</h3>
|
|
|
|
|
<ol>
|
|
|
|
|
|
|
|
|
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
|
|
|
|
A string showing the r, g, b, and a values of the color
|
|
|
|
|
</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>
|
2021-08-30 18:46:48 +01:00
|
|
|
<i style="float:right;">Last updated 2021-08-30 18:45:10 </i>
|
2021-08-12 20:16:28 +01:00
|
|
|
</div> <!-- id="about" -->
|
|
|
|
|
</div> <!-- id="container" -->
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
