Класс 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

Методы

Cleanup()

static void Cleanup ( )

inlinestaticprotected

Cleanup method to properly clean up the static data.

Заметки

Will be called when MissionBase is destroyed

    {
        // Nothing to clean
        if (!m_IsInitialized)
            return;     
        
        m_IsCleanup = true;
        
        // There should not be anything in here on server
        if (GetGame() && GetGame().IsDedicatedServer())
        {
            if (m_ParamsMap.Count() > 0)
                ErrorEx(string.Format("SEffectManager containing SoundParams on server."), ErrorExSeverity.WARNING);
            
            if (m_EffectsMap.Count() > 0)
                ErrorEx(string.Format("SEffectManager containing Effect on server."), ErrorExSeverity.WARNING);
        }
        
        // These are intentionally cached, just clear them
        m_ParamsMap.Clear();
        
        // These might not be intentionally still here, so log how many there are
        #ifdef DEVELOPER
        Print("--- SEffectManager Cleanup dump - Begin ------------------------");
        Print(string.Format("Effect count: %1", m_EffectsMap.Count()));
        #endif
        
        // Best to call the unregister event before clearing the map
        // In case some ref is still being held elsewhere and will still be kept alive
        foreach (int id, Effect eff : m_EffectsMap)
        {
            eff.Event_OnUnregistered();
            #ifdef SFXM_DUMP
            Print(string.Format( "%1 :: %2 :: %3", eff, typename.EnumToString(EffectType, eff.GetEffectType()), eff.GetDebugName() ));
            #endif
        }
        
        foreach (int i, EffecterBase effecter : m_EffectersMap)
        {
            effecter.Delete();
        }
        
        #ifdef DEVELOPER
        Print("--- SEffectManager Cleanup dump - End --------------------------");
        #endif
        
        // Now we can clear it
        m_EffectsMap.Clear();
        m_EffectersMap.Clear();
        
        // Reset the state
        m_HighestFreeEffectID = 1;      
        Event_OnFrameUpdate.Clear();
        m_IsCleanup = false;
    }

Перекрестные ссылки ErrorEx, Event_OnFrameUpdate, GetGame(), m_EffectersMap, m_EffectsMap, m_HighestFreeEffectID, m_IsCleanup, m_IsInitialized, m_ParamsMap и Print().

Используется в MissionBaseWorld::MissionBase() и CGame::~CGame().

CreateParticleServer()

static int CreateParticleServer ( vector pos, EffecterParameters parameters )

inlinestaticprotected

returns unique effecter ID

    {
        EffecterBase eff;
        eff = EffecterBase.Cast(GetGame().CreateObjectEx(parameters.m_EffecterType, pos, ECE_PLACE_ON_SURFACE));
        
        if (eff)
        {
            int id = GetFreeEffecterID();
            m_EffectersMap.Insert(id, eff);
        }
        
        eff.Init(id, parameters);
        return id;
    }

Перекрестные ссылки ECE_PLACE_ON_SURFACE, GetFreeEffecterID(), GetGame() и m_EffectersMap.

Используется в ItemBase::PlayCatchParticleSynced() и ActionFishingNew::PlaySplashEffectSynced().

CreateSound()

static EffectSound CreateSound ( string sound_set, vector position, float play_fade_in = 0, float stop_fade_out = 0, bool loop = false, bool enviroment = false )

inlinestaticprotected

Create an EffectSound.

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

Read PlayInWorld warning

Аргументы

sound_set	string The sound set name of the sound
position	vector The position to play the sound
play_fade_in	float The fade in duration of the sound (Optional)
stop_fade_out	float The fade out duration of the sound (Optional)
loop	bool Whether the sound should loop (Optional)
enviroment	bool Whether to set environment variables (Optional)

Возвращает

EffectSound The created EffectSound

    {
        EffectSound effect_sound = new EffectSound();
        effect_sound.SetSoundSet(sound_set);
        effect_sound.SetPosition(position);
        effect_sound.SetSoundFadeIn(play_fade_in);
        effect_sound.SetSoundFadeOut(stop_fade_out);
        effect_sound.SetSoundLoop(loop);
        effect_sound.SetEnviromentVariables(enviroment);
        
        EffectRegister( effect_sound );
        
        return effect_sound;
    }

Перекрестные ссылки EffectRegister().

Используется в BoatScript::HandleBoatSplashSound(), HandleEngineSound(), FlashbangEffect::PlaySound(), PlaySound(), PlaySoundCachedParams(), PlaySoundEnviroment(), PlaySoundOnObject(), PlaySoundParams() и UpdateMusic().

DestroyEffect()

static void DestroyEffect ( Effect effect )

inlinestaticprotected

Unregisters, stops and frees the Effect.

Аргументы

effect_sound

EffectSound The EffectSound to free

    {
        if (effect)
        {
            if (effect.CanDestroy())
            {
                // Functionality already happens in dtor of Effect to be safe
                delete effect;
            }
            else
            {
                // Make it clean up itself when done
                effect.SetAutodestroy(true);
                effect.Stop();
            }
        }
    }

Используется в BoatScript::CleanupEffects(), CleanupEffects(), CleanupSound(), Destroy(), ActionBuildShelter::DestroyActionLoopSound(), DestroySound(), EEDelete(), Roadflare::EEDelete(), ManBase::EEDelete(), House::EEDelete(), OnRingingStartClient(), OnRingingStopClient(), InventoryItem::OnRPC(), OnVariablesSynchronized(), ItemBase::OnWorkStop(), RemoveParticle(), ManBase::SetDecayEffects(), FlashbangEffect::StopSound(), KitchenTimer::TurnOff(), ~Bottle_Base(), ~ClockBase(), DayZIntroSceneXbox::~DayZIntroSceneXbox(), ItemBase::~Defibrillator(), DestructionEffectBase::~DestructionEffectBase(), FireworksLauncher::~FireworksLauncher(), FireworksLauncherClientEvent::~FireworksLauncherClientEvent(), FlashbangEffect::~FlashbangEffect(), InventoryItem::~ItemBase(), ~LandMineTrap(), ~LargeTent(), Backpack_Base::~LargeTentBackPack(), ParticleEffecter::~ParticleEffecter(), ManBase::~PlayerBase(), ItemBase::~PowerGeneratorBase() и ~TreeEffecter().

DestroyEffecterParticleServer()

static void DestroyEffecterParticleServer ( int effecterID )

inlinestaticprotected

    {
        EffecterBase eff = m_EffectersMap.Get(effecterID);
        if (eff)
        {
            m_EffectersMap.Remove(effecterID);
            eff.DeleteSafe();
        }
    }

Перекрестные ссылки m_EffectersMap.

Используется в DecreaseLifespan(), ActionFishingNewCB::DestroySplashEffectSynced(), OnEndServer() и ItemBase::SetActive().

DestroySound()

static bool DestroySound ( EffectSound sound_effect )

inlinestaticprotected

Legacy, backwards compatibility.

Аргументы

sound_effect

EffectSound The EffectSound to free

Возвращает

bool A bool which is always true

    {
        DestroyEffect(sound_effect);        
        return true;
    }

Перекрестные ссылки DestroyEffect().

Используется в CleanSoundEffects(), CleanUpOnClosedClient() и Land_Underground_Stairs_Exit::CleanUpOnClosedClient().

EffectRegister()

static int EffectRegister ( Effect effect )

inlinestaticprotected

Registers Effect in SEffectManager.

Заметки

Already handled in SEffectManager Create/Play methods

This will make SEffectManager hold a strong ref for the Effect

Аргументы

effect

Effect The Effect to register

Возвращает

int The Effect ID

    {
        if (effect.IsRegistered())
        {
            ErrorEx(string.Format("Attempted to register Effect '%1' which was already registered.", effect.GetDebugName()), ErrorExSeverity.INFO);         
            return effect.GetID();
        }
        
        int id;
        
        if (!m_IsCleanup)
        {
            id = GetFreeEffectID();
            m_EffectsMap.Insert(id, effect);
            effect.Event_OnRegistered(id);
        }
        else
            ErrorEx("Attempted to register Effect while SEffectManager is cleaning up, request ignored.", ErrorExSeverity.WARNING);
        
        return id;
    }

Перекрестные ссылки ErrorEx, GetFreeEffectID(), m_EffectsMap и m_IsCleanup.

Используется в CreateSound(), PlayInWorld() и PlayOnObject().

EffectUnregister()

static void EffectUnregister ( int id )

inlinestaticprotected

Unregisters Effect in SEffectManager.

Заметки

Will automatically occur on stop when the Effect is AutoDestroy

ID can be gotten from the Effect by calling Effect.GetID

Generic Play methods will also return the ID

Аргументы

id	int The ID of the Effect to unregister

    {
        if (m_IsCleanup)
            return; // No error needed, since it will have been unregistered anyways after cleanup is finished
        
        Effect effect;
        if ( m_EffectsMap.Find(id, effect) )
        {
            effect.Event_OnUnregistered();
            m_EffectsMap.Remove(id);
        }       
        
        if ( m_FreeEffectIDs.Find(id) == -1 )
        {
            m_FreeEffectIDs.Insert(id);
        }
    }

Перекрестные ссылки m_EffectsMap, m_FreeEffectIDs и m_IsCleanup.

Используется в EffectUnregisterEx() и ~Effect().

EffectUnregisterEx()

static void EffectUnregisterEx ( Effect effect )

inlinestaticprotected

Unregisters Effect in SEffectManager.

Аргументы

effect

Effect The Effect to unregister

    {
        EffectUnregister(effect.GetID());
    }

Перекрестные ссылки EffectUnregister().

Используется в BoatScript::CleanupEffects().

Event_OnFrameUpdate()

static void Event_OnFrameUpdate ( float time_delta )

inlinestaticprotected

Event called on frame.

Заметки

Called from MissionGameplay.OnUpdate

Effects register themselves by Effect.SetEnableEventFrame(true)

EffectSound is automatically registered

Аргументы

time_delta

float Time passed since the previous frame

    {
        Event_OnFrameUpdate.Invoke(time_delta);
    }

Перекрестные ссылки Event_OnFrameUpdate.

Event_OnSoundWaveEnded()

static void Event_OnSoundWaveEnded ( EffectSound effect_sound )

inlinestaticprotected

Event called from EffectSound.Event_OnSoundWaveEnded.

Заметки

Every registered sound is registered to call this

Аргументы

effect_sound

EffectSound The EffectSound calling the event

    {
        
    }

Используется в EffectSound::Event_OnRegistered() и EffectSound::Event_OnUnregistered().

GetCachedSoundParam()

static SoundParams GetCachedSoundParam ( string soundset )

inlinestaticprotected

Get or create a cached SoundParams object.

Аргументы

soundset

string The sound set name of the sound

Возвращает

SoundParams The cached SoundParams for the given soundset

    {
        SoundParams params;
        if (!m_ParamsMap.Find(soundset, params))
        {
            params = new SoundParams(soundset);
            m_ParamsMap.Insert(soundset, params);
        }
        return params;
    }

Перекрестные ссылки m_ParamsMap.

Используется в PlaySoundCachedParams().

GetEffectByID()

static Effect GetEffectByID ( int effect_id )

inlinestaticprotected

Gets the Effect with the given registered Effect ID.

Аргументы

effect_id

int The Effect ID

Возвращает

Effect The Effect registered to the ID or null

    {
        if (!m_IsCleanup)
            return m_EffectsMap[effect_id];
        else
            return null;
    }

Перекрестные ссылки m_EffectsMap и m_IsCleanup.

GetFreeEffecterID()

static int GetFreeEffecterID ( )

inlinestaticprotected

    {
        int return_id;
        
        if (m_FreeEffecterIDs.Count() > 0)
        {
            return_id = m_FreeEffecterIDs.Get(0);
            m_FreeEffecterIDs.Remove(0);
        }
        else
        {
            return_id = m_HighestFreeEffecterID;
            ++m_HighestFreeEffecterID;
        }
        
        return return_id;       
    }

Перекрестные ссылки m_FreeEffecterIDs и m_HighestFreeEffecterID.

Используется в CreateParticleServer().

GetFreeEffectID()

static int GetFreeEffectID ( )

inlinestaticprotected

Helper function for EffectRegister to decide an Effect ID.

Возвращает

int A currently unused Effect ID

    {
        int return_id;
        
        if (m_FreeEffectIDs.Count() > 0)
        {
            return_id = m_FreeEffectIDs.Get(0);
            m_FreeEffectIDs.Remove(0);
        }
        else
        {
            return_id = m_HighestFreeEffectID;
            ++m_HighestFreeEffectID;
        }
        
        return return_id;       
    }

Перекрестные ссылки m_FreeEffectIDs и m_HighestFreeEffectID.

Используется в EffectRegister().

Init()

static void Init ( )

inlinestaticprotected

Initialize the containers.

Заметки

This is done this way, to have these not exist on server

    {
        m_EffectsMap = new map<int, ref Effect>;
        m_FreeEffectIDs = new array<int>;
        m_ParamsMap = new map<string, ref SoundParams>;
        Event_OnFrameUpdate = new ScriptInvoker();
        
        m_IsInitialized = true;
    }

Перекрестные ссылки Event_OnFrameUpdate, m_EffectsMap, m_FreeEffectIDs, m_IsInitialized и m_ParamsMap.

Используется в CGame::CGame().

InitServer()

static void InitServer ( )

inlinestaticprotected

    {
        m_EffectersMap = new map<int, EffecterBase>;
        m_FreeEffecterIDs = new array<int>;
    }

Перекрестные ссылки m_EffectersMap и m_FreeEffecterIDs.

Используется в CGame::CGame().

IsEffectExist()

static bool IsEffectExist ( int effect_id )

inlinestaticprotected

Checks whether an Effect ID is registered in SEffectManager.

Аргументы

effect_id

int The Effect ID to check

Возвращает

bool Whether there is an Effect registered for this ID

    {
        if (!m_IsCleanup)
            return m_EffectsMap[effect_id] != null;
        else
            return false;
    }

Перекрестные ссылки m_EffectsMap и m_IsCleanup.

Используется в CreateCarDestroyedEffect(), EOnPostSimulate() и ManBase::SetDecayEffects().

OnUpdate()

static void OnUpdate ( float timeslice )

inlinestaticprotected

    {
        if (m_EffectersMap)
        {
            foreach (int i, EffecterBase effecter : m_EffectersMap)
            {
                effecter.DecreaseLifespan(timeslice);
            }
        }
    }

Перекрестные ссылки m_EffectersMap.

Используется в CGame::OnUpdate().

PlayInWorld()

static int PlayInWorld ( notnull Effect eff, vector pos )

inlinestaticprotected

Play an Effect.

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

As the Effect is automatically registered, it will not be freed automatically (because of the ref) Unless 'SetAutodestroy(true)' is called on the created 'Effect', which will clean it up when the sound stop Alternatively, SEffectManager.DestroyEffect can be called manually, which will also unregister and cleanup

Аргументы

eff	Effect The Effect to play
pos	vector The position to play the Effect

Возвращает

int The registered ID of the Effect

    {
        // Stop the effect first, just in case
        eff.Stop();
        
        int id = EffectRegister(eff);
        
        eff.SetPosition( pos );
        eff.Start();    
        
        return id;
    }

Перекрестные ссылки EffectRegister().

Используется в Hit_MeatBones::BloodSplatGround(), CreateParticle(), ImpactMaterials::EvaluateImpactEffect(), ManBase::OnParticleEvent(), ParticleEffecter::OnVariablesSynchronized(), OnVariablesSynchronized(), AmmoEffects::PlayAmmoEffect(), BleedingSourcesManagerBase::SetDiag(), DayZIntroSceneXbox::SetupParticles() и Explosion::SpawnEffect().

PlayOnObject()

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 )

inlinestaticprotected

Play an Effect.

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

Read PlayInWorld warning

Аргументы

eff	Effect The Effect to play
obj	Object The parent of the Effect
local_pos	vector The local position to play the Effect in relation to the parent (Optional)
local_ori	vector The local orientation to play the Effect in relation to the parent (Optional)
force_rotation_relative_to_world	bool Whether to force the orientation to stay in WS (Optional)

Возвращает

