‪Black Ops 3 Source Code Explorer  0.1
‪An script explorer for Black Ops 3 by ZeRoY
spawner_shared.gsc File Reference

Go to the source code of this file.

Macros

#define DEBUG_DAMAGE_DISPLAY_COLOR   (0.96, 0.12, 0.12)
 
#define DEBUG_XP_DISPLAY_COLOR   (0.83, 0.18, 0.76)
 
#define XP_DISPLAY_DELAY_BEFORE_FADE   20
 
#define XP_DISPLAY_MAX_HEIGHT_OFFSET   45
 
#define XP_DISPLAY_TOTAL_TIME   40
 

Functions

function __init__ ()
 
function __main__ ()
 
function add_archetype_spawn_function (archetype, spawn_func, param1, param2, param3, param4, param5)
 
function add_global_spawn_function (team, spawn_func, param1, param2, param3, param4, param5)
 
function add_spawn_function (spawn_func, param1, param2, param3, param4, param5)
 
function add_spawn_function_ai_group (str_aigroup, func_spawn, param_1, param_2, param_3, param_4, param_5)
 
function add_spawn_function_group (str_value, str_key="targetname", func_spawn, param_1, param_2, param_3, param_4, param_5)
 
function aigroup_init (aigroup, spawner)
 
function aigroup_spawner_death (tracker)
 
function aigroup_think (tracker)
 
function callback_Track_Dead_NPCs_By_Type ()
 
function check_player_requirements ()
 
function coverprint (org)
 
function crawl_target_and_init_flags (ent, get_func)
 
function crawl_through_targets_to_init_flags ()
 
function disable_replace_on_death ()
 
function drop_gear ()
 
function fallback_add_previous_group (num, node_array)
 
function fallback_ai (num, node_array, ignoreWhileFallingBack)
 
function fallback_ai_think (num, node_array, spawner, ignoreWhileFallingBack)
 
function fallback_ai_think_death (ai, num)
 
function fallback_death (ai, num)
 
function fallback_goal (ignoreWhileFallingBack)
 
function fallback_interrupt ()
 
function fallback_overmind (num, group, ignoreWhileFallingBack, percent)
 
function fallback_overmind_internal (num, group, fallback_nodes, ignoreWhileFallingBack, percent)
 
function fallback_spawner_think (num, node_array, ignoreWhileFallingBack)
 
function fallback_text (fallbackers, start, end)
 
function fallback_think (trigger)
 
function fallback_wait (num, group, ignoreWhileFallingBack, percent)
 
function flood_spawner_init (spawner)
 
function flood_spawner_scripted (spawners)
 
function flood_spawner_think (trigger)
 
function flood_trigger_think (trigger)
 
function get_ai_group_ai (aigroup)
 
function get_ai_group_count (aigroup)
 
function get_ai_group_sentient_count (aigroup)
 
function get_ai_group_spawner_count (aigroup)
 
function get_goal (str_goal, str_key="targetname")
 
function get_least_used_from_array (array)
 
function get_node_funcs_based_on_target (node, goal_type)
 
function get_spawner_target_nodes (group)
 
function get_target_ents (target)
 
function get_target_nodes (target)
 
function get_target_structs (target)
 
function global_ai_array ()
 
function global_spawn_throttle (n_count_per_network_frame)
 
function go_to_node (node, goal_type, optional_arrived_at_node_func)
 
function go_to_node_set_goal_node (node)
 
function go_to_node_set_goal_pos (ent)
 
function go_to_node_using_funcs (node, get_target_func, set_goal_func_quits, optional_arrived_at_node_func, require_player_dist)
 
function go_to_node_wait_for_player (node, get_target_func, dist)
 
function go_to_origin (node, optional_arrived_at_node_func)
 
function go_to_spawner_target (target_names)
 
function go_to_struct (node, optional_arrived_at_node_func)
 
function goal_volume_init ()
 
function autoexec init_female_spawn ()
 
function kill_spawnernum (number)
 
function kill_trigger (trigger)
 
function living_ai_prethink ()
 
function node_has_radius (node)
 
function player_saw_kill (guy, attacker)
 
function precache_player_weapon_drops (weapon_names)
 
function process_deathflags ()
 
function reincrement_count_if_deleted (spawner)
 
function release_spawner_target_node (node)
 
function remove_crawled (ent)
 
function remove_global_spawn_function (team, func)
 
function remove_spawn_function (func)
 
function remove_spawn_function_ai_group (str_aigroup, func_spawn, param_1, param_2, param_3, param_4, param_5)
 
function remove_spawner_values ()
 
function replace_on_death ()
 
function run_spawn_functions ()
 
function set_ai_group_cleared_count (aigroup, count)
 
function set_ai_group_cleared_flag (tracker)
 
function set_female_percent (percent)
 
function set_goal_volume ()
 
function set_goalradius_based_on_settings (node)
 
function set_targets (spawner_targets)
 
function show_bad_path ()
 
function simple_flood_spawn (name, spawn_func, spawn_func_2)
 
function simple_spawn (name_or_spawners, spawn_func, param1, param2, param3, param4, param5, bForce)
 
