kai/assaultcube-
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

documentation for onHit, onAttack, pm

Browse Source 
git-svn-id: svn://svn.code.sf.net/p/actiongame/code/trunk/ac@6627 e016b1c5-ed68-44aa-a2f7-31cac88cffde
This commit is contained in:
Lucas GAUTHERON
2011-08-31 00:39:36 +00:00
parent de6f8b0ea5
commit ee624d8dc0
2 changed files with 51 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
config/docs.cfg
+11
View File
@@ -697,6 +697,8 @@ docargument [A] [weapon id] [value] [0];
docident [nickcomplete] [adds a command to complete nicknames on];
docremark [your own nick will be ignored];
docexample [nickgreet = [ say (concat "Hello," (concatword $arg1 "!")) ]; nickcomplete nickgreet] [with this you can enter "/nickgreet " and cycle via TAB to the nickname you want to greet.];
docident [onAttack] [If defined, this will be executed each time you shot a bullet, throw a grenade or use your knife.];
docargument [weapon] [The weapon that was used] [] [0];
docident [onCallVote] [If this alias exists it will be run every time a vote is called.];
docident [onChangeVote] [If this alias exists it will be run every time a vote is changed.];
docident [onConnect] [If defined, this will be executed when you or another player join(s) a server.];
@@ -706,6 +708,12 @@ docident [onFlag] [If defined, this will be executed each time a flag action occ
docargument [action] [The action that occured] [integer (0 = stolen, 1 = dropped, 2 = lost, 3 = returned, 4 = scored, 5 = ktfscore, 6 = failed to score, 7 = reset)] [0];
docargument [actor] [The client number of the actor] [integer] [0];
docargument [flag] [The flag owner team] [integer (0 = CLA, 1 = RVSF)] [0];
docident [onHit] [If it's defined, this alias will be executed each time a damage is done.];
docargument [actor] [The client number of the actor] [integer] [0];
docargument [target] [The client number of the target] [integer] [0];
docargument [damage] [The damage done] [integer] [0];
docargument [gun] [The number of the gun used] [integer] [0];
docargument [gib] [Is it a gib or a normal frag] [integer (0 or 1)] [0];
docident [onKill] [If it exists, this alias will be executing when any player get killed, receiving a few arguments :];
docargument [actor] [The client number of the actor] [integer] [0];
docargument [target] [The client number of the target] [integer] [0];
@@ -726,6 +734,9 @@ docident [onWeaponSwitch] [If defined, this will be executed each time you switc
docargument [w] [The weapon ID that you switched to] [] [0];
docident [paused] [Determines if the game should be paused.];
docargument [B] [pause game] [min 0/max 1/default 0];
docident [pm] [Sends a private message to a specified client.];
docargument [C] [Client number] [] [0];
docargument [L] [List of strings] [] [0];
docident [prevweapon] [Returns the weapon-index the local player was previously holding.];
docident [pstat_score] [Returns the score statistics for the player with the given clientnumber.];
docargument [C] [client] [0..N] [0];
docs/reference.xml
+40 -11
View File
@@ -1335,15 +1335,15 @@ echo foo
</arguments>
</command>
<command name="echo">
<description>Outputs text to the console.</description>
<arguments>
<argument token="L" description="List of strings"/>
</arguments>
<references>
<identifierReference identifier="hudecho"/>
</references>
</command>
<command name="echo">
<description>Outputs text to the console.</description>
<arguments>
<argument token="L" description="List of strings"/>
</arguments>
<references>
<identifierReference identifier="hudecho"/>
</references>
</command>
<command name="hudecho">
<description>Outputs text to the console and heads up display.</description>
@@ -2042,8 +2042,26 @@ addOnLoadAlways [
</arguments>
<description>If defined, this will be executed each time you pick up an item.</description>
</scriptalias>
<scriptalias name="onWeaponSwitch">
<scriptalias name="onAttack">
<arguments>
<argument token="weapon" description="The weapon that was used" />
</arguments>
<description>If defined, this will be executed each time you shot a bullet, throw a grenade or use your knife.</description>
</scriptalias>
<scriptalias name="onHit">
<arguments>
<argument token="actor" description="The client number of the actor" valueNotes="integer" />
<argument token="target" description="The client number of the target" valueNotes="integer" />
<argument token="damage" description="The damage done" valueNotes="integer" />
<argument token="gun" description="The number of the gun used" valueNotes="integer" />
<argument token="gib" description="Is it a gib or a normal frag" valueNotes="integer (0 or 1)" />
</arguments>
<description>If it's defined, this alias will be executed each time a damage is done.</description>
</scriptalias>
<scriptalias name="onWeaponSwitch">
<arguments>
<argument token="w" description="The weapon ID that you switched to" />
</arguments>
@@ -2636,6 +2654,17 @@ bind PRINT [ if (strcmp $last_server "") [ remember_server ]
</arguments>
</command>
<command name="pm">
<description>Sends a private message to a specified client.</description>
<arguments>
<argument token="C" description="Client number"/>
<argument token="L" description="List of strings"/>
</arguments>
<references>
<identifierReference identifier="say"/>
</references>
</command>
<command name="ignore">
<description>Ignore a player.</description>
<arguments>