Omni-bot Command Reference
From Omni-bot Wiki
| Main Page | Omni-bot Command Reference |
Console Commands
Omni-bot comes with a wide range of utilities in the form of console commands for general purpose useage as well as debugging tools for waypointing.
Executing a command
- In ET, ETF, or other Quake 3 engine based games - /bot <command>
- In Quake4, Fortress Forever, and other Half-life 2 or Doom 3 engine based games, the / isn't required
addbot
Adds a bot to the game.
syntax: bot addbot <team> <class> <name> example: /bot addbot 2 1 bob will add a soldier named bob to the allied team in ET
balanceteams
Forces bots to keep teams balanced.
syntax: bot balanceteams 1/0 example: bot balanceteams 1 turns on bot balancing notes: by default, omni-bot will keep teams balanced when adding bots unless bots are added specifically to a team
debugbot
Enables debugging output on a specific bot.
syntax: bot debugbot botname debugtype example: bot debugbot all goals will give debug output for all connected bots goals debug types: log, move, aim, goals, sensory, brain, weapon, script, events, fpinfo
debugtriggers
Prints triggers to console.
syntax: bot debugtriggers
usage: used for checking or identifying trigger names to be used with map scripting. when turned on, you will see
messages about events as they occur in the map:
<+++> Trigger: TagName: The Tank has been repaired! Action: announce Entity: 0x7016dd8c Activator: 0
<+++> means that a callback (trigger) is set up and has been called, while <---> means no callback is associated
TagName is the string to use for the OnTrigger function in the map script
Action is the category in which the event is recognized
notes: this is a toggle. issuing the command a second time will turn it off.
dontmove
Enables/disables all bot movement ability.
syntax: bot dontmove true/false/1/0/yes/no example: bot dontmove 1 will stop all bots from moving.
dontshoot
Enables/disables all bot shooting ability.
syntax: bot dontshoot true/false/1/0/yes/no example: bot dontshoot 1 will stop all bots from shooting.
draw_goals
Draws debug information for all mapgoals.
syntax: bot draw_goals on/off goalname
example: bot draw_goals on will draw squares around all objective goals and highlight the radius of attack / defend goals
notes: the goalname parameter is optional and supports expressions. i.e. bot draw_goals on ATTACK.* will highlight all of
the attack goals in the map.
drawblocktests
Enables drawing of blockable line tests.
syntax: bot drawblocktests 1/0 example: bot drawblocktests 1 turns on drawing of block tests useage: will draw block test lines in addition to the ones drawn in waypoint mode.
drawthreats
Enables drawing of detected threats.
syntax: bot drawthreats 1/0 example: bot drawthreats 1 turns on drawing of threats useage: when enabled, potential threats are outlined (i.e. player entities)
help
List all bot commands available in console.
syntax: bot help
kickall
Kick all bots from the game by name.
syntax: bot kickall
kickbot
Removes a bot from the game.
syntax: bot kickbot <botname> example: bot kickbot [BOT]Aimless
maxbots
The maximum players to keep in play.
syntax: bot maxbots # example: bot maxbots 20
minbots
The minimum players to keep in play.
syntax: bot minbots # example: bot minbots 2
nav_logfailedpath
Saves info about failed path attempts for debugging.
nav_showfailedpath
Render a failed path by its index.
navsystem
Creates a navigation system of a specified type.
reload_weapons
Reloads the weapon database from script files on disc.
revision
Shows the revision the bot dll was built from.
syntax: bot revision
script_collect
Performs a garbage collection.
syntax: bot script_collect usage: for debugging use only
script_debug
Enables/disables debug messages in the scripting system.
syntax: bot script_debug 1/0/on/off example: bot script_debug 1 turns on debugging information in the script system. usage: when enabled, if an error occurs in script execution, it will be printed to the console.
script_run
Executes a string as a script snippet.
syntax: bot script_run <string> example: bot script_run "print(GetGameTimeLeft())"
script_runfile
Executes a specified script file.
syntax: bot script_runfile <filename> example: bot script_runfile testing.gm
script_stats
Shows scripting system memory usage/stats.
syntax: bot script_stats usage: displays memory use and garbage collection stats in console
show_bb
Shows the contents of the global blackboard.
syntax: bot show_bb
show_goals
Prints out the names of each goal.
syntax: bot show_goals <optional> <optional p> example: bot show_goals DEFEND.* will list all defend goals in console example: bot show_goals .* p will list all goals and their sub priorities (for >= 0.7) notes: this command supports expressions for the optional parameter
Explanation of goal-list-entry by example:
33: FLAG_the_War_Documents -> 0000 serial 3 priority 0.55
ALLIES AXIS SOLDIER MEDIC ENGINEER LIEUTENANT 1.80
<goal-no>: <goal-name> -> <team-availability> serial <serial> bias <bias>
goal-no: number of goal
goal-name: name of goal
team-availability: availability team1 team2 team3 team4
serial: serial
bias: current bias value
The optional p parameter displays properties set with the SetGoalPriority function which
enables Team and Class properties to be set.
notes: team-availability shows boolean value for each team
team3 and team4 are obsoleted in ET, since ET only has 2 teams:
TEAM.AXIS and TEAM.ALLIES or TEAM.TEAM1 and TEAM.TEAM2.
showprocesses
Shows a process by its name.
syntax: bot showprocesses usage: for debug use only
stopprocess
Stops a process by its name.
syntax: bot stopprocess usage: for debug use only
update_all_nav
Attempts to download all nav files from the database, including updating existing files.
syntax: bot update_all_nav notes: Be sure to have copies of all custom waypoints and scripts that you may be working on!
update_nav
Checks the remote waypoint database for updated navigation.
syntax: bot update_nav notes: Be sure to have copies of all custom waypoints and scripts that you may be working on!
version
Prints out the bot version number.
syntax: bot version