int The registered ID of the Effect

    {
        // Stop the effect first, just in case
        eff.Stop();
        
        int id = EffectRegister(eff);
        
        if (!obj)
        {
            ErrorEx("Parent object is null.", ErrorExSeverity.WARNING);
            eff.SetPosition(local_pos);
        }
        else
        {
            eff.SetPosition(obj.GetPosition());
        }
            
        eff.SetParent(obj);
        eff.SetLocalPosition(local_pos);
        eff.SetAttachedLocalOri(local_ori);
        
        if (force_rotation_relative_to_world)
        {
            EffectParticle eff_particle = EffectParticle.Cast(eff);
            
            if (eff_particle)
            {
                eff_particle.ForceParticleRotationRelativeToWorld(force_rotation_relative_to_world);
            }
        }
        
        eff.Start();
        
        return id;
    }

Перекрестные ссылки EffectRegister() и ErrorEx.

Используется в CreateCarDestroyedEffect(), EOnPostSimulate(), ManBase::SetDecayEffects() и ItemBase::StartLoopSound().

PlaySound()

static EffectSound PlaySound ( string sound_set, vector position, float play_fade_in = 0, float stop_fade_out = 0, bool loop = false )

inlinestaticprotected

Create and play an EffectSound.

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

Calls CreateSound, read CreateSound warning

Аргументы

sound_set	string The sound set name of the sound
position	vector The position to play the sound
play_fade_in	float The fade in duration of the sound (Optional)
stop_fade_out	float The fade out duration of the sound (Optional)
loop	bool Whether the sound should loop (Optional)

Возвращает

EffectSound The created EffectSound

    {
        EffectSound effect_sound = CreateSound(sound_set, position, play_fade_in, stop_fade_out, loop, false);
                
        effect_sound.SoundPlay();
        
        return effect_sound;
    }

Перекрестные ссылки CreateSound().

Используется в CGame::DelayedMidAirDetonation(), House::EEInit(), ItemBase::EEItemAttached(), ItemBase::EEItemDetached(), HandleDoorsSound(), HandleEngineSound(), BoatScript::HandleEngineSound(), HandleSeatAdjustmentSound(), CarScript::OnAnimationPhaseStarted(), Weapon::OnFireModeChange(), InventoryItem::OnRPC(), CGame::OnRPC(), OnSteppedOn(), InventoryItemSuper::OnWasAttached(), InventoryItemSuper::OnWasDetached(), SpookyEventBase::Perform(), ActionBuildShelter::PlayActionFinishSound(), ActionBuildShelter::PlayActionLoopSound(), ActionBuildShelter::PlayActionStartSound(), InventoryItem::PlayAttachSound(), InventoryItem::PlayDeployFinishSound(), InventoryItem::PlayDeployLoopSoundEx(), InventoryItem::PlayDeploySound(), PlayDisarmingLoopSound(), InventoryItem::PlayPlaceSound(), PlayRepackingLoopSound(), Backpack_Base::PlayRepackingLoopSound(), PlaySoundActivate(), TrapBase::PlaySoundBiteEmpty(), TrapBase::PlaySoundBiteLeg(), TrapBase::PlaySoundOpen(), Barrel_ColorBase::SoundBarrelClosePlay(), FireplaceBase::SoundBarrelClosePlay(), Barrel_ColorBase::SoundBarrelOpenPlay(), FireplaceBase::SoundBarrelOpenPlay(), Edible_Base::SoundCookingStart(), Entity::SoundHardBushFallingPlay(), Entity::SoundHardTreeFallingPlay(), Entity::SoundSoftBushFallingPlay(), Entity::SoundSoftTreeFallingPlay(), ItemBase::SoundTentClosePlay(), ItemBase::SoundTentCloseWindowPlay(), ItemBase::SoundTentOpenPlay(), ItemBase::SoundTentOpenWindowPlay(), StartActivate() и GeyserTrigger::UpdateGeyserState().

PlaySoundCachedParams()

static EffectSound PlaySoundCachedParams ( string sound_set, vector position, float play_fade_in = 0, float stop_fade_out = 0, bool loop = false )

inlinestaticprotected

Create and play an EffectSound, using or creating cached SoundParams.

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

Calls CreateSound, read CreateSound warning

Аргументы

sound_set	string The sound set name of the sound
position	vector The position to play the sound
play_fade_in	float The fade in duration of the sound (Optional)
stop_fade_out	float The fade out duration of the sound (Optional)
loop	bool Whether the sound should loop (Optional)

Возвращает

EffectSound The created EffectSound

    {
        SoundParams params = GetCachedSoundParam(sound_set);
        
        EffectSound effect_sound = CreateSound(params.GetName(), position, play_fade_in, stop_fade_out, loop, false);
 
        effect_sound.SoundPlayEx(params);
        
        return effect_sound;
    }

Перекрестные ссылки CreateSound() и GetCachedSoundParam().

Используется в Land_WarheadStorage_PowerStation::OnVariablesSynchronized(), BoatScript::PlaySound() и PlaySoundEx().

PlaySoundEnviroment()

static EffectSound PlaySoundEnviroment ( string sound_set, vector position, float play_fade_in = 0, float stop_fade_out = 0, bool loop = false )

inlinestaticprotected

Create and play an EffectSound, updating environment variables.

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

Calls CreateSound, read CreateSound warning

Аргументы

sound_set	string The sound set name of the sound
position	vector The position to play the sound
play_fade_in	float The fade in duration of the sound (Optional)
stop_fade_out	float The fade out duration of the sound (Optional)
loop	bool Whether the sound should loop (Optional)

Возвращает

EffectSound The created EffectSound

    {
        EffectSound effect_sound = CreateSound(sound_set, position, play_fade_in, stop_fade_out, loop, true);
                
        effect_sound.SoundPlay();
        
        return effect_sound;
    }

Перекрестные ссылки CreateSound().

Используется в ScriptConsoleSoundsTab::HandleKeys(), ScriptConsoleSoundsTab::OnClick(), ItemBase::PlayCatchSound() и IEntity::PlaySoundSetAtMemoryPoint().

PlaySoundOnObject()

static EffectSound PlaySoundOnObject ( string sound_set, Object parent_object, float play_fade_in = 0, float stop_fade_out = 0, bool loop = false )

inlinestaticprotected

Create and play an EffectSound.

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

Calls CreateSound, read CreateSound warning

Аргументы

sound_set	string The sound set name of the sound
parent_object	Object The parent Object for the sound to follow
play_fade_in	float The fade in duration of the sound (Optional)
stop_fade_out	float The fade out duration of the sound (Optional)
loop	bool Whether the sound should loop (Optional)

Возвращает

EffectSound The created EffectSound

    {
        EffectSound effect_sound = CreateSound(sound_set, parent_object.GetPosition(), play_fade_in, stop_fade_out, loop);
        
        effect_sound.SetParent( parent_object );
        effect_sound.SetLocalPosition( vector.Zero );
        effect_sound.SoundPlay();
        
        return effect_sound;
    }

Перекрестные ссылки CreateSound() и vector::Zero.

Используется в ItemBase::DischargeClient(), ManBase::EEHitByRemote(), ManBase::OnBleedingSourceAdded(), ItemBase::OnIsCharged(), ManBase::OnPlayerRecievedHit(), ItemBase::OnWorkStart(), PlayEmptyingLoopSound(), PlayPouringLoopSound(), PlaySound(), IEntity::PlaySoundSet() и StopEmptyingLoopSound().

PlaySoundParams()

static EffectSound PlaySoundParams ( notnull SoundParams params, vector position, float play_fade_in = 0, float stop_fade_out = 0, bool loop = false )

inlinestaticprotected

Create and play an EffectSound.

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

Calls CreateSound, read CreateSound warning

Аргументы

params	SoundParams Params to create the sound with
position	vector The position to play the sound
play_fade_in	float The fade in duration of the sound (Optional)
stop_fade_out	float The fade out duration of the sound (Optional)
loop	bool Whether the sound should loop (Optional)

Возвращает

EffectSound The created EffectSound

    {
        EffectSound effect_sound = CreateSound(params.GetName(), position, play_fade_in, stop_fade_out, loop, false);
 
        effect_sound.SoundPlayEx(params);
        
        return effect_sound;
    }

Перекрестные ссылки CreateSound().

ReactivateParticleServer()

static void ReactivateParticleServer ( int effecterID )

inlinestaticprotected

    {
        EffecterBase eff = m_EffectersMap.Get(effecterID);
        if (eff)
        {
            eff.Reactivate();
        }
    }

Перекрестные ссылки m_EffectersMap.

Используется в ItemBase::PlayCatchParticleSynced() и ActionFishingNew::PlaySplashEffectSynced().

ReinitParticleServer()

static void ReinitParticleServer ( int effecterID, EffecterParameters parameters )

