Класс SEffectManager

Manager class for managing Effect (EffectParticle, EffectSound) Подробнее...

Защищенные статические члены
Generic playback
Methods for playing Effect Заметки Since 1.15, these should work on EffectSound as well
static int	PlayInWorld (notnull Effect eff, vector pos)
	Play an Effect.
static int	PlayOnObject (notnull Effect eff, Object obj, vector local_pos="0 0 0", vector local_ori="0 0 0", bool force_rotation_relative_to_world=false)
	Play an Effect.
static void	Stop (int effect_id)
	Stops the Effect.
Create/Play sound
Methods for playing/creating sound
static EffectSound	CreateSound (string sound_set, vector position, float play_fade_in=0, float stop_fade_out=0, bool loop=false, bool enviroment=false)
	Create an EffectSound.
static EffectSound	PlaySound (string sound_set, vector position, float play_fade_in=0, float stop_fade_out=0, bool loop=false)
	Create and play an EffectSound.
static EffectSound	PlaySoundParams (notnull SoundParams params, vector position, float play_fade_in=0, float stop_fade_out=0, bool loop=false)
	Create and play an EffectSound.
static EffectSound	PlaySoundCachedParams (string sound_set, vector position, float play_fade_in=0, float stop_fade_out=0, bool loop=false)
	Create and play an EffectSound, using or creating cached SoundParams.
static EffectSound	PlaySoundEnviroment (string sound_set, vector position, float play_fade_in=0, float stop_fade_out=0, bool loop=false)
	Create and play an EffectSound, updating environment variables.
static EffectSound	PlaySoundOnObject (string sound_set, Object parent_object, float play_fade_in=0, float stop_fade_out=0, bool loop=false)
	Create and play an EffectSound.
Generic API
General methods used for SEffectManager
static void	DestroyEffect (Effect effect)
	Unregisters, stops and frees the Effect.
static bool	IsEffectExist (int effect_id)
	Checks whether an Effect ID is registered in SEffectManager.
static Effect	GetEffectByID (int effect_id)
	Gets the Effect with the given registered Effect ID.
static int	EffectRegister (Effect effect)
	Registers Effect in SEffectManager.
static int	GetFreeEffecterID ()
static void	EffectUnregister (int id)
	Unregisters Effect in SEffectManager.
static void	EffectUnregisterEx (Effect effect)
	Unregisters Effect in SEffectManager.
static int	GetFreeEffectID ()
	Helper function for EffectRegister to decide an Effect ID.
Sound helpers
Sound specific helper methods
static bool	DestroySound (EffectSound sound_effect)
	Legacy, backwards compatibility.
static SoundParams	GetCachedSoundParam (string soundset)
	Get or create a cached SoundParams object.
Events
Various events that can be overriden for custom behaviour
static void	Event_OnSoundWaveEnded (EffectSound effect_sound)
	Event called from EffectSound.Event_OnSoundWaveEnded.
static void	Event_OnFrameUpdate (float time_delta)
	Event called on frame.
Lifetime
Creation and cleanup
static void	Init ()
	Initialize the containers.
static void	InitServer ()
static void	Cleanup ()
	Cleanup method to properly clean up the static data.
static int	CreateParticleServer (vector pos, EffecterParameters parameters)
	returns unique effecter ID
static void	ReinitParticleServer (int effecterID, EffecterParameters parameters)
	allows re-initializing existing effecter with new parameters (extept m_EffecterType, obviously)
static void	ReactivateParticleServer (int effecterID)
static void	StartParticleServer (int effecterID)
static void	StopParticleServer (int effecterID)
static void	DestroyEffecterParticleServer (int effecterID)
static void	OnUpdate (float timeslice)

Статические защищенные данные
static ref map< int, ref Effect >	m_EffectsMap
	Static map of all registered effects <id, Effect>
static ref array< int >	m_FreeEffectIDs
	Static array of IDs that were previously used, but freed up by unregistering.
static int	m_HighestFreeEffectID = 1
	Counter for quickly getting the next ID if FreeEffectIDs array is empty.
static const int	INVALID_ID = 0
	As the counter starts at 1, Effect ID can never be 0.
static bool	m_IsCleanup
	Bool to check whether Cleanup is happening, which means that the maps should no longer be accessed.
static bool	m_IsInitialized
	Bool to check whether Init was called.
static ref map< string, ref SoundParams >	m_ParamsMap
	Static map of cached sound params, to prevent having to recreate them.
static ref ScriptInvoker	Event_OnFrameUpdate
	Static invoker for the SEffectManager.Event_OnFrameUpdate called form MissionGameplay.OnUpdate.
static ref map< int, EffecterBase >	m_EffectersMap
static ref array< int >	m_FreeEffecterIDs
	Static array of IDs that were previously used, but freed up by unregistering Effecters.
static int	m_HighestFreeEffecterID = 1

Подробное описание

Manager class for managing Effect (EffectParticle, EffectSound)

Предупреждения

Keeps a ref to any Effect registered (Created/Played), make sure to perform the necessary cleanup

См. определение в файле EffectManager.c строка 5