Hud gauges.tbl

From FreeSpace Wiki

Jump to: navigation, search
This feature requires SCP

Revision information.....

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


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

List of Tables

Contents

HUD Configurations

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


$Load Retail Configuration:

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

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

  • Syntax: Boolean


$Color:

Optional. Sets the default HUD color for all gauges.

  • 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.

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


$Max Directives:

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

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


$Max Escort Ships:

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

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


$Length Unit Multiplier:

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

  • Syntax: Float
  • Valid Values: Any positive number


$Speed Unit Multiplier:

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

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


$Wireframe Targetbox:

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

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


$Targetbox Shader Effect:

FS2 Open, 3.6.15:

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:

FS2 Open, 3.7.1:

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

$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.


$Font:

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

$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:

FS2 Open, 3.7.1:

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


$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:
Position:
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
Color: (Optional)
Font: (Optional)
Name:
Text:
X Offset: (Optional)
Y Offset: (Optional)
Gauge Type:
Slew: (Optional)
Active by default: (Optional)
Filename:

+Messages:

Adds a gauge that display mission messages.

  • Valid Sub-Entries:
Position
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
Color: (Optional)
Font: (Optional)
Slew: (Optional)
Max Lines: (Optional)
Max Width: (Optional)
Line Height (Optional)
Total Lifetime: (Optional)
Scroll Time (Optional)
Step Size: (Optional)
Hidden By Comms Menu: (Optional)


+Training Messages:

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

  • Valid Sub-Entries:
Position
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
Font: (Optional)


+Support:

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

  • Valid Sub-Entries:
Position
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
Color: (Optional)
Font: (Optional)
Slew: (Optional)
Filename:
Header Offsets: (Optional)
Text Y-offset: (Optional)
Dock Status X-offset: (Optional)
Dock Time X-offset: (Optional)


+Damage:

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

  • Valid Sub-Entries:
Position
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
Color: (Optional)
Font: (Optional)
Slew: (Optional)
Top Background Filename: (Optional)
Entry Background Filename: (Optional)
Bottom Background Filename: (Optional)
Header Offsets: (Optional)
Hull Integrity Offsets (Optional)
Hull Integrity Value X-offset (Optional)
Top Background Height: (Optional)
Subsystem Entry Height: (Optional)
Subsystem List Start Offsets: (Optional)
Subsystem Entry Value X-offset: (Optional)
Bottom Background Offset: (Optional)

+Wingman Status:

Adds a gauge that monitors the status of your wing and squadron.

  • Valid Sub-entries:
Position
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
Color: (Optional)
Font: (Optional)
Slew: (Optional)
Left Background Filename: (Optional)
FS2 Open, 3.6.15:
First Background Filename: (Optional)
Right Background Filename: (Optional)
FS2 Open, 3.6.15:
Last Background Filename: (Optional)
Entry Background Filename: (Optional)
Dot Filename: (Optional)
Header Offsets: (Optional)
Left Background Width: (Optional)
FS2 Open, 3.6.15:
First Background Size: (Optional)
Entry Width: (Optional)
FS2 Open, 3.6.15:
Entry Size: (Optional)
Right Background Offset: (Optional)
Last Background Offset: (Optional)
Single Wing Offsets: (Optional)
Multiple Wing Start Offsets: (Optional)
Wing Name Offsets: (Optional)
Dot Offsets: (Optional)
Expansion Mode: (Optional)

+Auto Speed:

Adds the Auto-Speed mode gauge.

  • Valid Sub-entries:
Position
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
Color: (Optional)
Font: (Optional)
Slew: (Optional)
Filename:
Auto Offsets: (Optional)
Speed Offsets: (Optional)
FS2 Open, 3.6.15:
On Text Color: (Optional)
Off Text Color: (Optional)

+Auto Target:

Adds the Auto-target mode gauge.

  • Valid Sub-entries:
Position
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
Color: (Optional)
Font: (Optional)
Slew: (Optional)
Filename:
Auto Offsets: (Optional)
Target Offsets: (Optional)
FS2 Open, 3.6.15:
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:
Position
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
Color: (Optional)
Font: (Optional)
Slew: (Optional)
Filename:
Text Offsets: (Optional)
Value Offsets: (Optional)


+Talking Head:

Adds a video window to display pilot message videos (a.k.a talking heads).

  • Valid Sub-entries:
Position
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
Color: (Optional)
Font: (Optional)
Slew: (Optional)
Filename:
Header Offsets: (Optional)
Animation Offsets: (Optional)
Animation Background Size: (Optional)


+Directives:

Adds a gauge that displays all currently active directives (includes current , completed, and failed)

  • Valid Sub-entries:
Position
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
Color: (Optional)
Font: (Optional)
Top Background Filename: (Optional)
Entry Background Filename: (Optional)
Bottom Background Filename: (Optional)
Header Offsets: (Optional)
Top Background Height: (Optional)
List Start Offsets: (Optional)
Entry Height: (Optional)
FS2 Open, 3.6.15:
Bottom Background Offset: (Optional)
Max Line Width: (Optional)

+Weapons:

Adds a weapon status and ammunition gauge.

  • Valid Sub-entries:
Position
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
Color: (Optional)
Font: (Optional)
Slew: (Optional)
Primary List Top Background Filename: (Optional)
Primary List Middle Background Filename: (Optional)
Primary List Bottom Background Filename: (Optional)
Secondary List Top Background Filename: (Optional)
Secondary List Entry Background Filename: (Optional)
Secondary List Bottom Background Filename: (Optional)
Header Offsets: (Optional)
Text X-offset: (Optional)
Top Primary Frame Height: (Optional)
Top Secondary Frame Height: (Optional)
Primary List Start Y-offset: (Optional)
Secondary List Start Y-offset: (Optional)
Primary Weapon Ammo X-offset: (Optional)
Primary Weapon Link X-offset: (Optional)
Primary Weapon Name X-offset: (Optional)
Secondary Weapon Ammo X-offset: (Optional)
Secondary Weapon Linked X-offset: (Optional)
Secondary Weapon Name X-offset: (Optional)
Secondary Weapon Reload X-offset: (Optional)
Primary Weapon Entry Height: (Optional)
Secondary Weapon Entry Height: (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:
Position
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
Color: (Optional)
Font: (Optional)
Slew: (Optional)
Filename:
Objective Text Y-offset: (Optional)
Objective Value Y-offset: (Optional)
Subspace Text Y-offset: (Optional)
Subspace Value Y-offset: (Optional)
Red Alert Text Y-offset: (Optional)
Red Alert Value Y-offset: (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)
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
Color: (Optional)
Font: (Optional)
Slew: (Optional)
Top Background Filename: (Optional)
Entry Background Filename: (Optional)
Bottom Background Filename: (Optional)
Header Offsets: (Optional)
Top Background Height: (Optional)
List Start Offsets: (Optional)
Entry Height: (Optional)
FS2 Open, 3.6.15:
Bottom Background Offset (Optional)
Command X-offset: (Optional)
Page Up Offsets: (Optional)
Page Down Offsets: (Optional)

+Lag:

Adds a Lag gauge.

  • Valid Sub-entries:
Position
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
Color: (Optional)
Font: (Optional)
Slew: (Optional)
Filename:


+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:
Position
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
Color: (Optional)
Font: (Optional)
Slew: (Optional)
Filename:
3 Digit Hull Offsets: (Optional)
2 Digit Hull Offsets: (Optional)
1 Digit Hull Offsets: (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)
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
Color: (Optional)
Font: (Optional)
Slew: (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)
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
Color: (Optional)
Font: (Optional)
Slew: (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)
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
Color: (Optional)
Font: (Optional)
Slew: (Optional)
Top Background Filename: (Optional)
Entry Background Filename: (Optional)
Bottom Background Filename: (Optional)
Entry Height (Optional)
Entry Stagger Width: (Optional)
FS2 Open, 3.6.15:
Bottom Background Offset: (Optional)
Header Text (Optional)
Header Offsets: (Optional)
List Start Offsets: (Optional)
Hull X-offset (Optional)
Name X-offset (Optional)
Status X-offset (Optional)
FS2 Open, 3.6.15:
Ship Name Max Width: (Optional)

+Mission Time:

Adds a gauge that displays the current mission time.

  • Valid Sub-entries:
Position (Optional)
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
Color: (Optional)
Font: (Optional)
Slew: (Optional)
Filename: (Optional)
Text Offsets: (Optional)
Value Offsets: (Optional)


+ETS Retail:

FS2 Open, 3.6.13:

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

  • Valid Sub-entries:
Position (Optional)
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
FS2 Open, 3.6.13:
Color: (Optional)
Font: (Optional)
Slew: (Optional)
Filename: (Optional)
Foreground Clip Height: (Optional)
Letter Offsets: (Optional)
Top Offsets: (Optional)
Bottom Offsets: (Optional)
Gauge Offset: (Optional)


+ETS Weapons:

Adds a gauge that displays the energy transfer rate for the energy weapons.

  • Valid Sub-entries:
Position (Optional)
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
Color: (Optional)
Font: (Optional)
Slew: (Optional)
Filename: (Optional)
Foreground Clip Height: (Optional)
Letter Offsets: (Optional)
Top Offsets: (Optional)
Bottom Offsets: (Optional)


+ETS Engines:

Adds a gauge that displays the energy transfer rate for the afterburner/engines.

  • Valid Sub-entries:
Position (Optional)
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
Color: (Optional)
Font: (Optional)
Slew: (Optional)
Filename: (Optional)
Foreground Clip Height: (Optional)
Letter Offsets: (Optional)
Top Offsets: (Optional)
Bottom Offsets: (Optional)


+ETS Shields:

Adds a gauge that displays the energy transfer rate for the shields.

  • Valid Sub-entries:
Position (Optional)
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
Color: (Optional)
Font: (Optional)
Slew: (Optional)
Filename: (Optional)
Foreground Clip Height: (Optional)
Letter Offsets: (Optional)
Top Offsets: (Optional)
Bottom Offsets: (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)
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
Color: (Optional)
Font: (Optional)
Monitor Filename: (Optional)
FS2 Open, 3.6.15:
Monitor Alpha Mask Filename: (Optional)
Integrity Bar Filename: (Optional)
Viewport Offsets: (Optional)
Viewport Size: (Optional)
Integrity Bar Offsets: (Optional)
Integrity Bar Foreground Clip Height: (Optional)
Status Offsets: (Optional)
Name Offsets: (Optional)
Class Offsets: (Optional)
Distance Offsets: (Optional)
Speed Offsets: (Optional)
Hull Offsets: (Optional)
Cargo Contents Offsets: (Optional)
Cargo Scan Start Offsets: (Optional)
Cargo Scan Size: (Optional)
FS2 Open, 3.6.15:
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)
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
Color: (Optional)
Font: (Optional)
Slew: (Optional)
Filename: (Optional)
Bracket Offsets: (Optional)
Dock Offsets: (Optional)
Order Offsets: (Optional)
Time Offsets: (Optional)


+Radar:

Adds a standard radar gauge

  • Valid Sub-entries:
Position (Optional)
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
Color: (Optional)
Font: (Optional)
Filename: (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)
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
Color: (Optional)
Font: (Optional)
Filename: (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)
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
Font: (Optional)
Size: (Optional)
XY Disc Filename: (Optional)
XZ YZ Disc Filename: (Optional)
Sweep Disc Filename: (Optional)
Default Contact Filename: (Optional)
Unknown Contact Filename: (Optional)
Cockpit Target: (Optional)
Canvas Size:
Display Offset:
Display Size:
Loop Volume: (Optional)
Minimum Beep Delay (Optional)

