Difference between revisions of "ISKernel:navpath (Data Type)"
Jump to navigation
Jump to search
| Line 2: | Line 2: | ||
== Members == | == Members == | ||
| − | *[[DataType:point3f|point3f]] '''Point['''#''']''': Retrieves a point on the path | + | *[[DataType:point3f|point3f]] '''Point['''#''']''': Retrieves a point on the path. (Valid # is 1-Points) |
| − | *[[DataType:string|string]] '''PointName['''#''']''': Retrieves the original name of a point on the path | + | *[[DataType:string|string]] '''PointName['''#''']''': Retrieves the original name of a point on the path. (Valid # is 1-Points) |
*[[DataType:int|int]] '''Points''': The total number of points on this path | *[[DataType:int|int]] '''Points''': The total number of points on this path | ||
*[[DataType:int|int]] '''NearestPoint['''x''']''': Retrieves the number of the nearest point on the path to location (x,0,0) | *[[DataType:int|int]] '''NearestPoint['''x''']''': Retrieves the number of the nearest point on the path to location (x,0,0) | ||
| Line 18: | Line 18: | ||
== Examples == | == Examples == | ||
| − | + | ===Declare a NavPath variable=== | |
| + | *declare PathHome navpath | ||
| + | ===Find shortest path from point a to point b=== | ||
| + | *NavPath:GetPath[earth,detroit,cincinatti] | ||
| + | ===Find the nearest point to a given location=== | ||
| + | *echo Nearest Point: ${NavPath.NearestPoint[123,432,-222] | ||
| + | ===Find total number of points in a path=== | ||
| + | *echo Total Points: ${PathHome.Points} | ||
| + | ===List the name of all points=== | ||
| + | declare x int 1 | ||
| + | do | ||
| + | { | ||
| + | echo Point ${x}: ${PathHome.PointName[x]} | ||
| + | } | ||
| + | while (${x:Inc}<=${PathHome.Points}) | ||
| + | ===Reverse a path=== | ||
| + | *PathHome:Reverse | ||
== See Also == | == See Also == | ||
* [[LavishScript:Data Types|LavishScript Data Types]] | * [[LavishScript:Data Types|LavishScript Data Types]] | ||
Revision as of 20:35, 29 August 2005
Contents
Description
Members
- point3f Point[#]: Retrieves a point on the path. (Valid # is 1-Points)
- string PointName[#]: Retrieves the original name of a point on the path. (Valid # is 1-Points)
- int Points: The total number of points on this path
- int NearestPoint[x]: Retrieves the number of the nearest point on the path to location (x,0,0)
- int NearestPoint[x,y]: Retrieves the number of the nearest point on the path to location (x,y,0)
- int NearestPoint[x,y,z]: Retrieves the number of the nearest point on the path to location (x,y,z)
Methods
- Clear: Resets the path so it contains no points
- GetPath[world,point a,point b]: Gets the shortest path from point A to point B (clearing is not required, it is done automatically)
- GetPath[world,point a,point b,additional points ...]: Gets the shortest path from point A to point B to point C to point D ad infinitum (clearing is not required, it is done automatically)
- Reverse: Reverses the path
Returns
Examples
- declare PathHome navpath
Find shortest path from point a to point b
- NavPath:GetPath[earth,detroit,cincinatti]
Find the nearest point to a given location
- echo Nearest Point: ${NavPath.NearestPoint[123,432,-222]
Find total number of points in a path
- echo Total Points: ${PathHome.Points}
List the name of all points
declare x int 1
do
{
echo Point ${x}: ${PathHome.PointName[x]}
}
while (${x:Inc}<=${PathHome.Points})
Reverse a path
- PathHome:Reverse
