Functions
function	__init__ ()

function	_detect_touched ()

function	_do_trigger_function (trigger, str_remove_on, func, param_1, param_2, param_3, param_4, param_5, param_6)

function	_ent_waits_for_trigger (trigger)

function	_hint_print (string, breakfunc)

function	_hint_print_wait (length, breakfunc)

function	_is_valid_trigger_type (type)

function	_trigger_wait (e_entity)

function	_trigger_wait_think (s_tracker, e_entity)

function	add_function (trigger, str_remove_on, func, param_1, param_2, param_3, param_4, param_5, param_6)

function	add_to_ent (ent, trig)

function	add_tokens_to_trigger_flags (tokens)

function	check_spawnflags ()

function	delete_link_chain (trigger)

function	delete_links_then_self ()

function	display_hint (hint)

function	ent_already_in (trig)

function	flag_clear_trigger (trigger, str_flag)

function	flag_set_touching (trigger)

function	flag_set_trigger (trigger, str_flag)

function	friendly_respawn_clear (trigger)

function	friendly_respawn_trigger (trigger)

function	function_thread (ent, on_enter_payload, on_exit_payload)

function	get_all (type1, type2, type3, type4, type5, type6, type7, type8, type9)

function	get_script_linkto_targets ()

function	get_trigger_look_target ()

function	init_flags ()

function	is_look_trigger (trig)

function	is_trigger_once (trig)

function	kill_spawner_trigger (trigger)

function	multiple_wait (str_trigger_notify)

function	multiple_waits (str_trigger_name, str_trigger_notify)

function	no_crouch_or_prone_think (trigger)

function	no_prone_think (trigger)

function	remove_from_ent (ent, trig)

function	report_trigger (ent, noteworthy)

function	script_flag_false_trigger (trigger)

function	script_flag_set_touching (trigger)

function	script_flag_true_trigger (trigger)

function	set_flag_permissions (msg)

function	trigger_delete_on_touch (trigger)

function	trigger_exploder (trigger)

function	trigger_group ()

function	trigger_group_remove ()

function	trigger_hint (trigger)

function	trigger_look (trigger)

function	trigger_notify (trigger, msg)

function	trigger_on_timeout (n_time, b_cancel_on_triggered=true, str_name, str_key="targetname")

function	trigger_once (trig)

function	trigger_spawner (trigger)

function	trigger_spawner_spawn ()

function	trigger_turns_off (trigger)

function	trigger_unlock (trigger)

function	trigger_unlock_death (target)

function	update_based_on_flags ()

function	use (str_name, str_key="targetname", ent, b_assert=true)

function	wait_for_an_unlocked_trigger (triggers, noteworthy)

function	wait_for_either (str_targetname1, str_targetname2)

function	wait_or_timeout (n_time, str_name, str_key)

function	wait_till (str_name, str_key="targetname", e_entity, b_assert=true)

Function Documentation

◆ init()

◆ _detect_touched()

function _detect_touched ( )

Definition at line 551 of file trigger_shared.gsc.

Referenced by script_flag_set_touching().

◆ _do_trigger_function()

function _do_trigger_function	(	trigger	,
		str_remove_on	,
		func	,
		param_1	,
		param_2	,
		param_3	,
		param_4	,
		param_5	,
		param_6
	)

Definition at line 1286 of file trigger_shared.gsc.

References single_thread(), and wait_till().

Referenced by add_function().

◆ _ent_waits_for_trigger()

function _ent_waits_for_trigger ( trigger )

Definition at line 1190 of file trigger_shared.gsc.

References wait_till().

Referenced by wait_for_either().

◆ _hint_print()

function _hint_print	(	string	,
		breakfunc
	)

Definition at line 702 of file trigger_shared.gsc.

References _hint_print_wait(), clear(), createFontString(), set(), and wait_till_clear().

Referenced by display_hint().

◆ _hint_print_wait()

function _hint_print_wait	(	length	,
		breakfunc
	)

Definition at line 773 of file trigger_shared.gsc.

References timer(), and WAIT_SERVER_FRAME.

Referenced by _hint_print().

◆ _is_valid_trigger_type()

function _is_valid_trigger_type ( type )

Definition at line 878 of file trigger_shared.gsc.

Referenced by get_all().

◆ _trigger_wait()

function _trigger_wait ( e_entity )

Definition at line 964 of file trigger_shared.gsc.

References is_look_trigger().

Referenced by _trigger_wait_think(), and wait_till().

◆ _trigger_wait_think()