function simple_spawn_single (name_or_spawner, spawn_func, param1, param2, param3, param4, param5, bforce)
 
function spawn (b_force=false, str_targetname, v_origin, v_angles, bIgnoreSpawningLimit)
 
function spawn_failed (spawn)
 
function spawn_grenade_bag (origin, angles, team)
 
function spawn_guys_until_death_or_no_count ()
 
function spawn_prethink ()
 
function spawn_think (spawner)
 
function spawn_think_action (spawner)
 
function spawn_throttle_reset ()
 
function spawner_targets_init ()
 
function teleport_spawned (v_origin, v_angles, b_reset_entity=true)
 
function trigger_requires_player (trigger)
 
function update_nav_triggers ()
 
function update_nav_triggers_for_actor ()
 
function update_target_array (str_target)
 
function waittill_ai_group_ai_count (aigroup, count)
 
function waittill_ai_group_amount_killed (aigroup, amount_killed)
 
function waittill_ai_group_cleared (aigroup)
 
function waittill_ai_group_count (aigroup, count)
 
function waittill_ai_group_spawner_count (aigroup, count)
 
function waittillDeathOrPainDeath ()
 
function watches_for_friendly_fire ()
 

Macro Definition Documentation

◆ DEBUG_DAMAGE_DISPLAY_COLOR

#define DEBUG_DAMAGE_DISPLAY_COLOR   (0.96, 0.12, 0.12)

Definition at line 23 of file spawner_shared.gsc.

◆ DEBUG_XP_DISPLAY_COLOR

#define DEBUG_XP_DISPLAY_COLOR   (0.83, 0.18, 0.76)

Definition at line 24 of file spawner_shared.gsc.

◆ XP_DISPLAY_DELAY_BEFORE_FADE

#define XP_DISPLAY_DELAY_BEFORE_FADE   20

Definition at line 22 of file spawner_shared.gsc.

◆ XP_DISPLAY_MAX_HEIGHT_OFFSET

#define XP_DISPLAY_MAX_HEIGHT_OFFSET   45

Definition at line 21 of file spawner_shared.gsc.

◆ XP_DISPLAY_TOTAL_TIME

#define XP_DISPLAY_TOTAL_TIME   40

Definition at line 20 of file spawner_shared.gsc.

Function Documentation

◆ __init__()

◆ __main__()

function __main__ ( )

◆ add_archetype_spawn_function()

function add_archetype_spawn_function ( archetype  ,
spawn_func  ,
param1  ,
param2  ,
param3  ,
param4  ,
param5   
)

Description:
"Function Name: add_archetype_spawn_function( <archetype> , <func> , <param1> , <param2> , <param3> )"
"Summary: All spawners of this team will run this function on spawn." "Module: Utility"
"Mandatory Argument(s): <archetype> : The AI archetype."
"Mandatory Argument(s): <func> : The function to run."
"Optional Argument(s): <param1> : An optional parameter."
"Optional Argument(s): <param2> : An optional parameter."
"Optional Argument(s): <param3> : An optional parameter."
"Optional Argument(s): <param4> : An optional parameter."
"Optional Argument(s): <param5> : An optional parameter."
"Example:add_archetype_spawn_function( "basic_soldier", &do_the_amazing_thing, some_amazing_parameter );"
"Single Player / Multi Player: singleplayer"

Definition at line 3188 of file spawner_shared.gsc.

References ARRAY_ADD.

◆ add_global_spawn_function()

function add_global_spawn_function ( team  ,
spawn_func  ,
param1  ,
param2  ,
param3  ,
param4  ,
param5   
)

Description:
"Function Name: add_global_spawn_function( <team> , <func> , <param1> , <param2> , <param3> )"
"Summary: All spawners of this team will run this function on spawn." "Module: Utility"
"Mandatory Argument(s): <team> : The team of the spawners that will run this function."
"Mandatory Argument(s): <func> : The function to run."
"Optional Argument(s): <param1> : An optional parameter."
"Optional Argument(s): <param2> : An optional parameter."
"Optional Argument(s): <param3> : An optional parameter."
"Optional Argument(s): <param4> : An optional parameter."
"Optional Argument(s): <param5> : An optional parameter."
"Example:add_global_spawn_function( "axis",&do_the_amazing_thing, some_amazing_parameter );"
"Single Player / Multi Player: singleplayer"

Definition at line 3149 of file spawner_shared.gsc.

References ARRAY_ADD.

Referenced by __init__().

◆ add_spawn_function()

function add_spawn_function ( spawn_func  ,
param1  ,
param2  ,
param3  ,
param4  ,
param5   
)

Description:
"Function Name: add_spawn_function( <func> , [param1], [param2], [param3], [param4], [param5] )"
"Summary: Anything that spawns from this spawner will run this function. Anything."
"Mandatory Argument(s): <func1> : The function to run."
"Optional Argument(s): <param1> : An optional parameter."
"Optional Argument(s): <param2> : An optional parameter."
"Optional Argument(s): <param3> : An optional parameter."
"Optional Argument(s): <param4> : An optional parameter."
"Optional Argument(s): <param5> : An optional parameter."
"Example:spawner add_spawn_function(&do_the_amazing_thing, some_amazing_parameter );"
"Single Player / Multi Player: singleplayer"

