MOAIGrid Class Reference

Inheritance diagram for MOAIGrid:

Function List
	clearTileFlags
	fill
	getTile
	getTileFlags
	setRow
	setTile
	setTileFlags
	streamTilesIn
	streamTilesOut
	toggleTileFlags

Additional Inherited Members
Function List inherited from MOAIGridSpace
	cellAddrToCoord
	getCellAddr
	getCellSize
	getOffset
	getSize
	getTileLoc
	getTileSize
	initAxialHexGrid
	initDiamondGrid
	initHexGrid
	initObliqueGrid
	initRectGrid
	locToCellAddr
	locToCoord
	setRepeat
	setShape
	setSize
	wrapCoord

Function Documentation

clearTileFlags

Clears bits specified in mask.

---

function clearTileFlags ( MOAIGrid self, number xTile, number yTile, number mask )

Parameters

MOAIGrid	self
number	xTile
number	yTile
number	mask

Returns

nil

fill

Set all tiles to a single value.

---

function fill ( MOAIGrid self, number value )

Parameters

MOAIGrid	self
number	value

Returns

nil

getTile

Returns the value of a given tile.

---

function getTile ( MOAIGrid self, number xTile, number yTile )

Parameters

MOAIGrid	self
number	xTile
number	yTile

Returns

number tile

getTileFlags

Returns the masked value of a given tile.

---

function getTileFlags ( MOAIGrid self, number xTile, number yTile, number mask )

Parameters

MOAIGrid	self
number	xTile
number	yTile
number	mask

Returns

number tile

setRow

Initializes a grid row given a variable argument list of values.

---

function setRow ( MOAIGrid self, number row, ... )

Parameters

MOAIGrid	self
number	row
...	values

Returns

nil

setTile

Sets the value of a given tile.

---

function setTile ( MOAIGrid self, number xTile, number yTile, number value )

Parameters

MOAIGrid	self
number	xTile
number	yTile
number	value

Returns

nil

setTileFlags

Sets a tile's flags given a mask.

---

function setTileFlags ( MOAIGrid self, number xTile, number yTile, number mask )

Parameters

MOAIGrid	self
number	xTile
number	yTile
number	mask

Returns

nil

streamTilesIn

Reads tiles directly from a stream. Call this only after initializing the grid. Only the content of the tiles buffer is read.

---

function streamTilesIn ( MOAIGrid self, MOAIStream stream )

Parameters

MOAIGrid	self
MOAIStream	stream

Returns

number bytesRead

streamTilesOut

Writes tiles directly to a stream. Only the content of the tiles buffer is written.

---

function streamTilesOut ( MOAIGrid self, MOAIStream stream )

Parameters

MOAIGrid	self
MOAIStream	stream

Returns

number bytesWritten

toggleTileFlags

Toggles a tile's flags given a mask.

---

function toggleTileFlags ( MOAIGrid self, number xTile, number yTile, number mask )

Parameters

MOAIGrid	self
number	xTile
number	yTile
number	mask

Returns

nil