anachronox-sdk/docs/miscexterns.html
2002-01-21 00:00:00 +00:00

114 lines
3.4 KiB
HTML

<HTML>
<HEAD>
<TITLE>MISCELLANEOUS EXTERN NOTES</TITLE>
<META name="description" content="">
<META name="keywords" content="">
<META name="generator" content="CuteHTML">
</HEAD>
<BODY BGCOLOR="#000000" TEXT="#FFFFFFF" LINK="#0000FF" VLINK="#800080">
<h1><p>Misc Extern Notes</p></h1>
<p>
<h2>APE Command Documentation</h2>
</p>
<p><i>There's a ton of externs that are undocumented. This is a pathetic attempt
to document them all</i></p>
<p><h3>Animation Externs</h3></p>
<p><i>Over the past year or so I've added some animation control via APE. You can set
entities to hold specific frames, play animations, set up sequences of animations, etc.</i></p>
<listing><p>ANIM_PlaySequence [handle] [anim] [subid]</p></listing>
<p><i>[handle]</i>: Entity reference</p>
<p><i>[anim]</i>: Animation name</p>
<p><i>[subid]</i> Animation sub id</p>
<p>Example: extern ANIM_PlaySequence handle amb_ a</p>
<p>This plays the specified animation/subanim on the given edict.
Because this function sucks you need the _ after the anim name.</p>
<hr>
<listing><p>ANIM_Stop [handle]</p></listing>
<p><i>[handle]</i>: Entity reference</p>
<p>Example: extern ANIM_Stop handle</p>
<p>This function stops all animations on the given handle and puts him in the
ambient.</p>
<hr>
<listing><p>ANIM_MakeStupid [handle]</p></listing>
<p><i>[handle]</i>: Entity reference</p>
<p>Example: extern ANIM_MakeStupid handle</p>
<p>This forces the entity into server animate mode--meaning it will
idle regardless of how you move it.</p>
<hr>
<listing><p>ANIM_MakeSmart [handle]</p></listing>
<p><i>[handle]</i>: Entity reference</p>
<p>Example: extern ANIM_MakeSmart handle</p>
<p>This forces the specified entity into smart animate mode.</p>
<hr>
<listing><p>ANIM_SetFrame [handle] [frame]</p></listing>
<p><i>[handle]</i>: Entity reference</p>
<p><i>[frame]</i>: Animation frame</p>
<p>Example: extern ANIM_Frame handle 200</p>
<p>This forces the entity to hold at the specified animation frame.</p>
<hr>
<listing><p>ANIM_PlayAnim [handle] [state] {[loop] [flush] [holdframe]}</p></listing>
<p><i>[handle]</i>: Entity reference</p>
<p><i>[state]</i>: Animation name</p>
<p><i>[loop]</i> Loop this animation</p>
<p><i>[flush]</i> Flush out current animation and play this one</p>
<p><i>[holdframe]</i> Hold last frame of this animation</p>
<p>
<p>NOTE: loop/flush/holdframe must ALL be included if you want to loop or flush.
<p>
<p>Example: extern ANIM_PlaySequence handle amb_a 0 1 0</p>
<p>This plays the specified animation on the given edict with
style parameters. The parameters are numbers (either 0 or 1) that
determine if you are flushing out the current animation, looping, or
holding the frame. This is a much more robust version of playsequence and
should be used instead.</p>
<hr>
<listing><p>assign [startelement] [value1] [value2] [value3] ...</listing>
<p><i>[startelement]</i>: e.g. a[10] will start assigning with tenth element of a</p>
<p><i>[value1]</i>: Follow with values for successive elements</p>
<p>
<p>This is for assigning multiple elements of an array at once, rather than successive statements.
<p>Example: extern assign d[25] 2 14 -3 2 0 1</p>
<p>Example: extern assign d[$index$] 2 14 -3 apevar 0 apevar2</p>
<p> (Note: eventually, the dollars signs in $var$ will be no longer necessary.)
</BODY>
</HTML>