Definition at line 3252 of file spawner_shared.gsc.

Referenced by __init__(), add_spawn_function_ai_group(), add_spawn_function_group(), custom_spawn_init_func(), dog_spawner_init(), and simple_flood_spawn().

◆ add_spawn_function_ai_group()

function add_spawn_function_ai_group ( str_aigroup  ,
func_spawn  ,
param_1  ,
param_2  ,
param_3  ,
param_4  ,
param_5   
)

Description:
"Function Name: add_spawn_function_ai_group( <str_aigroup>, <func_spawn>, [param_1], [param_2], [param_3], [param_4], [param_5] )"
"Summary: Gets all spawners with specified ai group, then adds spawn function to entire group with up to 5 input arguments." "Module: Entity" "CallOn: self unused"
"Mandatory Argument(s): <str_aigroup> ai group to add the spawn function to"
"Mandatory Argument(s): <func_spawn> Spawn function to add to the spawners"
"Optional Argument(s): <param_1> Input parameter to function"
"Optional Argument(s): <param_2> Input parameter to function"
"Optional Argument(s): <param_3> Input parameter to function"
"Optional Argument(s): <param_4> Input parameter to function"
"Optional Argument(s): <param_5> Input parameter to function"
"Example:add_spawn_function_ai_group( "physics_launch_guys",&set_ignoreall, true );"
"Single Player / Multi Player: singleplayer"

Definition at line 3343 of file spawner_shared.gsc.

References add_spawn_function().

◆ add_spawn_function_group()

function add_spawn_function_group ( str_value  ,
str_key  = "targetname",
func_spawn  ,
param_1  ,
param_2  ,
param_3  ,
param_4  ,
param_5   
)

Description:
"Function Name: add_spawn_function_group( <str_value>, <str_key>, <func_spawn>, [param_1], [param_2], [param_3], [param_4], [param_5] )"
"Summary: Gets all spawners with specified KVP, then adds spawn function to entire group with up to 5 input arguments." "Module: Entity" "CallOn: self unused"
"Mandatory Argument(s): <str_value> Name of the spawners to find"
"Mandatory Argument(s): <str_key> Key of the spawner to find; "targetname", "script_noteworthy", etc"
"Mandatory Argument(s): <func_spawn> Spawn function to add to the spawners"
"Optional Argument(s): <param_1> Input parameter to function"
"Optional Argument(s): <param_2> Input parameter to function"
"Optional Argument(s): <param_3> Input parameter to function"
"Optional Argument(s): <param_4> Input parameter to function"
"Optional Argument(s): <param_5> Input parameter to function"
"Example:add_spawn_function_group( "physics_launch_guys", "targetname",&set_ignoreall, true );"
"Single Player / Multi Player: singleplayer"

Definition at line 3318 of file spawner_shared.gsc.

References add_spawn_function().

◆ aigroup_init()

function aigroup_init ( aigroup  ,
spawner   
)

◆ aigroup_spawner_death()

function aigroup_spawner_death ( tracker  )

Definition at line 2399 of file spawner_shared.gsc.

References waittill_any().

Referenced by aigroup_init().

◆ aigroup_think()

function aigroup_think ( tracker  )

Definition at line 2405 of file spawner_shared.gsc.

References remove_undefined(), WAIT_SERVER_FRAME, and waittillDeathOrPainDeath().

Referenced by spawn_think().

◆ callback_Track_Dead_NPCs_By_Type()

function callback_Track_Dead_NPCs_By_Type ( )

Definition at line 251 of file spawner_shared.gsc.

Referenced by __main__().

◆ check_player_requirements()

function check_player_requirements ( )

Definition at line 2849 of file spawner_shared.gsc.

Referenced by spawn().

◆ coverprint()

function coverprint ( org  )

Definition at line 1793 of file spawner_shared.gsc.

References WAIT_SERVER_FRAME.

Referenced by fallback_ai().

◆ crawl_target_and_init_flags()

function crawl_target_and_init_flags ( ent  ,
get_func   
)

Definition at line 1460 of file spawner_shared.gsc.

References add(), init(), and remove_crawled().

Referenced by crawl_through_targets_to_init_flags().

◆ crawl_through_targets_to_init_flags()

function crawl_through_targets_to_init_flags ( )

◆ disable_replace_on_death()

function disable_replace_on_death ( )

Description:
"Function Name: disable_replace_on_death()"
"Summary: Disables replace on death for color reinforcements" "Module: Color" "CallOn: An AI"
"Example:guy disable_replace_on_death();"
"Single Player / Multi Player: singleplayer"

Definition at line 2948 of file spawner_shared.gsc.

◆ drop_gear()

function drop_gear ( )

Definition at line 366 of file spawner_shared.gsc.

References spawn_grenade_bag(), and waittillDeathOrPainDeath().

◆ fallback_add_previous_group()

function fallback_add_previous_group ( num  ,
node_array   
)

Definition at line 2065 of file spawner_shared.gsc.

Referenced by fallback_overmind_internal().

◆ fallback_ai()

