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
GridGenerator.GridSquareQuadrant Class Reference

Used for Being Able to Easily keep Track of GridSquares Tied to Specific Quadrants. More...

Public Member Functions

 GridSquareQuadrant (int quad_size, int t_rows, int t_cols, int q_row, int q_col)
 Creates a new GridSquareQuadrant and initializes Static Values. More...
 
 GridSquareQuadrant (int q_row, int q_col)
 Creates a new GridSquareQuadrant. More...
 
void determineAdjacentQuadrants (GridSquareQuadrant[,] quads)
 Determines Adjacent GridQuadrants to this GridQuadrant. More...
 
GridSquare[] retrieveQuadrantSquares ()
 Retrieves the GridSquares Attached to this GridQuadrant. More...
 
void resetQuadrant ()
 Used for Reseting any Information Tied to this Specific Quadrant. More...
 
int getRow ()
 Retrieves the Row Value of this GridQuadrant. More...
 
int getColumn ()
 Retrieves the Column Value of this GridQuadrant. More...
 
List< GridSquareQuadrantgetAdjacentQuadrants ()
 Retrieves this GridQuadrant's Adjacent GridQuadrants More...
 

Static Public Member Functions

static void resetQuadrantSquares (int t_r, int t_c)
 Resets all the GridSquares attached to the Static GridSquares Array. More...
 
static GridSquare retrieveSpecificSquare (int r, int c)
 Retrieves a GridSquare from a Particular Row and Column. More...
 
static void removeSpecificSquare (int r, int c)
 Removes a square from the Static GridSquares Array by Setting it to null. More...
 
static void addSquaretoQuad (GridSquare newSquare, int r, int c)
 Adds a GridSquare to the Static GridSquares Array at a Particular Location. More...
 

Detailed Description

Used for Being Able to Easily keep Track of GridSquares Tied to Specific Quadrants.

Constructor & Destructor Documentation

GridGenerator.GridSquareQuadrant.GridSquareQuadrant ( int  quad_size,
int  t_rows,
int  t_cols,
int  q_row,
int  q_col 
)

Creates a new GridSquareQuadrant and initializes Static Values.

Parameters
quad_sizeThe Size of the Quadrant
t_rowsThe Total Rows of all GridSquares
t_colsThe Total Columns of all GridSquares
q_rowThis Quadrant's Row
q_colThis Quadrant's Column
GridGenerator.GridSquareQuadrant.GridSquareQuadrant ( int  q_row,
int  q_col 
)

Creates a new GridSquareQuadrant.

Parameters
q_rowThis Quadrant's Row
q_colThis Quadrant's Column

Member Function Documentation

static void GridGenerator.GridSquareQuadrant.addSquaretoQuad ( GridSquare  newSquare,
int  r,
int  c 
)
static

Adds a GridSquare to the Static GridSquares Array at a Particular Location.

Parameters
newSquareThe new GridSquare to add
rThe Row
cThe Column
void GridGenerator.GridSquareQuadrant.determineAdjacentQuadrants ( GridSquareQuadrant  quads[,])

Determines Adjacent GridQuadrants to this GridQuadrant.

Parameters
quadsTwo dimensional array of GridQuadrants
List<GridSquareQuadrant> GridGenerator.GridSquareQuadrant.getAdjacentQuadrants ( )

Retrieves this GridQuadrant's Adjacent GridQuadrants

Returns
List of adjacent GridQuadrants
int GridGenerator.GridSquareQuadrant.getColumn ( )

Retrieves the Column Value of this GridQuadrant.

Returns
Quad Column Value
int GridGenerator.GridSquareQuadrant.getRow ( )

Retrieves the Row Value of this GridQuadrant.

Returns
Quad Row Value
static void GridGenerator.GridSquareQuadrant.removeSpecificSquare ( int  r,
int  c 
)
static

Removes a square from the Static GridSquares Array by Setting it to null.

Parameters
rThe Row
cThe Column
void GridGenerator.GridSquareQuadrant.resetQuadrant ( )

Used for Reseting any Information Tied to this Specific Quadrant.

static void GridGenerator.GridSquareQuadrant.resetQuadrantSquares ( int  t_r,
int  t_c 
)
static

Resets all the GridSquares attached to the Static GridSquares Array.

Parameters
t_rThe Total Rows
t_cThe Total Columns
GridSquare [] GridGenerator.GridSquareQuadrant.retrieveQuadrantSquares ( )

Retrieves the GridSquares Attached to this GridQuadrant.

Returns
Array of GridSquares
static GridSquare GridGenerator.GridSquareQuadrant.retrieveSpecificSquare ( int  r,
int  c 
)
static

Retrieves a GridSquare from a Particular Row and Column.

Parameters
rThe Row
cThe Column
Returns

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