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

The background action, which fades the clear colour of the renderer to a new colour. More...

#include <backgroundaction.h>

Inheritance diagram for BackgroundAction:
Collaboration diagram for BackgroundAction:

Public Member Functions

 ~BackgroundAction () override=default
 Destroy the object.
 BackgroundAction (DataArray *pAction)
 Read the action.
void Exec () override
 Start the fade from the current clear colour.
bool Poll () override
 Set the clear colour 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 background action, which fades the clear colour of the renderer to a new colour.

The RTTI records the class as deriving from TriggerAction. The object is 0x40 bytes. Nodes 1 through 3 are the red, green, and blue of the colour, and node 4 the length of the fade.

Constructor & Destructor Documentation

◆ ~BackgroundAction()

BackgroundAction::~BackgroundAction ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x00374a20
Ghidra address:
PAL: 0x003e3150

◆ BackgroundAction()

BackgroundAction::BackgroundAction ( DataArray * pAction)
explicit

Read the action.

The alpha of the colour is never written.

Parameters
pActionThe node.
Ghidra address:
NTSC-U/C: 0x00200948
Ghidra address:
PAL: 0x002096e8

Member Function Documentation

◆ Exec()

void BackgroundAction::Exec ( )
overridevirtual

Start the fade from the current clear colour.

Ghidra address:
NTSC-U/C: 0x002025b8
Ghidra address:
PAL: 0x0020b358

Implements TriggerAction.

◆ Poll()

bool BackgroundAction::Poll ( )
overridevirtual

Set the clear colour for the time on the clock.

Returns
Whether the fade is over.
Ghidra address:
NTSC-U/C: 0x00203188
Ghidra address:
PAL: 0x0020bf40

Reimplemented from TriggerAction.


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