Battlefield class. More...
#include <Rosetta/Models/Battlefield.hpp>
Public Member Functions | |
| Battlefield () | |
| Default constructor. More... | |
| Player & | GetOwner () const |
| void | SetOwner (Player &owner) |
| std::size_t | GetNumOfMinions () const |
| Character * | GetMinion (std::size_t pos) |
| std::vector< Character * > | GetAllMinions () |
| std::optional< std::size_t > | FindMinionPos (Minion &minion) |
| std::optional< std::size_t > | FindEmptyPos () const |
| void | AddMinion (Minion &minion, std::size_t pos) |
| void | RemoveMinion (Minion &minion) |
Detailed Description
Battlefield class.
This class is where the action takes place, representing the board on which each game is played out. Around the battlefield are various important UI elements, such as each player's hand, deck and Mana Crystals, as well as the two heroes themselves. Each battlefield features its own design and numerous interactive elements, but play is in no way affected or determined by battlefield selection. Battlefields are chosen at random and are independent of the heroes chosen by players or used by the Innkeeper.
Constructor & Destructor Documentation
◆ Battlefield()
| RosettaStone::Battlefield::Battlefield | ( | ) |
Default constructor.
Member Function Documentation
◆ AddMinion()
| void RosettaStone::Battlefield::AddMinion | ( | Minion & | minion, |
| std::size_t | pos | ||
| ) |
Adds minion to battlefield.
- Parameters
-
minion The minion to add to battlefield. pos The position of minion in battlefield.
◆ FindEmptyPos()
| std::optional<std::size_t> RosettaStone::Battlefield::FindEmptyPos | ( | ) | const |
Returns The empty position in battlefield.
- Returns
- The empty position in battlefield.
◆ FindMinionPos()
| std::optional<std::size_t> RosettaStone::Battlefield::FindMinionPos | ( | Minion & | minion | ) |
Returns the position of minion in battlefield.
- Returns
- The position of minion in battlefield.
◆ GetAllMinions()
| std::vector<Character*> RosettaStone::Battlefield::GetAllMinions | ( | ) |
Returns all minions in battlefield.
- Returns
- A list of minions in battlefield.
◆ GetMinion()
| Character* RosettaStone::Battlefield::GetMinion | ( | std::size_t | pos | ) |
Returns minion in battlefield.
- Parameters
-
pos The position of minion in battlefield.
- Returns
- A minion in battlefield at
pos.
◆ GetNumOfMinions()
| std::size_t RosettaStone::Battlefield::GetNumOfMinions | ( | ) | const |
Returns the number of minions in battlefield.
- Returns
- The number of minions in battlefield.
◆ GetOwner()
| Player& RosettaStone::Battlefield::GetOwner | ( | ) | const |
Returns the owner of battlefield.
- Returns
- The owner of battlefield.
◆ RemoveMinion()
| void RosettaStone::Battlefield::RemoveMinion | ( | Minion & | minion | ) |
Removes minion from battlefield.
- Parameters
-
minion The minion to remove from battlefield.
◆ SetOwner()
| void RosettaStone::Battlefield::SetOwner | ( | Player & | owner | ) |
Sets the owner of battlefield.
- Parameters
-
owner The owner of battlefield.
The documentation for this class was generated from the following file:
- Rosetta/Models/Battlefield.hpp
