Data Structures
class	cSceneObject

Macros
#define	NEW_STATE(__state)

#define	TRANSITION_FILTER_INDEX 5

#define	TRANSITION_STREAMER_TIMEOUT 5000

#define	TRANSITION_TIME 2000

#define	TRANSITION_TIME_SHORT 850

Functions
function	__init__ ()

function	__main__ ()

function	_call_state_funcs (str_state)

function	_get_type_count (str_type, str_scenedef)

function	_has_init_state ()

function	_init_instance (str_scenedef, a_ents, b_test_run=false)

function	_play_instance (s_tracker, str_scenedef, a_ents, b_test_run, str_mode)

function	_stop_instance (b_clear=false, str_scenedef, b_cancel=false)

function	_trigger_init (trig)

function	_trigger_play (trig)

function	_trigger_stop (trig)

function	add_scene_func (str_scenedef, func, str_state="play",...)

function	allows_multiple ()

function	cancel (arg1, arg2, arg3)

function	cf_server_sync (localClientNum, oldVal, newVal, bNewEnt, bInitialSnap, fieldName, bWasTimeJump)

	constructor ()

	destructor ()

function	get_active_scene (str_scenedef)

function	get_active_scenes (str_scenedef)

function	get_actor_count (str_scenedef)

function	get_align_ent (clientNum)

function	get_ents ()

function	get_existing_ent (clientNum, str_name)

function	get_object_id ()

function	get_player_count (str_scenedef)

function	get_prop_count (str_scenedef)

function	get_root ()

function	get_scenedef (str_scenedef)

function	get_scenedefs (str_type="scene")

function	get_state ()

function	get_valid_object_defs ()

function	get_valid_objects ()

function	get_vehicle_count (str_scenedef)

function	has_init_state ()

function	has_init_state (str_scenedef)

function	in_igc (localClientNum, oldVal, newVal, bNewEnt, bInitialSnap, fieldName, bWasTimeJump)

function	init (arg1, arg2, arg3, b_test_run)

function	init (str_scenedef, s_scenedef, e_align, a_ents, b_test_run)

function	initialize (b_playing=false)

function	is_active (str_scenedef)

function	is_capture_mode ()

function	is_igc ()

function	is_looping ()

function	is_playing (str_scenedef)

function	on_error ()

function private	on_localplayer_shutdown (localClientNum)

function	play (arg1, arg2, arg3, b_test_run=false, str_mode="")

function	play (b_testing=false, str_mode="")

function	player_scene_animation_skip (localClientNum, oldVal, newVal, bNewEnt, bInitialSnap, fieldName, bWasTimeJump)

function	player_scene_skip_completed (localClientNum, oldVal, newVal, bNewEnt, bInitialSnap, fieldName, bWasTimeJump)

function	postfx_igc (localClientNum, oldVal, newVal, bNewEnt, bInitialSnap, fieldName, bWasTimeJump)

function	postfx_igc_short (localClientNum, oldVal, newVal, bNewEnt, bInitialSnap, fieldName, bWasTimeJump)

function	postfx_igc_zombies (localClientNum)

function	remove_invalid_scene_objects (s_scenedef)

function	remove_scene_func (str_scenedef, func, str_state="play")

function	run_next ()

function	spawn (arg1, arg2, arg3, arg4, b_test_run)

function	stop (arg1, arg2, arg3, b_cancel, b_no_assert=false)

function	stop (b_clear=false, b_finished=false)

function	wait_till_scene_done ()

function	wait_till_scene_ready ()

function private	waittill_instance_scene_done (str_scenedef)

function private	waittill_scene_done (s_tracker)

Variables
cSceneObject	_e_root

var	_n_object_id

var	_str_mode

var	_str_state

Macro Definition Documentation

◆ NEW_STATE

#define NEW_STATE ( __state )

Value:

    ‪flagsys::clear( "ready" );\
‪	flagsys::clear( "done" );\
‪	flagsys::clear( "main_done" );\
    self notify( "new_state" );\
    self endon( "new_state" );\
    self notify(__state);\
    waittillframeend;

Definition at line 24 of file scene_shared.csc.

◆ TRANSITION_FILTER_INDEX

#define TRANSITION_FILTER_INDEX 5

Definition at line 1125 of file scene_shared.csc.

◆ TRANSITION_STREAMER_TIMEOUT

#define TRANSITION_STREAMER_TIMEOUT 5000

Definition at line 1127 of file scene_shared.csc.

◆ TRANSITION_TIME

#define TRANSITION_TIME 2000

Definition at line 1126 of file scene_shared.csc.

◆ TRANSITION_TIME_SHORT

#define TRANSITION_TIME_SHORT 850

Definition at line 1128 of file scene_shared.csc.

Function Documentation

◆ init()

function __init__ ( )

Definition at line 1058 of file scene_shared.csc.

References CF_CALLBACK_ZERO_ON_NEW_ENT, CF_HOST_ONLY, cf_server_sync(), get_script_bundles(), in_igc(), is_igc(), on_localclient_shutdown(), on_localplayer_shutdown(), player_scene_animation_skip(), player_scene_skip_completed(), postfx_igc(), register(), and VERSION_SHIP.

◆ main()

function __main__ ( )

Definition at line 1502 of file scene_shared.csc.

References get_array(), get_script_bundle(), init(), play(), SPAWNFLAG, SPAWNFLAG_SCRIPTBUNDLE_INIT, and SPAWNFLAG_SCRIPTBUNDLE_PLAY.

◆ _call_state_funcs()

function _call_state_funcs ( str_state )

Definition at line 868 of file scene_shared.csc.

References _e_root, _str_name, a_ents, get_ents(), and wait_till_scene_ready().

Referenced by initialize(), play(), and stop().

◆ _get_type_count()

function _get_type_count	(	str_type	,
		str_scenedef
	)

Definition at line 2284 of file scene_shared.csc.

References get_scenedef().

Referenced by get_actor_count(), get_player_count(), get_prop_count(), and get_vehicle_count().

◆ _has_init_state()

function _has_init_state ( )

Definition at line 2195 of file scene_shared.csc.

References IS_TRUE.

Referenced by cSceneObject::has_init_state(), and has_init_state().

◆ _init_instance()

function _init_instance	(	str_scenedef	,
		a_ents	,
		b_test_run	= `false`
	)

Definition at line 1846 of file scene_shared.csc.

References a_ents, DEFAULT, get_active_scene(), and get_scenedef().

Referenced by _play_instance(), _trigger_init(), and init().

◆ _play_instance()

function _play_instance	(	s_tracker	,
		str_scenedef	,
		a_ents	,
		b_test_run	,
		str_mode
	)

Definition at line 2009 of file scene_shared.csc.

References _init_instance(), a_ents, DEFAULT, get_scenedef(), IS_TRUE, and waittill_instance_scene_done().

Referenced by _trigger_play(), and play().

◆ _stop_instance()

function _stop_instance	(	b_clear	= `false`,
		str_scenedef	,
		b_cancel	= `false`
	)

Definition at line 2160 of file scene_shared.csc.

Referenced by _trigger_stop(), and stop().

◆ _trigger_init()

function _trigger_init ( trig )

Definition at line 1588 of file scene_shared.csc.

References _init_instance().

◆ _trigger_play()

function _trigger_play ( trig )

Definition at line 1595 of file scene_shared.csc.

References _play_instance(), get_scenedef(), and IS_TRUE.

◆ _trigger_stop()

function _trigger_stop ( trig )

Definition at line 1607 of file scene_shared.csc.

References _stop_instance().

◆ add_scene_func()

function add_scene_func	(	str_scenedef	,
		func	,
		str_state	= `"play"`,
			...
	)

Description:

"Summary: Adds a function to be called when a scene starts"
"Single Player / Multi Player: shared"

