Colobot
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
CPlayerProfile Class Reference

Public Member Functions

 CPlayerProfile (std::string playerName)
 
bool Create ()
 
bool Delete ()
 
std::string GetName ()
 Returns player name. More...
 
std::string GetSaveDir ()
 Returns player's save directory path. More...
 
std::string GetSaveFile (std::string filename)
 Returns path to file inside player's save directory. More...
 
void IncrementLevelTryCount (LevelCategory cat, int chap, int rank)
 Increments level try count. More...
 
int GetLevelTryCount (LevelCategory cat, int chap, int rank)
 Returns try count for given level. More...
 
void SetLevelPassed (LevelCategory cat, int chap, int rank, bool bPassed)
 Changes level passed status (also updates chapter passed status) More...
 
bool GetLevelPassed (LevelCategory cat, int chap, int rank)
 Chenks if the level (or chapter, if rank=0) is passed. More...
 
int GetChapPassed (LevelCategory cat)
 Returns the highest chapter accessible in the given category. More...
 
void SetSelectedChap (LevelCategory category, int chap)
 Sets selected chapter for save file. More...
 
int GetSelectedChap (LevelCategory category)
 Returns selected chapter from save file. More...
 
void SetSelectedRank (LevelCategory category, int rank)
 Sets selected level for save file. More...
 
int GetSelectedRank (LevelCategory category)
 Returns selected level from save file. More...
 
int GetFreeGameBuildUnlock ()
 Returns unlocked EnableBuild for free game. More...
 
void SetFreeGameBuildUnlock (int freeBuild)
 Saves unlocked EnableBuild for free game. More...
 
int GetFreeGameResearchUnlock ()
 Returns unlocked DoneResearch for free game. More...
 
void SetFreeGameResearchUnlock (int freeResearch)
 Saves unlocked DoneResearch for free game. More...
 
PlayerAppearanceGetAppearance ()
 Returns a reference to PlayerAppearance structure. More...
 
void LoadAppearance ()
 Loads PlayerAppearance structure. More...
 
void SaveAppearance ()
 Saves PlayerAppearance structure. More...
 
bool HasAnySavedScene ()
 Returns true if player has at least one saved scene. More...
 
std::vector< SavedSceneGetSavedSceneList ()
 Returns list of all saved scenes. More...
 
void SaveScene (std::string dir, std::string info)
 Saves current scene status. More...
 
void LoadScene (std::string dir)
 Loads scene. More...
 
bool DeleteScene (std::string dir)
 Delete saved scene. More...
 

Static Public Member Functions

static std::string GetLastName ()
 
static std::vector< std::string > GetPlayerList ()
 

Protected Member Functions

void LoadFinishedLevels (LevelCategory category)
 Loads LevelInfo data for given category. More...
 
void SaveFinishedLevels (LevelCategory category)
 Saves LevelInfo data for given category. More...
 
void LoadFreeGameUnlock ()
 Loads free game unlock state. More...
 
void SaveFreeGameUnlock ()
 Saves free game unlock state. More...
 

Protected Attributes

std::string m_playerName
 Player name. More...
 
std::map< LevelCategory, bool > m_levelInfoLoaded
 Is finished levels file loaded already? More...
 
std::map< LevelCategory, std::map< int, std::map< int, LevelInfo > > > m_levelInfo
 Level completion info. More...
 
std::map< LevelCategory, int > m_selectChap
 Selected level chapter. More...
 
std::map< LevelCategory, int > m_selectRank
 Selected level rank. More...
 
bool m_freegameLoaded
 Is freegame save file loaded already? More...
 
int m_freegameBuild
 Buildings unlocked for free game. More...
 
int m_freegameResearch
 Researches unlocked for free game. More...
 
PlayerAppearance m_appearance
 Player appearance. More...
 

Member Function Documentation

◆ GetName()

std::string CPlayerProfile::GetName ( )

Returns player name.

◆ GetSaveDir()

std::string CPlayerProfile::GetSaveDir ( )

Returns player's save directory path.

◆ GetSaveFile()

std::string CPlayerProfile::GetSaveFile ( std::string  filename)

Returns path to file inside player's save directory.

◆ IncrementLevelTryCount()

void CPlayerProfile::IncrementLevelTryCount ( LevelCategory  cat,
int  chap,
int  rank 
)

Increments level try count.

◆ GetLevelTryCount()

int CPlayerProfile::GetLevelTryCount ( LevelCategory  cat,
int  chap,
int  rank 
)

Returns try count for given level.

◆ SetLevelPassed()

