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

Scripted lesson that runs on top of a remix session. More...

#include <remixtutorial.h>

Inheritance diagram for RemixTutorial:
Collaboration diagram for RemixTutorial:

Public Member Functions

 RemixTutorial (RemixLogic *pLogic)
 Register the tutorial's script commands, build the steps of the song's script, and switch the first player to the default controller bindings.
 ~RemixTutorial () override
 Remove the script commands, stop the steps and the narration, and restore the first player's controller bindings.
void NotifyWhenDone (Task *pTask, const char *pszName) override
 Ignore the request.
void Start ()
 Start the first step.
bool Poll ()
 Advance the steps and the narration, unless the tutorial is paused.
void SetPaused (bool bPaused)
 Pause or resume the steps and the narration.
void NotifyPitch ()
 Report a pitch change to TheGameCallback.
void NotifyLoop (bool bLooping)
 Report to TheGameCallback that looping was switched on or off.
void NotifySectionChange (int nSection)
 Report a section change to TheGameCallback.
void NotifyRotate (bool bRight, int nRotation)
 Report a rotation to TheGameCallback when it differs from the last one, and record it.
void QueueStream (const char *pszName, bool bSkipIfBusy)
 Queue a narration stream.
void ClearGems ()
 Clear the gems of every section.
void EnableMenu (bool bEnable)
 Focus or release the remix menu of the first controller.
void OpenTempo (bool bOpen)
 Open or close the tempo control.
void AdjustTempo (int nSteps)
 Raise or lower the tempo.
void PlaySound ()
 Play the second sound of the interface sound bank.
void AllowPatternCancel (bool bAllow)
 Ignore the request.
int GetTempoChangeAllowed () const
int GetStick6Enabled () const
int GetStick2Enabled () const
int GetSectionChangeEnabled () const
int GetRotationLeftAllowed () const
int GetRotationEnabled () const
int GetPreviewEnabled () const
int GetPitchingEnabled () const
int GetLoopingAllowed () const
int GetHudEnabled () const
int GetErasingEnabled () const
int GetButton10Enabled () const
Public Member Functions inherited from TaskDoneNotifier
virtual ~TaskDoneNotifier ()
 Release the notifier.

Static Public Member Functions

static void OnStream (DataArray *pCommand, void *pUserData)
 Run the "stream" script command, which queues the narration stream it identifies.
static void OnEnableLooping (DataArray *pCommand, void *pUserData)
 Run the "enable_looping" script command, which turns looping of the first lane on or off.
static void OnPrint (DataArray *pCommand, void *pUserData)
 Run the "print" script command, which does nothing.
static void OnDisableRot (DataArray *pCommand, void *pUserData)
 Run the "disable_rot" script command, which disables or enables rotation.
static void OnDisablePitching (DataArray *pCommand, void *pUserData)
 Run the "disable_pitching" script command, which disables or enables pitching.
static void OnDisableSectionChange (DataArray *pCommand, void *pUserData)
 Run the "disable_section_change" script command, which disables or enables section changes.
static void OnDisableHud (DataArray *pCommand, void *pUserData)
 Run the "disable_hud" script command, which hides or shows the display.
static void OnDisableErasing (DataArray *pCommand, void *pUserData)
 Run the "disable_erasing" script command, which disables or enables erasing.
static void OnAllowLooping (DataArray *pCommand, void *pUserData)
 Run the "allow_looping" script command, which sets whether looping is allowed.
static void OnClearGems (DataArray *pCommand, void *pUserData)
 Run the "clear_gems" script command, which clears the gems.
static void OnShowPatterns (DataArray *pCommand, void *pUserData)
 Run the "show_patterns" script command, which sets whether the patterns are shown.
static void OnBurnPatterns (DataArray *pCommand, void *pUserData)
 Run the "burn_patterns" script command, which sets whether the patterns are burnt.
static void OnEnableMenu (DataArray *pCommand, void *pUserData)
 Run the "enable_menu" script command, which enables or disables the menu.
static void OnAllowTempoChange (DataArray *pCommand, void *pUserData)
 Run the "allow_tempo_change" script command, which sets whether tempo changes are allowed.
static void OnTempoOpen (DataArray *pCommand, void *pUserData)
 Run the "tempo_open" script command, which opens or closes the tempo menu.
static void OnAdjustTempo (DataArray *pCommand, void *pUserData)
 Run the "adjust_tempo" script command, which adjusts the tempo by its argument.
static void OnAllowPatternCancel (DataArray *pCommand, void *pUserData)
 Run the "allow_pattern_cancel" script command, which passes its argument to AllowPatternCancel().
static void OnAllowRotationLeft (DataArray *pCommand, void *pUserData)
 Run the "allow_rotation_left" script command, which sets whether rotation to the left is allowed.