"Function Name: add_scene_func( str_scenedef, func, str_state = "play" )" "CallOn: level"
"Mandatory Argument(s): <str_scenedef> Name of scene"
"Mandatory Argument(s): <func> function to call when scene starts"
"Optional Argument(s): [str_state] set to "init" or "done" if you want to the function to get called in one of those states"

"Example:level scene::init( "my_scenes", "targetname" );"

Definition at line 1628 of file scene_shared.csc.

References ARRAY_ADD, DEFAULT, and get_scenedef().

Referenced by addEpicSceneFunc(), and main().

◆ allows_multiple()

function allows_multiple ( )

Definition at line 972 of file scene_shared.csc.

References _s, and IS_TRUE.

Referenced by cSceneObject::_assign_unique_name(), and run_next().

◆ cancel()

function cancel	(	arg1	,
		arg2	,
		arg3
	)

Definition at line 2176 of file scene_shared.csc.

References stop().

◆ cf_server_sync()

function cf_server_sync	(	localClientNum	,
		oldVal	,
		newVal	,
		bNewEnt	,
		bInitialSnap	,
		fieldName	,
		bWasTimeJump
	)

Definition at line 1448 of file scene_shared.csc.

References init(), is_active(), play(), and stop().

Referenced by __init__().

◆ constructor()

constructor ( )

Definition at line 583 of file scene_shared.csc.

References _n_object_id, and _str_state.

◆ destructor()

destructor ( )

Definition at line 589 of file scene_shared.csc.

◆ get_active_scene()

function get_active_scene ( str_scenedef )

Definition at line 2376 of file scene_shared.csc.

References get_name().

Referenced by _init_instance(), is_active(), and is_playing().

◆ get_active_scenes()

function get_active_scenes ( str_scenedef )

Definition at line 2356 of file scene_shared.csc.

References DEFAULT.

Referenced by is_active(), play(), and stop().

◆ get_actor_count()

function get_actor_count ( str_scenedef )

Description:

"Summary: returns the number of actors defined for a scene"
"Single Player / Multi Player: shared"

"Function Name: get_actor_count( str_scenedef )" "CallOn: Any"
"Mandatory Argument(s): <str_scenedef> scene definition name (from gdt)"
"Example:level scene::get_actor_count( "my_scene" );"

"Function Name: get_actor_count()" "CallOn: scene object"
"Example:s_scene scene::get_actor_count();"

Definition at line 2258 of file scene_shared.csc.

References _get_type_count().

◆ get_align_ent()

function get_align_ent ( clientNum )

Definition at line 956 of file scene_shared.csc.

References _e_root, _s, and get_existing_ent().

◆ get_ents()

function get_ents ( )

Definition at line 922 of file scene_shared.csc.

References _a_objects, a_ents, and ARRAY_ADD.

Referenced by _call_state_funcs(), and run_next().

◆ get_existing_ent()

function get_existing_ent	(	clientNum	,
		str_name
	)

Definition at line 1029 of file scene_shared.csc.

References get().

Referenced by cSceneObject::_spawn(), cSceneObject::get_align_ent(), and get_align_ent().

◆ get_object_id()

function get_object_id ( )

Definition at line 701 of file scene_shared.csc.

References _n_object_id.

◆ get_player_count()

function get_player_count ( str_scenedef )

Description:

"Summary: returns the number of actors defined for a scene"
"Single Player / Multi Player: shared"

"Function Name: get_player_count( str_scenedef )" "CallOn: Any"
"Mandatory Argument(s): <str_scenedef> scene definition name (from gdt)"
"Example:level scene::get_player_count( "my_scene" );"

"Function Name: get_player_count()" "CallOn: scene object"
"Example:s_scene scene::get_player_count();"

Definition at line 2279 of file scene_shared.csc.

References _get_type_count().

◆ get_prop_count()

function get_prop_count ( str_scenedef )

Description:

"Summary: returns the number of props defined for a scene"
"Single Player / Multi Player: shared"

"Function Name: get_prop_count( str_scenedef )" "CallOn: Any"
"Mandatory Argument(s): <str_scenedef> scene definition name (from gdt)"
"Example:level scene::get_prop_count( "my_scene" );"

"Function Name: get_prop_count()" "CallOn: scene object"
"Example:s_scene scene::get_prop_count();"

Definition at line 2216 of file scene_shared.csc.

References _get_type_count().

◆ get_root()

function get_root ( )

Definition at line 951 of file scene_shared.csc.

References _e_root.

◆ get_scenedef()

function get_scenedef ( str_scenedef )

Definition at line 1826 of file scene_shared.csc.

References get_script_bundle().

Referenced by _get_type_count(), _init_instance(), _play_instance(), _trigger_play(), add_scene_func(), has_init_state(), and remove_scene_func().

◆ get_scenedefs()

function get_scenedefs ( str_type = "scene" )

Definition at line 1831 of file scene_shared.csc.

References ARRAY_ADD, and get_script_bundles().

◆ get_state()

function get_state ( )

Definition at line 1015 of file scene_shared.csc.

References _str_state.

◆ get_valid_object_defs()

function get_valid_object_defs ( )

Definition at line 656 of file scene_shared.csc.

References _s, ARRAY_ADD, and IS_TRUE.

Referenced by init().

◆ get_valid_objects()

function get_valid_objects ( )

Definition at line 995 of file scene_shared.csc.

References _a_objects, and ARRAY_ADD.

Referenced by initialize(), and play().

◆ get_vehicle_count()

function get_vehicle_count ( str_scenedef )

Description:

"Summary: returns the number of vehicles defined for a scene"
"Single Player / Multi Player: shared"

"Function Name: get_vehicle_count( str_scenedef )" "CallOn: Any"
"Mandatory Argument(s): <str_scenedef> scene definition name (from gdt)"
"Example:level scene::get_vehicle_count( "my_scene" );"

"Function Name: get_vehicle_count()" "CallOn: scene object"
"Example:s_scene scene::get_vehicle_count();"

Definition at line 2237 of file scene_shared.csc.

References _get_type_count().

◆ has_init_state() [1/2]

function has_init_state ( )

Definition at line 852 of file scene_shared.csc.

References _a_objects.

Referenced by play(), and run_next().

◆ has_init_state() [2/2]

function has_init_state ( str_scenedef )

Definition at line 2181 of file scene_shared.csc.

References _has_init_state(), get_scenedef(), and IS_TRUE.

◆ in_igc()

function in_igc	(	localClientNum	,
		oldVal	,
		newVal	,
		bNewEnt	,
		bInitialSnap	,
		fieldName	,
		bWasTimeJump
	)

Definition at line 1106 of file scene_shared.csc.

Referenced by __init__().

◆ init() [1/2]

function init	(	arg1	,
		arg2	,
		arg3	,
		b_test_run
	)

Description:

"Summary: Initializes a scene or multiple scenes"
"Single Player / Multi Player: shared"

"Function Name: init( str_val, str_key, ents )" "CallOn: level using KVP to specify the scene instances"
"Mandatory Argument(s): <str_val> value of the KVP of the scene entity"
"Mandatory Argument(s): <str_key> key of the KVP of the scene entity"
"Optional Argument(s): [clientNum][ents] override the entities used for this scene"
"Example:level scene::init( "my_scenes", "targetname" );"

"Function Name: init( str_scenedef, ents )" "CallOn: level"
"Mandatory Argument(s): <str_scenedef> specify the scene name, will play all instances of this scene"
"Optional Argument(s): [clientNum][ents] override the entities used for this scene"
"Example:level scene::init( "level1_scene_3" );"

"Function Name: init( str_scenedef, ents )" "CallOn: Any entity (script_origin, script_struct, ai, script_model, script_brushmodel, player)"
"Optional Argument(s): [str_scenedef] specify the scene name if needed"
"Optional Argument(s): [clientNum][ents] override the entities used for this scene"
"Example:e_scene_root scene::init( "level1_scene_3" );"

