Blaze Brigade
Public Member Functions | Properties | List of all members
Model.Mage Class Reference

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...

Inheritance diagram for Model.Mage:
Model.Unit

Public Member Functions

 Mage (Texture2D spriteImage, Button[] unitButtons, Texture2D charInfo, Texture2D charAttackInfo, Vector2 coordinates)
 
void setInitialStats ()
 
int getMovability ()
 
int [] getStats ()
 
Weapon [] getEquipableWeapons ()
 
UnitType getClass ()
 
Texture2D getSpriteImage ()
 
Texture2D getButtonImage (ButtonType buttonType)
 
bool isButtonActive (ButtonType buttonType)
 
Texture2D getCharInfo ()
 
Texture2D getCharAttackInfo ()
 
Button [] getButtons ()
 
Button getButtonType (ButtonType buttonType)
 
void setButtonCoordinates (Vector2 pixelCoordinates)
 
Rectangle getCurrentFrame ()
 

Properties

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]
 
- Properties inherited from Model.Unit
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]
 

Detailed Description

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

Constructor & Destructor Documentation

§ Mage()

Model.Mage.Mage ( Texture2D  spriteImage,
Button []  unitButtons,
Texture2D  charInfo,
Texture2D  charAttackInfo,
Vector2  coordinates 
)

The constructor for Unit Mage

Parameters
spriteImageThe character sprite
attackButtonThe dropdownmenu attack button texture
moveButtonThe dropdownmenu move button texture
itemButtonThe dropdownmenu item button texture
waitButtonThe dropdownmenu wait button texture
confirmButtonThe attack confirm button texture
charInfoThe character info popup texture
charAttackInfoThe character attack menu popup texture
coordinatesThe unit's current coordinate on screen
playerThe player of which the unit belongs to

Member Function Documentation

§ getButtonImage()

Texture2D Model.Mage.getButtonImage ( ButtonType  buttonType)

returns the button texture at index i

Implements Model.Unit.

§ getButtons()

Button [] Model.Mage.getButtons ( )

returns the dropdown menu buttons of the unit

Implements Model.Unit.

§ getButtonType()

Button Model.Mage.getButtonType ( ButtonType  buttonType)

Returns the button type

Parameters
buttonTypeThe 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()

UnitType Model.Mage.getClass ( )

returns unit's class (warrior, mage, archer)

Implements Model.Unit.

§ getCurrentFrame()

Rectangle Model.Mage.getCurrentFrame ( )

returns the current sprite frame in animation sequence

Implements Model.Unit.

§ getEquipableWeapons()

Weapon [] Model.Mage.getEquipableWeapons ( )

returns weapons the unit can equip (TODO)

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)

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

Implements Model.Unit.

§ isButtonActive()

bool Model.Mage.isButtonActive ( ButtonType  buttonType)

indicates whether a button has already been previously selected or not

Implements Model.Unit.

§ setButtonCoordinates()

void Model.Mage.setButtonCoordinates ( Vector2  pixelCoordinates)

sets the coordinates of menu buttons

Parameters
pixelCoordinatesThe pixel coordinate of the button

Implements Model.Unit.

§ setInitialStats()

void Model.Mage.setInitialStats ( )

sets initial unit stats upon creation

Implements Model.Unit.

Property Documentation

§ Alive

bool Model.Mage.Alive
getset

Sets and returns whether or not unit is alive

§ currentFrame

int Model.Mage.currentFrame
getset

the current frame the sprite is on

§ Def

int Model.Mage.Def
getset

Sets and returns a unit's Defense

§ equippedWeapon

Weapon Model.Mage.equippedWeapon
getset

returns weapon the unit is currently equipping

§ Hp

int Model.Mage.Hp
getset

Sets the hp of the unit.
Gets the unit's hp.

§ Int

int Model.Mage.Int
getset

Sets the new intelligence value
Gets the effective intelligence -> Unit intelligence + weapon intelligence

§ Level

int Model.Mage.Level
getset

Sets and returns a unit's Level

§ 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)

§ Position

Tuple<int, int> Model.Mage.Position
getset

gets and sets unit's position by tile

§ Res

int Model.Mage.Res
getset

Sets and returns a unit's Resistance

§ Skill

int Model.Mage.Skill
getset

Sets the new skill value
Gets the effective skill -> Unit skill + weapon skill

§ Speed

int Model.Mage.Speed
getset

Sets and returns a unit's Speed

§ Str

int Model.Mage.Str
getset

Sets the new strength value
Gets the effective strength -> Unit strength + weapon strength


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