mirror of
https://github.com/TombEngine/TombEngine.git
synced 2025-05-08 11:38:08 +03:00
317 lines
6.9 KiB
HTML
317 lines
6.9 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.0.2 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>3 Primitive Classes</h2>
|
|
<ul class="nowrap">
|
|
<li><strong>Color</strong></li>
|
|
<li><a href="../3 primitive classes/Rotation.html">Rotation</a></li>
|
|
<li><a href="../3 primitive classes/Vec3.html">Vec3</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.Moveable.html">Objects.Moveable</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/Strings.DisplayString.html">Strings.DisplayString</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/Objects.ObjID.html">Objects.ObjID</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>Primitive 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>
|
|
<td class="name" ><a href="#r">r</a></td>
|
|
<td class="summary">(int) red component</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#g">g</a></td>
|
|
<td class="summary">(int) green component</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#b">b</a></td>
|
|
<td class="summary">(int) blue component</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#a">a</a></td>
|
|
<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>
|
|
<td class="name" ><a href="#Color">Color(R, G, B)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#Color">Color(R, G, B, A)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" ><a href="#__tostring">__tostring(color)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br/>
|
|
<br/>
|
|
|
|
|
|
<h2 class="section-header "><a name="Members"></a>Members</h2>
|
|
|
|
<dl class="function">
|
|
<dt>
|
|
<a name = "r"></a>
|
|
<strong>r</strong>
|
|
</dt>
|
|
<dd>
|
|
(int) red component
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "g"></a>
|
|
<strong>g</strong>
|
|
</dt>
|
|
<dd>
|
|
(int) green component
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "b"></a>
|
|
<strong>b</strong>
|
|
</dt>
|
|
<dd>
|
|
(int) blue component
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "a"></a>
|
|
<strong>a</strong>
|
|
</dt>
|
|
<dd>
|
|
(int) alpha component (255 is opaque, 0 is invisible)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
|
|
|
<dl class="function">
|
|
<dt>
|
|
<a name = "Color"></a>
|
|
<strong>Color(R, G, B)</strong>
|
|
</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"></a>
|
|
<strong>Color(R, G, B, A)</strong>
|
|
</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>
|
|
<a name = "__tostring"></a>
|
|
<strong>__tostring(color)</strong>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">color</span>
|
|
<span class="types"><a class="type" href="../3 primitive classes/Color.html#Color">Color</a></span>
|
|
this color
|
|
</li>
|
|
</ul>
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.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>
|
|
<i style="float:right;">Last updated 2022-09-14 20:04:13 </i>
|
|
</div> <!-- id="about" -->
|
|
</div> <!-- id="container" -->
|
|
</body>
|
|
</html>
|