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


Public Member Functions | |
| Remix () | |
| Construct a remix world. | |
| ~Remix () override | |
| Unload the effect bank and release the world. | |
| int | GetRuleSet () const override |
| Report the remix rule set. | |
| bool | IsFinished () override |
| Report whether the remix 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 |
| Record a button event of command 8. | |
| void | Handle (const StickEvent< 2 > &event) override |
| Record a stick event of command 2. | |
| void | Handle (const StickEvent< 6 > &event) override |
| Ignore a stick event of command 6. | |
| void | Handle (const BtnEvent< 3 > &event) override |
| Record a button event of command 3. | |
| void | Handle (const BtnEvent< 4 > &event) override |
| Ignore a button event of command 4. | |
| void | Handle (const BtnEvent< 5 > &event) override |
| Ignore a button event of command 5. | |
| void | Handle (const ChangeSectionEvent &event) override |
| Record a section change. | |
| void | Handle (const BtnEvent< 9 > &event) override |
| Record 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 of the remix into its synthesiser slot. | |
| void | PollAssetLoad () override |
| Advance the effect bank load. | |
| 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 | CreateLogic () override |
| Build a RemixLogic for the song and install it. | |
| void | BuildTracks (int nStartTick) override |
| Build the display of the song's tracks. | |
| void | UnloadFxBank () |
| Empty the synthesiser slot of the effect bank. | |
| 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 | BeginEnding () |
| Start the sequence that follows the end of the game. | |
| virtual void | PollEnding () |
| Advance the sequence that follows the end of the game by one frame. | |
| virtual bool | IsEndingDone () |
| Report whether the sequence that follows the end of the game finished. | |
| 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. | |
| virtual void | OnStart () |
| Finish starting the song, after Start() created the logic. | |
| 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. | |
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 remix rule set.
The RTTI records the class as deriving from World. The object is 0x54 bytes. The input events the remix acts on are recorded as serializable input commands, and RemixLogic acts on them when the commands run.
| Remix::Remix | ( | ) |
Construct a remix world.
|
override |
Unload the effect bank and release the world.
|
inlineoverridevirtual |
Report the remix rule set.
Implements World.
|
overridevirtual |
Report whether the remix 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.
|
overridevirtual |
Record a button event of command 8.
| event | The button. |
Implements World.
|
overridevirtual |
Record a stick event of command 2.
| event | The stick position. |
Implements World.
|
overridevirtual |
Ignore a stick event of command 6.
The body is empty.
| event | The stick position. |
Implements World.
|
overridevirtual |
Record a button event of command 3.
| event | The button. |
Implements World.
|
inlineoverridevirtual |
Ignore a button event of command 4.
The body is empty.
| event | The button. |
Implements World.
|
inlineoverridevirtual |
Ignore a button event of command 5.
The body is empty.
| event | The button. |
Implements World.
|
overridevirtual |
Record a section change.
| event | The section change. |
Implements World.
|
overridevirtual |
Record a button event of command 9.
| event | The button. |
Implements World.
|
overridevirtual |
Record a button event of command 10.
| event | The button. |
Implements World.
|
overridevirtual |
Load the effect bank of the remix into its synthesiser slot.
The "game" section of the configuration supplies the bank file as "remix_fx_bank_file" and the slot as "game_fx_bank_slot". The slot is emptied first.
Implements World.
|
inlineoverridevirtual |
Advance the effect bank load.
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 |
Build a RemixLogic for the song and install it.
Implements World.
|
overridevirtual |
Build the display of the song's tracks.
Each track of kind 2 or 4 adds its instrument to the first list and its kind to the second. The last track of kind 1 or 3 supplies the option.
| nStartTick | The tick the song starts at. |
Implements World.
| void Remix::UnloadFxBank | ( | ) |
Empty the synthesiser slot of the effect bank.