|
wavelength 1.0.0
|
Scripted lesson that runs on top of a remix session. More...
#include <remixtutorial.h>


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. | |
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.
|
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.
| pLogic | The remix session the tutorial drives. |
|
override |
Remove the script commands, stop the steps and the narration, and restore the first player's controller bindings.
|
inlineoverridevirtual |
Ignore the request.
A tutorial never waits for named work.
| pTask | The task waiting for the work. |
| pszName | The name of the work. |
Implements TaskDoneNotifier.
| void RemixTutorial::Start | ( | ) |
Start the first step.
| bool RemixTutorial::Poll | ( | ) |
Advance the steps and the narration, unless the tutorial is paused.
| void RemixTutorial::SetPaused | ( | bool | bPaused | ) |
Pause or resume the steps and the narration.
| bPaused | Pause the tutorial. |
| void RemixTutorial::NotifyPitch | ( | ) |
Report a pitch change to TheGameCallback.
| void RemixTutorial::NotifyLoop | ( | bool | bLooping | ) |
Report to TheGameCallback that looping was switched on or off.
GameCallback::OnLoop() does not receive the flag.
| bLooping | Whether looping was switched on. |
| void RemixTutorial::NotifySectionChange | ( | int | nSection | ) |
Report a section change to TheGameCallback.
| nSection | The section. |
| void RemixTutorial::NotifyRotate | ( | bool | bRight, |
| int | nRotation ) |
Report a rotation to TheGameCallback when it differs from the last one, and record it.
| bRight | The rotation was to the right. |
| nRotation | The rotation. |
| void RemixTutorial::QueueStream | ( | const char * | pszName, |
| bool | bSkipIfBusy ) |
Queue a narration stream.
| pszName | The stream name. |
| bSkipIfBusy | Drop the request when a stream is already queued. |
| void RemixTutorial::ClearGems | ( | ) |
Clear the gems of every section.
| void RemixTutorial::EnableMenu | ( | bool | bEnable | ) |
Focus or release the remix menu of the first controller.
| bEnable | Focus the menu. |
| void RemixTutorial::OpenTempo | ( | bool | bOpen | ) |
Open or close the tempo control.
| bOpen | Open the control. |
| void RemixTutorial::AdjustTempo | ( | int | nSteps | ) |
Raise or lower the tempo.
| nSteps | The steps to raise the tempo by, negative to lower it. |
| void RemixTutorial::PlaySound | ( | ) |
Play the second sound of the interface sound bank.
| void RemixTutorial::AllowPatternCancel | ( | bool | bAllow | ) |
Ignore the request.
| bAllow | Ignored. |
|
static |
Run the "stream" script command, which queues the narration stream it identifies.
| pCommand | The command. |
| pUserData | The tutorial. |
|
static |
Run the "enable_looping" script command, which turns looping of the first lane on or off.
| pCommand | The command. |
| pUserData | The tutorial. |
|
static |
Run the "print" script command, which does nothing.
| pCommand | The command. |
| pUserData | The tutorial. |
|
static |
Run the "disable_rot" script command, which disables or enables rotation.
| pCommand | The command. |
| pUserData | The tutorial. |
|
static |
Run the "disable_pitching" script command, which disables or enables pitching.
| pCommand | The command. |
| pUserData | The tutorial. |
|
static |
Run the "disable_section_change" script command, which disables or enables section changes.
| pCommand | The command. |
| pUserData | The tutorial. |
|
static |
Run the "disable_hud" script command, which hides or shows the display.
| pCommand | The command. |
| pUserData | The tutorial. |
|
static |
Run the "disable_erasing" script command, which disables or enables erasing.
| pCommand | The command. |
| pUserData | The tutorial. |
|
static |
Run the "allow_looping" script command, which sets whether looping is allowed.
| pCommand | The command. |
| pUserData | The tutorial. |
|
static |
Run the "clear_gems" script command, which clears the gems.
| pCommand | The command. |
| pUserData | The tutorial. |
|
static |
Run the "show_patterns" script command, which sets whether the patterns are shown.
| pCommand | The command. |
| pUserData | The tutorial. |
|
static |
Run the "burn_patterns" script command, which sets whether the patterns are burnt.
| pCommand | The command. |
| pUserData | The tutorial. |
|
static |
Run the "enable_menu" script command, which enables or disables the menu.
| pCommand | The command. |
| pUserData | The tutorial. |
|
static |
Run the "allow_tempo_change" script command, which sets whether tempo changes are allowed.
| pCommand | The command. |
| pUserData | The tutorial. |
|
static |
Run the "tempo_open" script command, which opens or closes the tempo menu.
| pCommand | The command. |
| pUserData | The tutorial. |
|
static |
Run the "adjust_tempo" script command, which adjusts the tempo by its argument.
| pCommand | The command. |
| pUserData | The tutorial. |
|
static |
Run the "allow_pattern_cancel" script command, which passes its argument to AllowPatternCancel().
| pCommand | The command. |
| pUserData | The tutorial. |
|
static |
Run the "allow_rotation_left" script command, which sets whether rotation to the left is allowed.
| pCommand | The command. |
| pUserData | The tutorial. |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |