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

Creates a Unity3D Object to Inherit the Functionality of a DC/RTS ControlObjHandler within the Unity3D Environment. More...

Inheritance diagram for ControlObjHandler:

Public Member Functions

bool isValidMovePathTileCount ()
 Is the Current Move To Path Tile not the Last Tile? More...
 
GridGenerator.GridSquare getMovePathTile ()
 Gets the Path Tile the Control Object is Moving Towards. More...
 
List< GridGenerator.GridSquaregetCalculatedPathTiles ()
 Gets a the Current Path Tiles. More...
 
void setActiveTarget (bool val)
 Sets whether the Control Object is an ActiveTarget. More...
 
bool isActiveTarget ()
 Is the Control Object an Active Target? More...
 
bool isActiveCollision ()
 Is the Control Object Colliding with anything? More...
 
ControlObjObserverData getObserverData ()
 Retrieves this current ControlObjHandler's ControlObjObserverData More...
 
override string ToString ()
 Returns the Name of this Control Object. More...
 

Static Public Member Functions

static List< Transform > DetermineInMultiSelect (Vector2 init, Vector2 end)
 Determines if Control Objects are within the MultiSelectToggle based on Screen Coordinates. More...
 

Public Attributes

string Controller_Name = "NEWCONTROLLER"
 The Name of this Control Object. More...
 
Color ActiveColor = Color.white
 The Color of this Control Object's SelectedIndicator. More...
 
bool ToggleIndicatorSelect = true
 Will this Control Object use the Toggle Indicator? More...
 
bool DisplayHealth = true
 Will this Control Object display health above it's head? More...
 
Material IndicatorMaterial
 The Indicator Material to use for drawing the Toggle Indicator around the Control Object More...
 
Rect HealthBarDimens
 The Dimensions of the Health Bar above the Control Object's head More...
 
bool VerticleHealthBar
 Is this a Verticle Health Bar? More...
 
Texture HealthBubbleTexture
 The Texture of an individual health bubble More...
 
Texture HealthTexture
 The Texture to use to indicate health More...
 
float BarRotationVal
 The rotation of this health bar More...
 

Properties

GridGenerator.GridSquare DestinationTile [get, set]
 Gets or Sets the destination tile that the ControlObjHandler is trying to get to. More...
 
bool Moveable [get, set]
 Does the Control Object have a Path to Traverse? More...
 
bool isPositionReached [get]
 Has the Desired Position been reached for moving to a calculated path? More...
 

Detailed Description

Creates a Unity3D Object to Inherit the Functionality of a DC/RTS ControlObjHandler within the Unity3D Environment.

Member Function Documentation

static List<Transform> ControlObjHandler.DetermineInMultiSelect ( Vector2  init,
Vector2  end 
)
static

Determines if Control Objects are within the MultiSelectToggle based on Screen Coordinates.

Parameters
initThe Initial Screen Coordinate.
endThe Final Screen Coordinate.
Returns
List of Unity3D Transform Objects within the Bounds of the init and end Vector2.
List<GridGenerator.GridSquare> ControlObjHandler.getCalculatedPathTiles ( )

Gets a the Current Path Tiles.

GridGenerator.GridSquare ControlObjHandler.getMovePathTile ( )

Gets the Path Tile the Control Object is Moving Towards.

Returns
The GridGenerator.GridSquare that the Control Object is Moving Towards.
ControlObjObserverData ControlObjHandler.getObserverData ( )

Retrieves this current ControlObjHandler's ControlObjObserverData

Returns
bool ControlObjHandler.isActiveCollision ( )

Is the Control Object Colliding with anything?

Returns
bool ControlObjHandler.isActiveTarget ( )

Is the Control Object an Active Target?

bool ControlObjHandler.isValidMovePathTileCount ( )

Is the Current Move To Path Tile not the Last Tile?

void ControlObjHandler.setActiveTarget ( bool  val)

Sets whether the Control Object is an ActiveTarget.

This is Called for when the Control Object is Selected.

Parameters
valTrue or False.
override string ControlObjHandler.ToString ( )

Returns the Name of this Control Object.

Member Data Documentation

Color ControlObjHandler.ActiveColor = Color.white

The Color of this Control Object's SelectedIndicator.

float ControlObjHandler.BarRotationVal

The rotation of this health bar

string ControlObjHandler.Controller_Name = "NEWCONTROLLER"

The Name of this Control Object.

bool ControlObjHandler.DisplayHealth = true

Will this Control Object display health above it's head?

Rect ControlObjHandler.HealthBarDimens

The Dimensions of the Health Bar above the Control Object's head

Texture ControlObjHandler.HealthBubbleTexture

The Texture of an individual health bubble

Texture ControlObjHandler.HealthTexture

The Texture to use to indicate health

Material ControlObjHandler.IndicatorMaterial

The Indicator Material to use for drawing the Toggle Indicator around the Control Object

bool ControlObjHandler.ToggleIndicatorSelect = true

Will this Control Object use the Toggle Indicator?

This is the selected outline around the Control Object

bool ControlObjHandler.VerticleHealthBar

Is this a Verticle Health Bar?

Property Documentation

GridGenerator.GridSquare ControlObjHandler.DestinationTile
getset

Gets or Sets the destination tile that the ControlObjHandler is trying to get to.

bool ControlObjHandler.isPositionReached
get

Has the Desired Position been reached for moving to a calculated path?

bool ControlObjHandler.Moveable
getset

Does the Control Object have a Path to Traverse?


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