function fallback_ai ( num  ,
node_array  ,
ignoreWhileFallingBack   
)

◆ fallback_ai_think()

function fallback_ai_think ( num  ,
node_array  ,
spawner  ,
ignoreWhileFallingBack   
)

◆ fallback_ai_think_death()

function fallback_ai_think_death ( ai  ,
num   
)

Definition at line 1654 of file spawner_shared.gsc.

Referenced by fallback_ai_think().

◆ fallback_death()

function fallback_death ( ai  ,
num   
)

Definition at line 1687 of file spawner_shared.gsc.

Referenced by fallback_ai().

◆ fallback_goal()

function fallback_goal ( ignoreWhileFallingBack  )

Definition at line 1701 of file spawner_shared.gsc.

Referenced by fallback_ai().

◆ fallback_interrupt()

function fallback_interrupt ( )

Definition at line 1715 of file spawner_shared.gsc.

Referenced by fallback_ai().

◆ fallback_overmind()

function fallback_overmind ( num  ,
group  ,
ignoreWhileFallingBack  ,
percent   
)

Definition at line 1809 of file spawner_shared.gsc.

References add(), and fallback_overmind_internal().

Referenced by fallback_think().

◆ fallback_overmind_internal()

function fallback_overmind_internal ( num  ,
group  ,
fallback_nodes  ,
ignoreWhileFallingBack  ,
percent   
)

◆ fallback_spawner_think()

function fallback_spawner_think ( num  ,
node_array  ,
ignoreWhileFallingBack   
)

◆ fallback_text()

function fallback_text ( fallbackers  ,
start  ,
end   
)

Definition at line 1953 of file spawner_shared.gsc.

References end().

Referenced by fallback_overmind_internal().

◆ fallback_think()

function fallback_think ( trigger  )

Definition at line 2034 of file spawner_shared.gsc.

References fallback_overmind(), and kill_trigger().

Referenced by __init__().

◆ fallback_wait()

function fallback_wait ( num  ,
group  ,
ignoreWhileFallingBack  ,
percent   
)

Definition at line 1976 of file spawner_shared.gsc.

References fallback_ai_think().

Referenced by fallback_overmind_internal().

◆ flood_spawner_init()

function flood_spawner_init ( spawner  )

◆ flood_spawner_scripted()

function flood_spawner_scripted ( spawners  )

Definition at line 326 of file spawner_shared.gsc.

References flood_spawner_init(), and flood_spawner_think().

◆ flood_spawner_think()

◆ flood_trigger_think()

function flood_trigger_think ( trigger  )

Definition at line 2443 of file spawner_shared.gsc.

References flood_spawner_init(), and flood_spawner_think().

Referenced by __init__().

◆ get_ai_group_ai()

function get_ai_group_ai ( aigroup  )

Description:
"Function Name: get_ai_group_ai( <aigroup> )"
"Summary: Returns an array of the alive AI for this group." "Module: AI"
"Mandatory Argument(s): <aigroup> : The AI group"
"Example:room_1_guys = get_ai_group_ai( "room_1_guys" );"
"Single Player / Multi Player: singleplayer"

Definition at line 3117 of file spawner_shared.gsc.

◆ get_ai_group_count()

function get_ai_group_count ( aigroup  )

Description:
"Function Name: get_ai_group_count( <aigroup> )"
"Summary: Returns the integer sum of alive AI count and spawner count for this group." "Module: AI"
"Mandatory Argument(s): <aigroup> : The AI group"
"Example:if( get_ai_group_count( "room_1_guys" ) < 3 )..."
"Single Player / Multi Player: singleplayer"

Definition at line 3076 of file spawner_shared.gsc.

References get_ai_group_spawner_count().

◆ get_ai_group_sentient_count()

function get_ai_group_sentient_count ( aigroup  )

Description:
"Function Name: get_ai_group_sentient_count( <aigroup> )"
"Summary: Returns integer of the alive AI count for this group." "Module: AI"
"Mandatory Argument(s): <aigroup> : The AI group"
"Example:if( get_ai_group_sentient_count( "room_1_guys" ) < 3 )..."
"Single Player / Multi Player: singleplayer"

Definition at line 3090 of file spawner_shared.gsc.

◆ get_ai_group_spawner_count()

function get_ai_group_spawner_count ( aigroup  )

◆ get_goal()

function get_goal ( str_goal  ,
str_key  = "targetname" 
)

Definition at line 1608 of file spawner_shared.gsc.

Referenced by set_goalradius_based_on_settings().

◆ get_least_used_from_array()

function get_least_used_from_array ( array  )

Definition at line 1233 of file spawner_shared.gsc.

References array.

Referenced by go_to_node_using_funcs().

◆ get_node_funcs_based_on_target()

function get_node_funcs_based_on_target ( node  ,
goal_type   
)

◆ get_spawner_target_nodes()

function get_spawner_target_nodes ( group  )

Definition at line 1205 of file spawner_shared.gsc.

Referenced by go_to_spawner_target().

◆ get_target_ents()

function get_target_ents ( target  )

Definition at line 1031 of file spawner_shared.gsc.

Referenced by get_node_funcs_based_on_target().

◆ get_target_nodes()

