Isle
Loading...
Searching...
No Matches
ScoreState Class Reference

[AI] State object used to track the status of the Score/High Score area, particularly whether the educational "cube" tutorial should be shown to the player. More...

#include <score.h>

Inheritance diagram for ScoreState:
Collaboration diagram for ScoreState:

Public Member Functions

 ScoreState ()
 [AI] Constructor initializes the tutorial flag to TRUE by default. More...
 
MxBool IsSerializable () override
 [AI] Indicates whether this state can be serialized for savegames. More...
 
MxBool Reset () override
 [AI] Resets the ScoreState by re-enabling the tutorial. More...
 
const char * ClassName () const override
 [AI] Returns the class name as a string. More...
 
MxBool IsA (const char *p_name) const override
 [AI] Checks if this object is the given class or any of its base classes. More...
 
MxBool GetTutorialFlag ()
 [AI] Get whether the high score cube tutorial should be played. More...
 
void SetTutorialFlag (MxBool p_playCubeTutorial)
 [AI] Set whether the high score cube tutorial should be played. More...
 
- Public Member Functions inherited from LegoState
 ~LegoState () override
 [AI] Virtual destructor to allow subclass cleanup. More...
 
virtual MxBool IsSerializable ()
 [AI] Returns if this state can be serialized (for game saving/loading support). More...
 
virtual MxBool Reset ()
 [AI] Hook for returning object to default (empty) state; not implemented in this base. More...
 
virtual MxResult Serialize (LegoStorage *p_storage)
 [AI] Serialize state to a storage (for save/load). More...
 
const char * ClassName () const override
 [AI] Gets this class's name for RTTI/IsA functionality. More...
 
MxBool IsA (const char *p_name) const override
 [AI] Tests if this object is of a given class name, directly or through inheritance. More...
 
- Public Member Functions inherited from MxCore
 MxCore ()
 [AI] Constructs a new MxCore object and assigns it a unique id. More...
 
virtual ~MxCore ()
 [AI] Virtual destructor. Required for correct polymorphic cleanup in derived classes. More...
 
virtual MxLong Notify (MxParam &p_param)
 [AI] Virtual callback notification mechanism. More...
 
virtual MxResult Tickle ()
 [AI] Called by tickle managers to allow the object to update itself. More...
 
virtual const char * ClassName () const
 [AI] Returns the runtime class name of this object. More...
 
virtual MxBool IsA (const char *p_name) const
 [AI] Checks whether this object's class type or parents match the given name. More...
 
MxU32 GetId ()
 [AI] Gets the unique (per-process) id assigned to this object instance. More...
 

Public Attributes

MxBool m_playCubeTutorial
 [AI] Whether the cube tutorial should be played when entering the Score/High Score area. More...
 

Additional Inherited Members

- Public Types inherited from LegoState
enum  ScoreColor { e_grey = 0 , e_yellow , e_blue , e_red }
 [AI] Score coloring values for in-game display feedback or logic. More...
 

Detailed Description

[AI] State object used to track the status of the Score/High Score area, particularly whether the educational "cube" tutorial should be shown to the player.

[AI] ScoreState is a game state associated with the InfoScore/High Score room/area. It currently holds only one property: whether the cube tutorial should be played. This flag is used to determine if the "bigcube.gif" tutorial audio should play when entering the score area. Inherits from LegoState to allow serialization and integration with the game's state system.

See also
LegoState [AI]

Definition at line 15 of file score.h.

Constructor & Destructor Documentation

◆ ScoreState()

ScoreState::ScoreState ( )
inline

[AI] Constructor initializes the tutorial flag to TRUE by default.

Definition at line 18 of file score.h.

Member Function Documentation

◆ ClassName()

const char * ScoreState::ClassName ( ) const
inlineoverridevirtual

[AI] Returns the class name as a string.

Returns
[AI] "ScoreState"

Reimplemented from LegoState.

Definition at line 34 of file score.h.

◆ GetTutorialFlag()

MxBool ScoreState::GetTutorialFlag ( )
inline

[AI] Get whether the high score cube tutorial should be played.

Returns
[AI] TRUE if the tutorial is pending playback; FALSE otherwise.

Definition at line 49 of file score.h.

◆ IsA()

MxBool ScoreState::IsA ( const char *  p_name) const
inlineoverridevirtual

[AI] Checks if this object is the given class or any of its base classes.

Parameters
p_name[AI] The name of the class to check.
Returns
[AI] TRUE if p_name matches ScoreState or any base class, FALSE otherwise.

Reimplemented from LegoState.

Definition at line 42 of file score.h.

◆ IsSerializable()

MxBool ScoreState::IsSerializable ( )
inlineoverridevirtual

[AI] Indicates whether this state can be serialized for savegames.

Always returns FALSE.

Returns
[AI] FALSE.

Reimplemented from LegoState.

Definition at line 22 of file score.h.

◆ Reset()

MxBool ScoreState::Reset ( )
inlineoverridevirtual

[AI] Resets the ScoreState by re-enabling the tutorial.

Returns
[AI] TRUE.

Reimplemented from LegoState.

Definition at line 26 of file score.h.

◆ SetTutorialFlag()

void ScoreState::SetTutorialFlag ( MxBool  p_playCubeTutorial)
inline

[AI] Set whether the high score cube tutorial should be played.

Parameters
p_playCubeTutorial[AI] Set TRUE to show tutorial, FALSE to skip.

Definition at line 53 of file score.h.

Member Data Documentation

◆ m_playCubeTutorial

MxBool ScoreState::m_playCubeTutorial

[AI] Whether the cube tutorial should be played when entering the Score/High Score area.

Definition at line 56 of file score.h.


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