Difference between revisions of "Hud gauges.tbl"

From FreeSpace Wiki
Jump to: navigation, search
(Major update to reflect changes in Antipodes 7.)
Line 1: Line 1:
 
{{SCP table}}
 
{{SCP table}}
  
{{TableVersion|5211|5234}}
+
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.
 +
 
 +
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==
 +
 
 +
===$Load Retail Configuration:===
 +
*If yes, any gauge missing from the HUD gauge definitions below will be loaded using the retail defaults.
 +
*Syntax: '''Boolean'''
 +
 
 +
===$Font:===
 +
*Which font to use for the HUD.
 +
*Syntax: '''Integer''', font index as defined in fonts.tbl
 +
 
 +
===$Max Directives:===
 +
*Maximum number of directives displayed simultaneously.
 +
*Syntax: '''Integer''', default is 5.
 +
 
 +
===$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.
 +
*Syntax: '''Integer'''
 +
 
 +
===$Length Unit Multiplier:===
 +
*Defines the multiplier used for scaling the distances reported to the player in the game
 +
*Syntax: '''Float'''
 +
 
 +
===$Speed Unit Multiplier:===
 +
*Analogous to the above, this multiplier is applied to all speeds reported to the player
 +
*Syntax: '''Float''', if nothing else is defined, this is set to the same value as the length unit multiplier above
 +
 
 +
===$Wireframe Targetbox:===
 +
*Defines the default draw method for the targetbox
 +
*Syntax: '''Integer'''
 +
**Options:
 +
::* '''0''' - Standard
 +
::* '''1''' - Wireframe
 +
::* '''2''' - Wireframe with textures NOT ACTUALLY IMPLEMENTED!
 +
 
 +
 
 +
===$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.
 +
*Syntax: '''Boolean'''
 +
 
 +
 
 +
===$Reticle Style:===
 +
*Selection for display type of the Reticle.
 +
*Syntax: '''String'''
 +
**Options:
 +
::* '''FS1''' - uses '''''reticle1_fs1.ani'''''
 +
::* '''FS2''' - uses '''''reticle1.ani'''''
 +
 
 +
==$Gauge Config==
 +
 
 +
===$Ship:===
 +
*Optional. If set, the following config data will only be used if the player ship is of the supplied ship class
 +
*Syntax: '''String''', the ship class name
 +
 
 +
====$Load Retail Configuration:====
 +
*As per the global option above.
 +
*Syntax: '''Boolean'''
 +
 
 +
====$Font:====
 +
*As per the global option above.
 +
*Syntax: '''Integer'''
 +
 
 +
===$Base:===
 +
*Base resolution for this config.
 +
*Syntax: '''(Integer, Integer)'''
 +
 
 +
===$Required Aspect:===
 +
*Optional. If set, this configuration will only be loaded for widescreen or square resolutions.
 +
*Syntax: '''String''', either "Full Screen" or "Wide Screen".
 +
 
 +
===$Min:===
 +
*Minimum resolution for this config.
 +
*Syntax: '''(Integer, Integer)'''
 +
 
 +
===$Max:===
 +
*Maximum resolution for this config.
 +
*Syntax: '''(Integer, Integer)'''
 +
 
 +
===$Gauges:===
 +
 
 +
====+Custom:====
 +
 
 +
=====Position:=====
 +
*Screen coordinates for this gauge
 +
*Syntax: '''(Integer, Integer)'''
 +
 
 +
=====Font:=====
 +
*As per the global option above.
 +
*Syntax: '''Integer'''
 +
 
 +
=====Name:=====
 +
*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:=====
 +
*Text will be displayed with an offset of x pixels from the gauge origin.
 +
*Syntax: '''Integer'''
 +
 
 +
=====Y Offset:=====
 +
*Text will be displayed with an offset of y pixels from the gauge origin.
 +
*Syntax: '''Integer'''
 +
 
 +
=====Gauge Type:=====
 +
*Each custom gauge must have a type.
 +
*Syntax: '''String''', one of the possible [[gauge types]].
 +
 
 +
=====Slew:=====
 +
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
 +
*Syntax: '''Boolean'''
 +
 
 +
=====Color:=====
 +
*Optional. Defines the colour to use for this gauge.
 +
*Syntax: '''Integer Integer Integer'''
 +
 
 +
=====Active by default:=====
 +
*Optional. Whether this gauge is always active, or only available after being activated via sexp.
 +
*Syntax: '''Boolean'''
 +
 
 +
=====Filename:=====
 +
*Filename for the background graphic for this gauge
 +
*Syntax: '''Filename'''
 +
 
 +
====+Messages:====
 +
 
 +
=====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'''
 +
 
 +
=====Max Lines:=====
 +
*Optional. Maximum number of message lines that are displayed.
 +
*Syntax: '''Integer''', default is 3
 +
 
 +
=====Max Width:=====
 +
*Optional. How many pixels the message lines may be long.
 +
*Syntax: '''Integer'''
 +
 
 +
=====Line Height:=====
 +
*Optional. Vertical separation between message lines in pixels.
 +
*Syntax: '''Integer'''
 +
 
 +
=====Total Lifetime:=====
 +
*Optional. Message lifetime in milliseconds.
 +
*Syntax: '''Integer'''
 +
 
 +
=====Scroll Time:=====
 +
*Optional. Time to scroll one line.
 +
*Syntax: '''Integer'''
 +
 
 +
=====Step Size:=====
 +
*Optional.
 +
*Syntax: '''Integer'''
 +
 
 +
====+Training Messages:====
 +
 
 +
=====Position:=====
 +
*Screen coordinates for this gauge
 +
*Syntax: '''(Integer, Integer)'''
 +
 
 +
=====Font:=====
 +
*As per the global option above.
 +
*Syntax: '''Integer''
 +
 
 +
====+Support:====
 +
=====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'''
 +
 
 +
=====Header Offsets:=====
 +
=====Text Y-offset:=====
 +
=====Dock Status X-offset:=====
 +
=====Dock Time X-offset:=====
 +
 
 +
====+Damage:====
 +
 
 +
=====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:=====
 +
=====Hull Integrity Offsets:=====
 +
=====Hull Integrity Value X-offset:=====
 +
=====Top Background Height:=====
 +
=====Subsystem Entry Height:=====
 +
=====Subsystem List Start Offsets:=====
 +
=====Subsystem Entry Value X-offset:=====
 +
 
 +
====+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'''
 +
 
 +
=====Primary List Top Background Filename:=====
 +
=====Alt Ballistic Filename:=====
 +
=====Primary List Middle Background Filename:=====
 +
=====Alt Ballistic Filename:=====
 +
=====Primary List Bottom Background Filename:=====
 +
=====Alt Ballistic Filename:=====
 +
=====Secondary List Top Background Filename:=====
 +
=====Alt Ballistic Filename:=====
 +
=====Secondary List Entry Background Filename:=====
 +
=====Alt Ballistic Filename:=====
 +
=====Secondary List Bottom Background Filename:=====
 +
=====Alt Ballistic Filename:=====
 +
=====Header Offsets:=====
 +
=====Alt Ballistic Offsets:=====
 +
=====Top Primary Background X-offset:=====
 +
=====Alt Ballistic X-offset:=====
 +
=====Text X-offset:=====
 +
=====Alt Ballistic X-offset:=====
 +
=====Top Primary Frame Height:=====
 +
=====Top Secondary Frame Height:=====
 +
=====Primary List Start Y-offset:=====
 +
=====Secondary List Start Y-offset:=====
 +
=====Primary Weapon Ammo X-offset:=====
 +
=====Primary Weapon Link X-offset:=====
 +
=====Primary Weapon Name X-offset:=====
 +
=====Secondary Weapon Ammo X-offset:=====
 +
=====Secondary Weapon Unlinked X-offset:=====
 +
=====Secondary Weapon Linked X-offset:=====
 +
=====Secondary Weapon Name X-offset:=====
 +
=====Secondary Weapon Reload X-offset:=====
 +
=====Primary Weapon Entry Height:=====
 +
=====Secondary Weapon Entry Height:=====
 +
 
 +
====+Objective Notify:====
 +
=====Position:=====
 +
*Screen coordinates for this gauge
 +
*Syntax: '''(Integer, Integer)'''
 +
 
 +
=====Font:=====
 +
*As per the global option above.
 +
*Syntax: '''Integer'''
 +
 
 +
=====Filename:=====
 +
=====Infinity Distance Offsets:=====
 +
=====Long Distance Offsets:=====
 +
=====Short Distance Offsets:=====
 +
 
 +
====+Squad Message:====
 +
{{SCP table}}
  
 
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. 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.
 +
 +
NOTE: The following information is only applicable for builds based on Antipodes 7.
  
 
==Gauge system overview==
 
==Gauge system overview==
  
