class SEffectManagerSource

WarningAs 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

References EffectRegister(), Effect.SetPosition(), Effect.Start()

Show 1 more

, Effect.Stop()

Referenced by AmmoEffects.PlayAmmoEffect(), BleedingSource.CreateParticle(), DayZIntroSceneXbox.SetupParticles()

Show 6 more

, Explosion.SpawnEffect(), Hit_MeatBones.BloodSplatGround(), ImpactMaterials.EvaluateImpactEffect(), ParticleEffecter.OnVariablesSynchronized(), PlayerBase.OnParticleEvent(), and TreeEffecter.OnVariablesSynchronized()

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

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)

Returns: int The registered ID of the Effect

WarningRead PlayInWorld warning

References Class.Cast(), EffectRegister(), ErrorEx()

Show 8 more

, EffectParticle.ForceParticleRotationRelativeToWorld(), Object.GetPosition(), Effect.SetAttachedLocalOri(), Effect.SetLocalPosition(), Effect.SetParent(), Effect.SetPosition(), Effect.Start(), and Effect.Stop()

Referenced by CarScript.CreateCarDestroyedEffect(), CarScript.EOnPostSimulate(), PlayerBase.SetDecayEffects()

Show 1 more

, PowerGeneratorBase.StartLoopSound()

static void Stop(int effect_id)

Stops the Effect

effect_id: int The ID of the Effect to Stop

References ErrorEx(), string.Format(), map.Get()

Show 2 more

, Effect.Stop(), and m_EffectsMap

Referenced by CarScript.EOnPostSimulate()

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

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)

Returns: EffectSound The created EffectSound

WarningRead PlayInWorld warning

References EffectRegister(), new EffectSound(), EffectSound.SetEnviromentVariables()

Show 5 more

, Effect.SetPosition(), EffectSound.SetSoundFadeIn(), EffectSound.SetSoundFadeOut(), EffectSound.SetSoundLoop(), and EffectSound.SetSoundSet()

Referenced by AnniversaryMusicSource.UpdateMusic(), BoatScript.HandleBoatSplashSound(), FlashbangEffect.PlaySound()

Show 5 more

, PlaySound(), PlaySoundCachedParams(), PlaySoundEnviroment(), PlaySoundOnObject(), and PlaySoundParams()

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

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)

Returns: EffectSound The created EffectSound

WarningCalls CreateSound, read CreateSound warning

References CreateSound(), and EffectSound.SoundPlay()

Referenced by ActionBuildShelter.PlayActionFinishSound(), ActionBuildShelter.PlayActionLoopSound(), ActionBuildShelter.PlayActionStartSound()

Show 26 more

, BearTrap.PlaySoundBiteEmpty(), BearTrap.PlaySoundBiteLeg(), BearTrap.PlaySoundOpen(), CarWheel.OnWasAttached(), CarWheel.OnWasDetached(), CrashBase.EEInit(), DayZGame.DelayedMidAirDetonation(), DayZGame.OnRPC(), Edible_Base.SoundCookingStart(), EntityAI.SoundHardBushFallingPlay(), EntityAI.SoundHardTreeFallingPlay(), EntityAI.SoundSoftBushFallingPlay(), EntityAI.SoundSoftTreeFallingPlay(), GeyserTrigger.UpdateGeyserState(), ItemBase.OnRPC(), ItemBase.PlayAttachSound(), ItemSoundHandler.PlayItemSoundClient(), LandMineTrap.PlayDisarmingLoopSound(), LandMineTrap.PlaySoundActivate(), LandMineTrap.StartActivate(), LargeTent.PlayRepackingLoopSound(), LargeTentBackPack.PlayRepackingLoopSound(), SpookyEventBase.Perform(), SpookyEventRustle.Do(), TripwireTrap.OnSteppedOn(), and Weapon_Base.OnFireModeChange()

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

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)

Returns: EffectSound The created EffectSound

WarningCalls CreateSound, read CreateSound warning

References CreateSound(), SoundParams.GetName(), and EffectSound.SoundPlayEx()

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

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)

Returns: EffectSound The created EffectSound

WarningCalls CreateSound, read CreateSound warning

References CreateSound(), GetCachedSoundParam(), SoundParams.GetName()

Show 1 more

, EffectSound.SoundPlayEx()

Referenced by BoatScript.PlaySound(), CarScript.PlaySoundEx(), ItemSoundHandler.PlayItemSoundClient()

Show 1 more

, Land_WarheadStorage_PowerStation.OnVariablesSynchronized()

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

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)

Returns: EffectSound The created EffectSound

WarningCalls CreateSound, read CreateSound warning

References CreateSound(), and EffectSound.SoundPlay()

Referenced by ContainerLockedBase.OnDoorUnlocked(), Object.PlaySoundSetAtMemoryPoint(), ScriptConsoleSoundsTab.HandleKeys()

