Difference between revisions of "Hud gauges.tbl"

From FreeSpace Wiki
Jump to: navigation, search
(Majorly needed editing for style. Updated some stuffs. Stopping at +Wingman Status for now (taking a break))
Line 1: Line 1:
 
{{SCP table}}
 
{{SCP table}}
  
−
{{TableVersion|????}}
+
{{TableVersion|9018}}
  
−
hud_gauges.tbl is used for modifying the elements of the HUD. It is as of now currently unfinished. Not all gauges can be modified. However, it can still be used to add custom gauges equivalent to something like the wingman status display.
+
hud_gauges.tbl is used for modifying the elements of the HUD. Not all gauges can be modified. However, custom gauges may be added to mimic their behavior (such as the wingman status display).
 +
 
 +
HUD Elements in FS2 are called Gauges, and each gauge has various options to customize appearance and, in some cases, their behavior as well.
  
 
This table is one of the [[Modular Tables]] and can be extended with xxx-hdg.tbm
 
This table is one of the [[Modular Tables]] and can be extended with xxx-hdg.tbm
Line 9: Line 11:
 
NOTE: The following information is only applicable for builds based on Antipodes 7.
 
NOTE: The following information is only applicable for builds based on Antipodes 7.
  
−
==Gauge system overview==
 
  
−
*HUD Elements in FS2 are called Gauges. Each gauge has various options to customize appearance and, in some cases, gauge behaviour.
 
  
−
==Table Contents==
+
==HUD Configurations==
 +
The following entries are used on the HUD system, but have not been grouped with any particular gauge.
 +
 
  
 
===$Load Retail Configuration:===
 
===$Load Retail Configuration:===
−
*If yes, any gauge missing from the HUD gauge definitions below will be loaded using the retail defaults.
+
Optional. If yes, any gauge missing from the HUD gauge definitions below will be loaded using the retail defaults.
 +
 
 +
If no, any missing (default) gauge will prompt an error.
 +
 
 
*Syntax: '''Boolean'''
 
*Syntax: '''Boolean'''
 +
 +
 +
===$Color:===
 +
Optional. Sets the default HUD color for all gauges.
 +
 +
*Sytax: '''Integer''' Red, '''Integer''' Green, '''Integer''' Blue
 +
*Valid Values: all values from 0 to 255
 +
  
 
===$Font:===
 
===$Font:===
−
*Which font to use for the HUD.
+
Optional. Sets the font type to use for the HUD.
−
*Syntax: '''Integer''', font index as defined in fonts.tbl
+
 
 +
*Syntax: '''Integer''' font index number
 +
*Valid Values: Any font index as defined in [[Fonts.tbl]]
 +
 
  
 
===$Max Directives:===
 
===$Max Directives:===
−
*Maximum number of directives displayed simultaneously.
+
Optional. Sets the default maximum number of directives displayed simultaneously.
−
*Syntax: '''Integer''', default is 5.
+
 
 +
*Syntax: '''Integer''' maximum number of directives
 +
*Valid Values: Any positive number
 +
*Default Value: '''5'''
 +
 
  
 
===$Max Escort Ships:===
 
===$Max Escort Ships:===
−
*Sets the number of escort ships shown in the list. Entries more than 16 will cause the list to overflow into the weapons list under a resolution of 1024x768.
+
Optional. Sets the default maximum number of escort ships to be shown in the escort list.
 +
 
 
*Syntax: '''Integer'''
 
*Syntax: '''Integer'''
 +
*Valid Values: Any positive number
 +
{{Warning|
 +
Entries more than 16 will cause the list to overflow into the weapons list for resolutions lower than 1024x768.}}
 +
  
 
===$Length Unit Multiplier:===
 
===$Length Unit Multiplier:===
−
*Defines the multiplier used for scaling the distances reported to the player in the game
+
Optional. Sets the multiplier to applied to the reported distances. For example, if the multiplier is 0.5, then the distance reported to the player will (or at least should) be 0.5 x actual distance.
 +
 
 
*Syntax: '''Float'''
 
*Syntax: '''Float'''
 +
*Valid Values: Any positive number
 +
  
 
===$Speed Unit Multiplier:===
 
