Blaze-Brigade
Public Member Functions | Properties | List of all members
Model.Unit_Module.Button Class Reference

Buttons for the drop down menu buttons when selecting units. More...

Public Member Functions

 Button (ButtonType type, Vector2 coordinates, Texture2D image)
 
Vector2 getPixelCoordinates ()
 
ButtonType getButtonType ()
 
Texture2D getImage ()
 
void setPixelCoordinates (int x, int y)
 

Properties

bool Active [get, set]
 
String item [get, set]
 
bool hasItem [get, set]
 
Weapon weapon [get, set]
 

Detailed Description

Buttons for the drop down menu buttons when selecting units.

Constructor & Destructor Documentation

§ Button()

Model.Unit_Module.Button.Button ( ButtonType  type,
Vector2  coordinates,
Texture2D  image 
)

Constructor for button. Button is by defaalt active, and has no item.

Parameters
typeWhat the button type is.
coordinatesThe pixel coordinate of the button.
imageThe texture for the button.

Member Function Documentation

§ getButtonType()

ButtonType Model.Unit_Module.Button.getButtonType ( )

Returns the button type.

§ getImage()

Texture2D Model.Unit_Module.Button.getImage ( )

Returns the button image.

§ getPixelCoordinates()

Vector2 Model.Unit_Module.Button.getPixelCoordinates ( )

Returns the pixel coordinate of the button.

§ setPixelCoordinates()

void Model.Unit_Module.Button.setPixelCoordinates ( int  x,
int  y 
)

Sets the pixelCoordinate of button.

Parameters
xThe x coordinate of the button.
ythe y coordinate of the button.

Property Documentation

§ Active

bool Model.Unit_Module.Button.Active
getset

sets and gets whether button is active.

§ hasItem

bool Model.Unit_Module.Button.hasItem
getset

Sets and gets whether an item is currently bounded to button.

§ item

String Model.Unit_Module.Button.item
getset

Sets and gets string name for item name.

§ weapon

Weapon Model.Unit_Module.Button.weapon
getset

Sets and gets weapon associated with the button.


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