RosettaStone::Player Class Reference
#include <Rosetta/Models/Player.hpp>
Public Member Functions | |
Player () | |
Default constructor. More... | |
~Player () | |
Destructor. More... | |
Player (const Player &p)=delete | |
Copy constructor. More... | |
Player (Player &&p)=delete | |
Move constructor. More... | |
Player & | operator= (const Player &p)=delete |
Copy assignment operator. More... | |
Player & | operator= (Player &&p)=delete |
Move assignment operator. More... | |
std::string | GetNickname () const |
void | SetNickname (std::string nickname) |
PlayerType | GetPlayerType () const |
void | SetPlayerType (PlayerType type) |
std::size_t | GetID () const |
void | SetID (std::size_t id) |
Game * | GetGame () const |
void | SetGame (Game *game) |
Battlefield & | GetField () |
Deck & | GetDeck () |
Graveyard & | GetGraveyard () |
Hand & | GetHand () |
Hero * | GetHero () const |
IPolicy & | GetPolicy () const |
void | SetPolicy (IPolicy *policy) |
Player & | GetOpponent () const |
void | SetOpponent (Player *player) |
void | AddHeroAndPower (Card &&heroCard, Card &&powerCard) |
Public Attributes | |
PlayState | playState = PlayState::INVALID |
Mulligan | mulliganState = Mulligan::INVALID |
std::optional< Choice > | choice = std::nullopt |
std::size_t | currentMana = 0 |
std::size_t | maximumMana = 0 |
Static Public Attributes | |
static constexpr std::size_t | USER_INVALID = 255 |
Detailed Description
Player class.
This class stores various information that used in Hearthstone game. NOTE: This information should be used differently from the existing card information because there are various effects on the card.
Constructor & Destructor Documentation
◆ Player() [1/3]
RosettaStone::Player::Player | ( | ) |
Default constructor.
◆ ~Player()
RosettaStone::Player::~Player | ( | ) |
Destructor.
◆ Player() [2/3]
|
delete |
Copy constructor.
◆ Player() [3/3]
|
delete |
Move constructor.
Member Function Documentation
◆ AddHeroAndPower()
Adds hero and hero power.
- Parameters
-
heroCard A card that represents hero. powerCard A card that represents hero power.
◆ GetDeck()
◆ GetField()
Battlefield& RosettaStone::Player::GetField | ( | ) |
Returns player's battlefield.
- Returns
- Player's battlefield.
◆ GetGame()
Game* RosettaStone::Player::GetGame | ( | ) | const |
Returns a pointer to game.
- Returns
- A pointer to game.
◆ GetGraveyard()
Graveyard& RosettaStone::Player::GetGraveyard | ( | ) |
Returns player's graveyard.
- Returns
- Player's graveyard.
◆ GetHand()
◆ GetHero()
◆ GetID()
std::size_t RosettaStone::Player::GetID | ( | ) | const |
Returns player ID.
- Returns
- Player ID.
◆ GetNickname()
std::string RosettaStone::Player::GetNickname | ( | ) | const |
Returns player nickname.
- Returns
- player nickname.
◆ GetOpponent()
Player& RosettaStone::Player::GetOpponent | ( | ) | const |
Returns the opponent player.
- Returns
- The opponent player.
◆ GetPlayerType()
PlayerType RosettaStone::Player::GetPlayerType | ( | ) | const |
Returns player type.
- Returns
- Player type.
◆ GetPolicy()
IPolicy& RosettaStone::Player::GetPolicy | ( | ) | const |
Returns game playing policy of current player.
- Returns
- The policy of current player.
◆ operator=() [1/2]
◆ operator=() [2/2]
◆ SetGame()
void RosettaStone::Player::SetGame | ( | Game * | game | ) |
Sets a pointer to game.
- Parameters
-
game A pointer to game.
◆ SetID()
void RosettaStone::Player::SetID | ( | std::size_t | id | ) |
Sets player ID.
- Parameters
-
id Player ID.
◆ SetNickname()
void RosettaStone::Player::SetNickname | ( | std::string | nickname | ) |
Sets player nickname.
- Parameters
-
nickname player nickname.
◆ SetOpponent()
void RosettaStone::Player::SetOpponent | ( | Player * | player | ) |
Sets the opponent player.
- Parameters
-
player The opponent player.
◆ SetPlayerType()
void RosettaStone::Player::SetPlayerType | ( | PlayerType | type | ) |
Sets player type.
- Parameters
-
type Player type.
◆ SetPolicy()
void RosettaStone::Player::SetPolicy | ( | IPolicy * | policy | ) |
Sets game playing policy for current player.
- Parameters
-
policy Policy for playing game.
Member Data Documentation
◆ choice
std::optional<Choice> RosettaStone::Player::choice = std::nullopt |
◆ currentMana
std::size_t RosettaStone::Player::currentMana = 0 |
◆ maximumMana
std::size_t RosettaStone::Player::maximumMana = 0 |
◆ mulliganState
Mulligan RosettaStone::Player::mulliganState = Mulligan::INVALID |
◆ playState
PlayState RosettaStone::Player::playState = PlayState::INVALID |
◆ USER_INVALID
|
static |
The documentation for this class was generated from the following file:
- Rosetta/Models/Player.hpp