Legacy way of using particles in the game. More...

Private Member Functions
Playback
Methods regarding playing/stopping of particle
override void	PlayParticle (int particle_id=-1)
	Method to tell the particle to start playing.

override bool	PlayParticleEx (int particle_id=-1, int flags=0)
	Method to tell the particle to start playing.

void	Play (int particle_id=-1)
	Legacy function for backwards compatibility with 1.01 and below.

override bool	StopParticle (int flags=0)
	Method to tell the particle to stop playing.

void	Stop ()
	Legacy function for backwards compatibility with 1.14 and below.

Properties and state
Obtain information or set properties regarding the state of the Particle
void	SetSource (int particle_id)
	Sets particle id.

int	GetParticleID ()
	Gets particle id.

Object	GetDirectParticleEffect ()
	Returns direct particle effect entity which is usually handled by this class 'Particle' if there is one.

Object	GetParticleParent ()
	Returns the parent of this Particle if there is one.

bool	HasActiveParticle ()
	Returns if there is any particle active.

int	GetParticleCount ()
	Returns the total count of active particles in all emitors.

bool	IsRepeat ()
	Returns whether there is a repeating particle.

float	GetMaxLifetime ()
	Returns the approx. max lifetime.

Misc Particle specific helpers
Functionality specific for Particle
protected void	UpdateState ()
	Creates/Destroys ParticleEffect child according to current state.

private void	CreateParticleEffect ()
	Creates ParticleEffect child, called from UpdateState.

private void	DestroyParticleEffect ()
	Destroys ParticleEffect child, called from UpdateState.

override void	EOnFrame (IEntity other, float timeSlice)
	OnFrame update event decrementing the stored approx. lifetime and checking for deletion.

void	OnCheckAutoDelete ()
	Creates ParticleEffect child, called from UpdateState.

private void	OnToDelete ()
	Called before deletion from OnCheckAutoDelete.

Misc
Various helpers
void	AddAsChild (Object parent, vector local_pos="0 0 0", vector local_ori="0 0 0", bool force_rotation_to_world=false)
	Attaches this particle onto some object. If null value is provided then the particle will be detached from the current parent.

Parameter API
Helpful methods for getting or setting parameters
void	SetParticleParam (int parameter_id, float value)
	Set the value of a parameter of all emitors in the particle.

void	SetParameter (int emitter, int parameter, float value)
	Set the value of a parameter of an emitor in the particle.

void	GetParameter (int emitter, int parameter, out float value)
	Get the value of a parameter of an emitor in the particle.

float	GetParameterEx (int emitter, int parameter)
	Get the value of a parameter of an emitor in the particle.

float	GetParameterOriginal (int emitter, int parameter)

void	ScaleParticleParamFromOriginal (int parameter_id, float coef)
	Scales the given parameter on all emitors relatively to their ORIGINAL value.

void	ScaleParticleParam (int parameter_id, float coef)
	Scales the given parameter on all emitors relatively to their CURRENT value.

void	IncrementParticleParamFromOriginal (int parameter_id, float value)
	Increments the value of the given parameter relatively from the ORIGINAL value.

void	IncrementParticleParam (int parameter_id, float value)
	Increments the value of the given parameter relatively from the CURRENT value.

Static Private Member Functions
Create a particle (static)
You can create a particle either at some position, or create it as a child on some object.
static Particle	CreateOnObject (int particle_id, Object parent_obj, vector local_pos="0 0 0", vector local_ori="0 0 0", bool force_world_rotation=false)
	Creates a particle emitter and attaches it on the given object.

static Particle	Create (int particle_id, Object parent_obj, vector local_pos="0 0 0", vector local_ori="0 0 0")
	Legacy function for backwards compatibility.

static Particle	CreateInWorld (int particle_id, vector global_pos, vector global_ori="0 0 0", bool force_world_rotation=false)
	Creates a particle emitter on the given position.

static Particle	Create (int particle_id, vector global_pos, vector global_ori="0 0 0")
	Legacy function for backwards compatibility with 1.01 and below.

