ParticleBase.c File Reference

Go to the source code of this file.

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

Functions
void	ParticleBase ()
	ctor
override bool	IsParticle ()
	Have script recognize this as a Particle without casting.
Playback
Methods regarding playing/stopping of particle
void	PlayParticle (int particle_id=-1)
	Method to tell the particle to start playing.
bool	PlayParticleEx (int particle_id=-1, int flags=0)
	Method to tell the particle to start playing.
bool	StopParticle (int flags=0)
	Method to tell the particle to stop playing.
bool	ResetParticle ()
	Method to tell the particle to reset.
bool	RestartParticle ()
	Method to tell the particle to restart (reset + play)
bool	IsParticlePlaying ()
	Ask if the particle is still playing.
ParticleEvents	GetEvents ()
	Get the events.
Events
ParticleBase events For ParticleSource, these are handed on C++ side For more information, read ParticleEvents
void	OnParticleStart ()
	Event when the particle starts.
void	OnParticleStop ()
	Event when the particle stops.
void	OnParticleReset ()
	Event when the particle is restarted.
void	OnParticleEnd ()
	Event when the particle ends.
void	OnParticleParented (IEntity parent)
	Event when the particle receives a parent.
void	OnParticleUnParented (IEntity parent)
	Event when the particle is orphaned.

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

Function Documentation

GetEvents()

ParticleEvents GetEvents ( )

protected

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 158 of file ParticleBase.c.

  {
    return m_EventInvokers;
  }

References m_EventInvokers.

Referenced by OnAllocation(), OnAllocationEnd(), OnParticleEnd(), OnParticleParented(), OnParticleReset(), OnParticleStart(), OnParticleStop(), and OnParticleUnParented().

IsParticle()

override bool IsParticle ( )

protected

Have script recognize this as a Particle without casting.

Definition at line 77 of file ParticleBase.c.

  {
    return true;
  }

IsParticlePlaying()

bool IsParticlePlaying ( )

protected

Ask if the particle is still playing.

Returns

bool Whether the particle is playing

Definition at line 145 of file ParticleBase.c.

  {
    ErrorEx("Not implemented.", ErrorExSeverity.WARNING);
    return false;
  }

References ErrorEx.

OnParticleEnd()

void OnParticleEnd ( )

protected

Event when the particle ends.

Note

Looping particles will never end

Definition at line 201 of file ParticleBase.c.

  {
    GetEvents().Event_OnParticleEnd.Invoke(this);
  }

References ParticleEvents::Event_OnParticleEnd, and GetEvents().

Referenced by Particle::OnCheckAutoDelete().

OnParticleParented()

void OnParticleParented ( IEntity parent )

protected

Event when the particle receives a parent.

Definition at line 209 of file ParticleBase.c.

  {
    GetEvents().Event_OnParticleParented.Invoke(this);
  }

References ParticleEvents::Event_OnParticleParented, and GetEvents().

OnParticleReset()

void OnParticleReset ( )

protected

Event when the particle is restarted.

Definition at line 192 of file ParticleBase.c.

  {
    GetEvents().Event_OnParticleReset.Invoke(this);
  }

References ParticleEvents::Event_OnParticleReset, and GetEvents().

OnParticleStart()

void OnParticleStart ( )

protected

Event when the particle starts.

Definition at line 174 of file ParticleBase.c.

  {
    m_IsPlaying = true;
    GetEvents().Event_OnParticleStart.Invoke(this);
  }

References ParticleEvents::Event_OnParticleStart, GetEvents(), and m_IsPlaying.

Referenced by Particle::PlayParticleEx().

OnParticleStop()

void OnParticleStop ( )

protected

Event when the particle stops.

Definition at line 183 of file ParticleBase.c.

  {
    m_IsPlaying = false;
    GetEvents().Event_OnParticleStop.Invoke(this);
  }

References ParticleEvents::Event_OnParticleStop, GetEvents(), and m_IsPlaying.

Referenced by Particle::OnCheckAutoDelete(), and Particle::StopParticle().

OnParticleUnParented()

void OnParticleUnParented ( IEntity parent )

protected

Event when the particle is orphaned.

Definition at line 217 of file ParticleBase.c.

  {
    GetEvents().Event_OnParticleUnParented.Invoke(this);
  }

References ParticleEvents::Event_OnParticleUnParented, and GetEvents().

ParticleBase()

void ParticleBase ( )

protected

ctor

Definition at line 70 of file ParticleBase.c.

  {
    m_EventInvokers = new ParticleEvents();
  }

References m_EventInvokers.

PlayParticle()

void PlayParticle ( int particle_id = -1 )

protected

Method to tell the particle to start playing.

Parameters

particle_id

int Particle ID registered in ParticleList to start playing

Returns

bool Whether the particle successfully started

Definition at line 93 of file ParticleBase.c.

  {
    ErrorEx("Not implemented.", ErrorExSeverity.WARNING);
  }

References ErrorEx.

Referenced by ParticleFireEndStart(), ParticleFireStartStart(), ParticleFireWindyNoIgniteStart(), ParticleNormalFireStart(), ParticleNormalSmokeStart(), FireplaceBase::ParticleNormalSmokeStart(), ParticleSmallFireStart(), ParticleSmallSmokeStart(), FireplaceBase::ParticleSmallSmokeStart(), ParticleSteamEndStart(), ParticleSteamExtinguishingStart(), and ParticleWetNoIgniteStart().

PlayParticleEx()

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

protected

Method to tell the particle to start playing.

Parameters

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

Definition at line 104 of file ParticleBase.c.

  {
    ErrorEx("Not implemented.", ErrorExSeverity.WARNING);
    return false;
  }

References ErrorEx.

ResetParticle()

bool ResetParticle ( )

protected

Method to tell the particle to reset.

Returns

bool Whether the particle successfully reset

Definition at line 125 of file ParticleBase.c.

  {
    ErrorEx("Not implemented.", ErrorExSeverity.WARNING);
    return false;
  }

References ErrorEx.

RestartParticle()

bool RestartParticle ( )

protected

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

Returns

bool Whether the particle successfully restarted

Definition at line 135 of file ParticleBase.c.

  {
    ErrorEx("Not implemented.", ErrorExSeverity.WARNING);
    return false;
  }

References ErrorEx.

StopParticle()

bool StopParticle ( int flags = 0 )

protected

Method to tell the particle to stop playing.

Parameters

flags

int Flags to pass to the stopping

Returns

bool Whether the particle successfully stopped

Definition at line 115 of file ParticleBase.c.

  {
    ErrorEx("Not implemented.", ErrorExSeverity.WARNING);
    return false;
  }

References ErrorEx.

Referenced by ParticleFireEndStop(), ParticleFireStartStop(), ParticleNormalFireStop(), ParticleNormalSmokeStop(), ParticleSmallFireStop(), ParticleSmallSmokeStop(), ParticleSteamEndStop(), ParticleSteamExtinguishingStop(), ParticleWetNoIgniteStop(), and StopAllParticlesAndSounds().

Variable Documentation

m_EventInvokers

ref ParticleEvents m_EventInvokers

protected

Event invokers.

Definition at line 66 of file ParticleBase.c.

Referenced by GetEvents(), and ParticleBase().

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