CellArea Class Reference

The base class for cell trigger areas. More...

Inheritance diagram for CellArea:

Static Public Member Functions
static CellArea	InstantiateCellArea (int row, int column, RoomComponent room, int cellLayer, LayerMask triggeringLayers)
	Instantiates a new cell area within the specified room. More...

Protected Member Functions
void	Initialize (int row, int column, RoomComponent room)
	Initializes the base properties for the area. More...

Properties
int	Column [getprotected set]
RoomComponent	Room [getprotected set]
	The containing room. More...
int	Row [getprotected set]
	The row index corresponding to the area. More...

Detailed Description

The base class for cell trigger areas.

Definition at line 8 of file CellArea.cs.

Member Function Documentation

Initialize()

void Initialize ( int  row, int  column, RoomComponent  room  )

protected

Initializes the base properties for the area.

Parameters

row	The row index of the area.
column	The column index of the area.
room	The containing room.

Definition at line 55 of file CellArea.cs.

InstantiateCellArea()

static CellArea InstantiateCellArea ( int  row, int  column, RoomComponent  room, int  cellLayer, LayerMask  triggeringLayers  )

static

Instantiates a new cell area within the specified room.

Parameters

row	The row index of the area.
column	The column index of the area.
room	The containing room.
cellLayer	The physics layer assigned to the new cell.
triggeringLayers	The physics layer mask that the cell will detect for trigger events.

Exceptions

System.NotImplementedException

Raised if the room's assigned type is not handled.

Definition at line 34 of file CellArea.cs.

Property Documentation

Column

int Column

getprotected set

The column index corresponding to the area.

Definition at line 18 of file CellArea.cs.

Room

RoomComponent Room

getprotected set

The containing room.

Definition at line 23 of file CellArea.cs.

Row

int Row

getprotected set

The row index corresponding to the area.

Definition at line 13 of file CellArea.cs.

---

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

• /github/workspace/Packages/ManiaMap.Unity/Scripts/Runtime/CellArea.cs