Dayz Explorer  1.24.157551 (v105080)
Dayz Code Explorer by Zeroy
particlebase.c File Reference

Go to the source code of this file.

Data Structures

class  ParticleEvents
 Invokers for ParticleBase events, called from events. More...
 

Functions

void ParticleBase ()
 ctor More...
 
override bool IsParticle ()
 Have script recognize this as a Particle without casting. More...
 
Playback

Methods regarding playing/stopping of particle

void PlayParticle (int particle_id=-1)
 Method to tell the particle to start playing. More...
 
bool PlayParticleEx (int particle_id=-1, int flags=0)
 Method to tell the particle to start playing. More...
 
bool StopParticle (int flags=0)
 Method to tell the particle to stop playing. More...
 
bool ResetParticle ()
 Method to tell the particle to reset. More...
 
bool RestartParticle ()
 Method to tell the particle to restart (reset + play) More...
 
bool IsParticlePlaying ()
 Ask if the particle is still playing. More...
 
ParticleEvents GetEvents ()
 Get the events. More...
 
Events

ParticleBase events For ParticleSource, these are handed on C++ side For more information, read ParticleEvents

protected void OnParticleStart ()
 Event when the particle starts. More...
 
protected void OnParticleStop ()
 Event when the particle stops. More...
 
protected void OnParticleReset ()
 Event when the particle is restarted. More...
 
protected void OnParticleEnd ()
 Event when the particle ends. More...
 
protected void OnParticleParented (IEntity parent)
 Event when the particle receives a parent. More...
 
protected void OnParticleUnParented (IEntity parent)
 Event when the particle is orphaned. More...
 

Variables

class ParticleEvents m_IsPlaying
 Engine base class with internal functionality. More...
 
protected ref ParticleEvents m_EventInvokers
 Event invokers. More...
 

Function Documentation

◆ GetEvents()

ParticleEvents GetEvents ( )

Get the events.

Returns
ParticleEvents If there is any events set, this will return them so that additional functionality can be bound to them

Definition at line 162 of file particlebase.c.

◆ IsParticle()

override bool IsParticle ( )

Have script recognize this as a Particle without casting.

Definition at line 79 of file particlebase.c.

◆ IsParticlePlaying()

bool IsParticlePlaying ( )

Ask if the particle is still playing.

Returns
bool Whether the particle is playing

Definition at line 148 of file particlebase.c.

◆ OnParticleEnd()

protected void OnParticleEnd ( )

Event when the particle ends.

Note
Looping particles will never end

Definition at line 206 of file particlebase.c.

◆ OnParticleParented()

protected void OnParticleParented ( IEntity  parent)

Event when the particle receives a parent.

Definition at line 214 of file particlebase.c.

◆ OnParticleReset()

protected void OnParticleReset ( )

Event when the particle is restarted.

Definition at line 197 of file particlebase.c.

◆ OnParticleStart()

protected void OnParticleStart ( )

Event when the particle starts.

Definition at line 179 of file particlebase.c.

◆ OnParticleStop()

protected void OnParticleStop ( )

Event when the particle stops.

Definition at line 188 of file particlebase.c.

◆ OnParticleUnParented()

protected void OnParticleUnParented ( IEntity  parent)

Event when the particle is orphaned.

Definition at line 222 of file particlebase.c.

◆ ParticleBase()

void ParticleBase ( )

ctor

Definition at line 71 of file particlebase.c.

◆ PlayParticle()

void PlayParticle ( int  particle_id = -1)

Method to tell the particle to start playing.

Parameters
particle_idint Particle ID registered in ParticleList to start playing
Returns
bool Whether the particle successfully started

Definition at line 96 of file particlebase.c.

◆ PlayParticleEx()

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

Method to tell the particle to start playing.

Parameters
particle_idint Particle ID registered in ParticleList to start playing
flagsint Flags to pass to the playing
Returns
bool Whether the particle successfully started

Definition at line 107 of file particlebase.c.

◆ ResetParticle()

bool ResetParticle ( )

Method to tell the particle to reset.

Returns
bool Whether the particle successfully reset

Definition at line 128 of file particlebase.c.

◆ RestartParticle()

bool RestartParticle ( )

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

Returns
bool Whether the particle successfully restarted

Definition at line 138 of file particlebase.c.

◆ StopParticle()

bool StopParticle ( int  flags = 0)

Method to tell the particle to stop playing.

Parameters
flagsint Flags to pass to the stopping
Returns
bool Whether the particle successfully stopped

Definition at line 118 of file particlebase.c.

Variable Documentation

◆ m_EventInvokers

protected ref ParticleEvents m_EventInvokers

Event invokers.

Definition at line 66 of file particlebase.c.

◆ m_IsPlaying

class ParticleEvents m_IsPlaying

Engine base class with internal functionality.

Note
Is NOT intended for direct creation As this does not have an actual particle Use either Particle or ParticleSource Whether the particle is currently playing