View source for User:Gazyi/CS:GO Bot Behavior Trees

{{stub}}
{{update}}
{{back|Counter-Strike: Global Offensive Level Creation}}
In {{Counter-Strike: Global Offensive|4}}, [[bot]]s can be given a '''Behavior Tree''' to follow. A behavior tree dictates how the bot senses things (vision, hearing, damage sensing), moves, attacks, and does other actions.

They use [[Valve|Valve's]] proprietary [[Dota 2 Workshop Tools/KeyValues3|KeyValues3]] format (<code>.kv3</code>), which is a text-based format with somewhat strict syntax. They typically use the <code>bt_</code> prefix, to signify that file is a ''Behavior Tree''. They are stored in <code>csgo/scripts/ai</code>. One can create and use his own behavior trees, see below.

Officially, behavior trees are used for the game modes [[File:Csgo icon coopstrike.png|16px|link=]] [[Creating a Co-op Strike Map|Co-op Strike]], [[File:Csgo icon guardian.png|16px|link=]] [[Creating a Guardian Scenario Map|Guardian]] and [[File:Csgo icon deathmatch.png|16px|link=]] [[CS:GO Gamemodes: Deathmatch|Deathmatch]].

Behavior trees were first [https://blog.counter-strike.net/index.php/2019/09/25510/ added to the game] on September 16, 2019. Since September 1, 2020, [https://blog.counter-strike.net/index.php/2020/09/31532/ behavior trees can be packed into BSP files].

== Using a Behavior Tree ==
The [[ConVar]] <code>'''mp_bot_ai_bt'''</code> can assign a behavior tree to all bots on the server. Its value is a string representing the path to a .kv3 file, starting from <code>csgo/</code>. For example, the following line is used for official Deathmatch and can be found in <code>csgo/cfg/gamemode_deathmatch.cfg</code>:
<pre>mp_bot_ai_bt "scripts/ai/deathmatch/bt_default.kv3"</pre>

For the Co-op game mode, {{ent|info_enemy_terrorist_spawn}} entities have the KeyValue <code>behavior_tree_file</code> that can be used to specify a behavior tree only for bots spawning at this entity.

== Related Console Commands ==
{| class=standard-table
! ConVar !! Default Value !! Description
|-
| <code>cv_bot_ai_bt_debug_target</code>
| -1
| Draw the behavior tree of the given bot.
|-
| <code>cv_bot_ai_bt_hiding_spot_show</code>
| 0
| Draw hiding spots.
|-
| <code>cv_bot_ai_bt_moveto_show_next_hiding_spot</code>
| 0
| Draw the hiding spot the bot will check next.
|-
| <code>mp_bot_ai_bt</code>
| ""
| Use the specified behavior tree file to drive the bot behavior.
|-
| <code>mp_bot_ai_bt_clear_cache</code>
| ''ConCommand''
| Clears the cache for behavior tree files.
|}

== Format ==
The first line of a <code>.kv3</code> file is always a header specifying the KV3 version. For CS:GO, use this header:
<source lang="javascript">
<!-- kv3 encoding:text:version{e21c7f3c-8a33-41c5-9977-a76d3a32aa0d} format:generic:version{7412167c-06e9-4698-aff2-e63eb59037e7} -->
</source>
Now define general bot configuration. Use "config" key, which should contain full path to that file, including file extension:
<source lang="javascript">
<!-- kv3 encoding:text:version{e21c7f3c-8a33-41c5-9977-a76d3a32aa0d} format:generic:version{7412167c-06e9-4698-aff2-e63eb59037e7} -->
{
	config = "scripts/ai/<path to bt_config>/<bt_config_name>.kv3"
}
</source>
Behavior trees always start with root. Define it with "root" key. Every behavior node should be inside it.
<source lang="javascript">
<!-- kv3 encoding:text:version{e21c7f3c-8a33-41c5-9977-a76d3a32aa0d} format:generic:version{7412167c-06e9-4698-aff2-e63eb59037e7} -->
{
	config = "scripts/ai/<path to bt_config>/<bt_config_name>.kv3"
	root = 
	{
		<Behavior Node>
	}
}
</source>
Behavior Node format depends on its type and parameters:
<source lang="javascript">
<!-- kv3 encoding:text:version{e21c7f3c-8a33-41c5-9977-a76d3a32aa0d} format:generic:version{7412167c-06e9-4698-aff2-e63eb59037e7} -->
{
	config = "scripts/ai/<path to bt_config>/<bt_config_name>.kv3"
	root = 
	{
		type = <Node Type>
		<parameter> = <value>
		...
		child = 
		{
			<Behavior Node>
		}
	}
}
</source>
Some nodes allows to define new global variables. Their input name should contain both double and single quotes:
<source lang="javascript">
type = "action_set_global_counter"
input_name = "'Test'" // Note those quotation marks.
input_value = 1
</source>

== Configuration ==
{{Todo|
* Explain parameters in bt_config }}
These parameters define general bot reaction and combat behavior for every bot skill ( ''low, fair, normal, tough, hard, very_hard, expert, default'' ), like a botprofile.db.

Default format is:
<source lang="javascript">
<!-- kv3 encoding:text:version{e21c7f3c-8a33-41c5-9977-a76d3a32aa0d} format:generic:version{7412167c-06e9-4698-aff2-e63eb59037e7} -->
{
	<skill level>
	{
		<Variables from table below>
		attack = <Attack table>
	}
}</source>

=== List of parameters ===

{| class="standard-table" style="width: 100%;"
! Variable
!Description
|-
| <code>aim_target_acquisition_lerp_time</code>
| 
|-
| <code>aim_target_acquisition_lerp_time_deviation</code>
| 
|-
| <code>aim_target_acquisition_angle_penalty</code>
| 
|-
| <code>aim_target_acquisition_angle_penalty_deviation</code>
| 
|-
| <code>aim_target_acquisition_angle_penalty_reduction_ratio</code>
| 
|-
| <code>aim_target_acquisition_angle_tolerance</code>
| 
|-
| <code>aim_target_acquisition_angle_lerp_bias</code>
| 
|-
| <code>aim_target_tracking_lerp_time</code>
| 
|-
| <code>aim_target_tracking_lerp_time_deviation</code>
| 
|-
| <code>aim_target_tracking_focus_interval</code>
| 
|-
| <code>aim_target_tracking_focus_interval_deviation</code>
| 
|-
| <code>aim_target_tracking_angle_lerp_bias</code>
| 
|-
| <code>aim_new_target_angle_tolerance</code>
| 
|-
| <code>aim_max_duration</code>
| 
|-
| <code>aim_max_duration_deviation</code>
| 
|-
| <code>aim_punch_angle_reaction_chance</code>
| 
|-
| <code>look_around_awareness_yaw_range</code>
| Max angle to horizontal rotate viewcamera from this viewpoint.
|-
| <code>look_around_awareness_pitch_range</code>
| Max angle to vertical rotate viewcamera from this viewpoint.
|-
| <code>look_around_focus_interval</code>
| Delay between next viewcamera rotation.
|-
| <code>look_around_focus_interval_deviation</code>
| 
|-
| <code>look_around_lerp_time</code>
| Time to rotate viewcamera to next position.
|-
| <code>look_around_lerp_time_deviation</code>
| 
|-
| <code>look_around_lerp_bias</code>
| Smooths viewcamera movement.
|-
| <code>reaction_time</code>
| Delay before reaction on event.
|-
| <code>combat_crouch_chance</code>
| 
|-
| <code>combat_dodge_command_duration</code>
| 
|-
| <code>combat_dodge_command_duration_deviation</code>
| 
|}

=== Attack Table ===

Attack table defines handling of different weapon types.

Example:

<source lang="javascript">
attack =
[
	// duration, duration deviation, cadence, cooldown, cooldown deviation

	// KNIFE						PISTOL							SUBMACHINEGUN
	[ -1.0, -1.0, -1.0, -1.0, -1.0 ],[ 0.95, 0.25, 0.5, 0.15, 0.05 ],[ 0.42, 0.07, 0.0, 0.15, 0.05 ],
	// RIFLE						SHOTGUN							SNIPER_RIFLE
	[ 0.22, 0.07, 0.0, 0.45, 0.15 ],[ 0.3, 0.0, 0.0, 0.95, 0.25 ],[ 0.22, 0.07, 0.0, 2.0, 0.0 ],
	// MACHINEGUN					C4								TASER
	[ 0.75, 0.15, 0.0, 0.3, 0.1 ],[ -1.0, -1.0, -1.0, -1.0, -1.0 ],	[ -1.0, -1.0, -1.0, -1.0, -1.0 ],
	// GRENADE						EQUIPMENT						STACKABLEITEM
	[ -1.0, -1.0, -1.0, -1.0, -1.0 ],[ -1.0, -1.0, -1.0, -1.0, -1.0 ],[ -1.0, -1.0, -1.0, -1.0, -1.0 ],
	// FISTS						BREACHCHARGE					BUMPMINE
	[ -1.0, -1.0, -1.0, -1.0, -1.0 ],[ -1.0, -1.0, -1.0, -1.0, -1.0 ],[ -1.0, -1.0, -1.0, -1.0, -1.0 ],
	// TABLET						MELEE							SHIELD
	[ -1.0, -1.0, -1.0, -1.0, -1.0 ],[ -1.0, -1.0, -1.0, -1.0, -1.0 ],[ -1.0, -1.0, -1.0, -1.0, -1.0 ],
	// WEAPONTYPE_ZONE_REPULSOR		UNKNOWN
	[ -1.0, -1.0, -1.0, -1.0, -1.0 ],[ -1.0, -1.0, -1.0, -1.0, -1.0 ]
]
</source>

== Nodes ==
This is a list of all nodes on November 9, 2021.

{{Todo|
* Complete node parameters and descriptions, check for inaccuracies.
* Define variable types for parameters.
* Explain all parameters. }}

=== Combinators ===

{| class="standard-table" style="width: 100%;"
! Type
! Parameters
! Description
|-
| <code>parallel</code>
| 
| Executes all child functions in one script tick.
|-
| <code>selector</code>
| 
| Executes child functions as sequence until meeting child with true condition.
|-
| <code>sequencer</code>
| 
| Executes child functions as sequence until meeting child with false condition.
|-
| <code>subtree</code>
| <code>string file, string name</code>
| Executes behavior tree from file.
|}

=== Decorators ===

{| class="standard-table" style="width: 100%;"
! Type
! Parameters
!width=30% |Description
|-
| <code>decorator_bot_service</code>
| <code>array memory_to_expire(variable? domain (GroupID or AllBots), flag key (ShortTermAttackMemory, ShortTermDamageMemory, ShortTermAreaDamageMemory, ShortTermInvestigateMemory, LongTermMemory, DamageThroughSmokeMemory, Threats), int time, int distance), array tagged_entities_to_expire, int_flag? basic_chatter_enable, vector? input_chatter_enemies, int chatter_outnumbered_threshold</code>
| Kinda main bot behavior function? Usually contains all subtree routines.
|-
| <code>decorator_buy_service</code>
| <code>array output</code>
| Returns array of items that bot will buy, then executes function.
|-
| <code>decorator_dec_global_counter</code>
| <code>variable input_name</code>
| Decreases input variable by 1, then executes function?
|-
| <code>decorator_find_utility_strat</code>
| <code>vector input_location, int distance_threshold, vector output_location, vector output_angles, string output_weapon</code>
| Unused.
|-
| <code>decorator_game_event</code>
| 
| {{Warning|Release Notes for 21/10/2021 say about it but it doesn't exist in code?}}
|-
| <code>decorator_hiding_spot_service</code>
| <code>variable? domain (GroupID or AllBots), vector output_hiding_spot, int distance_threshold, int expiration_time</code>
| Returns hiding spot, then executes function? Usually located right after script root.
|-
| <code>decorator_invert</code>
| 
| Unused. Valve scripts usually use <code>negated = 1</code> flag in node parameters.
|-
| <code>decorator_maybe</code>
| <code>float chance</code>
| Executes child functions with specified chance (1 - 100%, 0.7 - 70% etc).
|-
| <code>decorator_memory</code>
| <code>vector? input, memory? output, string output_domain</code>
| Saves input in specified memory buffer?
|-
| <code>decorator_need_healing</code>
| <code>int health_threshold</code>
| Executes child functions if bot health is lower that input threshold.
|-
| <code>decorator_picker_blocked_by_smoke</code>
| <code>vector? input, int distance_threshold</code>
| Executes child functions if input position is behind smoke volume?
|-
| <code>decorator_picker_dedup</code>
| <code>vector? input, memory? against, int distance_threshold</code>
| ??? Only used in noise picker in Valve scripts.
|-
| <code>decorator_picker_grenade_type</code>
| <code>array input, array types (EXPLOSIVE, FLASH, FIRE, DECOY, SMOKE, SENSOR, SNOWBALL)</code>
| Executes child functions on specified grenade types.
|-
| <code>decorator_picker_max_score</code>
| <code>array input</code>
| ???
|-
| <code>decorator_picker_nearby</code>
| <code>array input, int cutoff_distance</code>
| Executes child functions if input entities are within distance.
|-
| <code>decorator_picker_random_by_distance</code>
| <code>array input, int distance_min, int distance_max</code>
| Executes child functions if random entity from input is within distance limits?
|-
| <code>decorator_picker_reaction_time</code>
| <code>variable? input_domain (GroupID or AllBots), memory? input, vector? output</code>
| Executes child functions after delay, that depends of bot skill reaction time?
|-
| <code>decorator_picker_visible</code>
| <code>array input, int_flag? check_fov</code>
| Executes function if input entity in LOS?
|-
| <code>decorator_picker_weight_as_distance</code>
| <code>array input</code>
| ??? Only used in noise picker in Valve scripts.
|-
| <code>decorator_random_approach_point</code>
| <code>vector output</code>
| Returns a random point in navmesh.
|-
| <code>decorator_random_int</code>
| <code>int min, int max, int output</code>
| Returns a random int the range of min to max.
|-
| <code>decorator_ranker_dist</code>
| <code>array input</code>
| Sorts entities depending on distance?
|-
| <code>decorator_remove</code>
| <code>variable? input_domain (GroupID or AllBots), memory? input, array? remove</code>
| Removes selected entities from input memory.
|-
| <code>decorator_remove_key</code>
| <code>variable? input</code>
| Removes input variable from script scope.
|-
| <code>decorator_repeat</code>
| 
| Executes child functions in loop.
|-
| <code>decorator_route_service</code>
| <code>array config (array routes, array strategies), vector? output_waypoint, string output_waypoint_name, string output_domain</code>
| Unused.
|-
| <code>decorator_run_once</code>
| <code>int max_attempts = 1</code>
| Executes child functions limited amount of times?
|-
| <code>decorator_sensor</code>
| <code>flag entity_type_filter (ALL, PLAYERS, HUMAN_PLAYERS, NOISE, DAMAGE, AREA_DAMAGE, CLASSNAME, GRENADE), function? shape(flag type (sensor_shape_fov, sensor_shape_sphere), int radius), flag team_filter (ANY, CT, TERRORIST, SAME, OPPOSITE, ENEMY), int_flag orphan_only, int_flag priority, string class_name, vector? output</code>
| Returns entity detected by sensor and executes child functions.
|-
| <code>decorator_set_barrier</code>
| 
| Unused.
|-
| <code>decorator_set_reaction_time</code>
| <code>array? input</code>
| Executes child functions on input after delay, that depends of bot skill reaction time?
|-
| <code>decorator_succeed</code>
| 
| Executes child functions if previous decorator is succeed?
|-
| <code>decorator_tag_entity</code>
| <code>vector? input, array? output, flag operation_type (BT_DECORATOR_TAG_ENTITY_CLEAR, BT_DECORATOR_TAG_ENTITY_SET), int expiration_time</code>
| ??? Used in picking target tree in Valve scripts.
|-
| <code>decorator_tag_threshold</code>
| <code>vector? entity_input, vector? tagged_entities_input, int amount, flag check_type (BT_DECORATOR_TAG_THRESHOLD_AT_MOST, BT_DECORATOR_TAG_THRESHOLD_AT_LEAST)</code>
| ??? Used to determine if it's safe to do objective in Valve scripts?
|-
| <code>decorator_token_service</code>
| <code>variable? domain, string output_token_name, string output_token_domain, function config(array tokens, array assignments)</code>
| In [[Creating a Guardian Scenario Map|Guardian]] Mode: defines bot GroupID, then executes child functions.
|-
| <code>decorator_try_lock</code>
| <code>variable? domain</code>
| Checks if other bot is already doing same function???
|-
| <code>decorator_wait_success</code>
| <code>int timeout</code>
| Executres child functions after delay?
|-
| <code>decorator_wait_success</code>
| <code>int timeout</code>
| Executres child functions after delay?
|}

=== Conditions ===

{| class="standard-table" style="width: 100%;"
! Type
! Parameters
! Description
|-
| <code>condition_barrier</code>
| 
| Unused.
|-
| <code>condition_distance_less</code>
| <code>vector input, int distance_threshold_min, int distance_threshold_max</code>
| Returns true, if distance to input position is less than distance_threshold?
|-
| <code>condition_has_parachute</code>
| 
| Returns true, if bot has parachute in inventory.
|-
| <code>condition_inactive</code>
| <code>array input(memory? key), int round_start_threshold_seconds, int sensor_inactivity_threshold_seconds</code>
| Returns true, if bot doesn't have any memory and sensor input within timing.
|-
| <code>condition_is_airborne</code>
| 
| Returns true, if bot is mid-air.
|-
| <code>condition_is_at_bomb_site</code>
| 
| Returns true, if bot is at bombsite zone.
|-
| <code>condition_is_empty</code>
| <code>int_flag? global, any input</code>
| Returns true, if input variable is empty or doesn't exist.
|-
| <code>condition_is_equal</code>
| <code>any source, any destination</code>
| Returns true, if source variable is equal to "destination" input.
|-
| <code>condition_is_greater</code>
| <code>any source, any destination</code>
| Unused. Returns true, if source variable is greater than "destination" input.
|-
| <code>condition_is_greater_equal</code>
| <code>any source, any destination</code>
| Unused. Returns true, if source variable is equal or greater than "destination" input.
|-
| <code>condition_is_inv_slot_empty</code>
| <code>flag slot (KNIFE, PISTOL, RIFLE, GRENADES)</code>
| Returns true, if input equipment slot is empty.
|-
| <code>condition_is_less</code>
| <code>any source, any destination</code>
| Unused. Returns true, if source variable is less than "destination" input.
|-
| <code>condition_is_less_equal</code>
| <code>any source, any destination</code>
| Unused. Returns true, if source variable is equal or less than "destination" input.
|-
| <code>condition_is_reloading</code>
| 
| Unused. Returns true, if active weapon is in reloading state.
|-
| <code>condition_is_weapon_equipped</code>
| <code>string weapon</code>
| Returns true, if bot has active weapon with input classname.
|-
| <code>condition_is_weapon_suitable</code>
| <code>string weapon</code>
| Unused.
|-
| <code>condition_out_of_ammo</code>
| 
| Returns true, if active weapon is out of ammo.
|-
| <code>condition_owns_item</code>
| <code>string weapon</code>
| Returns true, if bot has item with input classname.
|}

=== Actions ===

{| class="standard-table" style="width: 100%;"
! Type
! Parameters
!width=30% |Description
|-
| <code>action_acquire_items</code>
| <code>array items, int_flag? remove_all_items</code>
| Equips bot with items from array.
|-
| <code>action_aim</code>
| <code>vector input, int_flag? acquire_only, flag? ready</code>
| Rotates bot towards input point?
|-
| <code>action_aim_projectile</code>
| <code>vector input, vector output</code>
| Calculates angles for throwing at input position?
|-
| <code>action_assign_guardian_loadout</code>
| <code>string input_token_name, array assignments(string token, array loadout(array items, array wave_numbers, int wave_numbers_min, int wave_numbers_max, int weight))</code>
| In [[Creating a Guardian Scenario Map|Guardian]] mode: Chooses bot spawn loadout.
|-
| <code>action_attack</code>
| <code>vector input, flag? output (e.g. output = "Attacking"), flag? ready (e.g. ready = "AimReady")</code>
| Bot attack input entity?
|-
| <code>action_buy</code>
| 
| Bot buys weapons.
|-
| <code>action_choose_bomb_site_area</code>
| <code>int input, navzone? output</code>
| Gets bombzone nav position from index. Supports convars.
|-
| <code>action_choose_guardian_bomb_plant_location</code>
| <code>vector? output</code>
| Chooses plant position in navmesh? Guardian mode only?
|-
| <code>action_choose_random_waypoint</code>
| <code>navzone? input, vector output</code>
| Chooses random waypoint inside input navzone.
|-
| <code>action_choose_random_waypoint_within_radius</code>
| <code>vector origin, vector output, float radius</code>
| Choose random waypoint within specified origin and radius.
|-
| <code>action_choose_team_spawn_area</code>
| <code>navzone? output</code>
| Gets all navzones with spawnpoints?
|-
| <code>action_combat_positioning</code>
| <code>vector input, flag? is_attacking</code>
| Bot tries to reach best combat position against input entity?
|-
| <code>action_commit_suicide</code>
| 
| Kills bot.
|-
| <code>action_compare_global_counter</code>
| <code>variable? input_name (e.g. input_name = "'Test'"), int input_value</code>
| Compares value from variable "input_name" to input value.
|-
| <code>action_coordinated_buy</code>
| <code>flag team_filter (ANY, CT, TERRORIST, SAME, OPPOSITE, ENEMY), int save_threshold, flag? id_no_purchase (e.g. id_no_purchase = "DidNotPurchase"), array purchases(array items, string id)</code>
| In [[Creating a Guardian Scenario Map|Guardian]] mode: restricts buying items to specific groupIDs?
|-
| <code>action_crouch</code>
| 
| Forces bot to crouch.
|-
| <code>action_custom_buy</code>
| <code>array item_aliases</code>
| Unused.
|-
| <code>action_drop_active_weapon</code>
| 
| Unused. Forces bot to drop active weapon.
|-
| <code>action_equip_item</code>
| <code>string item, array items_one_of</code>
| Forces bot to select item with classname from input.
|-
| <code>action_equip_weapon</code>
| <code>string weapon (classname or BEST)</code>
| Force bot to select item with classname from input or "best" weapon in inventory.
|-
| <code>action_flee_area_damage</code>
| <code>vector? input, vector output, int max_search_range, int threat_min_keep_distance</code>
| Returns safe spot from that position within search radius.
|-
| <code>action_hide</code>
| 
| Unused.
|-
| <code>action_inspect_current_weapon</code>
| 
| Unused. Forces bot to play inspect animation.
|-
| <code>action_jump</code>
| 
| Forces bot to jump.
|-
| <code>action_look_at</code>
| <code>vector input_angles, navzone? input_location</code>
| Rotates bot at specified angle.
|-
| <code>action_move_to</code>
| <code>vector destination, flag movement_type (BT_ACTION_MOVETO_RUN, BT_ACTION_MOVETO_WALK), flag route_type (BT_ACTION_MOVETO_FASTEST_ROUTE,BT_ACTION_MOVETO_SAFEST_ROUTE), vector? hiding_spot, vector? threat, int damaging_areas_penalty_cost, int nearest_area_distance_threshold, int hiding_spot_check_distance_threshold, int arrival_epsilon, float additional_arrival_epsilon_2d, int_flag? auto_look_adjust</code>
| Forces bot to move at destination point.
|-
| <code>action_parachute_positioning</code>
| 
| ???
|-
| <code>action_pull_trigger</code>
| <code>int ratio</code>
| Forces bot primary attack.
|-
| <code>action_reload</code>
| 
| Forces bot to reload weapon.
|-
| <code>action_say</code>
| <code>string phrase, flag? high_priority</code>
| Forces bot to say radio command phrase. List of phrases is located in <code>botchatter.db</code>
|-
| <code>action_secondary_attack</code>
| 
| Unused. Forces bot secondary attack.
|-
| <code>action_select_areas_within_radius</code>
| <code>vector input, float radius, navzone? output</code>
| Returns navzones within specified origin and radius?
|-
| <code>action_set_global_counter</code>
| <code>variable? input_name, int input_value</code>
| Sets input value to variable "input_name".
|-
| <code>action_set_global_flag</code>
| <code>variable? name, int expiration_time_min, int expiration_time_max</code>
| Sets global variable "name" to 1 for specified time?
|-
| <code>action_set_value_float</code>
| <code>variable? key, float value</code>
| Sets float value to variable "key".
|-
| <code>action_set_value_vector</code>
| <code>variable? key, vector value</code>
| Sets vector value to variable "key".
|-
| <code>action_standup</code>
| 
| Unused. Forces bot to uncrouch.
|-
| <code>action_teleport</code>
| <code>vector destination</code>
| Teleports bot to destination position.
|-
| <code>action_use</code>
| 
| Forces bot "+use"
|-
| <code>action_wait</code>
| <code>int wait_time_min, int wait_time_max</code>
| Freezes bot AI and script execution for defined amount of time.
|}

== Reserved Variables ==
Those variables are defined in game code. They can be used to get some information about game mode and bot and as conditions.

{| class="standard-table" style="width: 100%;"
! Variable
!Description
|-
| <code>int NumberOfTerrorists</code>
| Number of players in T team.
|-
| <code>int NumberOfAliveTerrorists</code>
| Number of alive players in T team.
|-
| <code>int NumberOfCounterTerrorists</code>
| Number of players in CT team.
|-
| <code>int NumberOfAliveCounterTerrorists</code>
| Number of alive players in CT team.
|-
| <code>int GuardianWaveNumber</code>
| Wave number in Guardian Mode.
|-
| <code>int AccountBalance</code>
| Amount of player money.
|-
| <code>float? BlindnessPercentage</code>
| Amount of blindness applied by flash grenade.
|-
| <code>??? BombIsBeingDefused</code>
| Returns ??? when bomb is being defused.
|-
| <code>variable? LastCoopSpawnPointName</code>
| Targetname of last spawn point spawned that bot in Co-op Strike.
|-
| <code>Vector LastCoopSpawnPointLocation</code>
| Origin point of last spawn point spawned that bot in Co-op Strike.
|-
| <code>int AmmoCount/weapon_name</code>
| Remained amount of ammo in weapon with classname "weapon_name" (clip + reserve).
|-
| <code>int AmmoCount/current</code>
| Remained amount of ammo in active weapon (clip + reserve).
|}

== Examples ==
=== Default Deathmatch Behavior Tree ===
Found in <code>csgo/scripts/ai/bt_default.kv3</code>.
{{ExpandBox|
<source lang="javascript"><!-- kv3 encoding:text:version{e21c7f3c-8a33-41c5-9977-a76d3a32aa0d} format:generic:version{7412167c-06e9-4698-aff2-e63eb59037e7} -->
{
	config = "scripts/ai/deathmatch/bt_config.kv3"
	root =
	{
		type = "decorator_bot_service"
		memory_to_expire =
		[
			{
				key = "ShortTermAttackMemory"
				time = 0.7
				distance = 0
			},
			{
				key = "LongTermMemory"
				time = 10
				distance = 500
			},
			{
				key = "ShortTermInvestigateMemory"
				time = 3
				distance = 200
			}
		]
		child =
		{
			type = "decorator_buy_service"
			output = "ShouldBuy"
			child =
			{
				type = "parallel"
				children =
				[
					{
						type = "decorator_repeat"
						child =
						{
							type = "parallel"
							children =
							[
								// memorize enemies through vision
								{
									type = "subtree"
									file = "scripts/ai/modules/bt_memorize_enemies_vision.kv3"
									name = "MemorizeEnemiesVision"
								},
								// memorize noises happening right now
								{
									type = "subtree"
									file = "scripts/ai/modules/bt_memorize_noises.kv3"
									name = "MemorizeNoises"
								},
								// record the nearest memorized event to investigate
								{
									type = "subtree"
									file = "scripts/ai/modules/bt_memorize_nearest_investigation.kv3"
									name = "MemorizeNearestInvestigation"
								}
							]
						}
					},
					{
						type = "decorator_repeat"
						child =
						{
							type = "selector"
							children =
							[
								// Buy if we have to
								{
									type = "condition_is_empty"
									input = "ShouldBuy"
									negated = 1
									child =
									{
										// sequencer: evaluate first to last child, in order
										type = "sequencer"
										children =
										[
											{
												type = "action_wait"
												wait_time_min = 3
												wait_time_max = 3
											},
											{
												type = "action_buy"
											},
											{
												type = "decorator_remove_key"
												input = "ShouldBuy"
											}
										]
									}
								},
								// Else: face the damage source if we're taking damage
								{
									type = "decorator_sensor"
									entity_type_filter = "DAMAGE"
									output = "Damage"
									priority = 0
									child =
									{
										type = "condition_is_empty"
										input = "Damage"
										negated = 1
										child =
										{
											type = "action_aim"
											input = "Damage"
											acquire_only = 1
										}
									}
								},
								// Else: attack if we see an enemy
								{
									type = "subtree"
									file = "scripts/ai/modules/bt_attack.kv3"
									name = "Attack"
								},
								{
									type = "subtree"
									file = "scripts/ai/modules/bt_heal_if_needed.kv3"
									name = "HealIfNeeded"
								},
								// Else: investigate the closest memorized event
								{
									type = "subtree"
									file = "scripts/ai/modules/bt_investigate_closest_memorized_event.kv3"
									name = "InvestigateClosestMemorizedEvent"
								},
								// Else: hunt
								{
									// sequencer: evaluate first to last child, in order
									type = "sequencer"
									children =
									[
										{
											type = "action_equip_weapon"
											weapon = "BEST"
										},
										{
											type = "decorator_random_int"
											min = 0
											max = 1
											output = "BombSiteIndex"
											child =
											{
												type = "action_choose_bomb_site_area"
												input = "BombSiteIndex"
												output = "HuntAreas"
											}
										},
										{
											type = "action_choose_team_spawn_area"
											output = "HuntAreas"
										},
										{
											type = "action_choose_random_waypoint"
											input = "HuntAreas"
											output = "TargetHuntArea"
										},
										{
											type = "action_move_to"
											destination = "TargetHuntArea"
											movement_type = "BT_ACTION_MOVETO_RUN"
											route_type = "BT_ACTION_MOVETO_FASTEST_ROUTE"
										}
									]
								}
							]
						}
					}
				]
			}
		}
	}
}
</source>
}}