function get_target_nodes ( target  )

Definition at line 1036 of file spawner_shared.gsc.

Referenced by get_node_funcs_based_on_target().

◆ get_target_structs()

function get_target_structs ( target  )

Definition at line 1041 of file spawner_shared.gsc.

References get_array().

Referenced by get_node_funcs_based_on_target().

◆ global_ai_array()

function global_ai_array ( )

Definition at line 187 of file spawner_shared.gsc.

References array, and ARRAY_ADD.

Referenced by __init__().

◆ global_spawn_throttle()

function global_spawn_throttle ( n_count_per_network_frame  )

Definition at line 238 of file spawner_shared.gsc.

References IS_TRUE, and WAIT_SERVER_FRAME.

Referenced by _vehicle_spawn(), spawn(), and spawn_model().

◆ go_to_node()

function go_to_node ( node  ,
goal_type  ,
optional_arrived_at_node_func   
)

◆ go_to_node_set_goal_node()

function go_to_node_set_goal_node ( node  )

Definition at line 1446 of file spawner_shared.gsc.

Referenced by get_node_funcs_based_on_target().

◆ go_to_node_set_goal_pos()

function go_to_node_set_goal_pos ( ent  )

Definition at line 1441 of file spawner_shared.gsc.

Referenced by get_node_funcs_based_on_target().

◆ go_to_node_using_funcs()

function go_to_node_using_funcs ( node  ,
get_target_func  ,
set_goal_func_quits  ,
optional_arrived_at_node_func  ,
require_player_dist   
)

◆ go_to_node_wait_for_player()

function go_to_node_wait_for_player ( node  ,
get_target_func  ,
dist   
)

Definition at line 1375 of file spawner_shared.gsc.

Referenced by go_to_node_using_funcs().

◆ go_to_origin()

function go_to_origin ( node  ,
optional_arrived_at_node_func   
)

Definition at line 1051 of file spawner_shared.gsc.

References go_to_node().

◆ go_to_spawner_target()

function go_to_spawner_target ( target_names  )

◆ go_to_struct()

function go_to_struct ( node  ,
optional_arrived_at_node_func   
)

Definition at line 1056 of file spawner_shared.gsc.

References go_to_node().

◆ goal_volume_init()

function goal_volume_init ( )

Definition at line 256 of file spawner_shared.gsc.

Referenced by __init__().

◆ init_female_spawn()

function autoexec init_female_spawn ( )

Definition at line 3512 of file spawner_shared.gsc.

References set_female_percent().

◆ kill_spawnernum()

function kill_spawnernum ( number  )

Description:
"Function Name: kill_spawnernum( <num> )"
"Summary: Kill spawners with script_killspawner value of <num>." "Module: Utility"
"Mandatory Argument(s): <num> : The killspawner number"
"Example:kill_spawnernum(4);"
"Single Player / Multi Player: singleplayer"

Definition at line 2931 of file spawner_shared.gsc.

◆ kill_trigger()

function kill_trigger ( trigger  )

◆ living_ai_prethink()

function living_ai_prethink ( )

Definition at line 611 of file spawner_shared.gsc.

References crawl_through_targets_to_init_flags().

Referenced by __main__().

◆ node_has_radius()

function node_has_radius ( node  )

Definition at line 1046 of file spawner_shared.gsc.

Referenced by set_goalradius_based_on_settings().

◆ player_saw_kill()

function player_saw_kill ( guy  ,
attacker   
)

Definition at line 2568 of file spawner_shared.gsc.

References get_closest_player().

Referenced by flood_spawner_think().

◆ precache_player_weapon_drops()

function precache_player_weapon_drops ( weapon_names  )

Definition at line 276 of file spawner_shared.gsc.

Referenced by __init__().

◆ process_deathflags()

function process_deathflags ( )

Definition at line 302 of file spawner_shared.gsc.

References init().

Referenced by __init__().

◆ reincrement_count_if_deleted()

function reincrement_count_if_deleted ( spawner  )

Definition at line 334 of file spawner_shared.gsc.

Referenced by flood_spawner_think().

◆ release_spawner_target_node()

function release_spawner_target_node ( node  )

Definition at line 1197 of file spawner_shared.gsc.

References waittill_any().

Referenced by go_to_spawner_target().

◆ remove_crawled()

function remove_crawled ( ent  )

Definition at line 1451 of file spawner_shared.gsc.

Referenced by crawl_target_and_init_flags().

◆ remove_global_spawn_function()

function remove_global_spawn_function ( team  ,
func   
)

Description:
"Function Name: remove_global_spawn_function( <team> , <func> )"
"Summary: Remove this function from the global spawn functions for this team." "Module: Utility"
"Mandatory Argument(s): <team> : The team of the spawners that will no longer run this function."
"Mandatory Argument(s): <func> : The function to remove."
"Example:remove_global_spawn_function( "allies",&do_the_amazing_thing );"
"Single Player / Multi Player: singleplayer"

Definition at line 3222 of file spawner_shared.gsc.

References array.

◆ remove_spawn_function()

function remove_spawn_function ( func  )

