class EffectParticle

EffectParticle › Effect › Managed

Full hierarchy 59 Full members 91

Wrapper class for managing particles through SEffectManager

Constructors 2

void EffectParticle()

ctor

void ~EffectParticle()

dtor

References SEffectManager.DestroySound(), and m_EffectSound

Members 7

protected Particle m_ParticleObj

The main Particle effect that this Effect wrapper manages

Referenced by GetParticle(), SetParticle(), and Start()

protected int m_ParticleID

The ID in the ParticleList to create Particle from

Referenced by EffCloudDust.SelectFromSurface(), EffCloudDust.SetDefault(), GetDebugName()

Show 8 more

, GetParticleID(), SetCurrentParticleID(), SetParticleID(), Start(), EffVehicleDust.SelectFromSurface(), EffWheelContact.SelectFromSurface(), EffWheelSmoke.SelectFromSurface(), and EffWheelSmoke.SetSurface()

protected vector m_Orientation

Orientation set by SetOrientation

Referenced by GetOrientation(), and SetOrientation()

protected EffectSound m_EffectSound

Name of sound set that is going to be played when particle starts playback

Referenced by EffCloudDust.SelectFromSurface(), EffCloudDust.SetDefault(), ~EffectParticle()

Show 4 more

, SetEffectSound(), Start(), Stop(), and EffWheelContact.SelectFromSurface()

protected int m_PPFlags

Flags passed to ParticleManager.CreateParticleEx when the particle is created, see ParticlePropertiesFlags

Referenced by AddParticlePropertiesFlag(), IsSetParticlePropertiesFlag(), RemoveParticlePropertiesFlag()

Show 1 more

, Start()

protected vector m_ParticleOrientation

\name DEPRECATED Simply exist because of backwards compatibility, might have never been used

protected Object m_Object

Referenced by SetDecalOwner()

Methods 43

override void InitEffect()

init

References Effect.InitEffect(), ScriptInvoker.Remove(), Effect.Event_OnEffectEnded

Show 1 more

, Effect.Event_OnStopped

override string GetDebugName()

Override when getting debug information

References string.Format(), Class.GetDebugName(), Object.GetDebugNameNative()

Show 2 more

, GetParticle(), and m_ParticleID

override 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

References GetParticle(), and Stop()

override EffectType GetEffectType()

Get what type of effect the Effect is

Returns: EffectType What type of effect the Effect is

override bool IsParticle()

Check whether the Effect is EffectParticle without casting

Returns: bool Whether the Effect is EffectParticle

void SetParticle(Particle p)

Sets the main particle which this Effect will manage

p: Particle Main particle which this Effect will manage

References ParticleBase.GetEvents(), ScriptInvoker.Insert(), ScriptInvoker.Insert()

Show 7 more

, ScriptInvoker.Remove(), ScriptInvoker.Remove(), Effect.Event_OnEffectEnded, Effect.Event_OnEffectStarted, ParticleEvents.Event_OnParticleStart, ParticleEvents.Event_OnParticleStop, and m_ParticleObj

Referenced by EffBulletImpactBase.Event_OnStarted(), Start(), and Stop()

Particle GetParticle()

Gets the main particle which this Effect is managing

Returns: Particle Main particle which this Effect is managing

References m_ParticleObj

Referenced by BleedingSource.CreateParticle(), BleedingSource.DrawDebugShape(), BoatScript.ClearWaterEffects()

Show 27 more

, EffCoolantSteam.UpdateParticle(), EffectBoatWaterBack.Update(), EffectBoatWaterFront.Update(), EffectBoatWaterSide.Update(), AddAsChild(), GetCurrentLocalPosition(), GetCurrentOrientation(), GetCurrentParent(), GetCurrentParticleID(), GetCurrentPosition(), GetDebugName(), IsParticleCurrentRotationRelativeToWorld(), IsParticleRotationRelativeToWorld(), SetCurrentLocalPosition(), SetCurrentOrientation(), SetCurrentParticleID(), SetCurrentPosition(), Stop(), ValidateStart(), EffEngineSmoke.Event_OnFrameUpdate(), EffExhaustSmoke.ParticleParamsOverride(), EffVehicleDust.ParticleParamsOverride(), EffWheelContact.ParticleParamsOverride(), Hit_MeatBones.BloodSplatGround(), PlayerBase.OnParticleEvent(), PlayerBase.SetDecayEffects(), and VehicleVFXComponent.PlayEffectData()

