DC/RTS Documentation  v1.62
A Unity3D System Incorporating the Functionality of a Dungeon Crawler or Real Time Strategy System
 All Classes Files Functions Variables Enumerations Enumerator Properties Pages
GridObject Class Reference

Represents a GridObject that is used on the GridGenerator More...

Inheritance diagram for GridObject:

Public Member Functions

List< GridGenerator.GridSquaregetObjGridSquares ()
 Retrieves the GridSquares that make up this GridObject More...
 
bool isContinualCheck ()
 Is the GridObject currently being constantly updated? More...
 
bool isValidBuildLocation ()
 Is this GridObject buildable? More...
 
Texture2D getOptionsTexture (int index)
 Gets the options texture at a particular index More...
 
TimerBarSystem getTimerBar (int r, int c)
 Get the TimeBarSystem at the particular row and column of the GridObject option More...
 
HealthSystem getHealthBar ()
 Gets this GridObject's HealthBarSystem. More...
 
TimerBarSystem getActionTimerBar ()
 Gets this GridObject's TimerBarSystem. More...
 
void setTimeBarTimeLimits (float tT)
 Sets the time values for this GridObject options, this is called from the GridObjectHandler class More...
 

Public Attributes

Texture2D OptionsTexture
 The 50x50 framed texture that makes up this GridObject's individual options More...
 
int OptionsRows
 How many Rows does this GridObject's options contain? More...
 
int OptionsColumns
 How many Columns does this GridObject's options contain? More...
 
bool Selectable
 Is this GridObject selectable? More...
 

Properties

float BuildTime [get, set]
 The amount of time needed to build this Grid Object More...
 

Detailed Description

Represents a GridObject that is used on the GridGenerator

Member Function Documentation

TimerBarSystem GridObject.getActionTimerBar ( )

Gets this GridObject's TimerBarSystem.

Returns
HealthSystem GridObject.getHealthBar ( )

Gets this GridObject's HealthBarSystem.

Returns
List<GridGenerator.GridSquare> GridObject.getObjGridSquares ( )

Retrieves the GridSquares that make up this GridObject

Returns
A List of GridGenerator.GridSquare objects
Texture2D GridObject.getOptionsTexture ( int  index)

Gets the options texture at a particular index

Parameters
indexThe index to retrieve from
Returns
Texture2D representing the 50x50 frame of the option
TimerBarSystem GridObject.getTimerBar ( int  r,
int  c 
)

Get the TimeBarSystem at the particular row and column of the GridObject option

Parameters
rThe Row
cThe Column
Returns
The TimerBarSystem
bool GridObject.isContinualCheck ( )

Is the GridObject currently being constantly updated?

bool GridObject.isValidBuildLocation ( )

Is this GridObject buildable?

void GridObject.setTimeBarTimeLimits ( float  tT)

Sets the time values for this GridObject options, this is called from the GridObjectHandler class

Parameters
tTThe desired time

Member Data Documentation

int GridObject.OptionsColumns

How many Columns does this GridObject's options contain?

int GridObject.OptionsRows

How many Rows does this GridObject's options contain?

Texture2D GridObject.OptionsTexture

The 50x50 framed texture that makes up this GridObject's individual options

bool GridObject.Selectable

Is this GridObject selectable?

Property Documentation

float GridObject.BuildTime
getset

The amount of time needed to build this Grid Object


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