fx_shared.gsc File Reference

Go to the source code of this file.

Functions
function	__init__ ()
function	_play_fx_delete (ent, time_to_delete_or_notify=(-1))
function	create_effect (type, fxid)
function	create_loop_effect (fxid)
function	create_oneshot_effect (fxid)
function	get (fx)
function	play (str_fx, v_origin=(0, 0, 0), v_angles=(0, 0, 0), time_to_delete_or_notify, b_link_to_self=false, str_tag, b_no_cull, b_ignore_pause_world)
function	set_forward_and_up_vectors ()

Function Documentation

__init__()

function __init__

(

)

Definition at line 12 of file fx_shared.gsc.

_play_fx_delete()

function _play_fx_delete	(	ent	,
		time_to_delete_or_notify	= (-1)
	)

Definition at line 136 of file fx_shared.gsc.

References waittill_any_timeout(), and waittill_either().

Referenced by play().

create_effect()

function create_effect	(	type	,
		fxid
	)

Definition at line 29 of file fx_shared.gsc.

Referenced by create_loop_effect(), and create_oneshot_effect().

create_loop_effect()

function create_loop_effect

(

fxid

)

Definition at line 61 of file fx_shared.gsc.

References create_effect().

create_oneshot_effect()

function create_oneshot_effect

(

fxid

)

Definition at line 68 of file fx_shared.gsc.

References create_effect().

get()

function get

(

fx

)

Definition at line 22 of file fx_shared.gsc.

Referenced by play().

play()

function play	(	str_fx	,
		v_origin	= ( 0, 0, 0 ),
		v_angles	= ( 0, 0, 0 ),
		time_to_delete_or_notify	,
		b_link_to_self	= false,
		str_tag	,
		b_no_cull	,
		b_ignore_pause_world
	)

Description:
"Function Name: play( <str_fx>, <v_origin>, [v_angles], [time_to_delete_or_notify], [b_link_to_self], [str_tag] )"
"Summary: play an effect at an origin or relative to an entity for a time or unitl a notify." "Module: Utility" "CallOn: level or entity to link fx to"
"Mandatory Argument(s): <str_fx> : identifier of fx."
"Mandatory Argument(s): <v_origin> : origin to play fx."
"Optional Argument(s): [v_angles] : angles to play fx."
"Optional Argument(s): [time_to_delete_or_notify] : when to delete to fx entity (time or notify). can be undefined if linking to an ent. it will die when it dies."
"Optional Argument(s): [b_link_to_self] : set to true to link to the entity this function is called on."
"Optional Argument(s): [str_tag] : tag to link to if linking."
"Optional Argument(s): [b_no_cull] : set to true to force it to not cull out."
"Optional Argument(s): [b_ignore_pause_world] : set to true to keep playing the effect even when the world is paused <br/>"Example:e_ent play( "splosion", undefined, undefined, 3, true, "tag_bone" );" <br/>"Single Player / Multi Player: SP"

Definition at line 92 of file fx_shared.gsc.

References _play_fx_delete(), get(), IS_TRUE, and spawn_model().

set_forward_and_up_vectors()

function set_forward_and_up_vectors

(

)

Definition at line 16 of file fx_shared.gsc.