inlinestaticprotected

allows re-initializing existing effecter with new parameters (extept m_EffecterType, obviously)

    {
        EffecterBase eff = m_EffectersMap.Get(effecterID);
        if (eff)
        {
            eff.Init(effecterID,parameters);
        }
    }

Перекрестные ссылки m_EffectersMap.

Используется в ItemBase::PlayCatchParticleSynced() и ActionFishingNew::PlaySplashEffectSynced().

StartParticleServer()

static void StartParticleServer ( int effecterID )

inlinestaticprotected

    {
        EffecterBase eff = m_EffectersMap.Get(effecterID);
        if (eff)
        {
            eff.Start();
        }
        
    }

Перекрестные ссылки m_EffectersMap.

Stop()

static void Stop ( int effect_id )

inlinestaticprotected

Stops the Effect.

Аргументы

effect_id

int The ID of the Effect to Stop

    {
        Effect eff = m_EffectsMap.Get(effect_id);
        
        if (eff)
        {
            eff.Stop();
        }
        else
        {
            ErrorEx(string.Format("Failed to stop Effect with ID %1. The ID is not registered in m_EffectsMap!", effect_id));
        }
    }

Перекрестные ссылки ErrorEx и m_EffectsMap.

Используется в EOnPostSimulate().

StopParticleServer()

static void StopParticleServer ( int effecterID )

inlinestaticprotected

    {
        EffecterBase eff = m_EffectersMap.Get(effecterID);
        if (eff)
        {
            eff.Stop();
        }   
    }

Перекрестные ссылки m_EffectersMap.

Поля

Event_OnFrameUpdate

ref ScriptInvoker Event_OnFrameUpdate

staticprotected

Static invoker for the SEffectManager.Event_OnFrameUpdate called form MissionGameplay.OnUpdate.

Используется в Cleanup(), Event_OnFrameUpdate(), Init(), MissionBase::OnUpdate() и SetEnableEventFrame().

INVALID_ID

const int INVALID_ID = 0

staticprotected

As the counter starts at 1, Effect ID can never be 0.

Используется в Event_OnUnregistered().

m_EffectersMap

ref map<int, EffecterBase> m_EffectersMap

staticprotected

Используется в Cleanup(), CreateParticleServer(), DestroyEffecterParticleServer(), InitServer(), OnUpdate(), ReactivateParticleServer(), ReinitParticleServer(), StartParticleServer() и StopParticleServer().

m_EffectsMap

ref map<int, ref Effect> m_EffectsMap

staticprotected

Static map of all registered effects <id, Effect>

Используется в Cleanup(), EffectRegister(), EffectUnregister(), GetEffectByID(), Init(), IsEffectExist() и Stop().

m_FreeEffecterIDs

ref array<int> m_FreeEffecterIDs

staticprotected

Static array of IDs that were previously used, but freed up by unregistering Effecters.

Используется в GetFreeEffecterID() и InitServer().

m_FreeEffectIDs

ref array<int> m_FreeEffectIDs

staticprotected

Static array of IDs that were previously used, but freed up by unregistering.

Используется в EffectUnregister(), GetFreeEffectID() и Init().

m_HighestFreeEffecterID

int m_HighestFreeEffecterID = 1

staticprotected

Используется в GetFreeEffecterID().

m_HighestFreeEffectID

int m_HighestFreeEffectID = 1

staticprotected

Counter for quickly getting the next ID if FreeEffectIDs array is empty.

Используется в Cleanup() и GetFreeEffectID().

m_IsCleanup

bool m_IsCleanup

staticprotected

Bool to check whether Cleanup is happening, which means that the maps should no longer be accessed.

Используется в Cleanup(), EffectRegister(), EffectUnregister(), GetEffectByID() и IsEffectExist().

m_IsInitialized

bool m_IsInitialized

staticprotected

Bool to check whether Init was called.

Используется в Cleanup() и Init().

m_ParamsMap

ref map<string, ref SoundParams> m_ParamsMap

staticprotected

Static map of cached sound params, to prevent having to recreate them.

Используется в Cleanup(), GetCachedSoundParam() и Init().

---

Объявления и описания членов класса находятся в файле:

• D:/Ishodniki/scripts/3_Game/EffectManager.c