Difference between revisions of "LavishNav:lnavpathfinder (Object Type)"

From Lavish Software Wiki
Jump to navigation Jump to search
Line 1: Line 1:
 
== Description ==
 
== Description ==
 +
{{ObjectType-Vitals|lnavpathfinder|[[LavishNav]]|none|NULL|none (see [[LavishNav:dijkstrapathfinder (Object Type)|dijkstrapathfinder]] and [[LavishNav:astarpathfinder (Object Type)|astarpathfinder]])|no|LNavPathfinder *}}
  
 
== Members ==
 
== Members ==
*[[ObjectType:string|string]] '''Type''':
+
*[[ObjectType:string|string]] '''Type''': Type of pathfinder (Dijkstra or AStar)
 
*[[ObjectType:float|float]] '''Distance['''region id''']''':
 
*[[ObjectType:float|float]] '''Distance['''region id''']''':
*... LastStart:
+
*... '''LastStart''': Last <tt>from</tt> region used
*... LastGoal:
+
*... '''LastGoal''': Last <tt>to</tt> region used
  
 
== Methods ==
 
== Methods ==
*'''SelectPath['''from region id''','''to region id''']''':
+
*'''SelectPath['''from region search''','''to region search''','''[[LavishNav:lnavpath (Object Type)|lnavpath]] object''']''': Selects a path, if any, from one region to another, appending the given lnavpath object with the result
*'''Reset''':
+
*'''Reset''': Resets the current pathfinding data.  Note that the pathfinder is automatically reset when necessary, you do not generally need to use this method.
 
 
== Inherits ==
 
''none''
 
 
 
== Returns ==
 
''NULL''
 
 
 
== Creating Variables ==
 
See dijkstrapathfinder and astarpathfinder object types
 
  
 
== Examples ==
 
== Examples ==

Revision as of 20:41, 24 March 2006

Description

Object Type Vitals
lnavpathfinder
Defined By LavishNav
Inherits none
Reduces To NULL
Variable Object Type none (see dijkstrapathfinder and astarpathfinder)
Uses Sub-Types no
C/C++ Type LNavPathfinder *

Members

  • string Type: Type of pathfinder (Dijkstra or AStar)
  • float Distance[region id]:
  • ... LastStart: Last from region used
  • ... LastGoal: Last to region used

Methods

  • SelectPath[from region search,to region search,lnavpath object]: Selects a path, if any, from one region to another, appending the given lnavpath object with the result
  • Reset: Resets the current pathfinding data. Note that the pathfinder is automatically reset when necessary, you do not generally need to use this method.

Examples

See Also