Difference between revisions of "NavRoute"

From Vendetta Lua
Jump to: navigation, search
(SetFullRoute)
m (addbyid)
Line 12: Line 12:
  
 
=== addbyid ===
 
=== addbyid ===
'''Definition:'''
+
'''Definition:'''<br>
 +
addbyid(int sector_id)
 
<br><br>
 
<br><br>
 
'''Description:'''<br>
 
'''Description:'''<br>
Line 18: Line 19:
 
<br><br>
 
<br><br>
 
'''Arguments:'''<br>
 
'''Arguments:'''<br>
(sector_id)
+
''sector_id'' - sector to plot a route to
 
<br><br>
 
<br><br>
 
'''Returns:'''
 
'''Returns:'''

Revision as of 13:44, 14 February 2009

GetNextHop

Definition:

Description:

Arguments:

Returns:

Example:

addbyid

Definition:
addbyid(int sector_id)

Description:
Add a destination to the navigation route.

Arguments:
sector_id - sector to plot a route to

Returns:

Example:
local sector_id = SectorIDFromLocationStr('Bractus C-5')
NavRoute.addbyid{sector_id}


SetFinalDestination

Definition:

Description:

Arguments:

Returns:

Example:

save

Definition:

Description:

Arguments:

Returns:

Example:

OnEvent

Definition:

Description:

Arguments:

Returns:

Example:

clear

Definition:

Description:

Arguments:

Returns:

Example:

list

Definition:

Description:

Arguments:

Returns:

Example:

SetFullRoute

Definition:

Description:
Set the navigation route.

Arguments:
(sector_id)
It might be
(sector_id1,sector_id2,...)

Returns:

Example:
local sector_id = SectorIDFromLocationStr('Bractus C-5')
NavRoute.SetFullRoute{sector_id}


GetCurrentRoute

Definition:

Description:

Arguments:

Returns:

Example:

undo

Definition:

Description:

Arguments:

Returns:

Example:

GetFinalDestination

Definition:

Description:

Arguments:

Returns:

Example:

load

Definition:

Description:

Arguments:

Returns:

Example:

add

Definition:

Description:

Arguments:

Returns:

Example: