wavelength 1.0.0
Loading...
Searching...
No Matches
SetParticlesAction Class Reference

The set_particles action, which moves the ranges of a particle system to new values. More...

#include <setparticlesaction.h>

Inheritance diagram for SetParticlesAction:
Collaboration diagram for SetParticlesAction:

Public Member Functions

 ~SetParticlesAction () override=default
 Destroy the object.
 SetParticlesAction (DataArray *pAction)
 Read the action.
void Exec () override
 Record the current ranges, apply the pool size and the material, and start the move.
bool Poll () override
 Move the ranges for the time on the clock.
Public Member Functions inherited from TriggerAction
virtual ~TriggerAction ()
 Release the action.
void Start ()
 Run the action now, or schedule it when it has a delay.
float GetDelay () const
void SetDelay (float fDelay)
 Set the time on the clock of the action before Exec() runs.
int GetClock () const
void SetClock (int nClock)
 Set the TriggerMgr::Clock the action runs on.

Additional Inherited Members

Static Public Member Functions inherited from TriggerAction
static TriggerAction * New (DataArray *pAction)
 Build the action a node describes.
Static Protected Member Functions inherited from TriggerAction
template<class T>
static T * FindObject (DataArray *pAction, const char *pszName)
 Find a renderer object of a class by name, warning when there is none.

Detailed Description

The set_particles action, which moves the ranges of a particle system to new values.

The RTTI records the class as deriving from TriggerAction. The object is 0xb0 bytes. Node 1 names the system and node 2 is the time the move takes. The optional values are max_particles, life, speed, size, emit_rate, pos (the low and the high corner), and mat. The pool size and the material change at once, and the ranges move in a straight line.

Constructor & Destructor Documentation

◆ ~SetParticlesAction()

SetParticlesAction::~SetParticlesAction ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x00374f60
Ghidra address:
PAL: 0x003e3690

◆ SetParticlesAction()

SetParticlesAction::SetParticlesAction ( DataArray * pAction)
explicit

Read the action.

Parameters
pActionThe node.
Ghidra address:
NTSC-U/C: 0x00201828
Ghidra address:
PAL: 0x0020a5c8

Member Function Documentation

◆ Exec()

void SetParticlesAction::Exec ( )
overridevirtual

Record the current ranges, apply the pool size and the material, and start the move.

Ghidra address:
NTSC-U/C: 0x00202a98
Ghidra address:
PAL: 0x0020b838

Implements TriggerAction.

◆ Poll()

bool SetParticlesAction::Poll ( )
overridevirtual

Move the ranges for the time on the clock.

The PAL build first reports the move as over while the clock is before mStartTime.

Returns
Whether the move is over.
Ghidra address:
NTSC-U/C: 0x00202ed0
Ghidra address:
PAL: 0x0020bc70

Reimplemented from TriggerAction.


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