EffVehicleSmoke Class Reference

Inheritance diagram for EffVehicleSmoke:

Collaboration diagram for EffVehicleSmoke:

Private Member Functions
void	EffVehicleSmoke ()
void	SetParticleStateLight ()
void	SetParticleStateHeavy ()
void	SetParticleState (int state)
Private Member Functions inherited from EffectParticle
override EffectType	GetEffectType ()
	Get what type of effect the Effect is.
override bool	IsParticle ()
	Check whether the Effect is EffectParticle without casting.
void	SetParticle (Particle p)
	Sets the main particle which this Effect will manage.
Particle	GetParticle ()
	Gets the main particle which this Effect is managing.
override void	Start ()
	Plays all elements this effect consists of.
override void	Stop ()
	Stops all elements this effect consists of.
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.
void	ReAttach ()
	Helper method to attach to parent using stored settings.
void	AddAsChild (Object obj, vector local_pos, vector local_ori, bool force_rotation_to_world)
	Helper method to attach to parent.
void	Event_OnPlayStart ()
	Event which just simply exists (DEPRECATED)
void	Event_OnPlayStarted ()
	Event which just simply exists (DEPRECATED)
void	SetParticleID (int id)
	Sets the id of the particle to be used.
int	GetParticleID ()
	Gets the id of the particle to be used.
void	SetCurrentParticleID (int id)
	Sets the id of the particle to be used.
int	GetCurrentParticleID ()
	Gets the current id of the managed Particle.
override void	SetCurrentParent (Object parent_obj, bool updateCached=true)
	Set current parent of the managed Particle.
override Object	GetCurrentParent ()
	Get the current parent of the managed Particle.
override void	SetCurrentPosition (vector pos, bool updateCached=true)
	Set the current world position of the managed Particle.
override vector	GetCurrentPosition ()
	Get the current world position of the managed Particle.
override void	SetCurrentLocalPosition (vector pos, bool updateCached=true)
	Set the current local position of the managed Particle.
override vector	GetCurrentLocalPosition ()
	Get the current local position of the managed Particle.
void	SetOrientation (vector ori)
	Set orientation of the EffectParticle.
vector	GetOrientation ()
	Get the orientation of the EffectParticle.
void	SetCurrentOrientation (vector ori, bool updateCached=true)
	Set the current orientation of the managed Particle.
vector	GetCurrentOrientation ()
	Get the current orientation of the managed Particle.
void	ForceParticleRotationRelativeToWorld (bool state)
	Set orientation setting to be used by the effect when the Effect starts.
bool	IsParticleRotationRelativeToWorld ()
	Get the orientation setting to be used by the effect when the Effect starts.
bool	IsParticleCurrentRotationRelativeToWorld ()
	Get the current orientation setting to be used by the managed Particle.
void	EffectParticle ()
	ctor
void	~EffectParticle ()
	dtor
override void	InitEffect ()
	init
override string	GetDebugName ()
	Override when getting debug information.
override void	ValidateStart ()
	Validation whether an effect truly started playing or if the Effect should stop as none is present.
void	CheckLifeSpan ()
	Was never called and probably should never be called.
void	SetDecalOwner (Object o)

Additional Inherited Members
Private Attributes inherited from EffectParticle
Particle	m_ParticleObj
	The main Particle effect that this Effect wrapper manages.
int	m_ParticleID
	The ID in the ParticleList to create Particle from.
vector	m_Orientation
	Orientation set by SetOrientation.
bool	m_ForceRotationRelativeToWorld
	Orientation setting to be used by the effect when the Effect starts.
vector	m_ParticleOrientation
Object	m_Object

Detailed Description

Definition at line 1 of file VehicleSmoke.c.

Constructor & Destructor Documentation

EffVehicleSmoke()

void EffVehicleSmoke::EffVehicleSmoke ( )

inlineprivate

Definition at line 3 of file VehicleSmoke.c.

  {
    SetParticleStateLight();
  }

References SetParticleStateLight().

Member Function Documentation

SetParticleState()

void EffVehicleSmoke::SetParticleState ( int state )

inlineprivate

Definition at line 20 of file VehicleSmoke.c.

  {
    bool was_playing = IsPlaying();
 
    Stop();
 
    SetParticleID(state);
 
    if (was_playing)
    {
      Start(); // resume effect
    }
  }

References IsPlaying(), EffectParticle::SetParticleID(), EffectParticle::Start(), and EffectParticle::Stop().

Referenced by EffEngineSmoke::Event_OnFrameUpdate(), SetParticleStateHeavy(), EffCoolantSteam::SetParticleStateHeavy(), EffEngineSmoke::SetParticleStateHeavy(), SetParticleStateLight(), EffCoolantSteam::SetParticleStateLight(), EffEngineSmoke::SetParticleStateLight(), and EffExhaustSmoke::SetParticleStateLight().

SetParticleStateHeavy()

void EffVehicleSmoke::SetParticleStateHeavy ( )

inlineprivate

Definition at line 15 of file VehicleSmoke.c.

  {
    SetParticleState(ParticleList.HATCHBACK_COOLANT_OVERHEATED);
  }

References ParticleList::HATCHBACK_COOLANT_OVERHEATED, and SetParticleState().

SetParticleStateLight()

void EffVehicleSmoke::SetParticleStateLight ( )

inlineprivate

Definition at line 9 of file VehicleSmoke.c.

  {
    SetParticleState(ParticleList.HATCHBACK_COOLANT_OVERHEATING);
  }

References ParticleList::HATCHBACK_COOLANT_OVERHEATING, and SetParticleState().

Referenced by EffVehicleSmoke().

---

The documentation for this class was generated from the following file:

• scripts/3_Game/Effects/EffectParticle/VehicleSmoke.c