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

Task that waits until the player performs the remix actions a tutorial step lists. More...

#include <waitinteractiveremixtask.h>

Inheritance diagram for WaitInteractiveRemixTask:
Collaboration diagram for WaitInteractiveRemixTask:

Public Member Functions

 ~WaitInteractiveRemixTask () override=default
 Destroy the object.
 WaitInteractiveRemixTask (DataArray *pStep, RemixTutorial *pTutorial)
 Construct a task for one tutorial step.
void OnPitch () override
 Count a pitch change, restart the idle times, and evaluate the conditions.
void OnLoop () override
 Record that looping was switched on, and evaluate the conditions.
void OnSectionChange (int nSection) override
 Record a section change, restart the idle times, and evaluate the conditions.
void OnBurnPattern () override
 Record a burned pattern, and evaluate the conditions.
void OnErase () override
 Count an erased pattern, and evaluate the conditions.
void OnEraseSection () override
 Record an erased section, and evaluate the conditions.
void OnRotate (bool bRight) override
 Count a rotation, and evaluate the conditions.
void OnPatternMenuOpen () override
 Record that the pattern menu was opened, and evaluate the conditions.
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.
Public Member Functions inherited from GameCallback
virtual ~GameCallback ()
 Release the listener.
virtual void OnGemHit ()
 Report a gem the player hit.
virtual void OnGemMiss (int nLane)
 Report a gem the player missed.
virtual void OnGemPass ()
 Report a gem the player let pass.
virtual void OnCapture (int nTrack)
 Report a track the player captured.
virtual void OnAutocapture ()
 Report an automatic capture.
virtual void OnStreakBroken (int nStreak)
 Report a broken streak.
virtual void OnPowerup ()
 Report a powerup the player deployed.

Protected Member Functions

void OnStart () override
 Install the task as TheGameCallback, and restart the idle times.
void OnStop () override
 Stop reporting to the task.
void OnPoll () override
 Run the actions of the idle conditions whose time has passed.

Additional Inherited Members

Public Types inherited from Task
enum  State { kStateIdle = 0 , kStateRunning = 1 , kStateDone = 2 , kStateFailed = 3 }
 Values of mState. More...
Static Public Member Functions inherited from GameCallback
static void Set (GameCallback *pCallback)
 Install the listener the gameplay code reports to.

Detailed Description

Task that waits until the player performs the remix actions a tutorial step lists.

The RTTI includes the class name and records Task and GameCallback as the bases. A step has the shape WaitInteractiveTask reads, with remix conditions. Only pitch resets its count when it fires.

Constructor & Destructor Documentation

◆ ~WaitInteractiveRemixTask()

WaitInteractiveRemixTask::~WaitInteractiveRemixTask ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x00344208
Ghidra address:
PAL: 0x003b1740

◆ WaitInteractiveRemixTask()

WaitInteractiveRemixTask::WaitInteractiveRemixTask ( DataArray * pStep,
RemixTutorial * pTutorial )

Construct a task for one tutorial step.

Parameters
pStepThe step, with the conditions to wait for.
pTutorialThe tutorial the step belongs to.
Ghidra address:
NTSC-U/C: 0x00142290
Ghidra address:
PAL: 0x00143c30

Member Function Documentation

◆ OnPitch()

void WaitInteractiveRemixTask::OnPitch ( )
overridevirtual

Count a pitch change, restart the idle times, and evaluate the conditions.

Ghidra address:
NTSC-U/C: 0x00142728
Ghidra address:
PAL: 0x001440c8

Reimplemented from GameCallback.

◆ OnLoop()

void WaitInteractiveRemixTask::OnLoop ( )
overridevirtual

Record that looping was switched on, and evaluate the conditions.

Ghidra address:
NTSC-U/C: 0x00142768
Ghidra address:
PAL: 0x00144108

Reimplemented from GameCallback.

◆ OnSectionChange()

void WaitInteractiveRemixTask::OnSectionChange ( int nSection)
overridevirtual

Record a section change, restart the idle times, and evaluate the conditions.

Parameters
nSectionThe section. The task ignores it.
Ghidra address:
NTSC-U/C: 0x00142788
Ghidra address:
PAL: 0x00144128

Reimplemented from GameCallback.

◆ OnBurnPattern()

void WaitInteractiveRemixTask::OnBurnPattern ( )
overridevirtual

Record a burned pattern, and evaluate the conditions.

Ghidra address:
NTSC-U/C: 0x001427c8
Ghidra address:
PAL: 0x00144168

Reimplemented from GameCallback.

◆ OnErase()

void WaitInteractiveRemixTask::OnErase ( )
overridevirtual

Count an erased pattern, and evaluate the conditions.

Ghidra address:
NTSC-U/C: 0x001427e8
Ghidra address:
PAL: 0x00144188

Reimplemented from GameCallback.

◆ OnEraseSection()

void WaitInteractiveRemixTask::OnEraseSection ( )
overridevirtual

Record an erased section, and evaluate the conditions.

Ghidra address:
NTSC-U/C: 0x00142840
Ghidra address:
PAL: 0x001441e0

Reimplemented from GameCallback.

◆ OnRotate()

void WaitInteractiveRemixTask::OnRotate ( bool bRight)
overridevirtual

Count a rotation, and evaluate the conditions.

Parameters
bRightThe rotation was to the right. A right rotation adds one, and otherwise one is subtracted.
Ghidra address:
NTSC-U/C: 0x00142810
Ghidra address:
PAL: 0x001441b0

Reimplemented from GameCallback.

◆ OnPatternMenuOpen()

void WaitInteractiveRemixTask::OnPatternMenuOpen ( )
overridevirtual

Record that the pattern menu was opened, and evaluate the conditions.

Ghidra address:
NTSC-U/C: 0x00142860
Ghidra address:
PAL: 0x00144200

Reimplemented from GameCallback.

◆ OnStart()

void WaitInteractiveRemixTask::OnStart ( )
overrideprotectedvirtual

Install the task as TheGameCallback, and restart the idle times.

Ghidra address:
NTSC-U/C: 0x001422e8
Ghidra address:
PAL: 0x00143c88

Reimplemented from Task.

◆ OnStop()

void WaitInteractiveRemixTask::OnStop ( )
overrideprotectedvirtual

Stop reporting to the task.

Ghidra address:
NTSC-U/C: 0x00142328
Ghidra address:
PAL: 0x00143cc8

Reimplemented from Task.

◆ OnPoll()

void WaitInteractiveRemixTask::OnPoll ( )
overrideprotectedvirtual

Run the actions of the idle conditions whose time has passed.

Ghidra address:
NTSC-U/C: 0x00142348
Ghidra address:
PAL: 0x00143ce8

Reimplemented from Task.


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