Skip to content

Commit 6c60507

Browse files
LwmteLwmte
committed
Update to TEN 1.7
1 parent 0ed73c5 commit 6c60507

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+4390
-3574
lines changed

‎1 modules/Effects.html‎

Lines changed: 115 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<html>
44
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
55
<head>
6-
<title>TombEngine 1.5 Lua API</title>
6+
<title>TombEngine 1.7 Lua API</title>
77
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
88
</head>
99
<body>
@@ -24,7 +24,7 @@
2424

2525
<div id="navigation">
2626
<br/>
27-
<h1>TombEngine</h1>
27+
<h1>&nbsp;TombEngine</h1>
2828

2929
<ul>
3030
<li><a href="../index.html">Index</a></li>
@@ -45,16 +45,9 @@ <h2>1 Modules</h2>
4545
</ul>
4646
<h2>2 Classes</h2>
4747
<ul class="nowrap">
48-
<li> <a href="../2 classes/View.DisplaySprite.html">View.DisplaySprite</a></li>
49-
<li> <a href="../2 classes/Flow.Animations.html">Flow.Animations</a></li>
50-
<li> <a href="../2 classes/Flow.Fog.html">Flow.Fog</a></li>
51-
<li> <a href="../2 classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
52-
<li> <a href="../2 classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
5348
<li> <a href="../2 classes/Flow.Level.html">Flow.Level</a></li>
54-
<li> <a href="../2 classes/Flow.Mirror.html">Flow.Mirror</a></li>
5549
<li> <a href="../2 classes/Flow.Settings.html">Flow.Settings</a></li>
56-
<li> <a href="../2 classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
57-
<li> <a href="../2 classes/Flow.Starfield.html">Flow.Starfield</a></li>
50+
<li> <a href="../2 classes/Flow.Statistics.html">Flow.Statistics</a></li>
5851
<li> <a href="../2 classes/Objects.AIObject.html">Objects.AIObject</a></li>
5952
<li> <a href="../2 classes/Objects.Camera.html">Objects.Camera</a></li>
6053
<li> <a href="../2 classes/Objects.LaraObject.html">Objects.LaraObject</a></li>
@@ -65,26 +58,37 @@ <h2>2 Classes</h2>
6558
<li> <a href="../2 classes/Objects.Static.html">Objects.Static</a></li>
6659
<li> <a href="../2 classes/Objects.Volume.html">Objects.Volume</a></li>
6760
<li> <a href="../2 classes/Strings.DisplayString.html">Strings.DisplayString</a></li>
61+
<li> <a href="../2 classes/View.DisplaySprite.html">View.DisplaySprite</a></li>
6862
</ul>
6963
<h2>3 Primitive Classes</h2>
7064
<ul class="nowrap">
65+
<li> <a href="../3 primitive classes/Flow.Fog.html">Flow.Fog</a></li>
66+
<li> <a href="../3 primitive classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
67+
<li> <a href="../3 primitive classes/Flow.LensFlare.html">Flow.LensFlare</a></li>
68+
<li> <a href="../3 primitive classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
69+
<li> <a href="../3 primitive classes/Flow.Starfield.html">Flow.Starfield</a></li>
7170
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
7271
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
72+
<li> <a href="../3 primitive classes/Time.html">Time</a></li>
7373
<li> <a href="../3 primitive classes/Vec2.html">Vec2</a></li>
7474
<li> <a href="../3 primitive classes/Vec3.html">Vec3</a></li>
7575
</ul>
7676
<h2>4 Enums</h2>
7777
<ul class="nowrap">
7878
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
7979
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
80+
<li> <a href="../4 enums/Flow.ErrorMode.html">Flow.ErrorMode</a></li>
81+
<li> <a href="../4 enums/Flow.FreezeMode.html">Flow.FreezeMode</a></li>
8082
<li> <a href="../4 enums/Flow.GameStatus.html">Flow.GameStatus</a></li>
8183
<li> <a href="../4 enums/Input.ActionID.html">Input.ActionID</a></li>
8284
<li> <a href="../4 enums/Objects.AmmoType.html">Objects.AmmoType</a></li>
85+
<li> <a href="../4 enums/Objects.WeaponType.html">Objects.WeaponType</a></li>
8386
<li> <a href="../4 enums/Objects.MoveableStatus.html">Objects.MoveableStatus</a></li>
8487
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
8588
<li> <a href="../4 enums/Objects.RoomFlagID.html">Objects.RoomFlagID</a></li>
8689
<li> <a href="../4 enums/Objects.RoomReverb.html">Objects.RoomReverb</a></li>
8790
<li> <a href="../4 enums/Sound.SoundTrackType.html">Sound.SoundTrackType</a></li>
91+
<li> <a href="../4 enums/Strings.DisplayStringOption.html">Strings.DisplayStringOption</a></li>
8892
<li> <a href="../4 enums/Util.LogLevel.html">Util.LogLevel</a></li>
8993
<li> <a href="../4 enums/View.AlignMode.html">View.AlignMode</a></li>
9094
<li> <a href="../4 enums/View.CameraType.html">View.CameraType</a></li>
@@ -95,6 +99,7 @@ <h2>5 Lua utility modules</h2>
9599
<ul class="nowrap">
96100
<li> <a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li>
97101
<li> <a href="../5 lua utility modules/Timer.html">Timer</a></li>
102+
<li> <a href="../5 lua utility modules/Type.html">Type</a></li>
98103
</ul>
99104

