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

Update docs

Browse Source 
Compatible with the tree in assaultcube.github.io for #49dacb0 commit.
This commit is contained in:
aurhat
2017-11-25 00:43:47 +01:00
parent 45bded0150
commit a9c73cb50b
1 changed files with 40 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files
config/docs.cfg
+40 -25
View File
@@ -398,7 +398,7 @@ docref [alias];
docident [pop] [Resets a previously pushed alias to it's original value.];
docargument [A] [alias] [] [0];
docremark [It is allowed to use multiple arguments for "pop". So instead of "pop var_a ; pop var_b" you can write "pop var_a var_b". Also, "pop" will now give back the removed value of the first alias from the argument list. This allows using the pop'd value one last time.];
docexample [pop p; echo $p] [Output: 1];
docexample [p = 1; push p 2; pop p; echo $p] [Output: 1];
docref [push];
docident [powf] [Returns A raised to the power of B (floating-point).];
docargument [A] [the mantissa] [] [0];
@@ -427,7 +427,7 @@ docref [isolatecontext];
docident [sleep] [Executes a command after specified time period.];
docargument [N] [the amount of milliseconds] [] [0];
docargument [C] [the command to execute] [] [0];
docargument [P] [ignore map change (optional)] [] [0];
docargument [P] [ignore map change] [] [0];
docexample [sleep 1000 [ echo foo ]] [Prints 'foo' to the screen after 1 second.];
docident [sortlist] [Returns a sorted version of a list.];
docargument [L] [list to sort] [] [0];
@@ -722,6 +722,7 @@ dockey [BACKQUOTE|SLASH|CARET] [` or / or ^] [opens a command prompt /];
dockey [Y] [] [opens a command prompt % (for team chat)];
dockey [TAB] [Tab] [autocompletes forwards commands/variables/aliases];
dockey [LSHIFT+TAB] [left Shift + Tab] [autocompletes backwards commands/variables/aliases];
dockey [LSHIFT+ESCAPE] [left Shift + Esc] [resets the commandline to the state before using TAB-completion];
dockey [UP] [Up Arrow] [browse forwards command history];
dockey [DOWN] [Down Arrow] [browse backwards command history];
docref [complete];
@@ -1227,7 +1228,7 @@ docref [lastpm];
docident [quicknadethrow] [Switches to grenades, if available (must be bound to a key).];
docremark [If grenades are already selected or the key is held, it throws a grenade and switches back to previous weapon.];
dockey [G] [] [for all weapons];
dockey [MOUSE2] [right mouse button] [for all weapons besides sniper rifle];
dockey [MOUSE2] [right mouse button] [for all weapons except sniper rifle];
docref [grenades];
docident [reconnect] [Disconnects then reconnects you to the current server.];
docargument [P] [the server password] [] [0];
@@ -1711,6 +1712,7 @@ dockey [LCTRL] [left Ctrl] [];
docref [addselection];
docref [entproperty];
docref [undelent];
docref [pasteent];
docref [editmetakeydown];
docref [editmeta2];
docident [editmeta2] [Second modifier key for editing mode.];
@@ -1836,6 +1838,7 @@ dockey [PERIOD] [.] [equalizes the selection on the ceiling];
docident [expandselection] [Increases the size of the current selection by N cubes on all sides.];
docargument [N] [number of cubes] [integer] [0];
docremark [Instead of manually executing this command, you can bind "domodifier 11" to a key. While holding this key you can expand/shrink the current selection with the mouse wheel.];
docremark [It works also with multiple selections.];
docref [select];
docref [addselection];
docref [shrinkselection];
@@ -2039,7 +2042,7 @@ docremark [You can get the type of map license with the $mapinfo_license variabl
docref [mapinfo_comment];
docident [mapmodelchanged] [Set to "1" with every command that changes mapmodel slots.];
docargument [N] [0: not changed, 1: changed] [min 0/max 1/default 0];
docremark [Should be used to trigger a rebuild of mapsound menus.];
docremark [Should be used to trigger a rebuild of mapmodel menus.];
docref [mapmodel];
docref [editmapmodelslot];
docref [deletemapmodelslot];
@@ -2094,7 +2097,7 @@ docremark [The mipmapping routine does not take into account, if certain texture
docremark [Before any changes are made, mapmrproper creates a backup, which can be restored by "undo" command. Enable mipstats ("showmip" command), to see, what has been done.];
docref [showmip];
docident [mapmsg] [Sets the map message, which will be displayed when the map loads.];
docargument [M] [The map message] [String] [0];
docargument [M] [The map message] [string] [0];
docremark [You will need to use quote marks around the message, otherwise it save the message correctly.];
docremark [For example: /mapmsg "Map By Author"];
docremark [You can get the current map message with the $mapmsg variable.];
@@ -2189,14 +2192,14 @@ docremark [Note that this entity is used for physics only, to create a visual la
docref [newent mapmodel];
docident [newent light] [Adds a new light entity.];
docargument [radius] [the light radius] [1..32] [0];
docargument [R] [red colour component. see remarks below.] [1..255] [0];
docargument [R] [red colour component, see remarks below] [1..255] [0];
docargument [G] [green colour component] [1..255] [0];
docargument [B] [blue colour component] [1..255] [0];
docremark [if only argument R is specified, it is interpreted as brightness for white light.];
docident [newent mapmodel] [Adds a map model to the map (i.e. a rendered md2/md3 model which you collide against but has no behaviour or movement).];
docargument [N] [The mapmodel identifier] [Integer] [0];
docargument [Z] [Extra elevation above ground] [Integer] [0];
docargument [T] [The map texture to use] [Integer] [0];
docargument [N] [The mapmodel identifier] [integer] [0];
docargument [Z] [Extra elevation above ground] [integer] [0];
docargument [T] [The map texture to use] [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 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.];
docident [newent playerstart] [Adds a new spawn spot.];
@@ -2253,7 +2256,9 @@ dockey [V] [] [];
docref [copy];
docident [pasteent] [Pastes a previously copied entity.];
docremark [It also works with the menu list of copied entities. It works only while in edit mode.];
docremark [Pressing "editmeta" while using "pasteent" opens the menu with a list of copied entities.];
docref [copyent];
docref [editmeta];
docident [perlin] [Generates a perlin noise landscape in the current selection.];
docargument [S] [the scale, frequency of the features] [default is 10] [0];
docargument [E] [the random seed] [integer] [0];
@@ -2381,7 +2386,7 @@ docident [settex] [Sets a texture for the current selection.];
docargument [T] [position of the texture to set in map cfg] [integer] [0];
docargument [t] [the type of the texture] [0 (floor), 1 (wall), 2 (ceil), 3 (upper wall)] [0];
docident [setvantagepoint] [Sets vantage point in current camera position.];
docremark [The vantage point is supposed to be a distinctive view on a map - like the angle from which the preview picture was taken. It is allowed to use when editing or spectating in singleplayer mode.];
docremark [The vantage point is supposed to be a distinctive view on a map - like the angle from which the preview picture was taken. It is allowed to use when editing offline or spectating offline.];
docremark [A map can only have one vantage point.];
docref [gotovantagepoint];
docref [getvantagepoint];
@@ -2421,6 +2426,7 @@ docargument [N] [-] [min 0/max 1/default 1];
docident [shrinkselection] [Decreases the size of the current selection by N cubes on all sides.];
docargument [N] [number of cubes] [integer] [0];
docremark [Instead of manually executing this command, you can bind "domodifier 11" to a key. While holding this key you can expand/shrink the current selection with the mouse wheel.];
docremark [It works also with multiple selections.];
docref [select];
docref [addselection];
docref [expandselection];
@@ -2459,7 +2465,7 @@ docident [sorttextureslots] [Sorts all texture slots alphabetically and merges i
docargument [nosort] [do not sort the list alphabetically] [] [0];
docargument [nomerge] [do not merge any slots] [] [0];
docargument [mergeused] [merge used and unused (identical) slots freely] [] [0];
docremark [By default, the list is sorted (besides the first five) and only unused identical (with the same texture and scale factor) slots are merged. The keywords can be combined in any order. "nomerge" takes priority over "mergeused".];
docremark [By default, the list is sorted (except the first five) and only unused identical (with the same texture and scale factor) slots are merged. The keywords can be combined in any order. "nomerge" takes priority over "mergeused".];
docremark [It allows to manually sort also the first few slots by adding the slot number to move to the slots #1, #2, #3, #4 (for example "sorttextureslots 11 12 13 14" will move slot #11 to slot #1, #12 to #2, #13 to #3 and #14 to #4, and sort the rest texture slots).];
docremark [See examples in the "sortmapmodelslots" reference.];
docref [texture];
@@ -2993,8 +2999,6 @@ docident [bullethole] [Turns on/off the display of bullet holes.];
docargument [V] [Enable/Disable bullet holes] [min 0/max 1/default 1];
docident [bulletholettl] [Specifies how long (in milliseconds) to display bullet holes.];
docargument [V] [Bullethole display time] [min 0/max 30000/default 10000];
docident [colorbits] [Sets the bits per pixel value.];
docargument [] [bits per pixel] [min 0/max 32/default 0];
docident [curfont] [Returns a name of the current font.];
docargument [N] [name of font] [default, mono, serif min /max /default default];
docref [font];
@@ -3060,6 +3064,10 @@ docremark [-1 uses the default settings obtained from the system. 0 disables, 1.
docident [fullscreen] [Enables or disables fullscreen.];
docargument [] [fullscreen] [min 0/max 1/default 1];
docref [fullscreentoggle];
docref [fullscreendesktop];
docident [fullscreendesktop] [Enables using always desktop resolution in fullscreen mode.];
docargument [V] [Use desktop resolution for fullscreen] [min 0/max 1/default 1];
docref [fullscreen];
docident [fullscreentoggle] [Toggles fullscreen on or off.];
docref [fullscreen];
docident [gamma] [Sets the temporary (to next map start) hardware gamma value.];
@@ -3212,12 +3220,16 @@ docident [scr_h] [Sets the screen height.];
docargument [H] [the screen height] [min 200/max 10000/default 768];
docident [scr_w] [Sets the screen width.];
docargument [W] [the screen width] [min 320/max 10000/default 1024];
docident [screenh] [Returns the actual height of the screen/window.];
docargument [H] [the screen/window height] [ read-only];
docident [screenres] [Changes the screen resolution.];
docargument [W] [width] [] [0];
docargument [H] [height] [] [0];
docref [desktopw];
docref [desktoph];
docref [getdisplayresolutions];
docident [screenw] [Returns the actual width of the screen/window.];
docargument [W] [the screen/window width] [ read-only];
docident [setfont] [Changes the current font.];
docargument [N] [font name] [default, mono, serif] [0];
docref [font];
@@ -3318,6 +3330,7 @@ docident [enumsounds] [Lists sound index numbers and short descriptions for all
docargument [C] [list of sound categories (flags)] [PAIN, OWNPAIN, WEAPON, PICKUP, MOVEMENT, BULLET, OTHER, VOICECOM, TEAM, PUBLIC, FFA, FLAGONLY] [0];
docremark [All sounds with at least one of the flags will be listed. Flag names prefixed with "!" will exclude all matching sound from the list. If no such entities exist or the entity type could not be recognised, the list is empty.];
docexample [echo (enumsounds "VOICECOM !PUBLIC")] [It will list all voicecom sounds that are for teams only];
docexample [echo (enumsounds (listoptions soundcategories))] [It will list all sounds];
docref [sound];
docref [registersound];
docident [footsteps] [Indicates if the footsteps sound should be played.];
@@ -3352,20 +3365,21 @@ docident [musicvol] [Sets the music volume.];
docargument [N] [the volume] [min 0/max 255/default 128];
docref [soundvol];
docident [mutesound] [Mutes 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];
docargument [N] [ID of the sound to mute] [see 'enumsounds', starting at ID 0] [0];
docargument [A] [audible?] [(mute) 0 or 1 (unmute)] [0];
docref [soundmuted];
docref [unmuteallsounds];
docref [enumsounds];
docident [registermusic] [Registers a track as music.];
docargument [M] [music file] [] [0];
docremark [The first three tracks have special meaning: Track #1 is for "flag grab" the second and third are used as "last minute" tracks.];
docident [registersound] [Registers a sound.];
docargument [N] [sound name] [string, see config/sounds.cfg] [0];
docargument [N] [sound name] [path below packages/audio/, without file extension] [0];
docargument [V] [volume] [0..255] [0];
docargument [L] [loop] [0 (off), 1 (on)] [0];
docargument [R] [audible radius] [] [0];
docremark [This command returns the sound number, which is assigned from 0 onwards, and which can be used with "sound" command. If the sound was already registered, its existing index is returned. registersound does not actually load the sound, this is done on first play.];
docremark [See for example config/sounds.cfg.];
docremark [This command returns the sound number, which is assigned from 0 onwards, and which can be used with "sound" command. If the sound was already registered, its existing index is returned. "registersound" does not actually load the sound, this is done on first play.];
docexample [registersound "player/jump" 80] [It registers packages/audio/player/jump.ogg sound with volume 80];
docref [sound];
docident [sound] [Plays the specified sound.];
docargument [N] [number of the sound to play] [integer] [0];
@@ -3375,11 +3389,12 @@ docref [registersound];
docident [soundchannels] [Sets the desired amount of allocated sound channels.];
docargument [] [number of channels] [min 4/max 1024/default 128];
docremark [AC will try to allocate that number of channels but it is not guaranteed to succeed.];
docident [soundmuted] [Returns 1 if sound A is muted, else 0.];
docargument [A] [sound ID] [See /config/sounds.cfg for valid sound ID's.] [0];
docident [soundmuted] [Returns 1 if sound N is muted, else 0.];
docargument [N] [sound ID] [see 'enumsounds' for valid sound ID] [0];
docexample [mutesound 5; if (soundmuted 5) [echo Sound 5 is muted!] [echo Sound 5 is not muted!]] [Output: Sound 5 is muted!];
docref [mutesound];
docref [unmuteallsounds];
docref [enumsounds];
docident [soundscheddistancescore] [];
docargument [V] [] [min 0/max 1000/default 5];
docident [soundschedoldbonus] [];
@@ -3901,12 +3916,12 @@ docremark [You can get the current skymap name with the $loadsky variable.];
docexample [loadsky makke/mountain] [];
docexample [loadsky textures/skymaps/makke/mountain] [];
docident [mapmodel] [Registers a mapmodel that can be placed in maps.];
docargument [R] [The square radius of the bounding box.] [Integer] [0];
docargument [H] [The height of the bounding box.] [Integer] [0];
docargument [Z] [The initial height offset from the ground.] [Integer] [0];
docargument [R] [The square radius of the bounding box.] [integer] [0];
docargument [H] [The height of the bounding box.] [integer] [0];
docargument [Z] [The initial height offset from the ground.] [integer] [0];
docargument [0] [This integer is redundant. Leave it at zero so you don't break the command.] [0] [0];
docargument [N] [The name of the map model] [string] [0];
docargument [F] [If '1', the model is preloaded, even if no entities use it] [1 (optional)] [0];
docargument [F] [If '1', the model is preloaded, even if no entities use it] [1] [0];
docremark [A mapmodel registered with this command can be placed in a map using the 'newent mapmodel' command. The bounding box is an invisible force surrounding the model, allowing players to collide against it, instead of walking through the mapmodel. For more information about this command, read mapediting5.xml.];
docremark [Example: mapmodel 4 2 4 0 "modelname"];
docremark [This mapmodel has a bounding box of 8x8x2 in size (X/Y/Z) and by default hovers 4 units above ground.];
@@ -4015,7 +4030,7 @@ docremark [When specifying shadowyaw, remember that the default angle is 45 degr
docexample [shadowyaw 90] [];
docident [texture] [Binds a texture to the current texture slot.];
docargument [S] [Scale of the texture to load (should be a power of two).] [Float] [0];
docargument [F] [File name of the texture to bind] [String] [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.];
docremark [The texture is rendered at the given scale. At scale 1.0 (or if scale is 0), 32x32 texels cover one cube. At scale 2.0, which is the current maximum, it's 64x64.];
docremark [It also returns the number of the created slot, example: echo (texture ...)];