Lua PathFinder - Revision history

Flozi: /* PathNodeCosts */ 104.0 - implement Path.GetPathNodeCosts

2017-12-22T11:46:25Z

PathNodeCosts: 104.0 - implement Path.GetPathNodeCosts

← Older revision		Revision as of 12:46, 22 December 2017
Line 49:		Line 49:
	'''Path.SetPathNodeCosts'''		'''Path.SetPathNodeCosts'''
	(number arrayID) -> boolean success		(number arrayID) -> boolean success
			'''Path.GetPathNodeCosts''' {{new\|104.0}}
			(number arrayID) -> nil \| table overlayCosts

	'''Path.SetPathNodeCost'''		'''Path.SetPathNodeCost'''

Jk: /* PathNodeCosts */

2012-05-10T15:12:05Z

PathNodeCosts

← Older revision		Revision as of 16:12, 10 May 2012
Line 38:		Line 38:
	The following functions allow manipulating the cost of nodes visited by the pathfinding algorithm through numbered additive overlays (arrays). Only one overlay can be active at once, but as many as desired may be created with '''InitPathNodeCostsArray'''. The active layer is set by '''SetPathNodeCosts'''.<br/>		The following functions allow manipulating the cost of nodes visited by the pathfinding algorithm through numbered additive overlays (arrays). Only one overlay can be active at once, but as many as desired may be created with '''InitPathNodeCostsArray'''. The active layer is set by '''SetPathNodeCosts'''.<br/>

	<span class="~~info~~">NOTE: There are separate arrays for synced & unsynced! - don't ask when the unsynced one is used ... -</span>		<span class="note">NOTE: There are separate arrays for synced & unsynced! - don't ask when the unsynced one is used ... -</span>

	<span class="warning">IMPORTANT: the size of a newly created layer can be arbitrary, but ideally should match the heightmap dimensions. '''GetPathNodeCost''' ALWAYS takes heightmap coordinates as arguments, which are internally converted to the resolution of the active node-overlay (if any).</span>		<span class="warning">IMPORTANT: the size of a newly created layer can be arbitrary, but ideally should match the heightmap dimensions. '''GetPathNodeCost''' ALWAYS takes heightmap coordinates as arguments, which are internally converted to the resolution of the active node-overlay (if any).</span>

Jk: /* PathNodeCosts */

2012-05-10T15:11:52Z

PathNodeCosts

← Older revision		Revision as of 16:11, 10 May 2012
Line 37:		Line 37:

	The following functions allow manipulating the cost of nodes visited by the pathfinding algorithm through numbered additive overlays (arrays). Only one overlay can be active at once, but as many as desired may be created with '''InitPathNodeCostsArray'''. The active layer is set by '''SetPathNodeCosts'''.<br/>		The following functions allow manipulating the cost of nodes visited by the pathfinding algorithm through numbered additive overlays (arrays). Only one overlay can be active at once, but as many as desired may be created with '''InitPathNodeCostsArray'''. The active layer is set by '''SetPathNodeCosts'''.<br/>

			<span class="info">NOTE: There are separate arrays for synced & unsynced! - don't ask when the unsynced one is used ... -</span>

	<span class="warning">IMPORTANT: the size of a newly created layer can be arbitrary, but ideally should match the heightmap dimensions. '''GetPathNodeCost''' ALWAYS takes heightmap coordinates as arguments, which are internally converted to the resolution of the active node-overlay (if any).</span>		<span class="warning">IMPORTANT: the size of a newly created layer can be arbitrary, but ideally should match the heightmap dimensions. '''GetPathNodeCost''' ALWAYS takes heightmap coordinates as arguments, which are internally converted to the resolution of the active node-overlay (if any).</span>

Jk: /* PathNodeCosts */

2012-05-10T14:53:29Z

PathNodeCosts