"Function Name: init( ents, str_scenedef )" "CallOn: Any entity (script_origin, script_struct, ai, script_model, script_brushmodel, player)"
"Optional Argument(s): [clientNum][ents] override the entities used for this scene"
"Optional Argument(s): [str_scenedef] specify the scene name if needed"
"Example:s_scene_object scene::init( array( e_guy1, e_guy2 ) );"

Definition at line 1760 of file scene_shared.csc.

References _init_instance(), a_ents, and get_array().

◆ init() [2/2]

function init	(	str_scenedef	,
		s_scenedef	,
		e_align	,
		a_ents	,
		b_test_run
	)

Definition at line 593 of file scene_shared.csc.

References _e_root, _s, _str_name, a_ents, add_object(), ARRAY_ADD, error(), get_valid_object_defs(), initialize(), IS_EQUAL, MAKE_ARRAY, and STR.

Referenced by __main__(), cf_server_sync(), run_next(), and spawn().

◆ initialize()

function initialize ( b_playing = false )

Definition at line 675 of file scene_shared.csc.

References _a_objects, _call_state_funcs(), _str_name, _str_state, get_valid_objects(), set(), stop(), and wait_till_scene_done().

Referenced by init(), and play().

◆ is_active()

function is_active ( str_scenedef )

Description:

"Summary: Checks if a scene is playing"
"Single Player / Multi Player: shared"

"Function Name: is_active( str_scenedef )" "CallOn: level or a scene instance"
"Optional Argument(s): [str_scenedef] The name of the scene to check"
"Example:level scene::is_active( "my_scene" );"
"Example:s_scene scene::is_active();"

Definition at line 2314 of file scene_shared.csc.

References get_active_scene(), and get_active_scenes().

Referenced by cf_server_sync(), has_weapon_or_upgrade(), and pack_a_punch_machine_trigger_think().

◆ is_capture_mode()

function is_capture_mode ( )

Definition at line 2390 of file scene_shared.csc.

◆ is_igc()

function is_igc ( )

Definition at line 1493 of file scene_shared.csc.

Referenced by __init__().

◆ is_looping()

function is_looping ( )

Definition at line 977 of file scene_shared.csc.

References _s, and IS_TRUE.

Referenced by play(), and player_scene_animation_skip().

◆ is_playing()

function is_playing ( str_scenedef )

Description:

"Summary: Checks if a scene is playing"
"Single Player / Multi Player: shared"

"Function Name: is_playing( str_scenedef )"
"Optional Argument(s): [str_scenedef] The name of the scene to check"
"Example:s_scene scene::is_playing( "my_scene" );"
"Example:s_scene scene::is_playing();"

Definition at line 2336 of file scene_shared.csc.

References DEFAULT, get(), get_active_scene(), and IS_EQUAL.

◆ on_error()

function on_error ( )

Definition at line 1010 of file scene_shared.csc.

References stop().

◆ on_localplayer_shutdown()

function private on_localplayer_shutdown ( localClientNum )

Definition at line 1130 of file scene_shared.csc.

References disable_filter_base_frame_transition(), disable_filter_frame_transition(), disable_filter_sprite_transition(), and TRANSITION_FILTER_INDEX.

Referenced by __init__().

◆ play() [1/2]

function play	(	arg1	,
		arg2	,
		arg3	,
		b_test_run	= `false`,
		str_mode	= `""`
	)

Description:

"Summary: Plays a scene or multiple scenes"
"Single Player / Multi Player: shared"

"Function Name: play( str_val, str_key, ents )" "CallOn: level using KVP to specify the scene instances"
"Mandatory Argument(s): <str_val> value of the KVP of the scene entity"
"Mandatory Argument(s): <str_key> key of the KVP of the scene entity"
"Optional Argument(s): [clientNum][ents] override the entities used for this scene"
"Example:level scene::play( "my_scenes", "targetname" );"

"Function Name: play( str_scenedef, ents )" "CallOn: level"
"Mandatory Argument(s): <str_scenedef> specify the scene name, will play all instances of this scene"
"Optional Argument(s): [clientNum][ents] override the entities used for this scene"