Description:
"Function Name: remove_spawn_function( <func> )"
"Summary: Remove a previously added spawn function."
"Mandatory Argument(s): <func1> : The function to run."
"Example:spawner remove_spawn_function(&do_the_amazing_thing, some_amazing_parameter );"
"Single Player / Multi Player: singleplayer"

Definition at line 3280 of file spawner_shared.gsc.

References array.

Referenced by remove_spawn_function_ai_group().

◆ remove_spawn_function_ai_group()

function remove_spawn_function_ai_group ( str_aigroup  ,
func_spawn  ,
param_1  ,
param_2  ,
param_3  ,
param_4  ,
param_5   
)

Description:
"Function Name: remove_spawn_function_ai_group( <str_aigroup>, <func_spawn> )"
"Summary: Gets all spawners with specified ai group, then removes spawn function to entire group." "Module: Entity" "CallOn: self unused"
"Mandatory Argument(s): <str_aigroup> ai group to add the spawn function to"
"Mandatory Argument(s): <func_spawn> Spawn function to add to the spawners"
"Example:remove_spawn_function_ai_group( "physics_launch_guys",&set_ignoreall );"
"Single Player / Multi Player: singleplayer"

Definition at line 3363 of file spawner_shared.gsc.

References remove_spawn_function().

◆ remove_spawner_values()

function remove_spawner_values ( )

Definition at line 640 of file spawner_shared.gsc.

Referenced by spawn_think_action().

◆ replace_on_death()

function replace_on_death ( )

Description:
"Function Name: replace_on_death()"
"Summary: Will replace a color guy after he dies. Good for manually putting a respawnable guy onto a color chain." "Module: Utility" "CallOn: an actor"
"Example:new_color_guy thread replace_on_death();"
"Single Player / Multi Player: singleplayer"

Definition at line 2963 of file spawner_shared.gsc.

References colorNode_replace_on_death().

Referenced by colorNode_replace_on_death(), and spawn_think_action().

◆ run_spawn_functions()

function run_spawn_functions ( )

Definition at line 563 of file spawner_shared.gsc.

References callback(), and single_thread().

Referenced by Callback_ActorSpawned(), and spawn_think().

◆ set_ai_group_cleared_count()

function set_ai_group_cleared_count ( aigroup  ,
count   
)

Description:
"Function Name: set_ai_group_cleared_count( <aigroup>, <count> )"
"Summary: Sets how many guys left in an aigroup for it to be "cleared"." "Module: AI"
"Mandatory Argument(s): <aigroup> : The AI group"
"Mandatory Argument(s): <count> : How many guys/spawners are left when cleared."
"Example:set_ai_group_cleared_count( "room_1_guys", 2 ); // cleared when 2 guys are left"
"Single Player / Multi Player: singleplayer"

Definition at line 2978 of file spawner_shared.gsc.

References aigroup_init().

◆ set_ai_group_cleared_flag()

function set_ai_group_cleared_flag ( tracker  )

Definition at line 2429 of file spawner_shared.gsc.

References get_ai_group_spawner_count(), and set().

Referenced by aigroup_init().

◆ set_female_percent()

function set_female_percent ( percent  )

Description:
"Function Name: set_female_percent(<percent>)"
"Summary: Specify the chance that a spawner in the female mapping table will override the default" "Module: Utility"
"Example:guy spawner::set_female_percent(50);"
"Single Player / Multi Player: SP"

Definition at line 3526 of file spawner_shared.gsc.

Referenced by init_female_spawn().

◆ set_goal_volume()

function set_goal_volume ( )

Definition at line 971 of file spawner_shared.gsc.

References get().

Referenced by spawn_think_action().

◆ set_goalradius_based_on_settings()

function set_goalradius_based_on_settings ( node  )

◆ set_targets()

function set_targets ( spawner_targets  )

Description:
"Function Name: set_targets(<spawner_target_names>)"
"Summary: Gives an AI new script_spawner_targets node(s) to go to. Overrides previously set script_spawner_targets. Seperate sets by spaces." "Module: Utility"
"Example:guy spawner::set_targets("balcony1 balcony2");"
"Single Player / Multi Player: SP"

Definition at line 3506 of file spawner_shared.gsc.

References go_to_spawner_target().

◆ show_bad_path()

function show_bad_path ( )

Definition at line 2631 of file spawner_shared.gsc.

References WAIT_SERVER_FRAME.

Referenced by spawn_think_action().

◆ simple_flood_spawn()

function simple_flood_spawn ( name  ,
spawn_func  ,
spawn_func_2   
)

Description:
"Function Name: simple_flood_spawn( <name>, <spawn_func>, <spawn_func_2>)" "Module: Spawner"
"Summary: Simple way to floodspawn guys, with targetname 'name'"
"Mandatory Argument(s): <name> : targetname of spawners to spawn"
"Optional Argument(s): <spawn_func> : function pointer to a spawn function"
"Optional Argument(s): <spawn_func_2> : function pointer to an additional spawn function"
"Example:spawner::simple_flood_spawn( "defend_guys",&defend_guys_strategy,&defend_guys_retreat_strategy );"
"Single Player / Multi Player: singleplayer"

Definition at line 3383 of file spawner_shared.gsc.