Static Public Member Functions inherited from TaskDoneNotifier
static void ReportDone (Task *pTask)
 Tell a waiting task that its work is done.

Detailed Description

Scripted lesson that runs on top of a remix session.

The RTTI includes the class name and records TaskDoneNotifier as the base. The "script" entry of the song's "Tutorial" configuration lists the steps, each a task that mScript runs in order. The script commands the constructor registers switch the remix features on and off, play narration streams, and drive the remix controls. While the tutorial exists, the first player's controller bindings are the defaults.

Constructor & Destructor Documentation

◆ RemixTutorial()

RemixTutorial::RemixTutorial ( RemixLogic * pLogic)
explicit

Register the tutorial's script commands, build the steps of the song's script, and switch the first player to the default controller bindings.

Parameters
pLogicThe remix session the tutorial drives.
Ghidra address:
NTSC-U/C: 0x00136928
Ghidra address:
PAL: 0x00138140

◆ ~RemixTutorial()

RemixTutorial::~RemixTutorial ( )
override

Remove the script commands, stop the steps and the narration, and restore the first player's controller bindings.

Ghidra address:
NTSC-U/C: 0x00136d10
Ghidra address:
PAL: 0x00138570

Member Function Documentation

◆ NotifyWhenDone()

void RemixTutorial::NotifyWhenDone ( Task * pTask,
const char * pszName )
inlineoverridevirtual

Ignore the request.

A tutorial never waits for named work.

Parameters
pTaskThe task waiting for the work.
pszNameThe name of the work.
Ghidra address:
NTSC-U/C: 0x0033fcf8
Ghidra address:
PAL: 0x003ad230

Implements TaskDoneNotifier.

◆ Start()

void RemixTutorial::Start ( )

Start the first step.

Ghidra address:
NTSC-U/C: 0x00136ea8
Ghidra address:
PAL: 0x00138708

◆ Poll()

bool RemixTutorial::Poll ( )

Advance the steps and the narration, unless the tutorial is paused.

Returns
False once the last step is done, and true otherwise.
Ghidra address:
NTSC-U/C: 0x00136ec8
Ghidra address:
PAL: 0x00138728

◆ SetPaused()

void RemixTutorial::SetPaused ( bool bPaused)

Pause or resume the steps and the narration.

Parameters
bPausedPause the tutorial.
Ghidra address:
NTSC-U/C: 0x00136f38
Ghidra address:
PAL: 0x00138798

◆ NotifyPitch()

void RemixTutorial::NotifyPitch ( )

Report a pitch change to TheGameCallback.

Ghidra address:
NTSC-U/C: 0x00136f60
Ghidra address:
PAL: 0x001387c0

◆ NotifyLoop()

void RemixTutorial::NotifyLoop ( bool bLooping)

Report to TheGameCallback that looping was switched on or off.

GameCallback::OnLoop() does not receive the flag.

Parameters
bLoopingWhether looping was switched on.
Ghidra address:
NTSC-U/C: 0x00136f98
Ghidra address:
PAL: 0x001387f8

◆ NotifySectionChange()

void RemixTutorial::NotifySectionChange ( int nSection)

Report a section change to TheGameCallback.

Parameters
nSectionThe section.
Ghidra address:
NTSC-U/C: 0x00136fd0
Ghidra address:
PAL: 0x00138830

◆ NotifyRotate()

void RemixTutorial::NotifyRotate ( bool bRight,
int nRotation )

Report a rotation to TheGameCallback when it differs from the last one, and record it.

Parameters
bRightThe rotation was to the right.
nRotationThe rotation.
Ghidra address:
NTSC-U/C: 0x00137018
Ghidra address:
PAL: 0x00138878

◆ QueueStream()

void RemixTutorial::QueueStream ( const char * pszName,
bool bSkipIfBusy )

Queue a narration stream.

Parameters
pszNameThe stream name.
bSkipIfBusyDrop the request when a stream is already queued.
Ghidra address:
NTSC-U/C: 0x00137190
Ghidra address:
PAL: 0x001389f0

◆ ClearGems()

void RemixTutorial::ClearGems ( )

Clear the gems of every section.

Ghidra address:
NTSC-U/C: 0x001371b0
Ghidra address:
PAL: 0x00138a10

◆ EnableMenu()

void RemixTutorial::EnableMenu ( bool bEnable)

Focus or release the remix menu of the first controller.

Parameters
bEnableFocus the menu.
Ghidra address:
NTSC-U/C: 0x001371d0
Ghidra address:
PAL: 0x00138a30

◆ OpenTempo()

void RemixTutorial::OpenTempo ( bool bOpen)

Open or close the tempo control.

Parameters
bOpenOpen the control.
Ghidra address:
NTSC-U/C: 0x001371f0
Ghidra address:
PAL: 0x00138a50

