|
| | TutorialGameLogic (Song *pSong, DataArray *pSongConfig) |
| | Construct the logic of the tutorial song with a random seed.
|
| | ~TutorialGameLogic () override |
| | Cancel the scheduled deactivations, restore the song speed, the game settings, and the controller bindings, and remove the script commands.
|
| bool | DispatchPriv (Message *pMsg) override |
| | Report the type of a message and pass it to WorldLogic::DispatchPriv().
|
| int | GetTick () override |
| | Report the song position in ticks.
|
| float | GetTime () override |
| | Report the song position on the song clock.
|
| void | Poll () override |
| | Advance the song, the steps, and the narration.
|
| float | GetProgress () override |
| | Report how far the tutorial has played, from the span set_songpos_params sets.
|
| void | HandleInput (const RotateEvent &event) override |
| | Pass a rotation that mRotateMode allows, unless the input is disabled.
|
| void | HandleInput (const PlayNoteEvent &event) override |
| | Pass a note, unless the input is disabled.
|
| void | HandleInput (const BtnEvent< 4 > &event) override |
| | Ignore the event.
|
| void | HandleInput (const BtnEvent< 5 > &event) override |
| | Deploy a power-up, unless the input or the power-ups are disabled.
|
| void | SetPaused (bool bPaused, int nPad, int nReason) override |
| | Pause or resume the song and the narration, and show the pause menu while paused.
|
| void | OnStart () override |
| | Enable the first catch tracks and start the steps.
|
| void | OnFinish (bool bWon) override |
| | Ignore the end of the song.
|
| void | OnBar (int nBar) override |
| | Record the bar, unless it precedes bar 0.
|
| void | OnSection () override |
| | Ignore the start of a section.
|
| void | OnPhraseCaptured (CatchTrack *pTrack, Player *pPlayer, int nBar, bool bStreak) override |
| | Enable the next catch tracks, unless set_manual_enable_next asked for the script to do it.
|
| void | OnPhraseEnded (Track *pTrack) override |
| | Ignore the end of a phrase.
|
| void | OnPhraseMissed (Track *pTrack) override |
| | Ignore a missed phrase.
|
| void | NotifyWhenDone (Task *pTask, const char *pszName) override |
| | Arrange for a task to learn when the commands of a track named "SCRIPT" ran out.
|
| bool | IsPhraseAbsent () |
| | Report whether no phrase of the first player's track plays at or after the current bar.
|
| void | PlayScriptTrack (const char *pszName) |
| | Start the commands of a track named "SCRIPT" from the current tick.
|
| void | QueueStream (const char *pszName, bool bSkipIfBusy) |
| | Queue a narration stream.
|
| void | LoopTrack (int nStartBar, int nNumBars, int nBarsAhead) |
| | Loop a range of bars of the song from a number of bars after the recorded bar.
|
| void | SetInputDisabled (bool bDisabled) |
| | Disable or enable the input.
|
| void | SetRotateMode (int nMode) |
| | Set the rotations that pass.
|
| void | SetPowerupsDisabled (bool bDisabled) |
| | Disable or enable the power-ups.
|
| void | ActivateBars (int nBar, int nBars, int nTrack) |
| | Give a run of bars of a catch track to the first player.
|
| void | ScheduleDeactivateTrack (int nBarsAhead, int nBar, int nBars) |
| | Schedule the deactivation of a run of bars of the first player's track.
|
| void | CaptureTrack () |
| | Capture the phrase of the recorded bar on the first player's track.
|
| void | CaptureAllTracks () |
| | Capture the phrase of the current bar on every catch track for the first player.
|
| void | PlacePowerup (int nPowerup, int nTrack, int nBar) |
| | Place a power-up in a bar of a catch track.
|
| void | MoveTrack (int nTrack) |
| | Move the first player to a catch track.
|
| void | SetAutopilot (bool bAutopilot) |
| | Turn on or off the automatic play of the first player's track.
|
| void | SetNoSeeker (bool bNoSeeker) |
| | Hide or show the seeker of the first player's track.
|
| void | SetManualEnableNext (bool bManual) |
| | Leave the enabling of the next catch tracks to the script, or return it to the captures.
|
| void | SetSongPosParams (int nPlayedBars, int nTotalBars) |
| | Set the span GetProgress() measures.
|
| void | ShowStreakArrow (int nTrack, int nBarsAhead, int nUnused) |
| | Point at the next phrase of a catch track from a number of bars after the clock's bar.
|
| void | ScheduleSetJuice (int nBarsAhead, float fJuice) |
| | Schedule the first player's energy meter to change at the start of a later bar.
|
| void | ScheduleStageComplete (int nBarsAhead) |
| | Schedule the stage completion display at the start of a later bar.
|
| void | EnableNext () |
| | Enable the next catch tracks from the bar after the current one.
|
| void | HandleInput (const BtnEvent< 3 > &event) override |
| | Pause the song from the controller of the player.
|
| void | HandleInput (const ChangeSectionEvent &event) override |
| | Ignore the event.
|
| void | HandleInput (const BtnEvent< 9 > &event) override |
| | Ignore the event.
|
| void | HandleInput (const BtnEvent< 10 > &event) override |
| | Pass the button to the player.
|
| void | HandleInput (const BtnEvent< 8 > &event) override |
| | Ignore the event.
|
| void | HandleInput (const StickEvent< 2 > &event) override |
| | Pass the stick event to the player.
|
| void | HandleInput (const StickEvent< 6 > &event) override |
| | Pass the stick event to the player.
|
| | GameLogic (Song *pSong, DataArray *pConfig, int nSeed) |
| | Construct the logic of a song.
|
| | ~GameLogic () override |
| | Stop the song and release the players and the tracks.
|
| void | Start () override |
| | Start the song, the tracks, the players, and the bar counting.
|
| void | Stop () override |
| | Stop the song, the tracks, and the players.
|
| bool | IsFinished () const override |
| | Report whether Stop() ran.
|
| int | HasQuit () const override |
| | Report mQuit.
|
| int | IsRestartRequested () const override |
| | Report whether the song is to start again once it ends.
|
| bool | IsFreestyling (int nPlayer) override |
| | Report whether a player is on the freestyle track.
|
| bool | IsPlaying () const override |
| | Report whether the song is playing.
|
| virtual bool | DeploySlowdown (Player *pPlayer) |
| | Slow the song down for a player.
|
| virtual bool | DeployFreestyle (Player *pPlayer) |
| | Move a player to the freestyle track for the configured number of bars.
|
| virtual bool | DeployBumper (Player *pPlayer) |
| | Refuse a bumper.
|
| virtual bool | DeployCrippler (Player *pPlayer) |
| | Refuse a crippler.
|
| virtual void | EndFreestyle (Player *pPlayer) |
| | Move a player from the freestyle track back to a catch track.
|
| bool | IsFreestyleTrackActive () const |
| | Report whether a player is on the freestyle track while the song plays.
|
| bool | HasPhraseThisBar () const |
| | Report whether a catch track has a phrase in the current bar.
|
| void | EndSong () |
| | Start the ending of the song.
|
| void | Finish (bool bWon) |
| | Stop the players at the end of the song.
|
| void | CapturePhrase (CatchTrack *pTrack, Player *pPlayer, int nBar, bool bStreak) |
| | Record the capture of a phrase and find the next phrase of each local player.
|
| void | ContinueStreak (Track *pTrack, int nBar, int nFromBar) |
| | Lengthen or reset the streak of the player of a track and find the next phrase.
|
| void | EndPhrase (Track *pTrack) |
| | Report the end of a phrase to the triggers and to OnPhraseEnded().
|
| void | MissPhrase (Track *pTrack) |
| | Record a missed phrase and report it to the triggers and to OnPhraseMissed().
|
| void | EnableNextTracks (int nBar) |
| | Enable the catch tracks of the next step of the song's enable order.
|
| void | EnterFreestyle (Player *pPlayer, bool bVictory) |
| | Move a player to the freestyle track.
|
| void | LeaveFreestyle (Player *pPlayer, int nTrack) |
| | Move a player from the freestyle track to a catch track and find the next phrase.
|
| void | StartSlowdown () |
| | Slow the song down.
|
| void | StopSlowdown () |
| | Return the song to its speed after StartSlowdown().
|
| bool | DeployAutocatcher (Player *pPlayer) |
| | Capture a phrase of the track of a player and pulse the controllers of every player on it.
|
| bool | DeployMultiplier (Player *pPlayer) |
| | Raise the multiplier of a player.
|
| | WorldLogic () |
| | Construct the logic and give the input of every controller to the world.
|
| | ~WorldLogic () override |
| | Release the logic.
|
| bool | DispatchPriv (Message *pMsg) override |
| | Pass a JoypadConnectionMsg to OnJoypadConnection() and ignore any other message.
|
| void | AllNotesOff () |
| | Silence every synthesiser channel.
|
| void | ScheduleControllerCheck () |
| | Pause the song again one tick from now when a controller is disconnected.
|
| int | OnJoypadConnection (JoypadConnectionMsg *pMsg) |
| | Pause the playing song when the controller of a player is disconnected.
|
| void * | operator new (size_t nSize) |
| | Allocate a sink from the pool heaps under the tag "MsgSink".
|
| void | operator delete (void *pBlock) |
| | Return a sink to the pool heaps.
|
| virtual | ~MsgSink () |
| virtual bool | Dispatch (Message *pMsg) |
| | Accept a message.
|
| void * | operator new (size_t size) |
| | Allocate from the main heap under the name MsgSink.
|
| void | operator delete (void *mem) |
| | Return memory to its heap.
|
| virtual | ~MsgSink () |
| | Destroy the sink.
|
| virtual bool | Dispatch (Message *msg) |
| | Handle a message.
|
| virtual | ~TaskDoneNotifier () |
| | Release the notifier.
|
|
| static int | FindDisconnectedPad () |
| | Find the controller of a player on this console that is disconnected.
|
| static void | ReportDone (Task *pTask) |
| | Tell a waiting task that its work is done.
|
| void | AssignTracks () |
| | Assign each player to a random catch track.
|
| void | ApplyFreestyleEffect (int nSet) |
| | Apply one effect set of the song.
|
| void | ShowPowerupText (const char *pszToken, int nPlayer) |
| | Show the localised text of a power-up.
|
| void | CreateTracks (int *pFreestyleType, int *pFreestyleInstrument) |
| | Create the catch tracks and the freestyle track of the song.
|
| void | TickBar () |
| | Count one bar, starting the next section when it begins.
|
| void | AdvanceSection () |
| | Start the next section.
|
| void | ClearNextPhrase (int nPlayer) |
| | Forget the next phrase of a player.
|
| void | FindNextPhrase (int nPlayer, int nTrack, int nFromBar) |
| | Find the first phrase on another catch track at or after a bar, and point the player at it.
|
| void | PlaceRandomPowerups () |
| | Place a random power-up in every bar of every catch track.
|
| void | PlacePowerups () |
| | Place the power-ups of every section in the busiest bars of the catch tracks.
|
| static int | GetControllerArgument (DataArray *pCommand) |
| | Report the controller argument of a script command.
|
| static void | OnAutocatcherCommand (DataArray *pCommand, void *pUserData) |
| | Deploy the autocatcher for a controller on the autocatcher script command.
|
| static void | OnMultiplierCommand (DataArray *pCommand, void *pUserData) |
| | Deploy the multiplier for a controller on the multiplier script command.
|
| static void | OnSlowCommand (DataArray *pCommand, void *pUserData) |
| | Turn the slowdown on or off outside an online game on the slow script command.
|
| static void | OnFreestyleCommand (DataArray *pCommand, void *pUserData) |
| | Deploy the freestyle for a controller on the freestyle script command.
|
| static void | OnFreestyleToggleCommand (DataArray *pCommand, void *pUserData) |
| | Move the player of a controller onto or off the freestyle track on the freestyle_toggle script command.
|
| static void | OnBumperCommand (DataArray *pCommand, void *pUserData) |
| | Deploy the bumper for a controller on the bumper script command.
|
| static void | OnCripplerCommand (DataArray *pCommand, void *pUserData) |
| | Deploy the crippler for a controller on the crippler script command.
|
| static void | OnPowerupCommand (DataArray *pCommand, void *pUserData) |
| | Give a power-up to the player of a controller on the powerup script command while the power-up cheat is on.
|
| Song * | mSong |
| int | mState |
| int | mPaused |
| int | mTicksPerBar |
| int | mNumBars |
| PlayMap * | mPlayMap |
| std::vector< std::unique_ptr< Player > > | mPlayers |
| std::vector< LocalPlayer * > | mLocalPlayers |
| std::vector< std::unique_ptr< CatchTrack > > | mCatchTracks |
| std::unique_ptr< FreestyleTrack > | mFreestyleTrack |
| std::unique_ptr< GameTrackSelector > | mTrackSelector |
| std::unique_ptr< SpeedRamp > | mSpeedRamp |
| int | mPhraseThisBar |
| int | mQuit |
| int | mReserved60 |
| int | mSectionStartBar |
| int | mNextSectionBar |
| int | mSection |
| WorldBeat | mWorldBeat |
| int | mSavedState |
| int | mReserved8c |
| int | mSlowdown |
| int | mNextEnableStep |
| std::vector< PlayerData > | mPlayerData |
| Ptr< Command > | mBarCmd |
| Ptr< Command > | mStopSlowdownCmd |
| Rand | mRand |
| int | mEndTick |
Rules of the tutorial song.
The RTTI records the class as deriving from GameLogic and from TaskDoneNotifier, the second base after the members of GameLogic. Game builds the logic while GameDb::mTutorial is set. The "script" entry of the song's configuration lists the steps, each a task that mScript runs in order once the song starts. The script commands the constructor registers drive the song: they play narration streams, run the tracks named "SCRIPT" of the MIDI file, loop the song, give bars of the catch tracks to the player, and switch the controls on and off. The logic saves the game settings and the first player's controller bindings it changes and restores them when it is destroyed. The end of the last step shows the end-of-tutorial menu.