struct.gsc File Reference

Go to the source code of this file.

Functions
function	delete ()
function	delete_script_bundle (str_type, str_name)
function	get (kvp_value, kvp_key="targetname")
function	get_array (kvp_value, kvp_key="targetname")
function	get_script_bundle (str_type, str_name)
function	get_script_bundle_instances (str_type, str_name="")
function	get_script_bundle_list (str_type, str_name)
function	get_script_bundles (str_type)
function	init ()
function	spawn (v_origin=(0, 0, 0), v_angles=(0, 0, 0))

Function Documentation

delete()

function delete

(

)

Definition at line 3 of file struct.gsc.

delete_script_bundle()

function delete_script_bundle	(	str_type	,
		str_name
	)

Description:
"Function Name: delete_script_bundle( <str_type>, <str_name> )"
"Summary: Deletes the specified script bundle definition. This is the GDT data for the bundle."
"Mandatory Argument(s): <str_type> : The type of the script bundle"
"Mandatory Argument(s): <str_name> : The name of the script bundle"
"Example: struct::delete_script_bundle( "scene", "my_scene" );"
"Single Player / Multi Player: both"

Definition at line 57 of file struct.gsc.

get()

function get	(	kvp_value	,
		kvp_key	= "targetname"
	)

Description:
"Function Name: get( <kvp_value> , [kvp_key] )"
"Summary: Returns a struct with the specified kvp."
"Mandatory Argument(s): <kvp_value> : kvp value"
"Optional Argument(s): [kvp_key] : defaults to targetname"

"Example:struct::get( "some_value", "targetname" );"
"Single Player / Multi Player: both"

Definition at line 14 of file struct.gsc.

get_array()

function get_array	(	kvp_value	,
		kvp_key	= "targetname"
	)

Description:
"Function Name: get_array( <kvp_value> , [kvp_key] )"
"Summary: Returns an array of structs with the specified kvp."
"Mandatory Argument(s): <kvp_value> : kvp value"
"Optional Argument(s): [kvp_key] : defaults to targetname"
"Example: fxemitters = struct::get_array( "streetlights", "targetname" )"
"Single Player / Multi Player: both"

Definition at line 35 of file struct.gsc.

get_script_bundle()

function get_script_bundle	(	str_type	,
		str_name
	)

Description:
"Function Name: get_script_bundle( <str_type>, <str_name> )"
"Summary: Returns a struct with the specified script bundle definition. This is the GDT data for the bundle."
"Mandatory Argument(s): <str_type> : The type of the script bundle"
"Mandatory Argument(s): <str_name> : The name of the script bundle"
"Example: struct::get_script_bundle( "scene", "my_scene" );"
"Single Player / Multi Player: both"

Definition at line 46 of file struct.gsc.

get_script_bundle_instances()

function get_script_bundle_instances	(	str_type	,
		str_name	= ""
	)

Description:
"Function Name: get_script_bundle_instances( <str_type>, [str_name] )"
"Summary: Returns an array of all the script bundle instances with the specified script bundle definition and name."
"Mandatory Argument(s): <str_type> : The type of the script bundle"
"Mandatory Argument(s): [str_name] : The name of the script bundle"
"Example: struct::get_script_bundle_instances( "scene", "my_scene" );"
"Single Player / Multi Player: both"

Definition at line 89 of file struct.gsc.

get_script_bundle_list()

function get_script_bundle_list	(	str_type	,
		str_name
	)

Description:
"Function Name: get_script_bundle_list( <str_type>, <str_name> )"
"Summary: Returns a string array with the items specified by the script bundle list."
"Mandatory Argument(s): <str_type> : The type of the script bundle in the list"
"Mandatory Argument(s): <str_name> : The name of the script bundle list"
"Example: struct::get_script_bundle_list( "collectible", "completecollectibleslist" );"
"Single Player / Multi Player: both"

Definition at line 78 of file struct.gsc.

get_script_bundles()

function get_script_bundles

(

str_type

)

Description:
"Function Name: get_script_bundles( <str_type> )"
"Summary: Returns all of the script bundle definition structs for the specified type."
"Mandatory Argument(s): <str_type> : The type of the script bundle"
"Example: struct::get_script_bundles( "scene" );"
"Single Player / Multi Player: both"

Definition at line 67 of file struct.gsc.

init()

function init

(

)

Definition at line 2 of file struct.gsc.

spawn()

function spawn	(	v_origin	= (0, 0, 0),
		v_angles	= (0, 0, 0)
	)

Description:
"Function Name: spawn( [v_origin], [v_angles] )"
"Summary: Returns a new struct."
"Optional Argument(s): [v_origin] : optional origin"
"Optional Argument(s): [v_angles] : optional angles"
"Example: s = struct::spawn( self GetTagOrigin( "tag_origin" ) );"

Definition at line 24 of file struct.gsc.