wavelength 1.0.0
Loading...
Searching...
No Matches
Scheduler::CommandInfo Class Reference

One queued run of a command. More...

#include <scheduler.h>

Public Member Functions

 CommandInfo (Ptr< Command > command, float fTime, int nTick, const CommandId &id, int nRecordable)
 Construct a run.
bool operator< (const CommandInfo &other) const
 Report whether this run comes before another.
void Save (BinStream &stream) const
 Write the run to a recording.
void Load (BinStream &stream)
 Read a run Save() wrote.
const Ptr< Command > & GetCommand () const
float GetTime () const
int GetTick () const
CommandId GetId () const
int GetRecordable () const

Detailed Description

One queued run of a command.

The RTTI includes the nested name. The class is not polymorphic, and the object is 0x14 bytes. The queue orders the runs by time, and a recordable run before another at the same time.

Constructor & Destructor Documentation

◆ CommandInfo()

Scheduler::CommandInfo::CommandInfo ( Ptr< Command > command,
float fTime,
int nTick,
const CommandId & id,
int nRecordable )
inline

Construct a run.

Parameters
commandThe command.
fTimeThe time it runs at, in milliseconds.
nTickThe tick it runs at.
idThe tag stored with the run.
nRecordableNon-zero when a recording writes the run.

Member Function Documentation

◆ operator<()

bool Scheduler::CommandInfo::operator< ( const CommandInfo & other) const

Report whether this run comes before another.

Parameters
otherThe other run.
Returns
Whether this run comes first.
Ghidra address:
NTSC-U/C: 0x00281ad8
Ghidra address:
PAL: 0x0028b3d8

◆ Save()

void Scheduler::CommandInfo::Save ( BinStream & stream) const

Write the run to a recording.

Parameters
streamThe stream to write to.
Ghidra address:
NTSC-U/C: 0x00281b28
Ghidra address:
PAL: 0x0028b428

◆ Load()

void Scheduler::CommandInfo::Load ( BinStream & stream)

Read a run Save() wrote.

The tag becomes TheDefaultCommandId.

Parameters
streamThe stream to read from.
Ghidra address:
NTSC-U/C: 0x00281bc0
Ghidra address:
PAL: 0x0028b4b0

◆ GetCommand()

const Ptr< Command > & Scheduler::CommandInfo::GetCommand ( ) const
inline
Returns
The command.

◆ GetTime()

float Scheduler::CommandInfo::GetTime ( ) const
inline
Returns
The time it runs at, in milliseconds.

◆ GetTick()

int Scheduler::CommandInfo::GetTick ( ) const
inline
Returns
The tick it runs at.

◆ GetId()

CommandId Scheduler::CommandInfo::GetId ( ) const
inline
Returns
The tag stored with the run.

◆ GetRecordable()

int Scheduler::CommandInfo::GetRecordable ( ) const
inline
Returns
Non-zero when a recording writes the run.

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