Show 3 more

, ScriptConsoleSoundsTab.OnClick(), TrapSpawnBase.PlayCatchSound(), and TreeEffecter.OnVariablesSynchronized()

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

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)

Returns: EffectSound The created EffectSound

WarningCalls CreateSound, read CreateSound warning

References CreateSound(), Object.GetPosition(), Effect.SetLocalPosition()

Show 3 more

, EffectSound.SetParent(), EffectSound.SoundPlay(), and vector.Zero

Referenced by Bottle_Base.PlayEmptyingLoopSound(), Bottle_Base.PlayPouringLoopSound(), Bottle_Base.StopEmptyingLoopSound()

Show 8 more

, Defibrillator.DischargeClient(), Defibrillator.OnIsCharged(), Defibrillator.OnWorkStart(), HungerSoundHandlerClient.PlaySound(), Object.PlaySoundSet(), PlayerBase.EEHitByRemote(), PlayerBase.OnBleedingSourceAdded(), and PlayerBase.OnPlayerRecievedHit()

static void DestroyEffect(Effect effect)

Unregisters, stops and frees the Effect

effect_sound: EffectSound The EffectSound to free

References Effect.CanDestroy(), Effect.SetAutodestroy(), and Effect.Stop()

Referenced by ActionBuildShelter.DestroyActionLoopSound(), AnniversaryMusicSource.EEDelete(), BleedingSource.RemoveParticle()

Show 36 more

, BoatScript.CleanupEffects(), Bottle_Base.~Bottle_Base(), CarScript.CleanupEffects(), CarScript.CleanupSound(), CarScript.FixEntity(), ChristmasTree.EEDelete(), ClockBase.~ClockBase(), ClockBase.OnRingingStartClient(), ClockBase.OnRingingStopClient(), ClockBase.OnVariablesSynchronized(), DayZIntroSceneXbox.~DayZIntroSceneXbox(), Defibrillator.~Defibrillator(), DestructionEffectBase.~DestructionEffectBase(), FireworksLauncher.~FireworksLauncher(), FireworksLauncherClientEvent.~FireworksLauncherClientEvent(), FlashbangEffect.~FlashbangEffect(), FlashbangEffect.StopSound(), GeyserTrigger.StopEffects(), GeyserTrigger.StopEruption(), GeyserTrigger.UpdateGeyserState(), ItemBase.~ItemBase(), ItemBase.OnRPC(), KitchenTimer.TurnOff(), LandMineTrap.~LandMineTrap(), LargeTent.~LargeTent(), LargeTentBackPack.~LargeTentBackPack(), ParticleEffecter.~ParticleEffecter(), PlayerBase.~PlayerBase(), PlayerBase.EEDelete(), PlayerBase.SetDecayEffects(), PowerGeneratorBase.~PowerGeneratorBase(), PowerGeneratorBase.OnWorkStop(), Roadflare.EEDelete(), DestroySound(), TreeEffecter.~TreeEffecter(), and TreeEffecter.OnVariablesSynchronized()

static bool IsEffectExist(int effect_id)

Checks whether an Effect ID is registered in SEffectManager

effect_id: int The Effect ID to check

Returns: bool Whether there is an Effect registered for this ID

References m_EffectsMap, and m_IsCleanup

Referenced by CarScript.CreateCarDestroyedEffect(), CarScript.EOnPostSimulate(), and PlayerBase.SetDecayEffects()

static Effect GetEffectByID(int effect_id)

Gets the Effect with the given registered Effect ID

effect_id: int The Effect ID

Returns: Effect The Effect registered to the ID or null

References m_EffectsMap, and m_IsCleanup

static int EffectRegister(Effect effect)

Registers Effect in SEffectManager

effect: Effect The Effect to register

Returns: int The Effect ID

NoteAlready handled in SEffectManager Create/Play methods

NoteThis will make SEffectManager hold a strong ref for the Effect

References ErrorEx(), Effect.Event_OnRegistered(), string.Format()

Show 7 more

, Class.GetDebugName(), GetFreeEffectID(), Effect.GetID(), map.Insert(), Effect.IsRegistered(), m_EffectsMap, and m_IsCleanup

Referenced by CarScript.HandleDoorsSound(), CarScript.HandleEngineSound(), CarScript.HandleSeatAdjustmentSound()

Show 4 more

, CreateSound(), PlayInWorld(), PlayOnObject(), and Truck_01_Base.OnAnimationPhaseStarted()

protected static int GetFreeEffecterID()

References array.Count(), array.Get(), array.Remove()

Show 2 more

, m_FreeEffecterIDs, and m_HighestFreeEffecterID

Referenced by CreateParticleServer()

static void EffectUnregister(int id)

Unregisters Effect in SEffectManager

id: int The ID of the Effect to unregister

NoteWill automatically occur on stop when the Effect is AutoDestroy

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