===$Speed Unit Multiplier:===
−
*Analogous to the above, this multiplier is applied to all speeds reported to the player
+
Optional. Analogous to [[Hud_gauges.tbl#$Length Unit Multiplier:|$Length Unit Multiplier]], this sets the multiplier to be applied to all speeds reported to the player. For example, if the multiplier is 0.5, the the speed reported to the player will (or at least should) be 0.5 x actual speed.
−
*Syntax: '''Float''', if nothing else is defined, this is set to the same value as the length unit multiplier above
+
 
 +
*Syntax: '''Float'''
 +
*Valid Values: Any positive number
 +
*Default Values:
 +
:'''The value used in $Length Unit Multiplier''', or
 +
:'''1''', if $Length Unit Multiplier is undefined
 +
 
  
 
===$Wireframe Targetbox:===
 
===$Wireframe Targetbox:===
−
*Defines the default draw method for the targetbox
+
Optional. Defines the default draw method for the target viewer (a.k.a. targetbox).
−
*Syntax: '''Integer'''
+
 
−
**Options:
+
*Syntax: '''Integer''' Draw method ID
−
::* '''0''' - Standard with full bright lighting
+
*Valid Values:
−
::* '''1''' - Wireframe
+
::'''0''' - Standard with full, bright lighting
−
::* '''2''' - Standard with proper lighting
+
::'''1''' - Wireframe
 +
::'''2''' - Standard with proper lighting (i.e. lit the same as the actual target)
 
{{Table3615|
 
{{Table3615|
−
::* '''3''' - Untextured with full bright lighting (i.e. drawn with a single flat color)}}
+
::'''3''' - Untextured with full bright lighting (i.e. drawn with a single flat color)}}
 +
 
  
 
===$Targetbox Shader Effect:===
 
===$Targetbox Shader Effect:===
 
{{Table3615|
 
{{Table3615|
 +
Optional. If set, defines a unique ID for a shader effect to be used when rendering a ship for the targeting box. The ID will be passed to the main shader as in [[Post_processing.tbl##Ship_Effects|#Ship_Effects]], but a table entry for the effect is not needed.
 +
 
*Syntax: '''Integer'''
 
*Syntax: '''Integer'''
−
*If set, defines a unique ID for a shader effect to be used when rendering a ship for the targeting box. The ID will be passed to the main shader as in [[Post_processing.tbl##Ship_Effects]], but that a table entry for the effect is not needed.}}
+
*Valid Values: Any positive number
 +
}}
 +
 
  
 
===$Lock Wireframe Mode:===
 
===$Lock Wireframe Mode:===
−
*If set, prevents targetbox draw method from being changed during the gaming session. This can be used by modders to define an unchangable look for their mod.
+
Optional. If set, prevents targetbox draw method from being changed during the gaming session.
 
*Syntax: '''Boolean'''
 
*Syntax: '''Boolean'''
  
  
 
===$Reticle Style:===
 
===$Reticle Style:===
−
*Selection for display type of the Reticle.
+
Optional. Defines which aiming reticle to use.
 
*Syntax: '''String'''
 
*Syntax: '''String'''
−
**Options:  
+
*Valid Values:  
−
::* '''FS1''' - uses '''''reticle1_fs1.ani'''''
+
:'''FS1''' - uses '''''reticle1_fs1.ani'''''
−
::* '''FS2''' - uses '''''reticle1.ani'''''
+
:'''FS2''' - uses '''''reticle1.ani'''''
 +
 
 +
 
  
 
==#Gauge Config==
 
==#Gauge Config==
 +
The following entries define default gauge appearance and behavior. Each gauge has the option of overriding these options.
 +
  
 
===$Ship:===
 
===$Ship:===
−
*Optional. If set, the following config data will only be used if the player ship is of the supplied ship class
+
Optional. If defined, the following config data will only be used if the player ship is of the supplied ship class. Can be defined multiple times within a #Gauge config group to allow unique HUD configurations per ship class.
−
*Syntax: '''String''', the ship class name
+
 
 +
If not defined, all following config data will be applied to all ships.
 +
 
 +
*Syntax: '''String''', ship class name
 +
 
  
 
====$Load Retail Configuration:====
 
====$Load Retail Configuration:====
−
*As per the global option above.
+
Optional. Overrides the [[Hud_gauges.tbl#$Load Retail Configuration: 1|$Load Retail Configuration]] global option for this ship class.
 
*Syntax: '''Boolean'''
 
*Syntax: '''Boolean'''
 +
 +
 +
====$Color:====
 +
Optional. Overrides the [[Hud_gauges.tbl#$Color: 1|$Color]] global option for this ship class
 +
 +
*Syntax: '''Integer''' Red, '''Integer''' Green, '''Integer''' Blue
 +
*Valid Values: 0 to 255
 +
  
 
====$Font:====
 
====$Font:====
−
*As per the global option above.
+
Optional. Overrides the [[Hud_gauges.tbl#$Font: 1|$Front]] global option for this ship class.
−
*Syntax: '''Integer'''
+
 
 +
*Syntax: '''Integer''' font index number
 +
*Valid Values: Any font index as defined in [[Fonts.tbl]]
 +
 
  
 
===$Base:===
 
===$Base:===
−
*Base resolution for this config.
+
Defines the base resolution for this HUD configuration.
−
*Syntax: '''(Integer, Integer)'''
+
 
 +
*Syntax: ('''Integer''' width, '''Integer''' height)
 +
*Valid Values: All supported resolutions (?)
 +
 
  
 
===$Required Aspect:===
 
===$Required Aspect:===
−
*Optional. If set, this configuration will only be loaded for widescreen or square resolutions.
+
Optional. If set, this configuration will only be loaded for the specified aspect ratios.
−
*Syntax: '''String''', either "Full Screen" or "Wide Screen".
+
 
 +
*Syntax: '''String'''
 +
*Valid Values:
 +
:"Full Screen" (4:3)
 +
:"Wide Screen" (16:9, 16:10, or similar)
 +
 
  
 
===$Min:===
 
===$Min:===
−
*Minimum resolution for this config.
+
Minimum resolution for this config. Any resolution lower than specified will not use this configuration.
−
*Syntax: '''(Integer, Integer)'''
+
 
 +
*Syntax: ('''Integer''' width, '''Integer''' height)
 +
*Valid Values: All supported resolutions (?)
 +
 
  
 
===$Max:===
 
===$Max:===
−
*Maximum resolution for this config.
+
Maximum resolution for this config.  Any resolution higher than specified will not use this configuration.
−
*Syntax: '''(Integer, Integer)'''
+
 
 +
*Syntax: ('''Integer''' width, '''Integer''' height)
 +
*Valid Values: All supported resolutions (?)
 +
 
  
 
===$Gauges:===
 
===$Gauges:===
 +
Following entries define gauge-specific behavior. For the most part, each gauge has its own overrides that, if not defined, would otherwise use the global values.
 +
 +
{{Note|
 +
Please do not define non-custom gauges more than once within a ship class configuration group}}
 +
 +
Also, All gauges may take the optional string "default," to specify that default behavior should be used. In this case, retail resolutions (640x480 or 1024x768) for that particular gauge will be used (and the global resolutions will be ignored)
 +
  
 
====+Custom:====
 
====+Custom:====
 +
Adds a custom gauge type.
 +
  
 
=====Position:=====
 
=====Position:=====
−
*Screen coordinates for this gauge
+
Defines the screen coordinates for the upper left corner of this gauge.
−
*Syntax: '''(Integer, Integer)'''
+
 
 +
*Syntax: '''Integer''' horizontal pixel, '''Integer''' vertical pixel position
 +
 
  
 
=====Font:=====
 
=====Font:=====
−
*As per the global option above.
+
Optional. Overrides both the [[Hud_gagues.tbl#$Font: 1|$Font]] global option and the [[Hud_gauges#$Font: 2]] configuration option for only this particular gauge. If not defined, then [[Hud_gauges#$Font: 2|$Font]] will be used (if it is defined)
−
*Syntax: '''Integer'''
+
 
 +
*Syntax: '''Integer''' font index number
 +
*Valid Values: Any font index as defined in [[Fonts.tbl]]
 +
 
 +
=====Color:=====
 +
[[Hud_gagues.tbl#$Color: 1|$Color]] global option and the [[Hud_gauges#$Color: 2|$Color]] configuration option for only this particular gauge. If not defined, then [[Hud_gauges#$Color: 2|$Color]] will be used (if it is defined)
 +
 
 +
*Syntax: '''Integer''' Red, '''Integer''' Green, '''Integer''' Blue
 +
*Valid Values: 0 to 255
  
 +
 
=====Name:=====
 
=====Name:=====
−
*Name of this custom gauge.
+
Defines the name of this custom gauge.
−
*Syntax: '''String''', max length 32 characters
+
 
 +
*Syntax: '''String'''
 +
*Max Length: 32 characters
 +
 
  
 
=====Text:=====
 
=====Text:=====
−
*Default text to be displayed. Can be altered using the hud-set-message, hud-set-text and hud-set-directive sexps.
+
Default text to be displayed. Can be altered using the hud-set-message, hud-set-text and hud-set-directive sexps.
−
*Syntax: '''String''', max length 32 characters
+
 
 +
*Syntax: '''String'''
 +
*Max Length: 32 characters
 +
 
  
 
=====X Offset:=====
 
=====X Offset:=====
−
*Text will be displayed with an offset of x pixels from the gauge origin.
+
Optional. Defines the horizontal pixel offset (from the gauge's origin defined by [[Hud_gauges#$Position:]]) that the Text will be displayed.
 +
 
 
*Syntax: '''Integer'''
 
*Syntax: '''Integer'''
 +
*Units: Pixels
 +
  
 
=====Y Offset:=====
 
=====Y Offset:=====
−
*Text will be displayed with an offset of y pixels from the gauge origin.
+
Optional. Defines the vertical pixel offset (from the gauge's origin defined by [[Hud_gauges#$Position:]]) that the Text will be displayed.
 +
 
 
*Syntax: '''Integer'''
 
*Syntax: '''Integer'''
 +
*Units: Pixels
 +
  
 
=====Gauge Type:=====
 
=====Gauge Type:=====
−
*Each custom gauge must have a type.  
+
Defines the type of gauge this is.
−
*Syntax: '''String''', one of the possible [[gauge types]].
+
 
 +
*Syntax: '''String'''
 +
*Valid Values: Any one of the possible [[gauge types]].
 +
 
  
 
=====Slew:=====
 
=====Slew:=====
−
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
+
Optional. Determines whether or not this gauge is affected by afterburner shaking or similar effects. (May also follow the player's head movements when using TrackIR)
 +
 
 
*Syntax: '''Boolean'''
 
*Syntax: '''Boolean'''
  
−
=====Color:=====
 
−
*Optional. Defines the colour to use for this gauge.
 
−
*Syntax: '''Integer Integer Integer'''
 
  
 
=====Active by default:=====
 
=====Active by default:=====
−
*Optional. Whether this gauge is always active, or only available after being activated via sexp.
+
Optional. Determines whether or not this gauge is always active, or only available after being activated via sexp.
 +
 
 
*Syntax: '''Boolean'''
 
*Syntax: '''Boolean'''
 +
  
 
=====Filename:=====
 
=====Filename:=====
−
*Filename for the background graphic for this gauge
+
Designates the file used for this gauge's the background graphic
 +
 
 
*Syntax: '''Filename'''
 
*Syntax: '''Filename'''
 +
  
 
====+Messages:====  
 
====+Messages:====  
 +
Adds a gauge that display mission messages.
 +
  
 
=====Position:=====
 
=====Position:=====
−
*Screen coordinates for this gauge
+
Defines the screen coordinates for the upper left corner of this gauge.
−
*Syntax: '''(Integer, Integer)'''
+
 
 +
*Syntax: '''Integer''' horizontal pixel, '''Integer''' vertical pixel position
 +
 
  
 
=====Font:=====
 
=====Font:=====
−
*As per the global option above.
+
Optional. Overrides both the [[Hud_gagues.tbl#$Font: 1|$Font]] global option and the [[Hud_gauges#$Font: 2]] configuration option for only this particular gauge. If not defined, then [[Hud_gauges#$Font: 2|$Font]] will be used (if it is defined)
−
*Syntax: '''Integer'''
+
 
 +
*Syntax: '''Integer''' font index number
 +
*Valid Values: Any font index as defined in [[Fonts.tbl]]
 +
 
 +
 
 +
=====Color:=====
 +
[[Hud_gagues.tbl#$Color: 1|$Color]] global option and the [[Hud_gauges#$Color: 2|$Color]] configuration option for only this particular gauge. If not defined, then [[Hud_gauges#$Color: 2|$Color]] will be used (if it is defined)
 +
 
 +
*Syntax: '''Integer''' Red, '''Integer''' Green, '''Integer''' Blue
 +
*Valid Values: 0 to 255
 +
 
  
 
=====Slew:=====
 
=====Slew:=====
−
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
+
Optional. Determines whether or not this gauge is affected by afterburner shaking or similar effects. (May also follow the player's head movements when using TrackIR)
 +
 
 
*Syntax: '''Boolean'''
 
*Syntax: '''Boolean'''
 +
  
 
=====Max Lines:=====
 
=====Max Lines:=====
−
*Optional. Maximum number of message lines that are displayed.
+
Optional. Specifies the maximum number of message lines that are displayed.
−
*Syntax: '''Integer''', default is 3
+
 
 +
*Syntax: '''Integer'''
 +
*Default Value: 3
 +
 
  
 
=====Max Width:=====
 
=====Max Width:=====
−
*Optional. How many pixels the message lines may be long.
+
Optional. Determines how long each message line may be.
 +
 
 
*Syntax: '''Integer'''
 
*Syntax: '''Integer'''
 +
*Units: Pixels
 +
  
 
=====Line Height:=====
 
=====Line Height:=====
−
*Optional. Vertical separation between message lines in pixels.
+
Optional. Determines the distance between line origins. (i.g. for a 12pt Font, there are needs to be at least 12 pixels between the bottom of one line and the next, otherwise the text will overlap each)
 +
 
 
*Syntax: '''Integer'''
 
*Syntax: '''Integer'''
 +
*Units: Pixels
 +
*Default Value: 12
 +
  
 
=====Total Lifetime:=====
 
=====Total Lifetime:=====
−
*Optional. Message lifetime in milliseconds.
+
Optional. Determines the maximum time the message gauge will be displayed from the time a new message is received.
 +
 
 
*Syntax: '''Integer'''
 
*Syntax: '''Integer'''
 +
*Units: milliseconds
 +
*Default Value: 14000 (14 seconds)
 +
  
 
=====Scroll Time:=====
 
=====Scroll Time:=====
−
*Optional. Time to scroll one line.
+
Optional. Determines the time for the messages to scroll up one step.( See [[Hud_gauges.tbl#Step Size:]] )
 +
 
 
*Syntax: '''Integer'''
 
*Syntax: '''Integer'''
 +
*Units: milliseconds
 +
*Default Value: 30
 +
  
 
=====Step Size:=====
 
=====Step Size:=====
−
*Optional.
+
Optional. Determines how many pixels to shift message lines during scrolling. Messages will be shifted up by this amount until they are on the next line (as defined by [[Hud_gauges.tbl#Line Height:]])
 +
 
 
*Syntax: '''Integer'''
 
*Syntax: '''Integer'''
 +
*Units: Pixels
 +
*Default Value: 3
 +
  
 
====+Training Messages:====  
 
====+Training Messages:====  
 +
Adds a text box, like the ones seen in the FS1 and FS2 training missions.
 +
  
 
=====Position:=====
 
=====Position:=====
−
*Screen coordinates for this gauge
+
Defines the screen coordinates for the upper left corner of this gauge.
−
*Syntax: '''(Integer, Integer)'''
+
 
 +
*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
 +
*Units: Pixels
 +
 
  
 
=====Font:=====
 
=====Font:=====
−
*As per the global option above.
+
Optional. Overrides both the [[Hud_gagues.tbl#$Font: 1|$Font]] global option and the [[Hud_gauges#$Font: 2]] configuration option for only this particular gauge. If not defined, then [[Hud_gauges#$Font: 2|$Font]] will be used (if it is defined)
−
*Syntax: '''Integer''
+
 
 +
*Syntax: '''Integer''' font index number
 +
*Valid Values: Any font index as defined in [[Fonts.tbl]]
 +
 
 +
 
 +
====+Support:====
 +
Adds a text box that shows the Support ship's status and ETA
 +
 
 +
 
  
−
====+Support:====
 
 
=====Position:=====
 
=====Position:=====
−
*Screen coordinates for this gauge
+
Defines the screen coordinates for the upper left corner of this gauge.
−
*Syntax: '''(Integer, Integer)'''
+
 
 +
*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
 +
*Units: Pixels
 +
 
  
 
=====Font:=====
 
=====Font:=====
−
*As per the global option above.
+
Optional. Overrides both the [[Hud_gagues.tbl#$Font: 1|$Font]] global option and the [[Hud_gauges#$Font: 2]] configuration option for only this particular gauge. If not defined, then [[Hud_gauges#$Font: 2|$Font]] will be used (if it is defined)
−
*Syntax: '''Integer'''
+
 
 +
*Syntax: '''Integer''' font index number
 +
*Valid Values: Any font index as defined in [[Fonts.tbl]]
 +
 
  
 
=====Slew:=====
 
=====Slew:=====
−
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
+
Optional. Determines whether or not this gauge is affected by afterburner shaking or similar effects. (May also follow the player's head movements when using TrackIR)
 +
 
 
*Syntax: '''Boolean'''
 
*Syntax: '''Boolean'''
 +
  
 
=====Filename:=====
 
=====Filename:=====
−
*Filename for the background graphic for this gauge
+
Designates the file used for this gauge's the background graphic
 +
 
 
*Syntax: '''Filename'''
 
*Syntax: '''Filename'''
  
 
=====Header Offsets:=====
 
=====Header Offsets:=====
 +
Optional. Designates the offset from the gauge's upper left corner for the Support Ship header (?)
 +
 +
*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
 +
*Units: Pixels
 +
 +
 
=====Text Y-offset:=====
 
=====Text Y-offset:=====
 +
Optional. Designates the offset from the gauge's upper left corner for the Support Ship Text. (?)
 +
 +
*Syntax: '''Integer''' vertical offset
 +
*Units: Pixels
 +
 +
 
=====Dock Status X-offset:=====
 
=====Dock Status X-offset:=====
 +
Optional. Designates the offset from the gauge's upper left corner for the Support Ship's dock status. (?)
 +
 +
*Syntax: '''Integer''' vertical offset
 +
*Units: Pixels
 +
 +
 
=====Dock Time X-offset:=====
 
=====Dock Time X-offset:=====
 +
Optional. Designates the offset from the gauge's upper left corner for the Support Ship's dock time. (?)
 +
 +
*Syntax: '''Integer''' vertical offset
 +
*Units: Pixels
 +
  
 
====+Damage:====  
 
====+Damage:====  
 +
Adds a gauge that shows how much damage a target (or the player?) has.
 +
  
 
=====Position:=====
 
=====Position:=====
−
*Screen coordinates for this gauge
+
Defines the screen coordinates for the upper left corner of this gauge.
−
*Syntax: '''(Integer, Integer)'''
+
 
 +
*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
 +
*Units: Pixels
 +
 
  
 
=====Font:=====
 
=====Font:=====
−
*As per the global option above.
+
Optional. Overrides both the [[Hud_gagues.tbl#$Font: 1|$Font]] global option and the [[Hud_gauges#$Font: 2]] configuration option for only this particular gauge. If not defined, then [[Hud_gauges#$Font: 2|$Font]] will be used (if it is defined)
−
*Syntax: '''Integer'''
+
 
 +
*Syntax: '''Integer''' font index number
 +
*Valid Values: Any font index as defined in [[Fonts.tbl]]
 +
 
  
 
=====Slew:=====
 
=====Slew:=====
−
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
+
Optional. Determines whether or not this gauge is affected by afterburner shaking or similar effects. (May also follow the player's head movements when using TrackIR)
 +
 
 
*Syntax: '''Boolean'''
 
*Syntax: '''Boolean'''
 +
  
 
=====Top Background Filename:=====
 
=====Top Background Filename:=====
 +
Optional. Designates which file to use for the top background. (?)
 +
 +
*Syntax: '''Filename'''
 +
 +
 
=====Entry Background Filename:=====
 
=====Entry Background Filename:=====
 +
Optional. Designates which file to use for the Entry background (?)
 +
 +
*Syntax: '''Filename'''
 +
 +
 
=====Bottom Background Filename:=====
 
=====Bottom Background Filename:=====
 +
Optional. Designates which file to use for the Bottom background (?)
 +
 +
*Syntax: '''Filename'''
 +
 +
 
=====Header Offsets:=====
 
=====Header Offsets:=====
 +
Optional. Designates the offsets from the gauge's upper left corner for the for the Damage gauge header (?)
 +
 +
*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
 +
*Units: Pixels
 +
 +
 
=====Hull Integrity Offsets:=====
 
=====Hull Integrity Offsets:=====
 +
Optional. Designates the offsets from the gauge's upper left corner for the for the Damage gauge Hull integrity textbox(?)
 +
 +
*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
 +
*Units: Pixels
 +
 +
 
=====Hull Integrity Value X-offset:=====
 
=====Hull Integrity Value X-offset:=====
 +
Optional. Designates the offsets from the hull integrity textbox's upper left corner for the hull integrity value. (?)
 +
 +
*Syntax: '''Integer''' horizontal offset
 +
*Units: Pixels
 +
 +
 
=====Top Background Height:=====
 
=====Top Background Height:=====
 +
Optional. Designates the height of the Top background (?)
 +
 +
*Syntax: '''Integer'''
 +
*Units: Pixels
 +
 +
 
=====Subsystem Entry Height:=====
 
=====Subsystem Entry Height:=====
 +
Optional. Designates the height of the Subsystem entry (?)
 +
 +
*Syntax: '''Integer'''
 +
*Units: Pixels
 +
 +
 
=====Subsystem List Start Offsets:=====
 
=====Subsystem List Start Offsets:=====
 +
Optional. Designates the offsets from the gauge's upper left corner for the for the start of the Subsytem List (?)
 +
 +
*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
 +
*Units: Pixels
 +
 +
 
=====Subsystem Entry Value X-offset:=====
 
=====Subsystem Entry Value X-offset:=====
 +
Optional. Designates the horizontal offset from the Subsystem List's position (?)
 +
 +
*Syntax: '''Integer'''
 +
*Units: Pixels
 +
  
 
====+Wingman Status:====  
 
====+Wingman Status:====  

Revision as of 02:48, 16 July 2012

This feature requires FreeSpace Open

Revision information.....

FSO Revision: 9018
Note: Please update the version when the page is updated. If your edit had nothing to do with new code entries then please do not edit the version


hud_gauges.tbl is used for modifying the elements of the HUD. Not all gauges can be modified. However, custom gauges may be added to mimic their behavior (such as the wingman status display).

HUD Elements in FS2 are called Gauges, and each gauge has various options to customize appearance and, in some cases, their behavior as well.

This table is one of the Modular Tables and can be extended with xxx-hdg.tbm

NOTE: The following information is only applicable for builds based on Antipodes 7.


Contents

HUD Configurations

The following entries are used on the HUD system, but have not been grouped with any particular gauge.


$Load Retail Configuration:

Optional. If yes, any gauge missing from the HUD gauge definitions below will be loaded using the retail defaults.

If no, any missing (default) gauge will prompt an error.

  • Syntax: Boolean


$Color:

Optional. Sets the default HUD color for all gauges.

  • Sytax: Integer Red, Integer Green, Integer Blue
  • Valid Values: all values from 0 to 255


$Font:

Optional. Sets the font type to use for the HUD.

  • Syntax: Integer font index number
  • Valid Values: Any font index as defined in Fonts.tbl


$Max Directives:

Optional. Sets the default maximum number of directives displayed simultaneously.

  • Syntax: Integer maximum number of directives
  • Valid Values: Any positive number
  • Default Value: 5


$Max Escort Ships:

Optional. Sets the default maximum number of escort ships to be shown in the escort list.

  • Syntax: Integer
  • Valid Values: Any positive number
Warning: Entries more than 16 will cause the list to overflow into the weapons list for resolutions lower than 1024x768.


$Length Unit Multiplier:

Optional. Sets the multiplier to applied to the reported distances. For example, if the multiplier is 0.5, then the distance reported to the player will (or at least should) be 0.5 x actual distance.

  • Syntax: Float
  • Valid Values: Any positive number


$Speed Unit Multiplier:

Optional. Analogous to $Length Unit Multiplier, this sets the multiplier to be applied to all speeds reported to the player. For example, if the multiplier is 0.5, the the speed reported to the player will (or at least should) be 0.5 x actual speed.

  • Syntax: Float
  • Valid Values: Any positive number
  • Default Values:
The value used in $Length Unit Multiplier, or
1, if $Length Unit Multiplier is undefined


$Wireframe Targetbox:

Optional. Defines the default draw method for the target viewer (a.k.a. targetbox).

  • Syntax: Integer Draw method ID
  • Valid Values:
0 - Standard with full, bright lighting
1 - Wireframe
2 - Standard with proper lighting (i.e. lit the same as the actual target)
FS2 Open, 3.6.16:
3 - Untextured with full bright lighting (i.e. drawn with a single flat color)


$Targetbox Shader Effect:

FS2 Open, 3.6.16:

Optional. If set, defines a unique ID for a shader effect to be used when rendering a ship for the targeting box. The ID will be passed to the main shader as in #Ship_Effects, but a table entry for the effect is not needed.

  • Syntax: Integer
  • Valid Values: Any positive number


$Lock Wireframe Mode:

Optional. If set, prevents targetbox draw method from being changed during the gaming session.

  • Syntax: Boolean


$Reticle Style:

Optional. Defines which aiming reticle to use.

  • Syntax: String
  • Valid Values:
FS1 - uses reticle1_fs1.ani
FS2 - uses reticle1.ani


#Gauge Config

The following entries define default gauge appearance and behavior. Each gauge has the option of overriding these options.


$Ship:

Optional. If defined, the following config data will only be used if the player ship is of the supplied ship class. Can be defined multiple times within a #Gauge config group to allow unique HUD configurations per ship class.

If not defined, all following config data will be applied to all ships.

  • Syntax: String, ship class name


$Load Retail Configuration:

Optional. Overrides the $Load Retail Configuration global option for this ship class.

  • Syntax: Boolean


$Color:

Optional. Overrides the $Color global option for this ship class

  • Syntax: Integer Red, Integer Green, Integer Blue
  • Valid Values: 0 to 255


$Font:

Optional. Overrides the $Front global option for this ship class.

  • Syntax: Integer font index number
  • Valid Values: Any font index as defined in Fonts.tbl


$Base:

Defines the base resolution for this HUD configuration.

  • Syntax: (Integer width, Integer height)
  • Valid Values: All supported resolutions (?)


$Required Aspect:

Optional. If set, this configuration will only be loaded for the specified aspect ratios.

  • Syntax: String
  • Valid Values:
"Full Screen" (4:3)
"Wide Screen" (16:9, 16:10, or similar)


$Min:

Minimum resolution for this config. Any resolution lower than specified will not use this configuration.

  • Syntax: (Integer width, Integer height)
  • Valid Values: All supported resolutions (?)


$Max:

Maximum resolution for this config. Any resolution higher than specified will not use this configuration.

  • Syntax: (Integer width, Integer height)
  • Valid Values: All supported resolutions (?)


$Gauges:

Following entries define gauge-specific behavior. For the most part, each gauge has its own overrides that, if not defined, would otherwise use the global values.


Note: Please do not define non-custom gauges more than once within a ship class configuration group

Also, All gauges may take the optional string "default," to specify that default behavior should be used. In this case, retail resolutions (640x480 or 1024x768) for that particular gauge will be used (and the global resolutions will be ignored)


+Custom:

Adds a custom gauge type.


Position:

Defines the screen coordinates for the upper left corner of this gauge.

  • Syntax: Integer horizontal pixel, Integer vertical pixel position


Font:

Optional. Overrides both the $Font global option and the Hud_gauges#$Font: 2 configuration option for only this particular gauge. If not defined, then $Font will be used (if it is defined)

  • Syntax: Integer font index number
  • Valid Values: Any font index as defined in Fonts.tbl
Color:

$Color global option and the $Color configuration option for only this particular gauge. If not defined, then $Color will be used (if it is defined)

  • Syntax: Integer Red, Integer Green, Integer Blue
  • Valid Values: 0 to 255


Name:

Defines the name of this custom gauge.

  • Syntax: String
  • Max Length: 32 characters


Text:

Default text to be displayed. Can be altered using the hud-set-message, hud-set-text and hud-set-directive sexps.

  • Syntax: String
  • Max Length: 32 characters


X Offset:

Optional. Defines the horizontal pixel offset (from the gauge's origin defined by Hud_gauges#$Position:) that the Text will be displayed.

  • Syntax: Integer
  • Units: Pixels


Y Offset:

Optional. Defines the vertical pixel offset (from the gauge's origin defined by Hud_gauges#$Position:) that the Text will be displayed.

  • Syntax: Integer
  • Units: Pixels


Gauge Type:

Defines the type of gauge this is.

  • Syntax: String
  • Valid Values: Any one of the possible gauge types.


Slew:

Optional. Determines whether or not this gauge is affected by afterburner shaking or similar effects. (May also follow the player's head movements when using TrackIR)

  • Syntax: Boolean


Active by default:

Optional. Determines whether or not this gauge is always active, or only available after being activated via sexp.

  • Syntax: Boolean


Filename:

Designates the file used for this gauge's the background graphic

  • Syntax: Filename


+Messages:

Adds a gauge that display mission messages.


Position:

Defines the screen coordinates for the upper left corner of this gauge.

  • Syntax: Integer horizontal pixel, Integer vertical pixel position


Font:

Optional. Overrides both the $Font global option and the Hud_gauges#$Font: 2 configuration option for only this particular gauge. If not defined, then $Font will be used (if it is defined)

  • Syntax: Integer font index number
  • Valid Values: Any font index as defined in Fonts.tbl


Color:

$Color global option and the $Color configuration option for only this particular gauge. If not defined, then $Color will be used (if it is defined)

  • Syntax: Integer Red, Integer Green, Integer Blue
  • Valid Values: 0 to 255


Slew:

Optional. Determines whether or not this gauge is affected by afterburner shaking or similar effects. (May also follow the player's head movements when using TrackIR)

  • Syntax: Boolean


Max Lines:

Optional. Specifies the maximum number of message lines that are displayed.

  • Syntax: Integer
  • Default Value: 3


Max Width:

Optional. Determines how long each message line may be.

  • Syntax: Integer
  • Units: Pixels


Line Height:

Optional. Determines the distance between line origins. (i.g. for a 12pt Font, there are needs to be at least 12 pixels between the bottom of one line and the next, otherwise the text will overlap each)

  • Syntax: Integer
  • Units: Pixels
  • Default Value: 12


Total Lifetime:

Optional. Determines the maximum time the message gauge will be displayed from the time a new message is received.

  • Syntax: Integer
  • Units: milliseconds
  • Default Value: 14000 (14 seconds)


Scroll Time:

Optional. Determines the time for the messages to scroll up one step.( See Hud_gauges.tbl#Step Size: )

  • Syntax: Integer
  • Units: milliseconds
  • Default Value: 30


Step Size:

Optional. Determines how many pixels to shift message lines during scrolling. Messages will be shifted up by this amount until they are on the next line (as defined by Hud_gauges.tbl#Line Height:)

  • Syntax: Integer
  • Units: Pixels
  • Default Value: 3


+Training Messages:

Adds a text box, like the ones seen in the FS1 and FS2 training missions.


Position:

Defines the screen coordinates for the upper left corner of this gauge.

  • Syntax: Integer horizontal position, Integer vertical position
  • Units: Pixels


Font:

Optional. Overrides both the $Font global option and the Hud_gauges#$Font: 2 configuration option for only this particular gauge. If not defined, then $Font will be used (if it is defined)

  • Syntax: Integer font index number
  • Valid Values: Any font index as defined in Fonts.tbl


+Support:

Adds a text box that shows the Support ship's status and ETA


Position:

Defines the screen coordinates for the upper left corner of this gauge.

  • Syntax: Integer horizontal position, Integer vertical position
  • Units: Pixels


Font:

Optional. Overrides both the $Font global option and the Hud_gauges#$Font: 2 configuration option for only this particular gauge. If not defined, then $Font will be used (if it is defined)

  • Syntax: Integer font index number
  • Valid Values: Any font index as defined in Fonts.tbl


Slew:

Optional. Determines whether or not this gauge is affected by afterburner shaking or similar effects. (May also follow the player's head movements when using TrackIR)

  • Syntax: Boolean


Filename:

Designates the file used for this gauge's the background graphic

  • Syntax: Filename
Header Offsets:

Optional. Designates the offset from the gauge's upper left corner for the Support Ship header (?)

  • Syntax: Integer horizontal offset, Integer vertical offset
  • Units: Pixels


Text Y-offset:

Optional. Designates the offset from the gauge's upper left corner for the Support Ship Text. (?)

  • Syntax: Integer vertical offset
  • Units: Pixels


Dock Status X-offset:

Optional. Designates the offset from the gauge's upper left corner for the Support Ship's dock status. (?)

  • Syntax: Integer vertical offset
  • Units: Pixels


Dock Time X-offset:

Optional. Designates the offset from the gauge's upper left corner for the Support Ship's dock time. (?)

  • Syntax: Integer vertical offset
  • Units: Pixels


+Damage:

Adds a gauge that shows how much damage a target (or the player?) has.


Position:

Defines the screen coordinates for the upper left corner of this gauge.

  • Syntax: Integer horizontal position, Integer vertical position
  • Units: Pixels


Font:

Optional. Overrides both the $Font global option and the Hud_gauges#$Font: 2 configuration option for only this particular gauge. If not defined, then $Font will be used (if it is defined)

  • Syntax: Integer font index number
  • Valid Values: Any font index as defined in Fonts.tbl


Slew:

Optional. Determines whether or not this gauge is affected by afterburner shaking or similar effects. (May also follow the player's head movements when using TrackIR)

  • Syntax: Boolean


Top Background Filename:

Optional. Designates which file to use for the top background. (?)

  • Syntax: Filename


Entry Background Filename:

Optional. Designates which file to use for the Entry background (?)

  • Syntax: Filename


Bottom Background Filename:

Optional. Designates which file to use for the Bottom background (?)

  • Syntax: Filename


Header Offsets:

Optional. Designates the offsets from the gauge's upper left corner for the for the Damage gauge header (?)

  • Syntax: Integer horizontal offset, Integer vertical offset
  • Units: Pixels


Hull Integrity Offsets:

Optional. Designates the offsets from the gauge's upper left corner for the for the Damage gauge Hull integrity textbox(?)

  • Syntax: Integer horizontal offset, Integer vertical offset
  • Units: Pixels


Hull Integrity Value X-offset:

Optional. Designates the offsets from the hull integrity textbox's upper left corner for the hull integrity value. (?)

  • Syntax: Integer horizontal offset
  • Units: Pixels


Top Background Height:

Optional. Designates the height of the Top background (?)

  • Syntax: Integer
  • Units: Pixels


Subsystem Entry Height:

Optional. Designates the height of the Subsystem entry (?)

  • Syntax: Integer
  • Units: Pixels


Subsystem List Start Offsets:

Optional. Designates the offsets from the gauge's upper left corner for the for the start of the Subsytem List (?)

  • Syntax: Integer horizontal offset, Integer vertical offset
  • Units: Pixels


Subsystem Entry Value X-offset:

Optional. Designates the horizontal offset from the Subsystem List's position (?)

  • Syntax: Integer
  • Units: Pixels


+Wingman Status:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Slew:
  • Optional. Whether this gauge is affected by afterburner shaking or similar effects.
  • Syntax: Boolean
Left Background Filename:
Entry Background Filename:
Right Background Filename:
Dot Filename:
Header Offsets:
Left Background Width:
Entry Width:
Single Wing Offsets:
Multiple Wing Start Offsets:
Wing Name Offsets:
Dot Offsets:
Expansion Mode:

+Auto Speed:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Slew:
  • Optional. Whether this gauge is affected by afterburner shaking or similar effects.
  • Syntax: Boolean
Filename:
Auto Offsets:
Speed Offsets:

+Auto Target:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Slew:
  • Optional. Whether this gauge is affected by afterburner shaking or similar effects.
  • Syntax: Boolean
Auto Offsets:
Target Offsets:

+Countermeasures:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Slew:
  • Optional. Whether this gauge is affected by afterburner shaking or similar effects.
  • Syntax: Boolean
Text Offsets:
Value Offsets:

+Talking Head:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Filename:
Header Offsets:
Animation Offsets:
Animation Background Size:

+Directives:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Slew:
  • Optional. Whether this gauge is affected by afterburner shaking or similar effects.
  • Syntax: Boolean
Top Background Filename:
Entry Background Filename:
Bottom Background Filename:
Header Offsets:
Top Background Height:
List Start Offsets:
Entry Height:

+Weapons:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Slew:
  • Optional. Whether this gauge is affected by afterburner shaking or similar effects.
  • Syntax: Boolean
Top Background Filename:
Entry Background Filename:
Bottom Background Filename:
Header Offsets:
List Start Offsets:
Top Background Height:
Entry Height:
Command X-offset:
Page Up Offsets:
Page Down Offsets:

+Lag:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Slew:
  • Optional. Whether this gauge is affected by afterburner shaking or similar effects.
  • Syntax: Boolean
Filename:
  • Filename for the background graphic for this gauge
  • Syntax: Filename

+Mini Target Shields:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Slew:
  • Optional. Whether this gauge is affected by afterburner shaking or similar effects.
  • Syntax: Boolean
Filename:
  • Filename for the background graphic for this gauge
  • Syntax: Filename
3 Digit Hull Offsets:
2 Digit Hull Offsets:
1 Digit Hull Offsets:

+Player Shields:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Slew:
  • Optional. Whether this gauge is affected by afterburner shaking or similar effects.
  • Syntax: Boolean

+Target Shields:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Slew:
  • Optional. Whether this gauge is affected by afterburner shaking or similar effects.
  • Syntax: Boolean

+Escort View:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Slew:
  • Optional. Whether this gauge is affected by afterburner shaking or similar effects.
  • Syntax: Boolean
Top Background Filename:
Entry Background Filename:
Bottom Background Filename:
Entry Height:
Entry Stagger Width:
Header Text:
Header Offsets:
List Start Offsets:
Hull X-offset:
Name X-offset:
Status X-offset:

+Mission Time:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Slew:
  • Optional. Whether this gauge is affected by afterburner shaking or similar effects.
  • Syntax: Boolean
Filename:
  • Filename for the background graphic for this gauge
  • Syntax: Filename
Text Offsets:
Value Offsets:

+ETS Retail:

FS2 Open, 3.6.14:

Draws the three other ETS gauges as a single gauge. Will rearrange itself (like retail) if shields or other systems are missing. SVN 8830

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Slew:
  • Optional. Whether this gauge is affected by afterburner shaking or similar effects.
  • Syntax: Boolean
Filename:
  • Filename for the background graphic for this gauge
  • Syntax: Filename
Foreground Clip Height:
Letter Offsets:
Top Offsets:
Bottom Offsets:
Gauge Offset:
  • Distance between the individual weapon/shield/engine ETS gauges that comprise this gauge
  • Syntax: Integer

+ETS Weapons:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Slew:
  • Optional. Whether this gauge is affected by afterburner shaking or similar effects.
  • Syntax: Boolean
Filename:
  • Filename for the background graphic for this gauge
  • Syntax: Filename
Foreground Clip Height:
Letter Offsets:
Top Offsets:
Bottom Offsets:

+ETS Engines:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Slew:
  • Optional. Whether this gauge is affected by afterburner shaking or similar effects.
  • Syntax: Boolean
Filename:
  • Filename for the background graphic for this gauge
  • Syntax: Filename
Foreground Clip Height:
Letter Offsets:
Top Offsets:
Bottom Offsets:

+ETS Shields:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Slew:
  • Optional. Whether this gauge is affected by afterburner shaking or similar effects.
  • Syntax: Boolean
Filename:
  • Filename for the background graphic for this gauge
  • Syntax: Filename
Foreground Clip Height:
Letter Offsets:
Top Offsets:
Bottom Offsets:

+Target Monitor:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Monitor Filename:
Integrity Bar Filename:
Viewport Offsets:
Viewport Size:
Integrity Bar Offsets:
Integrity Bar Foreground Clip Height:
Status Offsets:
Name Offsets:
Class Offsets:
Distance Offsets:
Speed Offsets:
Hull Offsets:
Cargo Contents Offsets:
Cargo Scan Start Offsets:
Cargo Scan Size:

+Extra Target Data:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Slew:
  • Optional. Whether this gauge is affected by afterburner shaking or similar effects.
  • Syntax: Boolean
Filename:
  • Filename for the background graphic for this gauge
  • Syntax: Filename
Bracket Offsets:
Dock Offsets:
Order Offsets:
Time Offsets:

+Radar:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Filename:
  • Filename for the background graphic for this gauge
  • Syntax: Filename
Infinity Distance Offsets:
Long Distance Offsets:
Short Distance Offsets:

+Radar Orb:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Filename:
  • Filename for the background graphic for this gauge
  • Syntax: Filename
Infinity Distance Offsets:
Long Distance Offsets:
Short Distance Offsets:

+Radar BSG:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Size:
XY Disc Filename:
XZ YZ Disc Filename:
Sweep Disc Filename:
Default Contact Filename:
Unknown Contact Filename:
Cockpit Target:
Canvas Size:
Display Offset:
Display Size:

+Afterburner Energy:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Slew:
  • Optional. Whether this gauge is affected by afterburner shaking or similar effects.
  • Syntax: Boolean
Filename:
  • Filename for the background graphic for this gauge
  • Syntax: Filename
Foreground Clip Height:

+Weapon Energy:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Slew:
  • Optional. Whether this gauge is affected by afterburner shaking or similar effects.
  • Syntax: Boolean
Filename:
  • Filename for the background graphic for this gauge
  • Syntax: Filename
Foreground Clip Height:
Text Offsets:

+Text Warnings:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Slew:
  • Optional. Whether this gauge is affected by afterburner shaking or similar effects.
  • Syntax: Boolean

+Center Reticle:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Filename:
  • Filename for the background graphic for this gauge
  • Syntax: Filename
Firepoint display:
  • Displays the positions of the gun firepoints on your ship
  • Syntax: Boolean, YES or NO
Firepoint size:
  • Diameter of the gunpoint circles. Must be 4 or greater in order to work properly.
  • Syntax: Integer
Firepoint X coordinate multiplier:
Firepoint Y coordinate multiplier:

+Throttle:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Slew:
  • Optional. Whether this gauge is affected by afterburner shaking or similar effects.
  • Syntax: Boolean
Filename:
  • Filename for the background graphic for this gauge
  • Syntax: Filename
Foreground Clip Bottom Y-offset:
Foreground Clip Width:
Foreground Clip Height:
Afterburner Clip Height:
Show Background:
Max Speed Label Offsets:
Min Speed Label Offsets:
Orbit Center Offsets:
Orbit Radius:

+Threat Indicator:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Slew:
  • Optional. Whether this gauge is affected by afterburner shaking or similar effects.
  • Syntax: Boolean
Arc Filename:
  • Filename for the background graphic for this gauge
  • Syntax: Filename
Dumbfire Filename:
  • Filename for the background graphic for this gauge
  • Syntax: Filename
Lock Filename:
  • Filename for the background graphic for this gauge
  • Syntax: Filename
Dumbfire Offsets:
  • Filename for the background graphic for this gauge
  • Syntax: Filename
Lock Offsets:
  • Filename for the background graphic for this gauge
  • Syntax: Filename

+Multiplayer Messages:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer

+Voice Status:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Slew:
  • Optional. Whether this gauge is affected by afterburner shaking or similar effects.
  • Syntax: Boolean

+Ping:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Slew:
  • Optional. Whether this gauge is affected by afterburner shaking or similar effects.
  • Syntax: Boolean

+Supernova:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Slew:
  • Optional. Whether this gauge is affected by afterburner shaking or similar effects.
  • Syntax: Boolean

+Lock Indicator:

Font:
  • As per the global option above.
  • Syntax: Integer
Lock Filename:
Locked Filename:
Lock Center Offsets:
Locked Center Offsets:

+Offscreen Indicator:

Font:
  • As per the global option above.
  • Syntax: Integer

+Target Brackets:

Font:
  • As per the global option above.
  • Syntax: Integer
Dot Filename:

+Hostile Triangle:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Slew:
  • Optional. Whether this gauge is affected by afterburner shaking or similar effects.
  • Syntax: Boolean
Radius:
Triangle Base:
Triangle Height:

+Target Triangle:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Slew:
  • Optional. Whether this gauge is affected by afterburner shaking or similar effects.
  • Syntax: Boolean
Radius:
Triangle Base:
Triangle Height:

+Missile Triangles:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Slew:
  • Optional. Whether this gauge is affected by afterburner shaking or similar effects.
  • Syntax: Boolean
Radius:
Triangle Base:
Triangle Height:

+Lead Indicator:

Font:
  • As per the global option above.
  • Syntax: Integer
Filename:
  • Filename for the background graphic for this gauge
  • Syntax: Filename
Center Offsets:

+Orientation Tee:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Slew:
  • Optional. Whether this gauge is affected by afterburner shaking or similar effects.
  • Syntax: Boolean
Radius:

+Lead Sight:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Filename:
  • Filename for the background graphic for this gauge
  • Syntax: Filename

+Kills:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Slew:
  • Optional. Whether this gauge is affected by afterburner shaking or similar effects.
  • Syntax: Boolean
Filename:
  • Filename for the background graphic for this gauge
  • Syntax: Filename
Text Offsets:
Value Offsets:

+Weapon Linking:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Slew:
  • Optional. Whether this gauge is affected by afterburner shaking or similar effects.
  • Syntax: Boolean
Arc Filename:
Single Primary Filename:
Double Primary Filename:
Single Secondary Filename:
Double Secondary Filename:
Triple Secondary Filename:
Single Primary Offsets:
Double Primary Offsets:
Single Secondary Offsets:
Double Secondary Offsets:
Triple Secondary Offsets:

+Fixed Messages:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Retrieved from "https://wiki.hard-light.net/index.php?title=Hud_gauges.tbl&oldid=38981"