Difference between revisions of "Radar"

From Vendetta Lua
Jump to: navigation, search
(Don't know anything about these functions, but the descriptions are my best guess.)
 
(Removed the template (causing timeouts) and reordered the list)
 
(8 intermediate revisions by 4 users not shown)
Line 3: Line 3:
 
== Functions ==
 
== Functions ==
  
−
=== SetNavDestinationArrowIconSize ===
+
=== GetNearestObjectDistance ===
 
'''Definition:'''<br>
 
'''Definition:'''<br>
−
SetNavDestinationArrowIconSize() -> nil
+
GetNearestObjectDistance() -> nil
 
<br><br>
 
<br><br>
 
'''Description:''' <br>
 
'''Description:''' <br>
−
Set the size of the arrows on the wormhole indicator on the HUD.
+
Get distance to the nearest "large" object.
 
<br><br>
 
<br><br>
 
'''Arguments:'''
 
'''Arguments:'''
Line 19: Line 19:
 
<br><br>
 
<br><br>
  
 +
=== GetRadarSelectionID ===
 +
'''Definition:'''<br>
 +
GetRadarSelectionID() -> int nodeid objectid
 +
<br><br>
 +
'''Description:''' <br>
 +
Get [[nodeid]] and [[objectid]] of targeted object
 +
<br><br>
 +
'''Arguments:'''<br>
 +
<br><br>
 +
'''Returns:'''<br>
 +
'''nodeid''' [[nodeid]] of targeted object<br>
 +
'''objectid''' [[objectid]] of targeted object
 +
<br><br>
 +
'''Example:'''
 +
<br><br>
  
−
 
+
=== HideRadar ===
−
=== SetSelColor ===
+
 
'''Definition:'''<br>
 
'''Definition:'''<br>
−
SetSelColor() -> nil
+
HideRadar() -> nil
 
<br><br>
 
<br><br>
 
'''Description:''' <br>
 
'''Description:''' <br>
−
(Presumably) changes the color of the circle shown around your selected target.
+
Hide the radar.
 
<br><br>
 
<br><br>
 
'''Arguments:'''
 
'''Arguments:'''
Line 37: Line 51:
 
<br><br>
 
<br><br>
  
−
 
+
=== Hide3000mNavpoint ===
−
 
+
−
=== HideRadar ===
+
 
'''Definition:'''<br>
 
'''Definition:'''<br>
−
HideRadar() -> nil
+
Hide3000mNavpoint() -> ?
 
<br><br>
 
<br><br>
−
'''Description:''' <br>
+
'''Description:'''<br>
−
Hide the radar.
+
<br>
 +
'''Arguments:'''
 +
?
 +
<br><br>
 +
'''Returns:'''
 +
?
 +
<br><br>
 +
'''Example:'''
 +
<br><br>
 +
 
 +
=== IsObjectOccluded ===
 +
'''Definition:'''<br>
 +
IsObjectOccluded() -> ?
 
<br><br>
 
<br><br>
 +
'''Description:'''<br>
 +
<br>
 
'''Arguments:'''
 
'''Arguments:'''
 
?
 
?
Line 55: Line 81:
 
<br><br>
 
<br><br>
  
−
=== ShowRadar ===
+
=== SetAimDirIcon ===
 
'''Definition:'''<br>
 
'''Definition:'''<br>
−
ShowRadar() -> nil
+
SetAimDirIcon() -> nil
 
<br><br>
 
<br><br>
 
'''Description:''' <br>
 
'''Description:''' <br>
−
Show the radar.
+
(Presumably) set the icon for hud_new_aimdir.png (mouselook reticle).  
 
<br><br>
 
<br><br>
 
'''Arguments:'''
 
'''Arguments:'''
Line 71: Line 97:
 
<br><br>
 
<br><br>
  
−
=== SetRadarSelection ===
+
=== SetAimDirIconColor ===
 
'''Definition:'''<br>
 
'''Definition:'''<br>
−
SetRadarSelection() -> nil
+
SetAimDirIconColor() -> nil
 
<br><br>
 
<br><br>
 
'''Description:''' <br>
 
'''Description:''' <br>
−
(Presumably) change targets.
+
Change the color of the mouselook reticle?
 
<br><br>
 
<br><br>
 
'''Arguments:'''
 
'''Arguments:'''
Line 103: Line 129:
 
<br><br>
 
<br><br>
  
−
=== GetNearestObjectDistance ===
+
=== SetDestArrows ===
 
'''Definition:'''<br>
 
'''Definition:'''<br>
−
GetNearestObjectDistance() -> nil
+
SetDestArrows() -> nil
 
<br><br>
 
<br><br>
 
'''Description:''' <br>
 
'''Description:''' <br>
−
Get distance to the nearest "large" object.
+
(Presumably) change some aspect of the nav destination arrows on the HUD.
 
<br><br>
 
<br><br>
 
'''Arguments:'''
 
'''Arguments:'''
Line 119: Line 145:
 
<br><br>
 
<br><br>
  
−
=== SetAimDirIconColor ===
+
=== SetHUDIcon ===
 
'''Definition:'''<br>
 
'''Definition:'''<br>
−
SetAimDirIconColor() -> nil
+
SetHUDIcon() -> ?
 +
<br><br>
 +
'''Description:'''<br>
 +
<br>
 +
'''Arguments:'''
 +
?
 +
<br><br>
 +
'''Returns:'''
 +
?
 +
<br><br>
 +
'''Example:'''
 +
<br><br>
 +
 
 +
=== SetNavDestinationArrowIconSize ===
 +
'''Definition:'''<br>
 +
SetNavDestinationArrowIconSize() -> nil
 
<br><br>
 
<br><br>
 
'''Description:''' <br>
 
'''Description:''' <br>
−
Change the color of the mouselook reticle?
+
Set the size of the arrows on the wormhole indicator on the HUD.
 
<br><br>
 
<br><br>
 
'''Arguments:'''
 
'''Arguments:'''
Line 151: Line 192:
 
<br><br>
 
<br><br>
  
−
=== SetWormholeIconSize ===
+
=== SetRadarSelection ===
 
'''Definition:'''<br>
 
'''Definition:'''<br>
−
SetWormholeIconSize() -> nil
+
SetRadarSelection(int [[nodeid]], int [[objectid]]) -> nil
 
<br><br>
 
<br><br>
 
'''Description:''' <br>
 
'''Description:''' <br>
−
(Presumably) change the size of the wormhole icon on the radar.
+
Change targets.
 +
<br><br>
 +
'''Arguments:'''<br>
 +
'''nodeid''' [[nodeid]] of the object you want to target (2 for most things except ships).<br>
 +
'''objectid''' [[objectid]] of the object you want to target.
 +
<br><br>
 +
'''Returns:'''
 +
<br><br>
 +
'''Example:'''
 +
<br><br>
 +
 
 +
=== SetRadarSelectionByPoint ===
 +
'''Definition:'''<br>
 +
SetRadarSelectionByPoint(float percentW, float percentH, string targetcommand) -> nil
 +
<br><br>
 +
'''Description:''' <br>
 +
Change targets based on a given point on the screen and a specified targeting command.
 +
<br><br>
 +
'''Arguments:'''<br>
 +
'''percentW''' a float ranging from 0 to 1 indicating what percentage of the screen width the point is located at<br>
 +
'''percentH''' a float ranging from 0 to 1 indicating what percentage of the screen height the point is located at<br>
 +
'''targetcommand''' VO targeting command (eg RadarNextFront)
 +
<br><br>
 +
'''Returns:'''
 +
<br><br>
 +
'''Example:'''
 +
<source lang="lua">radar.SetRadarSelectionByPoint(0.3837, 0.9927, "RadarNextFront")</source>
 +
<br><br>
 +
 
 +
=== SetSelColor ===
 +
'''Definition:'''<br>
 +
SetSelColor(int r, g, b) -> nil
 +
<br><br>
 +
'''Description:''' <br>
 +
Set targetbox color of the currently selected object.
 +
<br><br>
 +
'''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>
 +
 
 +
=== SetViewPort ===
 +
'''Definition:'''<br>
 +
SetViewPort() -> ?
 
<br><br>
 
<br><br>
 +
'''Description:'''<br>
 +
<br>
 
'''Arguments:'''
 
'''Arguments:'''
 
?
 
?
Line 167: Line 259:
 
<br><br>
 
<br><br>
  
−
=== SetDestArrows ===
+
=== SetWormholeIconSize ===
 
'''Definition:'''<br>
 
'''Definition:'''<br>
−
SetDestArrows() -> nil
+
SetWormholeIconSize() -> nil
 
<br><br>
 
<br><br>
 
'''Description:''' <br>
 
'''Description:''' <br>
−
(Presumably) change some aspect of the nav destination arrows on the HUD.
+
(Presumably) change the size of the wormhole icon on the radar.
 
<br><br>
 
<br><br>
 
'''Arguments:'''
 
'''Arguments:'''
Line 183: Line 275:
 
<br><br>
 
<br><br>
  
−
=== GetRadarSelectionID ===
+
=== Show3000mNavpoint ===
 
'''Definition:'''<br>
 
'''Definition:'''<br>
−
GetRadarSelectionID() -> nil
+
Show3000mNavpoint() -> ?
−
<br><br>
+
−
'''Description:''' <br>
+
−
(Presumably) get the ID (probably the charID) of your selected target.
+
 
<br><br>
 
<br><br>
 +
'''Description:'''<br>
 +
<br>
 
'''Arguments:'''
 
'''Arguments:'''
 
?
 
?
Line 199: Line 290:
 
<br><br>
 
<br><br>
  
−
=== SetAimDirIcon ===
+
=== ShowRadar ===
 
'''Definition:'''<br>
 
'''Definition:'''<br>
−
SetAimDirIcon() -> nil
+
ShowRadar() -> nil
 
<br><br>
 
<br><br>
 
'''Description:''' <br>
 
'''Description:''' <br>
−
(Presumably) set the icon for hud_new_aimdir.png (mouselook reticle).  
+
Show the radar.
 
<br><br>
 
<br><br>
 
'''Arguments:'''
 
'''Arguments:'''
Line 214: Line 305:
 
'''Example:'''
 
'''Example:'''
 
<br><br>
 
<br><br>
 +
 +
[[Category:Tables]]

Latest revision as of 15:36, 22 September 2014

Functions for miscellaneous radar stuffs.

Functions

GetNearestObjectDistance

Definition:
GetNearestObjectDistance() -> nil

Description:
Get distance to the nearest "large" object.

Arguments: ?

Returns: ?

Example:

GetRadarSelectionID

Definition:
GetRadarSelectionID() -> int nodeid objectid

Description:
Get nodeid and objectid of targeted object

Arguments:


Returns:
nodeid nodeid of targeted object
objectid objectid of targeted object

Example:

HideRadar

Definition:
HideRadar() -> nil

Description:
Hide the radar.

Arguments: ?

Returns: ?

Example:

Hide3000mNavpoint

Definition:
Hide3000mNavpoint() -> ?

Description:

Arguments: ?

Returns: ?

Example:

IsObjectOccluded

Definition:
IsObjectOccluded() -> ?

Description:

Arguments: ?

Returns: ?

Example:

SetAimDirIcon

Definition:
SetAimDirIcon() -> nil

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

Arguments: ?

Returns: ?

Example:

SetAimDirIconColor

Definition:
SetAimDirIconColor() -> nil

Description:
Change the color of the mouselook reticle?

Arguments: ?

Returns: ?

Example:

SetAimDirIconSize

Definition:
SetAimDirIconSize() -> nil

Description:
(Presumably) change size of the mouselook reticle.

Arguments: ?

Returns: ?

Example:

SetDestArrows

Definition:
SetDestArrows() -> nil

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

Arguments: ?

Returns: ?

Example:

SetHUDIcon

Definition:
SetHUDIcon() -> ?

Description:

Arguments: ?

Returns: ?

Example:

SetNavDestinationArrowIconSize

Definition:
SetNavDestinationArrowIconSize() -> nil

Description:
Set the size of the arrows on the wormhole indicator on the HUD.

Arguments: ?

Returns: ?

Example:

SetNavpointFontHeight

Definition:
SetNavpointFontHeight() -> nil

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

Arguments: ?

Returns: ?

Example:

SetRadarSelection

Definition:
SetRadarSelection(int nodeid, int objectid) -> nil

Description:
Change targets.

Arguments:
nodeid nodeid of the object you want to target (2 for most things except ships).
objectid objectid of the object you want to target.

Returns:

Example:

SetRadarSelectionByPoint

Definition:
SetRadarSelectionByPoint(float percentW, float percentH, string targetcommand) -> nil

Description:
Change targets based on a given point on the screen and a specified targeting command.

Arguments:
percentW a float ranging from 0 to 1 indicating what percentage of the screen width the point is located at
percentH a float ranging from 0 to 1 indicating what percentage of the screen height the point is located at
targetcommand VO targeting command (eg RadarNextFront)

Returns:

Example: 

radar.SetRadarSelectionByPoint(0.3837, 0.9927, "RadarNextFront")



SetSelColor

Definition:
SetSelColor(int r, g, b) -> nil

Description:
Set targetbox color of the currently selected object.

Arguments:
r red component of color (0-255). nil is interpreted as 0
g green component
b blue component

Returns:

Example: 

radar.SetSelColor(255, 0, 0) -- turns the target box red



SetViewPort

Definition:
SetViewPort() -> ?

Description:

Arguments: ?

Returns: ?

Example:

SetWormholeIconSize

Definition:
SetWormholeIconSize() -> nil

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

Arguments: ?

Returns: ?

Example:

Show3000mNavpoint

Definition:
Show3000mNavpoint() -> ?

Description:

Arguments: ?

Returns: ?

Example:

ShowRadar

Definition:
ShowRadar() -> nil

Description:
Show the radar.

Arguments: ?

Returns: ?

Example:

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