Packagebe.dauntless.astar.core
Classpublic class PathRequest
InheritancePathRequest Inheritance Object

The PathRequest class describes a request to be handled by the Astar class.



Public Properties
 PropertyDefined By
  priority : uint
Returns the priority of this request
PathRequest
Public Methods
 MethodDefined By
  
PathRequest(start:IAstarTile, end:IAstarTile, map:IMap, priority:uint = 10)
Creates a new PathRequest
PathRequest
  
addAnalyzer(analyzer:Analyzer):void
Add an analyzer to the analyzer chain
PathRequest
  
Returns the Analyzer chain for this PathRequest
PathRequest
  
Returns the end point of this request
PathRequest
  
Returns the map of this request
PathRequest
  
Returns the start point of this request
PathRequest
  
isTarget(tile:IAstarTile):Boolean
Returns true if the given tile is a target tile.
PathRequest
  
setEnd(end:IAstarTile):void
Sets the end point of this request
PathRequest
  
setMap(map:IMap):void
Sets the map of this request
PathRequest
  
setStart(start:IAstarTile):void
Sets the start point of this request
PathRequest
Property Detail
priorityproperty
priority:uint

Returns the priority of this request


Implementation
    public function get priority():uint
    public function set priority(value:uint):void
Constructor Detail
PathRequest()Constructor
public function PathRequest(start:IAstarTile, end:IAstarTile, map:IMap, priority:uint = 10)

Creates a new PathRequest

Parameters
start:IAstarTile — The start point
 
end:IAstarTile — The end point
 
map:IMap — The map to search in
 
priority:uint (default = 10) — The priority of this request
Method Detail
addAnalyzer()method
public function addAnalyzer(analyzer:Analyzer):void

Add an analyzer to the analyzer chain

Parameters

analyzer:Analyzer — The analyzer to add to the analyzer chain

getAnalyzers()method 
public function getAnalyzers():Analyzer

Returns the Analyzer chain for this PathRequest

Returns
Analyzer
getEnd()method 
public function getEnd():IAstarTile

Returns the end point of this request

Returns
IAstarTile — The end point
getMap()method 
public function getMap():IMap

Returns the map of this request

Returns
IMap — The map
getStart()method 
public function getStart():IAstarTile

Returns the start point of this request

Returns
IAstarTile — The start point
isTarget()method 
public function isTarget(tile:IAstarTile):Boolean

Returns true if the given tile is a target tile. Returns false otherwise. Awill stop searching if it find this tile as the best tile.

Parameters

tile:IAstarTile

Returns
Boolean
setEnd()method 
public function setEnd(end:IAstarTile):void

Sets the end point of this request

Parameters

end:IAstarTile — The end point

setMap()method 
public function setMap(map:IMap):void

Sets the map of this request

Parameters

map:IMap — The map

setStart()method 
public function setStart(start:IAstarTile):void

Sets the start point of this request

Parameters

start:IAstarTile — The start point