Blaze Brigade  Rev0
Public Member Functions | Properties | List of all members
Model.Unit Interface Reference

Unit Interface for Warrior, Mage, and Archer More...

Inheritance diagram for Model.Unit:
Model.Archer Model.Mage Model.Warrior

Public Member Functions

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

Properties

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

Unit Interface for Warrior, Mage, and Archer

This is the interface for the 3 playable unit classes, where the only differences in the units will be their statistics and graphical assets

Member Function Documentation

§ getButtonImage()

Texture2D Model.Unit.getButtonImage ( ButtonType  buttonType)

returns the button texture at index i

Implemented in Model.Archer, Model.Mage, and Model.Warrior.

§ getButtons()

Button [] Model.Unit.getButtons ( )

returns the dropdown menu buttons of the unit

Implemented in Model.Archer, Model.Mage, and Model.Warrior.

§ getButtonType()

Button Model.Unit.getButtonType ( ButtonType  buttonType)

Returns the button type

Parameters
buttonTypeThe button to return (Move, Attack, Item, Wait, and attack confirm)

Implemented in Model.Archer, Model.Mage, and Model.Warrior.

§ getCharAttackInfo()

Texture2D Model.Unit.getCharAttackInfo ( )

returns the char attack info screen texture

Implemented in Model.Archer, Model.Mage, and Model.Warrior.

§ getCharInfo()

Texture2D Model.Unit.getCharInfo ( )

returns the char info screen texture

Implemented in Model.Archer, Model.Mage, and Model.Warrior.

§ getClass()

UnitType Model.Unit.getClass ( )

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

Implemented in Model.Archer, Model.Mage, and Model.Warrior.

§ getCurrentFrame()

Rectangle Model.Unit.getCurrentFrame ( )

returns the current sprite frame in animation sequence

Implemented in Model.Archer, Model.Mage, and Model.Warrior.

§ getEquipableWeapons()

Weapon [] Model.Unit.getEquipableWeapons ( )

returns array of equipable weapons

Implemented in Model.Archer, Model.Mage, and Model.Warrior.

§ getMovability()

int Model.Unit.getMovability ( )

Returns the unit's movability range on grid (number of spaces the unit can move in one turn)

Implemented in Model.Archer, Model.Mage, and Model.Warrior.

§ getSpriteImage()

Texture2D Model.Unit.getSpriteImage ( )

returns the sprite image of the unit

Implemented in Model.Archer, Model.Mage, and Model.Warrior.

§ getStats()

int [] Model.Unit.getStats ( )

returns all stats as an array

Implemented in Model.Archer, Model.Mage, and Model.Warrior.

§ isButtonActive()

bool Model.Unit.isButtonActive ( ButtonType  buttonType)

indicates whether a button has already been previously selected or not

Implemented in Model.Archer, Model.Mage, and Model.Warrior.

§ setButtonCoordinates()

void Model.Unit.setButtonCoordinates ( Vector2  pixelCoordinates)

sets the coordinates of menu buttons

Parameters
pixelCoordinatesThe pixel coordinate of the button

Implemented in Model.Archer, Model.Mage, and Model.Warrior.

§ setInitialStats()

void Model.Unit.setInitialStats ( )

sets initial unit stats upon creation

Implemented in Model.Archer, Model.Mage, and Model.Warrior.

Property Documentation

§ Alive

bool Model.Unit.Alive
getset

Sets and returns whether or not unit is alive

§ currentFrame

int Model.Unit.currentFrame
getset

Sets and gets the current frame of the animation sequence

§ Def

int Model.Unit.Def
getset

Sets and returns a unit's Defense

§ equippedWeapon

Weapon Model.Unit.equippedWeapon
getset

returns weapon the unit is currently equipping

§ Hp

int Model.Unit.Hp
getset

Sets and returns a unit's HP

§ Int

int Model.Unit.Int
getset

Sets and returns a unit's Intelliegence

§ Level

int Model.Unit.Level
getset

Sets and returns a unit's Level

§ PixelCoordinates

Vector2 Model.Unit.PixelCoordinates
getset

returns the pixel coordinate of the unit

§ Position

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

gets and sets unit's position by tile

§ Res

int Model.Unit.Res
getset

Sets and returns a unit's Resistance

§ Skill

int Model.Unit.Skill
getset

Sets and returns a unit's Skill

§ Speed

int Model.Unit.Speed
getset

Sets and returns a unit's Speed

§ Str

int Model.Unit.Str
getset

Sets and returns a unit's Strength


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