"Example:level scene::play( "level1_scene_3" );"

"Function Name: play( str_scenedef, ents )" "CallOn: Any entity (script_origin, script_struct, ai, script_model, script_brushmodel, player)"
"Optional Argument(s): [str_scenedef] specify the scene name if needed"
"Optional Argument(s): [clientNum][ents] override the entities used for this scene"

"Example:e_scene_root scene::play( "level1_scene_3" );"

"Function Name: play( ents, str_scenedef )" "CallOn: Any entity (script_origin, script_struct, ai, script_model, script_brushmodel, player)"
"Optional Argument(s): [clientNum][ents] override the entities used for this scene"
"Optional Argument(s): [str_scenedef] specify the scene name if needed"
"Example:s_scene_object scene::play( array( e_guy1, e_guy2 ) );"

Definition at line 1913 of file scene_shared.csc.

References _play_instance(), a_ents, get_active_scenes(), get_array(), and waittill_scene_done().

◆ play() [2/2]

function play	(	b_testing	= `false`,
		str_mode	= `""`
	)

Definition at line 707 of file scene_shared.csc.

References _a_objects, _call_state_funcs(), _e_root, _str_mode, _str_name, _str_state, _testing, clear(), get_valid_objects(), has_init_state(), initialize(), is_looping(), run_next(), set(), stop(), wait_till_scene_done(), and wait_till_scene_ready().

Referenced by __main__(), cSceneObject::_play_anim(), cf_server_sync(), and run_next().

◆ player_scene_animation_skip()

function player_scene_animation_skip	(	localClientNum	,
		oldVal	,
		newVal	,
		bNewEnt	,
		bInitialSnap	,
		fieldName	,
		bWasTimeJump
	)

Definition at line 33 of file scene_shared.csc.

References is_looping().

Referenced by __init__().

◆ player_scene_skip_completed()

function player_scene_skip_completed	(	localClientNum	,
		oldVal	,
		newVal	,
		bNewEnt	,
		bInitialSnap	,
		fieldName	,
		bWasTimeJump
	)

Definition at line 48 of file scene_shared.csc.

Referenced by __init__().

◆ postfx_igc()

function postfx_igc	(	localClientNum	,
		oldVal	,
		newVal	,
		bNewEnt	,
		bInitialSnap	,
		fieldName	,
		bWasTimeJump
	)

Definition at line 1145 of file scene_shared.csc.

Referenced by __init__().

◆ postfx_igc_short()

function postfx_igc_short	(	localClientNum	,
		oldVal	,
		newVal	,
		bNewEnt	,
		bInitialSnap	,
		fieldName	,
		bWasTimeJump
	)

Definition at line 1394 of file scene_shared.csc.

References CLIENT_FRAME, disable_filter_base_frame_transition(), disable_filter_frame_transition(), disable_filter_sprite_transition(), enable_filter_base_frame_transition(), enable_filter_frame_transition(), enable_filter_sprite_transition(), init_filter_base_frame_transition(), init_filter_frame_transition(), init_filter_sprite_transition(), set_filter_frame_transition_iris(), TRANSITION_FILTER_INDEX, TRANSITION_TIME_SHORT, and WAIT_CLIENT_FRAME.

Referenced by postfx_igc().

◆ postfx_igc_zombies()

function postfx_igc_zombies ( localClientNum )

Definition at line 1383 of file scene_shared.csc.

References screen_fade_in(), screen_fade_out(), and WAIT_CLIENT_FRAME.

Referenced by postfx_igc().

◆ remove_invalid_scene_objects()

function remove_invalid_scene_objects ( s_scenedef )

Definition at line 1473 of file scene_shared.csc.

References ARRAY_ADD.

◆ remove_scene_func()

function remove_scene_func	(	str_scenedef	,
		func	,
		str_state	= `"play"`
	)

Description:

"Summary: Removes a function to be called when a scene starts"
"Single Player / Multi Player: shared"