← Older revision		Revision as of 15:53, 10 May 2012
Line 27:		Line 27:

	Note that ''Path'' in ''Path:GetPathWayPoints'' and ''Path:Next'' is not part of the command, but rather a reference to the path Object created by ''Spring.RequestPath''. It must match the path Object (case sensitive).		Note that ''Path'' in ''Path:GetPathWayPoints'' and ''Path:Next'' is not part of the command, but rather a reference to the path Object created by ''Spring.RequestPath''. It must match the path Object (case sensitive).


			==Further Reading==

			{{forumlink\|topic=22953&start=2\|title=a forum thread}}


	=PathNodeCosts=		=PathNodeCosts=

	The following functions allow manipulating the cost of nodes visited by the pathfinding algorithm through numbered additive overlays (arrays). Only one overlay can be active at once, but as many as desired may be created with '''InitPathNodeCostsArray'''. The active layer is set by '''SetPathNodeCosts'''.<br/>		The following functions allow manipulating the cost of nodes visited by the pathfinding algorithm through numbered additive overlays (arrays). Only one overlay can be active at once, but as many as desired may be created with '''InitPathNodeCostsArray'''. The active layer is set by '''SetPathNodeCosts'''.<br/>
	<span class="warning">IMPORTANT: the size of a newly created layer can be arbitrary, but ideally should match the heightmap dimensions. '''GetPathNodeCost''' ALWAYS takes heightmap coordinates as arguments, which are internally converted to the resolution of the active node-overlay (if any).</span>		<span class="warning">IMPORTANT: the size of a newly created layer can be arbitrary, but ideally should match the heightmap dimensions. '''GetPathNodeCost''' ALWAYS takes heightmap coordinates as arguments, which are internally converted to the resolution of the active node-overlay (if any).</span>
Line 44:		Line 51:
	'''Path.GetPathNodeCost'''		'''Path.GetPathNodeCost'''
	(number arrayID, number heightMapX, number heightMapZ) -> number nodeCost		(number arrayID, number heightMapX, number heightMapZ) -> number nodeCost

	~~==Further Reading==~~

	~~{{forumlink\|topic=22953&start=2\|title=a forum thread}}~~

	[[category: Lua]]		[[category: Lua]]

Jk at 14:52, 10 May 2012

2012-05-10T14:52:51Z

← Older revision		Revision as of 15:52, 10 May 2012
Line 29:		Line 29:

	=PathNodeCosts=		=PathNodeCosts=
	The following functions allow manipulating the cost of nodes visited by the pathfinding algorithm through numbered additive overlays (arrays). Only one overlay can be active at once, but as many as desired may be created with '''InitPathNodeCostsArray'''. The active layer is set by '''SetPathNodeCosts'''.		The following functions allow manipulating the cost of nodes visited by the pathfinding algorithm through numbered additive overlays (arrays). Only one overlay can be active at once, but as many as desired may be created with '''InitPathNodeCostsArray'''. The active layer is set by '''SetPathNodeCosts'''.<br/>
	<span class="warning">IMPORTANT: the size of a newly created layer can be arbitrary, but ideally should match the heightmap dimensions. '''GetPathNodeCost''' ALWAYS takes heightmap coordinates as arguments, which are internally converted to the resolution of the active node-overlay (if any).</span>		<span class="warning">IMPORTANT: the size of a newly created layer can be arbitrary, but ideally should match the heightmap dimensions. '''GetPathNodeCost''' ALWAYS takes heightmap coordinates as arguments, which are internally converted to the resolution of the active node-overlay (if any).</span>

Jk at 14:52, 10 May 2012

2012-05-10T14:52:36Z

← Older revision		Revision as of 15:52, 10 May 2012
Line 29:		Line 29:

	=PathNodeCosts=		=PathNodeCosts=
	The following functions allow manipulating the cost of nodes visited by the pathfinding algorithm through numbered additive overlays (arrays). Only one overlay can be active at once, but as many as desired may be created with '''InitPathNodeCostsArray'''. The active layer is set by '''SetPathNodeCosts'''. <~~font color~~="~~red" style="font-weight:600~~">IMPORTANT: the size of a newly created layer can be arbitrary, but ideally should match the heightmap dimensions. '''GetPathNodeCost''' ALWAYS takes heightmap coordinates as arguments, which are internally converted to the resolution of the active node-overlay (if any).</~~font~~>		The following functions allow manipulating the cost of nodes visited by the pathfinding algorithm through numbered additive overlays (arrays). Only one overlay can be active at once, but as many as desired may be created with '''InitPathNodeCostsArray'''. The active layer is set by '''SetPathNodeCosts'''.
			<span class="warning">IMPORTANT: the size of a newly created layer can be arbitrary, but ideally should match the heightmap dimensions. '''GetPathNodeCost''' ALWAYS takes heightmap coordinates as arguments, which are internally converted to the resolution of the active node-overlay (if any).</span>

	'''Path.InitPathNodeCostsArray'''		'''Path.InitPathNodeCostsArray'''

Jk at 14:52, 10 May 2012

2012-05-10T14:52:05Z

