This graph shows which files directly or indirectly include this file:

Macros
#define	BOT_EXEC_STATUS_IDLE 0
#define	BOT_EXEC_STATUS_PAUSED 1
#define	BOT_EXEC_STATUS_WAITING 2
#define	CMD_STATUS_ERROR 2
#define	CMD_STATUS_EXECUTING 0
#define	CMD_STATUS_FINISHED 1

Functions
void	bot_cmdhelp (string scmd)
float	bot_execute_commands (entity this)
bool	bot_ispaused (entity this)
void	bot_list_commands ()
void	bot_queuecommand (entity bot, string cmdstring)
void	bot_resetqueues ()
entity	find_bot_by_name (string name)
entity	find_bot_by_number (float number)
	float (entity) cmd_resetgoal
	float (entity, vector) cmd_moveto

Variables
float	bot_barrier
float	bot_barriertime
entity	bot_cmd
const int	BOT_CMD_AIM = 12
const int	BOT_CMD_AIMTARGET = 19
const int	BOT_CMD_BARRIER = 20
const int	BOT_CMD_CC = 7
const int	BOT_CMD_CONSOLE = 21
const int	BOT_CMD_CONTINUE = 2
const int	BOT_CMD_COUNTER = 24
entity	bot_cmd_current
const int	BOT_CMD_DEBUG_ASSERT_CANFIRE = 23
const int	BOT_CMD_ELSE = 9
float	bot_cmd_execution_index
const int	BOT_CMD_FI = 10
const int	BOT_CMD_IF = 8
const int	BOT_CMD_IMPULSE = 16
float	bot_cmd_index
const int	BOT_CMD_MOVETO = 5
const int	BOT_CMD_MOVETOTARGET = 18
const int	BOT_CMD_NULL = 0
const int	BOT_CMD_PARAMETER_FLOAT = 1
const int	BOT_CMD_PARAMETER_NONE = 0
const int	BOT_CMD_PARAMETER_STRING = 2
const int	BOT_CMD_PARAMETER_VECTOR = 3
float	bot_cmd_parm_float
string	bot_cmd_parm_string
int	bot_cmd_parm_type [BOT_CMD_COUNTER]
vector	bot_cmd_parm_vector
const int	BOT_CMD_PAUSE = 1
const int	BOT_CMD_PRESSKEY = 13
const int	BOT_CMD_RELEASEKEY = 14
const int	BOT_CMD_RESETAIM = 11
const int	BOT_CMD_RESETGOAL = 6
const int	BOT_CMD_SELECTWEAPON = 15
const int	BOT_CMD_SOUND = 22
string	bot_cmd_string [BOT_CMD_COUNTER]
const int	BOT_CMD_TURN = 4
int	bot_cmd_type
const int	BOT_CMD_WAIT = 3
const int	BOT_CMD_WAIT_UNTIL = 17
float	bot_cmds_initialized

Macro Definition Documentation

◆ BOT_EXEC_STATUS_IDLE

#define BOT_EXEC_STATUS_IDLE 0

Definition at line 3 of file scripting.qh.

◆ BOT_EXEC_STATUS_PAUSED

#define BOT_EXEC_STATUS_PAUSED 1

Definition at line 4 of file scripting.qh.

Referenced by bot_cmd_continue(), bot_cmd_pause(), bot_execute_commands_once(), and bot_ispaused().

◆ BOT_EXEC_STATUS_WAITING

#define BOT_EXEC_STATUS_WAITING 2

Definition at line 5 of file scripting.qh.

Referenced by bot_cmd_wait(), and bot_cmd_wait_until().

◆ CMD_STATUS_ERROR

#define CMD_STATUS_ERROR 2

Definition at line 9 of file scripting.qh.

Referenced by bot_cmd_aim(), bot_cmd_aimtarget(), bot_cmd_if(), bot_cmd_movetotarget(), bot_cmd_select_weapon(), bot_execute_commands_once(), and havocbot_moveto().

◆ CMD_STATUS_EXECUTING

#define CMD_STATUS_EXECUTING 0

Definition at line 7 of file scripting.qh.

Referenced by bot_cmd_aim(), bot_cmd_aimtarget(), bot_cmd_wait(), bot_cmd_wait_until(), bot_execute_commands_once(), and havocbot_moveto().

◆ CMD_STATUS_FINISHED

#define CMD_STATUS_FINISHED 1

Function Documentation

◆ bot_cmdhelp()

void bot_cmdhelp ( string scmd )

Definition at line 331 of file scripting.qc.

{
    int i, ntype;
    string stype;
 
    if(!bot_cmds_initialized)
        bot_commands_init();
 
    for(i=1;i<BOT_CMD_COUNTER;++i)
    {
        if(bot_cmd_string[i]!=scmd)
            continue;
 
        ntype = bot_cmd_parm_type[i];
 
        switch(ntype)
        {
            case BOT_CMD_PARAMETER_FLOAT:
                stype = "float";
                break;
            case BOT_CMD_PARAMETER_STRING:
                stype = "string";
                break;
            case BOT_CMD_PARAMETER_VECTOR:
                stype = "vector";
                break;
            default:
                stype = "none";
                break;
        }
 
        string desc = "";
        switch(i)
        {
            case BOT_CMD_PAUSE:
                desc = "Stops the bot completely. Any command other than 'continue' will be ignored.";
                break;
            case BOT_CMD_CONTINUE:
                desc = "Disable paused status";
                break;
            case BOT_CMD_WAIT:
                desc = "Pause command parsing and bot ai for N seconds. Pressed key will remain pressed";
                break;
            case BOT_CMD_WAIT_UNTIL:
                desc = "Pause command parsing and bot ai until time is N from the last barrier. Pressed key will remain pressed";
                break;
            case BOT_CMD_BARRIER:
                desc = "Waits till all bots that have a command queue reach this command. Pressed key will remain pressed";
                break;
            case BOT_CMD_TURN:
                desc = "Look to the right or left N degrees. For turning to the left use positive numbers.";
                break;
            case BOT_CMD_MOVETO:
                desc = "Walk to an specific coordinate on the map. Usage: moveto \'x y z\'";
                break;
            case BOT_CMD_MOVETOTARGET:
                desc = "Walk to the specific target on the map";
                break;
            case BOT_CMD_RESETGOAL:
                desc = "Resets the goal stack";
                break;
            case BOT_CMD_CC:
                desc = "Execute client command. Examples: cc say something; cc god; cc name newnickname; cc kill;";
                break;
            case BOT_CMD_IF:
                desc = "Perform simple conditional execution.\n"
                    "Syntax: \n"
                    "        sv_cmd .. if \"condition\"\n"
                    "        sv_cmd ..  <instruction if true>\n"
                    "        sv_cmd ..  <instruction if true>\n"
                    "        sv_cmd .. else\n"
                    "        sv_cmd ..  <instruction if false>\n"
                    "        sv_cmd ..  <instruction if false>\n"
                    "        sv_cmd .. fi\n"
                    "Conditions: a=b, a>b, a<b, a\t\t(spaces not allowed)\n"
                    "            Values in conditions can be numbers, cvars in the form cvar.cvar_string or special fields\n"
                    "Fields: health, speed, flagcarrier\n"
                    "Examples: if health>50; if health>cvar.g_balance_laser_primary_damage; if flagcarrier;";
                break;
            case BOT_CMD_RESETAIM:
                desc = "Points the aim to the coordinates x,y 0,0";
                break;
            case BOT_CMD_AIM:
                desc = "Move the aim x/y (horizontal/vertical) degrees relatives to the bot\n"
                    "There is a 3rd optional parameter telling in how many seconds the aim has to reach the new position\n"
                    "Examples: aim \"90 0\" // Turn 90 degrees inmediately (positive numbers move to the left/up)\n"
                    "          aim \"0 90 2\"   // Will gradually look to the sky in the next two seconds";
                break;
            case BOT_CMD_AIMTARGET:
                desc = "Points the aim to given target";
                break;
            case BOT_CMD_PRESSKEY:
                desc = "Press one of the following keys: forward, backward, left, right, jump, crouch, attack1, attack2, use"
                    "Multiple keys can be pressed at time (with many presskey calls) and it will remain pressed until the command \"releasekey\" is called"
                    "Note: The script will not return the control to the bot ai until all keys are released";
                break;
            case BOT_CMD_RELEASEKEY:
                desc = "Release previoulsy used keys. Use the parameter \"all\" to release all keys";
                break;
            case BOT_CMD_SOUND:
                desc = "play sound file at bot location";
                break;
            case BOT_CMD_DEBUG_ASSERT_CANFIRE:
                desc = "verify the state of the weapon entity";
                break;
            default:
                desc = "This command has no description yet.";
                break;
        }
        LOG_HELP("Command: ", bot_cmd_string[i], "\nParameter: <", stype, ">", "\nDescription: ", desc);
    }
}

