My Project
Public Member Functions | Properties | List of all members
Model.MapModule.Node Class Reference

Structure that represents a tile on the game map grid. More...

Public Member Functions

 Node (int x, int y)
 
Vector2 getPosition ()
 
int getPositionX ()
 
int getPositionY ()
 
bool isOccupied ()
 

Properties

int movabilityObstruction [get, set]
 
bool isObstacle [get, set]
 
Unit unitOnNode [get, set]
 

Detailed Description

Structure that represents a tile on the game map grid.

Programmatical representation of a tile on the map grid. Holds information pertaining to the tile.

Constructor & Destructor Documentation

§ Node()

Model.MapModule.Node.Node ( int  x,
int  y 
)
inline

Creates a node at position x,y, with default set to not being an obstacle or movabilityObstruction.

Parameters
xX position of the node on the graph (by node).
yY position of the node on the graph (by node).

Member Function Documentation

§ getPosition()

Vector2 Model.MapModule.Node.getPosition ( )
inline

Returns the Vector position of the node on the graph.

§ getPositionX()

int Model.MapModule.Node.getPositionX ( )
inline

Returns the X position of the node on the graph.

§ getPositionY()

int Model.MapModule.Node.getPositionY ( )
inline

Returns the Y position of the node on the graph.

§ isOccupied()

bool Model.MapModule.Node.isOccupied ( )
inline

Indicates whether the node is occupied by a unit.

Property Documentation

§ isObstacle

bool Model.MapModule.Node.isObstacle
getset

Indicates whether a unit can stand inside the tile.

§ movabilityObstruction

int Model.MapModule.Node.movabilityObstruction
getset

Index for hindrance of the movability of a unit. The higher the index, the less a unit can move through the tile. Set to 0 by default (no hindrance).

§ unitOnNode

Unit Model.MapModule.Node.unitOnNode
getset

Gets and sets the unit that is on the node.


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