Hud gauges.tbl
| This feature requires FreeSpace Open |
Revision information.....
- FSO Git Commit: Date: 2016-09-14 SHA: f9bc01c
| List of Tables and related code files | |
|---|---|
| * Notes Modular Tables | |
| ** Notes tables which only use modular tables | |
| Ai.tbl* | /ai/aicode.cpp |
| Ai_profiles.tbl* | /ai/ai_profiles.cpp |
| Animation.tbl** | /model/modelanimation.cpp |
| Armor.tbl* | /ship/ship.cpp |
| Asteroid.tbl* | /asteroid/asteroid.cpp |
| Autopilot.tbl* | /autopilot/autopilot.cpp |
| Cheats.tbl* | /cheats_table/cheats_table.cpp |
| Colors.tbl* | /globalincs/alphacolors.cpp |
| Curves.tbl* | /math/curves.cpp |
| Controlconfigdefaults.tbl | /controlconfig/controlsconfigcommon.cpp |
| Credits.tbl* | /menuui/credits.cpp |
| Cutscenes.tbl* | /cutscene/cutscenes.cpp |
| Decals.tbl** | /decals/decals.cpp |
| Fireball.tbl* | /fireball/fireballs.cpp |
| Fonts.tbl* | /graphics/font.cpp |
| Game_settings.tbl* | /mod_table/mod_table.cpp |
| Glowpoints.tbl* | /model/modelread.cpp |
| Help.tbl* | /gamehelp/contexthelp.cpp |
| Hud_gauges.tbl* | /hud/hudparse.cpp |
| Icons.tbl* | /mission/missionbriefcommon.cpp |
| Iff_defs.tbl* | /iff_defs/iff_defs.cpp |
| Keywords.tbl* | Not In Codebase |
| Lighting_Profiles.tbl* | /lighting/lighting_profiles.cpp |
| Lightning.tbl* | /nebula/neblightning.cpp |
| Mainhall.tbl* | /menuui/mainhallmenu.cpp |
| Medals.tbl* | /stats/medals.cpp |
| Messages.tbl* | /mission/missionmessage.cpp |
| Mflash.tbl* | /weapon/muzzleflash.cpp |
| Music.tbl* | /gamesnd/eventmusic.cpp |
| Nebula.tbl* | /nebula/neb.cpp |
| Objecttypes.tbl* | /ship/ship.cpp |
| Options.tbl* | Not In Codebase |
| Particle effects(-part.tbm)** | /particle/effects... |
| Post_processing.tbl | /graphics/gropenglpostprocessing.cpp |
| Rank.tbl* | /stats/scoring.cpp |
| Scpui.tbl* | Not In Codebase |
| Scripting.tbl* | /parse/scripting.cpp |
| Ships.tbl* | /ship/ship.cpp |
| Sexps.tbl** | /parse/sexp/sexp_lookup.cpp |
| Sounds.tbl* | /gamesnd/gamesnd.cpp |
| Species_defs.tbl* | /species_defs/species_defs.cpp |
| Species.tbl* | /menuui/techmenu.cpp |
| Ssm.tbl* | /hud/hudartillery.cpp |
| Stars.tbl* | /starfield/starfield.cpp |
| Strings.tbl* | /localization/localize.cpp |
| Tips.tbl* | /menuui/playermenu.cpp |
| Traitor.tbl* | /stats/scoring.cpp |
| Tstrings.tbl* | /localization/localize.cpp |
| Virtual_pofs.tbl* | /model/modelreplace.cpp |
| Weapon_expl.tbl* | /weapon/weapons.cpp |
| Weapons.tbl* | /weapon/weapons.cpp |
The hud_gauges.tbl is used for modifying the elements of the HUD. Not all gauges can be modified. However, custom gauges may be added to mimic their behavior (such as the wingman status display).
HUD Elements in FS2 are called Gauges, and each gauge has various options to customize appearance and, in some cases, their behavior as well.
This table is one of the Modular Tables and can be extended with xxx-hdg.tbm
Contents
- 1 HUD Configurations
- 1.1 $Load Retail Configuration:
- 1.2 $Color:
- 1.3 $Font:
- 1.4 $Chase View Only:
- 1.5 $Max Directives:
- 1.6 $Max Escort Ships:
- 1.7 $Length Unit Multiplier:
- 1.8 $Speed Unit Multiplier:
- 1.9 $Wireframe Targetbox:
- 1.10 $Targetbox Shader Effect:
- 1.11 $Lock Wireframe Mode:
- 1.12 $Scale Gauges:
- 1.13 $Force Scaling Above:
- 1.14 $Reticle Style:
- 2 #Gauge Config
- 2.1 $Ship:
- 2.2 $Ships:
- 2.3 $Base:
- 2.4 $Scale Gauges:
- 2.5 $Force Scaling Above:
- 2.6 $Required Aspect:
- 2.7 $Min:
- 2.8 $Max:
- 2.9 $Gauges:
- 2.9.1 +Custom:
- 2.9.2 +Scripted Gauge:
- 2.9.3 +Messages:
- 2.9.4 +Training Messages:
- 2.9.5 +Support:
- 2.9.6 +Damage:
- 2.9.7 +Wingman Status:
- 2.9.8 +Auto Speed:
- 2.9.9 +Auto Target:
- 2.9.10 +Countermeasures:
- 2.9.11 +Talking Head:
- 2.9.12 +Directives:
- 2.9.13 +Weapons:
- 2.9.14 +Objective notify:
- 2.9.15 +Squad Message
- 2.9.16 +Lag:
- 2.9.17 +Mini Target Shields:
- 2.9.18 +Player Shields:
- 2.9.19 +Target Shields:
- 2.9.20 +Escort View:
- 2.9.21 +Mission Time:
- 2.9.22 +ETS Retail:
- 2.9.23 +ETS Weapons:
- 2.9.24 +ETS Engines:
- 2.9.25 +ETS Shields:
- 2.9.26 +Target Monitor:
- 2.9.27 +Extra Target Data:
- 2.9.28 +Radar:
- 2.9.29 +Radar Orb:
- 2.9.30 +Radar BSG:
- 2.9.31 +Afterburner Energy:
- 2.9.32 +Weapon Energy:
- 2.9.33 +Text Warnings:
- 2.9.34 +Center Reticle:
- 2.9.35 +Throttle:
- 2.9.36 +Threat Indicator:
- 2.9.37 +Multiplayer Messages:
- 2.9.38 +Voice Status:
- 2.9.39 +Ping:
- 2.9.40 +Supernova:
- 2.9.41 +Lock Indicator:
- 2.9.42 +Offscreen Indicator:
- 2.9.43 +Target Brackets:
- 2.9.44 +Hostile Triangle:
- 2.9.45 +Target Triangle:
- 2.9.46 +Missile Triangles:
- 2.9.47 +Lead Indicator:
- 2.9.48 +Orientation Tee:
- 2.9.49 +Lead Sight:
- 2.9.50 +Kills:
- 2.9.51 +Weapon Linking:
- 2.9.52 +Fixed Messages:
- 2.9.53 +Flight Path Marker:
- 2.9.54 +Warhead Count:
- 2.9.55 +Hardpoints:
- 2.9.56 +Primary Weapons:
- 2.9.57 +Secondary Weapons:
- 2.10 $End Gauges
- 3 #End
- 4 Gauge Configuration Options
- 4.1 Position:
- 4.2 Scale Gauge:
- 4.3 Force Scaling Above:
- 4.4 Origin:
- 4.5 Offset:
- 4.6 Cockpit Target:
- 4.7 Color:
- 4.8 Font:
- 4.9 Name:
- 4.10 Text:
- 4.11 X Offset:
- 4.12 Y Offset:
- 4.13 Gauge Type:
- 4.14 Slew:
- 4.15 Max Lines:
- 4.16 Max Width:
- 4.17 Line Height:
- 4.18 Total Lifetime:
- 4.19 Scroll Time:
- 4.20 Step Size:
- 4.21 Active by default:
- 4.22 Filename:
- 4.23 Top Background Filename:
- 4.24 Bottom Background Filename:
- 4.25 Left Background Filename:
- 4.26 First Background Filename:
- 4.27 Right Background Filename:
- 4.28 Last Background Filename:
- 4.29 Entry Background Filename:
- 4.30 Primary List Top Background Filename:
- 4.31 Primary List Middle Background Filename:
- 4.32 Primary List Bottom Background Filename:
- 4.33 Secondary List Top Background Filename:
- 4.34 Secondary List Entry Background Filename:
- 4.35 Secondary List Bottom Background Filename:
- 4.36 Alt Ballistic Filename:
- 4.37 Dot Filename:
- 4.38 Header Offsets:
- 4.39 Fixed Header Position:
- 4.40 Text Y-offset:
- 4.41 Text Offsets:
- 4.42 Value Offsets:
- 4.43 Dock Status X-offset:
- 4.44 Dock Time X-offset:
- 4.45 Hull Integrity Offsets:
- 4.46 Hull Integrity Value X-offset:
- 4.47 Top Background Height:
- 4.48 Left Background Width:
- 4.49 Entry Width:
- 4.50 Subsystem Entry Height:
- 4.51 Subsystem List Start Offsets:
- 4.52 Subsystem Entry Value X-offset:
- 4.53 Single Wing Offsets:
- 4.54 Multiple Wing Start Offsets:
- 4.55 Wing Name Offsets:
- 4.56 Dot Offsets:
- 4.57 Expansion Mode:
- 4.58 Use Full Wing Names:
- 4.59 Use Expanded Colors:
- 4.60 Auto Offsets:
- 4.61 Speed Offsets:
- 4.62 Target Offsets:
- 4.63 Animation Offsets:
- 4.64 Animation Background Size:
- 4.65 Animation Size:
- 4.66 List Start Offsets:
- 4.67 Entry Height:
- 4.68 Alt Ballistic Offsets:
- 4.69 Top Primary Background X-offset:
- 4.70 Text X-offset:
- 4.71 Alt Ballistic X-offset:
- 4.72 Top Primary Frame Height:
- 4.73 Top Secondary Frame Height:
- 4.74 Primary List Start Y-offset:
- 4.75 Secondary List Start Y-offset:
- 4.76 Primary Weapon Ammo X-offset:
- 4.77 Primary Weapon Link X-offset:
- 4.78 Primary Weapon Name X-offset:
- 4.79 Secondary Weapon Ammo X-offset:
- 4.80 Secondary Weapon Linked X-offset:
- 4.81 Secondary Weapon Name X-offset:
- 4.82 Secondary Weapon Reload X-offset:
- 4.83 Primary Weapon Entry Height:
- 4.84 Secondary Weapon Entry Height:
- 4.85 3 Digit Hull Offsets:
- 4.86 2 Digit Hull Offsets:
- 4.87 1 Digit Hull Offsets:
- 4.88 Objective Text Y-offset:
- 4.89 Objective Value Y-offset
- 4.90 Subspace Text Y-offset:
- 4.91 Subspace Value Y-offset
- 4.92 Red Alert Text Y-offset
- 4.93 Red Alert Value Y-offset
- 4.94 Command X-offset:
- 4.95 Page Up Offsets:
- 4.96 Page Down Offsets:
- 4.97 Entry Height:
- 4.98 Entry Stagger Width:
- 4.99 Header Text:
- 4.100 Header Offsets:
- 4.101 List Start Offsets:
- 4.102 Hull X-offset:
- 4.103 Name X-offset:
- 4.104 Status X-offset:
- 4.105 Ship Name Max Width:
- 4.106 Right-Align Ship Names:
- 4.107 Foreground Clip Height:
- 4.108 Letter Offsets:
- 4.109 Top Offsets:
- 4.110 Bottom Offsets:
- 4.111 Gauge Offset:
- 4.112 Monitor Filename:
- 4.113 Integrity Bar Filename:
- 4.114 Viewport Offsets:
- 4.115 Viewport Size:
- 4.116 Integrity Bar Offsets:
- 4.117 Integrity Bar Foreground Clip Height:
- 4.118 Status Offsets:
- 4.119 Name Offsets:
- 4.120 Class Offsets:
- 4.121 Distance Offsets:
- 4.122 Speed Offsets:
- 4.123 Hull Offsets:
- 4.124 Cargo Contents Offsets:
- 4.125 Cargo Scan Start Offsets:
- 4.126 Cargo Scan Size:
- 4.127 Bracket Offsets:
- 4.128 Dock Offsets:
- 4.129 Dock Max Width:
- 4.130 Order Offsets:
- 4.131 Order Max Width:
- 4.132 Time Offsets:
- 4.133 Radar Center Offsets:
- 4.134 Radar Size:
- 4.135 Infinity Distance Offsets:
- 4.136 Long Distance Offsets:
- 4.137 Short Distance Offsets:
- 4.138 Size:
- 4.139 XY Disc Filename:
- 4.140 XZ YZ Disc Filename:
- 4.141 Sweep Disc Filename:
- 4.142 Default Contact Filename:
- 4.143 Unknown Contact Filename:
- 4.144 Loop Volume:
- 4.145 Minimum Beep Delay:
- 4.146 Firepoint display:
- 4.147 Firepoint size:
- 4.148 Firepoint X coordinate multiplier:
- 4.149 Firepoint Y coordinate multiplier:
- 4.150 Foreground Clip Bottom Y-offset:
- 4.151 Foreground Clip Width:
- 4.152 Afterburner Clip Height:
- 4.153 Show Background:
- 4.154 Max Speed Label Offsets:
- 4.155 Min Speed Label Offsets:
- 4.156 Orbit Center Offsets:
- 4.157 Orbit Radius:
- 4.158 Arc Filename:
- 4.159 Dumbfire Filename:
- 4.160 Lock Filename:
- 4.161 Dumbfire Offsets:
- 4.162 Lock Offsets:
- 4.163 Lock Filename:
- 4.164 Locked Filename:
- 4.165 Lock Center Offsets:
- 4.166 Locked Center Offsets:
- 4.167 Radius:
- 4.168 Triangle Base:
- 4.169 Triangle Height:
- 4.170 Center Offsets:
- 4.171 Single Primary Filename:
- 4.172 Double Primary Filename:
- 4.173 Single Secondary Filename:
- 4.174 Double Secondary Filename:
- 4.175 Triple Secondary Filename:
- 4.176 Single Primary Offsets:
- 4.177 Double Primary Offsets:
- 4.178 Single Secondary Offsets:
- 4.179 Double Secondary Offsets:
- 4.180 Triple Secondary Offsets:
- 4.181 Hidden By Comms Menu:
- 4.182 Bottom Background Offset:
- 4.183 Center Text On Gauge X-Position:
- 4.184 N-gon Sides:
- 4.185 N-gon Offset:
HUD Configurations
The following entries are used on the HUD system, but have not been grouped with any particular gauge.
$Load Retail Configuration:
Optional. If yes, any gauge missing from the HUD gauge definitions below will be loaded using the retail defaults.
If no, any missing (default) gauge will prompt an error.
- Syntax: Boolean
$Color:
Optional. Sets the default HUD color for all gauges.
- Syntax: (Integer Red, Integer Green, Integer Blue)
- Valid Values: all values from 0 to 255
$Font:
Optional. Sets the font type to use for the HUD. This can either be a string or a number. A string references a font with a specific name while a number references a font with a specific index in the fonts table. The number option is deprecated and is only there for backwards-compatibility. Use the name if possible.
- Syntax: String or Integer font index number
- Valid Values: Any name or font index as defined in Fonts.tbl
$Chase View Only:
Optional. Sets gauges to be displayed only in Chase View.
- Syntax: Boolean
- Default Value: False
$Max Directives:
Optional. Sets the default maximum number of directives displayed simultaneously.
- Syntax: Integer maximum number of directives
- Valid Values: Any positive number
- Default Value: 5
$Max Escort Ships:
Optional. Sets the default maximum number of escort ships to be shown in the escort list.
- Syntax: Integer
- Valid Values: Any positive number
$Length Unit Multiplier:
Optional. Sets the multiplier to applied to the reported distances. For example, if the multiplier is 0.5, then the distance reported to the player will (or at least should) be 0.5 x actual distance.
- Syntax: Float
- Valid Values: Any positive number
$Speed Unit Multiplier:
Optional. Analogous to $Length Unit Multiplier, this sets the multiplier to be applied to all speeds reported to the player. For example, if the multiplier is 0.5, the the speed reported to the player will (or at least should) be 0.5 x actual speed.
- Syntax: Float
- Valid Values: Any positive number
- Default Values:
- The value used in $Length Unit Multiplier, or
- 1, if $Length Unit Multiplier is undefined
$Wireframe Targetbox:
Optional. Defines the default draw method for the target viewer (a.k.a. targetbox).
- Syntax: Integer Draw method ID
- Valid Values:
- 0 - Standard with full, bright lighting
- 1 - Wireframe
- 2 - Standard with proper lighting (i.e. lit the same as the actual target)
- 3 - Untextured with full bright lighting (i.e. drawn with a single flat color)
$Targetbox Shader Effect:
Optional. If set, defines a unique ID for a shader effect to be used when rendering a ship for the targeting box. The ID will be passed to the main shader as in #Ship_Effects, but a table entry for the effect is not needed.
- Syntax: Integer
- Valid Values: Any positive number
$Lock Wireframe Mode:
Optional. If set, prevents targetbox draw method from being changed during the gaming session.
- Syntax: Boolean
$Scale Gauges:
Optional. If set, all gauges will use this value as the default for scaling individual gauge sizes (i.e. doesn't affect gauges that use Position:, and doesn't affect the values of Offset:. In addition, if "$Load Retail Configuration:" is true then all unspecified retail gauges will use this value.
If not set, defaults to yes.
- Syntax: Boolean
$Force Scaling Above:
Optional. If gauge scaling is disabled, then gauges will be scaled as though the base resolution were this resolution or the real base resolution, whichever is greater.
Use this to disable scaling at lower resolutions while preventing gauges from getting too small at higher resolutions.
To disable this feature, use (-1, -1).
- Syntax: (Integer width, Integer height)
$Reticle Style:
Optional. Defines which aiming reticle to use.
- Syntax: String
- Valid Values:
- FS1 - uses reticle1_fs1.ani
- FS2 - uses reticle1.ani
#Gauge Config
The following entries define default gauge appearance and behavior. Each gauge has the option of overriding these options.
$Ship:
Deprecated and superceded by $Ships in FSO revision 9208. If defined, the following config data will only be used if the player ship is of the supplied ship class. Can be defined multiple times within a #Gauge config group to allow unique HUD configurations per ship class.
If not defined, all following config data will be applied to all ships.
- Syntax: String, ship class name
$Ships:
Optional. Can be used to define a list of ships the hud definition that follows will be applied to. Can be defined multiple times within a #Gauge config group to allow unique HUD configurations per ship class.
If not defined, all following config data will be applied to all ships.
- `Syntax: ( "Class name 1" "Class name 2" ), ship class names formatted like a flag list.
$Load Retail Configuration:
Optional. Overrides the $Load Retail Configuration global option for this ship class.
- Syntax: Boolean
$Color:
Optional. Overrides the $Color global option for this ship class.
- Syntax: See $Color
$Font:
Optional. Overrides the $Font global option for this ship class.
- Syntax: See $Font
$Chase View Only:
Optional. Overrides the $Chase View Only global option for this ship class.
- Syntax: See $Chase View Only
$Base:
Required. Defines the base resolution for this HUD configuration, upon which other gauge options (such as Position: / Origin: / Offset:) will use as its coordinate system.
- Syntax: (Integer width, Integer height)
- Valid Values: All supported resolutions (?)
$Scale Gauges:
Optional. If set, will configure gauges Scaling behaviour for gauges in this #Gauge Config section. i.e. overriding the default, or the value specified at the top of the file. Individual gauges can override this setting.
- Syntax: Boolean
$Force Scaling Above:
Optional. If gauge scaling is disabled, then gauges will be scaled as though the base resolution were this resolution or the real base resolution, whichever is greater.
Use this to disable scaling at lower resolutions while preventing gauges from getting too small at higher resolutions.
To disable this feature, use (-1, -1).
- Syntax: (Integer width, Integer height)
$Required Aspect:
Optional. If set, this configuration will only be loaded for the specified aspect ratios.
Used as a filter when there are multiple $Base: resolutions in the table
- Syntax: String
- Valid Values:
- "Full Screen" (4:3, aspect ratio < 1.5)
- "Wide Screen" (16:9, 16:10, or similar, aspect ratio >= 1.5)
$Min:
Optional. Minimum resolution for this config. Any resolution lower than specified will not use this configuration.
Used as a filter when there are multiple $Base: resolutions in the table
- Syntax: (Integer width, Integer height)
- Valid Values: All supported resolutions (?)
$Max:
Optional. Maximum resolution for this config. Any resolution higher than specified will not use this configuration.
Used as a filter when there are multiple $Base: resolutions in the table
- Syntax: (Integer width, Integer height)
- Valid Values: All supported resolutions (?)
$Gauges:
Following entries define gauge-specific behavior. For the most part, each gauge has its own overrides that, if not defined, would otherwise use the global values.
Since many gauges have the same configuration options, each gauge entry has a list of valid sub-entries. Unless stated otherwise, these options must be defined in the same order as they are shown, starting from the top and ending at the bottom.
+Custom:
Adds a custom gauge type.
- Valid Sub-Entries:
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Chase View Only: (Optional)
+Scripted Gauge:
Adds a scripted gauge type.
- Valid Sub-Entries:
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Chase View Only: (Optional)
+Messages:
Adds a gauge that display mission messages.
- Valid Sub-Entries:
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Chase View Only: (Optional)
+Training Messages:
Adds a text box, like the ones seen in the FS1 and FS2 training missions.
- Valid Sub-Entries:
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Font: (Optional)
- Chase View Only: (Optional)
+Support:
Adds a text box that shows the Support ship's status and ETA
- Valid Sub-Entries:
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Chase View Only: (Optional)
+Damage:
Adds a gauge that shows how much damage a target (or the player?) has.
- Valid Sub-Entries:
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Chase View Only: (Optional)
+Wingman Status:
Adds a gauge that monitors the status of your wing and squadron.
- Valid Sub-entries:
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Chase View Only: (Optional)
- First Background Filename: (Optional) (needs an animation with one frame)
- Last Background Filename: (Optional) (needs an animation with one frame)
- Left Background Width: (Optional)
- First Background Size: (Optional)
- Entry Size: (Optional)
- Right Background Offset: (Optional)
- Last Background Offset: (Optional)
+Auto Speed:
Adds the Auto-Speed mode gauge.
- Valid Sub-entries:
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Chase View Only: (Optional)
- On Text Color: (Optional)
- Off Text Color: (Optional)
+Auto Target:
Adds the Auto-target mode gauge.
- Valid Sub-entries:
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Chase View Only: (Optional)
- On Text Color: (Optional)
- Off Text Color: (Optional)
+Countermeasures:
Adds a gauge that monitors the amount of remaining countermeasures the player's ship currently has.
- Valid Sub-entries:
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Chase View Only: (Optional)
+Talking Head:
Adds a video window to display pilot message videos (a.k.a talking heads).
- Valid Sub-entries:
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Chase View Only: (Optional)
- Animation Size: (Optional)
+Directives:
Adds a gauge that displays all currently active directives (includes current , completed, and failed)
- Valid Sub-entries:
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Chase View Only: (Optional)
- Bottom Background Offset: (Optional)
- Max Line Width: (Optional)
+Weapons:
Adds a weapon status and ammunition gauge.
- Valid Sub-entries:
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Chase View Only: (Optional)
- Alt Ballistic Filename: (Optional) (needs animation with a single frame)
- Alt Ballistic Filename: (Optional) (needs animation with a single frame)
- Alt Ballistic Filename: (Optional) (needs animation with a single frame)
- Alt Ballistic Filename: (Optional) (needs animation with a single frame)
- Alt Ballistic Filename: (Optional) (needs animation with a single frame)
- Alt Ballistic Filename: (Optional) (needs animation with a single frame)
- Alt Ballistic Offsets: (Optional)
- Alt Ballistic X-offset: (Optional)
- Alt Ballistic X-offset: (Optional)
+Objective notify:
Adds a Objective notifier gauge. This gauge alerts the player when receiving a new objective, or when an objective has been completed or failed. Additionally, this gauge alerts the player when entering subspace, and when a Red Alert mission orders are being received (prior to a forced subspace jump).
- Valid Sub-entries:
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Chase View Only: (Optional)
+Squad Message
Adds the squad message gauge. In FS1 and FS2, this gauge is used to send commands to your squad. (?)
- Valid sub-entries:
- Position (Optional)
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Chase View Only: (Optional)
- Bottom Background Offset (Optional)
+Lag:
Adds a Lag gauge.
- Valid Sub-entries:
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Chase View Only: (Optional)
+Mini Target Shields:
Adds a mini Target shields gauge. In FS1 and FS2, the Mini Target Shield gauge is the one right below the center reticle, and shows the hull damage in %
- Valid Sub-entries:
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Chase View Only: (Optional)
+Player Shields:
Adds a gauge that shows the shield and hull status icon of the player's craft or ship.
- Valid Sub-entries:
- Position (Optional)
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Chase View Only: (Optional)
+Target Shields:
Adds a gauge that shows the shield and hull status icon of the targeted craft or ship.
- Valid Sub-entries:
- Position (Optional)
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Chase View Only: (Optional)
+Escort View:
Adds an escort monitor/view gauge. This gauge monitors the status of all ships assigned to the player to escort.
- Valid Sub-entries:
- Position (Optional)
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Chase View Only: (Optional)
- Bottom Background Offset: (Optional)
- Ship Name Max Width: (Optional)
- Right-Align Ship Names: (Optional)
+Mission Time:
Adds a gauge that displays the current mission time.
- Valid Sub-entries:
- Position (Optional)
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Chase View Only: (Optional)
+ETS Retail:
Draws the three other ETS gauges as a single gauge. Will automatically rearrange itself (like retail) if shields or other systems are missing.
- Valid Sub-entries:
- Position (Optional)
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Chase View Only: (Optional)
+ETS Weapons:
Adds a gauge that displays the energy transfer rate for the energy weapons.
- Valid Sub-entries:
- Position (Optional)
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Chase View Only: (Optional)
+ETS Engines:
Adds a gauge that displays the energy transfer rate for the afterburner/engines.
- Valid Sub-entries:
- Position (Optional)
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Chase View Only: (Optional)
+ETS Shields:
Adds a gauge that displays the energy transfer rate for the shields.
- Valid Sub-entries:
- Position (Optional)
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Chase View Only: (Optional)
+Target Monitor:
Adds a target monitor gauge that shows the targeted ship's relative orientation and hull strength, among other things.
- Valid Sub-entries:
- Position (Optional)
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Chase View Only: (Optional)
- Monitor Alpha Mask Filename: (Optional) (needs animation with a single frame)
- Subsystem Name Offsets: (Optional)
- Subsystem Integrity Offsets: (Optional)
- Disabled Status Offsets: (Optional)
- Desaturate: (Optional)
+Extra Target Data:
Adds a gauge that displays "extra" target data, such as its current orders and docking status.
- Valid Sub-Entries:
- Position (Optional)
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Chase View Only: (Optional)
- Dock Max Width: (Optional)
- Order Max Width: (Optional)
+Radar:
Adds a standard radar gauge
- Valid Sub-entries:
- N-gon Sides: (Optional)
- N-gon Offset: (Optional)
- Position (Optional)
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Chase View Only: (Optional)
- Radar Center Offsets: (Optional)
- Radar Size: (Optional)
- Infinity Distance Offsets (Optional)
- Long Distance Offsets: (Optional)
- Short Distance Offsets: (Optional)
+Radar Orb:
Adds a 3D orb radar gauge
- Valid Sub-entries:
- Position (Optional)
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Chase View Only: (Optional)
- Radar Center Offsets: (Optional)
- Radar Size: (Optional)
- Infinity Distance Offsets (Optional)
- Long Distance Offsets: (Optional)
- Short Distance Offsets: (Optional)
+Radar BSG:
Adds a BSG style radar (a.k.a DRADIS).
- Position (Optional)
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Font: (Optional)
- Chase View Only: (Optional)
+Afterburner Energy:
Adds a gauge that shows the remaining afterburner energy. Note that it only supports a vertical fill.
- Valid Sub-Entries:
- Position (Optional)
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Chase View Only: (Optional)
+Weapon Energy:
Adds a gauge that shows the remaining weapon energy. Note that it only supports a vertical fill.
- Valid Sub-Entries:
- Position (Optional)
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Chase View Only: (Optional)
- Text Alignment: (Optional)
- Always Show Text: (Optional)
- Text Follows: (Optional)
- Show Ballistic Ammo: (Optional)
- Armed Guns List Offsets: (Optional)
- Armed Guns List Alignment: (Optional)
- Armed Guns List Entry Height: (Optional)
+Text Warnings:
Adds a gauge that warns the player (current warnings are EMP, Launch, Evaded, Collision, Blast & Engine Wash).
- Valid Sub-Entries:
- Position (Optional)
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Chase View Only: (Optional)
+Center Reticle:
Adds a "custom" center reticle.
- Valid Sub-Entries:
- Position (Optional)
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Chase View Only: (Optional)
+Throttle:
Adds a gauge that shows the current throttle position.
- Valid Sub-Entries:
- Position (Optional)
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Chase View Only: (Optional)
- Show Max Speed Label: (Optional)
- Show Min Speed Label: (Optional)
- Current Speed Offsets: (Optional)
- Target Speed Offsets: (Optional)
- Show Percentage: (Optional)
- Glide Status Offsets: (Optional)
- Match Speed Status Offsets: (Optional)
+Threat Indicator:
Adds a gauge that indicates when a lock-on has been achieved by an attacker, and if the player is being shot at.
- Valid Sub-Entries:
- Position (Optional)
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Chase View Only: (Optional)
+Multiplayer Messages:
Adds a gauge that displays the multiplayer messages.
- Valid Sub-Entries:
- Position (Optional)
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Font: (Optional)
- Chase View Only: (Optional)
+Voice Status:
Adds a gauge that displays the voice status.
- Valid Sub-Entries:
- Position (Optional)
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Chase View Only: (Optional)
+Ping:
Adds a gauge that the ping time to the multiplayer server.
- Valid Sub-Entries:
- Position (Optional)
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Chase View Only: (Optional)
+Supernova:
Adds a gauge that warns the player of an impending supernova shock wave.
- Valid Sub-Entries:
- Position (Optional)
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Chase View Only: (Optional)
+Lock Indicator:
Adds a Lock Indicator gauge.
- Valid Sub-Entries:
- Font: (Optional)
- Chase View Only: (Optional)
+Offscreen Indicator:
Adds an Offscreen Indicator.
- Valid Sub-Entries:
- Font: (Optional)
- Chase View Only: (Optional)
+Target Brackets:
Adds a Target Bracket gauge. This is drawn around current target(s) and talkers.
- Valid Sub-Entries:
- Font: (Optional)
- Chase View Only: (Optional)
+Hostile Triangle:
Adds a gauge that points to the nearest attacker, if it is off-screen and is not currently targeted.
- Valid Sub-entries:
- Font: (Optional)
- Chase View Only: (Optional)
+Target Triangle:
Adds a gauge that points to the targeted craft, if it is currently off-screen.
- Valid Sub-entries:
- Font: (Optional)
- Chase View Only: (Optional)
+Missile Triangles:
Adds a gauge that is used during attempting to lock onto a target when using an aspect seeking missile.
- Valid Sub-entries:
- Font: (Optional)
- Chase View Only: (Optional)
+Lead Indicator:
Adds a gauge that leads (is in front) of the target. Aim your crosshairs at this indicator to increase probability of hitting the target.
- Valid Sub-entries:
- Font: (Optional)
- Chase View Only: (Optional)
- Frame #0: Secondaries lead indicator (Dumbfire)
- Frame #1: Secondaries lead indicator (Homing)
- Frame #2: Primaries lead indicator
+Orientation Tee:
Adds a gauge that indicates the targeted craft's orientation in relation to the player's craft.
- Valid Sub-Entries:
- Chase View Only: (Optional)
+Lead Sight:
Adds a gauge that lags (is behind) the target. Indicates where your shots will end up relative to the target's position. To score a hit, this gauge should be over the target. Notably used by Diaspora.
- Valid Sub-Entries:
- Chase View Only: (Optional)
- Frame #0 is used for secondaries
- If only one frame is found in the file, then it is used for primaries instead
- Frame #1 is used for primaries
+Kills:
Adds a gauge that keeps track of how many kills the player has scored during a mission.
- Valid Sub-Entries:
- Position (Optional)
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Chase View Only: (Optional)
+Weapon Linking:
Adds a gauge that indicates the selected weapons and their firing rates.
- Valid Sub-Entries:
- Position (Optional)
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Chase View Only: (Optional)
+Fixed Messages:
- Valid Sub-Entries:
- Position (Optional)
- Scale Gauge: (Optional)
- Force Scaling Above: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Chase View Only: (Optional)
- Center Text On Gauge X-Position: (Optional)
+Flight Path Marker:
Adds a gauge that indicates the direction where your ship is traveling. Notably used by Diaspora.
- Valid Sub-Entries:
- Color: (Optional)
- Filename: (Optional)
- Center Offsets: (Optional)
+Warhead Count:
Displays the name of the current secondary weapon. Tallies the ammo left. Notably used by Diaspora.
- Valid Sub-Entries:
- Position: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Color: (Optional)
- Font: (Optional)
- Chase View Only: (Optional)
+Hardpoints:
Draws a silhouette of the player's ship and mounted weapons. Notably used by Diaspora.
- Valid Sub-Entries:
- Position: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Color: (Optional)
- Size: (Optional)
- Line Width: (Optional)
- View Direction: (Optional)
- Show Primary Weapons: (Optional)
- Show Secondary Weapons: (Optional)
+Primary Weapons:
Like the Weapons gauge but simpler. Only displays primary weapons. Notably used by Diaspora.
- Valid Sub-Entries:
- Position: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Color: (Optional)
- Font: (Optional)
- Chase View Only: (Optional)
+Secondary Weapons:
Like the Weapons gauge but simpler. Only displays secondary weapons. Notably used by Diaspora.
- Valid Sub-Entries:
- Position: (Optional)
- Cockpit Target: (Optional)
- Canvas Size: (Optional)
- Display Offset: (Optional)
- Display Size:
- Color: (Optional)
- Font: (Optional)
- Chase View Only: (Optional)
$End Gauges
The Gauges section must end with $End Gauges. No Exceptions.
#End
The very last entry in the Hud_gauges.tbl must be #End. No Exceptions.
Gauge Configuration Options
Since a vast majority of gauges share the same entries, the configuration options for each gauge have been grouped here for formatting consistency.
Position:
Defines the screen coordinates for the upper left corner of this gauge.
- Syntax: Integer horizontal pixel, Integer vertical pixel position
Used by: +Custom:, +Training Messages:, +Support (and many others)
Scale Gauge:
Define if a gauge size will scale or not.
If false then gauge bitmaps will always show at their original size which may result in gauges being very small at high resolutions.
If true then gauge bitmaps will scale in proportion to the current resolution vs the base HUD resolution in use. This may result in gauges becoming blurry at non-base resolutions.
Defaults to yes/true.
Incompatible with Position:
- Syntax: Boolean scale_this_gauge
Used by: most gauges
Force Scaling Above:
Optional. If scaling is disabled for this gauge, then it will be scaled as though the base resolution were this resolution or the real base resolution, whichever is greater.
Use this to disable scaling at lower resolutions while preventing gauges from getting too small at higher resolutions.
To disable this feature, use (-1, -1).
Incompatible with Position:
- Syntax: (Integer width, Integer height)
Used by: most gauges
Origin:
Define gauge position as a ratio of the screen size (base or current, it doesn't matter).
Requires Offset:
Incompatible with Position:
- Syntax: Float horizontal ratio 0.0 - 1.0, Float vertical ratio 0.0 - 1.0
Used by: most gauges
Offset:
Define gauge offset from Origin: in base resolution pixels
Requires Origin:
Incompatible with Position:
- Syntax: Integer horizontal pixel offset from Origin:, Integer vertical pixel offset from Origin:
Used by: most gauges
Cockpit Target:
The cockpit display that this gauge will be rendered to. Refers to the +Display Name: defined in $Cockpit Display:.
- Syntax: String String defined in +Display Name: in $Cockpit Display:
Canvas Size:
The off-screen canvas this gauge will be rendered to before being interpolated into the actual cockpit display. The smaller this number is, the larger the gauge will appear on the cockpit display.
- Syntax: Integer width, Integer height
Display Offset:
The position of the canvas on the cockpit display texture
- Syntax: Integer width, Integer height
Display Size:
The interpolated size on the cockpit display texture that the canvas will be rendered to.
- Syntax: Integer width, Integer height
Color:
Optional. Overrides both previous color settings ($Color HUD option and $Color ship class option) for this particular gauge.
- Syntax: See $Color:
Font:
Optional. Overrides both previous font settings ($Font HUD option and $Font ship class option) for this particular gauge.
- Syntax: See $Font:
Used by: +Custom:, +Training Messages:, +Support
Name:
Defines the name of this custom gauge.
- Syntax: String
- Max Length: 32 characters
Used by: +Custom:
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
Used by: +Custom:
X Offset:
Optional. Defines the horizontal pixel offset (from the gauge's origin as defined by Position:) that the Text will be displayed.
- Syntax: Integer
- Units: Pixels
Used by: +Custom:
Y Offset:
Optional. Defines the vertical pixel offset (from the gauge's origin defined by Position:) that the Text will be displayed.
- Syntax: Integer
- Units: Pixels
Used by: +Custom:
Gauge Type:
Defines the type of gauge this is.
- Syntax: String
- Valid Values: Any one of the possible gauge types.
Used by: +Custom:
Slew:
Optional. Determines whether or not this gauge is affected by afterburner shaking or similar effects. If set to "true", the gauge will not follow the player's head movements when using TrackIR/padlock. i.e. should be used for gauges like the gunsight/leadsight.
- Syntax: Boolean
Max Lines:
Optional. Specifies the maximum number of message lines that are displayed.
- Syntax: Integer
- Default Value: 3
Used by: +Messages:
Max Width:
Optional. Determines how long each message line may be.
- Syntax: Integer
- Units: Pixels
Used by: +Messages:
Line Height:
Optional. Determines the distance between line origins. (i.g. for a 12pt Font, there are needs to be at least 12 pixels between the bottom of one line and the next, otherwise the text will overlap each)
- Syntax: Integer
- Units: Pixels
- Default Value: 9
Used by: +Messages:
Total Lifetime:
Optional. Determines the maximum time the message gauge will be displayed from the time a new message is received.
- Syntax: Integer
- Units: milliseconds
- Default Value: 14000 (14 seconds)
Used by: +Messages:
Scroll Time:
Optional. Determines the time for the messages to scroll up one step.( See Step Size: )
- Syntax: Integer
- Units: milliseconds
- Default Value: 30
Used by: +Messages:
Step Size:
Optional. Determines how many pixels to shift message lines during scrolling. Messages will be shifted up by this amount until they are on the next line (as defined by Line Height:)
- Syntax: Integer
- Units: Pixels
- Default Value: 3
Used by: +Messages:
Active by default:
Optional. Determines whether or not this gauge is always active, or only available after being activated via sexp.
- Syntax: Boolean
Used by: +Custom:
Filename:
Designates the .ANI or .EFF used for this gauge's background graphic.
- Syntax: Filename
- No filename extension is needed.
Top Background Filename:
Optional. Designates which file to use for the top background. (?)
- Syntax: Filename
Used by: +Damage
Bottom Background Filename:
Optional. Designates which file to use for the Bottom background (?)
- Syntax: Filename
Used by: +Damage
Left Background Filename:
Optional. Designates which file to use for the Left side of gauge.
- Syntax: Filename
Used by: +Wingman Status:
First Background Filename:
Optional. Alias for Left Background Filename:
Right Background Filename:
Optional. Designates which file to use for the Right side of the gauge.
- Syntax: Filename
Used by: +Wingman Status:
Last Background Filename:
Optional. Alias for Right Background Filename:
Entry Background Filename:
Optional. Designates which file to use for the (Wing) Entry section of the gauge (aka the middle sections).
- Syntax: Filename
Used by: +Damage, +Wingman Status:
Primary List Top Background Filename:
Optional. Designates which file to use for the Primary List Top Background
- Syntax: Filename
- Valid Sub-entries:
Used by: +Weapons:
Primary List Middle Background Filename:
Optional. Designates which file to use for the Primary List Middle Background
- Syntax: Filename
- Valid Sub-entries:
Used by: +Weapons:
Primary List Bottom Background Filename:
Optional. Designates which file to use for the Primary List Bottom Background
- Syntax: Filename
- Valid Sub-entries:
Used by: +Weapons:
Secondary List Top Background Filename:
Optional. Designates which file to use for the Secondary List Top Background
- Syntax: Filename
- Valid Sub-entries:
Used by: +Weapons:
Secondary List Entry Background Filename:
Optional. Designates which file to use for the Secondary List Entry Background
- Syntax: Filename
- Valid Sub-entries:
Used by: +Weapons:
Secondary List Bottom Background Filename:
Optional. Designates which file to use for the Secondary List Bottom Background
- Syntax: Filename
- Valid Sub-entries:
Used by: +Weapons:
Alt Ballistic Filename:
Optional. Designates an alternate file to be used for ballistic weapons.
- Syntax: Filename
Used by: Primary List Top Background Filename, Primary List Middle Background Filename, Primary List Bottom Background Filename, Secondary List Top Background Filename, Secondary List Entry Background Filename, Secondary List Bottom Background Filename
Dot Filename:
Optional. Designates which file to use for the wingman graphic (a.k.a. the Dot)
- Syntax: Filename
Used by: +Wingman Status:
Header Offsets:
Optional. Designates the offset from the gauge's upper left corner for headers of various gauges
- Syntax: Integer horizontal offset, Integer vertical offset
- Units: Pixels
- Valid Sub-entries:
- Weapons:
Used by: +Support:, +Damage:, +Weapons:
Fixed Header Position:
Optional. If set, the header text will not change position when the gauge changes size.
- Syntax: Boolean
Used by: +Wingman Status:
Text Y-offset:
Optional. Designates the offset from the gauge's upper left corner for the Support Ship Text. (?)
- Syntax: Integer vertical offset
- Units: Pixels
Used by: +Support:
Text Offsets:
Optional. Defines the screen position offsets for the text label.
- Syntax: Integer horizontal position, Integer vertical position
- Units: Pixels
Used by: :+Countermeasures:
Value Offsets:
Optional. Defines the screen position offsets for the value label.
- Syntax: Integer horizontal position, Integer vertical position
- Units: Pixels
Used by: :+Countermeasures:
Dock Status X-offset:
Optional. Designates the offset from the gauge's upper left corner for the Support Ship's dock status. (?)
- Syntax: Integer vertical offset
- Units: Pixels
Used by: +Support:
Dock Time X-offset:
Optional. Designates the offset from the gauge's upper left corner for the Support Ship's dock time. (?)
- Syntax: Integer vertical offset
- Units: Pixels
Used by: +Support:
Hull Integrity Offsets:
Optional. Designates the offsets from the gauge's upper left corner for the for the Damage gauge Hull integrity textbox(?)
- Syntax: Integer horizontal offset, Integer vertical offset
- Units: Pixels
Used by: +Damage:
Hull Integrity Value X-offset:
Optional. Designates the offsets from the hull integrity textbox's upper left corner for the hull integrity value. (?)
- Syntax: Integer horizontal offset
- Units: Pixels
Used by: +Damage:
Top Background Height:
Optional. Designates the height of the Top background (?)
- Syntax: Integer
- Units: Pixels
Used by: +Damage:
Left Background Width:
Optional. Defines the width of the Left Background.
- Syntax: Integer
- Units: Pixels
Used by: +Wingman Status:
Entry Width:
Optional. Defines the width of the Entry Background (?)
- Syntax: Integer
- Units: Pixels
Used by: +Wingman Status:
Subsystem Entry Height:
Optional. Designates the height of the Subsystem entry (?)
- Syntax: Integer
- Units: Pixels
Used by: +Damage:
Subsystem List Start Offsets:
Optional. Designates the offsets from the gauge's upper left corner for the for the start of the Subsytem List (?)
- Syntax: Integer horizontal offset, Integer vertical offset
- Units: Pixels
Used by: +Damage:
Subsystem Entry Value X-offset:
Optional. Designates the horizontal offset from the Subsystem List's position (?)
- Syntax: Integer
- Units: Pixels
Used by: +Damage:
Single Wing Offsets:
Optional. Designates the offset from the gauge's upper left corner for a single wing (?)
- Syntax: Integer horizontal offset, Integer vertical offset
- Units: Pixels
Used by: +Wingman Status:
Multiple Wing Start Offsets:
Optional. Designates the offset from the gauge's upper left corner for multiple wings (?)
- Syntax: Integer horizontal offset, Integer vertical offset
- Units: Pixels
Used by: +Wingman Status:
Wing Name Offsets:
Optional. Designates the offset from the gauge's upper left corner for the Support Ship header (?)
- Syntax: Integer horizontal offset, Integer vertical offset
- Units: Pixels
Used by: +Wingman Status:
Dot Offsets:
Optional. Designates the offset from the gauge's upper left corner for the All wingman status icons.
- Syntax:
- Integer x, Integer y ;; Wingman 1
- Integer x, Integer y ;; Wingman 2
- Integer x, Integer y ;; Wingman 3
- Integer x, Integer y ;; Wingman 4
- Integer x, Integer y ;; Wingman 5
- Integer x, Integer y ;; Wingman 6
- Units: Pixels
Used by: +Wingman Status:
Expansion Mode:
Optional. Denotes which direction (in relation to the player's wing) that the other wings should be appended to the gauge. If enabled, then wingmen dot colors will be
- Syntax: Boolean
- Default Value: False
Used by: +Wingman Status:
Use Full Wing Names:
Optional. If enabled the wingmen gauge draws the full wing name and does not alter the capitalization. Default behavior is to draw the first three letters of the wing in all lower-case.
- Syntax: Boolean
- Default Value: False
Used by: +Wingman Status:
Use Expanded Colors:
Optional. If enabled the wingmen gauge status dots use red, yellow, or green color to designate wingmen health (green full to greater thon two-thirds, yellow two-thirds to greater than one-third, and red less than or equal to one-third). Default is to use red for less than half health and gauge color otherwise.
- Syntax: Boolean
- Default Value: False
Used by: +Wingman Status:
Auto Offsets:
Optional. Defines the screen coordinates for the "Auto" text label.
- Syntax: Integer horizontal position, Integer vertical position
- Units: Pixels
Used by: +Auto Speed:, +Auto Target:
Speed Offsets:
Optional. Defines the screen coordinates for the "Speed" text label.
- Syntax: Integer horizontal position, Integer vertical position
- Units: Pixels
Used by: +Auto Speed:
Target Offsets:
Optional. Defines the screen coordinates for the "Target" text label.
- Syntax: Integer horizontal position, Integer vertical position
- Units: Pixels
Used by: +Auto Target:
Animation Offsets:
Optional. Defines the offsets for the animation graphics.
- Syntax: Integer horizontal offset, Integer vertical offset
- Units: Pixels
Used by: +Talking Head:
Animation Background Size:
Deprecated. Originally, this set the size of the black box that's drawn behind the animation. Since Git revision 556e9a4 (2015-11-01), it has the same effect as Animation Size:.
- Syntax: Integer horizontal size, Integer vertical size
- Units: Pixels
Used by: +Talking Head:
Animation Size:
Optional. Defines the size of the animation. All animations will be scaled to match this size.
- Syntax: Integer horizontal size, Integer vertical size
- Units: Pixels
Used by: +Talking Head:
List Start Offsets:
Optional. Defines the screen coordinate offsets for the start of the Directives list.
- Syntax: Integer x, Integer y
- Units: Pixels
Used by: +Directives:
Entry Height:
Optional. Defines the height of each Directive
- Syntax: Integer
- Units: Pixels
Used by: +Directives:
Alt Ballistic Offsets:
Opetional. Defines the screen coordinate offsets for headers of ballistic weapons
- Syntax: Integer horizontal offset, Integer vertical offset
- Units: Pixels
Used by: +Header Offset:
Top Primary Background X-offset:
Optional. Defines the screen coordinate offset for the Top Primary Background
- Syntax: Integer
- Units: Pixels
- Valid Sub-entries:
Used by: +Weapons:
Text X-offset:
(Optional) Defines the screen coordinate X-offset for weapon labels
- Syntax: Integer
- Units: Pixels
- Valid Sub-entries:
Used by: +Weapons:
Alt Ballistic X-offset:
Optional. Defines the screen coordinate X-offset for ballistic weapons
- Syntax: Integer
- Units: Pixels
Used by: Top Primary Background X-offset:, Text X-offset:
Top Primary Frame Height:
Used by: +Weapons:
Top Secondary Frame Height:
Used by: +Weapons:
Primary List Start Y-offset:
Used by: +Weapons:
Secondary List Start Y-offset:
Used by: +Weapons:
Primary Weapon Ammo X-offset:
Used by: +Weapons:
Primary Weapon Link X-offset:
Used by: +Weapons:
Primary Weapon Name X-offset:
Used by: +Weapons:
Secondary Weapon Ammo X-offset:
Used by: +Weapons:
Secondary Weapon Linked X-offset:
Used by: +Weapons:
Secondary Weapon Name X-offset:
Used by: +Weapons:
Secondary Weapon Reload X-offset:
Used by: +Weapons:
Primary Weapon Entry Height:
Used by: +Weapons:
Secondary Weapon Entry Height:
Used by: +Weapons:
3 Digit Hull Offsets:
Designates the screen position offsets for the hull damage % when it is the 3 digit range (i.e. >= 100%)
- Syntax: Integer x offset, Integer y offset
- Units: Pixels
Used by: +Mini Target Shields:
2 Digit Hull Offsets:
Designates the screen position offsets for the hull damage % when it is the 2 digit range (i.e. 100% > hull damage% >= 10%)
- Syntax: Integer x offset, Integer y offset
- Units: Pixels
Used by: +Mini Target Shields:
1 Digit Hull Offsets:
Designates the screen position offsets for the hull damage % when it is the 1 digit range (i.e. 10% > hull damage% >= 0%)
- Syntax: Integer x offset, Integer y offset
- Units: Pixels
Used by: +Mini Target Shields:
Objective Text Y-offset:
Designates the screen position offset for the Objective label
- Syntax: Integer y offset
- Units: Pixels
Used by: +Objective notify:
Objective Value Y-offset
Designates the screen position offset for the Objective value
- Syntax: Integer y offset
- Units: Pixels
Used by: +Objective notify:
Subspace Text Y-offset:
Designates the screen position offset for the Subspace label
- Syntax: Integer y offset
- Units: Pixels
Used by: +Objective notify:
Subspace Value Y-offset
Designates the screen position offset for the Subspace value (?)
- Syntax: Integer y offset
- Units: Pixels
Used by: +Objective notify:
Red Alert Text Y-offset
Designates the screen position offset for the Red Alert label
- Syntax: Integer y offset
- Units: Pixels
Used by: +Objective notify:
Red Alert Value Y-offset
Designates the screen position offset for the Red Alert value (?)
- Syntax: Integer y offset
- Units: Pixels
Used by: +Objective notify:
Command X-offset:
- Syntax: Integer x offset
- Units: Pixels
Used by: +Squad Message:
Page Up Offsets:
- Syntax: Integer x offset, Integer y offset
- Units: Pixels
Used by: +Squad Message:
Page Down Offsets:
- Syntax: Integer x offset, Integer y offset
- Units: Pixels
Used by: +Squad Message:
Entry Height:
Used by: +Escort View:
Entry Stagger Width:
Used by: +Escort View:
Header Text:
Used by: +Escort View:
Header Offsets:
Used by: +Escort View:
List Start Offsets:
Used by: +Escort View:
Hull X-offset:
Used by: +Escort View:
Name X-offset:
Used by: +Escort View:
Status X-offset:
Used by: +Escort View:
Ship Name Max Width:
Used by: +Escort View:
Right-Align Ship Names:
Used by: +Escort View:
Foreground Clip Height:
- Sets the height, in pixels, of the gauge.
- For the Throttle, sets the height of the gauge that represents 0% to 100% throttle. The total height of the gauge is the sum of this value and the Afterburner Clip Height value.
- Syntax: Integer
Used by: +ETS Retail:, +ETS Weapons, +ETS Engines, +ETS Shields, +Target Monitor, +Afterburner Energy, +Weapon Energy, +Throttle
Letter Offsets:
Used by: +ETS Retail:
Top Offsets:
Used by: +ETS Retail:
Bottom Offsets:
Used by: +ETS Retail:
Gauge Offset:
- Distance between the individual weapon/shield/engine ETS gauges that comprise this gauge
- Syntax: Integer
Used by: +ETS Retail:
Monitor Filename:
Used by: +Target Monitor:
Integrity Bar Filename:
Used by: +Target Monitor:
Viewport Offsets:
Used by: +Target Monitor:
Viewport Size:
Used by: +Target Monitor:
Integrity Bar Offsets:
Used by: +Target Monitor:
Integrity Bar Foreground Clip Height:
Used by: +Target Monitor:
Status Offsets:
Used by: +Target Monitor:
Name Offsets:
Used by: +Target Monitor:
Class Offsets:
Used by: +Target Monitor:
Distance Offsets:
Used by: +Target Monitor:
Speed Offsets:
Used by: +Target Monitor:
Hull Offsets:
Used by: +Target Monitor:
Cargo Contents Offsets:
Used by: +Target Monitor:
Cargo Scan Start Offsets:
Used by: +Target Monitor:
Cargo Scan Size:
Used by: +Target Monitor:
Bracket Offsets:
Used by: +Extra Target Data:
Dock Offsets:
Used by: +Extra Target Data:
Dock Max Width:
Used by: +Extra Target Data:
Order Offsets:
Used by: +Extra Target Data:
Order Max Width:
Used by: +Extra Target Data:
Time Offsets:
Used by: +Extra Target Data:
Radar Center Offsets:
Defines the radar's plot origin as an offset, in pixels, from this gauge's Position coordinates
- Syntax: Integer horizontal offset, Integer vertical offset
Used by: +Radar:
Radar Size:
Size, in pixels, of the radar plot area.
Syntax: Integer horizontal size, Integer vertical size
Used by: +Radar:
Infinity Distance Offsets:
Used by: +Radar:
Offset to draw the infinity radar range symbol.
Long Distance Offsets:
Used by: +Radar:
Offset to draw the long range radar text (i.e. 10k).
Short Distance Offsets:
Used by: +Radar:
Offset to draw the short range radar text (i.e. 2k).
Size:
Used by: +Radar BSG:
XY Disc Filename:
Used by: +Radar BSG:
XZ YZ Disc Filename:
Used by: +Radar BSG:
Sweep Disc Filename:
Used by: +Radar BSG:
Default Contact Filename:
Used by: +Radar BSG:
Unknown Contact Filename:
Used by: +Radar BSG:
Loop Volume:
Used by: +Radar BSG
Minimum Beep Delay:
Used by: +Radar BSG
Firepoint display:
Displays the positions of the gun firepoints on your ship
- Syntax: Boolean, YES or NO
NOTE: The position of the firepoints is calculated from the Eye Point position in the POF. You may encounter weird results if you have no Eye Point defined, but no debug warnings will be raised.
Used by: +Center Reticle
Firepoint size:
Diameter of the gunpoint circles. Must be 4 or greater in order to work properly.
- Syntax: Integer
Used by: +Center Reticle
Firepoint X coordinate multiplier:
Used by: +Center Reticle
Firepoint Y coordinate multiplier:
Used by: +Center Reticle
Foreground Clip Bottom Y-offset:
Used by: +Throttle:
Foreground Clip Width:
Used by: +Throttle:
Afterburner Clip Height:
- Sets the area of the throttle gauge that represents the Afterburner segment (which is on top of the 0% to 100% area). The total height of the gauge is determined by the sum of this value and Foreground Clip Height:
Used by: +Throttle:
Show Background:
Used by: +Throttle:
Max Speed Label Offsets:
Used by: +Throttle:
Min Speed Label Offsets:
Used by: +Throttle:
Orbit Center Offsets:
Used by: +Throttle:
Orbit Radius:
Used by: +Throttle:
Arc Filename:
- Filename for the background graphic for this gauge
- Syntax: Filename
Needs to be an ani with a least 2 frames (but only the 2nd frame is used ?!?!? for threat & weapon linking so far)
Used by: +Threat Indicator:
Dumbfire Filename:
- Filename for the background graphic for this gauge
- Syntax: Filename
Needs to be an ani with a least 2 frames. The 1st frame is "no warning", the rest of the frames are cycled through when a warning is active.
Internally FSO also refers to this as the "laser threat warning".
Used by: +Threat Indicator:
Lock Filename:
- Filename for the background graphic for this gauge
- Syntax: Filename
Needs to be an ani with a least 2 frames. The 1st frame is "no warning", the rest of the frames are cycled through when a warning is active. Frames cycle twice as fast when a lock has been acquired, compared to when a lock is being acquired.
Used by: +Threat Indicator:
Dumbfire Offsets:
- Filename for the background graphic for this gauge
- Syntax: Filename
Used by: +Threat Indicator:
Lock Offsets:
- Filename for the background graphic for this gauge
- Syntax: Filename
Used by: +Threat Indicator:
Lock Filename:
Used by: +Lock Indicator:
Locked Filename:
Used by: +Lock Indicator:
Lock Center Offsets:
Used by: +Lock Indicator:
Locked Center Offsets:
Used by: +Lock Indicator:
Radius:
Defines the distance from the center of the screen to the base of the Hostile Triangle gauge.
- Syntax: Integer
- Default value:
- Units: Pixels
Used by: +Hostile Triangle:
Triangle Base:
Defines the width of the Hostile Triangle's base.
- Syntax: Float
- Default value:
- Units: Pixels
Used by: +Hostile Triangle:
Triangle Height:
Defines the height of the Hostile Triangle.
- Syntax: Float
Default value:
- Units: Pixels
Used by: +Hostile Triangle:
Center Offsets:
Used by: +Lead Indicator:
Single Primary Filename:
Designates the file to use for primary linking for ships with a single primary bank.
Needs to be an ani with 2 frames; 1st is bank 1 not selected (not that this should ever be able to happen), 2nd is bank 1 selected.
Used by: +Weapon Linking:
Double Primary Filename:
Designates the file to use for primary linking for ships with two primary banks.
Needs to be an ani with 4 frames:
- Frame 0 is no banks selected
- Frame 1 is 1st bank selected
- Frame 2 is 2nd bank selected
- Frame 3 is both banks selected/linked
Used by: +Weapon Linking:
Single Secondary Filename:
Designates the file to use for selected secondary bank for ships with a single secondary bank.
Needs to be an ani with 2 frames; 1st is bank 1 not selected, 2nd is bank 1 selected.
Used by: +Weapon Linking:
Double Secondary Filename:
Designates the file to use for selected secondary bank for ships with two secondary banks.
Needs to be an ani with 3 frames; 1st is no banks selected, 2nd is bank 1 selected, 3rd is bank 2 selected.
Used by: +Weapon Linking:
Triple Secondary Filename:
Designates the file to use for selected secondary bank for ships with two secondary banks.
Needs to be an ani with 4 frames; 1st is no banks selected, 2nd is bank 1 selected, 3rd is bank 2 selected, 4th is bank 3 selected.
Used by: +Weapon Linking:
Single Primary Offsets:
Used by: +Weapon Linking:
Double Primary Offsets:
Used by: +Weapon Linking:
Single Secondary Offsets:
Used by: +Weapon Linking:
Double Secondary Offsets:
Used by: +Weapon Linking:
Triple Secondary Offsets:
Used by: +Weapon Linking:
Hidden By Comms Menu:
Defines whether the messages gauge may be drawn at the same time as the wingman comms menu.
- Syntax: Boolean
- Default Value: false (messages are not visible while the comms menu is open)
Bottom Background Offset:
Defines the vertical pixel offset added to the position of the bottom background frame.
- Syntax: Integer vertical offset
- Units: Pixels
Center Text On Gauge X-Position:
Sets whether to position the center of the text to the gauge's X-position.
- Syntax Boolean
- Default Value: false if the gauge is explicitly given a position, true otherwise
N-gon Sides:
Defines the number of sides an N-gon radar has. If defined, the standard radar's edge is drawn as an N-gon, instead of the standard ellipsoid. Blips that are projected outside of the N-gon are snapped to the edge: the blip's angle stays the same but the blip's radius to the center of the plot area is reduced.
- Syntax Integer
- Default Value: 0 A value of 0 means to use the standard ellipsoid radar
- Minimum value: 3 (which is a triangle)
N-gon Offset:
Defines the angular offset to apply to the N-gon perimeter. The first vertex is at the 3 o'clock position, positive offsets spin this vertex counter-clockwise, negative offsets spin this clockwise.
- Syntax Float (radians)
- Default Value: 0