◆ bot_execute_commands()

float bot_execute_commands ( entity this )

Definition at line 1350 of file scripting.qc.

{
    int f;
    do
    {
        f = bot_execute_commands_once(this);
    }
    while(f < 0);
    return f;
}

References bot_execute_commands_once(), and entity().

Referenced by havocbot_ai().

◆ bot_ispaused()

bool bot_ispaused ( entity this )

Definition at line 1003 of file scripting.qc.

{
    return(this.bot_exec_status & BOT_EXEC_STATUS_PAUSED);
}

References bot_exec_status, BOT_EXEC_STATUS_PAUSED, and entity().

Referenced by bot_relinkplayerlist(), and havocbot_ai().

◆ bot_list_commands()

void bot_list_commands ( )

Definition at line 444 of file scripting.qc.

{
    int i;
    string ptype;
 
    if(!bot_cmds_initialized)
        bot_commands_init();
 
    LOG_HELP("Bot commands:");
 
    for(i=1;i<BOT_CMD_COUNTER;++i)
    {
        switch(bot_cmd_parm_type[i])
        {
            case BOT_CMD_PARAMETER_FLOAT:
                ptype = "float";
                break;
            case BOT_CMD_PARAMETER_STRING:
                ptype = "string";
                break;
            case BOT_CMD_PARAMETER_VECTOR:
                ptype = "vector";
                break;
            default:
                ptype = "none";
                break;
        }
        if (ptype != "none")
            LOG_HELP("  ^2", bot_cmd_string[i]," ^7<", ptype, ">");
        else
            LOG_HELP("  ^2", bot_cmd_string[i]);
    }
    LOG_HELP("For help about a specific command, type bot_cmd help <command>");
}

◆ bot_queuecommand()

void bot_queuecommand	(	entity	bot,
		string	cmdstring )

Definition at line 30 of file scripting.qc.

{
    if(!bot.bot_cmdqueuebuf_allocated)
    {
        bot.bot_cmdqueuebuf = buf_create();
        bot.bot_cmdqueuebuf_allocated = true;
        bot.bot_cmdqueuebuf_start = 0;
        bot.bot_cmdqueuebuf_end = 0;
    }
 
    bufstr_set(bot.bot_cmdqueuebuf, bot.bot_cmdqueuebuf_end, cmdstring);
 
    // if the command was a "sound" command, precache the sound NOW
    // this prevents lagging!
    {
        float sp;
        string parm;
        string cmdstr;
 
        sp = strstrofs(cmdstring, " ", 0);
        if(sp >= 0)
        {
            parm = substring(cmdstring, sp + 1, -1);
            cmdstr = substring(cmdstring, 0, sp);
            if(cmdstr == "sound")
            {
                // find the LAST word
                for (;;)
                {
                    sp = strstrofs(parm, " ", 0);
                    if(sp < 0)
                        break;
                    parm = substring(parm, sp + 1, -1);
                }
                precache_sound(parm);
            }
        }
    }
 
    bot.bot_cmdqueuebuf_end += 1;
}

◆ bot_resetqueues()

void bot_resetqueues ( )

Definition at line 1165 of file scripting.qc.

{
    FOREACH_CLIENT(it.isbot, {
        it.bot_cmd_execution_index = 0;
        bot_clearqueue(it);
        // also, cancel all barriers
        it.bot_barrier = 0;
        for(int i = 0; i < it.bot_places_count; ++i)
        {
            strfree(it.(bot_placenames[i]));
        }
        it.bot_places_count = 0;
    });
 
    bot_barriertime = time;
}

◆ find_bot_by_name()

entity find_bot_by_name ( string name )

Definition at line 235 of file scripting.qc.

{
    FOREACH_CLIENT(IS_BOT_CLIENT(it) && it.netname == name,
    {
        return it;
    });
 
    return NULL;
}

◆ find_bot_by_number()

entity find_bot_by_number ( float number )

Definition at line 246 of file scripting.qc.

{
    entity bot;
    float c = 0;
 
    if(!number)
        return NULL;
 
    bot = findchainflags(flags, FL_CLIENT); // TODO: doesn't findchainflags loop backwards through entities?
    while (bot)
    {
        if(IS_BOT_CLIENT(bot))
        {
            if(++c==number)
                return bot;
        }
        bot = bot.chain;
    }
 
    return NULL;
}