References add_spawn_function(), flood_spawner_init(), flood_spawner_think(), name, and wait_network_frame().

◆ simple_spawn()

function simple_spawn ( name_or_spawners  ,
spawn_func  ,
param1  ,
param2  ,
param3  ,
param4  ,
param5  ,
bForce   
)

Description:
"Function Name: simple_spawn( <name_or_spawners>, <spawn_func>, <param1>, <param2>, <param3>, <param4>, <param5>, <bforce>)" "Module: Spawner"
"Summary: Simple way to spawn guys, with targetname or by passing in the spawners, just once (no floodspawning). Returns an array of the spawned ai."
"Mandatory Argument(s): <name_or_spawners> : targetname of spawners or the spawners themselves"
"Optional Argument(s): <spawn_func> : function pointer to a spawn function"
"Optional Argument(s): <param1> : argument to pass to the spawn function"
"Optional Argument(s): <param2> : argument to pass to the spawn function"
"Optional Argument(s): <param3> : argument to pass to the spawn function"
"Optional Argument(s): <param4> : argument to pass to the spawn function"
"Optional Argument(s): <param5> : argument to pass to the spawn function"
"Optional Argument(s): <bForce> : true/false if you want to force the spawn"
"Example:spawner::simple_spawn( "bunker_guys",&bunker_guys_strategy );"
"Single Player / Multi Player: singleplayer"

Definition at line 3435 of file spawner_shared.gsc.

References ARRAY_ADD, MAKE_ARRAY, single_thread(), and spawn().

Referenced by simple_spawn_single().

◆ simple_spawn_single()

function simple_spawn_single ( name_or_spawner  ,
spawn_func  ,
param1  ,
param2  ,
param3  ,
param4  ,
param5  ,
bforce   
)

Description:
"Function Name: simple_spawn_single( <name_or_spawner>, <spawn_func>, <param1>, <param2>, <param3>, <param4>, <param5>, <bforce>)" "Module: Spawner"
"Summary: Simple way to spawn just one guy, with targetname or by passing in the spawner, just once. Returns the spawned ai entity."
"Mandatory Argument(s): <name_or_spawner> : targetname of spawner or the spawner"
"Optional Argument(s): <spawn_func> : function pointer to a spawn function"
"Optional Argument(s): <param1> : argument to pass to the spawn function"
"Optional Argument(s): <param2> : argument to pass to the spawn function"
"Optional Argument(s): <param3> : argument to pass to the spawn function"
"Optional Argument(s): <param4> : argument to pass to the spawn function"
"Optional Argument(s): <param5> : argument to pass to the spawn function"
"Optional Argument(s): <bforce> : true/false to force spawn"
"Example:spawner::simple_spawn_single( "ambush_guy",&ambush_guy_strategy );"
"Single Player / Multi Player: singleplayer"

Definition at line 3486 of file spawner_shared.gsc.

References simple_spawn().

◆ spawn()

function spawn ( b_force  = false,
str_targetname  ,
v_origin  ,
v_angles  ,
bIgnoreSpawningLimit   
)

Description:
"Function Name: spawn()"
"Summary: Spawns an AI from an AI spawner. Handles force spawning based on 'script_forcespawn' value." "Module: Utility"
"Optional Argument(s): [bForceSpawn]: Set to true to force spawn the AI"
"Optional Argument(s): [v_origin]: Origin spawn the AI"
"Optional Argument(s): [v_angles]: Angles to spawn the AI"
"Example:guy = spawner spawn();"
"Single Player / Multi Player: singleplayer"

Definition at line 2692 of file spawner_shared.gsc.

References check_player_requirements(), global_spawn_throttle(), IS_BONUSZM, IS_TRUE, MAX_SPAWNED_PER_FRAME, spawn_failed(), SPAWNFLAG, SPAWNFLAG_ACTOR_SCRIPTFORCESPAWN, SPAWNFLAG_ACTOR_SCRIPTINFINITESPAWN, SPAWNFLAG_ACTOR_SCRIPTMAKEROOM, SPAWNFLAG_VEHICLE_SCRIPTMAKEROOM, teleport_spawned(), and WAIT_SERVER_FRAME.

Referenced by fallback_spawner_think(), flood_spawner_think(), simple_spawn(), and spawn_failed().

◆ spawn_failed()

function spawn_failed ( spawn  )

Description:
"Function Name: spawn_failed( <spawn> )"
"Summary: Checks to see if the spawned AI spawned correctly or had errors. Also waits until all spawn initialization is complete. Returns true or false." "Module: AI" "CallOn: "
"Mandatory Argument(s): <spawn> : The actor that just spawned"
"Example:spawn_failed( level.price );"
"Single Player / Multi Player: singleplayer"

Definition at line 2902 of file spawner_shared.gsc.

References spawn().

Referenced by colorNode_spawn_reinforcement(), fallback_spawner_think(), flood_spawner_think(), and spawn().

◆ spawn_grenade_bag()

function spawn_grenade_bag ( origin  ,
angles  ,
team   
)

Definition at line 422 of file spawner_shared.gsc.

References Spawn().

Referenced by drop_gear().

◆ spawn_guys_until_death_or_no_count()

