PlayerInfo Class Reference

Collaboration diagram for PlayerInfo:

Public Member Functions
void	Load (PlayerNumber pn, MultiPlayer mp, bool bShowNoteField, int iAddToDifficulty, GameplayMode mode=GameplayMode_Normal)
MultiPlayer	GetPlayerStateAndStageStatsIndex ()
	Retrieve the player's state and stage stats index.
PlayerState *	GetPlayerState ()
PlayerStageStats *	GetPlayerStageStats ()
PlayerNumber	GetStepsAndTrailIndex ()
bool	IsEnabled ()
	Determine if the player information is enabled.
bool	IsMultiPlayer () const
	Determine if we're in MultiPlayer.
std::string	GetName () const
	Retrieve the name of the Player based on the mode.
void	PushSelf (lua_State *L)

Public Attributes
PlayerNumber	m_pn
	The present Player's number.
MultiPlayer	m_mp { MultiPlayer_Invalid }
	The present Player's multiplayer number.
bool	m_bIsDummy { false }
int	m_iAddToDifficulty { 0 }
bool	m_bPlayerEnabled { false }
SoundEffectControl	m_SoundEffectControl
std::vector< Steps * >	m_vpStepsQueue
	The list of Steps a player has to go through in this set.
LifeMeter *	m_pLifeMeter
	The LifeMeter showing a Player's health.
BitmapText *	m_ptextStepsDescription
	The description of the current Steps.
ScoreKeeper *	m_pPrimaryScoreKeeper
	The primary ScoreKeeper for keeping track of the score.
BitmapText *	m_ptextPlayerOptions
	The current PlayerOptions that are activated.
NoteData	m_NoteData
	The NoteData the Player has to get through.
Player *	m_pPlayer
	The specific Player that is going to play.
StepsDisplay *	m_pStepsDisplay

Member Function Documentation

GetName()

std::string PlayerInfo::GetName ( ) const

inline

Retrieve the name of the Player based on the mode.

Returns

the name of the Player.

GetPlayerStateAndStageStatsIndex()

MultiPlayer PlayerInfo::GetPlayerStateAndStageStatsIndex ( )

inline

Retrieve the player's state and stage stats index.

Returns

the player's state and stage stats index.

IsEnabled()

bool PlayerInfo::IsEnabled

(

)

Determine if the player information is enabled.

Returns

its success or failure.

IsMultiPlayer()

bool PlayerInfo::IsMultiPlayer ( ) const

inline

Determine if we're in MultiPlayer.

Returns

true if it is MultiPlayer, false otherwise.

Member Data Documentation

m_vpStepsQueue

std::vector<Steps*> PlayerInfo::m_vpStepsQueue

The list of Steps a player has to go through in this set.

The size may be greater than 1 if playing a course.

---

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

• /home/runner/work/etterna/etterna/src/Etterna/Models/Misc/PlayerInfo.h
• /home/runner/work/etterna/etterna/src/Etterna/Models/Misc/PlayerInfo.cpp