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
GridObjectCreation Class Reference

The system that controls the creation of GridObjects More...

Inheritance diagram for GridObjectCreation:

Public Member Functions

void InitializeObjectCreationSystem ()
 Initializes the Object Creation System, setting initialized to true More...
 
GridObject getCurrentGridObject ()
 Gets the current GridObject that will be created More...
 
Texture2D[] getGridObjectIcons ()
 The Array of Texture2D that makes up the individual GridObjectCreation options More...
 
float[] getGUIScale ()
 The GUI scale based off a 1024 x 768 resolution More...
 
bool isActiveObserverBuild ()
 If ObjectCreationGUIController.CreationMethod = GridObjectCreationMethod.Observer, returns whether a WorkerClass has activated GridObjectCreation building More...
 
bool isActivatedBuild ()
 If currently in the process of building a new GridObject More...
 
bool hasJustBuilt ()
 Has just built a new GridObject, justBuilt boolean deactivates after one second More...
 
Rect getObjectCreationBoxRect ()
 The Rectangle object that makes up the Creation Box Options Area More...
 
Rect getObjectOptionsBoxRect ()
 The Rectangle object that makes up the GridObject Options Box Area More...
 
Rect getObserverOptionsBoxRect ()
 The Rectangle object that makes up the Observer Options Box Area More...
 

Static Public Member Functions

static bool DetermineObjectCreationPaneHover ()
 True when the mouse is hovering over the Creation Box Options Area or the Observer Options Box Area if Observer mode is activated. More...
 
static Vector3 retrieveMinimumVector (Vector3[] vecs)
 Calculates the minimum vector from an array of Vector3s More...
 
static Vector3 retrieveMaximumVector (Vector3[] vecs)
 Calculates the maximum vector from an array of Vector3s More...
 

Detailed Description

The system that controls the creation of GridObjects

Member Function Documentation

static bool GridObjectCreation.DetermineObjectCreationPaneHover ( )
static

True when the mouse is hovering over the Creation Box Options Area or the Observer Options Box Area if Observer mode is activated.

Or if a GridObject has just been built. False otherwise.

GridObject GridObjectCreation.getCurrentGridObject ( )

Gets the current GridObject that will be created

Returns
The GridObject to be created
Texture2D [] GridObjectCreation.getGridObjectIcons ( )

The Array of Texture2D that makes up the individual GridObjectCreation options

Returns
float [] GridObjectCreation.getGUIScale ( )

The GUI scale based off a 1024 x 768 resolution

Returns
An array of floats with length 2 making up the Width Scale and the Height Scale (x scale and y scale)
Rect GridObjectCreation.getObjectCreationBoxRect ( )

The Rectangle object that makes up the Creation Box Options Area

Rect GridObjectCreation.getObjectOptionsBoxRect ( )

The Rectangle object that makes up the GridObject Options Box Area

Rect GridObjectCreation.getObserverOptionsBoxRect ( )

The Rectangle object that makes up the Observer Options Box Area

bool GridObjectCreation.hasJustBuilt ( )

Has just built a new GridObject, justBuilt boolean deactivates after one second

void GridObjectCreation.InitializeObjectCreationSystem ( )

Initializes the Object Creation System, setting initialized to true

bool GridObjectCreation.isActivatedBuild ( )

If currently in the process of building a new GridObject

bool GridObjectCreation.isActiveObserverBuild ( )

If ObjectCreationGUIController.CreationMethod = GridObjectCreationMethod.Observer, returns whether a WorkerClass has activated GridObjectCreation building

static Vector3 GridObjectCreation.retrieveMaximumVector ( Vector3[]  vecs)
static

Calculates the maximum vector from an array of Vector3s

Parameters
vecsArray of Vector3 Objects
Returns
Maximum Vector3
static Vector3 GridObjectCreation.retrieveMinimumVector ( Vector3[]  vecs)
static

Calculates the minimum vector from an array of Vector3s

Parameters
vecsArray of Vector3 Objects
Returns
Minimum Vector3

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