NavRoute: Difference between revisions

From Vendetta Lua
Jump to navigationJump to search
← Older editNewer edit →
Darkgrey (talk | contribs)
28 edits
Mick (talk | contribs)
72 edits
m sorted, corrected lua syntax
Line 1: Line 1:
=== GetNextHop ===
== 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 sector_id)
addbyid(int [[sectorid]]) -> true
<br><br>
<br><br>
'''Description:'''<br>
'''Description:''' <br>
Add a destination to the navigation route.
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>
''sector_id'' - sector to plot a route to
''[[sectorid]]'' - sector to plot a route to
<br><br>
<br><br>
'''Returns:'''
'''Returns:''' <br>
Seems to always return true.
<br><br>
<br><br>
'''Example:'''<br>
'''Example:'''
local sector_id = SectorIDFromLocationStr('Bractus C-5')<br>
<source lang="lua">
NavRoute.addbyid{sector_id}<br>
local sectorid = SectorIDFromLocationStr("Bractus C-5")
NavRoute.addbyid(sectorid)
</source>
<br><br>
<br><br>


=== SetFinalDestination ===
 
'''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>


=== save ===
 
'''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>


=== OnEvent ===
 
'''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>


=== clear ===
 
'''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>


=== SetFullRoute ===
 
 
=== load ===
'''Definition:'''<br>
'''Definition:'''<br>
SetFullRoute(int sector_id)<br>
load() -> ?
or maybe<br>
SetFullRoute(int sector_id, sector_id2, ...)
<br><br>
<br><br>
'''Description:'''<br>
'''Description:''' <br>
Set the navigation route.
 
<br><br>
<br><br>
'''Arguments:'''<br>
'''Arguments:''' <br>
''sector_id'' - sector to plot a route to
?
<br><br>
<br><br>
'''Returns:'''
'''Returns:''' <br>
?
<br><br>
<br><br>
'''Example:'''<br>
'''Example:'''
local sector_id = SectorIDFromLocationStr('Bractus C-5')<br>
NavRoute.SetFullRoute{sector_id}<br>
<br><br>
<br><br>


=== GetCurrentRoute ===
 
'''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>


=== undo ===
 
'''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>


=== GetFinalDestination ===
 
'''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>


=== load ===
 
'''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>


=== add ===
 
'''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

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() -> ?

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:

Retrieved from "https://vo-wiki.com/racecar2/index.php?title=NavRoute&oldid=1189"