anachronox-sdk/docs/procedural/ape_animate.bak
2002-01-21 00:00:00 +00:00

41 lines
No EOL
1.8 KiB
Text

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML>
<HEAD>
<TITLE>APE Animated Texture Control</TITLE>
<LINK type="text/css" rel="stylesheet" href="../webdocs.css">
</HEAD>
<BODY>
<H1>APE Animated Texture Control</H1>
<p>You can easily control animated textures from APE by using these functions.
<pre class="syntax">
<b>extern RegisterPic2</b>
<b>string</b> <i>texturename</i> // base texture name
<b>floatvar</b> <i>handle</i> // receiving image handle
</pre>
<h4>Parameters</h4>
<dl>
<dt>texturename
<dd>Base name of the animated texture <em>including extension</em> but without the path. For example, if the full texture path is "anoxdata/textures/joey/happy.atd" then you would only specify "happy.atd" for this parameter.
<dt>handle
<dd>Variable to receive the image handle. Subsequent calls should specify this variable. A value of zero is an invalid handle and means the function failed.
</dl>
<pre class="syntax">
<b>extern SetAnimFrame</b>
<b>float</b> <i>handle</i> // image handle
<b>float</b> <i>framenum</i> // animation frame number
<b>float</b> <i>nowait</i> // (optional) ignore current delay
</pre>
<h4>Parameters</h4>
<dl>
<dt>handle
<dd>Non-zero handle received from a previous call to <b>RegisterPic2</b>.
<dt>framenum
<dd>Frame number which you want displayed next in the animation sequence.
<dt>nowait
<dd>Flag to specify whether or not the currently displayed frame's wait value should be ignored. If you specify 1, then <b>framenum</b> will be processed immediately. The default value is 0.
</dl>
<h4>Example</h4>
<p>Please see <b>map joeyproc</b> and the corresponding <b>joeyproc.txt</b> APE script for examples of APE control of animated textures on entities and world brushes.
</body>
</html>