DIFF

class EffectSource

Effect › Managed

Derived classes
EffectParticleEffectSound
View all 53 descendants

All members, including inherited

Constructors 2

void Effect()

ctor

References ErrorEx(), InitEffect(), CGame.IsDedicatedServer()
Show 1 more, m_IsPlaying
void ~Effect()

dtor

References SEffectManager.EffectUnregister(), GetID(), IsRegistered()
Show 2 more, SetEnableEventFrame(), and Stop()

Members 14

ref ScriptInvoker Event_OnStarted = new ScriptInvoker()

\name Event invokers ScriptInvonkers for certain events

Referenced by InitEffect(), Start(), and EffectSound.InitEffect()
ref ScriptInvoker Event_OnStopped = new ScriptInvoker()
Referenced by InitEffect(), Stop(), EffectParticle.InitEffect()
Show 1 more, EffectSound.InitEffect()
ref ScriptInvoker Event_OnEffectStarted = new ScriptInvoker()
Referenced by Event_OnEffectStarted(), InitEffect(), EffectParticle.SetParticle()
Show 1 more, EffectSound.InitEffect()
protected bool m_IsAutodestroy

Whether the Effect cleans up after itself when stopped

Referenced by IsAutodestroy(), and SetAutodestroy()
protected bool m_IsPendingDeletion

Whether the Destroy process has already been called

Referenced by Destroy(), and IsPendingDeletion()
protected bool m_IsPlaying

Whether the Effect is currently playing

Referenced by Effect(), Event_OnEffectEnded(), Event_OnEffectStarted()
Show 2 more, IsPlaying(), and EffectSound.SoundReset()
protected Object m_ParentObject

Cached parent

Referenced by GetParent(), SetParent(), EffectParticle.Start()
Show 3 more, EffectSound.GetCurrentPosition(), EffectSound.SoundLoadEx(), and EffectSound.SoundPlayEx()
protected int m_PivotIndex = -1

Cached parent pivot id

Referenced by GetPivotIndex(), SetParent(), EffectSound.SoundLoadEx()
Show 1 more, EffectSound.SoundPlayEx()
protected vector m_Position

Cached world position

Referenced by GetPosition(), and SetPosition()
protected int m_ID

ID of effect, given by SEffectManager when registered (automatically done when playing through it)

Referenced by GetID(), and SetID()
protected bool m_IsRegistered

Whether the effect is registered in SEffectManager

Referenced by Event_OnRegistered(), Event_OnUnregistered(), and IsRegistered()
protected vector m_LocalPos

Cached local pos

Referenced by GetLocalPosition(), and SetLocalPosition()
protected vector m_LocalOri

Local orientation set by SetAttachedLocalOri, only used by EffectParticle

Referenced by GetAttachedLocalOri(), and SetAttachedLocalOri()

Methods 45

EffectType GetEffectType()

Get what type of effect the Effect is

Returns: EffectType What type of effect the Effect is

Referenced by SEffectManager.Cleanup()
bool IsSound()

Check whether the Effect is EffectSound without casting

Returns: bool Whether the Effect is EffectSound

bool IsParticle()

Check whether the Effect is EffectParticle without casting

Returns: bool Whether the Effect is EffectParticle

void Start()

Plays all elements this effects consists of

NoteIs called by SEffectManager.Play methods
References Event_OnStarted(), ScriptInvoker.Invoke(), IsPlaying()
Show 1 more, Event_OnStarted
Referenced by EffectParticle.Start(), EffectSound.SoundPlayEx(), SEffectManager.PlayInWorld()
Show 1 more, SEffectManager.PlayOnObject()
void ValidateStart()

Validation whether an effect truly started playing or if the Effect should stop as none is present

NoteOverride this when inheriting to create own validation check
NoteIs called from Event_OnStarted invoker after Event_OnStarted has been performed
void Stop()

Stops all elements this effect consists of