Static play on creation
You can use the following Play(...) functions to create and activate a particle in 1 line of your script.
static Particle	PlayOnObject (int particle_id, Object parent_obj, vector local_pos="0 0 0", vector local_ori="0 0 0", bool force_world_rotation=false)
	Creates a particle emitter, attaches it on the given object and activates it.

static Particle	Play (int particle_id, Object parent_obj, vector local_pos="0 0 0", vector local_ori="0 0 0")
	Legacy function for backwards compatibility with 1.01 and below.

static Particle	PlayInWorld (int particle_id, vector global_pos)
	Creates a particle emitter on the given position and activates it.

static Particle	Play (int particle_id, vector global_pos)
	Legacy function for backwards compatibility with 1.01 and below.

Private Attributes
Generic data
Generic data for the Particle
protected int	m_ParticleID
	ID from ParticleList if assigned.

protected float	m_Lifetime
	Approx. remaining lifetime of particle.

protected bool	m_IsRepeat
	Whether this particle repeats.

private bool	m_MarkedForDeletion
	Whether this particle is queued for deletion.

Wiggle API
Settings to make the Particle wiggle
bool	m_WiggleProcessing
	Used for Wiggle API, to signal that wiggle API is currently doing work.

bool	m_ForceOrientationRelativeToWorld
	Used for Wiggle API, to restore after unparenting.

vector	m_DefaultOri
	Used for Wiggle API, to restore after unparenting.

vector	m_DefaultPos
	Used for Wiggle API, to restore after unparenting.

vector	m_DefaultWorldOri
	Used for Wiggle API, to restore after unparenting.

vector	m_DefaultWorldPos
	Used for Wiggle API, to restore after unparenting.

float	m_MaxOriWiggle
	Used for Wiggle API, Wiggle room [-m_MaxOriWiggle, m_MaxOriWiggle].

float	m_MaxOriInterval
	Used for Wiggle API, Interval for wiggling [0, m_MaxOriInterval[.

ref Timer	m_RandomizeOri
	Used for Wiggle API, calls the Wiggle functionality.

protected Object	m_ParentObject
	Parent Object the Particle is child of.

protected Object	m_ParticleEffect
	The child object which contains the actual particle.

protected int	m_PreviousFrame
	DEPRECATED.

private vector	m_GlobalPosPreviousFrame
	DEPRECATED.

static private const int	MAX_EMITORS = 30
	DEPRECATED

void	Particle ()
	ctor

protected void	ParticleInit ()
	Purely here so that it can be emptied in ParticleSource.

bool	IsWiggling ()
	Checks if particle is currently wiggling.

void	SetWiggle (float random_angle, float random_interval)
	Makes the particle change direction by random_angle every random_interval seconds.

void	StopWiggle ()
	Stops randomized wiggle.

void	RandomizeOrientation ()
	Randomizes a new orientation and applies it.

protected vector	RandWiggleVector ()
	Helper to get a randomized wiggle vector.

protected float	RandWiggleFloat ()
	Helper to get a randomized wiggle float value.

Detailed Description

Legacy way of using particles in the game.

Note: They work okay when just needing to play a particle once every once in a while But are extremely wasteful when it comes to playing multiple Particles at the same time

Constructor & Destructor Documentation

◆ Particle()

void Particle ( )

inlineprivate

ctor

References ParticleInit().

Member Function Documentation

◆ AddAsChild()

void AddAsChild	(	Object	parent,
		vector	local_pos = `"0 0 0"`,
		vector	local_ori = `"0 0 0"`,
		bool	force_rotation_to_world = `false`
	)

inlineprivate

Attaches this particle onto some object. If null value is provided then the particle will be detached from the current parent.

Note: Due to the members being filled in, AddChild/RemoveChild cannot be used with Particle when using Wiggle

Parameters

parent	`Object` Parent onto which this particle will be attached
local_pos	`vector` Attachment position local to the parent (optional)
local_ori	`vector` Orientation local to the parent (Pitch, Yawn, Roll in degrees) (Optional)
force_rotation_to_world	`bool` Force rotation to be in WS (Optional)

References AddChild(), m_DefaultPos, m_ForceOrientationRelativeToWorld, m_ParentObject, m_ParticleEffect, and SetPosition().

Referenced by EffectParticle::AddAsChild(), CreateOnObject(), and RandomizeOrientation().

◆ Create() [1/2]

static Particle Create	(	int	particle_id,
		Object	parent_obj,
		vector	local_pos = `"0 0 0"`,
		vector	local_ori = `"0 0 0"`
	)

inlinestaticprivate

Legacy function for backwards compatibility.

References CreateOnObject(), and particle_id.

◆ Create() [2/2]

static Particle Create	(	int	particle_id,
		vector	global_pos,
		vector	global_ori = `"0 0 0"`
	)

inlinestaticprivate

Legacy function for backwards compatibility with 1.01 and below.

References CreateInWorld(), and particle_id.

◆ CreateInWorld()

static Particle CreateInWorld	(	int	particle_id,
		vector	global_pos,
		vector	global_ori = `"0 0 0"`,
		bool	force_world_rotation = `false`
	)

inlinestaticprivate

Creates a particle emitter on the given position.

Parameters

particle_id	`int` Particle ID registered in ParticleList
global_pos	`Vector` Position where the particel will be created
global_ori	`vector` Orientation (Pitch, Yawn, Roll in degrees) (Optional)
force_world_rotation	`bool` Forces particle's orientation to rotate relative to the world and not with the object (Optional)

Returns: Particle Created particle instance

References ECE_LOCAL, GetGame(), m_ForceOrientationRelativeToWorld, particle_id, and SetSource().

Referenced by Create(), CreateOnObject(), and PlayInWorld().

◆ CreateOnObject()

static Particle CreateOnObject	(	int	particle_id,
		Object	parent_obj,
		vector	local_pos = `"0 0 0"`,
		vector	local_ori = `"0 0 0"`,
		bool	force_world_rotation = `false`
	)

inlinestaticprivate

Creates a particle emitter and attaches it on the given object.

Parameters

particle_id	`int` Particle ID registered in ParticleList
parent_obj	`Object` Instance on which this particle will be attached
local_pos	`vector` Attachment position local to the parent (Optional)
local_ori	`vector` Orientation local to the parent (Pitch, Yawn, Roll in degrees) (Optional)
force_world_rotation	`bool` Forces particle's orientation to rotate relative to the world and not with the object (Optional)

Returns: Particle Created particle instance

References AddAsChild(), CreateInWorld(), Error(), m_DefaultOri, particle_id, and Vector().

Referenced by Create(), and PlayOnObject().

◆ CreateParticleEffect()

private void CreateParticleEffect ( )

inlineprivate

Creates ParticleEffect child, called from UpdateState.

References AddChild(), CGame::CreateObjectEx(), ECE_LOCAL, ErrorEx, GetGame(), GetMaxLifetime(), GetObject(), ParticleList::GetParticleFullPath(), IsRepeat(), m_ForceOrientationRelativeToWorld, m_IsPlaying, m_IsRepeat, m_Lifetime, m_ParticleEffect, m_ParticleID, ReleaseObject(), and vector::Zero.

Referenced by UpdateState().

◆ DestroyParticleEffect()

private void DestroyParticleEffect ( )

inlineprivate

Destroys ParticleEffect child, called from UpdateState.

Note: Does not destroy it immediately As it simply nulls the lifetime Then it will be cleaned up by EOnFrame eventually

References GetGame(), m_IsRepeat, m_ParticleEffect, and SetParameter().

Referenced by UpdateState().

◆ EOnFrame()

override void EOnFrame	(	IEntity	other,
		float	timeSlice
	)

inlineprivate

OnFrame update event decrementing the stored approx. lifetime and checking for deletion.

References m_Lifetime, and OnCheckAutoDelete().

◆ GetDirectParticleEffect()

Object GetDirectParticleEffect ( )

inlineprivate

Returns direct particle effect entity which is usually handled by this class 'Particle' if there is one.

Note: Is a child of this Particle

Returns: Object The Object with the particle component or null

References m_ParticleEffect.

Referenced by FlammableBase::UpdateLight().

◆ GetMaxLifetime()

float GetMaxLifetime ( )

inlineprivate

Returns the approx. max lifetime.

Returns: float The largest lifetime sum among the emitors

References GetParticleEmitorCount(), GetParticleParm(), and m_ParticleEffect.

Referenced by CreateParticleEffect(), and OnCheckAutoDelete().

◆ GetParameter()

void GetParameter	(	int	emitter,
		int	parameter,
		out float	value
	)

inlineprivate

Get the value of a parameter of an emitor in the particle.

Parameters

emitter	`int` The emitor to get the value from
parameter	`int` The parameter to get the value from (enum EmitorParam)
value	`float` The value

References GetParticleParm(), and m_ParticleEffect.

◆ GetParameterEx()

float GetParameterEx	(	int	emitter,
		int	parameter
	)

inlineprivate

Get the value of a parameter of an emitor in the particle.

Parameters

emitter	`int` The emitor to get the value from
parameter	`int` The parameter to get the value from (enum EmitorParam)

Returns: float The value

References GetParticleParm(), and m_ParticleEffect.

◆ GetParameterOriginal()

float GetParameterOriginal	(	int	emitter,
		int	parameter
	)

inlineprivate

References GetParticleParmOriginal(), and m_ParticleEffect.

Referenced by EffectBoatWaterBase::EnableEmitor(), Update(), and EffectBoatWaterBack::Update().

◆ GetParticleCount()

int GetParticleCount ( )

inlineprivate

Returns the total count of active particles in all emitors.

Note: Internally does a sum, HasActiveParticle is better for a quick check

Returns: int Total count of active particles

References m_ParticleEffect, and ParticleGetCount().

Referenced by OnCheckAutoDelete().

◆ GetParticleID()

int GetParticleID ( )

inlineprivate

Gets particle id.

Note: This is not necessarily the CURRENT particle As one can use SetSource while the Particle is still playing But that will not change the particle before Particle is played again

Returns: int The last set Particle ID registered in ParticleList

References m_ParticleID.

Referenced by EffEngineSmoke::Event_OnFrameUpdate(), EffectParticle::GetCurrentParticleID(), and FlammableBase::UpdateParticle().

◆ GetParticleParent()

Object GetParticleParent ( )

inlineprivate

Returns the parent of this Particle if there is one.

Returns: Object The registered parent or null

References m_ParentObject.

◆ HasActiveParticle()

bool HasActiveParticle ( )

inlineprivate

Returns if there is any particle active.

Returns: bool Whether there is any particle active

References m_ParticleEffect, and ParticleHasActive().

◆ IncrementParticleParam()

void IncrementParticleParam	(	int	parameter_id,
		float	value
	)

inlineprivate

Increments the value of the given parameter relatively from the CURRENT value.

Note: It's a simple sum, so negative value decrements

Parameters

parameter_id	`int` The parameter to adjust (enum EmitorParam)
value	`float` The value to sum

References GetParticleEmitorCount(), GetParticleParm(), m_ParticleEffect, and SetParticleParm().

◆ IncrementParticleParamFromOriginal()

void IncrementParticleParamFromOriginal	(	int	parameter_id,
		float	value
	)

inlineprivate

Increments the value of the given parameter relatively from the ORIGINAL value.

Note: It's a simple sum, so negative value decrements

Parameters

parameter_id	`int` The parameter to adjust (enum EmitorParam)
value	`float` The value to sum

References GetParticleEmitorCount(), GetParticleParmOriginal(), m_ParticleEffect, and SetParticleParm().

◆ IsRepeat()

bool IsRepeat ( )

inlineprivate

Returns whether there is a repeating particle.

Returns: bool whether there is a repeating particle

References GetParticleEmitorCount(), GetParticleParm(), and m_ParticleEffect.

Referenced by CreateParticleEffect(), and OnCheckAutoDelete().

◆ IsWiggling()

bool IsWiggling ( )

inlineprivate

Checks if particle is currently wiggling.

References m_RandomizeOri.

Referenced by ParticleSource::OnParticleStop(), ParticleSource::OnParticleUnParented(), ParticleSource::SetWiggle(), and ParticleSource::StopWiggle().

◆ OnCheckAutoDelete()

void OnCheckAutoDelete ( )

inlineprivate

Creates ParticleEffect child, called from UpdateState.

References GetMaxLifetime(), GetParticleCount(), IsRepeat(), m_IsRepeat, m_Lifetime, m_MarkedForDeletion, m_ParticleEffect, OnParticleEnd(), OnParticleStop(), and OnToDelete().

Referenced by EOnFrame().

◆ OnToDelete()

private void OnToDelete ( )

inlineprivate

Called before deletion from OnCheckAutoDelete.

Referenced by OnCheckAutoDelete().

◆ ParticleInit()

protected void ParticleInit ( )

inlineprivate

Purely here so that it can be emptied in ParticleSource.

References SetFlags().

Referenced by Particle().

◆ Play() [1/3]

static Particle Play	(	int	particle_id,
		Object	parent_obj,
		vector	local_pos = `"0 0 0"`,
		vector	local_ori = `"0 0 0"`
	)

inlinestaticprivate

Legacy function for backwards compatibility with 1.01 and below.

References particle_id, and PlayOnObject().

◆ Play() [2/3]

static Particle Play	(	int	particle_id,
		vector	global_pos
	)

inlinestaticprivate

Legacy function for backwards compatibility with 1.01 and below.

References particle_id, and PlayInWorld().

◆ Play() [3/3]

void Play ( int particle_id = -1 )

inlineprivate

Legacy function for backwards compatibility with 1.01 and below.

Parameters

particle_id int Particle ID registered in ParticleList to start playing

References particle_id, and PlayParticle().

◆ PlayInWorld()

static Particle PlayInWorld	(	int	particle_id,
		vector	global_pos
	)

inlinestaticprivate

Creates a particle emitter on the given position and activates it.

Parameters

particle_id	`int` Particle ID registered in ParticleList
global_pos	`Vector` Position where the particel will be created

Returns: Particle Created particle instance

References CreateInWorld(), particle_id, and PlayParticle().

Referenced by EffBulletImpactBase::Event_OnStarted(), and Play().

◆ PlayOnObject()

static Particle PlayOnObject	(	int	particle_id,
		Object	parent_obj,
		vector	local_pos = `"0 0 0"`,
		vector	local_ori = `"0 0 0"`,
		bool	force_world_rotation = `false`
	)

inlinestaticprivate

Creates a particle emitter, attaches it on the given object and activates it.

Parameters

particle_id	`int` Particle ID registered in ParticleList
parent_obj	`Object` Instance on which this particle will be attached
local_pos	`vector` Attachment position local to the parent (Optional)
local_ori	`vector` Orientation local to the parent (Pitch, Yaw, Roll in degrees) (Optional)
force_world_rotation	`bool` Forces particle's orientation to rotate relative to the world and not with the object (Optional)

Returns: Particle Created particle instance

References CreateOnObject(), particle_id, and PlayParticle().

Referenced by Play().

◆ PlayParticle()

override void PlayParticle ( int particle_id = -1 )

inlineprivate

Method to tell the particle to start playing.

Parameters

particle_id int Particle ID registered in ParticleList to start playing

References particle_id, and PlayParticleEx().

Referenced by PMTPlayback::CheckStop(), Play(), PlayInWorld(), and PlayOnObject().

◆ PlayParticleEx()

override bool PlayParticleEx	(	int	particle_id = `-1`,
		int	flags = `0`
	)

inlineprivate

Method to tell the particle to start playing.

Note: The parameter to set the ID will only work when the particle is not already playing

Parameters

particle_id	`int` Particle ID registered in ParticleList to start playing
flags	`int` Flags to pass to the playing (None on this level)

Returns: bool Whether the particle successfully started

References OnParticleStart(), particle_id, SetSource(), and UpdateState().

Referenced by PlayParticle().

◆ RandomizeOrientation()

void RandomizeOrientation ( )

inlineprivate

Randomizes a new orientation and applies it.

References AddAsChild(), m_DefaultOri, m_DefaultPos, m_MaxOriInterval, m_ParentObject, m_RandomizeOri, m_WiggleProcessing, Math::RandomFloat(), and RandWiggleVector().

◆ RandWiggleFloat()

protected float RandWiggleFloat ( )

inlineprivate

Helper to get a randomized wiggle float value.

References m_MaxOriWiggle, and Math::RandomFloatInclusive().

Referenced by RandWiggleVector().

◆ RandWiggleVector()

protected vector RandWiggleVector ( )

inlineprivate

Helper to get a randomized wiggle vector.

References RandWiggleFloat(), and Vector().

Referenced by RandomizeOrientation(), and ParticleSource::RandomizeOrientation().

◆ ScaleParticleParam()

void ScaleParticleParam	(	int	parameter_id,
		float	coef
	)

inlineprivate

Scales the given parameter on all emitors relatively to their CURRENT value.

Parameters

parameter_id	`int` The parameter to adjust (enum EmitorParam)
coef	`float` The multiplier to apply

References GetParticleEmitorCount(), GetParticleParm(), m_ParticleEffect, and SetParticleParm().

Referenced by Hit_MeatBones::BloodSplatGround(), EffBulletImpactBase::Event_OnStarted(), EffBulletImpactBase::OnEnterAngledCalculations(), EffBulletImpactBase::OnEnterCalculations(), Hit_MeatBones::OnEnterCalculations(), Hit_Wood::OnEnterCalculations(), EffBulletImpactBase::OnExitCalculations(), Hit_MeatBones::OnExitCalculations(), Hit_Wood::OnExitCalculations(), and EffBulletImpactBase::OnRicochetCalculations().

◆ ScaleParticleParamFromOriginal()

void ScaleParticleParamFromOriginal	(	int	parameter_id,
		float	coef
	)

inlineprivate

Scales the given parameter on all emitors relatively to their ORIGINAL value.

Parameters

parameter_id	`int` The parameter to adjust (enum EmitorParam)
coef	`float` The multiplier to apply

References GetParticleEmitorCount(), GetParticleParmOriginal(), m_ParticleEffect, and SetParticleParm().

Referenced by EffEngineSmoke::Event_OnFrameUpdate(), EffExhaustSmoke::SetParticleStateLight(), EffCoolantSteam::UpdateParticle(), BroomBase::UpdateParticle(), and FlammableBase::UpdateParticle().

◆ SetParameter()

void SetParameter	(	int	emitter,
		int	parameter,
		float	value
	)

inlineprivate

Set the value of a parameter of an emitor in the particle.

Parameters

emitter	`int` The emitter to apply the new value to, -1 for all emitter
parameter	`int` The parameter to apply the new value to (enum EmitorParam)
value	`float` The value to apply

References m_ParticleEffect, and SetParticleParm().

Referenced by ManBase::ContaminatedParticleAdjustment(), CreateParticle(), DestroyParticleEffect(), EffectBoatWaterBase::EnableEmitor(), ParticleNormalSmokeStart(), ParticleSmallSmokeStart(), PlayVFX(), ManBase::SetContaminatedEffectEx(), FlareSimulation::Simulate(), FlareSimulation::TurnOffDistantLight(), Update(), and EffectBoatWaterBack::Update().

◆ SetParticleParam()

void SetParticleParam	(	int	parameter_id,
		float	value
	)

inlineprivate

Set the value of a parameter of all emitors in the particle.

Parameters

parameter	`int` The parameter to apply the new value to (enum EmitorParam)
value	`float` The value to apply

References m_ParticleEffect, and SetParticleParm().

Referenced by BoatScript::ClearWaterEffects(), EntityLightSource::HandleDancingShadows(), Update(), EffectBoatWaterBack::Update(), and EffCoolantSteam::UpdateParticle().

◆ SetSource()

void SetSource ( int particle_id )

inlineprivate

Sets particle id.

Note: Does not work at runtime, particle object needs to be destroyed and then Particle needs to play again

Parameters

particle_id int Particle ID registered in ParticleList to start playing

References m_ParticleID, and particle_id.

Referenced by CreateInWorld(), PlayParticleEx(), and EffectParticle::SetCurrentParticleID().

◆ SetWiggle()

void SetWiggle	(	float	random_angle,
		float	random_interval
	)

inlineprivate

Makes the particle change direction by random_angle every random_interval seconds.

Note: This does not actually work on Particle with no parent, it should on ParticleSource; Calling SetWiggle(0,0) will effectively stop all wiggle functionality

Parameters

random_angle	`float` Will be the range [-random_angle, random_angle[ to wiggle between
random_interval	`float` Will be the time range [0, random_interval] to wiggle next time

References CALL_CATEGORY_GAMEPLAY, m_MaxOriInterval, m_MaxOriWiggle, m_RandomizeOri, Math::RandomFloat(), and StopWiggle().

Referenced by Roadflare::DestroyParticle(), CupidsBoltSimulation::OnFire(), SmokeSimulation::OnFire(), Ammo_40mm_Smoke_ColorBase::OnVariablesSynchronized(), PlayVFX(), and Roadflare::UpdateActiveParticles().

◆ Stop()

void Stop ( )

inlineprivate

Legacy function for backwards compatibility with 1.14 and below.

References StopParticle().

Referenced by DestroyParticle(), Roadflare::DestroyParticle(), DynamicArea_Flare::EEDelete(), House::EEDelete(), BuildingSuper::EEDelete(), Misc_TirePile_Burning_DE::EEDelete(), Edible_Base::EEDelete(), Ammo_40mm_Smoke_ColorBase::EEDelete(), ItemBase::EEDelete(), HotSpringTrigger::EEDelete(), VolcanicTrigger::EEDelete(), InventoryItem::KillAllOverheatingParticles(), FlareSimulation::OnActivation(), FireworksLauncherClientEvent::OnExplode(), CupidsBoltSimulation::OnFire(), OnInventoryEnter(), FlammableBase::OnWorkStop(), FryingPan::ParticleCookingStop(), ManBase::SetContaminatedEffectEx(), EffectParticle::Stop(), FlammableBase::StopAllParticles(), InventoryItem::UpdateAllOverheatingParticles(), FlammableBase::UpdateParticle(), Edible_Base::UpdateVaporParticle(), CupidsBoltSimulation::~CupidsBoltSimulation(), DestructionEffectBase::~DestructionEffectBase(), ~EasterEgg(), FlareSimulation::~FlareSimulation(), and SmokeSimulation::~SmokeSimulation().

◆ StopParticle()

override bool StopParticle ( int flags = 0 )

inlineprivate

Method to tell the particle to stop playing.

Note: No flags available for Particle; Emitors are automatically removed later when its particle count is 0

Parameters

flags int Flags to pass to the stopping (None on this level)

Returns: bool Whether the particle successfully stopped

References GetParent(), GetPosition, OnParticleStop(), SetPosition(), and UpdateState().

Referenced by Stop().

◆ StopWiggle()

void StopWiggle ( )

inlineprivate

Stops randomized wiggle.

References m_MaxOriInterval, m_MaxOriWiggle, m_RandomizeOri, and Timer::Stop().

Referenced by SetWiggle().

◆ UpdateState()

protected void UpdateState ( )

inlineprivate

Creates/Destroys ParticleEffect child according to current state.

Note: Is called from Play/Stop methods

References CreateParticleEffect(), DestroyParticleEffect(), m_IsPlaying, and m_ParticleEffect.

Referenced by PlayParticleEx(), and StopParticle().