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

Task that is done once a set time has passed on the song clock. More...

#include <waittimetask.h>

Inheritance diagram for WaitTimeTask:
Collaboration diagram for WaitTimeTask:

Public Member Functions

 ~WaitTimeTask () override=default
 Destroy the object.
 WaitTimeTask (float fSeconds)
 Construct a task that waits for a time.
Public Member Functions inherited from Task
 Task ()
 Construct an idle task.
virtual ~Task ()
 Release the task.
int Poll ()
 Report the state after giving a running task one poll.
void Start ()
 Enter the running state and call OnStart(), unless the task is already running.
void Stop ()
 Call OnStop() when the task is running, and return to the idle state.
void Finish (bool bSucceeded)
 End the task from outside its poll, and call OnStop() when it was running.
int GetState () const
 Report mState.

Protected Member Functions

void OnStart () override
 Set the end time from the song clock.
void OnPoll () override
 Finish the task once the song clock reaches the end time.
Protected Member Functions inherited from Task
virtual void OnStop ()
 Abandon the work.

Additional Inherited Members

Public Types inherited from Task
enum  State { kStateIdle = 0 , kStateRunning = 1 , kStateDone = 2 , kStateFailed = 3 }
 Values of mState. More...

Detailed Description

Task that is done once a set time has passed on the song clock.

The RTTI includes the class name and records Task as the base.

Constructor & Destructor Documentation

◆ ~WaitTimeTask()

WaitTimeTask::~WaitTimeTask ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x00344108
Ghidra address:
PAL: 0x003b1640

◆ WaitTimeTask()

WaitTimeTask::WaitTimeTask ( float fSeconds)
explicit

Construct a task that waits for a time.

Parameters
fSecondsThe time to wait, in seconds.
Ghidra address:
NTSC-U/C: 0x00141970
Ghidra address:
PAL: 0x00143310

Member Function Documentation

◆ OnStart()

void WaitTimeTask::OnStart ( )
overrideprotectedvirtual

Set the end time from the song clock.

Ghidra address:
NTSC-U/C: 0x001419a0
Ghidra address:
PAL: 0x00143340

Reimplemented from Task.

◆ OnPoll()

void WaitTimeTask::OnPoll ( )
overrideprotectedvirtual

Finish the task once the song clock reaches the end time.

Ghidra address:
NTSC-U/C: 0x001419b8
Ghidra address:
PAL: 0x00143358

Reimplemented from Task.


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