override void Start()

Plays all elements this effect consists of

NoteIs called by SEffectManager.Play methods

References ParticleManager.CreateParticleEx(), Effect.GetAttachedLocalOri(), ParticleManager.GetInstance()

Show 14 more

, Effect.GetLocalPosition(), GetOrientation(), Effect.GetParent(), Effect.GetPosition(), SEffectManager.PlayOnObject(), Particle.PlayParticleEx(), SetParticle(), EffectSound.Start(), Effect.Start(), m_EffectSound, Effect.m_ParentObject, m_ParticleID, m_ParticleObj, and m_PPFlags

Referenced by CeilingDustEffectBase.Start(), EffCloudDust.SetParticleState(), EffectBoatWaterBase.SetParticleState()

Show 9 more

, EffectBoatWaterBase.Update(), EffectParticleGeneral.SetParticle(), EffVehicleDust.SetParticleState(), EffVehicleSmoke.SetParticleState(), EffWheelContact.SetParticleState(), EffWheelSmoke.SetParticleState(), ParticleEffecter.OnVariablesSynchronized(), TreeEffecter.OnVariablesSynchronized(), and VehicleVFXComponent.PlayEffectData()

override void Stop()

Stops all elements this effect consists of

NoteAlternatively use SEffectManager.Stop( effect_id )

References GetParticle(), SetParticle(), Particle.Stop()

Show 3 more

, EffectSound.Stop(), Effect.Stop(), and m_EffectSound

Referenced by BoatScript.CleanupEffects(), BoatScript.ClearWaterEffects(), EffCloudDust.SelectFromSurface()

Show 18 more

, EffCloudDust.SetDefault(), EffCloudDust.SetParticleState(), EffectBoatWaterBack.Update(), EffectBoatWaterBase.SetParticleState(), EffectBoatWaterFront.Update(), ValidateStart(), EffectParticleGeneral.SetParticle(), EffVehicleDust.SelectFromSurface(), EffVehicleDust.SetParticleState(), EffVehicleSmoke.SetParticleState(), EffWheelContact.SelectFromSurface(), EffWheelContact.SetParticleState(), EffWheelSmoke.SelectFromSurface(), EffWheelSmoke.SetParticleState(), EffWheelSmoke.SetSurface(), ParticleEffecter.OnVariablesSynchronized(), TreeEffecter.OnVariablesSynchronized(), and VehicleVFXComponent.StopEffectData()

void AttachTo(Object obj, vector local_pos = "0 0 0", vector local_ori = "0 0 0", bool force_rotation_to_world = false)

Read Particle.AddAsChild

References AddAsChild(), ForceParticleRotationRelativeToWorld(), Effect.SetAttachedLocalOri()

Show 2 more

, Effect.SetLocalPosition(), and Effect.SetParent()

Referenced by EffectBoatWaterBase.AttachTo()

void ReAttach()

Helper method to attach to parent using stored settings

References AddAsChild(), Effect.GetAttachedLocalOri(), Effect.GetLocalPosition()

Show 2 more

, Effect.GetParent(), and IsParticleRotationRelativeToWorld()

Referenced by SetCurrentLocalPosition(), and SetCurrentParent()

protected void AddAsChild(Object obj, vector local_pos, vector local_ori, bool force_rotation_to_world)

Helper method to attach to parent

References Particle.AddAsChild(), and GetParticle()

Referenced by AttachTo(), and ReAttach()

void Event_OnPlayStart()

Event which just simply exists (DEPRECATED)

NoteUse Event_OnStarted instead

WarningNever called or used

