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

World of the duel rule set. More...

#include <duel.h>

Inheritance diagram for Duel:
Collaboration diagram for Duel:

Public Member Functions

 Duel ()
 Construct a duel world.
 ~Duel () override
 Release the world.
int GetRuleSet () const override
 Report the duel rule set.
bool IsFinished () override
 Report whether the duel 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.
void Handle (const StickEvent< 6 > &event) override
 Record 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
 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
 Ignore a button event of command 10.
void BeginAssetLoad () override
 Load the effect bank of the duel 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 BeginEnding () override
 Stop the song's track loader and start it again.
void PollEnding () override
 Advance the sequence that follows the end of the duel.
bool IsEndingDone () override
 Advance the song's track loader and report whether it finished.
void CreateLogic () override
 Build a DuelLogic for the song and install it.
void OnStart () override
 Finish starting the song.
void BuildTracks (int nStartTick) override
 Build the display of the two players' tracks.
void SetLogic (DuelLogic *pLogic)
 Install the logic in the world and keep it in mLogic.
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.

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

Detailed Description

World of the duel rule set.

The RTTI records the class as deriving from World. The object is 0x50 bytes. The input events the duel acts on are recorded as serializable input commands, and DuelLogic acts on them when the commands run.

Constructor & Destructor Documentation

◆ Duel()

Duel::Duel ( )

Construct a duel world.

Ghidra address:
NTSC-U/C: 0x00104fb0
Ghidra address:
PAL: 0x00106698

◆ ~Duel()

Duel::~Duel ( )
override

Release the world.

Ghidra address:
NTSC-U/C: 0x00104ff0
Ghidra address:
PAL: 0x001066d8

Member Function Documentation

◆ GetRuleSet()

int Duel::GetRuleSet ( ) const
inlineoverridevirtual

Report the duel rule set.

Returns
GameDb::kRuleSetDuel.
Ghidra address:
NTSC-U/C: 0x00333f28
Ghidra address:
PAL: 0x003a14d8

Implements World.

◆ IsFinished()

bool Duel::IsFinished ( )
overridevirtual

Report whether the duel ended without a player abandoning it.

Returns
Whether the duel ended.
Ghidra address:
NTSC-U/C: 0x001052b8
Ghidra address:
PAL: 0x001069f0

Implements World.

◆ Handle() [1/11]

void Duel::Handle ( const RotateEvent & event)
overridevirtual

Record a rotation.

Parameters
eventThe rotation.
Ghidra address:
NTSC-U/C: 0x00105940
Ghidra address:
PAL: 0x00107078

Implements World.

◆ Handle() [2/11]

void Duel::Handle ( const PlayNoteEvent & event)
overridevirtual

Record a gem button.

Parameters
eventThe button.
Ghidra address:
NTSC-U/C: 0x00105968
Ghidra address:
PAL: 0x001070a0

Implements World.

◆ Handle() [3/11]

void Duel::Handle ( const BtnEvent< 8 > & event)
inlineoverridevirtual

Ignore a button event of command 8.

The body is empty.

Parameters
eventThe button.
Ghidra address:
NTSC-U/C: 0x00333f30
Ghidra address:
PAL: 0x003a14e0

Implements World.

◆ Handle() [4/11]

void Duel::Handle ( const StickEvent< 2 > & event)
overridevirtual

Record a stick event of command 2.

Parameters
eventThe stick position.
Ghidra address:
NTSC-U/C: 0x00105990
Ghidra address:
PAL: 0x001070c8

Implements World.

◆ Handle() [5/11]

void Duel::Handle ( const StickEvent< 6 > & event)
overridevirtual

Record a stick event of command 6.

Parameters
eventThe stick position.
Ghidra address:
NTSC-U/C: 0x001059b8
Ghidra address:
PAL: 0x001070f0

Implements World.

◆ Handle() [6/11]

void Duel::Handle ( const BtnEvent< 3 > & event)
overridevirtual

Record a button event of command 3.

Parameters
eventThe button.
Ghidra address:
NTSC-U/C: 0x001059e0
Ghidra address:
PAL: 0x00107118

Implements World.

◆ Handle() [7/11]

void Duel::Handle ( const BtnEvent< 4 > & event)
overridevirtual

Record a button event of command 4.

Parameters
eventThe button.
Ghidra address:
NTSC-U/C: 0x00105a08
Ghidra address:
PAL: 0x00107140

Implements World.

◆ Handle() [8/11]

void Duel::Handle ( const BtnEvent< 5 > & event)
overridevirtual

Record a button event of command 5.

Parameters
eventThe button.
Ghidra address:
NTSC-U/C: 0x00105a30
Ghidra address:
PAL: 0x00107168

