gib, hitsound, and push/pop documented...

git-svn-id: svn://svn.code.sf.net/p/actiongame/code/trunk/ac@6166 e016b1c5-ed68-44aa-a2f7-31cac88cffde
This commit is contained in:
Bukz
2011-03-30 18:15:38 +00:00
parent 12b806bfa8
commit 07892de7ec
2 changed files with 49 additions and 24 deletions
+8 -6
View File
@@ -117,11 +117,13 @@ docexample [echo (modf 7.5 12.5)] [Output: 7.5];
docexample [echo (modf 17.5 12.5)] [Output: 5.0];
docident [numargs] [The number of arguments passed to the current alias];
docargument [V] [numargs] [ read-only];
docident [pop] [];
docident [pop] [Resets a previously pushed alias to it's original value.];
docargument [A] [alias] [] [0];
docident [push] [];
docexample [pop p; echo $p] [Output: 1];
docident [push] [Temporarily redefines the value of an alias.];
docargument [N] [alias name] [] [0];
docargument [A] [action] [] [0];
docexample [p = 1; push p 2; echo $p] [Output: 2];
docident [result] [sets the result value of a CubeScript block];
docargument [R] [the result] [] [0];
docident [rnd] [Random value];
@@ -379,6 +381,8 @@ docident [dropflag] [Drops the enemy flag.];
docident [footstepalign] [Maximum time span between player animation and the playback of the footstep sound];
docargument [T] [time span] [min 5/max 4000/default 15];
docremark [If the footstep sound would be played immediately when entering the radius of the other player, it would not be synchronous to the player model animation.];
docident [hitsound] [Plays a sound upon every successful hit if enabled.];
docargument [B] [off OR on] [0 (false), 1 (true)];
docident [footsteps] [Indicates if the footsteps sound should be played];
docargument [B] [enable footsteps] [1 (true), 0 (false) min 0/max 1/default 1];
docident [gamespeed] [Sets the gamespeed in percent.];
@@ -1016,6 +1020,8 @@ docremark [Not supported on Windows and Mac.];
docident [gamma] [Sets the hardware gamma value.];
docargument [N] [the gamma value] [min 30/max 300/default 100];
docremark [May not work if your card/driver doesn't support it.];
docident [gib] [Enables or disables the gib animation entirely.];
docargument [B] [on OR off] [0 (false), 1 (true)];
docident [gibnum] [Sets the number of gibs to display when performing a "messy" kill (grenade, knife, sniper headshot).];
docargument [N] [number of gibs] [min 0/max 1000/default 6];
docremark [Larger values are more spectacular, but can slow down less powerful machines. Reducing gibttl may help in this case.];
@@ -1478,10 +1484,6 @@ docident [fontskip] [At what char does the definition proceed?];
docargument [A] [TODO] [] [0];
docident [gettext] [An alias used for i18n. Translateable text should be marked [(_ "this is the EN-us variant of the text")].];
docargument [M] [I18Nmessage] [] [0];
docident [gib] [TODO];
docargument [N] [TODO] [min 0/max 1/default 1];
docident [hitsound] [TODO];
docargument [N] [TODO] [min 0/max 1/default 0];
docident [hudextras] [TODO];
docargument [N] [TODO] [min 0/max 3/default 0];
docident [interms] [TODO];
+41 -18
View File
@@ -90,10 +90,18 @@
</command>
<command name="push">
<description>Temporarily redefines the value of an alias.</description>
<arguments>
<argument token="N" description="alias name"/>
<argument token="A" description="action"/>
</arguments>
<examples>
<example>
<code><![CDATA[p = 1; push p 2; echo $p]]></code>
<explanation>Output: 2
</explanation>
</example>
</examples>
<references>
<identifierReference identifier="pop"/>
</references>
@@ -119,12 +127,19 @@
</command>
<command name="pop">
<arguments>
<argument token="A" description="alias"/>
</arguments>
<references>
<identifierReference identifier="push"/>
</references>
<description>Resets a previously pushed alias to it's original value.</description>
<arguments>
<argument token="A" description="alias"/>
</arguments>
<examples>
<example>
<code><![CDATA[pop p; echo $p]]></code>
<explanation>Output: 1</explanation>
</example>
</examples>
<references>
<identifierReference identifier="push"/>
</references>
</command>
<command name="+">
@@ -2141,8 +2156,8 @@ Output:
<description>Indicates if the footsteps sound should be played</description>
<value token="B" description="enable footsteps" minValue="0" maxValue="1" defaultValue="1" valueNotes="1 (true), 0 (false)"/>
</variable>
<variable name="localfootsteps">
<variable name="localfootsteps">
<description>Indicates if the footsteps sound for the local player should be played</description>
<value token="B" description="enable footsteps" minValue="0" maxValue="1" defaultValue="1" valueNotes="1 (true), 0 (false)"/>
</variable>
@@ -2157,6 +2172,13 @@ Output:
</remarks>
<value token="T" description="time span" minValue="5" maxValue="4000" defaultValue="15"/>
</variable>
<variable name="hitsound">
<description>Plays a sound upon every successful hit if enabled.</description>
<value token="B" description="off OR on" minValue="0" maxValue="1" defaultValue="0" valueNotes="1 (true), 0 (false)" />
<identifierReference identifier="audio"/>
<identifierReference identifier="soundvol"/>
</variable>
<variable name="gamespeed">
<description>Sets the gamespeed in percent.</description>
@@ -3700,6 +3722,17 @@ Output:
<description>Turn on and off the display of blood.</description>
<value token="V" description="Enable/Disable blood" minValue="0" maxValue="1" defaultValue="1"/>
</variable>
<variable name="gib">
<description>Enables or disables the gib animation entirely.</description>
<value token="B" description="on OR off" minValue="0" maxValue="1" defaultValue="1" valueNotes="0 (false), 1 (true)" />
<references>
<identifierReference identifier="gibnum"/>
<identifierReference identifier="gibspeed"/>
<identifierReference identifier="gibsgore"/>
<identifierReference identifier="gibttl"/>
</references>
</variable>
<variable name="gibnum">
<description>Sets the number of gibs to display when performing a "messy" kill (grenade, knife, sniper headshot).</description>
@@ -5467,16 +5500,6 @@ Output:
<value token="N" description="TODO" minValue="0" maxValue="1000" defaultValue="125" />
</variable>
<variable name="gib">
<description>TODO</description>
<value token="N" description="TODO" minValue="0" maxValue="1" defaultValue="1" />
</variable>
<variable name="hitsound">
<description>TODO</description>
<value token="N" description="TODO" minValue="0" maxValue="1" defaultValue="0" />
</variable>
<variable name="hudextras">
<description>TODO</description>
<value token="N" description="TODO" minValue="0" maxValue="3" defaultValue="0" />