NoteAlternatively use SEffectManager.Stop( effect_id )
References Event_OnStopped(), ScriptInvoker.Invoke(), IsPlaying()
Show 1 more, Event_OnStopped
Referenced by ~Effect(), Destroy(), EffectParticle.Stop()
Show 5 more, EffectSound.SoundStop(), SEffectManager.DestroyEffect(), SEffectManager.PlayInWorld(), SEffectManager.PlayOnObject(), and SEffectManager.Stop()
protected void Destroy()

Cleans up the Effect, including unregistering if needed

NoteWill stop the Effect and queue up the deletion in the callqueue
NoteIs intended for usage from within the Effect itself, use SEffectManager.DestroyEffect when working from a pointer
References ScriptCallQueue.Call(), DayZGame.GetCallQueue(), IsPendingDeletion()
Show 2 more, Stop(), and m_IsPendingDeletion
Referenced by Event_OnEffectEnded()
void SetAutodestroy(bool auto_destroy)

Sets whether Effect automatically cleans up when it stops

auto_destroy
bool Whether Effect automatically cleans up when it stops
NoteThis means that it will be unregistered from SEffectManager as well
References m_IsAutodestroy
Referenced by AmmoEffects.PlayAmmoEffect(), EffectSound.SetAutodestroy(), Hit_MeatBones.BloodSplatGround()
Show 3 more, ImpactMaterials.EvaluateImpactEffect(), PlayerBase.OnParticleEvent(), and SEffectManager.DestroyEffect()
bool IsAutodestroy()

Get whether Effect automatically cleans up when it stops

Returns: bool Whether Effect automatically cleans up when it stops

References m_IsAutodestroy
Referenced by Event_OnEffectEnded()
bool IsPendingDeletion()

Get whether the Effect is queued up for being cleaned up

Returns: bool Whether the Effect is queued up for being cleaned up

References m_IsPendingDeletion
Referenced by Destroy(), and EffectSound.SoundStop()
bool CanDestroy()

Get whether the Effect can be destroyed right now

Returns: bool Whether the Effect can be destroyed right now

Referenced by SEffectManager.DestroyEffect()
void SetEnableEventFrame(bool enable)

Enable Event_OnFrameUpdate for the effect

NoteRead SEffectManager.Event_OnFrameUpdate for more info
References ScriptInvoker.Insert(), ScriptInvoker.Remove(), and SEffectManager.Event_OnFrameUpdate
Referenced by ~Effect(), EffectSound.UpdateEvents(), and EffEngineSmoke.EffEngineSmoke()
void Event_OnStarted()

Event used when Start was called

Referenced by Start()
void Event_OnStopped()

Event used when Stop was called

Referenced by Stop()
void Event_OnEffectStarted()

Event used when the actual effect started playing

References ScriptInvoker.Invoke(), Event_OnEffectStarted, and m_IsPlaying
Referenced by EffectSound.Event_OnSoundWaveStarted()
void Event_OnEffectEnded()

Event used when the actual effect stopped playing

References Destroy(), ScriptInvoker.Invoke(), IsAutodestroy()
Show 2 more, Event_OnEffectEnded, and m_IsPlaying
Referenced by EffectSound.Event_OnSoundWaveEnded()
void Event_OnFrameUpdate(float time_delta)

Event called on frame when enabled by SetEnableEventFrame(true)

time_delta
float Time passed since the previous frame
NoteCalled from SEffectManager.Event_OnFrameUpdate in MissionGameplay.OnUpdate
void Event_OnRegistered(int id)

Event called from SEffectManager when the Effect is registered

id
int ID registered in SEffectManager
NoteShould only ever be called by SEffectManager!
References SetID(), and m_IsRegistered
Referenced by EffectSound.Event_OnRegistered(), and SEffectManager.EffectRegister()
void Event_OnUnregistered()

Event called from SEffectManager when the Effect is unregistered

NoteShould only ever be called by SEffectManager!
References SetID(), SEffectManager.INVALID_ID, and m_IsRegistered
Referenced by EffectSound.Event_OnUnregistered(), SEffectManager.Cleanup(), and SEffectManager.EffectUnregister()
void OnCheckUpdate()

