Difference between revisions of "NavRoute"
m (→SetFullRoute) |
m (→SetFullRoute) |
||
| Line 209: | Line 209: | ||
<br><br> | <br><br> | ||
'''Description:''' <br> | '''Description:''' <br> | ||
| − | + | Set the navigation route. | |
<br><br> | <br><br> | ||
'''Arguments:''' <br> | '''Arguments:''' <br> | ||
Revision as of 12:36, 17 February 2009
Contents
Functions
add
Definition:
add() -> ?
Description:
Arguments:
?
Returns:
?
Example:
addbyid
Definition:
addbyid(int sectorid) -> true
Description:
Add a waypoint to the navigation route.
sectorid equal or lower than 0 generates an error.
Arguments:
sectorid - sector to plot a route to
Returns:
Seems to always return true.
Example:
local sectorid = SectorIDFromLocationStr("Bractus C-5") NavRoute.addbyid(sectorid)
clear
Definition:
clear() -> ?
Description:
Arguments:
?
Returns:
?
Example:
GetCurrentRoute
Definition:
GetCurrentRoute() -> ?
Description:
Arguments:
?
Returns:
?
Example:
GetFinalDestination
Definition:
GetFinalDestination() -> ?
Description:
Arguments:
?
Returns:
?
Example:
GetNextHop
Definition:
GetNextHop() -> ?
Description:
Arguments:
?
Returns:
?
Example:
list
Definition:
list() -> ?
Description:
Arguments:
?
Returns:
?
Example:
load
Definition:
load() -> ?
Description:
Arguments:
?
Returns:
?
Example:
OnEvent
Definition:
OnEvent() -> ?
Description:
Arguments:
?
Returns:
?
Example:
save
Definition:
save() -> ?
Description:
Arguments:
?
Returns:
?
Example:
SetFinalDestination
Definition:
SetFinalDestination() -> ?
Description:
Arguments:
?
Returns:
?
Example:
SetFullRoute
Definition:
SetFullRoute(int sectorid) -> ?
Description:
Set the navigation route.
Arguments:
sectorid - sector to plot a route to
Returns:
?
Example:
local sectorid = SectorIDFromLocationStr("Bractus C-5") NavRoute.SetFullRoute(sectorid)
undo
Definition:
undo() -> ?
Description:
Arguments:
?
Returns:
?
Example:
