diff --git a/config/docs.cfg b/config/docs.cfg index 7e2e565c..8031e79d 100644 --- a/config/docs.cfg +++ b/config/docs.cfg @@ -20,6 +20,26 @@ docargument [B] [second value] [] [0]; +docident [!=f] [Determines if a floating-point value is not equal to a second floating-point value.]; + +docargument [A] [the first value] [] [0]; + +docargument [B] [the second value] [] [0]; + + + +docident [&&] [logical AND.]; + +docargument [A] [first value] [] [0]; + +docargument [B] [second value] [] [0]; + +docexample [echo (&& 1 1)] [Output: 1]; + +docexample [echo (&& 1 0)] [Output: 0]; + + + docident [*] [Performs a multiplication.]; docargument [A] [the multiplicand] [] [0]; @@ -28,6 +48,18 @@ docargument [B] [the multiplier] [] [0]; +docident [||] [logical OR.]; + +docargument [A] [first value] [] [0]; + +docargument [B] [second value] [] [0]; + +docexample [echo (|| 1 0)] [output: 1]; + +docexample [echo (|| 0 0)] [output: 0]; + + + docident [+] [Performs an addition.]; docargument [A] [the first summand] [] [0]; @@ -38,6 +70,14 @@ docremark [Example: echo the sum of x and y is (+ $x $y)]; +docident [+f] [Adds up two floating-point numbers.]; + +docargument [A] [the first summand] [float] [0]; + +docargument [B] [the second summand] [float] [0]; + + + docident [<] [Determines if a value is smaller than a second value.]; docargument [A] [the first value] [] [0]; @@ -46,12 +86,46 @@ docargument [B] [the second value] [] [0]; +docident [<=] [Determines if a values is less than or equal than a second value.]; + +docargument [A] [the first value] [] [0]; + +docargument [B] [the second value] [] [0]; + + + +docident [<=f] [Determines if a floating-point value is less than or equal to a second floating-point value.]; + +docargument [A] [the first value] [] [0]; + +docargument [B] [the second value] [] [0]; + + + +docident [] [Determines if a value is bigger than a second value.]; @@ -62,6 +136,30 @@ docargument [B] [the second value] [] [0]; +docident [>=] [Determines if a values is greater than or equal than a second value.]; + +docargument [A] [the first value] [] [0]; + +docargument [B] [the second value] [] [0]; + + + +docident [>=f] [Determines if a floating-point value is greater than or equal to a second floating-point value.]; + +docargument [A] [the first value] [] [0]; + +docargument [B] [the second value] [] [0]; + + + +docident [>f] [Determines if a floating-point value is greater than a second floating-point value.]; + +docargument [A] [the first value] [] [0]; + +docargument [B] [the second value] [] [0]; + + + docident [at] [Grabs a word out of a string.]; docargument [S] [the string] [] [0]; @@ -94,7 +192,7 @@ docexample [alias a "Cube"; echo (concatword $a "Script")] [output: CubeScript]; -docident [div] [Performs a division.]; +docident [div] [Performs an integer division.]; docargument [A] [the dividend] [] [0]; @@ -102,6 +200,22 @@ docargument [B] [the divisor] [] [0]; +docident [divf] [Performs a division with floating-point precision.]; + +docargument [A] [] [the dividend] [0]; + +docargument [B] [] [the divisor] [0]; + + + +docident [-f] [Subtracts two floating-point numbers.]; + +docargument [A] [the minuend] [float] [0]; + +docargument [B] [the subtrahend] [float] [0]; + + + docident [findlist] [Searches a list for a specified value.]; docargument [L] [the list] [] [0]; @@ -110,18 +224,34 @@ docargument [I] [the item to find] [] [0]; +docident [format] []; + +docargument [F] [format] [use %1..%9 for the values] [0]; + +docargument [V] [value(s)] [] [0]; + +docexample [echo (format "%1 bottles of %2 on the %3, %1 bottles of %2!" 99 beer wall)] [output: 99 bottles of beer on the wall, 99 bottles of beer!]; + + + docident [if] [Controls the script flow based on a boolean expression.]; docargument [cond] [the condition] [0 (false) or anything else (true)] [0]; docargument [true] [the body to execute if the condition is true] [] [0]; -docargument [false] [the body to execute if the condition is true] [] [0]; +docargument [false] [the body to execute if the condition is false] [] [0]; docexample [if (> $x 10) [ echo x is bigger than 10 ] [ echo x too small ]] []; +docident [listlen] [returns the element count of the given list.]; + +docargument [L] [the list] [] [0]; + + + docident [loop] [Loops the specified body.]; docargument [V] [the alias used as counter] [] [0]; @@ -144,12 +274,44 @@ docargument [B] [the divisor] [] [0]; +docident [modf] [Performs a floating-point modulo operation.]; + +docargument [A] [the dividend] [] [0]; + +docargument [B] [the divisor] [] [0]; + +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] []; + +docargument [A] [alias] [] [0]; + + + +docident [push] []; + +docargument [N] [alias name] [] [0]; + +docargument [A] [action] [] [0]; + + + +docident [result] [sets the result value of a CubeScript block]; + +docargument [R] [the result] [] [0]; + + + docident [rnd] [Random value]; docargument [A] [The upper limit of the random value] [] [0]; @@ -192,7 +354,7 @@ docsection [General] docident [addserver] [Adds a server to the list of server to query in the server list menu.]; -docargument [S] [the name of the server (cn/ip)] [] [0]; +docargument [S] [the address of the server (hostname or IP)] [] [0]; docargument [P] [the port] [] [0]; @@ -204,9 +366,9 @@ docargument [N] [the name of the alias] [string, must not contain '$'] [0]; docargument [A] [the commands] [string] [0]; -docremark [It is possible to re-bind an alias, even during its evaluation.]; +docexample [alias myalias [ echo "hello world"; alias myalias [ echo "I already said hello" ] ]] [It is possible to re-bind an alias, even during its evaluation.]; -docremark [Example: alias myalias [ echo "hello world"; alias myalias [ echo "I already said hello" ] ]]; +docexample [test = [ echo "successful" ]] [There is also the shorthand version of defining an alias via the "="-sign.]; @@ -238,11 +400,25 @@ docremark [To find out what key names and their default bindings are, look at co +docident [browsefiledesc] [Toggles getting descriptive text from CGZ or DMO files in menudirlist.]; + +docargument [B] [] [min 0/max 1/default 1]; + + + +docident [changeteam] [Swaps your player to the enemy team.]; + + + +docident [clearservers] []; + + + docident [clockerror] [Sets the correction value for clockfix.]; docargument [V] [correction value] [min 990000/max 1010000/default 1000000]; -docremark [if(clockfix) millis = int(millis*(double(clockerror)/1000000));]; +docremark [Engine source-code snippet (main.cpp): if(clockfix) millis = int(millis*(double(clockerror)/1000000));]; @@ -276,6 +452,12 @@ docremark [Prints details while connecting triangles of 3d models.]; +docident [echo] []; + +docargument [L] [List of strings] [] [0]; + + + docident [exec] [Executes all commands in a specified config file.]; docargument [C] [the config file] [] [0]; @@ -288,19 +470,9 @@ docremark [default keys: W and Up Arrow]; -docident [gamemode] [Holds the current game mode.]; +docident [gamemode] [Holds the current game mode. READ ONLY]; -docargument [N] [gamemode] [min 1/max 0/default 0]; - - - -docident [highprocesspriority] [Specifies if the AC client process should run under high priority.]; - -docargument [B] [enable high priority] [min 0/max 0/default 0]; - -docremark [If enabled, AC might get more CPU resources from the operating system. This is useful when playing with bots or doing other resource intensive tasks.]; - -docremark [This is only implemented for the Windows platform. Also it only takes effect if the game is run in fullscreen mode and if the window has focus.]; +docexample [echo $gamemode] [Output: 5]; @@ -334,7 +506,7 @@ docremark [default keys: A and Left Arrow]; -docident [maxfps] [Limits FPS of the game.]; +docident [maxfps] [Limits the FPS (frames per second) of the game.]; docargument [V] [maximum FPS] [min 0/max 200/default 200]; @@ -352,6 +524,18 @@ docargument [V] [max. number of textures] [ read-only]; +docident [menudirlist] [create a menu listing of files from a path and perform an action on them when clicked.]; + +docargument [] [] [] [0]; + +docremark [use this inside menu definitions, almost always as the only command of that menu.]; + +docremark [compare the usage inside config/menus.cfg]; + +docexample [menudirlist "packages/maps" "cgz" "map $arg1"] [will create a list of maps and load them when clicked]; + + + docident [millis] [Returns the number of milliseconds since engine start.]; docexample [echo (millis)] []; @@ -364,20 +548,20 @@ docargument [V] [] [min 25/max 250/default 60]; -docident [minmillis] [Sets the minimum number of milliseconds a frame should take.]; - -docargument [N] [the number of milliseconds] [integer, 0 (off), default is 5] [0]; - -docremark [This is for very fast machines that run Cube at hundreds of fps. Default is 5, i.e. try to stay close to 200fps. This command is not exact, i.e. the precise delay it generates depends on OS and other factors... experiment with your ideal setting.]; - - - -docident [modeacronyms] [Turns on/off use of acronyms instead of full modenames in the serverbrowser.]; +docident [modeacronyms] [Toggles use of acronyms instead of full modenames in the serverbrowser.]; docargument [B] [] [min 0/max 1/default 0]; +docident [networkdebug] [Enables output of processed network packets.]; + +docargument [B] [enable network debugging] [min 0/max 1/default 0]; + +docremark [This variable only has an effect if the client binary is compiled in debug mode.]; + + + docident [onrelease] [Executes a command on the release of a key/button.]; docargument [A] [the command] [] [0]; @@ -388,15 +572,25 @@ docexample [bind CTRL [ echo "key pressed"; onrelease [ echo "key released" ] ]] +docident [physinterp] [Toggles physics interpolation.]; + +docargument [B] [] [min 0/max 1/default 1]; + + + docident [quit] [Quits the game without asking.]; -docident [rate] [Sets the clients maximum downstream bandwidth.]; +docident [registermusic] [registers a track as music - the first three tracks have special meaning. Track #1 is for "flag grab" the second and third are used as "last minute" tracks.]; -docargument [N] [the bytes per second] [min 0/max 25000/default 0]; +docargument [M] [music file] [] [0]; -docremark [Leaving it at 0 (the default) means the server will dynamically try to do the best thing, this is recommended for players who don't have a clue what their bandwidth is (setting your rate unoptimally is worse than not setting it all). Modem players (56k) could try rate 4000 and tweak from there, dsl players can try rate 6000-10000. Note that the more players on a server, the more critical the effect of your rate. If you are tweak addicted, you can try playing with the variables throttle_decel (how quickly to start dropping packets when your connection becomes bandwidth limited) throttle_accel (how quickly to recover once bandwidth becomes available again) and throttle_interval (how quickly to reestimate the situation). Change the defaults at your own risk.]; + + +docident [resetbinds] [Resets all binds back to their default values.]; + +docremark [This command executes the file /config/resetbinds.cfg which will bind all keys to the values specified in that file, thus resetting the binds to their default values.]; @@ -436,9 +630,7 @@ docremark [Secured maps can not be overwritten by the commands sendmap and getma docident [sensitivity] [Sets the mouse sensitivity.]; -docargument [S] [the sensitivity] [integer] [0]; - -docremark [With 'sensitivityscale' you can specify a number that the sensitivity is divided by.]; +docargument [S] [the sensitivity] [floating-point] [0]; @@ -454,6 +646,10 @@ docargument [V] [movement speed] [min 0/max 100/default 75]; +docident [soundtest] [Plays all hardcoded sounds in order.]; + + + docident [systime] [seconds since the epoch (00:00:00 UTC on January 1, 1970)]; docexample [echo (systime)] []; @@ -500,8 +696,6 @@ docexample [echo (timestring) "1:02:03"] []; docident [toggleconsole] [Toggles the console.]; -docargument [B] [toggle] [] [0]; - docident [tsswap] [Swaps vertices of model triangles.]; @@ -512,25 +706,49 @@ docargument [V] [] [min 0/max 1/default 1]; docident [updatefrommaster] [Contacts the masterserver and adds any new servers to the server list.]; +docargument [B] [force update] [0 (delayed), 1 (immediate)] [0]; + docremark [The servers are written to the config/servers.cfg file. This menu can be reached through the Multiplayer menu.]; -docident [version] [Gets an integer representing the game version.]; - -docargument [V] [] [min 1/max 0/default 1000]; +docident [version] [Gets an integer representing the game version. READ ONLY]; docremark [As example, version 1.0 is represented as value 1000.]; +docident [writecfg] [writes current configuration to config/saved.cfg - automatic on quit]; + + + docsection [Gameplay] +docident [addbot] [add a bot for a given team with a given skill calling him a given name.]; + +docargument [T] [team] [] [0]; + +docargument [S] [skill] [best,good,medium,worse OR bad] [0]; + +docargument [N] [name] [] [0]; + + + +docident [addnbot] [will add a given count of bots for the given team with the given skill and select random names for them.]; + +docargument [C] [count] [] [0]; + +docargument [T] [team] [] [0]; + +docargument [S] [skill] [best,good,medium,worse OR bad] [0]; + + + docident [alive] [Returns 1 if the local player is alive.]; -docargument [A] [] [value] [0]; +docexample [echo (alive)] [Output: 1]; @@ -540,15 +758,47 @@ docargument [B] [the autoreload state] [on (1), off (0) min 0/max 1/default 1]; +docident [botskill] []; + + + +docident [botskillall] []; + + + +docident [botsshoot] []; + + + +docident [changefollowplayer] []; + + + +docident [complete] []; + +docargument [C] [command] [any command or alias] [0]; + +docargument [P] [path] [path to search] [0]; + +docargument [E] [extension] [extension to match] [0]; + +docremark [The completion will work on the first word of your console input.]; + +docexample [complete demo "demos" dmo] [If you enter "/demo " and press TAB you will cycle through all available demos.]; + +docexample [alias mapcomplete [complete $arg1 "packages/maps" cgz]] [helper alias for quickly adding complete-definitions for all gamemodes - see config/script.cfg (below "Auto-Completions")]; + + + docident [connect] [Connects to a server.]; -docargument [N] [the (dns) name or ip of the server] [] [0]; +docargument [N] [the address of the server (hostname or IP)] [] [0]; docargument [O] [the port] [] [0]; docargument [P] [the server password] [] [0]; -docremark [If the server name ist omitted, the client will try to connect to an available server in the LAN. If the port is omitted or set to 0, the default port will be used.]; +docremark [If the server name is omitted, the client will try to connect to an available server in the LAN. If the port is omitted or set to 0, the default port will be used.]; docexample [connect 127.0.0.1 555 myServerPassword] []; @@ -556,7 +806,7 @@ docexample [connect 127.0.0.1 555 myServerPassword] []; docident [connectadmin] [Connects to a server and tries to claim admin state.]; -docargument [N] [the (dns) name or ip of the server] [] [0]; +docargument [N] [the address of the server (hostname or IP)] [] [0]; docargument [O] [the port] [] [0]; @@ -566,7 +816,37 @@ docremark [This command will connect to a server just like the command 'connect' docremark [If the server name ist omitted, the client will try to connect to an available server in the LAN. If the port is omitted or set to 0, the default port will be used.]; -docexample [connectadmin 127.0.0.1 777 myAdminPassword] []; +docexample [connectadmin 127.0.0.1 777 myAdminPassword] [connect as admin on port 777 of localhost]; + +docexample [connectadmin "" 0 myAdminPassword] [will try to connect to a LAN server on the default port as admin with the given password of "myAdminPassword".]; + + + +docident [crouch] []; + + + +docident [curmap] [Returns the current map being played.]; + +docargument [I] [clean] [0, 1] [0]; + +docremark [If you pass it a non-zero value, the result will be path-less.]; + +docexample [echo playing: (curmap) vote for: (curmap 1)] [output: playing maps/ac_complex vote for: ac_complex]; + + + +docident [curmode] [Returns the mode number for the current game.]; + + + +docident [currentprimary] [Returns the weapon-index the local player currently has selected as primary.]; + +docremark [This is not the same as curweapon - which could be a grenade or the knife.]; + + + +docident [currole] [Returns 1 if the local player has admin privileges, 0 otherwise.]; @@ -580,6 +860,18 @@ docremark [If I is 1,2 or 3 you will get the IP, HostName or port respectively.] docremark [If I is 4 you get a string representing the current state of the peer - usually this should be 'connected'.]; +docexample [echo [I am (curserver 4) to (curserver 2)]] [Output: I am connected to ctf-only.assault-servers.net]; + +docexample [last_server = "" remember_server = [ if (strcmp (curserver 4) "connected") [ last_server = (curserver 0) echo "I'm remembering:" $last_server ] [ echo "you are not 'connected' - you" (concatword "are '" (curserver 4) "' !") ] ] bind PRINT [ if (strcmp $last_server "") [ remember_server ] [ say (concat "^L2I was just ^Lfon^L3" $last_server) last_server = "" ] ]] [This will either remember or retrieve the last server you pressed the PrintScreen-key on.]; + + + +docident [curteam] [Returns 1 if the local player is on the RVSF team, 0 if on CLA.]; + + + +docident [curweapon] [Returns the weapon-index the local player is currently holding.]; + docident [demo] [Plays a recorded demo.]; @@ -608,6 +900,14 @@ docident [disconnect] [Leaves a server.]; +docident [drawbeamtobots] []; + + + +docident [dropflag] []; + + + docident [followmode] [Choose the mode of following. Either "chase" [3rd person] or "embody" [1st person].]; docargument [N] [followmode] [0 (chase) or 1 (embody)] [0]; @@ -640,14 +940,84 @@ docremark [This does not work in multiplayer. For entertainment purposes only :) +docident [getdemo] []; + +docargument [X] [number in list] [] [0]; + + + docident [getmap] [Retrieves the last map that was sent to the server using 'sendmap'.]; +docident [hidecustomskins] []; + +docargument [B] [] [min 0/max 1/default 0]; + + + +docident [idlebots] []; + +docargument [Y] [off OR on] [0||1] [0]; + + + +docident [inputcommand] [Makes an input perform a certain command.]; + +docargument [I] [input] [] [0]; + +docargument [C] [command] [] [0]; + +docargument [P] [prompt] [] [0]; + + + +docident [kickallbots] []; + + + +docident [kickbot] []; + +docargument [N] [botname] [] [0]; + + + +docident [lanconnect] []; + + + +docident [listcomplete] []; + + + +docident [listdemos] []; + + + +docident [loadcrosshair] [Loads a crosshair for a specific weapon of - if the weapon argument is omitted or <0 - for all weapons.]; + +docargument [I] [image] [] [0]; + +docargument [W] [weapon] [-1,0..7] [0]; + + + +docident [localfootsteps] [Indicates if the footsteps sound for the local player should be played]; + +docargument [B] [enable footsteps] [1 (true), 0 (false) min 0/max 1/default 1]; + + + docident [magcontent] [Returns contents of current magazine.]; docargument [N] [the weapon number] [0 (knife), 1 (pistol), 2 (shotgun), 3 (sub), 4 (sniper), 5 (assault), 6 (grenades)] [0]; +docremark [A knife will always return 1.]; + +docremark [Weapons that aren't available will return -1.]; + +docexample [wnames = "Knife Pistol Shotgun Sub Sniper Assault Grenades" numtwo = [ if (< $arg1 10) [ result (concatword 0 $arg1) ] [ result $arg1 ] ] ammoinfo = [ loop w (listlen $wnames) [ mc = (magcontent $w) mr = (magreserve $w) mt = (+ $mr $mc) if (> $mt 0) [ echo (numtwo $mc) "/" (numtwo $mr) ":" (at $wnames $w) ] ] ] Output: 01 / 01 : Knife 08 / 64 : Pistol 30 / 60 : Sub] []; + docident [magreserve] [Returns contents of magazine reserve.]; @@ -668,9 +1038,27 @@ docremark [When the map finishes it will load the next map when one is defined, -docident [minutesremaining] [Returns the remaining minutes of the currently played game.]; +docident [mapname] [returns the mapname]; -docargument [V] [minutes] [min 1/max 0/default -1]; + + +docident [mapsize] [outputs the mapsize.]; + + + +docident [mdldyncache] []; + +docargument [V] [] [min 1/max 32/default 2]; + + + +docident [mdlstatcache] []; + +docargument [V] [] [min 1/max 32/default 1]; + + + +docident [minutesremaining] [Returns the remaining minutes of the currently played game. READ ONLY]; @@ -686,12 +1074,24 @@ 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 [paused] [Determines if the game should be paused.]; docargument [B] [pause game] [min 0/max 1/default 0]; +docident [prevweapon] [Returns the weapon-index the local player was previously holding.]; + + + docident [reload] [Reloads the weapon.]; docargument [A] [] [value] [0]; @@ -710,7 +1110,7 @@ docident [saycommand] [Puts a prompt on screen.]; docargument [S...] [the text to display in the prompt] [] [1]; -docremark [this puts a prompt on screen that you can type into, and will capture all keystrokes until you press return (or esc to cancel). If what you typed started with a "/", the rest of it will be executed as a command, otherwise its something you "say" to all players.]; +docremark [this puts a prompt on screen that you can type into, and will capture all keystrokes until you press return (or ESC to cancel). If what you typed started with a "/", the rest of it will be executed as a command, otherwise its something you "say" to all players.]; dockey [T] [] [opens empty prompt]; @@ -730,6 +1130,22 @@ docargument [V] [] [min 5/max 50/default 50]; +docident [setscope] [will display a scope for the sniper-rifle. used in the zoom-script (config/scripts.cfg [l. 92ff "alias zoom"]]; + +docargument [Y] [scope on?] [0||1] [0]; + + + +docident [shiftweapon] [shifts your selected weapon by a given delta. By default the mouse-wheel shifts one up or down according to your scroll direction.]; + +docargument [D] [delta] [-N..-1,+1..N] [0]; + +dockey [MOUSE4] [] [cycle one up]; + +dockey [MOUSE5] [] [cycle one down]; + + + docident [showmap] [Determines if the mini-map should be shown on screen.]; docargument [B] [show mini-map] [min 0/max 1/default 0]; @@ -780,6 +1196,32 @@ docexample [team CLA] []; +docident [togglespect] [cycles through all available spectator modes. Follow-1stPerson, Follow-3rdPerson, Follow-3rdPerson-transparent and Fly.]; + +dockey [SPACE] [] [cycle spectator modes]; + + + +docident [voicecom] []; + +docargument [S] [sound] [must be a registered voicecom-sound] [0]; + +docargument [T] [text] [] [0]; + +dockey [V] [] [opens the voicecom menu, use number keys for your choice]; + + + +docident [vote] [agree or disagree to the currently running vote]; + +docargument [V] [vote value] [1 (yes) OR 2 (no)] [0]; + +dockey [F1] [] [votes YES]; + +dockey [F2] [] [votes NO]; + + + docident [watchingdemo] [Returns 1 when the current game is being played from a demo, else 0.]; docexample [echo I am (at [not now] (watchingdemo)) watching a demo. "so, are you?"] []; @@ -792,9 +1234,15 @@ docargument [N] [the weapon number] [0 (knife), 1 (pistol), 2 (shotgun), 3 (sub) -docident [xhairwpsel] [Determines if bot waypoints should be seceleted using the crosshair.]; +docident [whois] [get the IP address of a given clientnumber - only admins get shown the last octet]; -docargument [V] [] [min 0/max 1/default 1]; +docargument [C] [clientnum] [] [0]; + + + +docident [xhairwpsel] [Determines if bot waypoints should be selected/placed using the crosshair or by the nearest location to your player.]; + +docargument [V] [Note: This is turned on by default.] [min 0/max 1/default 1]; @@ -802,11 +1250,35 @@ docsection [Editing] +docident [addpath1way1] []; + + + +docident [addpath1way2] []; + + + +docident [addpath2way1] []; + + + +docident [addpath2way2] []; + + + +docident [addwp] []; + + + +docident [applymapsoundchanges] [during map editing, drop all mapsounds so they can be re-added]; + + + docident [arch] [Makes an arch out of the current selection.]; docargument [S] [side delta (optional)] [] [0]; -docremark [The selection must be a heightfield before this command can be used. Will make the arch in the long direction, i.e when you have 6x2 cubes selected, the arch will span 7 vertices. Optionally, sidedelta specifies the delta to add to the outer rows of vertices in the other direction, i.e. give the impression of an arch that bends 2 ways (try "arch 2" on an selection of atleast 2 thick to see the effect). Not all arch sizes are necessarily available, see config/prefabs.cfg.]; +docremark [The selection must be a heightfield before this command can be used. Will make the arch in the long direction, i.e when you have 6x2 cubes selected, the arch will span 7 vertices. Optionally, sidedelta specifies the delta to add to the outer rows of vertices in the other direction, i.e. give the impression of an arch that bends 2 ways (try "arch 2" on an selection of at least 2 thick to see the effect). Not all arch sizes are necessarily available, see config/prefabs.cfg.]; @@ -822,6 +1294,10 @@ docremark [See config/prefabs.cfg for an example on usage.]; +docident [autowp] []; + + + docident [clearents] [Deletes all entities of said type.]; docargument [T] [the entity type, see command 'newent'] [string] [0]; @@ -850,6 +1326,26 @@ docremark [hotkey x]; +docident [delpath1way1] []; + + + +docident [delpath1way2] []; + + + +docident [delpath2way1] []; + + + +docident [delpath2way2] []; + + + +docident [delwp] []; + + + docident [editheight] [Changes the height of the current selection.]; docargument [T] [an integer denoting the type] [0 (floor), 2 (ceiling)] [0]; @@ -860,6 +1356,18 @@ docremark [Default keys are [ and ] for floor level, and o/p for ceiling.]; +docident [editing] []; + +docargument [V] [] [min 1/max 0/default 0]; + + + +docident [edittag] []; + +docargument [T] [tag] [integer value] [0]; + + + docident [edittex] [Changes the texture on current selection by browsing through a list of textures directly shown on the cubes.]; docargument [T] [an integer denoting the type] [0 (floor), 1 (lower or wall), 2 (ceiling), 3 (upper wall)] [0]; @@ -890,6 +1398,22 @@ docremark [For example 'entproperty 0 2' when executed near a lightsource would +docident [entset] [Edits the closest entity.]; + +docargument [type] [the entity type] [light, sound, clip, playerstart, clips, ammobox, grenades, health, armour, akimbo, mapmodel, ladder, ctf-flag] [0]; + +docargument [value1] [see newent 'type'] [] [0]; + +docargument [value2] [see newent 'type'] [] [0]; + +docargument [value3] [see newent 'type'] [] [0]; + +docargument [value4] [see newent 'type'] [] [0]; + +docremark [Overwrites the closest entity with the specified values.]; + + + docident [equalize] [Levels the floor/ceiling of the selection.]; docargument [T] [an integer denoting the type] [0 (floor), 2 (ceiling)] [0]; @@ -912,13 +1436,21 @@ docremark [Will be reset when you issue a 'recalc'. Only works in edit mode.]; +docident [getentattr] []; + + + +docident [getenttype] []; + + + docident [heightfield] [Marks the current selection as a heightfield.]; docargument [T] [an integer denoting the type] [0 (floor), 2 (ceiling)] [0]; docremark [marks the current selection as a heightfield, with T being floor or ceiling, as above. A surface marked as heightfield will use the vdelta values (see below) of its 4 corners to create a sloped surface. To mark a heightfield as normal again (ignoring vdelta values, set or not) use "solid 0". Default keys are h (floor) and i (ceiling).]; -docremark [Heightfields should be made the exact size that is needed, not more not less. The most important reason for this is that cube automatically generates "caps" (side-faces for heightfields) only on the borders of the heightfield. This also means if you have 2 independant heightfields accidentally touch eachother, you will not get correct caps. Also, a heightfield is slightly slower to render than a non-heightfield floor or ceiling. Last but not least, a heightfield should have all the same baseheight (i.e. the height determined by a normal editheight operation) to get correct results.]; +docremark [Heightfields should be made the exact size that is needed, not more not less. The most important reason for this is that cube automatically generates "caps" (side-faces for heightfields) only on the borders of the heightfield. This also means if you have 2 independent heightfields accidentally touch each other, you will not get correct caps. Also, a heightfield is slightly slower to render than a non-heightfield floor or ceiling. Last but not least, a heightfield should have all the same baseheight (i.e. the height determined by a normal editheight operation) to get correct results.]; @@ -954,7 +1486,7 @@ docremark [For example: /mapmsg "Map By Author"]; docident [newent] [Adds a new entity]; -docargument [type] [the entity type] [light, playerstart, pistol, ammobox, grenades, health, armour, akimbo, mapmodel, ladder, ctf-flag] [0]; +docargument [type] [the entity type] [light, sound, clip, playerstart, pistol, ammobox, grenades, health, armour, akimbo, mapmodel, ladder, ctf-flag] [0]; docargument [value1] [see newent 'type'] [] [0]; @@ -980,7 +1512,17 @@ docident [newent armour] [Adds a new armour item.]; -docident [newent pistol] [Adds a pistol magazine item.]; +docident [newent clip] [Adds a clip entity.]; + +docargument [Z] [elevation above the ground] [integer] [0]; + +docargument [X] [X radius around the box center] [integer] [0]; + +docargument [Y] [Y radius around the box center] [integer] [0]; + +docargument [H] [height of the box] [integer] [0]; + +docremark [Defines a clipping box against which the player will collide.]; @@ -1030,7 +1572,11 @@ docargument [Z] [Extra elevation above ground] [Integer] [0]; docargument [T] [The map texture to use (optional)] [Integer] [0]; -docremark [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. Mapmodels are more expensive than normal map geometry, so do not use insane amounts of them to replace normal geometry.]; +docremark [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 identifier. 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. Mapmodels are more expensive than normal map geometry, so do not use insane amounts of them to replace normal geometry.]; + + + +docident [newent pistol] [Adds a pistol magazine item.]; @@ -1052,6 +1598,8 @@ docargument [V] [the volume] [default 255] [0]; docremark [Will play map-specific sound so long as the player is within the radius. However, only up to the max uses allowed for N (specified in the mapsound command) will play, even if the player is within the radius of more N sounds than the max. By default (size 0), the sound is a point source. Its volume is maximal at the entity's location, and tapers off to 0 at the radius. If size is specified, the volume is maximal within the specified size, and only starts tapering once outside this distance. Radius is always defined as distance from the entity's location, so a size greater than or equal to the radius will just make a sound that is always max volume within the radius, and off outside.]; +docremark [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.]; + docident [newmap] [Creates a new map.]; @@ -1078,7 +1626,7 @@ docargument [E] [the random seed] [integer] [0]; docargument [C] [cube size, how many cubes to generate a surface for at once (unused)] [] [0]; -docremark [Keep the seed the same to create multiple perlin areas which fit with eachother, or use different numbers if to create alternative random generations.]; +docremark [Keep the seed the same to create multiple perlin areas which fit with each other, or use different numbers if to create alternative random generations.]; @@ -1098,9 +1646,9 @@ docremark [See for example config/sounds.cfg.]; -docident [replace] [Repeats the last texture edit thruout the map.]; +docident [replace] [Repeats the last texture edit throughout the map.]; -docremark [The way it works is intuitive: simply edit any texture anywhere, then using "replace" will replace all textures thruout the map in the same way (taking into account wether it was a floor/wall/ceil/upper too). If the there was more than one "old" texture in your selection, the one nearest to the red dot is used. This operation can't be undone.]; +docremark [The way it works is intuitive: simply edit any texture anywhere, then using "replace" will replace all textures throughout the map in the same way (taking into account whether it was a floor/wall/ceil/upper too). If the there was more than one "old" texture in your selection, the one nearest to the red dot is used. This operation can't be undone.]; @@ -1140,6 +1688,14 @@ docremark [Coordinates are as follows: after a "newmap 6" the top-left corner (t +docident [setjumpwp] []; + + + +docident [setwpyaw] [takes the current player yaw for the current waypoint]; + + + docident [showmip] [Toggles between showing what parts of the scenery are rendered.]; docremark [Shows what parts of the scenery are rendered using what size cubes, and outputs some statistics about it. This can give map editors hints as to what architecture to align, textures to change, etc.]; @@ -1164,6 +1720,26 @@ docremark [This operation retains floor/ceiling heights/textures while swapping +docident [telebot] []; + + + +docident [testvisible] []; + +docargument [D] [direction] [0..5 for Forward, Backward, Left, Right, Up AND Down] [0]; + + + +docident [togglebotview] [When used you will see what the bot sees. Type it again (with or without name) to return to the game(you will respawn).]; + +docargument [N] [botname] [] [0]; + + + +docident [togglegrap] [Will toggle the focus of the mouse in game. Normally you can use your mouse to look around, when you type this command your mouse cursor is visible and can be used as normally. This is only useful when you run cube windowed, of course.]; + + + docident [toggleocull] [Turns occlusion culling on and off.]; docremark [The reason one may want to turn it off is to get an overview of the map from above, without having all occluded bits stripped out.]; @@ -1184,6 +1760,10 @@ docremark [undo's work for any size areas, so the amount of undo steps per megab +docident [unsetjumpwp] []; + + + docident [vdelta] [changes the vdelta value of the current selection]; docargument [N] [vdelta value] [] [0]; @@ -1200,7 +1780,35 @@ docargument [H] [the water level] [integer] [0]; docremark [Every cube that has a lower floor than the water level will be rendered with a nice wavy water alpha texture. Water physics will be applied to any entity located below it.]; -docremark [Performance notes: water is rendered for a whole square encapsulating all visible water areas in the map (try flying above the map in edit mode to see how). So the most efficient water is a single body of water, or multiple water areas that are mostly not visible from eachother. Players can influence how accurate the water is rendered using the "watersubdiv" command (map config).]; +docremark [Performance notes: water is rendered for a whole square encapsulating all visible water areas in the map (try flying above the map in edit mode to see how). So the most efficient water is a single body of water, or multiple water areas that are mostly not visible from each other. Players can influence how accurate the water is rendered using the "watersubdiv" command (map config).]; + + + +docident [wpclear] []; + + + +docident [wpflood] []; + + + +docident [wpinfo] [makes waypoints visible and either turns on or off the waypoint information display.]; + +docargument [Y] [show info?] [0||1] [0]; + + + +docident [wpload] []; + + + +docident [wpsave] []; + + + +docident [wpvisible] []; + +docargument [V] [visible] [0||1] [0]; @@ -1222,19 +1830,53 @@ docargument [S] [the scale] [] [0]; -docident [menuinit] [Specifies a block of commands to be executed when menu opens.]; +docident [closemenu] [Closes the specified menu if it is open.]; -docargument [C] [the code to execute on init] [] [0]; +docargument [N] [the name of a previously defined menu] [] [0]; + +docremark [If it is open multiple times in the stack only the topmost instance will be closed!]; + + + +docident [menuinit] [Specifies commands to be executed when a menu opens.]; + +docargument [C] [The code to execute on init] [] [0]; + +docremark [This command should be placed after newmenu.]; docident [menuitem] [Creates a new menuitem.]; -docargument [N] [the name of the menuitem] [] [0]; +docargument [N] [The menuitem description.] [] [0]; -docargument [A] [the action on selection] [] [0]; +docargument [A] [The command to execute on selection of the menuitem.] [] [0]; -docremark [If the action argument is omitted, then it will be set to the same value as the description. Upon pressing return, the associated action will be executed. See config/menus.cfg for examples.]; +docargument [H] [The command to execute upon rolling over the menuitem.] [] [0]; + +docremark [Upon activating the menuitem, the associated command will be executed. (See config/menus.cfg for examples). If the command argument is omitted, then it will be set to the same value as the description. If -1 is specified instead of the command to execute, then no command is executed when activating the item. If the rollover option is used, the menuitem will execute that command when selecting (but not activating) the menuitem.]; + +docremark [(Note: To activate the menu item, select it, and either: Click, press SPACE or press ENTER/Return).]; + + + +docident [menuitemcheckbox] []; + + + +docident [menuitemimage] []; + + + +docident [menuitemkeyinput] []; + + + +docident [menuitemslider] []; + + + +docident [menuitemtextinput] []; @@ -1252,7 +1894,9 @@ docargument [S] [the scale] [] [0]; docident [newmenu] [Creates a new menu.]; -docargument [N] [the name of the menu] [] [0]; +docargument [N] [The name of the menu] [] [0]; + +docremark [All menu commands placed after newmenu (i.e. menuitem, menuitemcheckbox, etc) are added into the menu until another "newmenu" command is specified.]; @@ -1274,6 +1918,12 @@ docargument [V] [] [min 1/max 10000/default 2000]; +docident [altconsize] []; + +docargument [V] [] [min 0/max 100/default 0]; + + + docident [clearminimap] [Recreates the minimap for the current map.]; @@ -1346,6 +1996,18 @@ docargument [V] [] [min 1/max 10000/default 1000]; +docident [fullconsize] []; + +docargument [V] [] [min 0/max 100/default 40]; + + + +docident [hidecompass] []; + +docargument [V] [] [min 0/max 1/default 0]; + + + docident [hideconsole] []; docargument [V] [] [min 0/max 1/default 0]; @@ -1358,6 +2020,12 @@ docargument [V] [] [min 0/max 1/default 0]; +docident [hidedamageindicator] []; + +docargument [V] [] [min 0/max 1/default 0]; + + + docident [hidehudequipment] []; docargument [V] [] [min 0/max 1/default 0]; @@ -1414,9 +2082,21 @@ docargument [V] [] [min 0/max 1/default 1]; +docident [maxcon] []; + +docargument [V] [] [min 10/max 1000/default 200]; + + + +docident [maxrecoil] []; + +docargument [V] [] [min 0/max 1000/default 1000]; + + + docident [minimapres] [Sets the resolution for the minimap.]; -docargument [N] [the resoution] [min 7/max 10/default 9]; +docargument [N] [the resolution] [min 7/max 10/default 9]; @@ -1508,6 +2188,12 @@ docargument [N] [the amount of milliseconds for the interpolation] [min 0/max 10 +docident [ati_mda_bug] []; + +docargument [V] [] [min 0/max 1/default 0]; + + + docident [bilinear] []; docargument [V] [] [min 0/max 1/default 1]; @@ -1544,13 +2230,49 @@ docargument [] [bits per pixel] [min 0/max 32/default 0]; +docident [dbghbox] []; + +docargument [V] [] [min 0/max 1/default 0]; + + + +docident [dbgmbatch] []; + +docargument [V] [] [min 0/max 1/default 0]; + + + +docident [dbgstenc] []; + +docargument [V] [] [min 0/max 2/default 0]; + + + +docident [dbgtiles] []; + +docargument [V] [] [min 0/max 1/default 0]; + + + +docident [dbgvlight] []; + +docargument [V] [] [min 0/max 1/default 0]; + + + docident [depthbits] [Sets the bits for the depth buffer.]; docargument [] [depth pixels] [min 0/max 32/default 0]; -docident [dynlight] [Determines wether dynamic shadows and lights are rendered, providedjust incase they slow your fps down too much.]; +docident [depthoffset] []; + +docargument [V] [] [min /max /default 0.005f]; + + + +docident [dynlight] [Determines whether dynamic shadows and lights are rendered, provided just incase they slow your fps down too much.]; docargument [R] [the radius of a dynamic light] [min 0/max 32/default 16]; @@ -1564,6 +2286,18 @@ docargument [] [the alpha value] [min 0/max 100/default 40]; +docident [dynshadowdecay] []; + +docargument [V] [] [min 0/max 3000/default 1000]; + + + +docident [dynshadowquad] []; + +docargument [V] [] [min 0/max 1/default 0]; + + + docident [dynshadowsize] [Sets the display size of the dynamic shadows.]; docargument [] [the size] [min 4/max 8/default 5]; @@ -1572,15 +2306,27 @@ docargument [] [the size] [min 4/max 8/default 5]; docident [font] []; +docargument [A] [] [value] [0]; + docident [fontchar] []; +docargument [A] [] [value] [0]; + docident [fov] [Sets the field of view (fov).]; -docargument [N] [the fov value] [90..120] [0]; +docargument [N] [the FOV value] [min 90/max 120/default 100]; + + + +docident [fpsrange] []; + +docargument [A] [min] [] [0]; + +docargument [B] [max] [] [0]; @@ -1590,6 +2336,12 @@ docargument [] [fsaa] [min 0/max 16/default 0]; +docident [fullbrightlevel] []; + +docargument [V] [] [min 0/max 255/default 176]; + + + docident [fullscreen] [Enables or disables fullscreen.]; docargument [] [fullscreen] [min 0/max 1/default 1]; @@ -1626,6 +2378,14 @@ docargument [N] [time to live] [min 0/max 15000/default 5000]; +docident [glext] [checks for the searchstring in all loaded extensions]; + +docargument [E] [extension] [] [0]; + +docexample [if (glext shadow_funcs) [echo you have shadow functionality] [echo no shadows for you]] []; + + + docident [hwtexsize] []; docargument [V] [] [min 1/max 0/default 0]; @@ -1670,6 +2430,18 @@ docargument [P] [the scale percentage] [min 20/max 500/default 100]; +docident [polygonoffsetfactor] []; + +docargument [V] [] [min /max /default -3.0f]; + + + +docident [polygonoffsetunits] []; + +docargument [V] [] [min /max /default -3.0f]; + + + docident [reflectclip] []; docargument [V] [] [min 0/max 100/default 3]; @@ -1688,6 +2460,10 @@ docargument [V] [] [min 6/max 10/default 8]; +docident [resetgl] []; + + + docident [saveshadows] [Sets if dynamic shadows should be saved to disk.]; docargument [] [auto save] [min 0/max 1/default 1]; @@ -1718,6 +2494,32 @@ docargument [] [the screen width] [min 0/max 1024/default 10000]; +docident [screenres] []; + +docargument [W] [width] [] [0]; + +docargument [H] [height] [] [0]; + + + +docident [shadowcasters] []; + +docargument [V] [] [min 1/max 0/default 0]; + + + +docident [shadowclip] []; + +docargument [V] [] [min 0/max 1/default 1]; + + + +docident [shadowtile] []; + +docargument [V] [] [min 0/max 1/default 1]; + + + docident [shotline] []; docargument [V] [] [min 0/max 1/default 1]; @@ -1730,12 +2532,30 @@ docargument [V] [] [min 0/max 10000/default 75]; +docident [skyclip] []; + +docargument [V] [] [min 0/max 1/default 1]; + + + docident [spectfov] []; docargument [V] [] [min 5/max 120/default 120]; +docident [stencilbits] []; + +docargument [V] [] [min 0/max 32/default 0]; + + + +docident [stencilshadow] []; + +docargument [V] [] [min 0/max 100/default 40]; + + + docident [teamdisplaymode] [Sets the team display mode.]; docargument [N] [the team display mode] [0 (none), 1 (color vests), 2 (color skins) min 0/max 2/default 1]; @@ -1754,6 +2574,8 @@ docident [vsync] [Enables or disables vsync.]; docargument [] [vsync] [min -1/max 1/default -1]; +docremark [-1 uses the default settings obtained from the system. 0 disables, 1 enables vsync.]; + docident [waterreflect] []; @@ -1780,6 +2602,18 @@ docsection [Sound] +docident [al_referencedistance] []; + +docargument [V] [] [min 0/max 1000000/default 400]; + + + +docident [al_rollofffactor] []; + +docargument [V] [] [min 0/max 1000000/default 100]; + + + docident [audio] [Enables or disables the audio subsystem in AC.]; docargument [B] [enable] [min 0/max 1/default 1]; @@ -1860,6 +2694,8 @@ docident [mutesound] [Mute a specific game sound.]; docargument [N] [ID of the sound to mute] [see config/sounds.cfg, starting at ID 0] [0]; +docargument [A] [audible?] [(mute) 0 || 1 (unmute)] [0]; + docident [sound] [Plays the specified sound.]; @@ -1878,6 +2714,30 @@ docremark [AC will try to allocate that number of channels but it is not guarant +docident [soundscheddistancescore] []; + +docargument [V] [] [min 0/max 1000/default 5]; + + + +docident [soundschedoldbonus] []; + +docargument [V] [] [min 0/max 1000/default 100]; + + + +docident [soundschedpriorityscore] []; + +docargument [V] [] [min 0/max 1000/default 100]; + + + +docident [soundschedreserve] []; + +docargument [V] [] [min 0/max 100/default 2]; + + + docident [soundvol] [Sets the sound volume for all sounds.]; docargument [N] [the volume] [min 0/max 255/default 128]; @@ -1932,15 +2792,15 @@ docargument [D] [the description] [] [0]; docremark [An identifier represents a command or variable. The new identifier]; -docremark [The name may countain spaces to create a "multipart" identifier documentation that can be used to describe a complex argument as a single pseudo identifier, look at the examples.]; +docremark [The name may contain spaces to create a "multipart" identifier documentation that can be used to describe a complex argument as a single pseudo identifier, look at the examples.]; docexample [docident fov "Sets the field of view."] []; -docexample [docident "newent light" "Adds a new light entitiy."] []; +docexample [docident "newent light" "Adds a new light entity."] []; -docident [docinvalid] [Outputs a list of identifer documentations that do not match any existing identifer.]; +docident [docinvalid] [Outputs a list of identifier documentations that do not match any existing identifier.]; docremark [Multipart identifiers are not included in this list, see 'docident'.]; @@ -1948,6 +2808,8 @@ docremark [Multipart identifiers are not included in this list, see 'docident'.] docident [dockey] []; +docargument [A] [] [value] [0]; + docident [docref] [Adds a new documentation reference to an identifier.]; @@ -1984,7 +2846,7 @@ docident [docundone] [Outputs a list of yet undocumented identifiers (commands,v docargument [A] [output all identifiers] [1 (true), 0 (false)] [0]; -docremark [If the one argument is omitted, only the builtin identifiers will be listed. Therefore specify the argument other identifers like aliases should be included too.]; +docremark [If the one argument is omitted, only the builtin identifiers will be listed. Therefore specify the argument other identifiers like aliases should be included too.]; docremark [Note that the list also includes identifiers that contain the substrings "TODO" or "UNDONE" in their documentation.]; @@ -2018,7 +2880,7 @@ docargument [B] [Enables or disables auto team.] [1 (On), 0 (Off)] [0]; -docident [ban] [Temporarally bans the specified player from the server.]; +docident [ban] [Temporary ban of the specified player from the server.]; docargument [CN] [The player to ban] [Client number] [0]; @@ -2066,10 +2928,28 @@ docremark [If the mastermode is set to 'private', no more clients can join the s +docident [masterupdatefrequency] []; + +docargument [V] [] [min 1/max 24*60*60/default 60*60]; + + + +docident [maxservpings] []; + +docargument [V] [] [min 0/max 1000/default 0]; + + + docident [removebans] [Removes all temporary bans from the server. Temporary bans are normally automatically removed after 20 minutes.]; +docident [searchlan] []; + +docargument [V] [] [min 0/max 2/default 1]; + + + docident [sendmap] [Sends the current map to the server and sends other players a message about it.]; docargument [M] [Map to save and reload locally] [] [0]; @@ -2078,13 +2958,39 @@ docremark [If the map argument is specified, the map is first saved and then rel +docident [serverextension] [Modded servers announcement of features. See source/src/server.cpp [Line 2926ff. "case SV_EXTENSION:"]]; + +docargument [E] [extension] [] [0]; + +docargument [D] [description] [] [0]; + + + +docident [serversort] []; + +docargument [V] [] [min 0/max NUMSERVSORT-1/default 0]; + + + +docident [servpingrate] []; + +docargument [V] [] [min 1000/max 60000/default 5000]; + + + docident [setadmin] [Claims or drops admin status.]; docargument [B] [Status] [1 (Claim), 0 (Drop)] [0]; -docargument [PASS] [Password] [Maximum of 15 characters] [0]; +docargument [PASS] [Password] [case sensitive] [0]; -docremark [Successfully claiming admin status makes all other player votes invalid. Failed logins result in an auto kick. The admin is granted the right to kick, ban, remove bans, set autoteam, set shuffleteam, change server description (if enabled), change map, change mastermode, force team, change mode, record demos, stop demos and clear demo(s) - All without needing votes from other users. In the scoreboard, the admin will be shown as a red colour.]; +docremark [Failed logins result in an auto kick. The admin is granted the right to kick, ban, remove bans, set autoteam, set shuffleteam, change server description (if enabled), change map, change mastermode, force team, change mode, record demos, stop demos and clear demo(s) - All without needing votes from other users. If the admin votes on any (other players) call, his vote is final. In the scoreboard, the admin will be shown as a red colour.]; + + + +docident [showallservers] []; + +docargument [V] [] [min 0/max 1/default 1]; @@ -2118,6 +3024,14 @@ docexample [dm ac_complex] []; +docident [gamemodedesc] []; + +docargument [M] [mode] [integer] [0]; + +docargument [D] [description] [string] [0]; + + + docident [htf] [Starts a map with the mode "Hunt the Flag"]; docargument [M] [The name of the map you wish to play] [] [1]; @@ -2134,7 +3048,7 @@ docexample [ktf ac_mines] []; -docident [lms] [Starts a map with the mode "Last man standing"]; +docident [lms] [Starts a map with the mode "Last Man Standing"]; docargument [M] [The name of the map you wish to play] [] [1]; @@ -2142,7 +3056,7 @@ docexample [lms ac_complex] []; -docident [lss] [Starts a map with the mode "Last swiss standing"]; +docident [lss] [Starts a map with the mode "Last Swiss Standing"]; docargument [M] [The name of the map you wish to play] [] [1]; @@ -2150,9 +3064,11 @@ docexample [lss ac_complex] []; -docident [mode] [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.]; +docident [mode] [Sets the gameplay mode to N for the next map loaded.]; -docargument [N] [The mode number] [0 - Team Deathmatch] [0]; +docargument [N] [The mode number] [] [0]; + +docargument [] [] [0 - Team Deathmatch] [0]; docargument [] [] [1 - Co-op edit] [0]; @@ -2160,29 +3076,31 @@ docargument [] [] [2 - Deathmatch] [0]; docargument [] [] [3 - Survivor] [0]; -docargument [] [] [4 - Team survivor] [0]; +docargument [] [] [4 - Team Survivor] [0]; docargument [] [] [5 - Capture the Flag] [0]; -docargument [] [] [6 - Pistol frenzy] [0]; +docargument [] [] [6 - Pistol Frenzy] [0]; -docargument [] [] [7 - Bot team deathmatch] [0]; +docargument [] [] [7 - Bot Team Deathmatch] [0]; -docargument [] [] [8 - Bot deathmatch] [0]; +docargument [] [] [8 - Bot Deathmatch] [0]; -docargument [] [] [9 - Last swiss standing] [0]; +docargument [] [] [9 - Last Swiss Standing] [0]; -docargument [] [] [10 - One shot, One kill] [0]; +docargument [] [] [10 - One Shot, One Kill] [0]; -docargument [] [] [11 - Team One shot, One kill] [0]; +docargument [] [] [11 - Team One Shot, One Kill] [0]; -docargument [] [] [12 - Bot One shot, One kill] [0]; +docargument [] [] [12 - Bot One Shot, One Kill] [0]; docargument [] [] [13 - Hunt the Flag] [0]; -docargument [] [] [14 - Team keep the flag] [0]; +docargument [] [] [14 - Team Keep the Flag] [0]; -docargument [] [] [15 - Keep the flag] [0]; +docargument [] [] [15 - Keep the Flag] [0]; + +docremark [You will need to define mode before loading the map or it will stay as the last mode played.]; @@ -2194,7 +3112,7 @@ docexample [osok ac_complex] []; -docident [pf] [Starts a map with the mode "Pistol frenzy"]; +docident [pf] [Starts a map with the mode "Pistol Frenzy"]; docargument [M] [The name of the map you wish to play] [] [1]; @@ -2210,7 +3128,7 @@ docexample [tdm ac_complex] []; -docident [tktf] [Starts a map with the mode "Team keep the Flag"]; +docident [tktf] [Starts a map with the mode "Team Keep the Flag"]; docargument [M] [The name of the map you wish to play] [] [1]; @@ -2218,7 +3136,7 @@ docexample [tktf ac_mines] []; -docident [tosok] [Starts a map with the mode "Team one shot, One kill"]; +docident [tosok] [Starts a map with the mode "Team One Shot, One Kill"]; docargument [M] [The name of the map you wish to play] [] [1]; @@ -2226,7 +3144,7 @@ docexample [tosok ac_complex] []; -docident [ts] [Starts a map with the mode "Team survivor"]; +docident [ts] [Starts a map with the mode "Team Survivor"]; docargument [M] [The name of the map you wish to play] [] [1]; @@ -2248,9 +3166,9 @@ docsection [Editing configs] docident [fog] [Sets the fog distance.]; -docargument [N] [The fog distance] [0...1024, default is 160] [0]; +docargument [N] [The fog distance] [64...1024, default is 180] [0]; -docremark [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".]; +docremark [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 aesthetic features of maps especially when combined with "fogcolour".]; @@ -2260,6 +3178,12 @@ docargument [C] [The colour] [Hexadecimal colour, default is 0x8099B3] [0]; +docident [isolatecontext] [Isolates the given context. This disables access from this context to identifiers located in other contexts, also it removes all aliases created in this context once the running context changes]; + +docargument [C] [the context] [] [0]; + + + docident [loadnotexture] [Binds a texture to be used if a slot couldn't be loaded with a given textures path.]; docargument [F] [file name of the texture to bind] [string] [0]; @@ -2320,6 +3244,162 @@ docremark [Registers the sound as a map-specific sound. These map-specific sound +docident [mapsoundreset] [Resets the mapsound slots/indices to 0 for the subsequent "mapsound" commands.]; + +docremark [Each subsequent mapsound command increases it again. See config/default_map_settings.cfg for an example.]; + + + +docident [md2anim] []; + +docargument [A] [anim] [] [0]; + +docargument [F] [frame] [] [0]; + +docargument [R] [range] [] [0]; + +docargument [S] [speed] [] [0]; + + + +docident [md2emit] []; + +docargument [T] [tag] [] [0]; + +docargument [Y] [type] [] [0]; + +docargument [A] [arg1] [] [0]; + +docargument [B] [arg2] [] [0]; + + + +docident [md2tag] []; + +docargument [N] [name] [] [0]; + +docargument [A] [vert1] [] [0]; + +docargument [B] [vert2] [] [0]; + +docargument [C] [vert3] [] [0]; + +docargument [D] [vert4] [] [0]; + + + +docident [md3anim] []; + +docargument [A] [anim] [] [0]; + +docargument [S] [startframe] [] [0]; + +docargument [R] [range] [] [0]; + +docargument [V] [speed] [] [0]; + + + +docident [md3emit] []; + +docargument [T] [tag] [] [0]; + +docargument [Y] [type] [] [0]; + +docargument [A] [arg1] [] [0]; + +docargument [B] [arg2] [] [0]; + + + +docident [md3link] []; + +docargument [P] [parentno] [] [0]; + +docargument [C] [childno] [] [0]; + +docargument [T] [tagname] [] [0]; + + + +docident [md3load] []; + +docargument [M] [model] [] [0]; + + + +docident [md3skin] []; + +docargument [N] [object name] [] [0]; + +docargument [S] [skin texture] [] [0]; + + + +docident [mdlalphatest] []; + +docargument [A] [alphatest] [] [0]; + + + +docident [mdlcachelimit] []; + +docargument [L] [cachelimit] [] [0]; + + + +docident [mdlcullface] []; + +docargument [C] [cullface] [0||1] [0]; + + + +docident [mdlscale] []; + +docargument [P] [percent] [0..100..N*100] [0]; + + + +docident [mdlshadowdist] []; + +docargument [D] [shadow distance] [] [0]; + + + +docident [mdltrans] [translates (= moves) the model]; + +docargument [X] [] [] [0]; + +docargument [Y] [] [] [0]; + +docargument [Z] [] [] [0]; + + + +docident [mdltranslucent] []; + +docargument [T] [translucency] [0..100..N*100] [0]; + + + +docident [mdlvertexlight] []; + +docargument [V] [vertexligh] [0||1] [0]; + + + +docident [scriptcontext] []; + +docargument [C] [context] [] [0]; + +docargument [N] [idname] [] [0]; + + + +docident [sealcontexts] [secure this configuration for the rest of the game]; + + + docident [shadowyaw] [Shadow yaw specifies the angle at which shadow stencils are drawn on a map.]; docargument [D] [The angle in degrees to rotate the stencil shadows] [0...360, default is 45] [0];