◆ AdjustTempo()

void RemixTutorial::AdjustTempo ( int nSteps)

Raise or lower the tempo.

Parameters
nStepsThe steps to raise the tempo by, negative to lower it.
Ghidra address:
NTSC-U/C: 0x00137220
Ghidra address:
PAL: 0x00138a80

◆ PlaySound()

void RemixTutorial::PlaySound ( )

Play the second sound of the interface sound bank.

Ghidra address:
NTSC-U/C: 0x00137298
Ghidra address:
PAL: 0x00138af8

◆ AllowPatternCancel()

void RemixTutorial::AllowPatternCancel ( bool bAllow)

Ignore the request.

Parameters
bAllowIgnored.
Ghidra address:
NTSC-U/C: 0x001372b8
Ghidra address:
PAL: 0x00138b18

◆ OnStream()

void RemixTutorial::OnStream ( DataArray * pCommand,
void * pUserData )
static

Run the "stream" script command, which queues the narration stream it identifies.

Parameters
pCommandThe command.
pUserDataThe tutorial.
Ghidra address:
NTSC-U/C: 0x00136560
Ghidra address:
PAL: 0x00137d78

◆ OnEnableLooping()

void RemixTutorial::OnEnableLooping ( DataArray * pCommand,
void * pUserData )
static

Run the "enable_looping" script command, which turns looping of the first lane on or off.

Parameters
pCommandThe command.
pUserDataThe tutorial.
Ghidra address:
NTSC-U/C: 0x001365e0
Ghidra address:
PAL: 0x00137df8

◆ OnPrint()

void RemixTutorial::OnPrint ( DataArray * pCommand,
void * pUserData )
static

Run the "print" script command, which does nothing.

Parameters
pCommandThe command.
pUserDataThe tutorial.
Ghidra address:
NTSC-U/C: 0x00136618
Ghidra address:
PAL: 0x00137e30

◆ OnDisableRot()

void RemixTutorial::OnDisableRot ( DataArray * pCommand,
void * pUserData )
static

Run the "disable_rot" script command, which disables or enables rotation.

Parameters
pCommandThe command.
pUserDataThe tutorial.
Ghidra address:
NTSC-U/C: 0x00136620
Ghidra address:
PAL: 0x00137e38

◆ OnDisablePitching()

void RemixTutorial::OnDisablePitching ( DataArray * pCommand,
void * pUserData )
static

Run the "disable_pitching" script command, which disables or enables pitching.

Parameters
pCommandThe command.
pUserDataThe tutorial.
Ghidra address:
NTSC-U/C: 0x00136650
Ghidra address:
PAL: 0x00137e68

◆ OnDisableSectionChange()

void RemixTutorial::OnDisableSectionChange ( DataArray * pCommand,
void * pUserData )
static

Run the "disable_section_change" script command, which disables or enables section changes.

Parameters
pCommandThe command.
pUserDataThe tutorial.
Ghidra address:
NTSC-U/C: 0x00136680
Ghidra address:
PAL: 0x00137e98

◆ OnDisableHud()

void RemixTutorial::OnDisableHud ( DataArray * pCommand,
void * pUserData )
static

Run the "disable_hud" script command, which hides or shows the display.

Parameters
pCommandThe command.
pUserDataThe tutorial.
Ghidra address:
NTSC-U/C: 0x001366b0
Ghidra address:
PAL: 0x00137ec8

◆ OnDisableErasing()

void RemixTutorial::OnDisableErasing ( DataArray * pCommand,
void * pUserData )
static

Run the "disable_erasing" script command, which disables or enables erasing.

Parameters
pCommandThe command.
pUserDataThe tutorial.
Ghidra address:
NTSC-U/C: 0x001366e0
Ghidra address:
PAL: 0x00137ef8

◆ OnAllowLooping()

void RemixTutorial::OnAllowLooping ( DataArray * pCommand,
void * pUserData )
static

Run the "allow_looping" script command, which sets whether looping is allowed.

Parameters
pCommandThe command.
pUserDataThe tutorial.
Ghidra address:
NTSC-U/C: 0x00136710
Ghidra address:
PAL: 0x00137f28

◆ OnClearGems()

void RemixTutorial::OnClearGems ( DataArray * pCommand,
void * pUserData )
static

Run the "clear_gems" script command, which clears the gems.

Parameters
pCommandThe command.
pUserDataThe tutorial.
Ghidra address:
NTSC-U/C: 0x00136748
Ghidra address:
PAL: 0x00137f60

◆ OnShowPatterns()

void RemixTutorial::OnShowPatterns ( DataArray * pCommand,
void * pUserData )
static

Run the "show_patterns" script command, which sets whether the patterns are shown.

Parameters
pCommandThe command.
pUserDataThe tutorial.
Ghidra address:
NTSC-U/C: 0x00136768
Ghidra address:
PAL: 0x00137f80