function _trigger_wait_think	(	s_tracker	,
		e_entity
	)

Definition at line 1037 of file trigger_shared.gsc.

References _trigger_wait().

Referenced by wait_till().

◆ add_function()

function add_function	(	trigger	,
		str_remove_on	,
		func	,
		param_1	,
		param_2	,
		param_3	,
		param_4	,
		param_5	,
		param_6
	)

Description:
"Function Name: add_function( <str_trig_targetname>, [str_remove_on], <func>, [param_1], [param_2], [param_3], [param_4], [param_5], [param_6] )"
"Summary: Runs a function when a trigger is hit." "Module: Utility" "CallOn: level"
"Mandatory Argument(s): <str_trig_targetname> : targetname of the trigger"
"Optional Argument(s): [str_remove_on] : remove the function on this notify to the trigger"
"Mandatory Argument(s): <func> : pointer to a script function"
"Optional Argument(s): [param_1] : parameter 1 to pass to the func"
"Optional Argument(s): [param_2] : parameter 2 to pass to the func"
"Optional Argument(s): [param_3] : parameter 3 to pass to the func"
"Optional Argument(s): [param_4] : parameter 4 to pass to the func"
"Optional Argument(s): [param_5] : parameter 5 to pass to the func"
"Optional Argument(s): [param_6] : parameter 6 to pass to the func"
"Example:add_function( "my_trigger",&my_trigger_function );"
"Single Player / Multi Player: SP"

Definition at line 1281 of file trigger_shared.gsc.

References _do_trigger_function().

Referenced by __main__().

◆ add_to_ent()

function add_to_ent	(	ent	,
		trig
	)

Definition at line 1480 of file trigger_shared.gsc.

Referenced by function_thread().

◆ add_tokens_to_trigger_flags()

function add_tokens_to_trigger_flags ( tokens )

Definition at line 402 of file trigger_shared.gsc.

Referenced by script_flag_false_trigger(), and script_flag_true_trigger().

◆ check_spawnflags()

function check_spawnflags ( )

Definition at line 131 of file trigger_shared.gsc.

References IS_TRUE, SPAWNFLAG, SPAWNFLAG_TRIGGER_AI_ALLIES, SPAWNFLAG_TRIGGER_AI_AXIS, SPAWNFLAG_TRIGGER_AI_NEUTRAL, SPAWNFLAG_TRIGGER_NOT_PLAYER, and SPAWNFLAG_TRIGGER_VEHICLE.

Referenced by __init__().

◆ delete_link_chain()

function delete_link_chain ( trigger )

Definition at line 1353 of file trigger_shared.gsc.

References delete_links_then_self(), and get_script_linkto_targets().

Referenced by __init__().

◆ delete_links_then_self()

function delete_links_then_self ( )

Definition at line 1362 of file trigger_shared.gsc.

References get_script_linkto_targets().

Referenced by delete_link_chain().

◆ display_hint()

function display_hint ( hint )

Description:
"Function Name: display_hint( <hint> )"
"Summary: Displays a hint created with add_hint_string." "Module: Utility"
"Mandatory Argument(s): <hint> : The hint reference created with add_hint_string."
"Example:display_hint( "huzzah" )"
"Single Player / Multi Player: singleplayer"

Definition at line 678 of file trigger_shared.gsc.

References _hint_print().

Referenced by trigger_hint().

◆ ent_already_in()

function ent_already_in ( trig )

Definition at line 1466 of file trigger_shared.gsc.

Referenced by function_thread().

◆ flag_clear_trigger()

function flag_clear_trigger	(	trigger	,
		str_flag
	)

Definition at line 374 of file trigger_shared.gsc.

References clear(), DEFAULT, exists(), init(), script_delay(), and wait_till().

Referenced by __init__().

◆ flag_set_touching()

function flag_set_touching ( trigger )

Definition at line 575 of file trigger_shared.gsc.

References clear(), init(), and set().

Referenced by __init__().

◆ flag_set_trigger()

function flag_set_trigger	(	trigger	,
		str_flag
	)

Definition at line 346 of file trigger_shared.gsc.

References DEFAULT, exists(), init(), script_delay(), set(), and wait_till().

Referenced by __init__().

◆ friendly_respawn_clear()

function friendly_respawn_clear ( trigger )

Definition at line 462 of file trigger_shared.gsc.

References clear().

Referenced by __init__().

◆ friendly_respawn_trigger()

function friendly_respawn_trigger ( trigger )

Definition at line 432 of file trigger_shared.gsc.