*Many of the gauges in FreeSpace 2 are made up of individual images and text. To allow easy editing, these have been broken up into main gauges and child gauges. '''Main gauges''' (aka parent gauges) are a standalone part of the HUD, and may be one gauge or a collection of gauges. '''Child gauges''' are gauges that are dependant upon another gauge's position.
+
*HUD Elements in FS2 are called Gauges. Each gauge has various options to customize appearance and, in some cases, gauge behaviour.
*For example, in the center of the screen of FreeSpace 2, there is a gauge that tells you your target's hull strength and shield status. The text is a child gauge, and the shield quadrant is a child gauge. Both of these together make up the main gauge. So, to move both to the corner, you would simply change the position of the main gauge.
+
 
*Finally, '''all coordinates are measured in pixels from the upper-left corner of the screen.''' (100 50) is 100 pixels to the right and 50 pixels down; this may seem unnatural at first, but it the standard way to describe screen coordinates and easy to get used to.
+
==Table Contents==
 +
 
 +
===$Load Retail Configuration:===
 +
*If yes, any gauge missing from the HUD gauge definitions below will be loaded using the retail defaults.
 +
*Syntax: '''Boolean'''
 +
 
 +
===$Font:===
 +
*Which font to use for the HUD.
 +
*Syntax: '''Integer''', font index as defined in fonts.tbl
 +
 
 +
===$Max Directives:===
 +
*Maximum number of directives displayed simultaneously.
 +
*Syntax: '''Integer''', default is 5.
 +
 
 +
===$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.
 +
*Syntax: '''Integer'''
  
==Sections overview==
+
===$Length Unit Multiplier:===
 +
*Defines the multiplier used for scaling the distances reported to the player in the game
 +
*Syntax: '''Float'''
  
