DIFF

class ParticleBase

ParticleBase › Entity › ObjectTyped › Object › IEntity › Managed

Constructors 2
void ParticleBase()

ctor

References ScriptInvoker.Insert(), new ParticleEvents(), ParticleEvents.Event_OnParticleStart
Show 1 more, m_EventInvokers
void ~ParticleBase()
References ScriptInvoker.Remove(), ParticleEvents.Event_OnParticleStart, and m_EventInvokers

Members 4
protected bool m_IsPlaying

Whether the particle is currently playing

Referenced by Particle.CreateParticleEffect(), Particle.UpdateState(), OnParticleStart()
Show 1 more, OnParticleStop()
protected ref ParticleEvents m_EventInvokers

Event invokers

Referenced by ~ParticleBase(), GetEvents(), and ParticleBase()
protected string m_StartSoundSetName

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

Referenced by GetStartSoundName(), PlayStartSound(), and SetStartSoundParams()
protected vector m_SoundPosition

Position of sound playback (world)

Referenced by PlayStartSound(), and SetStartSoundParams()

Methods 17
override bool IsParticle()

Have script recognize this as a Particle without casting

void PlayParticle(int particle_id = -1)

Method to tell the particle to start playing

particle_id
int Particle ID registered in ParticleList to start playing

Returns: bool Whether the particle successfully started

References ErrorEx()
bool PlayParticleEx(int particle_id = -1, int flags = 0)

Method to tell the particle to start playing

particle_id
int Particle ID registered in ParticleList to start playing
flags
int Flags to pass to the playing

Returns: bool Whether the particle successfully started

References ErrorEx()
bool StopParticle(int flags = 0)

Method to tell the particle to stop playing

flags
int Flags to pass to the stopping

Returns: bool Whether the particle successfully stopped

References ErrorEx()
bool ResetParticle()

Method to tell the particle to reset

Returns: bool Whether the particle successfully reset

References ErrorEx()
bool RestartParticle()

Method to tell the particle to restart (reset + play)

Returns: bool Whether the particle successfully restarted

References ErrorEx()
bool IsParticlePlaying()

Ask if the particle is still playing

Returns: bool Whether the particle is playing

References ErrorEx()
void SetStartSoundParams(string soundSetName, vector position)

Ask if the particle is still playing

soundSetName
string Name of the sound set to be played (DZ/sounds)
position
vector World position on which sound is going to be played
References m_SoundPosition, and m_StartSoundSetName
Referenced by DayZGame.ExplosionEffects()
string GetStartSoundName()
References m_StartSoundSetName
void PlayStartSound()

Play sound (if set) on OnParticleStart event

References SEffectManager.PlaySound(), EffectSound.SetAutodestroy(), m_SoundPosition
Show 1 more, m_StartSoundSetName
protected void OnParticleStart()

Event when the particle starts

References GetEvents(), ScriptInvoker.Invoke(), and m_IsPlaying
Referenced by Particle.PlayParticleEx()
protected void OnParticleStop()

Event when the particle stops

References GetEvents(), ScriptInvoker.Invoke(), and m_IsPlaying
Referenced by Particle.OnCheckAutoDelete(), Particle.StopParticle(), and ParticleSource.OnParticleStop()
protected void OnParticleReset()

Event when the particle is restarted

References GetEvents(), and ScriptInvoker.Invoke()
protected void OnParticleEnd()

Event when the particle ends

NoteLooping particles will never end
References GetEvents(), and ScriptInvoker.Invoke()
Referenced by Particle.OnCheckAutoDelete()
protected void OnParticleParented(IEntity parent)

Event when the particle receives a parent

References GetEvents(), and ScriptInvoker.Invoke()
Referenced by ParticleSource.OnParticleParented()
protected void OnParticleUnParented(IEntity parent)

Event when the particle is orphaned

References GetEvents(), and ScriptInvoker.Invoke()
Referenced by ParticleSource.OnParticleUnParented()