Event used when EffectParticle.CheckLifeSpan was called (DEPRECATED)

NoteSo this is EffectParticle specific...
NoteEffectParticle.CheckLifeSpan is currently not in use
void SetParent(Object parent_obj, int pivot)

Set parent of the Effect

parent_obj
Object The parent
pivot
int The pivot index
NoteSame as SetAttachmentParent, but more generic name
WarningOnly sets the cached variable, for immediate effect use SetCurrent variant
References m_ParentObject, and m_PivotIndex
Referenced by SetAttachmentParent(), SetCurrentParent(), EffectParticle.AttachTo()
Show 2 more, EffectSound.SetParent(), and SEffectManager.PlayOnObject()
void SetParent(Object parent_obj)

Set parent of the Effect

parent_obj
Object The parent for the Effect
NoteSame as SetAttachmentParent, but more generic name
WarningOnly sets the cached variable, for immediate effect use SetCurrent variant
Referenced by SetAttachmentParent(), SetCurrentParent(), EffectParticle.AttachTo()
Show 2 more, EffectSound.SetParent(), and SEffectManager.PlayOnObject()
Object GetParent()

Get parent of the Effect

Returns: Object The parent of the Effect

NoteSame as GetAttachmentParent, but more generic name
WarningOnly gets the cached variable, for immediate effect use GetCurrent variant
References m_ParentObject
Referenced by GetAttachmentParent(), EffectParticle.GetCurrentLocalPosition(), EffectParticle.GetCurrentParent()
Show 5 more, EffectParticle.ReAttach(), EffectParticle.SetCurrentLocalPosition(), EffectParticle.Start(), EffectSound.GetCurrentParent(), and EffectSound.GetParent()
int GetPivotIndex()

Get parent pivot of the Effect, only valid when there is some GetParent

Returns: int The parent pivot of the Effect

WarningOnly gets the cached variable
References m_PivotIndex
Referenced by EffectSound.GetPivotIndex()
void SetCurrentParent(Object parent_obj, bool updateCached = true)

Set current parent of the managed effect

parent_obj
Object The parent for the Effect
updateCached
bool Whether to update the cached variable
NoteSame as SetAttachmentParent, but more generic name
References SetParent()
Referenced by EffectParticle.SetCurrentParent()
Object GetCurrentParent()

Get the current parent of the managed Effect

Returns: Object The current parent of the managed Effect

void SetPosition(vector pos)

Set the world position of the Effect

pos
vector The world position for the Effect
WarningOnly sets the cached variable, for immediate effect use SetCurrent variant
References m_Position
Referenced by CarScript.CreateSoundForAnimationSource(), CarScript.HandleEngineSound(), CarScript.PlaySoundEx()
Show 4 more, SetCurrentPosition(), SEffectManager.CreateSound(), SEffectManager.PlayInWorld(), and SEffectManager.PlayOnObject()
vector GetPosition()

Get the world position of the Effect

Returns: vector The world position of the Effect

WarningOnly gets the cached variable, for immediate effect use GetCurrent variant
References m_Position
Referenced by EffectParticle.GetCurrentPosition(), EffectParticle.Start(), EffectSound.GetCurrentLocalPosition()
Show 4 more, EffectSound.GetCurrentPosition(), EffectSound.SoundLoadEx(), EffectSound.SoundPlayEx(), and Hit_MeatBones.Event_OnStarted()
void SetCurrentPosition(vector pos, bool updateCached = true)

Set the current world position of the managed effect

pos
vector The current world position for the Effect
updateCached
bool Whether to update the cached variable
References SetPosition()
Referenced by EffectParticle.SetCurrentPosition(), and EffectSound.SetCurrentPosition()
vector GetCurrentPosition()

Get the current world position of the managed effect

Returns: vector The current world position of the managed effect

References vector.Zero
void SetLocalPosition(vector pos)

