From c37612f624d55e048648033640579f1842293819 Mon Sep 17 00:00:00 2001 From: driAn Date: Sun, 19 Oct 2008 19:19:48 +0000 Subject: [PATCH] docs: element ordering fixes git-svn-id: svn://svn.code.sf.net/p/actiongame/code/trunk/ac@3159 e016b1c5-ed68-44aa-a2f7-31cac88cffde --- docs/reference.xml | 554 +++++++++++++++++++++++---------------------- 1 file changed, 278 insertions(+), 276 deletions(-) diff --git a/docs/reference.xml b/docs/reference.xml index dd3b910f..3aefba3f 100644 --- a/docs/reference.xml +++ b/docs/reference.xml @@ -106,68 +106,67 @@ - - + + logical AND. + + + + + + + output: 1 + + + + + + + + output: 0 + + + - - - - - - - output: 1 - - - - - - - - output: 0 - - - logical OR. + + + + + + + output: 1 + + + + + + + + output: 0 + + + - - - - - - - output: 1 - - - - - - - - output: 0 - - - - Random value @@ -364,12 +363,12 @@ Contacts the masterserver and adds any new servers to the server list. - - - The servers are written to the config/servers.cfg file. This menu can be reached through the Multiplayer menu. + + + Returns the number of milliseconds since engine start. @@ -786,16 +785,13 @@ - - + + Returns the current map being played. - - If you pass it a non-zero value, the result will be path-less. - - - - - + + If you pass it a non-zero value, the result will be path-less. + + - - - - - - - - - Returns the mode number for the current game. - - - - - - - - - Returns the weapon-index the local player currently has selected as primary. - - This is not the same as curweapon - which could be a grenade or the knife. - - - - - - - + + + + + + + + + + + Returns the mode number for the current game. + + + + - + + Returns the weapon-index the local player currently has selected as primary. + + This is not the same as curweapon - which could be a grenade or the knife. + + + + + + + + + + + + Returns 1 if the local player has admin privileges, 0 otherwise. - - - - + + + + @@ -857,34 +856,34 @@ - - + + Returns 1 if the local player is on the RVSF team, 0 if on CLA. - - - - + + + + - - + + Returns the weapon-index the local player is currently holding. - - + + - - - + + + - + Loads up a map in the gamemode set previously by the 'mode' command. - If connected to a multiplayer server, it votes to load the map (others will have to type "map M" as well - to agree with loading this map). To vote for a map with a specific mode, set the mode before you issue the map command. + If connected to a multiplayer server, it votes to load the map (others will have to type "map M" as well + to agree with loading this map). To vote for a map with a specific mode, set the mode before you issue the map command. A map given as "blah" refers to "packages/maps/blah.cgz", "mypackage/blah" refers to "packages/mypackage/blah.cgz". @@ -902,8 +901,8 @@ - - + + Returns the primary weapon on next respawn. @@ -944,7 +943,7 @@ - + @@ -1074,36 +1073,35 @@ Returns contents of current magazine. - - A knife will always return 1. - Weapons that aren't available will return -1. - - + + A knife will always return 1. + Weapons that aren't available will return -1. + + + + + + + + + - - - - - - - - Returns contents of magazine reserve. + + + + + + + + - - - - - - - - Retrieves the last map that was sent to the server using 'sendmap'. @@ -1252,8 +1250,7 @@ - + Default keys are the six keys above the cursor keys, which each 2 of them cycle one type (and numpad 7/4 for upper). @@ -1468,7 +1465,7 @@ Adds a map model to the map (i.e. a rendered md2/md3 model which you collide against but has no behaviour or movement) - The mapmodel identifier is the desired map model which is defined by the 'mapmodel' command. The order in which + The mapmodel identifier is the desired map model which is defined by the 'mapmodel' command. The order in which the mapmodel is placed in the map config file defines the mapmodel indentifier. The map texture refers to a texture which is defined by the 'texture' command, if omitted the models default skin will be used. The 'mapmodel' and 'texture' commands are placed in the map config normally. @@ -1519,7 +1516,7 @@ A sound entity can be either ambient or non-ambient. Ambient sounds have no specific direction, they are 'just there'. Non-ambient sounds however appear to come from a specific direction (stereo panning). - If S is set to 0, the sound is a single point and will therefore be non-ambient. However if S is greater than 0, the sound will be ambient as it covers a specified area instead of being a single point. + If S is set to 0, the sound is a single point and will therefore be non-ambient. However if S is greater than 0, the sound will be ambient as it covers a specified area instead of being a single point. @@ -2023,18 +2020,20 @@
This section describes identifiers to configure the visuals. - - Sets the field of view (fov). + - + - - - - + + + + + Sets the field of view (fov). + + @@ -2513,7 +2512,9 @@ - + + + @@ -2526,17 +2527,14 @@
- This section lists commands used by the client that communicate to the server. - Most are used for server administration. - Also see the "mode" section and the "map" command which also - communicate to the server. + This section lists commands used by the client that communicate to the server. Most are used for server administration. Also see the "mode" section and the "map" command which also communicate to the server. - Sets automated team assignment. - + Sets automated team assignment. + @@ -2544,11 +2542,11 @@ - - + + - Temporarally bans the specified player from the server. - + Temporarally bans the specified player from the server. + Temporary ban duration is fixed at 20 minutes. @@ -2562,14 +2560,14 @@ - - + + Calls a vote on the server. - This command is wrapped by aliases for better usability and is used to action votes such as ban, kick, etc. - See config/admin.cfg for actual uses. - + This command is wrapped by aliases for better usability and is used to action votes such as ban, kick, etc. + See config/admin.cfg for actual uses. + @@ -2580,8 +2578,8 @@ - Forces the specified player to join the enemy team. - + Forces the specified player to join the enemy team. + @@ -2592,8 +2590,8 @@ - Gives admin state to the specified player. - + Gives admin state to the specified player. + Requires admin state. The admin will lose his admin state after successfully issuing this command. @@ -2606,11 +2604,11 @@ - - + + - Kicks the specified player from the server. - + Kicks the specified player from the server. + @@ -2618,11 +2616,11 @@ - - + + - Sets the mastermode for the server. - + Sets the mastermode for the server. + If the mastermode is set to 'private', no more clients can join the server. @@ -2636,22 +2634,19 @@ - - - - Removes all temporary bans from the server. - Temporary bans are normally automatically removed after 20 minutes. - + + + Removes all temporary bans from the server. Temporary bans are normally automatically removed after 20 minutes. - + - Sends the current map to the server and sends other players a message about it. - + Sends the current map to the server and sends other players a message about it. + If the map argument is specified, the map is first saved and then reloaded before sending it. @@ -2666,8 +2661,8 @@ - - + + Claims or drops admin status. @@ -2694,12 +2689,12 @@
- - -
+ + +
- - + + Starts a map with the mode "Co-op edit" @@ -2717,8 +2712,8 @@ - - + + Starts a map with the mode "Capture the Flag" @@ -2731,8 +2726,8 @@ - - + + Starts a map with the mode "Deathmatch" @@ -2759,7 +2754,7 @@ - + Starts a map with the mode "Keep the Flag" @@ -2773,8 +2768,8 @@ - - + + Starts a map with the mode "Last man standing" @@ -2787,8 +2782,8 @@ - - + + Starts a map with the mode "Last swiss standing" @@ -2802,15 +2797,21 @@ - - Sets the gameplay mode to N for the next map loaded. You will need to define mode before loading the map or it will - stay as the last mode played. + + + Sets the gameplay mode to N for the next map loaded. + + + + You will need to define mode before loading the map or it will stay as the last mode played. + + - + @@ -2828,8 +2829,8 @@ - - + + Starts a map with the mode "One shot, One kill" @@ -2842,8 +2843,8 @@ - - + + Starts a map with the mode "Pistol frenzy" @@ -2856,7 +2857,7 @@ - + Starts a map with the mode "Team Deathmatch" @@ -2884,8 +2885,8 @@ - - + + Starts a map with the mode "Team one shot, One kill" @@ -2899,7 +2900,7 @@ - + Starts a map with the mode "Team survivor" @@ -2913,8 +2914,8 @@ - - + + Starts a map with the mode "Hunt the Flag". Some players prefer the name "VIP" for this mode. @@ -2927,49 +2928,49 @@ - - -
+ + +
All the below commands are used specifically in map configuration files. - Some of these commands can also be used without the need of a map configuration file. + Some of these commands can also be used without the need of a map configuration file. - + Sets the fog distance. You can do this for tweaking the visual effect of the fog, or if you are on a slow machine, setting the fog to a low value can also be a very effective way to increase fps (if you are geometry limited). - Try out different values on big maps / maps which give you low fps. It is also good for asthetic features of maps - especially when combined with "fogcolour". + Try out different values on big maps / maps which give you low fps. It is also good for asthetic features of maps + especially when combined with "fogcolour". + + + - - - - - + + Sets the fog and clearing colour. - - - + + + - - + + - Binds a texture to be used if a slot couldn't be loaded with a given textures path. - + Binds a texture to be used if a slot couldn't be loaded with a given textures path. + Binds the texture indicated in the filename to the texture slot of any textures that aren't found. @@ -2993,31 +2994,31 @@ - - + + Loads a skymap for a map. The available skymaps reside in packages/textures/skymaps/.. - To select a skymap you need to use the full path from "packages/" - but only up to the underscore "_" in the filename. + To select a skymap you need to use the full path from "packages/" + but only up to the underscore "_" in the filename. - - - - + loadsky "textures/skymaps/makke/mountain" + + + - - + + Registers a mapmodel that can be placed in maps. @@ -3028,9 +3029,14 @@ Example: mapmodel 4 2 4 0 "modelname" - This mapmodel has a bounding box of 8x8x2 in size (X/Y/Z) and by default hovers 4 units above ground. + + This mapmodel has a bounding box of 8x8x2 in size (X/Y/Z) and by default hovers 4 units above ground. + + + + @@ -3038,13 +3044,9 @@ - - - - - - + + Resets the mapmodel slots/indices to 0 for the subsequent "mapmodel" commands. Each subsequent mapmodel command increases it again. See config/default_map_settings.cfg for an example. @@ -3053,15 +3055,15 @@ - + Defines a mapsound. - Registers the sound as a map-specific sound. These map-specific sounds may currently - only be used with "sound" entities within a map. The first map sound registered in a map has slot/index number 0 - and increases afterwards. + Registers the sound as a map-specific sound. These map-specific sounds may currently + only be used with "sound" entities within a map. The first map sound registered in a map has slot/index number 0 + and increases afterwards. @@ -3078,7 +3080,7 @@ Resets the mapsound slots/indices to 0 for the subsequent "mapsound" commands. - Each subsequent mapsound command increases it again. See config/default_map_settings.cfg for an example. + Each subsequent mapsound command increases it again. See config/default_map_settings.cfg for an example. @@ -3088,10 +3090,10 @@ - - - Shadow yaw specifies the angle at which shadow stencils are drawn on a map. - + + + Shadow yaw specifies the angle at which shadow stencils are drawn on a map. + @@ -3099,17 +3101,17 @@ + + + When specifying shadowyaw, remember that the default angle is 45 degrees. The example below + would make the shadows appear at 90 degrees (45 degrees more to the left). + + - + - - - When specifying shadowyaw, remember that the default angle is 45 degrees. The example below - would make the shadows appear at 90 degrees (45 degrees more to the left). - - - - + + Binds a texture to the current texture slot. @@ -3127,8 +3129,8 @@ - - + + Sets the texture slots/indicies to 0 for the subsequent "texture" commands. Each subsequent texture command increases it again. See config/default_map_settings.cfg for an example. @@ -3137,27 +3139,27 @@ - + Determines the water colour in a map. + + + + + + You must define all 3 values, otherwise this command may not work + correctly (use "1" as a placeholder if needed). + + - - - - - - You must define all 3 values, otherwise this command may not work - correctly (use "1" as a placeholder if needed). - - - +