NoteGeneric Play methods will also return the ID

References Effect.Event_OnUnregistered(), map.Find(), array.Find()

Show 5 more

, array.Insert(), map.Remove(), m_EffectsMap, m_FreeEffectIDs, and m_IsCleanup

Referenced by Effect.~Effect(), and EffectUnregisterEx()

static void EffectUnregisterEx(Effect effect)

Unregisters Effect in SEffectManager

effect: Effect The Effect to unregister

References EffectUnregister(), and Effect.GetID()

Referenced by BoatScript.CleanupEffects()

protected static int GetFreeEffectID()

Helper function for EffectRegister to decide an Effect ID

Returns: int A currently unused Effect ID

References array.Count(), array.Get(), array.Remove()

Show 2 more

, m_FreeEffectIDs, and m_HighestFreeEffectID

Referenced by EffectRegister()

static bool DestroySound(EffectSound sound_effect)

Legacy, backwards compatibility

sound_effect: EffectSound The EffectSound to free

Returns: bool A bool which is always true

References DestroyEffect()

Referenced by Land_Underground_Entrance.CleanUpOnClosedClient(), Land_Underground_Stairs_Exit.CleanUpOnClosedClient(), and Land_Underground_WaterReservoir.CleanSoundEffects()

static SoundParams GetCachedSoundParam(string soundset)

Get or create a cached SoundParams object

soundset: string The sound set name of the sound

Returns: SoundParams The cached SoundParams for the given soundset

References map.Find(), map.Insert(), new SoundParams()

Show 1 more

, m_ParamsMap

Referenced by PlaySoundCachedParams()

static void Event_OnSoundWaveEnded(EffectSound effect_sound)

Event called from EffectSound.Event_OnSoundWaveEnded

effect_sound: EffectSound The EffectSound calling the event

NoteEvery registered sound is registered to call this

static void Event_OnFrameUpdate(float time_delta)

Event called on frame

time_delta: float Time passed since the previous frame

NoteCalled from MissionGameplay.OnUpdate

NoteEffects register themselves by Effect.SetEnableEventFrame(true)

NoteEffectSound is automatically registered

References ScriptInvoker.Invoke(), and Event_OnFrameUpdate

Referenced by MissionGameplay.OnUpdate()

static void Init()

Initialize the containers

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

References new ScriptInvoker(), Event_OnFrameUpdate, m_EffectsMap

Show 3 more

, m_FreeEffectIDs, m_IsInitialized, and m_ParamsMap

Referenced by CGame.CGame()

static void InitServer()

References m_EffectersMap, and m_FreeEffecterIDs

Referenced by CGame.CGame()

static void Cleanup()

Cleanup method to properly clean up the static data

NoteWill be called when MissionBase is destroyed

Referenced by CGame.~CGame(), and MissionBase.MissionBase()

static int CreateParticleServer(vector pos, EffecterParameters parameters)

returns unique effecter ID

References Class.Cast(), CGame.CreateObjectEx(), GetFreeEffecterID()

Show 4 more

, EffecterBase.Init(), map.Insert(), m_EffectersMap, and EffecterParameters.m_EffecterType

Referenced by ActionFishingNew.PlaySplashEffectSynced(), ActionMineBush.OnExecuteServer(), ActionMineTree.OnExecuteServer()

Show 2 more

, CarScript.CheckContactCache(), and TrapSpawnBase.PlayCatchParticleSynced()

static void ReinitParticleServer(int effecterID, EffecterParameters parameters)

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

References map.Get(), EffecterBase.Init(), and m_EffectersMap

Referenced by ActionFishingNew.PlaySplashEffectSynced(), and TrapSpawnBase.PlayCatchParticleSynced()

static void ReactivateParticleServer(int effecterID)

References map.Get(), EffecterBase.Reactivate(), and m_EffectersMap

Referenced by ActionFishingNew.PlaySplashEffectSynced(), ActionMineBush.OnExecuteServer(), ActionMineTree.OnExecuteServer()

Show 1 more

, TrapSpawnBase.PlayCatchParticleSynced()

static void StartParticleServer(int effecterID)

References map.Get(), EffecterBase.Start(), and m_EffectersMap

static void StopParticleServer(int effecterID)

References map.Get(), EffecterBase.Stop(), and m_EffectersMap

static void DestroyEffecterParticleServer(int effecterID)

References EntityAI.DeleteSafe(), map.Get(), map.Remove()

Show 1 more

, m_EffectersMap

Referenced by ActionFishingNewCB.DestroySplashEffectSynced(), ActionMineTree.OnEndServer(), EffecterBase.DecreaseLifespan()

Show 1 more

, TrapSpawnBase.SetActive()

static void OnUpdate(float timeslice)

References EffecterBase.DecreaseLifespan(), and m_EffectersMap

Referenced by DayZGame.OnUpdate()