← Older revision		Revision as of 15:52, 10 May 2012
Line 28:		Line 28:
	Note that ''Path'' in ''Path:GetPathWayPoints'' and ''Path:Next'' is not part of the command, but rather a reference to the path Object created by ''Spring.RequestPath''. It must match the path Object (case sensitive).		Note that ''Path'' in ''Path:GetPathWayPoints'' and ''Path:Next'' is not part of the command, but rather a reference to the path Object created by ''Spring.RequestPath''. It must match the path Object (case sensitive).

			=PathNodeCosts=
	The following functions allow manipulating the cost of nodes visited by the pathfinding algorithm through numbered additive overlays (arrays). Only one overlay can be active at once, but as many as desired may be created with '''InitPathNodeCostsArray'''. The active layer is set by '''SetPathNodeCosts'''. <font color="red" style="font-weight:600">IMPORTANT: the size of a newly created layer can be arbitrary, but ideally should match the heightmap dimensions. '''GetPathNodeCost''' ALWAYS takes heightmap coordinates as arguments, which are internally converted to the resolution of the active node-overlay (if any).</font>		The following functions allow manipulating the cost of nodes visited by the pathfinding algorithm through numbered additive overlays (arrays). Only one overlay can be active at once, but as many as desired may be created with '''InitPathNodeCostsArray'''. The active layer is set by '''SetPathNodeCosts'''. <font color="red" style="font-weight:600">IMPORTANT: the size of a newly created layer can be arbitrary, but ideally should match the heightmap dimensions. '''GetPathNodeCost''' ALWAYS takes heightmap coordinates as arguments, which are internally converted to the resolution of the active node-overlay (if any).</font>

Kloot: /* Path UserData Object */

2012-02-07T00:41:15Z

Path UserData Object

← Older revision		Revision as of 01:41, 7 February 2012
Line 10:		Line 10:

	== Path UserData Object ==		== Path UserData Object ==
	'''Path:~~GetEstimatedPath~~'''		'''Path:GetPathWayPoints'''
	( ) -> nil \| {		( ) -> nil \| {
	[1] = { x,y,z }, ...		[1] = { x,y,z }, ...
Line 18:		Line 18:
	[3] = startIdxOfDetailedEstimatedPath2,		[3] = startIdxOfDetailedEstimatedPath2,
	}		}
	<font color="#55ee99">~~GetEstimatedPath~~() returns 2 tables: 1 table with the waypoints and 1 table with 3 indices (in the waypoint table) when a new (more lazy) pathfinding algorithm begins. So the waypoint table contains 3 different levels of details.</font>		<font color="#55ee99">GetPathWayPoints() returns 2 tables: 1 table with the waypoints and 1 table with 3 indices (in the waypoint table) when a new (more lazy) pathfinding algorithm begins. So the waypoint table contains 3 different levels of details.</font>

	'''Path:Next'''		'''Path:Next'''
Line 24:		Line 24:
	[, number radius = 0 ]		[, number radius = 0 ]
	) -> nil \| number x, number y, number z		) -> nil \| number x, number y, number z
	<font color="#55ee99">Path:Next() returns the next waypoint in the path. Unlike ~~GetEstimatedPath~~() in which the resolution of the waypoints decreases, Next updates the path so the resolution will increase as it approaches the target.</font>		<font color="#55ee99">Path:Next() returns the next waypoint in the path. Unlike GetPathWayPoints() in which the resolution of the waypoints decreases, Next updates the path so the resolution will increase as it approaches the target.</font>

	Note that ''Path'' in ''Path:~~GetEstimatedPath~~'' and ''Path:Next'' is not part of the command, but rather a reference to the path Object created by ''Spring.RequestPath''. It must match the path Object (case sensitive).		Note that ''Path'' in ''Path:GetPathWayPoints'' and ''Path:Next'' is not part of the command, but rather a reference to the path Object created by ''Spring.RequestPath''. It must match the path Object (case sensitive).

Knorke: added a forum link

2011-07-08T16:40:11Z

added a forum link

← Older revision		Revision as of 17:40, 8 July 2011
Line 43:		Line 43:
	'''Path.GetPathNodeCost'''		'''Path.GetPathNodeCost'''
	(number arrayID, number heightMapX, number heightMapZ) -> number nodeCost		(number arrayID, number heightMapX, number heightMapZ) -> number nodeCost

			==Further Reading==

			{{forumlink\|topic=22953&start=2\|title=a forum thread}}

	[[category: Lua]]		[[category: Lua]]

Kloot: document the new LuaPathFinder callouts

2011-06-07T20:52:50Z

document the new LuaPathFinder callouts

@@ Line 2: / Line 2: @@
 == PathFinder ==
-'''Spring.RequestPath'''
+'''Path.RequestPath'''
    ( string "MoveTypeName" | number moveID,
      number start_x, number start_y, number start_z,
@@ Line 27: / Line 27: @@
 Note that ''Path'' in ''Path:GetEstimatedPath'' and ''Path:Next'' is not part of the command, but rather a reference to the path Object created by ''Spring.RequestPath''.  It must match the path Object (case sensitive).
 [[category: Lua]]