void CPlayerProfile::SetLevelPassed ( LevelCategory  cat,
int  chap,
int  rank,
bool  bPassed 
)

Changes level passed status (also updates chapter passed status)

◆ GetLevelPassed()

bool CPlayerProfile::GetLevelPassed ( LevelCategory  cat,
int  chap,
int  rank 
)

Chenks if the level (or chapter, if rank=0) is passed.

◆ GetChapPassed()

int CPlayerProfile::GetChapPassed ( LevelCategory  cat)

Returns the highest chapter accessible in the given category.

◆ SetSelectedChap()

void CPlayerProfile::SetSelectedChap ( LevelCategory  category,
int  chap 
)

Sets selected chapter for save file.

◆ GetSelectedChap()

int CPlayerProfile::GetSelectedChap ( LevelCategory  category)

Returns selected chapter from save file.

◆ SetSelectedRank()

void CPlayerProfile::SetSelectedRank ( LevelCategory  category,
int  rank 
)

Sets selected level for save file.

◆ GetSelectedRank()

int CPlayerProfile::GetSelectedRank ( LevelCategory  category)

Returns selected level from save file.

◆ GetFreeGameBuildUnlock()

int CPlayerProfile::GetFreeGameBuildUnlock ( )

Returns unlocked EnableBuild for free game.

◆ SetFreeGameBuildUnlock()

void CPlayerProfile::SetFreeGameBuildUnlock ( int  freeBuild)

Saves unlocked EnableBuild for free game.

◆ GetFreeGameResearchUnlock()

int CPlayerProfile::GetFreeGameResearchUnlock ( )

Returns unlocked DoneResearch for free game.

◆ SetFreeGameResearchUnlock()

void CPlayerProfile::SetFreeGameResearchUnlock ( int  freeResearch)

Saves unlocked DoneResearch for free game.

◆ GetAppearance()

PlayerAppearance & CPlayerProfile::GetAppearance ( )

Returns a reference to PlayerAppearance structure.

◆ LoadAppearance()

void CPlayerProfile::LoadAppearance ( )

Loads PlayerAppearance structure.

◆ SaveAppearance()

void CPlayerProfile::SaveAppearance ( )

Saves PlayerAppearance structure.

◆ HasAnySavedScene()

bool CPlayerProfile::HasAnySavedScene ( )

Returns true if player has at least one saved scene.

◆ GetSavedSceneList()

std::vector< SavedScene > CPlayerProfile::GetSavedSceneList ( )

Returns list of all saved scenes.

◆ SaveScene()

void CPlayerProfile::SaveScene ( std::string  dir,
std::string  info 
)

Saves current scene status.

◆ LoadScene()

void CPlayerProfile::LoadScene ( std::string  dir)

Loads scene.

◆ DeleteScene()

bool CPlayerProfile::DeleteScene ( std::string  dir)

Delete saved scene.

◆ LoadFinishedLevels()

void CPlayerProfile::LoadFinishedLevels ( LevelCategory  category)
protected

Loads LevelInfo data for given category.

◆ SaveFinishedLevels()

void CPlayerProfile::SaveFinishedLevels ( LevelCategory  category)
protected

Saves LevelInfo data for given category.

◆ LoadFreeGameUnlock()

void CPlayerProfile::LoadFreeGameUnlock ( )
protected

Loads free game unlock state.

◆ SaveFreeGameUnlock()

void CPlayerProfile::SaveFreeGameUnlock ( )
protected

Saves free game unlock state.

Member Data Documentation

◆ m_playerName

std::string CPlayerProfile::m_playerName
protected

Player name.

◆ m_levelInfoLoaded

std::map<LevelCategory, bool> CPlayerProfile::m_levelInfoLoaded
protected

Is finished levels file loaded already?

◆ m_levelInfo

std::map<LevelCategory, std::map<int, std::map<int, LevelInfo> > > CPlayerProfile::m_levelInfo
protected

Level completion info.

◆ m_selectChap

std::map<LevelCategory, int> CPlayerProfile::m_selectChap
protected

Selected level chapter.

◆ m_selectRank

std::map<LevelCategory, int> CPlayerProfile::m_selectRank
protected

Selected level rank.

◆ m_freegameLoaded

bool CPlayerProfile::m_freegameLoaded
protected

Is freegame save file loaded already?

◆ m_freegameBuild

int CPlayerProfile::m_freegameBuild
protected

Buildings unlocked for free game.

◆ m_freegameResearch

int CPlayerProfile::m_freegameResearch
protected

Researches unlocked for free game.

◆ m_appearance

PlayerAppearance CPlayerProfile::m_appearance
protected

Player appearance.


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