From 23968a440e3eea63a2f1c81e36ffa9d4ab143505 Mon Sep 17 00:00:00 2001 From: flowtron Date: Thu, 30 Oct 2008 08:30:12 +0000 Subject: [PATCH] syntax fixes, added descriptions, examples and missing "menudirlist" command git-svn-id: svn://svn.code.sf.net/p/actiongame/code/trunk/ac@3322 e016b1c5-ed68-44aa-a2f7-31cac88cffde --- docs/reference.xml | 384 ++++++++++++++++++++++++--------------------- 1 file changed, 209 insertions(+), 175 deletions(-) diff --git a/docs/reference.xml b/docs/reference.xml index 1877491d..1cfca6a2 100644 --- a/docs/reference.xml +++ b/docs/reference.xml @@ -106,29 +106,30 @@ - + + Determines if a values is less than or equal than a second value. + + + + + + + Determines if a values is greater than or equal than a second value. + + + + + logical AND. - - - - - output: 1 - + + Output: 1 - - - - - output: 0 - + + Output: 0 @@ -141,21 +142,13 @@ logical OR. - - - + output: 1 - - - + output: 0 @@ -186,11 +179,7 @@ Controls the script flow based on a boolean expression. - - $x 10) [ echo x is bigger than 10 ] [ echo x too small ] - ]]> - + $x 10) [ echo x is bigger than 10 ] [ echo x too small ]]]> @@ -208,11 +197,7 @@ - - - + @@ -231,11 +216,7 @@ - - - + @@ -247,11 +228,7 @@ Concatenates multiple strings with spaces inbetween. - - - + output: hello world @@ -272,11 +249,7 @@ - - - + output: CubeScript @@ -292,11 +265,7 @@ Grabs a word out of a string. - - - + output: two @@ -320,11 +289,7 @@ Executes a command after specified time period. - - - + Prints 'foo' to the screen after 1 second. @@ -347,25 +312,42 @@ This section describes general identifiers. - - - - - - - + Toggles getting descriptive text from CGZ or DMO files in menudirlist. + + + + - + Toggles physics interpolation. + + + create a menu listing of files from a path and perform an action on them when clicked. + + use this inside menu definitions, almost always as the only command of that menu. + compare the usage inside config/menus.cfg + + + + + + + + + will create a list of maps and load them when clicked + + + + + + + Toggles the console. - - - Triggers a jump. @@ -386,7 +368,7 @@ Returns the number of milliseconds since engine start. - echo (millis) + @@ -395,7 +377,7 @@ seconds since the epoch (00:00:00 UTC on January 1, 1970) - echo (systime) + @@ -406,13 +388,13 @@ - echo (timestamp) "2008 08 08 08 08 08" + - echo (timestamp) "2063 04 05 12 00 00" + - echo (at (timestamp) 0) (at (timestamp) 2) (at (timestamp) 1) "2063 05 04" + @@ -424,7 +406,7 @@ - echo (datestring) "Sat Jun 7 17:08:35 2008" + @@ -432,10 +414,10 @@ the current time in (H)H:MM:SS format - echo (timestring) "12:34:56" + - echo (timestring) "1:02:03" + @@ -461,7 +443,7 @@ - bind CTRL [ echo "key pressed"; onrelease [ echo "key released" ] ] + @@ -473,18 +455,20 @@ Binds a name to commands. - - - It is possible to re-bind an alias, even during its evaluation. - - - Example: alias myalias [ echo "hello world"; alias myalias [ echo "I already said hello" ] ] - - + + + + It is possible to re-bind an alias, even during its evaluation. + + + + There is also the shorthand version of defining an alias via the "="-sign. + + Quits the game without asking. @@ -591,7 +575,7 @@ Adds a server to the list of server to query in the server list menu. - + @@ -660,7 +644,7 @@ - Limits FPS of the game. + Limits the FPS (frames per second) of the game. @@ -677,12 +661,10 @@ - Turns on/off use of acronyms instead of full modenames in the serverbrowser. + Toggles use of acronyms instead of full modenames in the serverbrowser. - - - + Resets all binds back to their default values. @@ -766,16 +748,23 @@ - Gets an integer representing the game version. + Gets an integer representing the game version. READ ONLY As example, version 1.0 is represented as value 1000. - - Holds the current game mode. - + Holds the current game mode. READ ONLY + + + + Output: 5 + + + + + Indicates if a connection to a server exists. @@ -813,9 +802,12 @@ Returns 1 if the local player is alive. - - - + + + + Output: 1 + + @@ -826,11 +818,7 @@ - - - + output: playing maps/ac_complex vote for: ac_complex @@ -888,6 +876,34 @@ + + + + Output: I am connected to ctf-only.assault-servers.net + + + + + This will either remember or retrieve the last server you pressed the PrintScreen-key on. + + @@ -912,7 +928,7 @@ - + @@ -1017,7 +1033,24 @@ - + + + + + + + The completion will work on the first word of your console input. + + + + + If you enter "/demo " and press TAB you will cycle through all available demos. + + + + helper alias for quickly adding complete-definitions for all gamemodes - see config/script.cfg (below "Auto-Completions") + + @@ -1031,7 +1064,20 @@ - + + adds a command to complete nicknames on + + your own nick will be ignored + + + + + with this you can enter "/nickgreet " and cycle via TAB to the nickname you want to greet. + + + + + @@ -1045,16 +1091,14 @@ - - connect 127.0.0.1 555 myServerPassword - + - + @@ -1076,9 +1120,12 @@ - - connectadmin 127.0.0.1 777 myAdminPassword - + + connect as admin on port 777 of localhost + + + + will try to connect to a LAN server on the default port as admin with the given password of "myAdminPassword". @@ -1086,7 +1133,7 @@ - + @@ -1114,9 +1161,7 @@ Sets the team for the local player. - - team CLA - + @@ -1141,6 +1186,26 @@ A knife will always return 1. Weapons that aren't available will return -1. + + + $mt 0) [ echo (at $wnames $w) : (magcontent $w) ] [ ] + if (> $mt 0) [ echo (numtwo $mc) "/" (numtwo $mr) ":" (at $wnames $w) ] + ] +] + +Output: +01 / 01 : Knife +08 / 64 : Pistol +30 / 60 : Sub]]> + + @@ -1193,7 +1258,7 @@ - echo I am (at [not now] (watchingdemo)) watching a demo. "so, are you?" + @@ -2592,10 +2657,10 @@ - docident fov "Sets the field of view." + - docident "newent light" "Adds a new light entitiy." + @@ -2951,9 +3016,7 @@ - - coop ac_newmap - + @@ -2965,9 +3028,7 @@ Starts a map with the mode "Capture the Flag" - - ctf ac_mines - + @@ -2979,9 +3040,7 @@ Starts a map with the mode "Deathmatch" - - dm ac_complex - + @@ -2993,9 +3052,7 @@ Starts a map with the mode "Hunt the Flag" - - htf ac_mines - + @@ -3007,9 +3064,7 @@ Starts a map with the mode "Keep the Flag" - - ktf ac_mines - + @@ -3021,9 +3076,7 @@ Starts a map with the mode "Last man standing" - - lms ac_complex - + @@ -3035,9 +3088,7 @@ Starts a map with the mode "Last swiss standing" - - lss ac_complex - + @@ -3051,6 +3102,7 @@ + @@ -3082,9 +3134,7 @@ Starts a map with the mode "One shot, One kill" - - osok ac_complex - + @@ -3096,9 +3146,7 @@ Starts a map with the mode "Pistol frenzy" - - pf ac_complex - + @@ -3110,9 +3158,7 @@ Starts a map with the mode "Team Deathmatch" - - tdm ac_complex - + @@ -3124,9 +3170,7 @@ Starts a map with the mode "Team keep the Flag" - - tktf ac_mines - + @@ -3139,9 +3183,7 @@ Starts a map with the mode "Team one shot, One kill" - - tosok ac_complex - + @@ -3153,9 +3195,7 @@ Starts a map with the mode "Team survivor" - - ts ac_complex - + @@ -3167,9 +3207,7 @@ Starts a map with the mode "Hunt the Flag". Some players prefer the name "VIP" for this mode. - - vip ac_mines - + @@ -3228,10 +3266,10 @@ - loadnotexture // Reset to default + - loadnotexture "makke/black.jpg" // Any missing texture will show up black + @@ -3256,9 +3294,7 @@ - - loadsky "textures/skymaps/makke/mountain" - + @@ -3344,9 +3380,7 @@ - - shadowyaw 90 - +