NavRoute: Difference between revisions
| (2 intermediate revisions by 2 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 === | ||
Latest revision as of 05:11, 13 July 2009
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:
<source lang="lua">
local sectorid = SectorIDFromLocationStr("Bractus C-5")
NavRoute.addbyid(sectorid)
</source>
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:
<source lang="lua">
NavRoute.SetFinalDestination(SectorIDFromLocationStr"Dau A1")
</source>
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:
<source lang="lua">
local sectorid = SectorIDFromLocationStr("Bractus C-5")
NavRoute.SetFullRoute({sectorid, sectorid+1, 1234})
</source>
undo
Definition:
undo() -> ?
Description:
Arguments:
?
Returns:
?
Example:
