Difference between revisions of "Radar"

From Vendetta Lua
Jump to: navigation, search
(Added to category.)
(Added new functions and updated display to use Template:Function)
Line 3: Line 3:
 
== Functions ==
 
== Functions ==
  
−
=== SetNavDestinationArrowIconSize ===
+
{{Function
−
'''Definition:'''<br>
+
| name        = GetNearestObjectDistance
−
SetNavDestinationArrowIconSize() -> nil
+
| desc        = Get distance to the nearest "large" object.  
−
<br><br>
+
| ret1_name    =
−
'''Description:''' <br>
+
| ret1_type    = number
−
Set the size of the arrows on the wormhole indicator on the HUD.
+
| ret1_desc    =
−
<br><br>
+
| notes        =
−
'''Arguments:'''
+
}}
−
?
+
−
<br><br>
+
−
'''Returns:'''
+
−
?
+
−
<br><br>
+
−
'''Example:'''
+
−
<br><br>
+
  
 +
{{Function
 +
| name        = GetRadarSelectionID
 +
| desc        = Get [[nodeid]] and [[objectid]] of targeted object
 +
| ret1_name    = nodeid
 +
| ret1_type    = number
 +
| ret1_desc    = [[nodeid]] of targeted object
 +
| ret2_name    = objectid
 +
| ret2_type    = number
 +
| ret2_desc    = [[objectid]] of targeted object
 +
| notes        =
 +
}}
  
 +
{{Function
 +
| name        = Hide3000mNavpoint
 +
| desc        =
 +
| arg1_name    = ?
 +
| arg1_type    =
 +
| arg1_desc    =
 +
| arg1_opt    =
 +
| ret1_name    = ?
 +
| ret1_type    =
 +
| ret1_desc    =
 +
| notes        =
 +
}}
  
−
=== SetSelColor ===
+
{{Function
−
'''Definition:'''<br>
+
| name        = HideRadar
−
SetSelColor(int r, g, b) -> nil
+
| desc        = Hide the radar.
−
<br><br>
+
| ret1_name    =
−
'''Description:''' <br>
+
| ret1_type    = nil
−
Set targetbox color of the currently selected object.
+
| ret1_desc    =
−
<br><br>
+
| notes        =  
−
'''Arguments:'''<br>
+
}}
−
'''r''' red component of color (0-255). nil is interpreted as 0<br>
+
−
'''g''' green component<br>
+
−
'''b''' blue component
+
−
<br><br>
+
−
'''Returns:'''
+
−
<br><br>
+
−
'''Example:'''
+
−
<source lang="lua">radar.SetSelColor(255, 0, 0) -- turns the target box red</source>
+
−
<br><br>
+
  
−
=== HideRadar ===
+
{{Function
−
'''Definition:'''<br>
+
| name        = IsObjectOccluded
−
HideRadar() -> nil
+
| desc        =  
−
<br><br>
+
| arg1_name    = ?
−
'''Description:''' <br>
+
| arg1_type    =  
−
Hide the radar.
+
| arg1_desc    =  
−
<br><br>
+
| arg1_opt    =  
−
'''Arguments:'''
+
| ret1_name    = ?
−
?
+
| ret1_type    =
−
<br><br>
+
| ret1_desc    =
−
'''Returns:'''
+
| notes        =
−
?
+
}}
−
<br><br>
+
−
'''Example:'''
+
−
<br><br>
+
  
−
=== ShowRadar ===
+
{{Function
−
'''Definition:'''<br>
+
| name        = SetAimDirIcon
−
ShowRadar() -> nil
+
| desc        = (Presumably) set the icon for hud_new_aimdir.png (mouselook reticle).  
−
<br><br>
+
| arg1_name    = ?
−
'''Description:''' <br>
+
| arg1_type    =
−
Show the radar.
+
| arg1_desc    =
−
<br><br>
+
| arg1_opt    =
−
'''Arguments:'''
+
| ret1_name    = ?
−
?
+
| ret1_type    =
−
<br><br>
+
| ret1_desc    =
−
'''Returns:'''
+
| notes        =
−
?
+
}}
−
<br><br>
+
−
'''Example:'''
+
−
<br><br>
+
  
−
=== SetRadarSelection ===
+
{{Function
−
'''Definition:'''<br>
+
| name        = SetAimDirIconColor
−
SetRadarSelection(int [[nodeid]], int [[objectid]]) -> nil
+
| desc        = Change the color of the mouselook reticle?
−
<br><br>
+
| arg1_name    = ?
−
'''Description:''' <br>
+
| arg1_type    =
−
Change targets.
+
| arg1_desc    =
−
<br><br>
+
| arg1_opt    =
−
'''Arguments:'''<br>
+
| ret1_name    = ?
−
'''nodeid''' [[nodeid]] of the object you want to target (2 for most things except ships).<br>
+
| ret1_type    =
−
'''objectid''' [[objectid]] of the object you want to target.
+
| ret1_desc    =
−
<br><br>
+
| notes        =
−
'''Returns:'''
+
}}
−
<br><br>
+
−
'''Example:'''
+
−
<br><br>
+
  
−
=== SetAimDirIconSize ===
+
{{Function
−
'''Definition:'''<br>
+
| name        = SetAimDirIconSize
−
SetAimDirIconSize() -> nil
+
| desc        = (Presumably) change size of the mouselook reticle.
−
<br><br>
+
| arg1_name    = ?
−
'''Description:''' <br>
+
| arg1_type    =
−
(Presumably) change size of the mouselook reticle.
+
| arg1_desc    =
−
<br><br>
+
| arg1_opt    =
−
'''Arguments:'''
+
| ret1_name    = ?
−
?
+
| ret1_type    =
−
<br><br>
+
| ret1_desc    =
−
'''Returns:'''
+
| notes        =
−
?
+
}}
−
<br><br>
+
−
'''Example:'''
+
−
<br><br>
+
  
−
=== GetNearestObjectDistance ===
+
{{Function
−
'''Definition:'''<br>
+
| name        = SetDestArrows
−
GetNearestObjectDistance() -> nil
+
| desc        = (Presumably) change some aspect of the nav destination arrows on the HUD.
−
<br><br>
+
| arg1_name    = ?
−
'''Description:''' <br>
+
| arg1_type    =
−
Get distance to the nearest "large" object.
+
| arg1_desc    =
−
<br><br>
+
| arg1_opt    =
−
'''Arguments:'''
+
| ret1_name    = ?
−
?
+
| ret1_type    =
−
<br><br>
+
| ret1_desc    =
−
'''Returns:'''
+
| notes        =
−
?
+
}}
−
<br><br>
+
−
'''Example:'''
+
−
<br><br>
+
  
−
=== SetAimDirIconColor ===
+
{{Function
−
'''Definition:'''<br>
+
| name        = SetHUDIcon
−
SetAimDirIconColor() -> nil
+
| desc        =  
−
<br><br>
+
| arg1_name    = ?
−
'''Description:''' <br>
+
| arg1_type    =
−
Change the color of the mouselook reticle?
+
| arg1_desc    =
−
<br><br>
+
| arg1_opt    =
−
'''Arguments:'''
+
| ret1_name    = ?
−
?
+
| ret1_type    =
−
<br><br>
+
| ret1_desc    =
−
'''Returns:'''
+
| notes        =
−
?
+
}}
−
<br><br>
+
−
'''Example:'''
+
−
<br><br>
+
  
−
=== SetNavpointFontHeight ===
+
{{Function
−
'''Definition:'''<br>
+
| name        = SetNavDestinationArrowIconSize
−
SetNavpointFontHeight() -> nil
+
| desc        =  
−
<br><br>
+
| arg1_name    = ?
−
'''Description:''' <br>
+
| arg1_type    =  
−
(Presumably) change the size of the green + on the radar in ion storms.
+
| arg1_desc    =  
−
<br><br>
+
| arg1_opt    =  
−
'''Arguments:'''
+
| ret1_name    = ?
−
?
+
| ret1_type    =
−
<br><br>
+
| ret1_desc    =
−
'''Returns:'''
+
| notes        =
−
?
+
}}
−
<br><br>
+
−
'''Example:'''
+
−
<br><br>
+
  
−
=== SetWormholeIconSize ===
+
{{Function
−
'''Definition:'''<br>
+
| name        = SetNavpointFontHeight
−
SetWormholeIconSize() -> nil
+
| desc        = (Presumably) change the size of the green + on the radar in ion storms.
−
<br><br>
+
| arg1_name    = ?
−
'''Description:''' <br>
+
| arg1_type    =
−
(Presumably) change the size of the wormhole icon on the radar.
+
| arg1_desc    =
−
<br><br>
+
| arg1_opt    =
−
'''Arguments:'''
+
| ret1_name    = ?
−
?
+
| ret1_type    =
−
<br><br>
+
| ret1_desc    =
−
'''Returns:'''
+
| notes        =
−
?
+
}}
−
<br><br>
+
−
'''Example:'''
+
−
<br><br>
+
  
−
=== SetDestArrows ===
+
{{Function
−
'''Definition:'''<br>
+
| name        = SetRadarSelection
−
SetDestArrows() -> nil
+
| desc        = Change targets.
−
<br><br>
+
| arg1_name    = nodeid
−
'''Description:''' <br>
+
| arg1_type    = number
−
(Presumably) change some aspect of the nav destination arrows on the HUD.
+
| arg1_desc    = [[nodeid]] of the object you want to target (2 for most things except ships)
−
<br><br>
+
| arg1_opt    =
−
'''Arguments:'''
+
| arg2_name    = objectid
−
?
+
| arg2_type    = number
−
<br><br>
+
| arg2_desc    = [[objectid]] of the object you want to target.
−
'''Returns:'''
+
| arg2_opt    =
−
?
+
| ret1_name    =
−
<br><br>
+
| ret1_type    = nil
−
'''Example:'''
+
| ret1_desc    =
−
<br><br>
+
| notes        =
 +
}}
  
−
=== GetRadarSelectionID ===
+
{{Function
−
'''Definition:'''<br>
+
| name        = SetRadarSelectionByPoint
−
GetRadarSelectionID() -> int nodeid objectid
+
| desc        =  
−
<br><br>
+
| arg1_name    = ?
−
'''Description:''' <br>
+
| arg1_type    =  
−
Get [[nodeid]] and [[objectid]] of targeted object
+
| arg1_desc    =  
−
<br><br>
+
| arg1_opt    =  
−
'''Arguments:'''<br>
+
| ret1_name    = ?
−
<br><br>
+
| ret1_type    =
−
'''Returns:'''<br>
+
| ret1_desc    =
−
'''nodeid''' [[nodeid]] of targeted object<br>
+
| notes        =
−
'''objectid''' [[objectid]] of targeted object
+
}}
−
<br><br>
+
 
−
'''Example:'''
+
{{Function
−
<br><br>
+
| name        = SetSelColor
 +
| desc        = Set targetbox color of the currently selected object.
 +
| arg1_name    = r
 +
| arg1_type    = number
 +
| arg1_desc    = red component of color (0-255). nil is interpreted as 0
 +
| arg1_opt    =
 +
| arg2_name    = g
 +
| arg2_type    = number
 +
| arg2_desc    = green component
 +
| arg2_opt    =
 +
| arg3_name    = b
 +
| arg3_type    = number
 +
| arg3_desc    = blue component
 +
| arg3_opt    =
 +
| ret1_name    =
 +
| ret1_type    = nil
 +
| ret1_desc    =
 +
| notes        = <source lang="lua">radar.SetSelColor(255, 0, 0) -- turns the target box red</source>
 +
}}
 +
 
 +
{{Function
 +
| name        = SetViewport
 +
| desc        =
 +
| arg1_name    = ?
 +
| arg1_type    =
 +
| arg1_desc    =
 +
| arg1_opt    =
 +
| ret1_name    = ?
 +
| ret1_type    =
 +
| ret1_desc    =
 +
| notes        =
 +
}}
 +
 
 +
{{Function
 +
| name        = SetWormholeIconSize
 +
| desc        = (Presumably) change the size of the wormhole icon on the radar.
 +
| arg1_name    = ?
 +
| arg1_type    =
 +
| arg1_desc    =
 +
| arg1_opt    =
 +
| ret1_name    = ?
 +
| ret1_type    =
 +
| ret1_desc    =
 +
| notes        =
 +
}}
 +
 
 +
{{Function
 +
| name        = Show3000mNavpoint
 +
| desc        =
 +
| arg1_name    = ?
 +
| arg1_type    =
 +
| arg1_desc    =
 +
| arg1_opt    =
 +
| ret1_name    = ?
 +
| ret1_type    =
 +
| ret1_desc    =
 +
| notes        =
 +
}}
 +
 
 +
{{Function
 +
| name        = ShowRadar
 +
| desc        = Show the radar.
 +
| ret1_name    =
 +
| ret1_type    = nil
 +
| ret1_desc    =
 +
| notes        =
 +
}}
  
−
=== SetAimDirIcon ===
 
−
'''Definition:'''<br>
 
−
SetAimDirIcon() -> nil
 
−
<br><br>
 
−
'''Description:''' <br>
 
−
(Presumably) set the icon for hud_new_aimdir.png (mouselook reticle).
 
−
<br><br>
 
−
'''Arguments:'''
 
−
?
 
−
<br><br>
 
−
'''Returns:'''
 
−
?
 
−
<br><br>
 
−
'''Example:'''
 
−
<br><br>
 
  
  
 
[[Category:Tables]]
 
[[Category:Tables]]

Revision as of 09:12, 14 January 2012

Functions for miscellaneous radar stuffs.

Functions

GetNearestObjectDistance

Definition

GetNearestObjectDistance() ->  number
Description

Get distance to the nearest "large" object.
Returns

Type Name Description
number



GetRadarSelectionID

Definition

GetRadarSelectionID() ->  number  nodeid,  number  objectid
Description

Get nodeid and objectid of targeted object
Returns

Type Name Description
number nodeid nodeid of targeted object
number objectid objectid of targeted object



Hide3000mNavpoint

Definition

Hide3000mNavpoint( ?) ->  ?
Arguments

Type Name Description
 ?
Returns

Type Name Description
 ?



HideRadar

Definition

HideRadar() ->  nil
Description

Hide the radar.
Returns

Type Name Description
nil



IsObjectOccluded

Definition

IsObjectOccluded( ?) ->  ?
Arguments

Type Name Description
 ?
Returns

Type Name Description
 ?



SetAimDirIcon

Definition

SetAimDirIcon( ?) ->  ?
Description

(Presumably) set the icon for hud_new_aimdir.png (mouselook reticle).
Arguments

Type Name Description
 ?
Returns

Type Name Description
 ?



SetAimDirIconColor

Definition

SetAimDirIconColor( ?) ->  ?
Description

Change the color of the mouselook reticle?
Arguments

Type Name Description
 ?
Returns

Type Name Description
 ?



SetAimDirIconSize

Definition

SetAimDirIconSize( ?) ->  ?
Description

(Presumably) change size of the mouselook reticle.
Arguments

Type Name Description
 ?
Returns

Type Name Description
 ?



SetDestArrows

Definition

SetDestArrows( ?) ->  ?
Description

(Presumably) change some aspect of the nav destination arrows on the HUD.
Arguments

Type Name Description
 ?
Returns

Type Name Description
 ?



SetHUDIcon

Definition

SetHUDIcon( ?) ->  ?
Arguments

Type Name Description
 ?
Returns

Type Name Description
 ?



SetNavDestinationArrowIconSize

Definition

SetNavDestinationArrowIconSize( ?) ->  ?
Arguments

Type Name Description
 ?
Returns

Type Name Description
 ?



SetNavpointFontHeight

Definition

SetNavpointFontHeight( ?) ->  ?
Description

(Presumably) change the size of the green + on the radar in ion storms.
Arguments

Type Name Description
 ?
Returns

Type Name Description
 ?



SetRadarSelection

Definition

SetRadarSelection( number  nodeid,  number  objectid) ->  nil
Description

Change targets.
Arguments

Type Name Description
number nodeid nodeid of the object you want to target (2 for most things except ships)
number objectid objectid of the object you want to target.
Returns

Type Name Description
nil



SetRadarSelectionByPoint

Definition

SetRadarSelectionByPoint( ?) ->  ?
Arguments

Type Name Description
 ?
Returns

Type Name Description
 ?



SetSelColor

Definition

SetSelColor( number  r,  number  g,  number  b) ->  nil
Description

Set targetbox color of the currently selected object.
Arguments

Type Name Description
number r red component of color (0-255). nil is interpreted as 0
number g green component
number b blue component
Returns

Type Name Description
nil
Notes 
radar.SetSelColor(255, 0, 0) -- turns the target box red



SetViewport

Definition

SetViewport( ?) ->  ?
Arguments

Type Name Description
 ?
Returns

Type Name Description
 ?



SetWormholeIconSize

Definition

SetWormholeIconSize( ?) ->  ?
Description

(Presumably) change the size of the wormhole icon on the radar.
Arguments

Type Name Description
 ?
Returns

Type Name Description
 ?



Show3000mNavpoint

Definition

Show3000mNavpoint( ?) ->  ?
Arguments

Type Name Description
 ?
Returns

Type Name Description
 ?



ShowRadar

Definition

ShowRadar() ->  nil
Description

Show the radar.
Returns

Type Name Description
nil
Retrieved from "https://www.vo-wiki.com/racecar2/index.php?title=Radar&oldid=2135"