Difference between revisions of "NavRoute"
From Vendetta Lua
m (→SetFullRoute) |
m (sorted, corrected lua syntax) |
||
| Line 1: | Line 1: | ||
| − | === | + | == Functions == |
| − | '''Definition:''' | + | === add === |
| + | '''Definition:'''<br> | ||
| + | add() -> ? | ||
<br><br> | <br><br> | ||
| − | '''Description:''' | + | '''Description:''' <br> |
| + | |||
<br><br> | <br><br> | ||
| − | '''Arguments:''' | + | '''Arguments:''' <br> |
| + | ? | ||
<br><br> | <br><br> | ||
| − | '''Returns:''' | + | '''Returns:''' <br> |
| + | ? | ||
<br><br> | <br><br> | ||
'''Example:''' | '''Example:''' | ||
<br><br> | <br><br> | ||
| + | |||
| + | |||
=== addbyid === | === addbyid === | ||
'''Definition:'''<br> | '''Definition:'''<br> | ||
| − | addbyid(int | + | addbyid(int [[sectorid]]) -> true |
<br><br> | <br><br> | ||
| − | '''Description:'''<br> | + | '''Description:''' <br> |
| − | Add a | + | Add a waypoint to the navigation route. |
| + | <br> | ||
| + | sectorid equal or lower than 0 generates an error. | ||
<br><br> | <br><br> | ||
| − | '''Arguments:'''<br> | + | '''Arguments:''' <br> |
| − | '' | + | ''[[sectorid]]'' - sector to plot a route to |
<br><br> | <br><br> | ||
| − | '''Returns:''' | + | '''Returns:''' <br> |
| + | Seems to always return true. | ||
<br><br> | <br><br> | ||
| − | '''Example:'''< | + | '''Example:''' |
| − | local | + | <source lang="lua"> |
| − | NavRoute.addbyid | + | local sectorid = SectorIDFromLocationStr("Bractus C-5") |
| + | NavRoute.addbyid(sectorid) | ||
| + | </source> | ||
<br><br> | <br><br> | ||
| − | === | + | |
| − | '''Definition:''' | + | |
| + | === clear === | ||
| + | '''Definition:'''<br> | ||
| + | clear() -> ? | ||
<br><br> | <br><br> | ||
| − | '''Description:''' | + | '''Description:''' <br> |
| + | |||
<br><br> | <br><br> | ||
| − | '''Arguments:''' | + | '''Arguments:''' <br> |
| + | ? | ||
<br><br> | <br><br> | ||
| − | '''Returns:''' | + | '''Returns:''' <br> |
| + | ? | ||
<br><br> | <br><br> | ||
'''Example:''' | '''Example:''' | ||
<br><br> | <br><br> | ||
| − | === | + | |
| − | '''Definition:''' | + | |
| + | === GetCurrentRoute === | ||
| + | '''Definition:'''<br> | ||
| + | GetCurrentRoute() -> ? | ||
<br><br> | <br><br> | ||
| − | '''Description:''' | + | '''Description:''' <br> |
| + | |||
<br><br> | <br><br> | ||
| − | '''Arguments:''' | + | '''Arguments:''' <br> |
| + | ? | ||
<br><br> | <br><br> | ||
| − | '''Returns:''' | + | '''Returns:''' <br> |
| + | ? | ||
<br><br> | <br><br> | ||
'''Example:''' | '''Example:''' | ||
<br><br> | <br><br> | ||
| − | === | + | |
| − | '''Definition:''' | + | |
| + | === GetFinalDestination === | ||
| + | '''Definition:'''<br> | ||
| + | GetFinalDestination() -> ? | ||
<br><br> | <br><br> | ||
| − | '''Description:''' | + | '''Description:''' <br> |
| + | |||
<br><br> | <br><br> | ||
| − | '''Arguments:''' | + | '''Arguments:''' <br> |
| + | ? | ||
<br><br> | <br><br> | ||
| − | '''Returns:''' | + | '''Returns:''' <br> |
| + | ? | ||
<br><br> | <br><br> | ||
'''Example:''' | '''Example:''' | ||
<br><br> | <br><br> | ||
| − | === | + | |
| − | '''Definition:''' | + | |
| + | === GetNextHop === | ||
| + | '''Definition:'''<br> | ||
| + | GetNextHop() -> ? | ||
<br><br> | <br><br> | ||
| − | '''Description:''' | + | '''Description:''' <br> |
| + | |||
<br><br> | <br><br> | ||
| − | '''Arguments:''' | + | '''Arguments:''' <br> |
| + | ? | ||
<br><br> | <br><br> | ||
| − | '''Returns:''' | + | '''Returns:''' <br> |
| + | ? | ||
<br><br> | <br><br> | ||
'''Example:''' | '''Example:''' | ||
<br><br> | <br><br> | ||
| + | |||
| + | |||
=== list === | === list === | ||
| − | '''Definition:''' | + | '''Definition:'''<br> |
| + | list() -> ? | ||
<br><br> | <br><br> | ||
| − | '''Description:''' | + | '''Description:''' <br> |
| + | |||
<br><br> | <br><br> | ||
| − | '''Arguments:''' | + | '''Arguments:''' <br> |
| + | ? | ||
<br><br> | <br><br> | ||
| − | '''Returns:''' | + | '''Returns:''' <br> |
| + | ? | ||
<br><br> | <br><br> | ||
'''Example:''' | '''Example:''' | ||
<br><br> | <br><br> | ||
| − | === | + | |
| + | |||
| + | === load === | ||
'''Definition:'''<br> | '''Definition:'''<br> | ||
| − | + | load() -> ? | |
| − | + | ||
| − | + | ||
<br><br> | <br><br> | ||
| − | '''Description:'''<br> | + | '''Description:''' <br> |
| − | + | ||
<br><br> | <br><br> | ||
| − | '''Arguments:'''<br> | + | '''Arguments:''' <br> |
| − | + | ? | |
<br><br> | <br><br> | ||
| − | '''Returns:''' | + | '''Returns:''' <br> |
| + | ? | ||
<br><br> | <br><br> | ||
| − | '''Example:''' | + | '''Example:''' |
| − | + | ||
| − | + | ||
<br><br> | <br><br> | ||
| − | === | + | |
| − | '''Definition:''' | + | |
| + | === OnEvent === | ||
| + | '''Definition:'''<br> | ||
| + | OnEvent() -> ? | ||
<br><br> | <br><br> | ||
| − | '''Description:''' | + | '''Description:''' <br> |
| + | |||
<br><br> | <br><br> | ||
| − | '''Arguments:''' | + | '''Arguments:''' <br> |
| + | ? | ||
<br><br> | <br><br> | ||
| − | '''Returns:''' | + | '''Returns:''' <br> |
| + | ? | ||
<br><br> | <br><br> | ||
'''Example:''' | '''Example:''' | ||
<br><br> | <br><br> | ||
| − | === | + | |
| − | '''Definition:''' | + | |
| + | === save === | ||
| + | '''Definition:'''<br> | ||
| + | save() -> ? | ||
<br><br> | <br><br> | ||
| − | '''Description:''' | + | '''Description:''' <br> |
| + | |||
<br><br> | <br><br> | ||
| − | '''Arguments:''' | + | '''Arguments:''' <br> |
| + | ? | ||
<br><br> | <br><br> | ||
| − | '''Returns:''' | + | '''Returns:''' <br> |
| + | ? | ||
<br><br> | <br><br> | ||
'''Example:''' | '''Example:''' | ||
<br><br> | <br><br> | ||
| − | === | + | |
| − | '''Definition:''' | + | |
| + | === SetFinalDestination === | ||
| + | '''Definition:'''<br> | ||
| + | SetFinalDestination() -> ? | ||
<br><br> | <br><br> | ||
| − | '''Description:''' | + | '''Description:''' <br> |
| + | |||
<br><br> | <br><br> | ||
| − | '''Arguments:''' | + | '''Arguments:''' <br> |
| + | ? | ||
<br><br> | <br><br> | ||
| − | '''Returns:''' | + | '''Returns:''' <br> |
| + | ? | ||
<br><br> | <br><br> | ||
'''Example:''' | '''Example:''' | ||
<br><br> | <br><br> | ||
| − | === | + | |
| − | '''Definition:''' | + | |
| + | === SetFullRoute === | ||
| + | '''Definition:'''<br> | ||
| + | SetFullRoute() -> ? | ||
<br><br> | <br><br> | ||
| − | '''Description:''' | + | '''Description:''' <br> |
| + | |||
<br><br> | <br><br> | ||
| − | '''Arguments:''' | + | '''Arguments:''' <br> |
| + | ? | ||
<br><br> | <br><br> | ||
| − | '''Returns:''' | + | '''Returns:''' <br> |
| + | ? | ||
<br><br> | <br><br> | ||
'''Example:''' | '''Example:''' | ||
<br><br> | <br><br> | ||
| − | === | + | |
| − | '''Definition:''' | + | |
| + | === undo === | ||
| + | '''Definition:'''<br> | ||
| + | undo() -> ? | ||
<br><br> | <br><br> | ||
| − | '''Description:''' | + | '''Description:''' <br> |
| + | |||
<br><br> | <br><br> | ||
| − | '''Arguments:''' | + | '''Arguments:''' <br> |
| + | ? | ||
<br><br> | <br><br> | ||
| − | '''Returns:''' | + | '''Returns:''' <br> |
| + | ? | ||
<br><br> | <br><br> | ||
'''Example:''' | '''Example:''' | ||
<br><br> | <br><br> | ||
Revision as of 21:49, 14 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() -> ?
Description:
Arguments:
?
Returns:
?
Example:
undo
Definition:
undo() -> ?
Description:
Arguments:
?
Returns:
?
Example:
