From 99904cf6cdd14f42aaf7e0db7eade2b8855d7db7 Mon Sep 17 00:00:00 2001 From: "Alejandro V. Garcia" Date: Fri, 30 Jul 2010 11:26:55 +0000 Subject: [PATCH] update git-svn-id: svn://svn.code.sf.net/p/actiongame/code/trunk/ac@5479 e016b1c5-ed68-44aa-a2f7-31cac88cffde --- config/docs.cfg | 226 ++++-- docs/reference.xml | 1684 +++++++++++++++++++++----------------------- 2 files changed, 969 insertions(+), 941 deletions(-) diff --git a/config/docs.cfg b/config/docs.cfg index 5f831167..c77e5a8f 100644 --- a/config/docs.cfg +++ b/config/docs.cfg @@ -279,7 +279,7 @@ docident [updatefrommaster] [Contacts the masterserver and adds any new servers 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. READ ONLY]; -docremark [As example, version 3.1.4.1 is represented as value 3141.]; +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.]; @@ -491,9 +491,7 @@ docident [skin_cla] [Choose skin when playing for team CLA.]; docargument [N] [skin id] [] [0]; docident [skin_rvsf] [Choose skin when playing for team RVSF.]; docargument [N] [skin id] [] [0]; -docident [spectatemode] [Toggle into spectator mode - only possible when you're dead! (if unsure, do not use this)]; - -docargument [N] [the spectator number] [mode id] [0]; +docident [spectatemode] [Toggle into spectator mode - only possible when you're dead!]; dockey [SPACE] [] [switch spectator mode]; dockey [MOUSE4] [] [next player]; dockey [MOUSE5] [] [previous player]; @@ -528,6 +526,8 @@ docident [addpath2way2] []; docident [addwp] []; docident [advancemaprevision] [Select the increment of the map revision number for the next 'savemap'.]; docargument [N] [increment] [min 1/max 100/default 1]; +docident [ambientsoundvol] [Deletes the entity closest to the player]; +docremark [hotkey x]; 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]; @@ -825,7 +825,7 @@ docident [showmenu] [Displays the specified menu.]; docargument [N] [the name of a previously defined menu] [] [0]; docremark [The menu allows the user to pick an item with the cursor keys. Upon pressing return, the associated action will be executed. Pressing ESC will cancel the menu.]; docsection [Head-Up Display] -docident [aboveheadiconfadetime] []; +docident [aboveheadiconfadetime] [Time in milliseconds before the abovehead dissapears.]; docargument [V] [] [min 1/max 10000/default 2000]; docident [altconsize] [Sets the number of text lines on an alternate F11 history display.]; docargument [V] [] [min 0/max 100/default 0]; @@ -845,15 +845,15 @@ docremark [When on, the crosshair will go grey when the weapon is reloading, ora docident [crosshairsize] [Sets the size of your crosshair.]; docargument [N] [the crosshair size] [min 0/max 50/default 15]; docremark [The crosshair is turned off entirely if the size is set to 0.]; -docident [crosshairteamsign] []; +docident [crosshairteamsign] [Turns on/off display of team warning crosshair.]; docargument [V] [] [min 0/max 1/default 1]; -docident [damageindicatoralpha] []; +docident [damageindicatoralpha] [Set the level of transparency of the damage indicator, 0 = is fully transparent, 100 = totaly solid.]; docargument [V] [] [min 1/max 100/default 50]; -docident [damageindicatordist] []; +docident [damageindicatordist] [Sets the separation of the arrows in the damage indicator.]; docargument [V] [] [min 0/max 10000/default 500]; -docident [damageindicatorsize] []; +docident [damageindicatorsize] [Sets the size of the damage indicator.]; docargument [V] [] [min 0/max 10000/default 200]; -docident [damageindicatortime] []; +docident [damageindicatortime] [Sets how long the damage indicator stays on screen.]; docargument [V] [] [min 1/max 10000/default 1000]; docident [fullconsize] [Sets the number of text lines on the F11 history display.]; docargument [V] [] [min 0/max 100/default 40]; @@ -861,35 +861,35 @@ docident [hidebigmenuimages] [Hide big images in menus.]; docargument [N] [0: show, 1: hide] [min 0/max 1/default 0]; docident [hidecompass] []; docargument [V] [] [min 0/max 1/default 0]; -docident [hideconsole] []; +docident [hideconsole] [Turns on or off the display of console text.]; docargument [V] [] [min 0/max 1/default 0]; -docident [hidectfhud] []; +docident [hidectfhud] [Turns on or off the display of flag icons.]; docargument [V] [] [min 0/max 1/default 0]; docident [hidedamageindicator] []; docargument [V] [] [min 0/max 1/default 0]; -docident [hidehudequipment] []; +docident [hidehudequipment] [Turns on or off the display of equipement icons.]; docargument [V] [] [min 0/max 1/default 0]; -docident [hidehudmsgs] []; +docident [hidehudmsgs] [Turns on or off the display of messages at the bottom of the screen.]; docargument [V] [] [min 0/max 1/default 0]; -docident [hideradar] []; +docident [hideradar] [Turns on or off the display of the on-screen radar.]; docargument [V] [] [min 0/max 1/default 0]; -docident [hidespecthud] []; +docident [hidespecthud] [Turns on or off the display of spectator staus.]; docargument [V] [] [min 0/max 1/default 0]; -docident [hideteam] []; +docident [hideteam] [Turns on or off the display of local player team icons.]; docargument [V] [] [min 0/max 1/default 0]; -docident [hidevote] []; +docident [hidevote] [Turns on or off the display of vote icons.]; docargument [V] [] [min 0/max 2/default 0]; docident [history] [Executes the specified command in the command line history.]; docargument [N] [the N'th command from the history] [] [0]; docremark [For example, binding "history 1" to a key allows you to quickly repeat the last command typed in (useful for placing many identical entities etc.)]; -docident [hudgun] []; +docident [hudgun] [Turns on or off the display of the current selected gun.]; docargument [V] [] [min 0/max 1/default 1]; docident [maxcon] [Sets the total number of text lines from the console to store as history.]; docargument [V] [] [min 10/max 1000/default 200]; docident [maxhistory] [Sets how many typed console commands to store.]; docargument [N] [Total of stored commands] [min 0/max 10000/default 1000]; docremark [This value sets how many command lines to store in memory, everytime a command is entered it gets store so it can be recalled using the "/" key along with the arrow keys to scroll back and forth through the list.]; -docident [maxrecoil] []; +docident [maxrecoil] [.]; docargument [V] [] [min 0/max 1000/default 1000]; docident [minimapres] [Sets the resolution for the minimap.]; docargument [N] [the resolution] [min 7/max 10/default 9]; @@ -897,17 +897,17 @@ docident [nosway] []; docargument [V] [] [min 0/max 1/default 0]; docident [oldfashionedgunstats] [Show ammo stats like in 1.0]; docargument [N] [0: new, 1: old] [min 0/max 1/default 0]; -docident [radarentsize] []; +docident [radarentsize] [Sets the icon size of the players shown in the radar and the minimap.]; docargument [V] [] [min 1/max 64/default 4]; -docident [radarres] []; -docargument [V] [] [min 1/max 1024/default 64]; +docident [radarres] [Sets the map area size or zoom level shown in the radar.]; +docargument [V] [] [min 10/max 1024/default 64]; docident [recoilbackfade] []; docargument [V] [] [min 0/max 1000/default 100]; docident [recoilbase] []; docargument [V] [] [min 0/max 1000/default 40]; docident [recoilincrease] []; docargument [V] [] [min 1/max 10/default 2]; -docident [recoiltest] []; +docident [recoiltest] [.]; docargument [V] [] [min 0/max 1/default 0]; docident [righthanded] [Choose player hand to carry the weapon.]; docargument [N] [0: lefty, 1: righty] [min 0/max 1/default 1]; @@ -924,7 +924,7 @@ docargument [V] [] [min 1/max 1000/default 105]; docsection [Visuals] docident [aadynshadow] [Sets the size/resolution of the dynamic shadow data.]; docargument [] [the size] [min 0/max 3/default 2]; -docident [aboveheadiconsize] []; +docident [aboveheadiconsize] [Sets the size for the icon shown above a player using comunications voices.]; docargument [V] [] [min 0/max 1000/default 50]; docident [animationinterpolationtime] [Sets the time available for interpolation between model animations.]; docargument [N] [the amount of milliseconds for the interpolation] [min 0/max 1000/default 100]; @@ -932,9 +932,9 @@ docident [ati_mda_bug] []; docargument [V] [] [min 0/max 1/default 0]; docident [bilinear] []; docargument [V] [] [min 0/max 1/default 1]; -docident [blood] []; +docident [blood] [Turn on and off the display of blood.]; docargument [V] [] [min 0/max 1/default 1]; -docident [bloodttl] []; +docident [bloodttl] [Sets the amount of time in milliseconds that blood is displayed on the ground.]; docargument [V] [] [min 0/max 30000/default 10000]; docident [bullethole] []; docargument [V] [] [min 0/max 1/default 1]; @@ -967,21 +967,21 @@ 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]; -docident [font] []; -docargument [A] [] [value] [0]; -docident [fontchar] []; -docargument [A] [] [value] [0]; +docident [font] [Loads an image to be used as a text font.]; +docargument [A] [Check font.cfg for examples of use] [value] [0]; +docident [fontchar] [Especify a region of an image to be used as a font character.]; +docargument [A] [Check font.cfg for examples of use] [value] [0]; docident [fov] [Sets the field of view (fov).]; docargument [N] [the FOV value] [min 75/max 120/default 90]; docident [fovcompat] [Sets the field of view (fov) based on the rules of AC v0.93]; docargument [A] [FOV degree] [] [0]; docremark [This command is supplied for backward compatibility.]; -docident [fpsrange] []; +docident [fpsrange] [(descripton unavailable)]; docargument [A] [min] [] [0]; docargument [B] [max] [] [0]; docident [fsaa] [Sets the level of fullscreen antialiasing (FSAA).]; docargument [] [fsaa] [min 0/max 16/default 0]; -docident [fullbrightlevel] []; +docident [fullbrightlevel] [Sets the level of brightness to use when using the command "/fullbright 1".]; docargument [V] [] [min 0/max 255/default 176]; docident [fullscreen] [Enables or disables fullscreen.]; docargument [] [fullscreen] [min 0/max 1/default 1]; @@ -1024,7 +1024,7 @@ docident [reflectscissor] []; docargument [V] [] [min 0/max 1/default 1]; docident [reflectsize] []; docargument [V] [] [min 6/max 10/default 8]; -docident [resetgl] []; +docident [resetgl] [Resets the OpenGL rendering settings]; docident [saveshadows] [Sets if dynamic shadows should be saved to disk.]; docargument [] [auto save] [min 0/max 1/default 1]; docident [scorch] []; @@ -1035,7 +1035,7 @@ docident [scr_h] [Sets the screen height.]; docargument [] [the screen height] [min 0/max 768/default 10000]; docident [scr_w] [Sets the screen width.]; docargument [] [the screen width] [min 0/max 1024/default 10000]; -docident [screenres] []; +docident [screenres] [Changes the screen resolution, available only for LINUX]; docargument [W] [width] [] [0]; docargument [H] [height] [] [0]; docident [setfont] [Changes the current font.]; @@ -1056,7 +1056,7 @@ docident [spectfov] []; docargument [V] [] [min 5/max 120/default 120]; docident [stencilbits] []; docargument [V] [] [min 0/max 32/default 0]; -docident [stencilshadow] []; +docident [stencilshadow] [Sets the transparency/opacity level of stencil shadows.]; 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]; @@ -1411,44 +1411,116 @@ 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]; -docremark [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).] -docexample [shadowyaw 90] [] -docident [texture] [Binds a texture to the current texture slot.] -docargument [0] [This is a redundant value. Always leave this value as 0 here so it doesn't break your configurations.] [0] [0] -docargument [F] [File name of the texture to bind] [String] [0] -docremark [Binds the texture indicated in the filename to the current texture slot and increments the slot number.] -docident [texturereset] [Sets the texture slots/indicies to 0 for the subsequent "texture" commands.] -docremark [Each subsequent texture command increases it again. See config/default_map_settings.cfg for an example.] -docident [watercolour] [Determines the water colour in a map.] -docargument [R] [Red colour intensity] [Between 1 and 255] [0] -docargument [G] [Green colour intensity] [Between 1 and 255] [0] -docargument [B] [Blue colour intensity] [Between 1 and 255] [0] -docremark [You must define all 3 values, otherwise this command may not work correctly (use "1" as a placeholder if needed).] -docident [maploaditemlength] [change at what position to truncate the map title string] -docident [showedithide] [shows the settings of edithide (sparklies)] -docremark [Lists all hidden entity types for which no sparky is drawn.] -docident [setedithide] [list of entities that do not emit a sparkly] -docargument [C] [list of type to hide] -docremark [pass light or 1, playerstart or 2. Call [setedithide 1 10] to just hide all lights and mapmodels.] -docremark [Or [setedithide [3 4 5 6 7 8 9 12 13]] for all the clips, ammo, nades, health, helmet, armour, akimbo, ladder, and flag.] -docremark [Reversly just use [1 2 10 11 13 14 15 16] to hide light, spawn, mapmodel, ladder, sound, clip, plclip.] -docremark [Only shown entity types are potential 'closest entity'.] -docident [seteditshow] [hides all but the single entity type you give. pass 1 for light, 2 for spawn, or use [playerstart].] -docargument [T] [type to show exclusively] -docremark [Just run [seteditshow model] and see just the model entities.] -docremark [The other entity types are ignored as closestentity too.] -docremark [other call forms may use the numerical item type] -docident [mfilter] [smoothes mouse movement, this way you have no jittering or video lag artifacts (if the mouse caused them), it's most likely usefull in case you havent got a gaming-grade mouse, if that's your case, use this new option,it will let you enjoy the game more atleast until you buy a new/better mouse.]; -docargument [N] [the smoothing factor (5 is recommended)] [float] [0] -docident [autoscopesens] [auto-regulates the sniper sensitivity, by taking into account how much zoom was applied]; -docremark [if you find that the sniper movement when zooming is too fast or too slow, than this option is definitely for you, else you can as usual customize you sniper scope sensitivity by modifying scopesensscale (defaults to 0.5, means half sensitivity for zoomed view)]; -docargument [N] [enables autoscopesens] [bool] [0] -docident [mouseaccel] [add's mouse acceleration, fast mouse movements create bigger ingame movement than a slow movement that took the same space.]; -docremark [if you want to try it start with 1 and then regulate it to your preference -eg. you can do a 180 degree turn in a little flick but still have the possibility to do very small ingame movements with a slow hand motion for fine aiming and precision. -it's higly recommendable (in case you are using mouse accel) to turn off "enhance pointer precision" on windows (or use "xset m 0 0" in commandline for linux) -you don't want your operating system to add strange mouse acceleration, you'll probably want to fine tune it trought the ingame option.] -docargument [N] [value for mouse acceleration] [float] [0] -docident [sensitivityscale] [divides mouse sensitivity and acceleration by it's value.] -docremark [you can cleaverly use this option when you change mouse to a higher dpi one, just set it to newdpi/olddpi, this way you won't need to change all other mouse parameters, and maybe never get them good as they used to be] -docargument [N] [value for sensitivity scale] [float] [0] +docremark [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).]; +docexample [shadowyaw 90] []; +docident [texture] [Binds a texture to the current texture slot.]; +docargument [0] [This is a redundant value. Always leave this value as 0 here so it doesn't break your configurations.] [0] [0]; +docargument [F] [File name of the texture to bind] [String] [0]; +docremark [Binds the texture indicated in the filename to the current texture slot and increments the slot number.]; +docident [texturereset] [Sets the texture slots/indicies to 0 for the subsequent "texture" commands.]; +docremark [Each subsequent texture command increases it again. See config/default_map_settings.cfg for an example.]; +docident [watercolour] [Determines the water colour in a map.]; +docargument [R] [Red colour intensity] [Between 1 and 255] [0]; +docargument [G] [Green colour intensity] [Between 1 and 255] [0]; +docargument [B] [Blue colour intensity] [Between 1 and 255] [0]; +docremark [You must define all 3 values, otherwise this command may not work correctly (use "1" as a placeholder if needed).]; +docsection [TODO] +docident [addzip] [TODO: Description]; +docargument [A] [TODO] [] [0]; +docargument [B] [TODO] [] [0]; +docargument [C] [TODO] [] [0]; +docident [akimboendaction] [0: none, 1: switch to primary?, 2: switch to nades?-before-switch to primary?]; +docargument [N] [TODO] [min 0/max 2/default 0]; +docident [ambient] [TODO]; +docargument [N] [TODO] [min 0/max 16777215/default 0]; +docident [applydialog] [do you reall want to quit?]; +docargument [N] [TODO] [min 0/max 1/default 1]; +docident [autoscopesens] [TODO]; +docargument [N] [TODO] [min 0/max 1/default 0]; +docident [checkmapdependencies] [Find what media the map depends on, this is used for mediapack providers.]; +docident [cncolumncolor] [colour of CN column in scoreboard]; +docargument [N] [TODO] [min 0/max 9/default 5]; +docident [damagescreen] [show the blood-spat overlay when receiving damage?]; +docargument [N] [TODO] [min 0/max 1/default 1]; +docident [damagescreenalpha] [if overlay of blood-spat, at what blending (transparency) level?]; +docargument [N] [TODO] [min 1/max 100/default 45]; +docident [damagescreenfactor] [if overlay of blood-spat, use which factor]; +docargument [N] [TODO] [min 1/max 100/default 7]; +docident [damagescreenfade] [if overlay of blood-spat, at what speed does it fade]; +docargument [N] [TODO] [min 0/max 1000/default 125]; +docident [findcn] [find client number (cn)]; +docargument [N] [NAME] [] [0]; +docident [findpn] [find player name]; +docargument [C] [CLIENTNUM] [] [0]; +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]; +docargument [N] [TODO] [min 0/max 1/default 0]; +docident [mapdimsfactor] [TODO]; +docargument [N] [TODO] [min 0/max 4/default 2]; +docident [maploaditemlength] [change at what position to truncate the map title string]; +docargument [N] [CHAR] [min 0/max 255/default 46]; +docident [mapshot] [save an image of the entire radar-overview of the map.]; +docident [maxrollremote] [TODO]; +docargument [N] [TODO] [min 0/max 1/default 1]; +docident [mdldlist] [TODO]; +docargument [N] [TODO] [min 0/max 1/default 1]; +docident [menufont] [switch the font in which the menu is displayed]; +docargument [F] [FONT] [] [0]; +docident [menuitemmapload] [a menuitem that loads a map, displays the title and the preview or a default image]; +docargument [M] [MAP] [] [0]; +docargument [T] [TEXT] [] [0]; +docident [mfilter] [TODO]; +docargument [N] [TODO] [min 0,0/max 6,0/default 0,0]; +docident [mouseaccel] [TODO]; +docargument [N] [TODO] [min 0,0/max 1000,0/default 0,0]; +docident [musicpreload] [TODO: Description]; +docargument [A] [TODO] [] [0]; +docident [orderscorecolumns] [variants of ordering CN first or not in scoreboard]; +docargument [N] [TODO] [min 0/max 1/default 0]; +docident [quicknadethrow] [TODO: Description]; +docident [radarheight] [change at what height you are floating in the radar-view]; +docargument [H] [height] [min 20/max 70/default 35]; +docident [removezip] [TODO: Description]; +docargument [A] [TODO] [] [0]; +docident [scopesensscale] [TODO]; +docargument [N] [TODO] [min 0,001/max 1000,0/default 0,5]; +docident [scorefont] [use monspacefont to render the scoreboard? or the default one?]; +docargument [N] [TODO] [min 0/max 1/default 0]; +docident [sensitivityscale] [TODO]; +docargument [N] [TODO] [min 0,001/max 1000,0/default 1,0]; +docident [setburst] [TODO: Description]; +docident [setedithide] [hides the list of entity types you set. pass 1 for light, 2 for spawn, or use "playerstart".]; +docargument [L] [list of types to hide] [] [0]; +docremark [pass light or 1, playerstart or 2. Call [setedithide 1 10] to just hide all lights and mapmodels.]; +docremark [Or [setedithide [3 4 5 6 7 8 9 12 13]] for all the clips, ammo, nades, health, helmet, armour, akimbo, ladder, and flag.]; +docremark [Reversly just use [1 2 10 11 13 14 15 16] to hide light, spawn, mapmodel, ladder, sound, clip, plclip.]; +docremark [Only shown entity types are potential 'closest entity'.]; +docident [seteditshow] [hides all but the single entity type you give. pass 1 for light, 2 for spawn, or use [playerstart].]; +docargument [T] [type to show exclusively] [] [0]; +docremark [Just run [seteditshow model] and see just the model entities.]; +docremark [The other entity types are ignored as closestentity too.]; +docremark [other call forms may use the numerical item type]; +docident [setwptriggernr] [TODO: Description]; +docargument [A] [TODO] [] [0]; +docident [showedithide] [shows the settings of edithide (sparklies)]; +docident [showmapbackdrop] [change wether to have a see-through map overview, or render it on a black backdrop]; +docargument [B] [on/off] [min 0/max 1/default 1]; +docident [soundmuted] [TODO: Description]; +docargument [A] [TODO] [] [0]; +docident [testvel] [TODO]; +docargument [N] [TODO] [min 0/max 1/default 0]; +docident [texreduce] [-1: 2x2 : 0 : 1: x0.5 : 2: x0.25 : 3: x0.125]; +docargument [N] [TODO] [min -1/max 3/default 0]; +docident [texturescale] [TODO]; +docargument [N] [TODO] [min 16/max 64/default 32]; +docident [voicecomsounds] [TODO]; +docargument [N] [TODO] [min 0/max 2/default 1]; diff --git a/docs/reference.xml b/docs/reference.xml index a9cd90f3..aff1e65c 100644 --- a/docs/reference.xml +++ b/docs/reference.xml @@ -18,7 +18,7 @@ This reference describes the commands and variables available in AssaultCube. @@ -996,962 +996,918 @@ - -
- This section describes gameplay related identifiers. - - -shifts your selected weapon by a given delta. By default the mouse-wheel shifts one up or down according to your scroll direction. - - - - - - - - + +
+ This section describes gameplay related identifiers. + - -will display a scope for the sniper-rifle. used in the zoom-script (config/scripts.cfg [l. 92ff "alias zoom"] - - - - + + shifts your selected weapon by a given delta. By default the mouse-wheel shifts one up or down according to your scroll direction. + + + + + + + + - -cycles through all available spectator modes. Follow-1stPerson, Follow-3rdPerson, Follow-3rdPerson-transparent and Fly. - - - - + + will display a scope for the sniper-rifle. used in the zoom-script (config/scripts.cfg [l. 92ff "alias zoom"] + + + + - -get the IP address of a given clientnumber - only admins get shown the last octet - - - - + + cycles through all available spectator modes. Follow-1stPerson, Follow-3rdPerson, Follow-3rdPerson-transparent and Fly. + + + + - -agree or disagree to the currently running vote - - - - - - - - + + get the IP address of a given clientnumber - only admins get shown the last octet + + + + - - - - - - - - - + + agree or disagree to the currently running vote + + + + + + + + - -returns the mapname - + + + + + + + + + - -outputs the mapsize. - + + returns the mapname + - -Loads a crosshair for a specific weapon of - if the weapon argument is omitted or <0 - for all weapons. - - - - - + + outputs the mapsize. + - - Enables or disables the processing of the bots artificial intelligence - - - - - - -Will make the bots stand still. - - - -Will enable the bots to move and shoot. - - - + + Loads a crosshair for a specific weapon of - if the weapon argument is omitted or <0 - for all weapons. + + + + + - - Kicks all bots out of the current game. - - - - + + Enables or disables the processing of the bots artificial intelligence + + + + + + + Will make the bots stand still. + + + + Will enable the bots to move and shoot. + + + - - Kicks the bot with the given name out of the current game. - - - - - - - Will make the bot named "Robbie" dissapear from the current game. - - - + + Kicks all bots out of the current game. + + + + - - - - - - - - - - + + Kicks the bot with the given name out of the current game. + + + + + + + Will make the bot named "Robbie" dissapear from the current game. + + + - - -Draws a shooting line in the direction of all available bots. - - - - -This is a debugging command and only works for single player modes. - - + - - -add a bot for a given team with a given skill calling him a given name. - - - - - - -This command only works for single player modes. - - - - -Will add a bot named Robbie with a medium skill level to the RVSF team. - - - + - -will add a given count of bots for the given team with the given skill and select random names for them. - - - - - - -This command only works for single player modes. -The name of the bots will be selected randomly. - - - - -Will add 2 bots with a bad skill level to the CLA team. - - - + + + + + + + + - -changes the skill level for the given bot. - - - - - - - -Changes the previous bot skill level of the bot named Robbie to a 'best' skill level. - - - + - -changes the skill level for all bots. - - - - - - -Changes the previous bot skill level for all bots to a 'worse' skill level. - - - + + Draws a shooting line in the direction of all available bots. + + + + + This is a debugging command and only works for single player modes. + + - -Enables or disables the ability of the bots to fire their weapons - - - - - - -Bots won't shoot. - - - + - - - - - + + add a bot for a given team with a given skill calling him a given name. + + + + + + + This command only works for single player modes. + + + + + Will add a bot named Robbie with a medium skill level to the RVSF team. + + + - -Returns 1 if the local player is alive. - - - -Output: 1 - - - + + will add a given count of bots for the given team with the given skill and select random names for them. + + + + + + + This command only works for single player modes. + The name of the bots will be selected randomly. + + + + + Will add 2 bots with a bad skill level to the CLA team. + + + - -Returns the current map being played. - -If you pass it a non-zero value, the result will be path-less. - - - - - -output: playing maps/ac_complex vote for: ac_complex - - - - - - - - - - - - + + changes the skill level for the given bot. + + + + + + + + Changes the previous bot skill level of the bot named Robbie to a 'best' skill level. + + + - -Returns the mode number for the current game. - - - - - - + + changes the skill level for all bots. + + + + + + + Changes the previous bot skill level for all bots to a 'worse' skill level. + + + - -Current map revision number. - - + + Enables or disables the ability of the bots to fire their weapons + + + + + + + Bots won't shoot. + + + - -Checks the current game mode for certain attributes. - - - - - -Possible attributes are: team, arena, flag and bot. - - - + + + + + - -Returns the current game mode number. - + + Returns 1 if the local player is alive. + + + + Output: 1 + + + - -Returns the current mastermode - + + Returns the current map being played. + + If you pass it a non-zero value, the result will be path-less. + + + + + output: playing maps/ac_complex vote for: ac_complex + + + + + + + + + + + - -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 1 if the local player has admin privileges, 0 otherwise. - - - - - + + Current map revision number. + + - -Returns information on the current server - if you're connected to one. - -If I is 0 (omitted or any other value than the ones below) you will get a string with 'IP PORT' -If I is 1,2 or 3 you will get the IP, HostName or port respectively. -If I is 4 you get a string representing the current state of the peer - usually this should be 'connected'. - - - - - - - -Output: I am connected to ctf-only.assault-servers.net - - - + + Checks the current game mode for certain attributes. + + + + + Possible attributes are: team, arena, flag and bot. + + + + + Returns the current game mode number. + + + + Returns the current mastermode + + + + 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. + + + + + + + + Returns information on the current server - if you're connected to one. + + If I is 0 (omitted or any other value than the ones below) you will get a string with 'IP PORT' + If I is 1,2 or 3 you will get the IP, HostName or port respectively. + If I is 4 you get a string representing the current state of the peer - usually this should be 'connected'. + + + + + + + + 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. - - - +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) "' !") ] ] - -Returns 1 if the local player is on the RVSF team, 0 if on CLA. - - - - - +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. + + + - -Returns the weapon-index the local player is currently holding. - - - - - - - - - + + Returns 1 if the local player is on the RVSF team, 0 if on CLA. + + + + + - -Returns the weapon-index the local player was previously holding. - - - - - - - - - + + Returns the weapon-index the local player is currently holding. + + + + + + + + + - - - + + Returns the weapon-index the local player was previously 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. - - -A map given as "blah" refers to "packages/maps/blah.cgz", "mypackage/blah" refers to "packages/mypackage/blah.cgz". -At every map load, "config/default_map_settings.cfg" is loaded which sets up all texture definitions, etc. Everything -defined there can be overridden per package or per map by creating a "mapname.cfg" which -contains whatever you want to do differently from the default. - - -When the map finishes it will load the next map when one is defined, otherwise it reloads the current map. -You can define what map follows a particular map by making an alias like (in the map script): alias nextmap_blah1 blah2 -(loads "blah2" after "blah1"). - - - - - - + + + - -Returns the primary weapon on next respawn. - - - - + + 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. + + + A map given as "blah" refers to "packages/maps/blah.cgz", "mypackage/blah" refers to "packages/mypackage/blah.cgz". + At every map load, "config/default_map_settings.cfg" is loaded which sets up all texture definitions, etc. Everything + defined there can be overridden per package or per map by creating a "mapname.cfg" which + contains whatever you want to do differently from the default. + + + When the map finishes it will load the next map when one is defined, otherwise it reloads the current map. + You can define what map follows a particular map by making an alias like (in the map script): alias nextmap_blah1 blah2 + (loads "blah2" after "blah1"). + + + + + + - -Reloads the weapon. - - - - + + Returns the primary weapon on next respawn. + + + + - - -Determines the skin of the current player. - - - -See the player model folder for the according skin-id. - - - - - - + + Reloads the weapon. + + + + - -Choose skin when playing for team CLA. - - - - + + Determines the skin of the current player. + + See the player model folder for the according skin-id. + + + + + - -Choose skin when playing for team RVSF. - - - - + + Choose skin when playing for team CLA. + + + + - -Sets the nick name for the local player. - - - - + + Choose skin when playing for team RVSF. + + + + - -Outputs text to other players. - - -If the text begins with a percent character (%), -only team mates will receive the message. - - - - - - + + Sets the nick name for the local player. + + + + - -Ignore a player. - - - - - -You won't see any further game chat or hear any more voice com messages from that player. - - - + + Outputs text to other players. + + + If the text begins with a percent character (%), + only team mates will receive the message. + + + + + + - -Print a list of all players that you are currently ignoring. - + + Ignore a player. + + + + + You won't see any further game chat or hear any more voice com messages from that player. + + - -Clear list of ignored players. - - - - - -Omit the client number to clear the whole list. - - - + + Print a list of all players that you are currently ignoring. + - -Mute a player - - - - - -You won't hear any further voice com messages from that player. - - - + + Clear list of ignored players. + + + + + Omit the client number to clear the whole list. + + - -Clear list of muted players. - - - - - -Omit the client number to clear the whole list. - - - + + Mute a player + + + + + You won't hear any further voice com messages from that player. + + - -Print a list of all players that you have muted. - + + Clear list of muted players. + + + + + Omit the client number to clear the whole list. + + - -Action chat message. - - - - + + Print a list of all players that you have muted. + - - -Puts a prompt on screen. - - - -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. - - - - - - - - - - - - - - - - - - + + Action chat message. + + + + - -Makes an input perform a certain command. - - - - - - - - - - - - - + + Puts a prompt on screen. + + + 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. + + + + + + + + + + + + + + + + + + - - - - - - - -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") - - - - - - - + + Makes an input perform a certain command. + + + + + + + + + + + + + - - - - - - - + + + + + + + + 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") + + + + + + + - - -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. - - - - - - + + + + + + + - - -Connects to a server. - - - -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. - - - - - - - - - - - - - - - - + + + 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. + + + + + + - -Connects to a server and tries to claim admin state. - - -This command will connect to a server just like the command 'connect' and -try to claim admin state. If the specified password is correct, the admin -will be able to connect even if he is locked out by ban, private master mode or taken client slots. -If successfully connected, bans assigned to the admin's host will be removed automatically. If all -client slots are taken a random client will be kicked to let the admin in. - - -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. - - - - - -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". - - - - - - - - - - - - + + Connects to a server. + + + 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. + + + + + + + + + + + + + + + + - -Leaves a server. - + + Connects to a server and tries to claim admin state. + + + This command will connect to a server just like the command 'connect' and + try to claim admin state. If the specified password is correct, the admin + will be able to connect even if he is locked out by ban, private master mode or taken client slots. + If successfully connected, bans assigned to the admin's host will be removed automatically. If all + client slots are taken a random client will be kicked to let the admin in. + + + 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. + + + + + + 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". + + + + + + + + + + + + - -Sets the team for the local player. - - - - - - - - - + + Leaves a server. + - -Move from active team to spectator during match. - + + Sets the team for the local player. + + + + + + + + + - -Connect to a modded server. - - - - - - - -The modified server needs to use the original client-server protocol. The protocol version number -will be the negated value of an unmodded server. - - - + + Move from active team to spectator during match. + - -Connect to a modded server and claim admin. - - - - - - - -The modified server needs to use the original client-server protocol. The protocol version number -will be the negated value of an unmodded server. - - - + + Connect to a modded server. + + + + + + + + The modified server needs to use the original client-server protocol. The protocol version number + will be the negated value of an unmodded server. + + + - -Connect to a modified LAN server. - - -The modified server needs to use the original client-server protocol. The protocol version number -will be the negated value of an unmodded server. - - - + + Connect to a modded server and claim admin. + + + + + + + + The modified server needs to use the original client-server protocol. The protocol version number + will be the negated value of an unmodded server. + + + - -Shows or hides the scores. - - - - + + Connect to a modified LAN server. + + + The modified server needs to use the original client-server protocol. The protocol version number + will be the negated value of an unmodded server. + + + - -Changes the weapon. - - - - + + Shows or hides the scores. + + + + - -Returns contents of current magazine. - -A knife will always return 1. -Weapons that aren't available will return -1. - - - - + + Changes the weapon. + + + + + + + Returns contents of current magazine. + + A knife will always return 1. + Weapons that aren't available will return -1. + + + + $mt 0) [ echo (numtwo $mc) "/" (numtwo $mr) ":" (at $wnames $w) ] -] + 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]]> - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + - -Returns contents of magazine reserve. - - - - - - - - - - - - + + Returns contents of magazine reserve. + + + + + + + + + + + + - -Retrieves the last map that was sent to the server using 'sendmap'. - - - - + + Retrieves the last map that was sent to the server using 'sendmap'. + + + + - - -Toggle into spectator mode - only possible when you're dead! - - - - - - - + + Toggle into spectator mode - only possible when you're dead! + + + + + + - - -Stops any demo recording or playback. - - + + Stops any demo recording or playback. + - - -Returns 1 when the current game is being played from a demo, else 0. - - - - - - - - + + Returns 1 when the current game is being played from a demo, else 0. + + + + + + + - - -Kills your player. You will lose 1 frag point and gain 1 death point when using this command. - - + + Kills your player. You will lose 1 frag point and gain 1 death point when using this command. + - -Plays a recorded demo. - - -Playback is interpolated for the player whose perspective you view. - - - - - - + + Plays a recorded demo. + + Playback is interpolated for the player whose perspective you view. + + + + + - - -Determines if bot waypoints should be selected/placed using the crosshair or by the nearest location to your player. - - - + + Determines if bot waypoints should be selected/placed using the crosshair or by the nearest location to your player. + + - -Returns the remaining minutes of the currently played game. READ ONLY - + + Returns the remaining minutes of the currently played game. READ ONLY + - - -Determines if the game should be paused. - - - + + Determines if the game should be paused. + + - -Indicates if the weapons should be reloaded automatically. - - + + Indicates if the weapons should be reloaded automatically. + + - - -Determines the FOV when scoping. - - - - - - + + Determines the FOV when scoping. + + + + + - - -Determines if the mini-map should be shown on screen. - - - + + Determines if the mini-map should be shown on screen. + + - - -Determines if scores should be shown on death. - - - + + Determines if scores should be shown on death. + + - -Indicates if the footsteps sound should be played - - + + Indicates if the footsteps sound should be played + + - -Indicates if the footsteps sound for the local player should be played - - + + Indicates if the footsteps sound for the local player should be played + + - -Maximum time span between player animation and the playback of the footstep sound - - -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. - - - - + + Maximum time span between player animation and the playback of the footstep sound + + + 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. + + + + - -Sets the gamespeed in percent. - -This does not work in multiplayer. For entertainment purposes only :) - - - + + Sets the gamespeed in percent. + + This does not work in multiplayer. For entertainment purposes only :) + + + - -
+ +
+
@@ -4052,7 +4008,7 @@ The name, description and remarks are included in the search. Writes out a base XML documentation reference containing templates for the builtin identifiers. -The generated reference is written to "config/autogenerated_base_reference.xml" by default. +The generated reference is written to "docs/autogenerated_base_reference.xml" by default. The three arguments can be changed later on in the generated XML document.