The Mage model class, extends Unit
This Unit has strong magical capabilities, and is capable of powerful ranged magic attacks, but makes up with poor physical stats
More...
|
bool | Alive [get, set] |
|
int | Speed [get, set] |
|
int | Def [get, set] |
|
int | Res [get, set] |
|
int | Level [get, set] |
|
Weapon | equippedWeapon [get, set] |
|
int | currentFrame [get, set] |
|
int | Str [get, set] |
|
int | Int [get, set] |
|
int | Skill [get, set] |
|
int | Hp [get, set] |
|
Tuple< int, int > | Position [get, set] |
|
Vector2 | PixelCoordinates [get, set] |
|
bool | Alive [get, set] |
|
int | Hp [get, set] |
|
int | Str [get, set] |
|
int | Int [get, set] |
|
int | Skill [get, set] |
|
int | Speed [get, set] |
|
int | Def [get, set] |
|
int | Res [get, set] |
|
int | Level [get, set] |
|
Weapon | equippedWeapon [get, set] |
|
int | currentFrame [get, set] |
|
Tuple< int, int > | Position [get, set] |
|
Vector2 | PixelCoordinates [get, set] |
|
The Mage model class, extends Unit
This Unit has strong magical capabilities, and is capable of powerful ranged magic attacks, but makes up with poor physical stats
§ Mage()
Model.Mage.Mage |
( |
Texture2D |
spriteImage, |
|
|
Button [] |
unitButtons, |
|
|
Texture2D |
charInfo, |
|
|
Texture2D |
charAttackInfo, |
|
|
Vector2 |
coordinates, |
|
|
Texture2D |
healthBar |
|
) |
| |
The constructor for Unit Mage. Stores all relevent data in model.
- Parameters
-
spriteImage | The character sprite |
attackButton | The dropdownmenu attack button texture |
moveButton | The dropdownmenu move button texture |
itemButton | The dropdownmenu item button texture |
waitButton | The dropdownmenu wait button texture |
confirmButton | The attack confirm button texture |
charInfo | The character info popup texture |
charAttackInfo | The character attack menu popup texture |
coordinates | The unit's current coordinate on screen |
player | The player of which the unit belongs to |
§ getButtonImage()
Texture2D Model.Mage.getButtonImage |
( |
ButtonType |
buttonType | ) |
|
This method returns the texture associated with the bunttonType passed in, by going through a switch case and matching it.
- Parameters
-
buttonType | The buttontype that was clicked |
Implements Model.Unit.
§ getButtons()
Button [] Model.Mage.getButtons |
( |
| ) |
|
returns the dropdown menu buttons of the unit
Implements Model.Unit.
§ getButtonType()
Method takes in the buttonType enum, then returns the object associated with that enum
- Parameters
-
buttonType | The button to return (Move, Attack, Item, Wait, and attack confirm) |
Implements Model.Unit.
§ getCharAttackInfo()
Texture2D Model.Mage.getCharAttackInfo |
( |
| ) |
|
returns the char attack info screen texture
Implements Model.Unit.
§ getCharInfo()
Texture2D Model.Mage.getCharInfo |
( |
| ) |
|
returns the char info screen texture
Implements Model.Unit.
§ getClass()
returns unit's class (warrior, mage, archer)
Implements Model.Unit.
§ getCurrentFrame()
Rectangle Model.Mage.getCurrentFrame |
( |
| ) |
|
returns the current sprite frame in animation sequence. The rectangle starts at currentFrame * 32, where 32 is the sprite sheet offset between frames, and is 32 high and wide.
Exceptions:
-Assumes that each sprite frame is 32pixels wide
Implements Model.Unit.
§ getEquipableWeapons()
Weapon [] Model.Mage.getEquipableWeapons |
( |
| ) |
|
returns weapons the unit can equip (TODO)
Implements Model.Unit.
§ getHealthBar()
Texture2D Model.Mage.getHealthBar |
( |
| ) |
|
Returns the healthbar texture
Implements Model.Unit.
§ getMaxHp()
int Model.Mage.getMaxHp |
( |
| ) |
|
Returns the character's max HP
Implements Model.Unit.
§ getMovability()
int Model.Mage.getMovability |
( |
| ) |
|
Returns the unit's movability range on grid (number of spaces the unit can move in one turn)
Exceptions:
-Negative movement will be treated as 0 in path finding algorithm
Implements Model.Unit.
§ getSpriteImage()
Texture2D Model.Mage.getSpriteImage |
( |
| ) |
|
returns the sprite image of the unit
Implements Model.Unit.
§ getStats()
int [] Model.Mage.getStats |
( |
| ) |
|
returns all stats as an array, where the index in array corresponds to stats in this order: Level, Strength, Int, Skill, Speed, Def, Res
Implements Model.Unit.
§ isButtonActive()
bool Model.Mage.isButtonActive |
( |
ButtonType |
buttonType | ) |
|
This method takes in the buttonType specified, and checks if that button is currently active by calling the getter in button.
- Parameters
-
buttonType | The buttontype that was clicked |
Implements Model.Unit.
§ setButtonCoordinates()
void Model.Mage.setButtonCoordinates |
( |
Vector2 |
pixelCoordinates | ) |
|
Sets the coordinates of menu buttons. One for loop will position the main Drop Down menu (potentailly containing attack, move, item and wait directly 32 pixels to the right of unit (so the tile to right of unit) , and for each active button, increment it downwards by 32 pixels (height of each button). The second for loop is similiar and is for the inventory menu buttons, except it starts 160 pixels offsetted to right (to the right of the main drop down menu).
- Parameters
-
pixelCoordinates | The pixel coordinate of the button |
Implements Model.Unit.
§ setInitialStats()
void Model.Mage.setInitialStats |
( |
| ) |
|
§ Alive
Sets and returns whether or not unit is alive
§ currentFrame
int Model.Mage.currentFrame |
|
getset |
Gets and sets current frame the sprite is on
§ Def
Sets and returns a unit's Defense
Exceptions:
-Negative defense will result in an attacker doing more damage than their attack
§ equippedWeapon
Weapon Model.Mage.equippedWeapon |
|
getset |
Gets and sets the unit is currently equipping
§ Hp
Sets and returns a unit's HP. Should HP fall under 0, Unit's Alive Boolean should change to false
§ Int
Sets the new intelligence value
Gets the effective intelligence -> Unit intelligence + weapon intelligence
Exceptions:
-Negative strength will be treated as 0 in damage calculation, as damage dealt can not be negative
§ Level
Sets and returns a unit's Level. Currently does not have any use
§ PixelCoordinates
Vector2 Model.Mage.PixelCoordinates |
|
getset |
returns the pixel coordinate of the unit
sets the pixel coordinate, and also sets Position (which is the tile location of that coordinate)
Exceptions:
-Dead units will still have a position, but won't impact the rest of the game
§ Position
Tuple<int, int> Model.Mage.Position |
|
getset |
gets and sets unit's position by tile. The set also updates pixelCoordinate's location by making that vector equivalent to position*32 (since each tile is 32x32).
Exceptions:
-Dead units will still have a position, but won't impact the rest of the game
§ Res
Sets and returns a unit's Resistance
Exceptions:
-Negative resistance will result in an attacker doing more damage than their intelligence
§ Skill
Sets the new skill value
Gets the effective skill -> Unit skill + weapon skill
Exceptions:
-Negative skill will not result in an error, but will most likely result in a 0% hit and crit rate
§ Speed
Sets and returns a unit's Speed
Exceptions:
-Negative skill will not result in an error as speed is only used for checking double attack boolean, which is binary
§ Str
Sets the new strength value
Gets the effective strength -> Unit strength + weapon strength
Exceptions:
-Negative strength will be treated as 0 in damage calculation, as damage dealt can not be negative
The documentation for this class was generated from the following file:
- C:/Users/Thien Trandinh/Documents/Blaze-Brigade/src/Blaze-Brigade/Blaze_Brigade/Mage.cs