diff --git a/config/docs.cfg b/config/docs.cfg index 633e5238..0c9b04dc 100644 --- a/config/docs.cfg +++ b/config/docs.cfg @@ -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]; diff --git a/docs/reference.xml b/docs/reference.xml index 82d5956c..071d9b3d 100644 --- a/docs/reference.xml +++ b/docs/reference.xml @@ -90,10 +90,18 @@ + Temporarily redefines the value of an alias. + + + + Output: 2 + + + @@ -119,12 +127,19 @@ - - - - - - + Resets a previously pushed alias to it's original value. + + + + + + + Output: 1 + + + + + @@ -2141,8 +2156,8 @@ Output: Indicates if the footsteps sound should be played - - + + Indicates if the footsteps sound for the local player should be played @@ -2157,6 +2172,13 @@ Output: + + + Plays a sound upon every successful hit if enabled. + + + + Sets the gamespeed in percent. @@ -3700,6 +3722,17 @@ Output: Turn on and off the display of blood. + + + Enables or disables the gib animation entirely. + + + + + + + + Sets the number of gibs to display when performing a "messy" kill (grenade, knife, sniper headshot). @@ -5467,16 +5500,6 @@ Output: - - TODO - - - - - TODO - - - TODO