MOAIGridDeck2D Class Reference

Inheritance diagram for MOAIGridDeck2D:

List of all members.

Function List
	reserveBrushes
	setBrush
	setDeck
	setGrid
	setRemapper

---

Function Documentation

reserveBrushes

Set capacity of grid deck.

---

function reserveBrushes ( MOAIGridDeck2D self, number nBrushes )

Parameters:

self	( MOAIGridDeck2D )
nBrushes	( number )

Returns:

nil

setBrush

Initializes a brush.

---

function setBrush ( MOAIGridDeck2D self, number idx, number xTile, number yTile, number width, number height [, number xOff, number yOff ] )

Parameters:

self	( MOAIGridDeck2D )
idx	( number ) Index of the brush.
xTile	( number )
yTile	( number )
width	( number )
height	( number )
xOff	( number ) Optional. Default value is 0.
yOff	( number ) Optional. Default value is 0.

Returns:

nil

setDeck

Sets or clears the deck to be indexed by the grid.

---

function setDeck ( MOAIGridDeck2D self [, MOAIDeck deck ] )

Parameters:

self	( MOAIGridDeck2D )
deck	( MOAIDeck ) Optional. Default value is nil.

Returns:

nil

setGrid

Sets or clears the grid to be sampled by the brushes.

---

function setGrid ( MOAIGridDeck2D self [, MOAIGrid grid ] )

Parameters:

self	( MOAIGridDeck2D )
grid	( MOAIGrid ) Optional. Default value is nil.

Returns:

nil

setRemapper

Sets or clears the remapper (for remapping index values held in the grid).

---

function setRemapper ( MOAIGridDeck2D self [, MOAIDeckRemapper remapper ] )

Parameters:

self	( MOAIGridDeck2D )
remapper	( MOAIDeckRemapper ) Optional. Default value is nil.

Returns:

nil