+Afterburner Energy:

Adds a gauge that shows the remaining afterburner energy.

  • Valid Sub-Entries:
Position (Optional)
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
Color: (Optional)
Font: (Optional)
Slew: (Optional)
Filename: (Optional)
Foreground Clip Height: (Optional)


+Weapon Energy:

Adds a gauge that shows the remaining weapon energy.

  • Valid Sub-Entries:
Position (Optional)
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
Color: (Optional)
Font: (Optional)
Slew: (Optional)
Filename: (Optional)
Foreground Clip Height: (Optional)
Text Offsets: (Optional)
FS2 Open, 3.6.15:
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)
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
Color: (Optional)
Font: (Optional)
Slew: (Optional)

+Center Reticle:

Adds a "custom" center reticle.

  • Valid Sub-Entries:
Position (Optional)
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
Color: (Optional)
Font: (Optional)
Filename: (Optional)
Firepoint display: (Optional)
Firepoint size: (Optional)
Firepoint X coordinate multiplier: (Optional)
Firepoint Y coordinate multiplier: (Optional)


+Throttle:

Adds a gauge that shows the current throttle position.

  • Valid Sub-Entries:
Position (Optional)
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
Color: (Optional)
Font: (Optional)
Filename: (Optional)
Foreground Clip Bottom Y-offset: (Optional)
Foreground Clip Width: (Optional)
Foreground Clip Height: (Optional)
Afterburner Clip Height: (Optional)
Show Background: (Optional)
Max Speed Label Offsets: (Optional)
FS2 Open, 3.6.15:
Show Max Speed Label: (Optional)
Min Speed Label Offsets: (Optional)
FS2 Open, 3.6.15:
Show Min Speed Label: (Optional)
Orbit Center Offsets: (Optional)
Orbit Radius: (Optional)
FS2 Open, 3.6.15:
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)
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
Color: (Optional)
Font: (Optional)
Slew: (Optional)
Arc Filename: (Optional)
Dumbfire Filename: (Optional)
Lock Filename: (Optional)
Dumbfire Offsets: (Optional)
Lock Offsets: (Optional)


+Multiplayer Messages:

Adds a gauge that displays the multiplayer messages.

  • Valid Sub-Entries:
Position (Optional)
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
Font: (Optional)


+Voice Status:

Adds a gauge that displays the voice status.

  • Valid Sub-Entries:
Position (Optional)
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
Color: (Optional)
Font: (Optional)


+Ping:

Adds a gauge that the ping time to the multiplayer server.

  • Valid Sub-Entries:
Position (Optional)
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
Color: (Optional)
Font: (Optional)


+Supernova:

Adds a gauge that warns the player of an impending supernova shock wave.

  • Valid Sub-Entries:
Position (Optional)
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
Color: (Optional)
Font: (Optional)


+Lock Indicator:

Adds a Lock Indicator gauge.

  • Valid Sub-Entries:
Font: (Optional)
Lock Filename: (Optional)
Locked Filename: (Optional)
Lock Center Offsets: (Optional)
Locked Center Offsets: (Optional)


+Offscreen Indicator:

Adds an Offscreen Indicator.

  • Valid Sub-Entries:
Font: (Optional)


+Target Brackets:

Adds a Target Bracket gauge. This is drawn around current target(s) and talkers.

  • Valid Sub-Entries:
Font: (Optional)
Dot Filename: (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)
Slew: (Optional)
Radius (Optional)
Triangle Base: (Optional)
Triangle Height: (Optional)


+Target Triangle:

Adds a gauge that points to the targeted craft, if it is currently off-screen.

  • Valid Sub-entries:
Font: (Optional)
Slew: (Optional)
Radius (Optional)
Triangle Base: (Optional)
Triangle Height: (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)
Slew: (Optional)
Radius (Optional)
Triangle Base: (Optional)
Triangle Height: (Optional)


+Lead Indicator:

Adds a gauge that is used to raise the probability of hitting a target with primary weapons.

  • Valid Sub-entries:
Font: (Optional)
Filename: (Optional)
Frame #0: Secondaries lead indicator (Dumbfire)
Frame #1: Secondaries lead indicator (Homing)
Frame #2: Primaries lead indicator
Center Offsets: (Optional)


+Orientation Tee:

Adds a gauge that indicates the targeted craft's orientation in relation to the player's craft.

  • Valid Sub-Entries:
Position (Optional)
Font: (Optional)
Slew: (Optional)
Radius (Optional)


+Lead Sight:

Adds a gauge that indicates where your shots will end up, as opposed to Lead Indicator that indicates where you have to shoot at to hit your target. Notably used by Diaspora.

  • Valid Sub-Entries:
Position (Optional)
Color: (Optional)
Font: (Optional)
Slew: (Optional)
Filename: (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)
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
Color: (Optional)
Font: (Optional)
Slew: (Optional)
Filename: (Optional)
Text Offsets: (Optional)
Value Offsets: (Optional)

+Weapon Linking:

Adds a gauge that indicates the selected weapons and their firing rates.

  • Valid Sub-Entries:
Position (Optional)
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
Color: (Optional)
Font: (Optional)
Slew: (Optional)
Arc Filename: (Optional)
Single Primary Filename: (Optional)
Double Primary Filename: (Optional)
Single Secondary Filename: (Optional)
Double Secondary Filename: (Optional)
Triple Secondary Filename: (Optional)
Single Primary Offsets: (Optional)
Double Primary Offsets: (Optional)
Single Secondary Offsets: (Optional)
Double Secondary Offsets: (Optional)
Triple Secondary Offsets: (Optional)


+Fixed Messages:

  • Valid Sub-Entries:
Position (Optional)
FS2 Open, 3.7.1:
Scale Gauge: (Optional)
Origin: (Optional, incompatible with Position:, requires Offset:)
Offset: (Optional, incompatible with Position:, requires Origin:)
FS2 Open, 3.6.15:
Cockpit Target: (Optional)
Canvas Size: (Optional)
Display Offset: (Optional)
Display Size:
Color: (Optional)
Font: (Optional)

+Flight Path Marker:

FS2 Open, 3.6.15:

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:

FS2 Open, 3.6.15:

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)
Slew: (Optional)
Filename: (Optional)
Name Offsets: (Optional)
Count Offsets: (Optional)
Icon Width: (Optional)
Icon Height: (Optional)
Max Icons: (Optional)
Max Columns: (Optional)
Name Alignment: (Optional)

+Hardpoints:

FS2 Open, 3.6.15:

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:

FS2 Open, 3.6.15:

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)
Slew: (Optional)
Header Offsets: (Optional)
Header Text: (Optional)
First Background Filename: (Optional)
First Background Height: (Optional)
First Background X-offset: (Optional)
Entry Background Filename: (Optional)
Entry Background Height: (Optional)
Entry Background X-offset: (Optional)
Last Background Filename: (Optional)
Last Background X-offset: (Optional)
Last Background Y-offset: (Optional)
Entry Height: (Optional)
List Start Y-offset: (Optional)
Ammo X-offset: (Optional)
Link X-offset: (Optional)
Name X-offset: (Optional)

+Secondary Weapons:

FS2 Open, 3.6.15:

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)
Slew: (Optional)
Header Offsets: (Optional)
Header Text: (Optional)
First Background Filename: (Optional)
First Background Height: (Optional)
First Background X-offset: (Optional)
Entry Background Filename: (Optional)
Entry Background Height: (Optional)
Entry Background X-offset: (Optional)
Last Background Filename: (Optional)
Last Background X-offset: (Optional)
Last Background Y-offset: (Optional)
Entry Height: (Optional)
List Start Y-offset: (Optional)
Ammo X-offset: (Optional)
Link X-offset: (Optional)
Name X-offset: (Optional)
Unlink X-offset: (Optional)
Reload X-offset: (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:

FS2 Open, 3.7.1:

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

Origin:

FS2 Open, 3.7.1:

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:

FS2 Open, 3.7.1:

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:.

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.

Used by: +Custom:, +Support


Font:

Optional. Overrides both previous font settings ($Font HUD option and $Font ship class option) for this particular gauge.

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

Used by: +Custom:, +Support

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: 12

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.

Note: All HUD .ANI's must have the same color palette as the retail .ANI's in order to render properly. (.EFF's do not have this restriction)


  • Syntax: Filename
    • No filename extension is needed.


Used by: +Custom:, +Support

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 background (?)

  • Syntax: Filename

Used by: +Wingman Status:


Right Background Filename:

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

  • Syntax: Filename

Used by: +Wingman Status:


Entry Background Filename:

Optional. Designates which file to use for the Entry background

  • Syntax: Filename

Used by: +Damage, +Wingman Status:


Primary List Top Background Filename:

Optional. Designates which file to use for the Primary List Top Background

Used by: +Weapons:


Primary List Middle Background Filename:

Optional. Designates which file to use for the Primary List Middle Background

Used by: +Weapons:


Primary List Bottom Background Filename:

Optional. Designates which file to use for the Primary List Bottom Background

Used by: +Weapons:


Secondary List Top Background Filename:

Optional. Designates which file to use for the Secondary List Top Background

Used by: +Weapons:


Secondary List Entry Background Filename:

Optional. Designates which file to use for the Secondary List Entry Background

Used by: +Weapons:


Secondary List Bottom Background Filename:

Optional. Designates which file to use for the Secondary List Bottom Background

Used by: +Weapons:


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 the Support Ship header (?)

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

Used by: +Support:, +Damage:


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
  • Units: Pixels


Warning: All 5 wingman positions must be defined

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

  • Syntax: String
  • Valid Values:
  • "Right"  ;; Wings are added to the right of the previous wing

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:

Optional. Defines the size of the animation's background (?)

  • Syntax: Integer horizontal offset, Integer vertical offset
  • 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:


Top Primary Background X-offset:

Optional. Defines the screen coordinate offset for the Top Primary Background

  • Syntax: Integer
  • Units: Pixels

Used by: +Weapons:


Text X-offset:

Used by: +Weapons:


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:


Foreground Clip Height:

Used by: +ETS Retail:


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:


Order Offsets:

Used by: +Extra Target Data:


Time Offsets:

Used by: +Extra Target Data:


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


Foreground Clip Height:

Used by: +Afterburner Energy:

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:


Foreground Clip Height:

Used by: +Throttle:


Afterburner 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

Used by: +Threat Indicator:


Dumbfire Filename:

  • Filename for the background graphic for this gauge
  • Syntax: Filename

Used by: +Threat Indicator:


Lock Filename:

  • Filename for the background graphic for this gauge
  • Syntax: Filename

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 the primary single fire-mode.

Used by: +Weapon Linking:


Double Primary Filename:

Used by: +Weapon Linking:

Single Secondary Filename:

Used by: +Weapon Linking:

Double Secondary Filename:

Used by: +Weapon Linking:

Triple Secondary Filename:

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:

FS2 Open, 3.6.15:

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)
Used by: +Messages:

Bottom Background Offset:

FS2 Open, 3.6.15:

Defines the vertical pixel offset added to the position of the bottom background frame.

  • Syntax: Integer vertical offset
  • Units: Pixels
Used by: +Damage:
Personal tools