◆ OnBurnPatterns()

void RemixTutorial::OnBurnPatterns ( DataArray * pCommand,
void * pUserData )
static

Run the "burn_patterns" script command, which sets whether the patterns are burnt.

Parameters
pCommandThe command.
pUserDataThe tutorial.
Ghidra address:
NTSC-U/C: 0x001367a0
Ghidra address:
PAL: 0x00137fb8

◆ OnEnableMenu()

void RemixTutorial::OnEnableMenu ( DataArray * pCommand,
void * pUserData )
static

Run the "enable_menu" script command, which enables or disables the menu.

Parameters
pCommandThe command.
pUserDataThe tutorial.
Ghidra address:
NTSC-U/C: 0x001367d8
Ghidra address:
PAL: 0x00137ff0

◆ OnAllowTempoChange()

void RemixTutorial::OnAllowTempoChange ( DataArray * pCommand,
void * pUserData )
static

Run the "allow_tempo_change" script command, which sets whether tempo changes are allowed.

Parameters
pCommandThe command.
pUserDataThe tutorial.
Ghidra address:
NTSC-U/C: 0x00136810
Ghidra address:
PAL: 0x00138028

◆ OnTempoOpen()

void RemixTutorial::OnTempoOpen ( DataArray * pCommand,
void * pUserData )
static

Run the "tempo_open" script command, which opens or closes the tempo menu.

Parameters
pCommandThe command.
pUserDataThe tutorial.
Ghidra address:
NTSC-U/C: 0x00136848
Ghidra address:
PAL: 0x00138060

◆ OnAdjustTempo()

void RemixTutorial::OnAdjustTempo ( DataArray * pCommand,
void * pUserData )
static

Run the "adjust_tempo" script command, which adjusts the tempo by its argument.

Parameters
pCommandThe command.
pUserDataThe tutorial.
Ghidra address:
NTSC-U/C: 0x00136880
Ghidra address:
PAL: 0x00138098

◆ OnAllowPatternCancel()

void RemixTutorial::OnAllowPatternCancel ( DataArray * pCommand,
void * pUserData )
static

Run the "allow_pattern_cancel" script command, which passes its argument to AllowPatternCancel().

Parameters
pCommandThe command.
pUserDataThe tutorial.
Ghidra address:
NTSC-U/C: 0x001368b8
Ghidra address:
PAL: 0x001380d0

◆ OnAllowRotationLeft()

void RemixTutorial::OnAllowRotationLeft ( DataArray * pCommand,
void * pUserData )
static

Run the "allow_rotation_left" script command, which sets whether rotation to the left is allowed.

Parameters
pCommandThe command.
pUserDataThe tutorial.
Ghidra address:
NTSC-U/C: 0x001368f0
Ghidra address:
PAL: 0x00138108

◆ GetTempoChangeAllowed()

int RemixTutorial::GetTempoChangeAllowed ( ) const
inline
Returns
Set by "allow_tempo_change".

◆ GetStick6Enabled()

int RemixTutorial::GetStick6Enabled ( ) const
inline
Returns
Whether the remix passes on a StickEvent<6>. Always 0.

◆ GetStick2Enabled()

int RemixTutorial::GetStick2Enabled ( ) const
inline
Returns
Whether the remix passes on a StickEvent<2>. Always 0.

◆ GetSectionChangeEnabled()

int RemixTutorial::GetSectionChangeEnabled ( ) const
inline
Returns
Cleared by "disable_section_change".

◆ GetRotationLeftAllowed()

int RemixTutorial::GetRotationLeftAllowed ( ) const
inline
Returns
Set by "allow_rotation_left", initially 1.

◆ GetRotationEnabled()

int RemixTutorial::GetRotationEnabled ( ) const
inline
Returns
Cleared by "disable_rot".

◆ GetPreviewEnabled()

int RemixTutorial::GetPreviewEnabled ( ) const
inline
Returns
Whether the remix starts or stops a preview. Always 0.

◆ GetPitchingEnabled()

int RemixTutorial::GetPitchingEnabled ( ) const
inline
Returns
Cleared by "disable_pitching".

◆ GetLoopingAllowed()

int RemixTutorial::GetLoopingAllowed ( ) const
inline
Returns
Set by "allow_looping".

◆ GetHudEnabled()

int RemixTutorial::GetHudEnabled ( ) const
inline
Returns
Cleared by "disable_hud".

◆ GetErasingEnabled()

int RemixTutorial::GetErasingEnabled ( ) const
inline
Returns
Cleared by "disable_erasing".

◆ GetButton10Enabled()

int RemixTutorial::GetButton10Enabled ( ) const
inline
Returns
Whether the remix passes on a BtnEvent<10>. Always 0.

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