Script Plugin - Version 3.3 - Reference
Filename: plugin_blatt_script
Offline Manual
You are reading this offline manual for this plugin. The links to the right
navigate through the offline information. The links above and to the left
link to www.ravenousbugblatterbeast.pwp.blueyonder.co.uk.
If you downloaded the plugin from somewhere else, or downloaded it some time ago,
I recomend you check for an updated plugin. Note that the on-line manual may have been updated
even if the plugin hasn't.
Player Usage
- bbscript_list
- Displays the current script in the console and indicates the current line
Admin Usage
The following commands can be issued from the console by an admin with ACCESS_CONFIG.
- bbscript_report [ "on" | "off" ]
- If called with no arguments, displays the current configuration. If an argument is supplied,
it switches on/off the automatic display of the report after every other command is issued.
- bbscript_reset
- Changes all settings back to their default values as described on this page and restarts
the current script.
- bbscript_mode off
- Disables script processing. If a timer is in progress it will be cancelled.
- bbscript_mode on
- Enables script processing.
- If a script was in a "wait X rounds" when script processing was disabled, it
will continue to wait however many rounds were left remaining when processing
was disabled.
- If a script was in a "wait X seconds" or "wait X minutes" when script processing was
disabled, it will continue immediately from the next line.
- If script processing has not been enabled at all this game, the script starts at the beginning
- bbscript_list
- Displays the current script in the console and indicates the current line
- bbscript_load <filename>
- Executes the specified script. If the filename specified does not end in .script, this
is appended.
Script Names
If you want to automatically run a script whenever a game starts, place it in either your
addons\adminmod\config directory or your mod directory and name
the file default.script.
If you want to automatically run a different script for specific maps, place the script in your maps directory
and name it after the map - e.g. cs_assault.script
If you want to start scripts manually using the bbscript_load command, call them whatever you want
as long as it ends in .script. The scripts should be placed in your mod directory.
Script Syntax
Scripts can contain the following lines:
- wait [n] minutes
- Pauses the script execution for the specified number of minutes.
- wait [n] seconds
- Pauses the script execution for the specified number of seconds.
- wait [n] rounds
- Pauses the script until the specified number of rounds start. NOTE: Depending on the order of
Admin Mod loading the plugin and the first player joining, the very first round of a game may or may
not be detected. Also, this only works for game mods that support rounds - currently only counter-strike.
- quit
- Stops processing the script. If the script does not contain a quit, it is repeated from the
beginning after the last line is executed.
- //<whatever>
- Lines beginning with // are comments and are ignored.
- exec <command>
- Runs the specified command client-side on all connected clients.
- anything else
- Any other line is executed as if it were entered at the server console. This means you
can run Admin Mod commands by preceding them with admin_command.
NOTE: Scripts run with an access level of 65535. This means they cannot use functions that
require a level of 65536 - admin_execclient, admin_execall and admin_rcon.
Example Script
The following script turns disco mode on for 1 minute every 10 rounds:
wait 10 rounds
say "Disco mode for one minute"
admin_command admin_disco 1
wait 1 minute
admin_command admin_disco 0
|