function spawn_guys_until_death_or_no_count ( )

Definition at line 320 of file spawner_shared.gsc.

◆ spawn_prethink()

function spawn_prethink ( )

Definition at line 449 of file spawner_shared.gsc.

References aigroup_init(), and crawl_through_targets_to_init_flags().

Referenced by __init__().

◆ spawn_think()

function spawn_think ( spawner  )

◆ spawn_think_action()

◆ spawn_throttle_reset()

function spawn_throttle_reset ( )

Definition at line 228 of file spawner_shared.gsc.

References wait_network_frame().

Referenced by __main__().

◆ spawner_targets_init()

function spawner_targets_init ( )

Definition at line 1095 of file spawner_shared.gsc.

Referenced by __init__().

◆ teleport_spawned()

function teleport_spawned ( v_origin  ,
v_angles  ,
b_reset_entity  = true 
)

Definition at line 2833 of file spawner_shared.gsc.

References DEFAULT.

Referenced by spawn().

◆ trigger_requires_player()

function trigger_requires_player ( trigger  )

Definition at line 2489 of file spawner_shared.gsc.

Referenced by flood_spawner_think().

◆ update_nav_triggers()

function update_nav_triggers ( )

Definition at line 122 of file spawner_shared.gsc.

References waittill_notify_or_timeout().

Referenced by __init__().

◆ update_nav_triggers_for_actor()

function update_nav_triggers_for_actor ( )

Definition at line 492 of file spawner_shared.gsc.

References waittill_either().

Referenced by spawn_think().

◆ update_target_array()

function update_target_array ( str_target  )

Definition at line 1562 of file spawner_shared.gsc.

References get_array().

Referenced by go_to_node_using_funcs().

◆ waittill_ai_group_ai_count()

function waittill_ai_group_ai_count ( aigroup  ,
count   
)

Description:
"Function Name: waittill_ai_group_ai_count( <aigroup>, <count> )"
"Summary: Waits until an AI group's AI count is equal to or lower than the specified number. Only alive guys are counted (spawner counts are not counted)." "Module: AI"
"Mandatory Argument(s): <aigroup> : The AI group"
"Example:waittill_ai_group_ai_count( "room_1_guys", 3 );"
"Single Player / Multi Player: singleplayer"

Definition at line 3025 of file spawner_shared.gsc.

◆ waittill_ai_group_amount_killed()

function waittill_ai_group_amount_killed ( aigroup  ,
amount_killed   
)

Description:
"Function Name: waittill_ai_group_amount_killed( <aigroup>, <amount_killed> )"
"Summary: Waits until a certain number of members an AI group are killed." "Module: AI"
"Mandatory Argument(s): <aigroup> : The AI group"
"Example:waittill_ai_group_amount_killed( "room_1_guys", 3 );"
"Single Player / Multi Player: singleplayer"

Definition at line 3059 of file spawner_shared.gsc.

◆ waittill_ai_group_cleared()

function waittill_ai_group_cleared ( aigroup  )

Description:
"Function Name: waittill_ai_group_cleared( <aigroup> )"
"Summary: Waits until all of an AI group is cleared, including alive guys and spawners. If any spawners have a count greater than 0, this will continue to wait." "Module: AI"
"Mandatory Argument(s): <aigroup> : The AI group"
"Example:waittill_ai_group_cleared( "room_1_guys" );"
"Single Player / Multi Player: singleplayer"

Definition at line 2993 of file spawner_shared.gsc.

References wait_till().

Referenced by go_to_node_using_funcs().

◆ waittill_ai_group_count()

function waittill_ai_group_count ( aigroup  ,
count   
)

Description:
"Function Name: waittill_ai_group_count( <aigroup>, <count> )"
"Summary: Waits until an AI group's count is equal to or lower than the specified number. The group's count is made up of the sum of its spawner counts and the number of alive guys in the group" "Module: AI"
"Mandatory Argument(s): <aigroup> : The AI group"
"Example:waittill_ai_group_count( "room_1_guys", 3 );"
"Single Player / Multi Player: singleplayer"

Definition at line 3008 of file spawner_shared.gsc.

References get_ai_group_spawner_count().

◆ waittill_ai_group_spawner_count()

function waittill_ai_group_spawner_count ( aigroup  ,
count   
)

Description:
"Function Name: waittill_ai_group_spawner_count( <aigroup>, <count> )"
"Summary: Waits until an AI group's spawner count is equal to or lower than the specified number. Only spawner counts are counted (alive AI are not counted)." "Module: AI"
"Mandatory Argument(s): <aigroup> : The AI group"
"Example:waittill_ai_group_spawner_count( "room_1_guys", 3 );"
"Single Player / Multi Player: singleplayer"

Definition at line 3042 of file spawner_shared.gsc.

References get_ai_group_spawner_count().

◆ waittillDeathOrPainDeath()

function waittillDeathOrPainDeath ( )

Definition at line 360 of file spawner_shared.gsc.

Referenced by aigroup_think(), and drop_gear().

◆ watches_for_friendly_fire()

function watches_for_friendly_fire ( )

Definition at line 2676 of file spawner_shared.gsc.