|
wavelength 1.0.0
|
World of the main game rule set. More...
#include <game.h>


Public Member Functions | |
| Game () | |
| Construct a game world. | |
| ~Game () override | |
| Turn the software effects off, empty the bank slots, and remove the script commands. | |
| int | GetRuleSet () const override |
| Report the main game rule set. | |
| bool | IsFinished () override |
| Report whether the game ended without a player abandoning it. | |
| void | Handle (const RotateEvent &event) override |
| Record a rotation. | |
| void | Handle (const PlayNoteEvent &event) override |
| Record a gem button. | |
| void | Handle (const BtnEvent< 8 > &event) override |
| Ignore a button event of command 8. | |
| void | Handle (const StickEvent< 2 > &event) override |
| Record a stick event of command 2 while the freestyle track is active. | |
| void | Handle (const StickEvent< 6 > &event) override |
| Record a stick event of command 6 while the freestyle track is active. | |
| void | Handle (const BtnEvent< 3 > &event) override |
| Record a button event of command 3. | |
| void | Handle (const BtnEvent< 4 > &event) override |
| Record a button event of command 4. | |
| void | Handle (const BtnEvent< 5 > &event) override |
| Record a button event of command 5. | |
| void | Handle (const ChangeSectionEvent &event) override |
| Ignore a section change. | |
| void | Handle (const BtnEvent< 9 > &event) override |
| Ignore a button event of command 9. | |
| void | Handle (const BtnEvent< 10 > &event) override |
| Record a button event of command 10. | |
| void | BeginAssetLoad () override |
| Load the effect bank and the cheer bank into their synthesiser slots. | |
| void | PollAssetLoad () override |
| Advance the bank loads. | |
| bool | IsAssetLoadDone () override |
| Report whether the effect bank is loaded. | |
| void | BeginSongLoad () override |
| Start the song's track loader. | |
| void | PollSongLoad () override |
| Advance the song load. | |
| bool | IsSongLoadDone () override |
| Advance the song's track loader and report whether it finished. | |
| void | BeginEnding () override |
| Stop the song's track loader and start it again. | |
| void | PollEnding () override |
| Advance the sequence that follows the end of the game. | |
| bool | IsEndingDone () override |
| Advance the song's track loader and report whether it finished. | |
| void | CreateLogic () override |
| Build the logic of the tutorial, the solo game, or the multiplayer game and install it. | |
| void | OnStart () override |
| Register the script commands of the game. | |
| void | BuildTracks (int nStartTick) override |
| Build the display of the song's catch tracks. | |
| void | ReleaseBanks () |
| Empty the bank slots BeginAssetLoad() filled and forget them. | |
| Public Member Functions inherited from World | |
| World () | |
| Construct a world with no game state. | |
| ~World () override | |
| Release the world. | |
| bool | DispatchPriv (Message *pMsg) override |
| Act on a message sent to the world. | |
| virtual float | GetDisplayTime () |
| Report how far the running world has played, from WorldLogic::GetProgress(). | |
| virtual void | Record (const RotateEvent &event) |
| Record a rotation as a serializable input command. | |
| virtual void | Record (const PlayNoteEvent &event) |
| Record a gem button as a serializable input command. | |
| virtual void | Record (const BtnEvent< 8 > &event) |
| Record a button event of command 8. | |
| virtual void | Record (const StickEvent< 2 > &event) |
| Record a stick event of command 2. | |
| virtual void | Record (const StickEvent< 6 > &event) |
| Record a stick event of command 6. | |
| virtual void | Record (const BtnEvent< 3 > &event) |
| Record a button event of command 3. | |
| virtual void | Record (const BtnEvent< 4 > &event) |
| Record a button event of command 4. | |
| virtual void | Record (const BtnEvent< 5 > &event) |
| Record a button event of command 5. | |
| virtual void | Record (const ChangeSectionEvent &event) |
| Record a section change. | |
| virtual void | Record (const BtnEvent< 9 > &event) |
| Record a button event of command 9. | |
| virtual void | Record (const BtnEvent< 10 > &event) |
| Record a button event of command 10. | |
| void | Start () |
| Start the song of a world that finished loading. | |
| void | Stop () |
| Stop the song and release what Start() and LoadAssets() created. | |
| int | IsRestartRequested () |
| Report whether the world that ended requested a restart. | |
| bool | IsFreestyling (int nPlayer) |
| Report whether a player is in a freestyle while the song plays. | |
| void | Poll () |
| Advance the world by one frame. | |
| bool | IsLoaded () const |
| Report whether the assets LoadAssets() started are loaded. | |
| void | LoadAssets () |
| Start loading the song and the assets of the world. | |
| int | GetTick () |
| Report the song position in ticks. | |
| float | GetTime () |
| Report the song position on the song clock. | |
| void | SetLogic (WorldLogic *pLogic) |
| Destroy the installed logic and install another. | |
| Public Member Functions inherited from MsgSink | |
| 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. | |
Static Public Member Functions | |
| static void | TogglePlayAllGems (DataArray *pCommand, void *pUserData) |
| Toggle GameConfig::mPlayAllGems, the play_all_gems script command. | |
| static void | TogglePracticeMode (DataArray *pCommand, void *pUserData) |
| Toggle the practice mode of GameDb, the practice_mode script command. | |
| static void | ToggleNoCapture (DataArray *pCommand, void *pUserData) |
| Toggle GameConfig::mNoCapture, the no_capture script command. | |
Additional Inherited Members | |
| Public Types inherited from World | |
| enum | State { kStateIdle = 0 , kStateLoading = 1 , kStateLoaded = 2 , kStatePlaying = 3 , kStateEnding = 4 , kStateRestarting = 5 } |
| Values of mState. More... | |
| enum | LoadStep { kLoadStepDemo = 0 , kLoadStepSong = 1 , kLoadStepTracks = 2 , kLoadStepMusic = 3 , kLoadStepAssets = 4 , kLoadStepSession = 5 , kLoadStepComplete = 6 } |
| Values of mLoadStep. More... | |
| Protected Attributes inherited from World | |
| std::unique_ptr< Song > | mSong |
| DataArray * | mSongConfig |
| int | mSeed |
World of the main game rule set.
The RTTI records the class as deriving from World. The object is 0x5c bytes. The world builds a TutorialGameLogic, a SoloGameLogic, or a MultiGameLogic, and while it exists the script commands play_all_gems, practice_mode, and no_capture toggle the matching settings.
| Game::Game | ( | ) |
Construct a game world.
|
override |
Turn the software effects off, empty the bank slots, and remove the script commands.
|
inlineoverridevirtual |
Report the main game rule set.
Implements World.
|
overridevirtual |
Report whether the game ended without a player abandoning it.
Implements World.
|
overridevirtual |
Record a rotation.
| event | The rotation. |
Implements World.
|
overridevirtual |
Record a gem button.
| event | The button. |
Implements World.
|
inlineoverridevirtual |
Ignore a button event of command 8.
The body is empty.
| event | The button. |
Implements World.
|
overridevirtual |
Record a stick event of command 2 while the freestyle track is active.
| event | The stick position. |
Implements World.
|
overridevirtual |
Record a stick event of command 6 while the freestyle track is active.
| event | The stick position. |
Implements World.
|
overridevirtual |
Record a button event of command 3.
| event | The button. |
Implements World.
|
overridevirtual |
Record a button event of command 4.
| event | The button. |
Implements World.
|
overridevirtual |
Record a button event of command 5.
| event | The button. |
Implements World.
|
inlineoverridevirtual |
Ignore a section change.
The body is empty.
| event | The section change. |
Implements World.
|
inlineoverridevirtual |
Ignore a button event of command 9.
The body is empty.
| event | The button. |
Implements World.
|
overridevirtual |
Record a button event of command 10.
| event | The button. |
Implements World.
|
overridevirtual |
Load the effect bank and the cheer bank into their synthesiser slots.
The "game" section of the configuration supplies the effect bank of the community, the cheer bank, and the effect bank slot. The cheer bank takes the first slot after the song's banks, and the sound memory is divided again to fit it. The PAL build loads the effect bank from SoundFX, or for a language other than English from that language's directory in SoundFX.
Implements World.
|
inlineoverridevirtual |
Advance the bank loads.
The body is empty.
Implements World.
|
overridevirtual |
Report whether the effect bank is loaded.
Implements World.
|
overridevirtual |
Start the song's track loader.
Implements World.
|
inlineoverridevirtual |
Advance the song load.
The body is empty.
Implements World.
|
overridevirtual |
Advance the song's track loader and report whether it finished.
Implements World.
|
overridevirtual |
Stop the song's track loader and start it again.
Reimplemented from World.
|
overridevirtual |
Advance the sequence that follows the end of the game.
The body is empty.
Reimplemented from World.
|
overridevirtual |
Advance the song's track loader and report whether it finished.
Reimplemented from World.
|
overridevirtual |
Build the logic of the tutorial, the solo game, or the multiplayer game and install it.
A demo or the zero_rand_seed setting clears the seed first.
Implements World.
|
overridevirtual |
Register the script commands of the game.
Reimplemented from World.
|
overridevirtual |
Build the display of the song's catch tracks.
Each catch track adds its instrument and its type to the two lists, and a freestyle track sets the option. A solo game outside the tutorial passes the songs of the group the player cleared as the flags, unless the song is of type 1. A demo also shows the demo text.
| nStartTick | The tick the song starts at. |
Implements World.
| void Game::ReleaseBanks | ( | ) |
Empty the bank slots BeginAssetLoad() filled and forget them.
The name is inferred.
|
static |
Toggle GameConfig::mPlayAllGems, the play_all_gems script command.
| pCommand | The command. |
| pUserData | The value given to ScriptFunction::Register(), null. |
|
static |
Toggle the practice mode of GameDb, the practice_mode script command.
| pCommand | The command. |
| pUserData | The value given to ScriptFunction::Register(), null. |
|
static |
Toggle GameConfig::mNoCapture, the no_capture script command.
| pCommand | The command. |
| pUserData | The value given to ScriptFunction::Register(), null. |