Difference between revisions of "NavRoute"
m (sorted, corrected lua syntax) |
(→GetCurrentRoute) |
||
| (9 intermediate revisions by 5 users not shown) | |||
| Line 44: | Line 44: | ||
=== clear === | === clear === | ||
'''Definition:'''<br> | '''Definition:'''<br> | ||
| − | clear() -> | + | clear() -> Clear the current route |
<br><br> | <br><br> | ||
'''Description:''' <br> | '''Description:''' <br> | ||
| + | Will clear any route if one exists | ||
<br><br> | <br><br> | ||
'''Arguments:''' <br> | '''Arguments:''' <br> | ||
| − | + | None | |
| + | |||
<br><br> | <br><br> | ||
'''Returns:''' <br> | '''Returns:''' <br> | ||
| − | + | Nil | |
| + | |||
<br><br> | <br><br> | ||
'''Example:''' | '''Example:''' | ||
<br><br> | <br><br> | ||
| − | |||
| − | |||
=== GetCurrentRoute === | === GetCurrentRoute === | ||
'''Definition:'''<br> | '''Definition:'''<br> | ||
| − | GetCurrentRoute() -> | + | GetCurrentRoute() -> table route |
<br><br> | <br><br> | ||
'''Description:''' <br> | '''Description:''' <br> | ||
| − | + | Returns current nav route. Note: The return value is a reference to the navroute not a copy. That means the returned table is updated as the route changes and the route can be edited by modifying the table elements. | |
| − | + | ||
| − | + | ||
| − | + | ||
<br><br> | <br><br> | ||
'''Returns:''' <br> | '''Returns:''' <br> | ||
| − | + | '''route''' reference to navroute table | |
<br><br> | <br><br> | ||
| − | |||
| − | |||
| − | |||
| − | |||
=== GetFinalDestination === | === GetFinalDestination === | ||
| Line 89: | Line 83: | ||
<br><br> | <br><br> | ||
'''Returns:''' <br> | '''Returns:''' <br> | ||
| − | + | ||
| + | sector-id of route end | ||
| + | |||
<br><br> | <br><br> | ||
'''Example:''' | '''Example:''' | ||
<br><br> | <br><br> | ||
| − | |||
| − | |||
=== GetNextHop === | === GetNextHop === | ||
| Line 188: | Line 182: | ||
=== SetFinalDestination === | === SetFinalDestination === | ||
'''Definition:'''<br> | '''Definition:'''<br> | ||
| − | SetFinalDestination() -> | + | SetFinalDestination(int destination) -> nil |
<br><br> | <br><br> | ||
'''Description:''' <br> | '''Description:''' <br> | ||
| − | + | Plot navroute to specified sector. | |
<br><br> | <br><br> | ||
'''Arguments:''' <br> | '''Arguments:''' <br> | ||
| − | + | ''destination'' - [[sectorid]] of destination sector. | |
| − | + | ||
| − | ''' | + | |
| − | + | ||
<br><br> | <br><br> | ||
'''Example:''' | '''Example:''' | ||
| − | <br>< | + | <br> |
| − | + | <source lang="lua"> | |
| − | + | NavRoute.SetFinalDestination(SectorIDFromLocationStr"Dau A1") | |
| + | </source> | ||
=== SetFullRoute === | === SetFullRoute === | ||
'''Definition:'''<br> | '''Definition:'''<br> | ||
| − | SetFullRoute() -> | + | SetFullRoute(table route) -> nil |
<br><br> | <br><br> | ||
'''Description:''' <br> | '''Description:''' <br> | ||
| − | + | Set the navigation route by specifying all it's points. | |
<br><br> | <br><br> | ||
'''Arguments:''' <br> | '''Arguments:''' <br> | ||
| − | + | ''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"> | ||
| + | local sectorid = SectorIDFromLocationStr("Bractus C-5") | ||
| + | NavRoute.SetFullRoute({sectorid, sectorid+1, 1234}) | ||
| + | </source> | ||
<br><br> | <br><br> | ||
| − | |||
| − | |||
=== undo === | === undo === | ||
| Line 237: | Line 229: | ||
'''Example:''' | '''Example:''' | ||
<br><br> | <br><br> | ||
| + | |||
| + | [[Category:Tables]] | ||
Latest revision as of 05:11, 13 July 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() -> Clear the current route
Description:
Will clear any route if one exists
Arguments:
None
Returns:
Nil
Example:
GetCurrentRoute
Definition:
GetCurrentRoute() -> table route
Description:
Returns current nav route. Note: The return value is a reference to the navroute not a copy. That means the returned table is updated as the route changes and the route can be edited by modifying the table elements.
Returns:
route reference to navroute table
GetFinalDestination
Definition:
GetFinalDestination() -> ?
Description:
Arguments:
?
Returns:
sector-id of route end
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(int destination) -> nil
Description:
Plot navroute to specified sector.
Arguments:
destination - sectorid of destination sector.
Example:
NavRoute.SetFinalDestination(SectorIDFromLocationStr"Dau A1")
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:
