Difference between revisions of "NavRoute"

From Vendetta Lua
Jump to: navigation, search
(→‎SetFullRoute)
(→‎GetCurrentRoute)
 
(12 intermediate revisions by 5 users not shown)
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:'''
+
'''Definition:'''<br>
 +
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)
+
''[[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() -> Clear the current route
 
<br><br>
 
<br><br>
−
'''Description:'''
+
'''Description:''' <br>
 +
Will clear any route if one exists
 +
 
 
<br><br>
 
<br><br>
−
'''Arguments:'''
+
'''Arguments:''' <br>
 +
None
 +
 
 
<br><br>
 
<br><br>
−
'''Returns:'''
+
'''Returns:''' <br>
 +
Nil
 +
 
 
<br><br>
 
<br><br>
 
'''Example:'''
 
'''Example:'''
 
<br><br>
 
<br><br>
  
−
=== save ===
+
=== GetCurrentRoute ===
−
'''Definition:'''
+
'''Definition:'''<br>
 +
GetCurrentRoute() -> table route
 
<br><br>
 
<br><br>
−
'''Description:'''
+
'''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>
−
'''Arguments:'''
+
'''Returns:''' <br>
 +
'''route''' reference to navroute table
 
<br><br>
 
<br><br>
−
'''Returns:'''
+
 
−
<br><br>
+
=== GetFinalDestination ===
−
'''Example:'''
+
'''Definition:'''<br>
 +
GetFinalDestination() -> ?
 
<br><br>
 
<br><br>
 +
'''Description:''' <br>
  
−
=== OnEvent ===
 
−
'''Definition:'''
 
 
<br><br>
 
<br><br>
−
'''Description:'''
+
'''Arguments:''' <br>
 +
?
 
<br><br>
 
<br><br>
−
'''Arguments:'''
+
'''Returns:''' <br>
−
<br><br>
+
 
−
'''Returns:'''
+
sector-id of route end
 +
 
 
<br><br>
 
<br><br>
 
'''Example:'''
 
'''Example:'''
 
<br><br>
 
<br><br>
  
−
=== clear ===
+
=== GetNextHop ===
−
'''Definition:'''
+
'''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 ===
+
 
−
'''Definition:'''
+
 
 +
=== load ===
 +
'''Definition:'''<br>
 +
load() -> ?
 
<br><br>
 
<br><br>
−
'''Description:'''<br>
+
'''Description:''' <br>
−
Set the navigation route.
+
 
 
<br><br>
 
<br><br>
−
'''Arguments:'''<br>
+
'''Arguments:''' <br>
−
(sector_id)<br>
+
?
−
It might be <br>
+
−
(sector_id1,sector_id2,...)
+
 
<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(int destination) -> nil
 
<br><br>
 
<br><br>
−
'''Description:'''
+
'''Description:''' <br>
 +
Plot navroute to specified sector.
 
<br><br>
 
<br><br>
−
'''Arguments:'''
+
'''Arguments:''' <br>
−
<br><br>
+
''destination'' - [[sectorid]] of destination sector.
−
'''Returns:'''
+
 
<br><br>
 
<br><br>
 
'''Example:'''
 
'''Example:'''
−
<br><br>
+
<br>
 +
<source lang="lua">
 +
NavRoute.SetFinalDestination(SectorIDFromLocationStr"Dau A1")
 +
</source>
  
−
=== load ===
+
=== SetFullRoute ===
−
'''Definition:'''
+
'''Definition:'''<br>
 +
SetFullRoute(table route) -> nil
 
<br><br>
 
<br><br>
−
'''Description:'''
+
'''Description:''' <br>
 +
Set the navigation route by specifying all it's points.
 
<br><br>
 
<br><br>
−
'''Arguments:'''
+
'''Arguments:''' <br>
−
<br><br>
+
''route'' - list containing [[sectorid]]'s describing the navroute.<br>
−
'''Returns:'''
+
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>
  
−
=== add ===
+
=== undo ===
−
'''Definition:'''
+
'''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>
 +
 +
[[Category:Tables]]

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: 

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:

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