MOAIPathFinder Class Reference

Inherits MOAILuaObject.

Function List
	findPath
	getGraph
	getPathEntry
	getPathSize
	init
	reserveTerrainWeights
	setFlags
	setGraph
	setHeuristic
	setTerrainMask
	setTerrainDeck
	setTerrainWeight
	setWeight

Function Documentation

findPath

Attempts to find an efficient path from the start node to the finish node. May be called incrementally.

---

function findPath ( MOAIPathFinder self [, number iterations ] )

Parameters

MOAIPathFinder	self
number	iterations Optional.

Returns

boolean more

getGraph

Returns the attached graph (if any).

---

function getGraph ( MOAIPathFinder self )

Parameters

MOAIPathFinder

self

Returns

MOAIPathGraph graph

getPathEntry

Returns a path entry. This is a node ID that may be passed back to the graph to get a location.

---

function getPathEntry ( MOAIPathFinder self, number index )

Parameters

MOAIPathFinder	self
number	index

Returns

number entry

getPathSize

Returns the size of the path (in nodes).

---

function getPathSize ( MOAIPathFinder self )

Parameters

MOAIPathFinder

self

Returns

number size

init

Specify the ID of the start and target node.

---

function init ( MOAIPathFinder self, number startNodeID, number targetNodeID )

Parameters

MOAIPathFinder	self
number	startNodeID
number	targetNodeID

Returns

nil

reserveTerrainWeights

Specify the size of the terrain weight vector.

---

function reserveTerrainWeights ( MOAIPathFinder self [, number size ] )

Parameters

MOAIPathFinder	self
number	size Optional. Default value is 0.

Returns

nil

setFlags

Set flags to use for pathfinding. These are graph specific flags provided by the graph implementation.

---

function setFlags ( MOAIPathFinder self [, number heuristic ] )

Parameters

MOAIPathFinder	self
number	heuristic Optional.

Returns

nil

setGraph

Set graph data to use for pathfinding.

---

function setGraph ( MOAIPathFinder self [, MOAIGrid grid ] )

Parameters

MOAIPathFinder	self
MOAIGrid	grid Optional. Default value is nil.

Returns

nil

Note

---

function setGraph ( MOAIPathFinder self [, MOAIGridPathGraph gridPathGraph ] )

Parameters

MOAIPathFinder	self
MOAIGridPathGraph	gridPathGraph Optional. Default value is nil.

Returns

nil

Note

setHeuristic

Set heuristic to use for pathfinding. This is a const provided by the graph implementation being used.

---

function setHeuristic ( MOAIPathFinder self [, number heuristic ] )

Parameters

MOAIPathFinder	self
number	heuristic Optional.

Returns

nil

setTerrainDeck

Set terrain deck to use with graph.

---

function setTerrainDeck ( MOAIPathFinder self [, MOAIPathTerrainDeck terrainDeck ] )

Parameters

MOAIPathFinder	self
MOAIPathTerrainDeck	terrainDeck Optional. Default value is nil.

Returns

nil

setTerrainMask

Set 32-bit mask to apply to terrain samples.

---

function setTerrainMask ( MOAIPathFinder self [, number mask ] )

Parameters

MOAIPathFinder	self
number	mask Optional. Default value is 0xffffffff.

Returns

nil

setTerrainWeight

Set a component of the terrain weight vector.

---

function setTerrainWeight ( MOAIPathFinder self, number index [, number deltaScale, number penaltyScale ] )

Parameters

MOAIPathFinder	self
number	index
number	deltaScale Optional. Default value is 0.
number	penaltyScale Optional. Default value is 0.

Returns

nil

setWeight

Sets weights to be applied to G and H.

---

function setWeight ( MOAIPathFinder self [, number gWeight, number hWeight ] )

Parameters

MOAIPathFinder	self
number	gWeight Optional. Default value is 1.0.
number	hWeight Optional. Default value is 1.0.

Returns

nil