Functions
function	clear (str_flag)

function	delete (str_flag)

function	get (str_flag)

function	script_flag_wait ()

function	set (str_flag)

function	set_for_time (n_time, str_flag)

function	set_val (str_flag, b_val)

function	toggle (str_flag)

function	wait_till (str_flag)

function	wait_till_all (a_flags)

function	wait_till_all_timeout (n_timeout, a_flags)

function	wait_till_any (a_flags)

function	wait_till_any_timeout (n_timeout, a_flags)

function	wait_till_clear (str_flag)

function	wait_till_clear_all (a_flags)

function	wait_till_clear_all_timeout (n_timeout, a_flags)

function	wait_till_clear_any (a_flags)

function	wait_till_clear_any_timeout (n_timeout, a_flags)

function	wait_till_clear_timeout (n_timeout, str_flag)

function	wait_till_timeout (n_timeout, str_flag)

Function Documentation

◆ clear()

function clear ( str_flag )

Description:
"Function Name: clear( <str_flag> )"
"Summary: Clears the specified str_flag on self." "Module: Flag" "CallOn: Any entity (script_origin, script_struct, ai, script_model, script_brushmodel, player)"
"Mandatory Argument(s): <str_flag> : name of the str_flag to clear"
"Example:enemy clear( "hq_cleared" );"
"Single Player / Multi Player: singleplayer"

Definition at line 67 of file flagsys_shared.gsc.

References IS_TRUE.

Referenced by delete(), set_for_time(), and set_val().

◆ delete()

function delete ( str_flag )

Description:
"Function Name: delete( <flagname> )"
"Summary: delete a flag that has been inited to free vars" "Module: Flag" "CallOn: "
"Mandatory Argument(s): <flagname> : name of the flag to create"
"Example:flag::delete( "hq_cleared" );"
"Single Player / Multi Player: SP"

Definition at line 260 of file flagsys_shared.gsc.

References clear().

◆ get()

function get ( str_flag )

Description:
"Function Name: get( <str_flag> )"
"Summary: Checks if the str_flag is set on self. Returns true or false." "Module: Flag" "CallOn: Any entity (script_origin, script_struct, ai, script_model, script_brushmodel, player)"
"Mandatory Argument(s): <str_flag> : name of the str_flag to check"
"Example:enemy get( "death" );"
"Single Player / Multi Player: singleplayer"

Definition at line 114 of file flagsys_shared.gsc.

References IS_TRUE.

Referenced by toggle(), wait_till(), wait_till_all(), wait_till_any(), wait_till_clear(), wait_till_clear_all(), and wait_till_clear_any().

◆ script_flag_wait()

function script_flag_wait ( )

Definition at line 265 of file flagsys_shared.gsc.

References wait_till().

◆ set()

function set ( str_flag )

Description:
"Function Name: set( <str_flag> )"
"Summary: Sets the specified str_flag on self, all scripts using wait on self will now continue." "Module: Flag" "CallOn: Any entity (script_origin, script_struct, ai, script_model, script_brushmodel, player)"
"Mandatory Argument(s): <str_flag> : name of the str_flag to set"
"Example:enemy set( "hq_cleared" );"
"Single Player / Multi Player: singleplayer"

Definition at line 25 of file flagsys_shared.gsc.

Referenced by set_for_time(), set_val(), and toggle().

◆ set_for_time()

function set_for_time	(	n_time	,
		str_flag
	)

Description:
"Function Name: set_for_time( <n_time>, <str_flag> )"
"Summary: Sets the specified flag, all scripts using flag_wait will now continue." "Module: Flag" "CallOn: "
"Mandatory Argument(s): <n_time> : time to set the flag for"
"Mandatory Argument(s): <str_flag> : name of the flag to set"
"Example:flag::set_for_time( 2, "hq_cleared" );"
"Single Player / Multi Player: both"

Definition at line 47 of file flagsys_shared.gsc.

References clear(), and set().

◆ set_val()

function set_val	(	str_flag	,
		b_val
	)

Definition at line 76 of file flagsys_shared.gsc.

References clear(), and set().

◆ toggle()

function toggle ( str_flag )

Description:
"Function Name: toggle( <str_flag> )"
"Summary: Toggles the specified ent str_flag." "Module: Flag"
"Mandatory Argument(s): <str_flag> : name of the str_flag to toggle"
"Example:toggle( "hq_cleared" );"
"Single Player / Multi Player: SP"

Definition at line 99 of file flagsys_shared.gsc.

References get(), and set().

◆ wait_till()

function wait_till ( str_flag )

Description:
"Function Name: wait( <str_flag> )"
"Summary: Waits until the specified str_flag is set on self. Even handles some default flags for ai such as 'goal' and 'damage'" "Module: Flag" "CallOn: Any entity (script_origin, script_struct, ai, script_model, script_brushmodel, player)"
"Mandatory Argument(s): <str_flag> : name of the str_flag to wait on"
"Example:enemy wait( "goal" );"
"Single Player / Multi Player: singleplayer"

Definition at line 129 of file flagsys_shared.gsc.

References get().

Referenced by script_flag_wait(), and wait_till_timeout().