100105
</div>
@@ -123,10 +128,14 @@ <h2><a href="#Functions">Functions</a></h2>
123128
<td class="summary">Emit a shockwave, similar to that seen when a harpy projectile hits something.</td>
124129
</tr>
125130
<tr>
126-
<td class="name" ><a href="#EmitLight">EmitLight(pos, color, radius)</a></td>
131+
<td class="name" ><a href="#EmitLight">EmitLight(pos[, color][, radius][, shadows][, name])</a></td>
127132
<td class="summary">Emit dynamic light that lasts for a single frame.</td>
128133
</tr>
129134
<tr>
135+
<td class="name" ><a href="#EmitSpotLight">EmitSpotLight(pos, dir[, color][, radius][, falloff][, distance][, shadows][, name])</a></td>
136+
<td class="summary">Emit dynamic directional spotlight that lasts for a single frame.</td>
137+
</tr>
138+
<tr>
130139
<td class="name" ><a href="#EmitBlood">EmitBlood(pos, count)</a></td>
131140
<td class="summary">Emit blood.</td>
132141
</tr>
@@ -142,6 +151,10 @@ <h2><a href="#Functions">Functions</a></h2>
142151
<td class="name" ><a href="#MakeEarthquake">MakeEarthquake(strength)</a></td>
143152
<td class="summary">Make an earthquake</td>
144153
</tr>
154+
<tr>
155+
<td class="name" ><a href="#GetWind">GetWind()</a></td>
156+
<td class="summary">Get the wind vector for the current game frame.</td>
157+
</tr>
145158
</table>
146159