Set the local position of the Effect

pos
vector The local position for the Effect
WarningOnly sets the cached variable, for immediate effect use SetCurrent variant
References m_LocalPos
Referenced by BoatScript.HandleBoatSplashSound(), CarScript.CreateSoundForAnimationSource(), CarScript.HandleEngineSound()
Show 5 more, SetAttachedLocalPos(), SetCurrentLocalPosition(), EffectParticle.AttachTo(), SEffectManager.PlayOnObject(), and SEffectManager.PlaySoundOnObject()
vector GetLocalPosition()

Get the local position of the Effect

Returns: vector The lcoal position of the Effect

WarningOnly gets the cached variable, for immediate effect use GetCurrent variant
References m_LocalPos
Referenced by GetAttachedLocalPos(), EffectBoatWaterFront.Update(), EffectBoatWaterSide.Update()
Show 4 more, EffectParticle.GetCurrentLocalPosition(), EffectParticle.ReAttach(), EffectParticle.Start(), and EffectSound.GetCurrentLocalPosition()
void SetCurrentLocalPosition(vector pos, bool updateCached = true)

Set the current local position of the managed effect

pos
vector The current local position for the managed effect
updateCached
bool Whether to update the cached variable
References SetLocalPosition()
Referenced by EffectParticle.SetCurrentLocalPosition(), and EffectSound.SetCurrentLocalPosition()
vector GetCurrentLocalPosition()

Get the current local position of the managed effect

Returns: vector The current local position of the managed effect

References vector.Zero
protected void SetID(int id)

Set the ID registered in SEffectManager

id
int ID registered in SEffectManager
NoteShould only ever be called by Event_OnRegistered!
References m_ID
Referenced by Event_OnRegistered(), and Event_OnUnregistered()
int GetID()

Get the ID registered in SEffectManager

Returns: int ID registered in SEffectManager, or 0 (SEffectManager.INVALID_ID) when not registered

References m_ID
Referenced by ~Effect(), SEffectManager.EffectRegister(), and SEffectManager.EffectUnregisterEx()
bool IsRegistered()

Get whether this Effect is registered in SEffectManager

Returns: bool Whether this Effect is registered in SEffectManager

References m_IsRegistered
Referenced by BoatScript.CleanupEffects(), ~Effect(), and SEffectManager.EffectRegister()
void SetAttachmentParent(Object obj)

Set parent for the Effect

obj
Object The parent for the Effect
References SetParent()
Referenced by BoatScript.HandleBoatSplashSound(), and BoatScript.PlaySound()
Object GetAttachmentParent()

Get the parent set by SetAttachmentParent

Returns: Object The parent set by SetAttachmentParent

References GetParent()
Referenced by EffCoolantSteam.UpdateParticle(), EffEngineSmoke.Event_OnFrameUpdate(), and EffExhaustSmoke.SetParticleStateLight()
void SetAttachedLocalPos(vector pos)

Set local pos for the Effect relative to the parent

pos
vector The local pos relative to the parent
References SetLocalPosition()
Referenced by FlashbangEffect.PlaySound()
vector GetAttachedLocalPos()

Get the local pos set by SetAttachedLocalPos

Returns: vector The local pos set by SetAttachedLocalPos

References GetLocalPosition()
void SetAttachedLocalOri(vector ori)

Set local orientation for the Effectparticle to attach to when the Effect is started

ori
vector The local orientation to use on Start
NoteOverrides the orientation set by EffectParticle.SetOrientation
WarningOnly caches it into a variable to be used by Start, does not live update when called afterwards
References m_LocalOri
Referenced by EffectParticle.AttachTo(), and SEffectManager.PlayOnObject()
vector GetAttachedLocalOri()

Get the local orientation set by SetAttachedLocalOri

Returns: vector The local orientation set by SetAttachedLocalOri

WarningIs not necessarily the current local orientation
References m_LocalOri
Referenced by EffectParticle.ReAttach(), and EffectParticle.Start()