Implements World.

◆ Handle() [9/11]

void Duel::Handle ( const ChangeSectionEvent & event)
inlineoverridevirtual

Ignore a section change.

The body is empty.

Parameters
eventThe section change.
Ghidra address:
NTSC-U/C: 0x00333f38
Ghidra address:
PAL: 0x003a14e8

Implements World.

◆ Handle() [10/11]

void Duel::Handle ( const BtnEvent< 9 > & event)
inlineoverridevirtual

Ignore a button event of command 9.

The body is empty.

Parameters
eventThe button.
Ghidra address:
NTSC-U/C: 0x00333f40
Ghidra address:
PAL: 0x003a14f0

Implements World.

◆ Handle() [11/11]

void Duel::Handle ( const BtnEvent< 10 > & event)
inlineoverridevirtual

Ignore a button event of command 10.

The body is empty.

Parameters
eventThe button.
Ghidra address:
NTSC-U/C: 0x00333f48
Ghidra address:
PAL: 0x003a14f8

Implements World.

◆ BeginAssetLoad()

void Duel::BeginAssetLoad ( )
overridevirtual

Load the effect bank of the duel 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.

Ghidra address:
NTSC-U/C: 0x00105120
Ghidra address:
PAL: 0x00106808

Implements World.

◆ PollAssetLoad()

void Duel::PollAssetLoad ( )
inlineoverridevirtual

Advance the effect bank load.

The body is empty.

Ghidra address:
NTSC-U/C: 0x00333f58
Ghidra address:
PAL: 0x003a1508

Implements World.

◆ IsAssetLoadDone()

bool Duel::IsAssetLoadDone ( )
overridevirtual

Report whether the effect bank is loaded.

Returns
Whether the bank is loaded.
Ghidra address:
NTSC-U/C: 0x00105210
Ghidra address:
PAL: 0x00106948

Implements World.

◆ BeginSongLoad()

void Duel::BeginSongLoad ( )
overridevirtual

Start the song's track loader.

Ghidra address:
NTSC-U/C: 0x001050d0
Ghidra address:
PAL: 0x001067b8

Implements World.

◆ PollSongLoad()

void Duel::PollSongLoad ( )
inlineoverridevirtual

Advance the song load.

The body is empty.

Ghidra address:
NTSC-U/C: 0x00333f50
Ghidra address:
PAL: 0x003a1500

Implements World.

◆ IsSongLoadDone()

bool Duel::IsSongLoadDone ( )
overridevirtual

Advance the song's track loader and report whether it finished.

Returns
Whether the song is loaded.
Ghidra address:
NTSC-U/C: 0x001050f8
Ghidra address:
PAL: 0x001067e0

Implements World.

◆ BeginEnding()

void Duel::BeginEnding ( )
overridevirtual

Stop the song's track loader and start it again.

Ghidra address:
NTSC-U/C: 0x00105248
Ghidra address:
PAL: 0x00106980

Reimplemented from World.

◆ PollEnding()

void Duel::PollEnding ( )
overridevirtual

Advance the sequence that follows the end of the duel.

The body is empty.

Ghidra address:
NTSC-U/C: 0x00105280
Ghidra address:
PAL: 0x001069b8

Reimplemented from World.

◆ IsEndingDone()

bool Duel::IsEndingDone ( )
overridevirtual

Advance the song's track loader and report whether it finished.

Returns
Whether the loader finished.
Ghidra address:
NTSC-U/C: 0x00105288
Ghidra address:
PAL: 0x001069c0

Reimplemented from World.

◆ CreateLogic()

void Duel::CreateLogic ( )
overridevirtual

Build a DuelLogic for the song and install it.

Ghidra address:
NTSC-U/C: 0x00105048
Ghidra address:
PAL: 0x00106730

Implements World.

◆ OnStart()

void Duel::OnStart ( )
overridevirtual

Finish starting the song.

The body is empty.

Ghidra address:
NTSC-U/C: 0x001052b0
Ghidra address:
PAL: 0x001069e8

Reimplemented from World.

◆ BuildTracks()

void Duel::BuildTracks ( int nStartTick)
overridevirtual

Build the display of the two players' tracks.

Parameters
nStartTickThe tick the song starts at.
Ghidra address:
NTSC-U/C: 0x00105328
Ghidra address:
PAL: 0x00106a60

Implements World.

◆ SetLogic()

void Duel::SetLogic ( DuelLogic * pLogic)

Install the logic in the world and keep it in mLogic.

Parameters
pLogicThe logic to install.
Ghidra address:
NTSC-U/C: 0x00105098
Ghidra address:
PAL: 0x00106780

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