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
+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" />