147160
<br/>
@@ -357,7 +370,7 @@ <h3>Parameters:</h3>
357370
</dd>
358371
<dt>
359372
<a name = "EmitLight"></a>
360-
<strong>EmitLight(pos, color, radius)</strong>
373+
<strong>EmitLight(pos[, color][, radius][, shadows][, name])</strong>
361374
</dt>
362375
<dd>
363376
Emit dynamic light that lasts for a single frame.
@@ -369,17 +382,84 @@ <h3>Parameters:</h3>
369382
<ul>
370383
<li><span class="parameter">pos</span>
371384
<span class="types"><a class="type" href="../3 primitive classes/Vec3.html#">Vec3</a></span>
385+
position of the light
386+
</li>
387+
<li><span class="parameter">color</span>
388+
<span class="types"><a class="type" href="../3 primitive classes/Color.html#">Color</a></span>
389+
light color (default Color(255, 255, 255))
390+
(<em>optional</em>)
391+
</li>
392+
<li><span class="parameter">radius</span>
393+
<span class="types"><span class="type">int</span></span>
394+
measured in "clicks" or 256 world units (default 20)
395+
(<em>optional</em>)
396+
</li>
397+
<li><span class="parameter">shadows</span>
398+
<span class="types"><span class="type">bool</span></span>
399+
determines whether light should generate dynamic shadows for applicable moveables (default is false)
400+
(<em>optional</em>)
401+
</li>
402+
<li><span class="parameter">name</span>
403+
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
404+
if provided, engine will interpolate this light for high framerate mode (be careful not to use same name for different lights)
405+
(<em>optional</em>)
406+
</li>
407+
</ul>
408+
409+
410+
411+
412+
413+
</dd>
414+
<dt>
415+
<a name = "EmitSpotLight"></a>
416+
<strong>EmitSpotLight(pos, dir[, color][, radius][, falloff][, distance][, shadows][, name])</strong>
417+
</dt>
418+
<dd>
419+
Emit dynamic directional spotlight that lasts for a single frame.
420+
If you want a light that sticks around, you must call this each frame.
372421

373422

374423

424+
<h3>Parameters:</h3>
425+
<ul>
426+
<li><span class="parameter">pos</span>
427+
<span class="types"><a class="type" href="../3 primitive classes/Vec3.html#">Vec3</a></span>
428+
position of the light
429+
</li>
430+
<li><span class="parameter">dir</span>
431+
<span class="types"><a class="type" href="../3 primitive classes/Vec3.html#">Vec3</a></span>
432+
direction, or a point to which spotlight should be directed to
375433
</li>
376434
<li><span class="parameter">color</span>
377435
<span class="types"><a class="type" href="../3 primitive classes/Color.html#">Color</a></span>
378436
(default Color(255, 255, 255))
437+
(<em>optional</em>)
379438
</li>
380439
<li><span class="parameter">radius</span>
381440
<span class="types"><span class="type">int</span></span>
382-
(default 20) corresponds loosely to both intensity and range
441+
overall radius at the endpoint of a light cone, measured in "clicks" or 256 world units (default 10)
442+
(<em>optional</em>)
443+
</li>
444+
<li><span class="parameter">falloff</span>
445+
<span class="types"><span class="type">int</span></span>
446+
radius, at which light starts to fade out, measured in "clicks" (default 5)
447+
(<em>optional</em>)
448+
</li>
449+
<li><span class="parameter">distance</span>
450+
<span class="types"><span class="type">int</span></span>
451+
distance, at which light cone fades out, measured in "clicks" (default 20)
452+
(<em>optional</em>)
453+
</li>
454+
<li><span class="parameter">shadows</span>
455+
<span class="types"><span class="type">bool</span></span>
456+
determines whether light should generate dynamic shadows for applicable moveables (default is false)
457+
(<em>optional</em>)
458+
</li>
459+
<li><span class="parameter">name</span>
460+
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
461+
if provided, engine will interpolate this light for high framerate mode (be careful not to use same name for different lights)
462+
(<em>optional</em>)
383463
</li>
384464
</ul>
385465

@@ -497,6 +577,28 @@ <h3>Parameters:</h3>
497577

498578

499579

580+
</dd>
581+
<dt>
582+
<a name = "GetWind"></a>
583+
<strong>GetWind()</strong>
584+
</dt>
585+
<dd>
586+
Get the wind vector for the current game frame.
587+
This represents the 3D displacement applied by the engine on things like particles affected by wind.()
588+
589+
590+
591+
592+
<h3>Returns:</h3>
593+
<ol>
594+
595+
<span class="types"><a class="type" href="../3 primitive classes/Vec3.html#">Vec3</a></span>
596+
Wind vector.
597+
</ol>
598+
599+
600+
601+
500602
</dd>
501603
</dl>
502604

0 commit comments

Comments
 (0)