void Event_OnPlayStarted()

Event which just simply exists (DEPRECATED)

NoteUse Event_OnStarted instead

WarningNever called or used

void SetParticleID(int id)

Sets the id of the particle to be used

id: int Particle ID registered in ParticleList

NoteOnly changes the cached variable, for immediate, use SetCurrentParticleID

References m_ParticleID

Referenced by BleedingSourceEffect.BleedingSourceEffect(), BleedingSourceEffectLight.BleedingSourceEffectLight(), BloodSplatter.BloodSplatter()

Show 18 more

, EffBreathVapourHeavy.EffBreathVapourHeavy(), EffBreathVapourLight.EffBreathVapourLight(), EffBreathVapourMedium.EffBreathVapourMedium(), EffBulletImpactTest.EffBulletImpactTest(), EffCloudDust.SetParticleState(), EffectBoatWaterBase.SetParticleState(), EffectParticleGeneral.SetParticleID(), EffGeneratorSmoke.EffGeneratorSmoke(), EffSwarmingFlies.EffSwarmingFlies(), EffVehicleDust.SetParticleState(), EffVehicleSmoke.SetParticleState(), EffVomit.EffVomit(), EffVomitBlood.EffVomitBlood(), EffWheelContact.SetParticleState(), EffWheelSmoke.SetParticleState(), LandmineExplosion.LandmineExplosion(), MenuCarEngineSmoke.MenuCarEngineSmoke(), and MenuEvaporation.MenuEvaporation()

int GetParticleID()

Gets the id of the particle to be used

Returns: int Particle ID registered in ParticleList

WarningOnly gets the cached variable, for immediate effect use GetCurrent variant

References m_ParticleID

void SetCurrentParticleID(int id)

Sets the id of the particle to be used

id: int Particle ID registered in ParticleList

NoteParticle will not update immediately, but ParticleSource will

References GetParticle(), Particle.SetSource(), and m_ParticleID

int GetCurrentParticleID()

Gets the current id of the managed Particle

Returns: int Particle ID registered in ParticleList

References GetParticle(), Particle.GetParticleID(), and ParticleList.INVALID

override void SetCurrentParent(Object parent_obj, bool updateCached = true)

Set current parent of the managed Particle

parent_obj: Object The parent for the Particle
updateCached: bool Whether to update the cached variable

References ReAttach(), and Effect.SetCurrentParent()

override Object GetCurrentParent()

Get the current parent of the managed Particle

Returns: Object The currrent parent of the Particle

References Class.Cast(), IEntity.GetParent(), Effect.GetParent()

Show 1 more

, GetParticle()

override void SetCurrentPosition(vector pos, bool updateCached = true)

Set the current world position of the managed Particle

pos: vector The current world position for the Particle
updateCached: bool Whether to update the cached variable

References GetParticle(), Effect.SetCurrentPosition(), and Object.SetPosition()

override vector GetCurrentPosition()

Get the current world position of the managed Particle

Returns: vector The current world position of the managed Particle

References GetParticle(), Object.GetPosition(), and Effect.GetPosition()

override void SetCurrentLocalPosition(vector pos, bool updateCached = true)

Set the current local position of the managed Particle

pos: vector The current local position for the managed Particle
updateCached: bool Whether to update the cached variable

References Effect.GetParent(), GetParticle(), ReAttach()

Show 2 more

, Effect.SetCurrentLocalPosition(), and Object.SetPosition()

Referenced by EffectBoatWaterBase.UpdatePosToSeaLevel(), and VehicleVFXComponent.SetEffectDataPosition()

override vector GetCurrentLocalPosition()

Get the current local position of the managed Particle

Returns: vector The current local position of the managed Particle

References Effect.GetLocalPosition(), Effect.GetParent(), GetParticle()

Show 2 more

, Object.GetPosition(), and Object.WorldToModel()

void SetOrientation(vector ori)

Set orientation of the EffectParticle

ori: vector Orientation in degrees (yaw, pitch, roll)

WarningOnly sets the cached variable, for immediate effect use SetCurrent variant

References m_Orientation

Referenced by SetCurrentOrientation()

vector GetOrientation()

Get the orientation of the EffectParticle

Returns: vector The orientation of EffectParticle

WarningOnly gets the cached variable, for immediate effect use GetCurrent variant

References m_Orientation

Referenced by Start()

void SetCurrentOrientation(vector ori, bool updateCached = true)

Set the current orientation of the managed Particle

ori: vector Orientation in degrees (yaw, pitch, roll)

References GetParticle(), SetOrientation(), and Object.SetOrientation()

vector GetCurrentOrientation()

Get the current orientation of the managed Particle

Returns: vector The current orientation of the managed Particle

References Object.GetOrientation(), GetParticle(), and vector.Zero

protected void AddParticlePropertiesFlag(ParticlePropertiesFlags flag)

References m_PPFlags

Referenced by DisableParticleInUI(), and ForceParticleRotationRelativeToWorld()

protected void RemoveParticlePropertiesFlag(ParticlePropertiesFlags flag)

References m_PPFlags

Referenced by DisableParticleInUI(), and ForceParticleRotationRelativeToWorld()

protected bool IsSetParticlePropertiesFlag(ParticlePropertiesFlags flag)

References m_PPFlags

Referenced by IsDisableParticleInUI(), and IsParticleRotationRelativeToWorld()

void ForceParticleRotationRelativeToWorld(bool state)

Set orientation setting to be used by the effect when the Effect starts

state: bool Whether to keep WS orientation when attaching it to parent

NoteThere is no way to update this immediately

WarningOnly caches it into a variable to be used by Start, does not live update when called afterwards

References AddParticlePropertiesFlag(), and RemoveParticlePropertiesFlag()

Referenced by AttachTo(), and SEffectManager.PlayOnObject()

bool IsParticleRotationRelativeToWorld()

Get the orientation setting to be used by the effect when the Effect starts

Returns: bool Whether to keep WS orientation when attaching it to parent

WarningOnly gets the cached variable, for immediate effect use IsParticleCurrentRotationRelativeToWorld

References GetParticle(), IEntity.IsHierarchyPositionOnly(), and IsSetParticlePropertiesFlag()

Referenced by ReAttach()

void DisableParticleInUI(bool disable)

Disable creating particle for preview player

disable: bool Is particle not draw

References AddParticlePropertiesFlag(), and RemoveParticlePropertiesFlag()

Referenced by EffCloudDust.EffCloudDust()

bool IsDisableParticleInUI()

References IsSetParticlePropertiesFlag()

bool IsParticleCurrentRotationRelativeToWorld()

Get the current orientation setting to be used by the managed Particle

Returns: bool Whether the managed Particle is only updating position from parent

References GetParticle(), and IEntity.IsHierarchyPositionOnly()

void SetEffectSound(EffectSound effectSound)

Set effect sound play with particle

References SEffectManager.DestroySound(), and m_EffectSound

Referenced by EffCloudDust.SelectFromSurface(), EffCloudDust.SetDefault(), and EffWheelContact.SelectFromSurface()

void SelectFromSurface(string surface)

Selection of particle based on Surface

Referenced by VehicleVFXComponent.PlayEffectData()

void SelectFromSurface(SurfaceInfo surfaceInfo)

Referenced by VehicleVFXComponent.PlayEffectData()

void SetParticleState(int state)

Referenced by VehicleVFXComponent.SetEffectGroupParticleState(), and VehicleVFXComponent.SetEffectParticleState()

void ParticleParamsOverride(notnull ParticleParamsOverrideData data)

Callback for overriding effect's particle attributes

Referenced by VehicleVFXComponent.PlayEffectData()

void CheckLifeSpan()

Was never called and probably should never be called

WarningEmptied the functionality as it is relatively unsafe...

void SetDecalOwner(Object o)

References m_Object

Referenced by PlayerBase.OnParticleEvent(), and PlayerBase.SetDecayEffects()