Difference between revisions of "NavRoute"
m (→SetFullRoute) |
(→SetFullRoute) |
||
| Line 206: | Line 206: | ||
=== SetFullRoute === | === SetFullRoute === | ||
'''Definition:'''<br> | '''Definition:'''<br> | ||
| − | SetFullRoute( | + | SetFullRoute(table route) -> nil |
<br><br> | <br><br> | ||
'''Description:''' <br> | '''Description:''' <br> | ||
| − | Set the navigation route. | + | Set the navigation route by specifying all it's points. |
<br><br> | <br><br> | ||
'''Arguments:''' <br> | '''Arguments:''' <br> | ||
| − | ''[[sectorid]]' | + | ''route'' - list containing [[sectorid]]'s describing the navroute.<br> |
| − | + | Calling it with arguments of wrong type (not table) causes Lua errors that cripple the HUD. | |
| − | + | ||
| − | + | ||
<br><br> | <br><br> | ||
'''Example:''' | '''Example:''' | ||
<source lang="lua"> | <source lang="lua"> | ||
local sectorid = SectorIDFromLocationStr("Bractus C-5") | local sectorid = SectorIDFromLocationStr("Bractus C-5") | ||
| − | NavRoute.SetFullRoute(sectorid) | + | NavRoute.SetFullRoute({sectorid, sectorid+1, 1234}) |
</source> | </source> | ||
<br><br> | <br><br> | ||
Revision as of 23:30, 22 April 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(table route) -> nil
Description:
Set the navigation route by specifying all it's points.
Arguments:
route - list containing sectorid's describing the navroute.
Calling it with arguments of wrong type (not table) causes Lua errors that cripple the HUD.
Example:
local sectorid = SectorIDFromLocationStr("Bractus C-5") NavRoute.SetFullRoute({sectorid, sectorid+1, 1234})
undo
Definition:
undo() -> ?
Description:
Arguments:
?
Returns:
?
Example:
