RosettaStone::Deck Class Reference
#include <Rosetta/Models/Deck.hpp>
Public Member Functions | |
| Deck () | |
| Default constructor. More... | |
| Player & | GetOwner () const |
| void | SetOwner (Player &owner) |
| bool | IsEmpty () const |
| std::size_t | GetNumOfCards () const |
| Entity * | GetTopCard () const |
| void | AddCard (Entity &card) |
| Entity & | RemoveCard (Entity &card) |
| void | Shuffle () |
| Shuffles cards in deck. More... | |
Detailed Description
Deck class.
This class stores a deck. A deck is a collection of exactly 30 cards assembled before a match, as well as the zone which players draw cards from (and sometimes add cards to) during game play. Each deck is tied to a specific class.
Constructor & Destructor Documentation
◆ Deck()
| RosettaStone::Deck::Deck | ( | ) |
Default constructor.
Member Function Documentation
◆ AddCard()
| void RosettaStone::Deck::AddCard | ( | Entity & | card | ) |
Adds a card to deck.
- Parameters
-
card The card to add to deck.
◆ GetNumOfCards()
| std::size_t RosettaStone::Deck::GetNumOfCards | ( | ) | const |
Returns the number of cards in deck.
- Returns
- The number of cards in deck.
◆ GetOwner()
| Player& RosettaStone::Deck::GetOwner | ( | ) | const |
Returns the owner of deck.
- Returns
- The owner of deck.
◆ GetTopCard()
| Entity* RosettaStone::Deck::GetTopCard | ( | ) | const |
Returns the top card from deck.
- Returns
- The top card of deck.
◆ IsEmpty()
| bool RosettaStone::Deck::IsEmpty | ( | ) | const |
Finds out if deck is empty.
- Returns
- true if deck is empty, and false otherwise.
◆ RemoveCard()
Removes a card from deck.
- Parameters
-
card The card to remove from deck.
- Returns
- The card that is removed from deck.
◆ SetOwner()
| void RosettaStone::Deck::SetOwner | ( | Player & | owner | ) |
Sets the owner of deck.
- Parameters
-
owner The owner of deck.
◆ Shuffle()
| void RosettaStone::Deck::Shuffle | ( | ) |
Shuffles cards in deck.
The documentation for this class was generated from the following file:
- Rosetta/Models/Deck.hpp