*hud_gauges.tbl contains six sections, the most of any table in FreeSpace. They are:
+
===$Speed Unit Multiplier:===
**[[#Table Contents|Miscellaneous variables]]
+
*Analogous to the above, this multiplier is applied to all speeds reported to the player
***All miscellaneous variables go at the top of the hud_gauges.tbl file.
+
*Syntax: '''Float''', if nothing else is defined, this is set to the same value as the length unit multiplier above
**[[##Custom Gauges|#Custom Gauges]]
+
 
***This is where all custom gauges (and their default attributes) are defined. This includes any child gauges you want to define.
+
===$Wireframe Targetbox:===
**[[##Main Gauges|#Main Gauges]]
+
*Defines the default draw method for the targetbox
***Used to set the attributes of the Main HUD gauges, such as the escort list or the shield status display or any custom main gauge you have defined.
+
*Syntax: '''Integer'''
**[[##Gauges|#Gauges]]
+
**Options:
***Used to set individual child gauges' attributes.
+
::* '''0''' - Standard
**[[##Ship Main Gauges|#Ship Main Gauges]]
+
::* '''1''' - Wireframe
***Same as the <nowiki>#</nowiki>Main Gauges section, except it's used for overrides to the gauges for specific ships.
+
::* '''2''' - Wireframe with textures NOT ACTUALLY IMPLEMENTED!
**[[##Ship Gauges|#Ship Gauges]]
+
 
***Again, this is the same as the <nowiki>#</nowiki>Gauges section, except for individual ship overrides.
+
 
 +
===$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.
 +
*Syntax: '''Boolean'''
 +
 
 +
 
 +
===$Reticle Style:===
 +
*Selection for display type of the Reticle.
 +
*Syntax: '''String'''
 +
**Options:
 +
::* '''FS1''' - uses '''''reticle1_fs1.ani'''''
 +
::* '''FS2''' - uses '''''reticle1.ani'''''
 +
 
 +
==$Gauge Config==
 +
 
 +
===$Ship:===
 +
*Optional. If set, the following config data will only be used if the player ship is of the supplied ship class
 +
*Syntax: '''String''', the ship class name
 +
 
 +
====$Load Retail Configuration:====
 +
*As per the global option above.
 +
*Syntax: '''Boolean'''
 +
 
 +
====$Font:====
 +
*As per the global option above.
 +
*Syntax: '''Integer'''
 +
 
 +
===$Base:===
 +
*Base resolution for this config.
 +
*Syntax: '''(Integer, Integer)'''
 +
 
 +
===$Required Aspect:===
 +
*Optional. If set, this configuration will only be loaded for widescreen or square resolutions.
 +
*Syntax: '''String''', either "Full Screen" or "Wide Screen".
 +
 
 +
===$Min:===
 +
*Minimum resolution for this config.
 +
*Syntax: '''(Integer, Integer)'''
 +
 
 +
===$Max:===
 +
*Maximum resolution for this config.
 +
*Syntax: '''(Integer, Integer)'''
 +
 
 +
===$Gauges:===
 +
 
 +
====+Custom:====
 +
 
 +
=====Position:=====
 +
*Screen coordinates for this gauge
 +
*Syntax: '''(Integer, Integer)'''
 +
 
 +
=====Font:=====
 +
*As per the global option above.
 +
*Syntax: '''Integer'''
 +
 
 +
=====Name:=====
 +
*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:=====
 +
*Text will be displayed with an offset of x pixels from the gauge origin.
 +
*Syntax: '''Integer'''
 +
 
 +
=====Y Offset:=====
 +
*Text will be displayed with an offset of y pixels from the gauge origin.
 +
*Syntax: '''Integer'''
 +
 
 +
=====Gauge Type:=====
 +
*Each custom gauge must have a type.
 +
*Syntax: '''String''', one of the possible [[gauge types]].
 +
 
 +
=====Slew:=====
 +
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
 +
*Syntax: '''Boolean'''
 +
 
 +
=====Color:=====
 +
*Optional. Defines the colour to use for this gauge.
 +
*Syntax: '''Integer Integer Integer'''
 +
 
 +
=====Active by default:=====
 +
*Optional. Whether this gauge is always active, or only available after being activated via sexp.
 +
*Syntax: '''Boolean'''
 +
 
 +
=====Filename:=====
 +
*Filename for the background graphic for this gauge
 +
*Syntax: '''Filename'''
 +
 
 +
====+Messages:====
 +
 
 +
=====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'''
 +
 
 +
=====Max Lines:=====
 +
*Optional. Maximum number of message lines that are displayed.
 +
*Syntax: '''Integer''', default is 3
 +
 
 +
=====Max Width:=====
 +
*Optional. How many pixels the message lines may be long.
 +
*Syntax: '''Integer'''
 +
 
 +
=====Line Height:=====
 +
*Optional. Vertical separation between message lines in pixels.
 +
*Syntax: '''Integer'''
 +
 
 +
=====Total Lifetime:=====
 +
*Optional. Message lifetime in milliseconds.
 +
*Syntax: '''Integer'''
 +
 
 +
=====Scroll Time:=====
 +
*Optional. Time to scroll one line.
 +
*Syntax: '''Integer'''
 +
 
 +
=====Step Size:=====
 +
*Optional.
 +
*Syntax: '''Integer'''
 +
 
 +
====+Training Messages:====
 +
 
 +
=====Position:=====
 +
*Screen coordinates for this gauge
 +
*Syntax: '''(Integer, Integer)'''
 +
 
 +
=====Font:=====
 +
*As per the global option above.
 +
*Syntax: '''Integer''
 +
 
 +
====+Support:====
 +
=====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'''
 +
 
 +
=====Header Offsets:=====
 +
=====Text Y-offset:=====
 +
=====Dock Status X-offset:=====
 +
=====Dock Time X-offset:=====
 +
 
 +
====+Damage:====
 +
 
 +
=====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:=====
 +
=====Hull Integrity Offsets:=====
 +
=====Hull Integrity Value X-offset:=====
 +
=====Top Background Height:=====
 +
=====Subsystem Entry Height:=====
 +
=====Subsystem List Start Offsets:=====
 +
=====Subsystem Entry Value X-offset:=====
 +
 
 +
====+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 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 Shields:====
 +
{{SCP table}}
 +
 
 +
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.
 +
 
 +
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==
 
==Table Contents==
 +
 +
===$Load Retail Configuration:===
 +
*If yes, any gauge missing from the HUD gauge definitions below will be loaded using the retail defaults.
 +
*Syntax: '''Boolean'''
 +
 +
===$Font:===
 +
*Which font to use for the HUD.
 +
*Syntax: '''Integer''', font index as defined in fonts.tbl
 +
 +
===$Max Directives:===
 +
*Maximum number of directives displayed simultaneously.
 +
*Syntax: '''Integer''', default is 5.
  
 
===$Max Escort Ships:===
 
===$Max Escort Ships:===
{{Table3610|
 
 
*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.
 
*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.
*Syntax: '''Integer''', from 1 to 20}}
+
*Syntax: '''Integer'''
 +
 
 +
===$Length Unit Multiplier:===
 +
*Defines the multiplier used for scaling the distances reported to the player in the game
 +
*Syntax: '''Float'''
 +
 
 +
===$Speed Unit Multiplier:===
 +
*Analogous to the above, this multiplier is applied to all speeds reported to the player
 +
*Syntax: '''Float''', if nothing else is defined, this is set to the same value as the length unit multiplier above
 +
 
 +
===$Wireframe Targetbox:===
 +
*Defines the default draw method for the targetbox
 +
*Syntax: '''Integer'''
 +
**Options:
 +
::* '''0''' - Standard
 +
::* '''1''' - Wireframe
 +
::* '''2''' - Wireframe with textures NOT ACTUALLY IMPLEMENTED!
 +
 
 +
 
 +
===$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.
 +
*Syntax: '''Boolean'''
 +
 
 +
 
 +
===$Reticle Style:===
 +
*Selection for display type of the Reticle.
 +
*Syntax: '''String'''
 +
**Options:
 +
::* '''FS1''' - uses '''''reticle1_fs1.ani'''''
 +
::* '''FS2''' - uses '''''reticle1.ani'''''
 +
 
 +
==$Gauge Config==
 +
 
 +
===$Ship:===
 +
*Optional. If set, the following config data will only be used if the player ship is of the supplied ship class
 +
*Syntax: '''String''', the ship class name
  
 +
====$Load Retail Configuration:====
 +
*As per the global option above.
 +
*Syntax: '''Boolean'''
 +
 +
====$Font:====
 +
*As per the global option above.
 +
*Syntax: '''Integer'''
 +
 +
===$Base:===
 +
*Base resolution for this config.
 +
*Syntax: '''(Integer, Integer)'''
 +
 +
===$Required Aspect:===
 +
*Optional. If set, this configuration will only be loaded for widescreen or square resolutions.
 +
*Syntax: '''String''', either "Full Screen" or "Wide Screen".
 +
 +
===$Min:===
 +
*Minimum resolution for this config.
 +
*Syntax: '''(Integer, Integer)'''
 +
 +
===$Max:===
 +
*Maximum resolution for this config.
 +
*Syntax: '''(Integer, Integer)'''
 +
 +
===$Gauges:===
 +
 +
====+Custom:====
 +
 +
=====Position:=====
 +
*Screen coordinates for this gauge
 +
*Syntax: '''(Integer, Integer)'''
 +
 +
=====Font:=====
 +
*As per the global option above.
 +
*Syntax: '''Integer'''
 +
 +
=====Name:=====
 +
*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:=====
 +
*Text will be displayed with an offset of x pixels from the gauge origin.
 +
*Syntax: '''Integer'''
 +
 +
=====Y Offset:=====
 +
*Text will be displayed with an offset of y pixels from the gauge origin.
 +
*Syntax: '''Integer'''
 +
 +
=====Gauge Type:=====
 +
*Each custom gauge must have a type.
 +
*Syntax: '''String''', one of the possible [[gauge types]].
 +
 +
=====Slew:=====
 +
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
 +
*Syntax: '''Boolean'''
 +
 +
=====Color:=====
 +
*Optional. Defines the colour to use for this gauge.
 +
*Syntax: '''Integer Integer Integer'''
 +
 +
=====Active by default:=====
 +
*Optional. Whether this gauge is always active, or only available after being activated via sexp.
 +
*Syntax: '''Boolean'''
 +
 +
=====Filename:=====
 +
*Filename for the background graphic for this gauge
 +
*Syntax: '''Filename'''
 +
 +
====+Messages:====
 +
 +
=====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'''
 +
 +
=====Max Lines:=====
 +
*Optional. Maximum number of message lines that are displayed.
 +
*Syntax: '''Integer''', default is 3
 +
 +
=====Max Width:=====
 +
*Optional. How many pixels the message lines may be long.
 +
*Syntax: '''Integer'''
 +
 +
=====Line Height:=====
 +
*Optional. Vertical separation between message lines in pixels.
 +
*Syntax: '''Integer'''
 +
 +
=====Total Lifetime:=====
 +
*Optional. Message lifetime in milliseconds.
 +
*Syntax: '''Integer'''
 +
 +
=====Scroll Time:=====
 +
*Optional. Time to scroll one line.
 +
*Syntax: '''Integer'''
 +
 +
=====Step Size:=====
 +
*Optional.
 +
*Syntax: '''Integer'''
 +
 +
====+Training Messages:====
 +
 +
=====Position:=====
 +
*Screen coordinates for this gauge
 +
*Syntax: '''(Integer, Integer)'''
 +
 +
=====Font:=====
 +
*As per the global option above.
 +
*Syntax: '''Integer''
 +
 +
====+Support:====
 +
=====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'''
 +
 +
=====Header Offsets:=====
 +
=====Text Y-offset:=====
 +
=====Dock Status X-offset:=====
 +
=====Dock Time X-offset:=====
 +
 +
====+Damage:====
 +
 +
=====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:=====
 +
=====Hull Integrity Offsets:=====
 +
=====Hull Integrity Value X-offset:=====
 +
=====Top Background Height:=====
 +
=====Subsystem Entry Height:=====
 +
=====Subsystem List Start Offsets:=====
 +
=====Subsystem Entry Value X-offset:=====
 +
 +
====+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'''
 +
 +
=====Primary List Top Background Filename:=====
 +
=====Alt Ballistic Filename:=====
 +
=====Primary List Middle Background Filename:=====
 +
=====Alt Ballistic Filename:=====
 +
=====Primary List Bottom Background Filename:=====
 +
=====Alt Ballistic Filename:=====
 +
=====Secondary List Top Background Filename:=====
 +
=====Alt Ballistic Filename:=====
 +
=====Secondary List Entry Background Filename:=====
 +
=====Alt Ballistic Filename:=====
 +
=====Secondary List Bottom Background Filename:=====
 +
=====Alt Ballistic Filename:=====
 +
=====Header Offsets:=====
 +
=====Alt Ballistic Offsets:=====
 +
=====Top Primary Background X-offset:=====
 +
=====Alt Ballistic X-offset:=====
 +
=====Text X-offset:=====
 +
=====Alt Ballistic X-offset:=====
 +
=====Top Primary Frame Height:=====
 +
=====Top Secondary Frame Height:=====
 +
=====Primary List Start Y-offset:=====
 +
=====Secondary List Start Y-offset:=====
 +
=====Primary Weapon Ammo X-offset:=====
 +
=====Primary Weapon Link X-offset:=====
 +
=====Primary Weapon Name X-offset:=====
 +
=====Secondary Weapon Ammo X-offset:=====
 +
=====Secondary Weapon Unlinked X-offset:=====
 +
=====Secondary Weapon Linked X-offset:=====
 +
=====Secondary Weapon Name X-offset:=====
 +
=====Secondary Weapon Reload X-offset:=====
 +
=====Primary Weapon Entry Height:=====
 +
=====Secondary Weapon Entry Height:=====
 +
 +
====+Objective Notify:====
 +
=====Position:=====
 +
*Screen coordinates for this gauge
 +
*Syntax: '''(Integer, Integer)'''
 +
 +
=====Font:=====
 +
*As per the global option above.
 +
*Syntax: '''Integer'''
 +
 +
=====Filename:=====
 +
=====Infinity Distance Offsets:=====
 +
=====Long Distance Offsets:=====
 +
=====Short Distance Offsets:=====
 +
 +
====+Squad Message:====
 +
{{SCP table}}
 +
 +
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.
 +
 +
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==
 +
 +
===$Load Retail Configuration:===
 +
*If yes, any gauge missing from the HUD gauge definitions below will be loaded using the retail defaults.
 +
*Syntax: '''Boolean'''
 +
 +
===$Font:===
 +
*Which font to use for the HUD.
 +
*Syntax: '''Integer''', font index as defined in fonts.tbl
 +
 +
===$Max Directives:===
 +
*Maximum number of directives displayed simultaneously.
 +
*Syntax: '''Integer''', default is 5.
 +
 +
===$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.
 +
*Syntax: '''Integer'''
  
 
===$Length Unit Multiplier:===
 
===$Length Unit Multiplier:===
{{Table3610|
+
*Defines the multiplier used for scaling the distances reported to the player in the game
*Defines the multiplier used for scaling the distances and speeds reported to the player in the game
+
*Syntax: '''Float'''
*Syntax: '''Float'''}}
 
  
 +
===$Speed Unit Multiplier:===
 +
*Analogous to the above, this multiplier is applied to all speeds reported to the player
 +
*Syntax: '''Float''', if nothing else is defined, this is set to the same value as the length unit multiplier above
  
 
===$Wireframe Targetbox:===
 
===$Wireframe Targetbox:===
{{Table3611|
 
 
*Defines the default draw method for the targetbox
 
*Defines the default draw method for the targetbox
 
*Syntax: '''Integer'''
 
*Syntax: '''Integer'''
Line 48: Line 1,339:
 
::* '''0''' - Standard
 
::* '''0''' - Standard
 
::* '''1''' - Wireframe
 
::* '''1''' - Wireframe
::* '''2''' - Wireframe with textures}}
+
::* '''2''' - Wireframe with textures NOT ACTUALLY IMPLEMENTED!
  
  
 
===$Lock Wireframe Mode:===
 
===$Lock Wireframe Mode:===
{{Table3611|
 
 
*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.
 
*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.
*Syntax: '''Boolean'''}}
+
*Syntax: '''Boolean'''
  
  
 
===$Reticle Style:===
 
===$Reticle Style:===
{{Table3610|
 
 
*Selection for display type of the Reticle.
 
*Selection for display type of the Reticle.
 
*Syntax: '''String'''
 
*Syntax: '''String'''
 
**Options:  
 
**Options:  
 
::* '''FS1''' - uses '''''reticle1_fs1.ani'''''
 
::* '''FS1''' - uses '''''reticle1_fs1.ani'''''
::* '''FS2''' - uses '''''reticle1.ani'''''}}
+
::* '''FS2''' - uses '''''reticle1.ani'''''
 +
 
 +
==$Gauge Config==
 +
 
 +
===$Ship:===
 +
*Optional. If set, the following config data will only be used if the player ship is of the supplied ship class
 +
*Syntax: '''String''', the ship class name
 +
 
 +
====$Load Retail Configuration:====
 +
*As per the global option above.
 +
*Syntax: '''Boolean'''
 +
 
 +
====$Font:====
 +
*As per the global option above.
 +
*Syntax: '''Integer'''
 +
 
 +
===$Base:===
 +
*Base resolution for this config.
 +
*Syntax: '''(Integer, Integer)'''
 +
 
 +
===$Required Aspect:===
 +
*Optional. If set, this configuration will only be loaded for widescreen or square resolutions.
 +
*Syntax: '''String''', either "Full Screen" or "Wide Screen".
 +
 
 +
===$Min:===
 +
*Minimum resolution for this config.
 +
*Syntax: '''(Integer, Integer)'''
 +
 
 +
===$Max:===
 +
*Maximum resolution for this config.
 +
*Syntax: '''(Integer, Integer)'''
  
 +
===$Gauges:===
  
==#Custom Gauges==
+
====+Custom:====
*Custom Gauges are easy to use, and incredibly powerful with the hud-set SEXPs. Initially, they are completely blank; in order to see them you must set their text or image variable in one of the Gauges sections. In order to define a new custom gauge, only the name field is needed:
 
  
===$Name:===
+
=====Position:=====
{{Table3610|*What the name of the custom gauge will be
+
*Screen coordinates for this gauge
*Syntax: '''String''', up to 32 characters
+
*Syntax: '''(Integer, Integer)'''
  
 +
=====Font:=====
 +
*As per the global option above.
 +
*Syntax: '''Integer'''
  
*'''+Default640x:'''
+
=====Name:=====
**The Default X coordinate of the gauge in 640x480
+
*Name of this custom gauge.
**Syntax: '''Integer'''
+
*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
  
*'''+Default640y:'''
+
=====X Offset:=====
**The Default Y coordinate in 640x480
+
*Text will be displayed with an offset of x pixels from the gauge origin.
**Syntax: '''Integer'''
+
*Syntax: '''Integer'''
  
 +
=====Y Offset:=====
 +
*Text will be displayed with an offset of y pixels from the gauge origin.
 +
*Syntax: '''Integer'''
  
*'''+Default1024x:'''
+
=====Gauge Type:=====
**The Default X coordinate in 1024x768
+
*Each custom gauge must have a type.
**Syntax: '''Integer'''
+
*Syntax: '''String''', one of the possible [[gauge types]].
  
 +
=====Slew:=====
 +
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
 +
*Syntax: '''Boolean'''
  
*'''+Default1024y:'''
+
=====Color:=====
**The Default Y coordinate in 1024x768
+
*Optional. Defines the colour to use for this gauge.
**Syntax: '''Integer'''
+
*Syntax: '''Integer Integer Integer'''
  
 +
=====Active by default:=====
 +
*Optional. Whether this gauge is always active, or only available after being activated via sexp.
 +
*Syntax: '''Boolean'''
  
*'''+Parent:'''
+
=====Filename:=====
**The parent gauge of the new custom gauge. Only main gauges that can already be manipulated in this table or custom gauges that you defined can be used as a parent gauge.
+
*Filename for the background graphic for this gauge
**Syntax: '''String''', up to 32 characters}}
+
*Syntax: '''Filename'''
  
 +
====+Messages:====
  
==#Main Gauges==
+
=====Position:=====
*Each list of main gauge definitions can start with one of two strings - $Resolution and $Default. A list started with $Resolution will only be used if the resolution FreeSpace 2 is started in is exactly the same as $Resolution. $Default lists will be loaded regardless of the resolution.
+
*Screen coordinates for this gauge
*In other words, a list starting with $Resolution: (1024 768) will only be used in 1024 768. However, a list starting with $Default: (640 480) will be scaled to any resolution, regardless of what the current resolution is. These tags are NOT additive.
+
*Syntax: '''(Integer, Integer)'''
*To have gauges be an absolute distance from the upper-left corner of the screen, regardless of resolution, use $Default: (0 0).
 
*Finally, gauges are loaded from first to last in the listing of resolution-specific and default gauge lists, so if any valid gauge settings are defined more than once, the last setting will be used. This means that $Default lists '''should always come first''', so that resolution-specific settings will override them, rather than the other way around.
 
*If any later definition that matches has some settings missing that an earlier definition set, those will be overridden with defaults. The previous settings will NOT be used.
 
  
===$Default:===
+
=====Font:=====
{{Table3610|
+
*As per the global option above.
*Defines what resolution coordinates are given in and scale them to the current resolution appropriately. If (0 0) is given, coordinates are assumed to be absolute numbers of pixels from the upper-left corner of the screen no matter what resolution is used in fs2_open.
+
*Syntax: '''Integer'''
*Syntax: ( '''Integer''' '''Integer''' )
 
**Tip: Set to (100 100) to set coordinates using percentages.}}
 
  
 +
=====Slew:=====
 +
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
 +
*Syntax: '''Boolean'''
  
===$Resolution:===
+
=====Max Lines:=====
{{Table3610|
+
*Optional. Maximum number of message lines that are displayed.
*Tells fs2_open that coordinates are for the specified resolution and that resolution only. These will not be used or scaled if the resolution fs2_open is started in is different.
+
*Syntax: '''Integer''', default is 3
*Syntax: ( '''Integer''' '''Integer''' )}}
 
  
 +
=====Max Width:=====
 +
*Optional. How many pixels the message lines may be long.
 +
*Syntax: '''Integer'''
  
====$<Gauge name>:====
+
=====Line Height:=====
{{Table3610|
+
*Optional. Vertical separation between message lines in pixels.
*Where ''<Gauge name>'' is the name of the gauge (can be a custom gauge) you want to move, moves the upper-left corner of the gauge to the specified position.
+
*Syntax: '''Integer'''
*Syntax: ( '''Float''' '''FloatInteger''' )
 
*'''List of known supported retail gauges''': 
 
::* '''Player Shield'''
 
::* '''Target Shield'''
 
::* '''Shield Mini'''
 
::* '''Afterburner Energy'''
 
::* '''Weapons Energy'''
 
::* '''Escort List'''
 
  
 +
=====Total Lifetime:=====
 +
*Optional. Message lifetime in milliseconds.
 +
*Syntax: '''Integer'''
  
*'''+Size:'''
+
=====Scroll Time:=====
**Defines the size of the gauge; usually not needed, unless the gauge should be centered (see +Percentage below).
+
*Optional. Time to scroll one line.
**Size and Percentage must always be specifed together for size to have an effect.
+
*Syntax: '''Integer'''
**Syntax: ( '''Integer''' '''Integer''' )
 
  
 +
=====Step Size:=====
 +
*Optional.
 +
*Syntax: '''Integer'''
  
*'''+Percentage:'''
+
====+Training Messages:====
**Moves the the gauge by the given percent (100.0 is 100%) of the screen size. If a size was specified (see +Size above) the '''center''' will be moved to this position. This is added onto the original coordinates given for the gauge. This means if you specify the coordinates (0 0) and as a percentage (50.0 50.0) the gauge's upper left corner will be positioned on the screen center.
 
**If additionally you specified the size, then the gauge's center is positioned on the screen center. If you specified (5 5) as coordinates then the center is moved 5 to the right and 5 below the center of the screen.
 
**Size and Percentage must always be specifed together for size to have an effect.
 
**Syntax: ( '''Float''' '''Float''' )
 
  
 +
=====Position:=====
 +
*Screen coordinates for this gauge
 +
*Syntax: '''(Integer, Integer)'''
  
*'''+Image:'''
+
=====Font:=====
**What image or animation the gauge should use. If set for a custom gauge, this image will always be displayed at the gauge's coordinates unless a SEXP is called.
+
*As per the global option above.
**Syntax: '''Filename''', up to 32 characters
+
*Syntax: '''Integer''
  
 +
====+Support:====
 +
=====Position:=====
 +
*Screen coordinates for this gauge
 +
*Syntax: '''(Integer, Integer)'''
  
*'''+Text:'''
+
=====Font:=====
**What text the gauge should use. If set for a custom gauge, the text will always be shown unless a SEXP is used.
+
*As per the global option above.
**Syntax: '''String''', up to 32 characters, although the limit varies for retail gauges
+
*Syntax: '''Integer'''
  
 +
=====Slew:=====
 +
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
 +
*Syntax: '''Boolean'''
  
*'''+Color:'''
+
=====Filename:=====
**What color the gauge's image or text should be.
+
*Filename for the background graphic for this gauge
**Syntax: Three '''Integers''', from 0 to 255; red, blue and green respectively}}
+
*Syntax: '''Filename'''
  
 +
=====Header Offsets:=====
 +
=====Text Y-offset:=====
 +
=====Dock Status X-offset:=====
 +
=====Dock Time X-offset:=====
  
==#Gauges==
+
====+Damage:====  
  
===$Default:===
+
=====Position:=====
{{Table3610|
+
*Screen coordinates for this gauge
*Defines what resolution coordinates are given in and scale them to the current resolution appropriately. If (0 0) is given, coordinates are assumed to be absolute numbers of pixels from the upper-left corner of the screen no matter what resolution is used in fs2_open.
+
*Syntax: '''(Integer, Integer)'''
*Syntax: ( '''Integer''' '''Integer''' )}}
 
  
===$Resolution:===
+
=====Font:=====
{{Table3610|
+
*As per the global option above.
*Defines the resolution for the draw data
+
*Syntax: '''Integer'''
**Syntax: ( '''Integer''' '''Integer''' )
 
  
===$Gauge:===
+
=====Slew:=====
{{Table3610|
+
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
*Defines the name of gauge
+
*Syntax: '''Boolean'''
**Syntax: '''String'''}}
 
  
*'''+Size:'''
+
=====Top Background Filename:=====
**Defines the size of the gauge; usually not needed, unless the gauge should be centered (see +Percentage below).
+
=====Entry Background Filename:=====
**Size and Percentage must always be specifed together for size to have an effect.
+
=====Bottom Background Filename:=====
**Syntax: ( '''Integer''' '''Integer''' )
+
=====Header Offsets:=====
 +
=====Hull Integrity Offsets:=====
 +
=====Hull Integrity Value X-offset:=====
 +
=====Top Background Height:=====
 +
=====Subsystem Entry Height:=====
 +
=====Subsystem List Start Offsets:=====
 +
=====Subsystem Entry Value X-offset:=====
  
 +
====+Wingman Status:====
 +
=====Position:=====
 +
*Screen coordinates for this gauge
 +
*Syntax: '''(Integer, Integer)'''
  
*'''+Percentage:'''
+
=====Font:=====
**Moves the the gauge by the given percent (100.0 is 100%) of the screen size. If a size was specified (see +Size above) the '''center''' will be moved to this position. This is added onto the original coordinates given for the gauge. This means if you specify the coordinates (0 0) and as a percentage (50.0 50.0) the gauge's upper left corner will be positioned on the screen center.
+
*As per the global option above.
**If additionally you specified the size, then the gauge's center is positioned on the screen center. If you specified (5 5) as coordinates then the center is moved 5 to the right and 5 below the center of the screen.
+
*Syntax: '''Integer'''
**Size and Percentage must always be specifed together for size to have an effect.
 
**Syntax: ( '''Float''' '''Float''' )
 
  
 +
=====Slew:=====
 +
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
 +
*Syntax: '''Boolean'''
  
*'''+Image:'''
+
=====Left Background Filename:=====
**What image or animation the gauge should use. If set for a custom gauge, this image will always be displayed at the gauge's coordinates unless a SEXP is called.
+
=====Entry Background Filename:=====
**Syntax: '''Filename''', up to 32 characters
+
=====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)'''
  
*'''+Text:'''
+
=====Font:=====
**What text the gauge should use. If set for a custom gauge, the text will always be shown unless a SEXP is used.
+
*As per the global option above.
**Syntax: '''String''', up to 32 characters, although the limit varies for retail gauges
+
*Syntax: '''Integer'''
  
 +
=====Slew:=====
 +
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
 +
*Syntax: '''Boolean'''
  
*'''+Color:'''
+
=====Filename:=====
**What color the gauge's image or text should be.
+
=====Auto Offsets:=====
**Syntax: Three '''Integers''', from 0 to 255; red, blue and green respectively}}
+
=====Speed Offsets:=====
  
 +
====+Auto Target:====
 +
=====Position:=====
 +
*Screen coordinates for this gauge
 +
*Syntax: '''(Integer, Integer)'''
  
==#Ship Main Gauges==
+
=====Font:=====
Basically the same as the <nowiki>#</nowiki>Main Gauges Section, the Ship Main Gauges adds a new variable - $Ship. This defines which ship the specified changes will apply to. So, if you set $Ship as "GTF Ulysses", whenever the player flies the Ulysses, s/he will see the HUD changes.
+
*As per the global option above.
'''IMPORTANT: Only $Default or $Resolution may be defined, NOT both.'''
+
*Syntax: '''Integer'''
  
===$Ship:===
+
=====Slew:=====
{{Table3610|
+
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
*Defines what ship class HUD attributes will apply to.
+
*Syntax: '''Boolean'''
*Syntax: '''String''', up to 32 characters}}
+
 
 +
=====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 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:=====
 +
=====Firepoint size:=====
 +
=====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'''
  
===$Default:===
+
====+Supernova:====
{{Table3610|
+
=====Position:=====
*Defines what resolution coordinates are given in and scale them to the current resolution appropriately. If (0 0) is given, coordinates are assumed to be absolute numbers of pixels from the upper-left corner of the screen no matter what resolution is used in fs2_open.
+
*Screen coordinates for this gauge
*Syntax: ( '''Integer''' '''Integer''' )
+
*Syntax: '''(Integer, Integer)'''
**Tip: Set to (100 100) to set coordinates using percentages.}}
 
  
 +
=====Font:=====
 +
*As per the global option above.
 +
*Syntax: '''Integer'''
  
===$Resolution:===
+
=====Slew:=====
{{Table3610|
+
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
*Tells fs2_open that coordinates are for the specified resolution and that resolution only. These will not be used or scaled if the resolution fs2_open is started in is different.
+
*Syntax: '''Boolean'''
*Syntax: ( '''Integer''' '''Integer''' )}}
+
 
 +
====+Lock Indicator:====
 +
=====Font:=====
 +
*As per the global option above.
 +
*Syntax: '''Integer'''
  
 +
=====Lock Filename:=====
 +
=====Locked Filename:=====
 +
=====Lock Center Offsets:=====
 +
=====Locked Center Offsets:=====
  
====$<Gauge name>:====
+
====+Offscreen Indicator:====
{{Table3610|
+
=====Font:=====
*Where ''<Gauge name>'' is the name of the gauge you want to move, moves the upper-left corner of the gauge to the specified position.
+
*As per the global option above.
*Syntax: ( '''Float''' '''FloatInteger''' )
+
*Syntax: '''Integer'''
*'''List of known supported retail gauges''': 
 
::* '''Player Shield'''
 
::* '''Target Shield'''
 
::* '''Shield Mini'''
 
::* '''Afterburner Energy'''
 
::* '''Weapons Energy'''
 
::* '''Escort List'''
 
  
 +
====+Target Brackets:====
 +
=====Font:=====
 +
*As per the global option above.
 +
*Syntax: '''Integer'''
  
*'''+Size:'''
+
=====Dot Filename:=====
**Defines the size of the gauge; usually not needed, unless the gauge should be centered (see +Percentage below).
 
**Size and Percentage must always be specifed together for size to have an effect. Their values cannot be inherited from the default gauges as their effect is calculated on the fly. They have to be specifed for each ship individually,
 
**Syntax: ( '''Integer''' '''Integer''' )
 
  
 +
====+Hostile Triangle:====
 +
=====Position:=====
 +
*Screen coordinates for this gauge
 +
*Syntax: '''(Integer, Integer)'''
  
*'''+Percentage:'''
+
=====Font:=====
**Moves the the gauge by the given percent (100.0 is 100%) of the screen size. If a size was specified (see +Size above) the '''center''' will be moved to this position. This is added onto the original coordinates given for the gauge. This means if you specify the coordinates (0 0) and as a percentage (50.0 50.0) the gauge's upper left corner will be positioned on the screen center.
+
*As per the global option above.
**If additionally you specified the size, then the gauge's center is positioned on the screen center. If you specified (5 5) as coordinates then the center is moved 5 to the right and 5 below the center of the screen.
+
*Syntax: '''Integer'''
**Size and Percentage must always be specifed together for size to have an effect. Their values cannot be inherited from the default gauges as their effect is calculated on the fly. They have to be specifed for each ship individually,
 
**Syntax: ( '''Float''' '''Float''' )
 
  
 +
=====Slew:=====
 +
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
 +
*Syntax: '''Boolean'''
  
*'''+Image:'''
+
=====Radius:=====
**What image or animation the gauge should use. If set for a custom gauge, this image will always be displayed at the gauge's coordinates unless a SEXP is called.
+
=====Triangle Base:=====
**Syntax: '''Filename''', up to 32 characters
+
=====Triangle Height:=====
  
 +
====+Target Triangle:====
 +
=====Position:=====
 +
*Screen coordinates for this gauge
 +
*Syntax: '''(Integer, Integer)'''
  
*'''+Text:'''
+
=====Font:=====
**What text the gauge should use. If set for a custom gauge, the text will always be shown unless a SEXP is used.
+
*As per the global option above.
**Syntax: '''String''', up to 32 characters, although the limit varies for retail gauges
+
*Syntax: '''Integer'''
  
 +
=====Slew:=====
 +
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
 +
*Syntax: '''Boolean'''
  
*'''+Color:'''
+
=====Radius:=====
**What color the gauge's image or text should be.
+
=====Triangle Base:=====
**Syntax: Three '''Integers''', from 0 to 255; red, blue and green respectively}}
+
=====Triangle Height:=====
  
==#Ship Gauges==
+
====+Missile Triangles:====
 +
=====Position:=====
 +
*Screen coordinates for this gauge
 +
*Syntax: '''(Integer, Integer)'''
  
===$Ship:===
+
=====Font:=====
{{Table3610|
+
*As per the global option above.
*Defines the name of the ship
+
*Syntax: '''Integer'''
**Syntax: '''String'''}}
 
  
 +
=====Slew:=====
 +
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
 +
*Syntax: '''Boolean'''
  
===$Default:===
+
=====Radius:=====
{{Table3610|
+
=====Triangle Base:=====
*Defines what resolution coordinates are given in and scale them to the current resolution appropriately. If (0 0) is given, coordinates are assumed to be absolute numbers of pixels from the upper-left corner of the screen no matter what resolution is used in fs2_open.
+
=====Triangle Height:=====
*Syntax: ( '''Integer''' '''Integer''' )}}
 
  
===$Resolution:===
+
====+Lead Indicator:====
{{Table3610|
+
=====Font:=====
*Defines the resolution for the draw data
+
*As per the global option above.
**Syntax: ( '''Integer''' '''Integer''' )
+
*Syntax: '''Integer'''
  
 +
=====Filename:=====
 +
*Filename for the background graphic for this gauge
 +
*Syntax: '''Filename'''
  
===$Gauge:===
+
=====Center Offsets:=====
{{Table3610|
 
*Defines the name of gauge
 
**Syntax: '''String'''}}
 
  
 +
====+Orientation Tee:====
 +
=====Position:=====
 +
*Screen coordinates for this gauge
 +
*Syntax: '''(Integer, Integer)'''
  
*'''+Size:'''
+
=====Font:=====
**Defines the size of the gauge; usually not needed, unless the gauge should be centered (see +Percentage below).
+
*As per the global option above.
**Size and Percentage must always be specifed together for size to have an effect. Their values cannot be inherited from the default gauges as their effect is calculated on the fly. They have to be specifed for each ship individually,
+
*Syntax: '''Integer'''
**Syntax: ( '''Integer''' '''Integer''' )
 
  
 +
=====Slew:=====
 +
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
 +
*Syntax: '''Boolean'''
  
*'''+Percentage:'''
+
=====Radius:=====
**Moves the the gauge by the given percent (100.0 is 100%) of the screen size. If a size was specified (see +Size above) the '''center''' will be moved to this position. This is added onto the original coordinates given for the gauge. This means if you specify the coordinates (0 0) and as a percentage (50.0 50.0) the gauge's upper left corner will be positioned on the screen center.
 
**If additionally you specified the size, then the gauge's center is positioned on the screen center. If you specified (5 5) as coordinates then the center is moved 5 to the right and 5 below the center of the screen.
 
**Size and Percentage must always be specifed together for size to have an effect. Their values cannot be inherited from the default gauges as their effect is calculated on the fly. They have to be specifed for each ship individually,
 
**Syntax: ( '''Float''' '''Float''' )
 
  
 +
====+Lead Sight:====
 +
=====Position:=====
 +
*Screen coordinates for this gauge
 +
*Syntax: '''(Integer, Integer)'''
  
*'''+Image:'''
+
=====Font:=====
**What image or animation the gauge should use. If set for a custom gauge, this image will always be displayed at the gauge's coordinates unless a SEXP is called.
+
*As per the global option above.
**Syntax: '''Filename''', up to 32 characters
+
*Syntax: '''Integer'''
  
 +
=====Filename:=====
 +
*Filename for the background graphic for this gauge
 +
*Syntax: '''Filename'''
  
*'''+Text:'''
+
====+Kills:====
**What text the gauge should use. If set for a custom gauge, the text will always be shown unless a SEXP is used.
+
=====Position:=====
**Syntax: '''String''', up to 32 characters, although the limit varies for retail gauges
+
*Screen coordinates for this gauge
 +
*Syntax: '''(Integer, Integer)'''
  
 +
=====Font:=====
 +
*As per the global option above.
 +
*Syntax: '''Integer'''
  
*'''+Color:'''
+
=====Slew:=====
**What color the gauge's image or text should be.
+
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
**Syntax: Three '''Integers''', from 0 to 255; red, blue and green respectively}}
+
*Syntax: '''Boolean'''
  
 +
=====Filename:=====
 +
*Filename for the background graphic for this gauge
 +
*Syntax: '''Filename'''
  
==Minimal Example==
+
=====Text Offsets:=====
  $Max Escort Ships: 15
+
=====Value Offsets:=====
  
==Example==
+
====+Weapon Linking:====
*it runs, but not entirely sure if all of it is working properly; this is a copy-paste from somewhere else... someone please update
+
=====Position:=====
<pre>
+
*Screen coordinates for this gauge
  $Max Escort Ships: 15
+
*Syntax: '''(Integer, Integer)'''
 
 
  #Custom Gauges
 
    $Name: MyParentGauge
 
        +Default1024x: 100
 
        +Default1024y: 100
 
        +Parent:
 
    $Name: MyChildGauge
 
        +Default1024x: 10
 
        +Default1024y: 5
 
        +Parent: MyParentGauge
 
  #End
 
  
  #Main Gauges
+
=====Font:=====
    $Default:                 (1024 768)
+
*As per the global option above.
        $Player Shield:         (694 670)
+
*Syntax: '''Integer'''
        $Target Shield:         (232 670)
+
 
        $MyParentGauge:         (100 100)
+
=====Slew:=====
    $Resolution:               (1024 768)
+
*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
        $Escort List:           (865 330)
+
*Syntax: '''Boolean'''
            +Image: escort1
+
 
  #End
+
=====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:=====
  
  #Gauges
+
====+Fixed Messages:====
    $Default:                  (1024 768)       
+
=====Position:=====
        $Gauge: MyParentGauge
+
*Screen coordinates for this gauge
            $MyChildGauge:      (347 219)
+
*Syntax: '''(Integer, Integer)'''
                +Image:          child_image
 
                +Color:         175 230 175
 
    $Resolution:               (1024 768)
 
        $Gauge: Escort List
 
            $Header Text:       (4 1)
 
                +Text: Monitoring
 
            $List:              (0 13)
 
            $Ship:              (0 11)
 
                +Image:          escort2
 
            $Last Ship:          (0 11)
 
                +Image:          escort3
 
            $Ship Name:          (4 0)
 
            $Ship Hull:          (116 0)
 
            $Ship Status:        (-11 0)
 
  #End
 
  
  #Ship Main Gauges
+
=====Font:=====
    $Ship: WhateverShip 107A
+
*As per the global option above.
        $Default:              (1024 768)
+
*Syntax: '''Integer'''
            $Player Shield:     (694 670)
 
            $Target Shield:      (232 670)
 
            $MyParentGauge:      (100 100)
 
    $Ship: WhateverShip 105B
 
        $Default:              (1024 768)
 
            $Player Shield:      (694 623)
 
            $Target Shield:      (211 670)
 
            $MyParentGauge:      (100 150)
 
  #End
 
  
  #Ship Gauges
 
    $Ship: WhateverShip 107A
 
        $Default:              (1024 768)       
 
            $Gauge: MyParentGauge
 
                $MyChildGauge:  (347 219)
 
                    +Image:      child_image
 
                    +Color:      175 230 175
 
    $Ship: WhateverShip 105B
 
        $Default:              (1024 768)       
 
            $Gauge: MyParentGauge
 
                $MyChildGauge:  (347 219)
 
                    +Image:      child_image
 
                    +Color:      175 230 175
 
  #End
 
 
 
</pre>
 
 
[[Category:Tables]]
 
[[Category:Tables]]

Revision as of 03:10, 11 December 2010

This feature requires FreeSpace Open

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.

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

Contents

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

$Load Retail Configuration:

  • If yes, any gauge missing from the HUD gauge definitions below will be loaded using the retail defaults.
  • Syntax: Boolean

$Font:

  • Which font to use for the HUD.
  • Syntax: Integer, font index as defined in fonts.tbl

$Max Directives:

  • Maximum number of directives displayed simultaneously.
  • Syntax: Integer, default is 5.

$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.
  • Syntax: Integer

$Length Unit Multiplier:

  • Defines the multiplier used for scaling the distances reported to the player in the game
  • Syntax: Float

$Speed Unit Multiplier:

  • Analogous to the above, this multiplier is applied to all speeds reported to the player
  • Syntax: Float, if nothing else is defined, this is set to the same value as the length unit multiplier above

$Wireframe Targetbox:

  • Defines the default draw method for the targetbox
  • Syntax: Integer
    • Options:
  • 0 - Standard
  • 1 - Wireframe
  • 2 - Wireframe with textures NOT ACTUALLY IMPLEMENTED!


$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.
  • Syntax: Boolean


$Reticle Style:

  • Selection for display type of the Reticle.
  • Syntax: String
    • Options:
  • FS1 - uses reticle1_fs1.ani
  • FS2 - uses reticle1.ani

$Gauge Config

$Ship:

  • Optional. If set, the following config data will only be used if the player ship is of the supplied ship class
  • Syntax: String, the ship class name

$Load Retail Configuration:

  • As per the global option above.
  • Syntax: Boolean

$Font:

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

$Base:

  • Base resolution for this config.
  • Syntax: (Integer, Integer)

$Required Aspect:

  • Optional. If set, this configuration will only be loaded for widescreen or square resolutions.
  • Syntax: String, either "Full Screen" or "Wide Screen".

$Min:

  • Minimum resolution for this config.
  • Syntax: (Integer, Integer)

$Max:

  • Maximum resolution for this config.
  • Syntax: (Integer, Integer)

$Gauges:

+Custom:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Name:
  • 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:
  • Text will be displayed with an offset of x pixels from the gauge origin.
  • Syntax: Integer
Y Offset:
  • Text will be displayed with an offset of y pixels from the gauge origin.
  • Syntax: Integer
Gauge Type:
  • Each custom gauge must have a type.
  • Syntax: String, one of the possible gauge types.
Slew:
  • Optional. Whether this gauge is affected by afterburner shaking or similar effects.
  • Syntax: Boolean
Color:
  • Optional. Defines the colour to use for this gauge.
  • Syntax: Integer Integer Integer
Active by default:
  • Optional. Whether this gauge is always active, or only available after being activated via sexp.
  • Syntax: Boolean
Filename:
  • Filename for the background graphic for this gauge
  • Syntax: Filename

+Messages:

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
Max Lines:
  • Optional. Maximum number of message lines that are displayed.
  • Syntax: Integer, default is 3
Max Width:
  • Optional. How many pixels the message lines may be long.
  • Syntax: Integer
Line Height:
  • Optional. Vertical separation between message lines in pixels.
  • Syntax: Integer
Total Lifetime:
  • Optional. Message lifetime in milliseconds.
  • Syntax: Integer
Scroll Time:
  • Optional. Time to scroll one line.
  • Syntax: Integer
Step Size:
  • Optional.
  • Syntax: Integer

+Training Messages:

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

+Support:

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
Header Offsets:
Text Y-offset:
Dock Status X-offset:
Dock Time X-offset:

+Damage:

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:
Hull Integrity Offsets:
Hull Integrity Value X-offset:
Top Background Height:
Subsystem Entry Height:
Subsystem List Start Offsets:
Subsystem Entry Value X-offset:

+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
Primary List Top Background Filename:
Alt Ballistic Filename:
Primary List Middle Background Filename:
Alt Ballistic Filename:
Primary List Bottom Background Filename:
Alt Ballistic Filename:
Secondary List Top Background Filename:
Alt Ballistic Filename:
Secondary List Entry Background Filename:
Alt Ballistic Filename:
Secondary List Bottom Background Filename:
Alt Ballistic Filename:
Header Offsets:
Alt Ballistic Offsets:
Top Primary Background X-offset:
Alt Ballistic X-offset:
Text X-offset:
Alt Ballistic X-offset:
Top Primary Frame Height:
Top Secondary Frame Height:
Primary List Start Y-offset:
Secondary List Start Y-offset:
Primary Weapon Ammo X-offset:
Primary Weapon Link X-offset:
Primary Weapon Name X-offset:
Secondary Weapon Ammo X-offset:
Secondary Weapon Unlinked X-offset:
Secondary Weapon Linked X-offset:
Secondary Weapon Name X-offset:
Secondary Weapon Reload X-offset:
Primary Weapon Entry Height:
Secondary Weapon Entry Height:

+Objective Notify:

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

+Squad Message:

This feature requires FreeSpace Open

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.

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

$Load Retail Configuration:

  • If yes, any gauge missing from the HUD gauge definitions below will be loaded using the retail defaults.
  • Syntax: Boolean

$Font:

  • Which font to use for the HUD.
  • Syntax: Integer, font index as defined in fonts.tbl

$Max Directives:

  • Maximum number of directives displayed simultaneously.
  • Syntax: Integer, default is 5.

$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.
  • Syntax: Integer

$Length Unit Multiplier:

  • Defines the multiplier used for scaling the distances reported to the player in the game
  • Syntax: Float

$Speed Unit Multiplier:

  • Analogous to the above, this multiplier is applied to all speeds reported to the player
  • Syntax: Float, if nothing else is defined, this is set to the same value as the length unit multiplier above

$Wireframe Targetbox:

  • Defines the default draw method for the targetbox
  • Syntax: Integer
    • Options:
  • 0 - Standard
  • 1 - Wireframe
  • 2 - Wireframe with textures NOT ACTUALLY IMPLEMENTED!


$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.
  • Syntax: Boolean


$Reticle Style:

  • Selection for display type of the Reticle.
  • Syntax: String
    • Options:
  • FS1 - uses reticle1_fs1.ani
  • FS2 - uses reticle1.ani

$Gauge Config

$Ship:

  • Optional. If set, the following config data will only be used if the player ship is of the supplied ship class
  • Syntax: String, the ship class name

$Load Retail Configuration:

  • As per the global option above.
  • Syntax: Boolean

$Font:

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

$Base:

  • Base resolution for this config.
  • Syntax: (Integer, Integer)

$Required Aspect:

  • Optional. If set, this configuration will only be loaded for widescreen or square resolutions.
  • Syntax: String, either "Full Screen" or "Wide Screen".

$Min:

  • Minimum resolution for this config.
  • Syntax: (Integer, Integer)

$Max:

  • Maximum resolution for this config.
  • Syntax: (Integer, Integer)

$Gauges:

+Custom:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Name:
  • 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:
  • Text will be displayed with an offset of x pixels from the gauge origin.
  • Syntax: Integer
Y Offset:
  • Text will be displayed with an offset of y pixels from the gauge origin.
  • Syntax: Integer
Gauge Type:
  • Each custom gauge must have a type.
  • Syntax: String, one of the possible gauge types.
Slew:
  • Optional. Whether this gauge is affected by afterburner shaking or similar effects.
  • Syntax: Boolean
Color:
  • Optional. Defines the colour to use for this gauge.
  • Syntax: Integer Integer Integer
Active by default:
  • Optional. Whether this gauge is always active, or only available after being activated via sexp.
  • Syntax: Boolean
Filename:
  • Filename for the background graphic for this gauge
  • Syntax: Filename

+Messages:

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
Max Lines:
  • Optional. Maximum number of message lines that are displayed.
  • Syntax: Integer, default is 3
Max Width:
  • Optional. How many pixels the message lines may be long.
  • Syntax: Integer
Line Height:
  • Optional. Vertical separation between message lines in pixels.
  • Syntax: Integer
Total Lifetime:
  • Optional. Message lifetime in milliseconds.
  • Syntax: Integer
Scroll Time:
  • Optional. Time to scroll one line.
  • Syntax: Integer
Step Size:
  • Optional.
  • Syntax: Integer

+Training Messages:

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

+Support:

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
Header Offsets:
Text Y-offset:
Dock Status X-offset:
Dock Time X-offset:

+Damage:

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:
Hull Integrity Offsets:
Hull Integrity Value X-offset:
Top Background Height:
Subsystem Entry Height:
Subsystem List Start Offsets:
Subsystem Entry Value X-offset:

+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 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 Shields:

This feature requires FreeSpace Open

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.

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

$Load Retail Configuration:

  • If yes, any gauge missing from the HUD gauge definitions below will be loaded using the retail defaults.
  • Syntax: Boolean

$Font:

  • Which font to use for the HUD.
  • Syntax: Integer, font index as defined in fonts.tbl

$Max Directives:

  • Maximum number of directives displayed simultaneously.
  • Syntax: Integer, default is 5.

$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.
  • Syntax: Integer

$Length Unit Multiplier:

  • Defines the multiplier used for scaling the distances reported to the player in the game
  • Syntax: Float

$Speed Unit Multiplier:

  • Analogous to the above, this multiplier is applied to all speeds reported to the player
  • Syntax: Float, if nothing else is defined, this is set to the same value as the length unit multiplier above

$Wireframe Targetbox:

  • Defines the default draw method for the targetbox
  • Syntax: Integer
    • Options:
  • 0 - Standard
  • 1 - Wireframe
  • 2 - Wireframe with textures NOT ACTUALLY IMPLEMENTED!


$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.
  • Syntax: Boolean


$Reticle Style:

  • Selection for display type of the Reticle.
  • Syntax: String
    • Options:
  • FS1 - uses reticle1_fs1.ani
  • FS2 - uses reticle1.ani

$Gauge Config

$Ship:

  • Optional. If set, the following config data will only be used if the player ship is of the supplied ship class
  • Syntax: String, the ship class name

$Load Retail Configuration:

  • As per the global option above.
  • Syntax: Boolean

$Font:

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

$Base:

  • Base resolution for this config.
  • Syntax: (Integer, Integer)

$Required Aspect:

  • Optional. If set, this configuration will only be loaded for widescreen or square resolutions.
  • Syntax: String, either "Full Screen" or "Wide Screen".

$Min:

  • Minimum resolution for this config.
  • Syntax: (Integer, Integer)

$Max:

  • Maximum resolution for this config.
  • Syntax: (Integer, Integer)

$Gauges:

+Custom:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Name:
  • 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:
  • Text will be displayed with an offset of x pixels from the gauge origin.
  • Syntax: Integer
Y Offset:
  • Text will be displayed with an offset of y pixels from the gauge origin.
  • Syntax: Integer
Gauge Type:
  • Each custom gauge must have a type.
  • Syntax: String, one of the possible gauge types.
Slew:
  • Optional. Whether this gauge is affected by afterburner shaking or similar effects.
  • Syntax: Boolean
Color:
  • Optional. Defines the colour to use for this gauge.
  • Syntax: Integer Integer Integer
Active by default:
  • Optional. Whether this gauge is always active, or only available after being activated via sexp.
  • Syntax: Boolean
Filename:
  • Filename for the background graphic for this gauge
  • Syntax: Filename

+Messages:

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
Max Lines:
  • Optional. Maximum number of message lines that are displayed.
  • Syntax: Integer, default is 3
Max Width:
  • Optional. How many pixels the message lines may be long.
  • Syntax: Integer
Line Height:
  • Optional. Vertical separation between message lines in pixels.
  • Syntax: Integer
Total Lifetime:
  • Optional. Message lifetime in milliseconds.
  • Syntax: Integer
Scroll Time:
  • Optional. Time to scroll one line.
  • Syntax: Integer
Step Size:
  • Optional.
  • Syntax: Integer

+Training Messages:

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

+Support:

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
Header Offsets:
Text Y-offset:
Dock Status X-offset:
Dock Time X-offset:

+Damage:

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:
Hull Integrity Offsets:
Hull Integrity Value X-offset:
Top Background Height:
Subsystem Entry Height:
Subsystem List Start Offsets:
Subsystem Entry Value X-offset:

+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
Primary List Top Background Filename:
Alt Ballistic Filename:
Primary List Middle Background Filename:
Alt Ballistic Filename:
Primary List Bottom Background Filename:
Alt Ballistic Filename:
Secondary List Top Background Filename:
Alt Ballistic Filename:
Secondary List Entry Background Filename:
Alt Ballistic Filename:
Secondary List Bottom Background Filename:
Alt Ballistic Filename:
Header Offsets:
Alt Ballistic Offsets:
Top Primary Background X-offset:
Alt Ballistic X-offset:
Text X-offset:
Alt Ballistic X-offset:
Top Primary Frame Height:
Top Secondary Frame Height:
Primary List Start Y-offset:
Secondary List Start Y-offset:
Primary Weapon Ammo X-offset:
Primary Weapon Link X-offset:
Primary Weapon Name X-offset:
Secondary Weapon Ammo X-offset:
Secondary Weapon Unlinked X-offset:
Secondary Weapon Linked X-offset:
Secondary Weapon Name X-offset:
Secondary Weapon Reload X-offset:
Primary Weapon Entry Height:
Secondary Weapon Entry Height:

+Objective Notify:

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

+Squad Message:

This feature requires FreeSpace Open

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.

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

$Load Retail Configuration:

  • If yes, any gauge missing from the HUD gauge definitions below will be loaded using the retail defaults.
  • Syntax: Boolean

$Font:

  • Which font to use for the HUD.
  • Syntax: Integer, font index as defined in fonts.tbl

$Max Directives:

  • Maximum number of directives displayed simultaneously.
  • Syntax: Integer, default is 5.

$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.
  • Syntax: Integer

$Length Unit Multiplier:

  • Defines the multiplier used for scaling the distances reported to the player in the game
  • Syntax: Float

$Speed Unit Multiplier:

  • Analogous to the above, this multiplier is applied to all speeds reported to the player
  • Syntax: Float, if nothing else is defined, this is set to the same value as the length unit multiplier above

$Wireframe Targetbox:

  • Defines the default draw method for the targetbox
  • Syntax: Integer
    • Options:
  • 0 - Standard
  • 1 - Wireframe
  • 2 - Wireframe with textures NOT ACTUALLY IMPLEMENTED!


$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.
  • Syntax: Boolean


$Reticle Style:

  • Selection for display type of the Reticle.
  • Syntax: String
    • Options:
  • FS1 - uses reticle1_fs1.ani
  • FS2 - uses reticle1.ani

$Gauge Config

$Ship:

  • Optional. If set, the following config data will only be used if the player ship is of the supplied ship class
  • Syntax: String, the ship class name

$Load Retail Configuration:

  • As per the global option above.
  • Syntax: Boolean

$Font:

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

$Base:

  • Base resolution for this config.
  • Syntax: (Integer, Integer)

$Required Aspect:

  • Optional. If set, this configuration will only be loaded for widescreen or square resolutions.
  • Syntax: String, either "Full Screen" or "Wide Screen".

$Min:

  • Minimum resolution for this config.
  • Syntax: (Integer, Integer)

$Max:

  • Maximum resolution for this config.
  • Syntax: (Integer, Integer)

$Gauges:

+Custom:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Name:
  • 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:
  • Text will be displayed with an offset of x pixels from the gauge origin.
  • Syntax: Integer
Y Offset:
  • Text will be displayed with an offset of y pixels from the gauge origin.
  • Syntax: Integer
Gauge Type:
  • Each custom gauge must have a type.
  • Syntax: String, one of the possible gauge types.
Slew:
  • Optional. Whether this gauge is affected by afterburner shaking or similar effects.
  • Syntax: Boolean
Color:
  • Optional. Defines the colour to use for this gauge.
  • Syntax: Integer Integer Integer
Active by default:
  • Optional. Whether this gauge is always active, or only available after being activated via sexp.
  • Syntax: Boolean
Filename:
  • Filename for the background graphic for this gauge
  • Syntax: Filename

+Messages:

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
Max Lines:
  • Optional. Maximum number of message lines that are displayed.
  • Syntax: Integer, default is 3
Max Width:
  • Optional. How many pixels the message lines may be long.
  • Syntax: Integer
Line Height:
  • Optional. Vertical separation between message lines in pixels.
  • Syntax: Integer
Total Lifetime:
  • Optional. Message lifetime in milliseconds.
  • Syntax: Integer
Scroll Time:
  • Optional. Time to scroll one line.
  • Syntax: Integer
Step Size:
  • Optional.
  • Syntax: Integer

+Training Messages:

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

+Support:

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
Header Offsets:
Text Y-offset:
Dock Status X-offset:
Dock Time X-offset:

+Damage:

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:
Hull Integrity Offsets:
Hull Integrity Value X-offset:
Top Background Height:
Subsystem Entry Height:
Subsystem List Start Offsets:
Subsystem Entry Value X-offset:

+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 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:
Firepoint size:
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