"Function Name: remove_scene_func( str_scenedef, func, str_state = "play" )" "CallOn: level"
"Mandatory Argument(s): <str_scenedef> Name of scene"
"Mandatory Argument(s): <func> function to remove"
"Optional Argument(s): [str_state] set to "init" or "done" if you want to the function to get removed from one of those states"
"Example:level scene::init( "my_scenes", "targetname" );"

Definition at line 1652 of file scene_shared.csc.

References DEFAULT, and get_scenedef().

◆ run_next()

function run_next ( )

Definition at line 769 of file scene_shared.csc.

References _e_root, _s, allows_multiple(), error(), get_ents(), has_init_state(), init(), IS_EQUAL, and play().

Referenced by play().

◆ spawn()

function spawn	(	arg1	,
		arg2	,
		arg3	,
		arg4	,
		b_test_run
	)

Description:

"Summary: Spawns a scene"
"Single Player / Multi Player: shared"

"Function Name: spawn( str_scenedef, v_origin, v_angles, ents )" "CallOn: NA "Mandatory Argument(s): <str_scenedef> Name of scene to spawn" "Optional Argument(s): [v_origin] The origin to spawn the scene at - defaults to (0, 0, 0)" "Optional Argument(s): [v_angles] The angles to spawn the scene at - defaults to (0, 0, 0)" "Optional Argument(s): [clientNum[a_ents] Entities to use for the scene" "Example:level scene::spawn( "my_scene", (99, 45, 156) );"

"Function Name: spawn( str_scenedef, ents, v_origin, v_angles )" "CallOn: NA "Mandatory Argument(s): <str_scenedef> Name of scene to spawn" "Optional Argument(s): [clientNum[a_ents] Entities to use for the scene" "Optional Argument(s): [v_origin] The origin to spawn the scene at - defaults to (0, 0, 0)" "Optional Argument(s): [v_angles] The angles to spawn the scene at - defaults to (0, 0, 0)" "Example:level scene::spawn( "my_scene", array( my_ent1, my_ent2 ) );"

Definition at line 1695 of file scene_shared.csc.

References a_ents, and init().

◆ stop() [1/2]

function stop	(	arg1	,
		arg2	,
		arg3	,
		b_cancel	,
		b_no_assert	= `false`
	)

Description:

"Summary: Stops a scene or multiple scenes"
"Single Player / Multi Player: shared"

"Function Name: stop( str_val, str_key, b_clear )" "CallOn: level using KVP to specify the scene instances"
"Mandatory Argument(s): <str_val> value of the KVP of the scene entity"
"Mandatory Argument(s): <str_key> key of the KVP of the scene entity"
"Optional Argument(s): [b_clear] optionally delete the ents if they were spawned by the scene, regardless of options in scene definition"

"Example:level scene::stop( "my_scenes", "targetname" );"

"Function Name: stop( str_scenedef, b_clear )" "CallOn: level"
"Mandatory Argument(s): <str_scenedef> specify the scene name, will stop all instances of this scene"
"Optional Argument(s): [b_clear] optionally delete the ents if they were spawned by the scene, regardless of options in scene definition"
"Example:level scene::stop( "level1_scene_3" );"

"Function Name: stop( str_scenedef, b_clear )" "CallOn: Any entity (script_origin, script_struct, ai, script_model, script_brushmodel, player)"
"Optional Argument(s): [str_scenedef] specify the scene name if multiple scenes are running on the entity"
"Optional Argument(s): [b_clear] optionally delete the ents if they were spawned by the scene, regardless of options in scene definition"
"Example:e_my_scene scene::stop( "level1_scene_3" );"

"Function Name: stop( b_clear, str_scenedef )" "CallOn: Any entity (script_origin, script_struct, ai, script_model, script_brushmodel, player)"
"Optional Argument(s): [b_clear] optionally delete the ents if they were spawned by the scene, regardless of options in scene definition"
"Optional Argument(s): [str_scenedef] specify the scene name if multiple scenes are running on the entity"
"Example:s_scene_object scene::stop( true );"

Definition at line 2097 of file scene_shared.csc.

References _stop_instance(), get_active_scenes(), and get_array().

◆ stop() [2/2]

function stop	(	b_clear	= `false`,
		b_finished	= `false`
	)

Definition at line 806 of file scene_shared.csc.

References _a_objects, _call_state_funcs(), _e_root, _str_name, _str_state, and clear().

Referenced by cancel(), cf_server_sync(), initialize(), on_error(), and play().

◆ wait_till_scene_done()

function wait_till_scene_done ( )

Definition at line 990 of file scene_shared.csc.

References _a_objects.

Referenced by initialize(), and play().

◆ wait_till_scene_ready()

function wait_till_scene_ready ( )

Definition at line 982 of file scene_shared.csc.

References _a_objects.

Referenced by _call_state_funcs(), and play().

◆ waittill_instance_scene_done()

function private waittill_instance_scene_done ( str_scenedef )

Definition at line 2054 of file scene_shared.csc.

Referenced by _play_instance().

◆ waittill_scene_done()

function private waittill_scene_done ( s_tracker )

Definition at line 1998 of file scene_shared.csc.

Referenced by play().

Variable Documentation

◆ _e_root

cSceneObject _e_root

Referenced by _call_state_funcs(), get_align_ent(), get_root(), init(), play(), run_next(), and stop().

◆ _n_object_id

var _n_object_id

Definition at line 580 of file scene_shared.csc.

Referenced by constructor(), and get_object_id().

◆ _str_mode

var _str_mode

Definition at line 581 of file scene_shared.csc.

Referenced by play().

◆ _str_state

var _str_state

Definition at line 579 of file scene_shared.csc.

Referenced by constructor(), get_state(), initialize(), play(), and stop().

Data Structures

Macros

Functions

Variables

Macro Definition Documentation

◆ NEW_STATE

◆ TRANSITION_FILTER_INDEX

◆ TRANSITION_STREAMER_TIMEOUT

◆ TRANSITION_TIME

◆ TRANSITION_TIME_SHORT

Function Documentation

◆ __init__()

◆ __main__()

◆ _call_state_funcs()

◆ _get_type_count()

◆ _has_init_state()

◆ _init_instance()

◆ _play_instance()

◆ _stop_instance()

◆ _trigger_init()

◆ _trigger_play()

◆ _trigger_stop()

◆ add_scene_func()

◆ allows_multiple()

◆ cancel()

◆ cf_server_sync()

◆ constructor()

◆ destructor()

◆ get_active_scene()

◆ get_active_scenes()

◆ get_actor_count()

◆ get_align_ent()

◆ get_ents()

◆ get_existing_ent()

◆ get_object_id()

◆ get_player_count()

◆ get_prop_count()

◆ get_root()

◆ get_scenedef()

◆ get_scenedefs()

◆ get_state()

◆ get_valid_object_defs()

◆ get_valid_objects()

◆ get_vehicle_count()

◆ has_init_state() [1/2]

◆ has_init_state() [2/2]

◆ in_igc()

◆ init() [1/2]

◆ init() [2/2]

◆ initialize()

◆ is_active()

◆ is_capture_mode()

◆ is_igc()

◆ is_looping()

◆ is_playing()

◆ on_error()

◆ on_localplayer_shutdown()

◆ play() [1/2]

◆ play() [2/2]

◆ player_scene_animation_skip()

◆ player_scene_skip_completed()

◆ postfx_igc()

◆ postfx_igc_short()

◆ postfx_igc_zombies()

◆ remove_invalid_scene_objects()

◆ remove_scene_func()

◆ run_next()

◆ spawn()

◆ stop() [1/2]

◆ stop() [2/2]

◆ wait_till_scene_done()

◆ wait_till_scene_ready()

◆ waittill_instance_scene_done()

◆ waittill_scene_done()

Variable Documentation

◆ _e_root

◆ _n_object_id

◆ _str_mode

◆ _str_state

◆ init()

◆ main()