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

This class handles inputs for selecting the objects through the game world More...

Inheritance diagram for SelectionBehavior:

Public Member Functions

void setActiveCursorScrollValues (int c_index, float dx, float dy)
 Sets the Scroll Cursor to a particular frame, with a position modifier for placing the cursor in the right location. More...
 
Transform getSelectedTarget ()
 Retrieves the selected Control Object More...
 
Transform getPreviousTarget ()
 Retrieves the previously selected Control Object More...
 
Transform getActiveTarget ()
 Retrieves the selected NPC Object, Grid Object or Creature Object More...
 

Public Attributes

GridGenerator MainGridGenerator
 The Main GridGenerator to use for Calculating Paths with the PathFinder. More...
 
KeyCode AddAdditionalKey = KeyCode.LeftAlt
 The Key that will Add Additional Control Objects when RealTimeStratToggle is Toggled. More...
 
Texture2D MouseCursor = null
 The Mouse Cursor Texture to use. More...
 
Texture2D MouseHoverCursor = null
 The four framed, 64x64 texture making up the hovering of a ControlObjHandler, NPCHandler, or GridObject More...
 
Texture2D MouseDirections = null
 The 8 framed 32x32 Texture Sheet for the Mouse Scroll Movement Directions More...
 
Material MultiSelectMaterial = null
 The Material that is used for Coloring the Multi Selection Mouse Drag Box. More...
 

Properties

bool SimilarSelected [get, set]
 Allows for setting and retrieval of whether a similar Control Object has been selected More...
 

Detailed Description

This class handles inputs for selecting the objects through the game world

Member Function Documentation

Transform SelectionBehavior.getActiveTarget ( )

Retrieves the selected NPC Object, Grid Object or Creature Object

Returns
Transform of selected NPC, Grid Object or Creature Object
Transform SelectionBehavior.getPreviousTarget ( )

Retrieves the previously selected Control Object

Returns
Transform of previously selected Control Object
Transform SelectionBehavior.getSelectedTarget ( )

Retrieves the selected Control Object

Returns
Transform of selected Control Object
void SelectionBehavior.setActiveCursorScrollValues ( int  c_index,
float  dx,
float  dy 
)

Sets the Scroll Cursor to a particular frame, with a position modifier for placing the cursor in the right location.

Called from CamMovementBehavior.cs

Parameters
c_indexThe Index of the valid Mouse Scroll Direction texture array
dxThe x position modifier
dyThe y position modifier

Member Data Documentation

KeyCode SelectionBehavior.AddAdditionalKey = KeyCode.LeftAlt

The Key that will Add Additional Control Objects when RealTimeStratToggle is Toggled.

GridGenerator SelectionBehavior.MainGridGenerator

The Main GridGenerator to use for Calculating Paths with the PathFinder.

Texture2D SelectionBehavior.MouseCursor = null

The Mouse Cursor Texture to use.

4 frames each 64x64 -> total: 256x64

Texture2D SelectionBehavior.MouseDirections = null

The 8 framed 32x32 Texture Sheet for the Mouse Scroll Movement Directions

Texture2D SelectionBehavior.MouseHoverCursor = null

The four framed, 64x64 texture making up the hovering of a ControlObjHandler, NPCHandler, or GridObject

Material SelectionBehavior.MultiSelectMaterial = null

The Material that is used for Coloring the Multi Selection Mouse Drag Box.

Property Documentation

bool SelectionBehavior.SimilarSelected
getset

Allows for setting and retrieval of whether a similar Control Object has been selected


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