References set().

Referenced by __init__().

◆ function_thread()

function function_thread	(	ent	,
		on_enter_payload	,
		on_exit_payload
	)

Definition at line 1432 of file trigger_shared.gsc.

References add_to_ent(), ent_already_in(), and remove_from_ent().

◆ get_all()

function get_all	(	type1	,
		type2	,
		type3	,
		type4	,
		type5	,
		type6	,
		type7	,
		type8	,
		type9
	)

Description:
"Function Name: get_all(type1, type2, type3, type4, type5, type6, type7, type8, type9)"
"Summary: Gets all triggers on the map. If only want certain types, can specify those" "Module: Level" "CallOn: N/A"
"Optional Argument(s): <type1-9> : Classname of Trigger to get."
"Example:trigs = get_all();"
"Single Player / Multi Player: singleplayer"

Definition at line 802 of file trigger_shared.gsc.

References _is_valid_trigger_type().

Referenced by __init__(), __main__(), and setup_triggers().

◆ get_script_linkto_targets()

function get_script_linkto_targets ( )

Definition at line 1331 of file trigger_shared.gsc.

Referenced by delete_link_chain(), and delete_links_then_self().

◆ get_trigger_look_target()

function get_trigger_look_target ( )

Definition at line 200 of file trigger_shared.gsc.

References ARRAY_ADD, DEFAULT, e_target, get_array(), and IS_EQUAL.

Referenced by trigger_look().

◆ init_flags()

function init_flags ( )

Definition at line 1157 of file trigger_shared.gsc.

Referenced by __init__(), and init().

◆ is_look_trigger()

function is_look_trigger ( trig )

Definition at line 1162 of file trigger_shared.gsc.

References IS_EQUAL, SPAWNFLAG, and SPAWNFLAG_TRIGGER_LOOK.

Referenced by _trigger_wait(), trigger_on_timeout(), trigger_once(), and use().

◆ is_trigger_once()

function is_trigger_once ( trig )

Definition at line 1167 of file trigger_shared.gsc.

References IS_EQUAL, SPAWNFLAG, and SPAWNFLAG_TRIGGER_TRIGGER_ONCE.

Referenced by __init__().

◆ kill_spawner_trigger()

function kill_spawner_trigger ( trigger )

Definition at line 1311 of file trigger_shared.gsc.

References a_ents, IS_EQUAL, and wait_till().

Referenced by __init__().

◆ multiple_wait()

function multiple_wait ( str_trigger_notify )

Definition at line 1256 of file trigger_shared.gsc.

Referenced by multiple_waits().

◆ multiple_waits()

function multiple_waits	(	str_trigger_name	,
		str_trigger_notify
	)

Definition at line 1248 of file trigger_shared.gsc.

References multiple_wait().

◆ no_crouch_or_prone_think()

function no_crouch_or_prone_think ( trigger )

Definition at line 1369 of file trigger_shared.gsc.

References WAIT_SERVER_FRAME.

Referenced by __init__().

◆ no_prone_think()

function no_prone_think ( trigger )

Definition at line 1392 of file trigger_shared.gsc.

References WAIT_SERVER_FRAME.

Referenced by __init__().

◆ remove_from_ent()

function remove_from_ent	(	ent	,
		trig
	)

Definition at line 1490 of file trigger_shared.gsc.

Referenced by function_thread().

◆ report_trigger()

function report_trigger	(	ent	,
		noteworthy
	)

Definition at line 192 of file trigger_shared.gsc.

Referenced by wait_for_an_unlocked_trigger().

◆ script_flag_false_trigger()

function script_flag_false_trigger ( trigger )

Definition at line 416 of file trigger_shared.gsc.

References add_tokens_to_trigger_flags(), create_flags_and_return_tokens(), and update_based_on_flags().

Referenced by __init__().

◆ script_flag_set_touching()

function script_flag_set_touching ( trigger )

Definition at line 492 of file trigger_shared.gsc.

References _detect_touched(), clear(), init(), set(), and WAIT_SERVER_FRAME.

Referenced by __init__().

◆ script_flag_true_trigger()

function script_flag_true_trigger ( trigger )

Definition at line 424 of file trigger_shared.gsc.

References add_tokens_to_trigger_flags(), create_flags_and_return_tokens(), and update_based_on_flags().

Referenced by __init__().

◆ set_flag_permissions()

function set_flag_permissions ( msg )

Definition at line 1104 of file trigger_shared.gsc.

References remove_undefined(), and update_based_on_flags().

Referenced by clear(), and set().

◆ trigger_delete_on_touch()

function trigger_delete_on_touch ( trigger )

Definition at line 562 of file trigger_shared.gsc.

Referenced by __init__().

◆ trigger_exploder()

function trigger_exploder ( trigger )

Definition at line 655 of file trigger_shared.gsc.

Referenced by __init__().

◆ trigger_group()

function trigger_group ( )

Definition at line 1413 of file trigger_shared.gsc.

References trigger_group_remove().

Referenced by __init__().

◆ trigger_group_remove()

function trigger_group_remove ( )

Definition at line 1422 of file trigger_shared.gsc.

Referenced by trigger_group().

◆ trigger_hint()

function trigger_hint ( trigger )

Definition at line 626 of file trigger_shared.gsc.

References display_hint().

Referenced by __init__().

◆ trigger_look()

function trigger_look ( trigger )

Definition at line 230 of file trigger_shared.gsc.

References clear(), e_target, get_trigger_look_target(), init(), is_ads(), is_looking_at(), IS_TRUE, set(), and WAIT_SERVER_FRAME.

Referenced by __init__().

◆ trigger_notify()

function trigger_notify	(	trigger	,
		msg
	)

Description:
"Function Name: trigger_notify()"
"Summary: Sends out a level notify of the trigger's script_notify once triggered" "Module: Trigger" "CallOn: "
"Example:trigger thread trigger_notify(); "
"Single Player / Multi Player: singleplayer"

Definition at line 327 of file trigger_shared.gsc.

References wait_till().

Referenced by __init__().

◆ trigger_on_timeout()

function trigger_on_timeout	(	n_time	,
		b_cancel_on_triggered	= `true`,
		str_name	,
		str_key	= `"targetname"`
	)

Description:
"Function Name: trigger_on_timeout( n_time, b_cancel_on_triggered, str_name, str_key )"
"Summary: Force a trigger to trigger when time passes."
"Mandatory Argument(s): n_time: the amount of time."
"Optional Argument(s): b_cancel_on_triggered: don't trigger the trigger if it gets triggered before the time is up."
"Optional Argument(s): str_name: name of the trigger."
"Optional Argument(s): str_key: KVP key of the trigger."
"Example:trigger::trigger_on_timeout( 5, true, "my_trigger", "targetname" );"

Definition at line 1221 of file trigger_shared.gsc.

References is_look_trigger(), and use().

◆ trigger_once()

function trigger_once ( trig )

Definition at line 598 of file trigger_shared.gsc.

References is_look_trigger().

Referenced by __init__().

◆ trigger_spawner()

function trigger_spawner ( trigger )

Definition at line 290 of file trigger_shared.gsc.

References trigger_spawner_spawn(), and wait_till().

Referenced by __init__().

◆ trigger_spawner_spawn()

function trigger_spawner_spawn ( )

Definition at line 308 of file trigger_shared.gsc.

References script_delay(), script_flag_wait(), and spawn().

Referenced by trigger_spawner().

◆ trigger_turns_off()

function trigger_turns_off ( trigger )

Definition at line 474 of file trigger_shared.gsc.

References wait_till().

Referenced by __init__().

◆ trigger_unlock()

function trigger_unlock ( trigger )

Definition at line 144 of file trigger_shared.gsc.

References trigger_unlock_death(), and wait_for_an_unlocked_trigger().

Referenced by __init__().

◆ trigger_unlock_death()

function trigger_unlock_death ( target )

Definition at line 173 of file trigger_shared.gsc.

Referenced by trigger_unlock().

◆ update_based_on_flags()

function update_based_on_flags ( )

Definition at line 1118 of file trigger_shared.gsc.

References create_flags_and_return_tokens(), and get().

Referenced by script_flag_false_trigger(), script_flag_true_trigger(), and set_flag_permissions().

◆ use()

function use	(	str_name	,
		str_key	= `"targetname"`,
		ent	,
		b_assert	= `true`
	)

Description:
"Function Name: use( <str_name> , [str_key], [ent], [b_assert] )"
"Summary: Activates a trigger with the specified key / value is triggered" "Module: Trigger" "CallOn: "
"Mandatory Argument(s): <str_name> : Name of the key on this trigger. If name is not passed in, func will check against self"
"Optional Argument(s): [str_key] : Key on the trigger to use, example: "targetname" or "script_noteworthy""
"Optional Argument(s): [ent] : Entity that the trigger is used by"
"Optional Argument(s): [b_assert] : Set to false to not assert if the trigger doesn't exist"
"Example:use( "player_in_building1, "targetname", enemy, false );" <br/>"Single Player / Multi Player: singleplayer"

Definition at line 1059 of file trigger_shared.gsc.

References is_look_trigger().

Referenced by has_key_object(), trigger_on_timeout(), and turret_owner_power_callback().

◆ wait_for_an_unlocked_trigger()

function wait_for_an_unlocked_trigger	(	triggers	,
		noteworthy
	)

Definition at line 180 of file trigger_shared.gsc.

References report_trigger().

Referenced by trigger_unlock().

◆ wait_for_either()

function wait_for_either	(	str_targetname1	,
		str_targetname2
	)

Definition at line 1172 of file trigger_shared.gsc.

References _ent_waits_for_trigger(), and array.

◆ wait_or_timeout()

function wait_or_timeout	(	n_time	,
		str_name	,
		str_key
	)

Description:
"Function Name: wait_or_timeout( n_time, str_name, str_key )"
"Summary: Wait for a trigger to trigger or time passes."
"Mandatory Argument(s): n_time: the amount of time."
"Optional Argument(s): str_name: name of the trigger."
"Optional Argument(s): str_key: KVP key of the trigger."
"Example:trigger::wait_or_timeout( 5, "my_trigger", "targetname" );"

Definition at line 1205 of file trigger_shared.gsc.

References TIMEOUT, and wait_till().

◆ wait_till()

function wait_till	(	str_name	,
		str_key	= `"targetname"`,
		e_entity	,
		b_assert	= `true`
	)

Description:
function Name: wait_till( <str_name> , str_key = "targetname", e_entity ) Summary: Waits until a trigger with the specified key / value is triggered. Returns the trigger and assigns the entity that triggered it to "trig.who". Module: Trigger MandatoryArg: str_name: Key value. OptionalArg: str_key: Key name on the trigger to use, example: "targetname" or "script_noteworthy". OptionalArg: e_entity: Wait for a specific entity to trigger the trigger.
"Optional Argument(s): <b_assert> : Set to false to not assert if the trigger doesn't exist" function Example: wait_till( "player_in_building1, "script_noteworthy" ); SPMP: both

Definition at line 911 of file trigger_shared.gsc.

References _trigger_wait(), _trigger_wait_think(), and IS_BONUSZM.

Referenced by _do_trigger_function(), _ent_waits_for_trigger(), flag_clear_trigger(), flag_set_trigger(), kill_spawner_trigger(), trigger_notify(), trigger_spawner(), trigger_turns_off(), and wait_or_timeout().

Functions

Function Documentation

◆ __init__()

◆ _detect_touched()

◆ _do_trigger_function()

◆ _ent_waits_for_trigger()

◆ _hint_print()

◆ _hint_print_wait()

◆ _is_valid_trigger_type()

◆ _trigger_wait()

◆ _trigger_wait_think()

◆ add_function()

◆ add_to_ent()

◆ add_tokens_to_trigger_flags()

◆ check_spawnflags()

◆ delete_link_chain()

◆ delete_links_then_self()

◆ display_hint()

◆ ent_already_in()

◆ flag_clear_trigger()

◆ flag_set_touching()

◆ flag_set_trigger()

◆ friendly_respawn_clear()

◆ friendly_respawn_trigger()

◆ function_thread()

◆ get_all()

◆ get_script_linkto_targets()

◆ get_trigger_look_target()

◆ init_flags()

◆ is_look_trigger()

◆ is_trigger_once()

◆ kill_spawner_trigger()

◆ multiple_wait()

◆ multiple_waits()

◆ no_crouch_or_prone_think()

◆ no_prone_think()

◆ remove_from_ent()

◆ report_trigger()

◆ script_flag_false_trigger()

◆ script_flag_set_touching()

◆ script_flag_true_trigger()

◆ set_flag_permissions()

◆ trigger_delete_on_touch()

◆ trigger_exploder()

◆ trigger_group()

◆ trigger_group_remove()

◆ trigger_hint()

◆ trigger_look()

◆ trigger_notify()

◆ trigger_on_timeout()

◆ trigger_once()

◆ trigger_spawner()

◆ trigger_spawner_spawn()

◆ trigger_turns_off()

◆ trigger_unlock()

◆ trigger_unlock_death()

◆ update_based_on_flags()

◆ use()

◆ wait_for_an_unlocked_trigger()

◆ wait_for_either()

◆ wait_or_timeout()

◆ wait_till()

◆ init()