Difference between revisions of "Hud gauges.tbl"

Revision as of 22:11, 16 July 2012

This feature requires FreeSpace Open

Revision information.....

FSO Revision: 9018

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

Warning: This Wiki page is currently being updated. Please be patient while the changes are done

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

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

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

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

HUD Configurations

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

$Load Retail Configuration:

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

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

Syntax: Boolean

$Color:

Optional. Sets the default HUD color for all gauges.

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

$Font:

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

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

$Max Directives:

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

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

$Max Escort Ships:

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

Syntax: Integer
Valid Values: Any positive number

Warning: Entries more than 16 will cause the list to overflow into the weapons list for resolutions lower than 1024x768.

$Length Unit Multiplier:

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

Syntax: Float
Valid Values: Any positive number

$Speed Unit Multiplier:

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

Syntax: Float
Valid Values: Any positive number
Default Values:

The value used in $Length Unit Multiplier, or

1, if $Length Unit Multiplier is undefined

$Wireframe Targetbox:

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

Syntax: Integer Draw method ID
Valid Values:

0 - Standard with full, bright lighting

1 - Wireframe

2 - Standard with proper lighting (i.e. lit the same as the actual target)

FS2 Open, 3.6.16:

3 - Untextured with full bright lighting (i.e. drawn with a single flat color)

$Targetbox Shader Effect:

FS2 Open, 3.6.16:

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

Syntax: Integer
Valid Values: Any positive number

$Lock Wireframe Mode:

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

Syntax: Boolean

$Reticle Style:

Optional. Defines which aiming reticle to use.

Syntax: String
Valid Values:

FS1 - uses reticle1_fs1.ani

FS2 - uses reticle1.ani

#Gauge Config

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

$Ship:

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

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

Syntax: String, ship class name

$Load Retail Configuration:

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

Syntax: Boolean

$Color:

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

Syntax: See $Color

$Font:

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

Syntax: See $Font

$Base:

Defines the base resolution for this HUD configuration.

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

$Required Aspect:

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

Syntax: String
Valid Values:

"Full Screen" (4:3)

"Wide Screen" (16:9, 16:10, or similar)

$Min:

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

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

$Max:

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

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

$Gauges:

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

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:

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

Color: (Optional)

Font: (Optional)

Slew: (Optional)

Max Lines: (Optional)

Max Width: (Optional)

Line Height (Optional)

Total Lifetime: (Optional)

Scroll Time (Optional)

Step Size: (Optional)

+Training Messages:

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

Valid Sub-Entries:

Position

Font: (Optional)

+Support:

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

Valid Sub-Entries:

Position

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

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)

+Wingman Status:

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

Valid Sub-entries:

Position

Color: (Optional)

Font: (Optional)

Slew: (Optional)

Left Background Filename: (Optional)

Right Background Filename: (Optional)

Entry Background Filename: (Optional)

Dot Filename: (Optional)

Header Offsets: (Optional)

Left Background Width: (Optional)

Entry Width: (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

Color: (Optional)

Font: (Optional)

Slew: (Optional)

Filename:

Auto Offsets: (Optional)

Speed Offsets: (Optional)

+Auto Target:

Adds the Auto-target mode gauge.

Valid Sub-entries:

Position

Color: (Optional)

Font: (Optional)

Slew: (Optional)

Filename:

Auto Offsets: (Optional)

Target Offsets: (Optional)

+Countermeasures:

Adds a gauge that monitors the amount of remaining countermeasures the player's ship currently has.

Valid Sub-entries:

Position

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

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

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)

: (Optional)

+Weapons:

Adds a weapon status and ammunition gauge.

Valid Sub-entries:

Position

Color: (Optional)

Font: (Optional)

Slew: (Optional)

Header Offsets: (Optional)

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:

Top Primary Background X-offset:

Text X-offset:

Top Primary Frame Height:

Top Secondary Frame Height:

Primary List Start Y-offset:

Secondary List Start Y-offset:

Primary Weapon Ammo X-offset:

Primary Weapon Link X-offset:

Primary Weapon Name X-offset:

Secondary Weapon Ammo X-offset:

Secondary Weapon Linked X-offset:

Secondary Weapon Name X-offset:

Secondary Weapon Reload X-offset:

Primary Weapon Entry Height:

Secondary Weapon Entry Height:

+Lag:

Adds a Lag gauge.

Valid Sub-entries:

Position

Color: (Optional)

Font: (Optional)

Slew: (Optional)

Filename:

Filename for the background graphic for this gauge
Syntax: Filename

+Mini Target Shields:

Position:

Screen coordinates for this gauge
Syntax: (Integer, Integer)

Font:

As per the global option above.
Syntax: Integer

Slew:

Optional. Whether this gauge is affected by afterburner shaking or similar effects.
Syntax: Boolean

Filename:

Filename for the background graphic for this gauge
Syntax: Filename

3 Digit Hull Offsets:

2 Digit Hull Offsets:

1 Digit Hull Offsets:

+Player Shields:

Position:

Screen coordinates for this gauge
Syntax: (Integer, Integer)

Font:

As per the global option above.
Syntax: Integer

Slew:

Optional. Whether this gauge is affected by afterburner shaking or similar effects.
Syntax: Boolean

+Target Shields:

Position:

Screen coordinates for this gauge
Syntax: (Integer, Integer)

Font:

As per the global option above.
Syntax: Integer

Slew:

Optional. Whether this gauge is affected by afterburner shaking or similar effects.
Syntax: Boolean

+Escort View:

Position:

Screen coordinates for this gauge
Syntax: (Integer, Integer)

Font:

As per the global option above.
Syntax: Integer

Slew:

Optional. Whether this gauge is affected by afterburner shaking or similar effects.
Syntax: Boolean

Top Background Filename:

Entry Background Filename:

Bottom Background Filename:

Entry Height:

Entry Stagger Width:

Header Text:

Header Offsets:

List Start Offsets:

Hull X-offset:

Name X-offset:

Status X-offset:

+Mission Time:

Position:

Screen coordinates for this gauge
Syntax: (Integer, Integer)

Font:

As per the global option above.
Syntax: Integer

Slew:

Optional. Whether this gauge is affected by afterburner shaking or similar effects.
Syntax: Boolean

Filename:

Filename for the background graphic for this gauge
Syntax: Filename

Text Offsets:

Value Offsets:

+ETS Retail:

FS2 Open, 3.6.14:

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

Position:

Screen coordinates for this gauge
Syntax: (Integer, Integer)

Font:

As per the global option above.
Syntax: Integer

Slew:

Optional. Whether this gauge is affected by afterburner shaking or similar effects.
Syntax: Boolean

Filename:

Filename for the background graphic for this gauge
Syntax: Filename

Foreground Clip Height:

Letter Offsets:

Top Offsets:

Bottom Offsets:

Gauge Offset:

Distance between the individual weapon/shield/engine ETS gauges that comprise this gauge
Syntax: Integer

+ETS Weapons:

Position:

Screen coordinates for this gauge
Syntax: (Integer, Integer)

Font:

As per the global option above.
Syntax: Integer

Slew:

Optional. Whether this gauge is affected by afterburner shaking or similar effects.
Syntax: Boolean

Filename:

Filename for the background graphic for this gauge
Syntax: Filename

Foreground Clip Height:

Letter Offsets:

Top Offsets:

Bottom Offsets:

+ETS Engines:

Position:

Screen coordinates for this gauge
Syntax: (Integer, Integer)

Font:

As per the global option above.
Syntax: Integer

Slew:

Optional. Whether this gauge is affected by afterburner shaking or similar effects.
Syntax: Boolean

Filename:

Filename for the background graphic for this gauge
Syntax: Filename

Foreground Clip Height:

Letter Offsets:

Top Offsets:

Bottom Offsets:

+ETS Shields:

Position:

Screen coordinates for this gauge
Syntax: (Integer, Integer)

Font:

As per the global option above.
Syntax: Integer

Slew:

Optional. Whether this gauge is affected by afterburner shaking or similar effects.
Syntax: Boolean

Filename:

Filename for the background graphic for this gauge
Syntax: Filename

Foreground Clip Height:

Letter Offsets:

Top Offsets:

Bottom Offsets:

+Target Monitor:

Position:

Screen coordinates for this gauge
Syntax: (Integer, Integer)

Font:

As per the global option above.
Syntax: Integer

Monitor Filename:

Integrity Bar Filename:

Viewport Offsets:

Viewport Size:

Integrity Bar Offsets:

Integrity Bar Foreground Clip Height:

Status Offsets:

Name Offsets:

Class Offsets:

Distance Offsets:

Speed Offsets:

Hull Offsets:

Cargo Contents Offsets:

Cargo Scan Start Offsets:

Cargo Scan Size:

+Extra Target Data:

Position:

Screen coordinates for this gauge
Syntax: (Integer, Integer)

Font:

As per the global option above.
Syntax: Integer

Slew:

Optional. Whether this gauge is affected by afterburner shaking or similar effects.
Syntax: Boolean

Filename:

Filename for the background graphic for this gauge
Syntax: Filename

Bracket Offsets:

Dock Offsets:

Order Offsets:

Time Offsets:

+Radar:

Position:

Screen coordinates for this gauge
Syntax: (Integer, Integer)

Font:

As per the global option above.
Syntax: Integer

Filename:

Filename for the background graphic for this gauge
Syntax: Filename

Infinity Distance Offsets:

Long Distance Offsets:

Short Distance Offsets:

+Radar Orb:

Position:

Screen coordinates for this gauge
Syntax: (Integer, Integer)

Font:

As per the global option above.
Syntax: Integer

Filename:

Filename for the background graphic for this gauge
Syntax: Filename

Infinity Distance Offsets:

Long Distance Offsets:

Short Distance Offsets:

+Radar BSG:

Position:

Screen coordinates for this gauge
Syntax: (Integer, Integer)

Font:

As per the global option above.
Syntax: Integer

Size:

XY Disc Filename:

XZ YZ Disc Filename:

Sweep Disc Filename:

Default Contact Filename:

Unknown Contact Filename:

Cockpit Target:

Canvas Size:

Display Offset:

Display Size:

+Afterburner Energy:

Position:

Screen coordinates for this gauge
Syntax: (Integer, Integer)

Font:

As per the global option above.
Syntax: Integer

Slew:

Optional. Whether this gauge is affected by afterburner shaking or similar effects.
Syntax: Boolean

Filename:

Filename for the background graphic for this gauge
Syntax: Filename

Foreground Clip Height:

+Weapon Energy:

Position:

Screen coordinates for this gauge
Syntax: (Integer, Integer)

Font:

As per the global option above.
Syntax: Integer

Slew:

Optional. Whether this gauge is affected by afterburner shaking or similar effects.
Syntax: Boolean

Filename:

Filename for the background graphic for this gauge
Syntax: Filename

Foreground Clip Height:

Text Offsets:

+Text Warnings:

Position:

Screen coordinates for this gauge
Syntax: (Integer, Integer)

Font:

As per the global option above.
Syntax: Integer

Slew:

Optional. Whether this gauge is affected by afterburner shaking or similar effects.
Syntax: Boolean

+Center Reticle:

Position:

Screen coordinates for this gauge
Syntax: (Integer, Integer)

Font:

As per the global option above.
Syntax: Integer

Filename:

Filename for the background graphic for this gauge
Syntax: Filename

Firepoint display:

Displays the positions of the gun firepoints on your ship
Syntax: Boolean, YES or NO

Firepoint size:

Diameter of the gunpoint circles. Must be 4 or greater in order to work properly.
Syntax: Integer

Firepoint X coordinate multiplier:

Firepoint Y coordinate multiplier:

+Throttle:

Position:

Screen coordinates for this gauge
Syntax: (Integer, Integer)

Font:

As per the global option above.
Syntax: Integer

Slew:

Optional. Whether this gauge is affected by afterburner shaking or similar effects.
Syntax: Boolean

Filename:

Filename for the background graphic for this gauge
Syntax: Filename

Foreground Clip Bottom Y-offset:

Foreground Clip Width:

Foreground Clip Height:

Afterburner Clip Height:

Show Background:

Max Speed Label Offsets:

Min Speed Label Offsets:

Orbit Center Offsets:

Orbit Radius:

+Threat Indicator:

Position:

Screen coordinates for this gauge
Syntax: (Integer, Integer)

Font:

As per the global option above.
Syntax: Integer

Slew:

Optional. Whether this gauge is affected by afterburner shaking or similar effects.
Syntax: Boolean

Arc Filename:

Filename for the background graphic for this gauge
Syntax: Filename

Dumbfire Filename:

Filename for the background graphic for this gauge
Syntax: Filename

Lock Filename:

Filename for the background graphic for this gauge
Syntax: Filename

Dumbfire Offsets:

Filename for the background graphic for this gauge
Syntax: Filename

Lock Offsets:

Filename for the background graphic for this gauge
Syntax: Filename

+Multiplayer Messages:

Position:

Screen coordinates for this gauge
Syntax: (Integer, Integer)

Font:

As per the global option above.
Syntax: Integer

+Voice Status:

Position:

Screen coordinates for this gauge
Syntax: (Integer, Integer)

Font:

As per the global option above.
Syntax: Integer

Slew:

Optional. Whether this gauge is affected by afterburner shaking or similar effects.
Syntax: Boolean

+Ping:

Position:

Screen coordinates for this gauge
Syntax: (Integer, Integer)

Font:

As per the global option above.
Syntax: Integer

Slew:

Optional. Whether this gauge is affected by afterburner shaking or similar effects.
Syntax: Boolean

+Supernova:

Position:

Screen coordinates for this gauge
Syntax: (Integer, Integer)

Font:

As per the global option above.
Syntax: Integer

Slew:

Optional. Whether this gauge is affected by afterburner shaking or similar effects.
Syntax: Boolean

+Lock Indicator:

Font:

As per the global option above.
Syntax: Integer

Lock Filename:

Locked Filename:

Lock Center Offsets:

Locked Center Offsets:

+Offscreen Indicator:

Font:

As per the global option above.
Syntax: Integer

+Target Brackets:

Font:

As per the global option above.
Syntax: Integer

Dot Filename:

+Hostile Triangle:

Position:

Screen coordinates for this gauge
Syntax: (Integer, Integer)

Font:

As per the global option above.
Syntax: Integer

Slew:

Optional. Whether this gauge is affected by afterburner shaking or similar effects.
Syntax: Boolean

Radius:

Triangle Base:

Triangle Height:

+Target Triangle:

Position:

Screen coordinates for this gauge
Syntax: (Integer, Integer)

Font:

As per the global option above.
Syntax: Integer

Slew:

Optional. Whether this gauge is affected by afterburner shaking or similar effects.
Syntax: Boolean

Radius:

Triangle Base:

Triangle Height:

+Missile Triangles:

Position:

Screen coordinates for this gauge
Syntax: (Integer, Integer)

Font:

As per the global option above.
Syntax: Integer

Slew:

Optional. Whether this gauge is affected by afterburner shaking or similar effects.
Syntax: Boolean

Radius:

Triangle Base:

Triangle Height:

+Lead Indicator:

Font:

As per the global option above.
Syntax: Integer

Filename:

Filename for the background graphic for this gauge
Syntax: Filename

Center Offsets:

+Orientation Tee:

Position:

Screen coordinates for this gauge
Syntax: (Integer, Integer)

Font:

As per the global option above.
Syntax: Integer

Slew:

Optional. Whether this gauge is affected by afterburner shaking or similar effects.
Syntax: Boolean

Radius:

+Lead Sight:

Position:

Screen coordinates for this gauge
Syntax: (Integer, Integer)

Font:

As per the global option above.
Syntax: Integer

Filename:

Filename for the background graphic for this gauge
Syntax: Filename

+Kills:

Position:

Screen coordinates for this gauge
Syntax: (Integer, Integer)

Font:

As per the global option above.
Syntax: Integer

Slew:

Optional. Whether this gauge is affected by afterburner shaking or similar effects.
Syntax: Boolean

Filename:

Filename for the background graphic for this gauge
Syntax: Filename

Text Offsets:

Value Offsets:

+Weapon Linking:

Position:

Screen coordinates for this gauge
Syntax: (Integer, Integer)

Font:

As per the global option above.
Syntax: Integer

Slew:

Optional. Whether this gauge is affected by afterburner shaking or similar effects.
Syntax: Boolean

Arc Filename:

Single Primary Filename:

Double Primary Filename:

Single Secondary Filename:

Double Secondary Filename:

Triple Secondary Filename:

Single Primary Offsets:

Double Primary Offsets:

Single Secondary Offsets:

Double Secondary Offsets:

Triple Secondary Offsets:

+Fixed Messages:

Position:

Screen coordinates for this gauge
Syntax: (Integer, Integer)

Font:

As per the global option above.
Syntax: Integer

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

Color:

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

Syntax: See Hud_gauges.tbl#$Color: 1

Used by: +Custom:, +Support

Font:

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

Syntax: See Hud_gauges.tbl#$Font: 1

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 defined by Hud_gauges#$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 Hud_gauges#$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. (May also follow the player's head movements when using TrackIR)

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 Hud_gauges.tbl#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 Hud_gauges.tbl#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 file used for this gauge's the background graphic

Syntax: Filename

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

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

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

Used by: Hud_gauges.tbl#+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: Hud_gauges.tbl#+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:

@@ Line 2: / Line 2: @@
 {{TableVersion|9018}}
+{{Warning|
+This Wiki page is currently being updated. Please be patient while the changes are done}}
 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).
@@ Line 240: / Line 245: @@
 :[[Hud_gauges.tbl#Top Background Filename:|Top Background Filename:]] (Optional)
 :[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional)
-:[[Hud_gauges.tbl#Bottom Background Filename:Bottom Background Filename:]] (Optional)
+:[[Hud_gauges.tbl#Bottom Background Filename:|Bottom Background Filename:]] (Optional)
 :[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
 :[[Hud_gauges.tbl#Hull Integrity Offsets:|Hull Integrity Offsets]] (Optional)
@@ Line 270: / Line 275: @@
 :[[Hud_gauges.tbl#Dot Offsets:|Dot Offsets:]] (Optional)
 :[[Hud_gauges.tbl#Expansion Mode:|Expansion Mode:]] (Optional)
-:[[Hud_gauges.tbl#:|:]] (Optional)
@@ Line 310: / Line 314: @@
 :[[Hud_gauges.tbl#Text Offsets:|Text Offsets:]] (Optional)
 :[[Hud_gauges.tbl#Value Offsets:|Value Offsets:]] (Optional)
-:[[Hud_gauges.tbl#:|:]] (Optional)
@@ Line 316: / Line 319: @@
 Adds a video window to display pilot message videos (a.k.a talking heads).
+*Valid Sub-entries:
+:[[Hud_gauges.tbl#Position:|Position]]
+:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
+:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
+:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
+:[[Hud_gauges.tbl#Filename:|Filename:]]
+:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
+:[[Hud_gauges.tbl#Animation Offsets:|Animation Offsets:]] (Optional)
+:[[Hud_gauges.tbl#Animation Background Size:|Animation Background Size:]] (Optional)
-=====Position:=====
-Defines the screen coordinates for the upper left corner of this gauge.
-*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
-*Units: Pixels
+====+Directives:====
+Adds a gauge that displays all currently active directives (includes current , completed, and failed)
-=====Color:=====
+*Valid Sub-entries:
-Optional. Overrides both previous color settings ([[Hud_gauges.tbl#$Color: 1|$Font]] HUD option and [[Hud_gauges#$Color: 2|$Font]] ship class option) for this particular gauge.
+:[[Hud_gauges.tbl#Position:|Position]]
+:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
-*Syntax: See [[Hud_gauges.tbl#$Color: 1]]
+:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
+:[[Hud_gauges.tbl#Top Background Filename:|Top Background Filename:]] (Optional)
+:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional)
+:[[Hud_gauges.tbl#Bottom Background Filename:|Bottom Background Filename:]] (Optional)
+:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
+:[[Hud_gauges.tbl#Top Background Height:|Top Background Height:]] (Optional)
+:[[Hud_gauges.tbl#List Start Offsets:|List Start Offsets:]] (Optional)
+:[[Hud_gauges.tbl#Entry Height:|Entry Height:]] (Optional)
+:[[Hud_gauges.tbl#:|:]] (Optional)
-=====Font:=====
+====+Weapons:====
-Optional. Overrides both previous font settings ([[Hud_gauges.tbl#$Font: 1|$Font]] HUD option and [[Hud_gauges#$Font: 2|$Font]] ship class option) for this particular gauge.
+Adds a weapon status and ammunition gauge.
+*Valid Sub-entries:
+:[[Hud_gauges.tbl#Position:|Position]]
+:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
+:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
+:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
-*Syntax: See [[Hud_gauges.tbl#$Font: 1]]
+:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
+====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:====
+====Top Primary Background X-offset:====
+====Text X-offset:====
+====Top Primary Frame Height:====
+====Top Secondary Frame Height:====
+====Primary List Start Y-offset:====
+====Secondary List Start Y-offset:====
+====Primary Weapon Ammo X-offset:====
+====Primary Weapon Link X-offset:====
+====Primary Weapon Name X-offset:====
+====Secondary Weapon Ammo X-offset:====
+====Secondary Weapon Linked X-offset:====
+====Secondary Weapon Name X-offset:====
+====Secondary Weapon Reload X-offset:====
+====Primary Weapon Entry Height:====
+====Secondary Weapon Entry Height:====
+====+Lag:====
+Adds a Lag gauge.
+*Valid Sub-entries:
+:[[Hud_gauges.tbl#Position:|Position]]
+:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
+:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
+:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
 =====Filename:=====
-Optional. Designates which file to use for the background of this gauge.
+*Filename for the background graphic for this gauge
+*Syntax: '''Filename'''
-*Syntax: '''Filename''
+====+Mini Target Shields:====
+=====Position:=====
+*Screen coordinates for this gauge
+*Syntax: '''(Integer, Integer)'''
+=====Font:=====
+*As per the global option above.
+*Syntax: '''Integer'''
-=====Header Offsets:=====
+=====Slew:=====
-Optional. Defines the offsets for the header label.
+*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
+*Syntax: '''Boolean'''
-*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
+=====Filename:=====
-*Units: Pixels
+*Filename for the background graphic for this gauge
+*Syntax: '''Filename'''
+=====3 Digit Hull Offsets:=====
+=====2 Digit Hull Offsets:=====
+=====1 Digit Hull Offsets:=====
-=====Animation Offsets:=====
+====+Player Shields:====
-Optional. Defines the offsets for the animation graphis.
+=====Position:=====
+*Screen coordinates for this gauge
+*Syntax: '''(Integer, Integer)'''
-*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
+=====Font:=====
-*Units: Pixels
+*As per the global option above.
+*Syntax: '''Integer'''
+=====Slew:=====
+*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
+*Syntax: '''Boolean'''
-=====Animation Background Size:=====
+====+Target Shields:====
-Optional. Defines the size of the animation's background (?)
+=====Position:=====
+*Screen coordinates for this gauge
+*Syntax: '''(Integer, Integer)'''
-*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
+=====Font:=====
-*Units: Pixels
+*As per the global option above.
+*Syntax: '''Integer'''
+=====Slew:=====
+*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
+*Syntax: '''Boolean'''
+====+Escort View:====
+=====Position:=====
+*Screen coordinates for this gauge
+*Syntax: '''(Integer, Integer)'''
-====+Directives:====
+=====Font:=====
-Adds a gauge that displays all currently active directives (includes current , completed, and failed)
+*As per the global option above.
+*Syntax: '''Integer'''
+=====Slew:=====
+*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
+*Syntax: '''Boolean'''
+=====Top Background Filename:=====
+=====Entry Background Filename:=====
+=====Bottom Background Filename:=====
+=====Entry Height:=====
+=====Entry Stagger Width:=====
+=====Header Text:=====
+=====Header Offsets:=====
+=====List Start Offsets:=====
+=====Hull X-offset:=====
+=====Name X-offset:=====
+=====Status X-offset:=====
+====+Mission Time:====
 =====Position:=====
-Defines the screen coordinates for the upper left corner of this gauge.
+*Screen coordinates for this gauge
+*Syntax: '''(Integer, Integer)'''
-*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
+=====Font:=====
-*Units: Pixels
+*As per the global option above.
+*Syntax: '''Integer'''
+=====Slew:=====
+*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
+*Syntax: '''Boolean'''
-=====Color:=====
+=====Filename:=====
-Optional. Overrides both previous color settings ([[Hud_gauges.tbl#$Color: 1|$Font]] HUD option and [[Hud_gauges#$Color: 2|$Font]] ship class option) for this particular gauge.
+*Filename for the background graphic for this gauge
+*Syntax: '''Filename'''
-*Syntax: See [[Hud_gauges.tbl#$Color: 1]]
+=====Text Offsets:=====
+=====Value Offsets:=====
+====+ETS Retail:====
+{{Table3613|
+Draws the three other ETS gauges as a single gauge.  Will rearrange itself (like retail) if shields or other systems are missing. SVN 8830
+=====Position:=====
+*Screen coordinates for this gauge
+*Syntax: '''(Integer, Integer)'''
 =====Font:=====
-Optional. Overrides both previous font settings ([[Hud_gauges.tbl#$Font: 1|$Font]] HUD option and [[Hud_gauges#$Font: 2|$Font]] ship class option) for this particular gauge.
+*As per the global option above.
+*Syntax: '''Integer'''
-*Syntax: See [[Hud_gauges.tbl#$Font: 1]]
+=====Slew:=====
+*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
+*Syntax: '''Boolean'''
+=====Filename:=====
+*Filename for the background graphic for this gauge
+*Syntax: '''Filename'''
-=====Top Background Filename:=====
+=====Foreground Clip Height:=====
-Optional. Designates which file to use for the Top Background. (?)
+=====Letter Offsets:=====
+=====Top Offsets:=====
+=====Bottom Offsets:=====
+=====Gauge Offset:=====
+*Distance between the individual weapon/shield/engine ETS gauges that comprise this gauge
+*Syntax: '''Integer'''
+}}
-*Syntax: '''Filename'''
+====+ETS Weapons:====
+=====Position:=====
+*Screen coordinates for this gauge
+*Syntax: '''(Integer, Integer)'''
+=====Font:=====
+*As per the global option above.
+*Syntax: '''Integer'''
-=====Entry Background Filename:=====
+=====Slew:=====
-Optional. Designates which file to use for the Entry Background. (?)
+*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
+*Syntax: '''Boolean'''
+=====Filename:=====
+*Filename for the background graphic for this gauge
 *Syntax: '''Filename'''
+=====Foreground Clip Height:=====
+=====Letter Offsets:=====
+=====Top Offsets:=====
+=====Bottom Offsets:=====
-=====Bottom Background Filename:=====
+====+ETS Engines:====
-Optional. Designates which file to use for the Bottom Background. (?)
-*Syntax: '''Filename'''
+=====Position:=====
+*Screen coordinates for this gauge
+*Syntax: '''(Integer, Integer)'''
+=====Font:=====
+*As per the global option above.
+*Syntax: '''Integer'''
-=====Header Offsets:=====
+=====Slew:=====
-Optional. Defines the screen coordinate offests for the header label.
+*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
+*Syntax: '''Boolean'''
-*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
+=====Filename:=====
-*Units: Pixels
+*Filename for the background graphic for this gauge
+*Syntax: '''Filename'''
+=====Foreground Clip Height:=====
+=====Letter Offsets:=====
+=====Top Offsets:=====
+=====Bottom Offsets:=====
-=====Top Background Height:=====
+====+ETS Shields:====
-Optional. Defines the height of the Top Background (?)
-*Syntax: '''Integer'''
-*Units: Pixels
+=====Position:=====
+*Screen coordinates for this gauge
+*Syntax: '''(Integer, Integer)'''
-=====List Start Offsets:=====
+=====Font:=====
-Optional. Defines the screen coordinate offsets for the start of the Directives list.
+*As per the global option above.
+*Syntax: '''Integer'''
-*Syntax: '''Integer''' x, '''Integer''' y
+=====Slew:=====
-*Units: Pixels
+*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
+*Syntax: '''Boolean'''
+=====Filename:=====
+*Filename for the background graphic for this gauge
+*Syntax: '''Filename'''
-=====Entry Height:=====
+=====Foreground Clip Height:=====
-Optional. Defines the height of each Directive
+=====Letter Offsets:=====
+=====Top Offsets:=====
-*Syntax: '''Integer'''
+=====Bottom Offsets:=====
-*Units: Pixels
-====+Weapons:====
-Adds a weapon status and ammunition gauge.
+====+Target Monitor:====
 =====Position:=====
-Defines the screen coordinates for the upper left corner of this gauge.
+*Screen coordinates for this gauge
+*Syntax: '''(Integer, Integer)'''
-*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
-*Units: Pixels
-=====Color:=====
-Optional. Overrides both previous color settings ([[Hud_gauges.tbl#$Color: 1|$Font]] HUD option and [[Hud_gauges#$Color: 2|$Font]] ship class option) for this particular gauge.
-*Syntax: See [[Hud_gauges.tbl#$Color: 1]]
 =====Font:=====
-Optional. Overrides both previous font settings ([[Hud_gauges.tbl#$Font: 1|$Font]] HUD option and [[Hud_gauges#$Font: 2|$Font]] ship class option) for this particular gauge.
+*As per the global option above.
+*Syntax: '''Integer'''
-*Syntax: See [[Hud_gauges.tbl#$Font: 1]]
+=====Monitor Filename:=====
+=====Integrity Bar Filename:=====
+=====Viewport Offsets:=====
+=====Viewport Size:=====
+=====Integrity Bar Offsets:=====
+=====Integrity Bar Foreground Clip Height:=====
+=====Status Offsets:=====
+=====Name Offsets:=====
+=====Class Offsets:=====
+=====Distance Offsets:=====
+=====Speed Offsets:=====
+=====Hull Offsets:=====
+=====Cargo Contents Offsets:=====
+=====Cargo Scan Start Offsets:=====
+=====Cargo Scan Size:=====
+====+Extra Target Data:====
+=====Position:=====
+*Screen coordinates for this gauge
+*Syntax: '''(Integer, Integer)'''
+=====Font:=====
+*As per the global option above.
+*Syntax: '''Integer'''
 =====Slew:=====
-Optional. Determines whether or not this gauge is affected by afterburner shaking or similar effects. (May also follow the player's head movements when using TrackIR)
+*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
 *Syntax: '''Boolean'''
+=====Filename:=====
+*Filename for the background graphic for this gauge
+*Syntax: '''Filename'''
-=====Top Background Filename:=====
+=====Bracket Offsets:=====
-Optional. Designates which file to use for the Top Background. (?)
+=====Dock Offsets:=====
+=====Order Offsets:=====
+=====Time Offsets:=====
-*Syntax: '''Filename'''
+====+Radar:====
+=====Position:=====
+*Screen coordinates for this gauge
+*Syntax: '''(Integer, Integer)'''
+=====Font:=====
+*As per the global option above.
+*Syntax: '''Integer'''
-=====Entry Background Filename:=====
+=====Filename:=====
-Optional. Designates which file to use for the Entry Background. (?)
+*Filename for the background graphic for this gauge
 *Syntax: '''Filename'''
+=====Infinity Distance Offsets:=====
+=====Long Distance Offsets:=====
+=====Short Distance Offsets:=====
-=====Bottom Background Filename:=====
+====+Radar Orb:====
-Optional. Designates which file to use for the Bottom Background. (?)
-*Syntax: '''Filename'''
-=====Header Offsets:=====
-Optional. Defines the screen coordinate offests for the header label.
-*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
-*Units: Pixels
-=====Top Background Height:=====
-Optional. Defines the height of the Top Background (?)
-*Syntax: '''Integer'''
-*Units: Pixels
-=====Header Offsets:=====
-=====List Start Offsets:=====
-=====Top Background Height:=====
-=====Entry Height:=====
-=====Command X-offset:=====
-=====Page Up Offsets:=====
-=====Page Down Offsets:=====
-====+Lag:====
 =====Position:=====
 *Screen coordinates for this gauge
@@ Line 512: / Line 653: @@
 *Syntax: '''Integer'''
-=====Slew:=====
+=====Filename:=====
-*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
+*Filename for the background graphic for this gauge
-*Syntax: '''Boolean'''
+*Syntax: '''Filename'''
-=====Filename:=====
+=====Infinity Distance Offsets:=====
-*Filename for the background graphic for this gauge
+=====Long Distance Offsets:=====
-*Syntax: '''Filename'''
+=====Short Distance Offsets:=====
-====+Mini Target Shields:====
+====+Radar BSG:====
 =====Position:=====
 *Screen coordinates for this gauge
@@ Line 529: / Line 670: @@
 *Syntax: '''Integer'''
-=====Slew:=====
+=====Size:=====
-*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
+=====XY Disc Filename:=====
-*Syntax: '''Boolean'''
+=====XZ YZ Disc Filename:=====
+=====Sweep Disc Filename:=====
+=====Default Contact Filename:=====
+=====Unknown Contact Filename:=====
+=====Cockpit Target:=====
+======Canvas Size:======
+======Display Offset:======
+======Display Size:======
-=====Filename:=====
+====+Afterburner Energy:====
-*Filename for the background graphic for this gauge
-*Syntax: '''Filename'''
-=====3 Digit Hull Offsets:=====
-=====2 Digit Hull Offsets:=====
-=====1 Digit Hull Offsets:=====
-====+Player Shields:====
 =====Position:=====
 *Screen coordinates for this gauge
@@ Line 554: / Line 694: @@
 *Syntax: '''Boolean'''
-====+Target Shields:====
+=====Filename:=====
+*Filename for the background graphic for this gauge
+*Syntax: '''Filename'''
+=====Foreground Clip Height:=====
+====+Weapon Energy:====
 =====Position:=====
 *Screen coordinates for this gauge
@@ Line 567: / Line 713: @@
 *Syntax: '''Boolean'''
-====+Escort View:====
+=====Filename:=====
+*Filename for the background graphic for this gauge
+*Syntax: '''Filename'''
+=====Foreground Clip Height:=====
+=====Text Offsets:=====
+====+Text Warnings:====
 =====Position:=====
 *Screen coordinates for this gauge
@@ Line 580: / Line 733: @@
 *Syntax: '''Boolean'''
-=====Top Background Filename:=====
+====+Center Reticle:====
-=====Entry Background Filename:=====
-=====Bottom Background Filename:=====
-=====Entry Height:=====
-=====Entry Stagger Width:=====
-=====Header Text:=====
-=====Header Offsets:=====
-=====List Start Offsets:=====
-=====Hull X-offset:=====
-=====Name X-offset:=====
-=====Status X-offset:=====
-====+Mission Time:====
 =====Position:=====
 *Screen coordinates for this gauge
@@ Line 600: / Line 741: @@
 *As per the global option above.
 *Syntax: '''Integer'''
-=====Slew:=====
-*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
-*Syntax: '''Boolean'''
 =====Filename:=====
@@ Line 609: / Line 746: @@
 *Syntax: '''Filename'''
-=====Text Offsets:=====
+=====Firepoint display:=====
-=====Value Offsets:=====
+*Displays the positions of the gun firepoints on your ship
+*Syntax: '''Boolean''', YES or NO
-====+ETS Retail:====
+=====Firepoint size:=====
-{{Table3613|
+*Diameter of the gunpoint circles.  '''Must be 4 or greater''' in order to work properly.
-Draws the three other ETS gauges as a single gauge.  Will rearrange itself (like retail) if shields or other systems are missing. SVN 8830
+*Syntax: '''Integer'''
+=====Firepoint X coordinate multiplier:=====
+=====Firepoint Y coordinate multiplier:=====
+====+Throttle:====
 =====Position:=====
 *Screen coordinates for this gauge
@@ Line 631: / Line 774: @@
 *Syntax: '''Filename'''
+=====Foreground Clip Bottom Y-offset:=====
+=====Foreground Clip Width:=====
 =====Foreground Clip Height:=====
-=====Letter Offsets:=====
+=====Afterburner Clip Height:=====
-=====Top Offsets:=====
+=====Show Background:=====
-=====Bottom Offsets:=====
+=====Max Speed Label Offsets:=====
-=====Gauge Offset:=====
+=====Min Speed Label Offsets:=====
-*Distance between the individual weapon/shield/engine ETS gauges that comprise this gauge
+=====Orbit Center Offsets:=====
-*Syntax: '''Integer'''
+=====Orbit Radius:=====
-}}
-====+ETS Weapons:====
+====+Threat Indicator:====
 =====Position:=====
 *Screen coordinates for this gauge
@@ Line 653: / Line 797: @@
 *Syntax: '''Boolean'''
-=====Filename:=====
+=====Arc Filename:=====
 *Filename for the background graphic for this gauge
 *Syntax: '''Filename'''
-=====Foreground Clip Height:=====
+=====Dumbfire Filename:=====
-=====Letter Offsets:=====
+*Filename for the background graphic for this gauge
-=====Top Offsets:=====
+*Syntax: '''Filename'''
-=====Bottom Offsets:=====
+=====Lock Filename:=====
+*Filename for the background graphic for this gauge
+*Syntax: '''Filename'''
+=====Dumbfire Offsets:=====
+*Filename for the background graphic for this gauge
+*Syntax: '''Filename'''
-====+ETS Engines:====
+=====Lock Offsets:=====
+*Filename for the background graphic for this gauge
+*Syntax: '''Filename'''
+====+Multiplayer Messages:====
 =====Position:=====
 *Screen coordinates for this gauge
@@ Line 672: / Line 826: @@
 *Syntax: '''Integer'''
-=====Slew:=====
+====+Voice Status:====
-*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
+=====Position:=====
-*Syntax: '''Boolean'''
+*Screen coordinates for this gauge
-=====Filename:=====
-*Filename for the background graphic for this gauge
-*Syntax: '''Filename'''
-=====Foreground Clip Height:=====
-=====Letter Offsets:=====
-=====Top Offsets:=====
-=====Bottom Offsets:=====
-====+ETS Shields:====
-=====Position:=====
-*Screen coordinates for this gauge
 *Syntax: '''(Integer, Integer)'''
@@ Line 699: / Line 839: @@
 *Syntax: '''Boolean'''
-=====Filename:=====
+====+Ping:====
-*Filename for the background graphic for this gauge
-*Syntax: '''Filename'''
-=====Foreground Clip Height:=====
-=====Letter Offsets:=====
-=====Top Offsets:=====
-=====Bottom Offsets:=====
-====+Target Monitor:====
 =====Position:=====
 *Screen coordinates for this gauge
@@ Line 717: / Line 848: @@
 *Syntax: '''Integer'''
-=====Monitor Filename:=====
+=====Slew:=====
-=====Integrity Bar Filename:=====
+*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
-=====Viewport Offsets:=====
+*Syntax: '''Boolean'''
-=====Viewport Size:=====
-=====Integrity Bar Offsets:=====
-=====Integrity Bar Foreground Clip Height:=====
-=====Status Offsets:=====
-=====Name Offsets:=====
-=====Class Offsets:=====
-=====Distance Offsets:=====
-=====Speed Offsets:=====
-=====Hull Offsets:=====
-=====Cargo Contents Offsets:=====
-=====Cargo Scan Start Offsets:=====
-=====Cargo Scan Size:=====
-====+Extra Target Data:====
+====+Supernova:====
 =====Position:=====
 *Screen coordinates for this gauge
@@ Line 746: / Line 865: @@
 *Syntax: '''Boolean'''
-=====Filename:=====
+====+Lock Indicator:====
-*Filename for the background graphic for this gauge
+=====Font:=====
-*Syntax: '''Filename'''
+*As per the global option above.
+*Syntax: '''Integer'''
-=====Bracket Offsets:=====
+=====Lock Filename:=====
-=====Dock Offsets:=====
+=====Locked Filename:=====
-=====Order Offsets:=====
+=====Lock Center Offsets:=====
-=====Time Offsets:=====
+=====Locked Center Offsets:=====
+====+Offscreen Indicator:====
+=====Font:=====
+*As per the global option above.
+*Syntax: '''Integer'''
+====+Target Brackets:====
+=====Font:=====
+*As per the global option above.
+*Syntax: '''Integer'''
+=====Dot Filename:=====
-====+Radar:====
+====+Hostile Triangle:====
 =====Position:=====
 *Screen coordinates for this gauge
@@ Line 764: / Line 896: @@
 *Syntax: '''Integer'''
-=====Filename:=====
+=====Slew:=====
-*Filename for the background graphic for this gauge
+*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
-*Syntax: '''Filename'''
+*Syntax: '''Boolean'''
-=====Infinity Distance Offsets:=====
+=====Radius:=====
-=====Long Distance Offsets:=====
+=====Triangle Base:=====
-=====Short Distance Offsets:=====
+=====Triangle Height:=====
-====+Radar Orb:====
+====+Target Triangle:====
 =====Position:=====
 *Screen coordinates for this gauge
@@ Line 781: / Line 913: @@
 *Syntax: '''Integer'''
-=====Filename:=====
+=====Slew:=====
-*Filename for the background graphic for this gauge
+*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
-*Syntax: '''Filename'''
+*Syntax: '''Boolean'''
-=====Infinity Distance Offsets:=====
+=====Radius:=====
-=====Long Distance Offsets:=====
+=====Triangle Base:=====
-=====Short Distance Offsets:=====
+=====Triangle Height:=====
-====+Radar BSG:====
+====+Missile Triangles:====
 =====Position:=====
 *Screen coordinates for this gauge
@@ Line 798: / Line 930: @@
 *Syntax: '''Integer'''
-=====Size:=====
+=====Slew:=====
-=====XY Disc Filename:=====
+*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
-=====XZ YZ Disc Filename:=====
+*Syntax: '''Boolean'''
-=====Sweep Disc Filename:=====
-=====Default Contact Filename:=====
-=====Unknown Contact Filename:=====
-=====Cockpit Target:=====
-======Canvas Size:======
-======Display Offset:======
-======Display Size:======
-====+Afterburner Energy:====
+=====Radius:=====
-=====Position:=====
+=====Triangle Base:=====
-*Screen coordinates for this gauge
+=====Triangle Height:=====
-*Syntax: '''(Integer, Integer)'''
+====+Lead Indicator:====
 =====Font:=====
 *As per the global option above.
 *Syntax: '''Integer'''
-=====Slew:=====
-*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
-*Syntax: '''Boolean'''
 =====Filename:=====
@@ Line 826: / Line 947: @@
 *Syntax: '''Filename'''
-=====Foreground Clip Height:=====
+=====Center Offsets:=====
-====+Weapon Energy:====
+====+Orientation Tee:====
 =====Position:=====
 *Screen coordinates for this gauge
@@ Line 840: / Line 961: @@
 *Optional. Whether this gauge is affected by afterburner shaking or similar effects.
 *Syntax: '''Boolean'''
+=====Radius:=====
+====+Lead Sight:====
+=====Position:=====
+*Screen coordinates for this gauge
+*Syntax: '''(Integer, Integer)'''
+=====Font:=====
+*As per the global option above.
+*Syntax: '''Integer'''
 =====Filename:=====
@@ Line 845: / Line 977: @@
 *Syntax: '''Filename'''
-=====Foreground Clip Height:=====
+====+Kills:====
-=====Text Offsets:=====
-====+Text Warnings:====
 =====Position:=====
 *Screen coordinates for this gauge
@@ Line 861: / Line 990: @@
 *Syntax: '''Boolean'''
-====+Center Reticle:====
+=====Filename:=====
-=====Position:=====
+*Filename for the background graphic for this gauge
-*Screen coordinates for this gauge
+*Syntax: '''Filename'''
-*Syntax: '''(Integer, Integer)'''
+=====Text Offsets:=====
-=====Font:=====
+=====Value Offsets:=====
-*As per the global option above.
-*Syntax: '''Integer'''
+====+Weapon Linking:====
-=====Filename:=====
-*Filename for the background graphic for this gauge
-*Syntax: '''Filename'''
-=====Firepoint display:=====
-*Displays the positions of the gun firepoints on your ship
-*Syntax: '''Boolean''', YES or NO
-=====Firepoint size:=====
-*Diameter of the gunpoint circles.  '''Must be 4 or greater''' in order to work properly.
-*Syntax: '''Integer'''
-=====Firepoint X coordinate multiplier:=====
-=====Firepoint Y coordinate multiplier:=====
-====+Throttle:====
 =====Position:=====
 *Screen coordinates for this gauge
@@ Line 898: / Line 1,010: @@
 *Syntax: '''Boolean'''
-=====Filename:=====
+=====Arc Filename:=====
-*Filename for the background graphic for this gauge
+=====Single Primary Filename:=====
-*Syntax: '''Filename'''
+=====Double Primary Filename:=====
+=====Single Secondary Filename:=====
+=====Double Secondary Filename:=====
+=====Triple Secondary Filename:=====
+=====Single Primary Offsets:=====
+=====Double Primary Offsets:=====
+=====Single Secondary Offsets:=====
+=====Double Secondary Offsets:=====
+=====Triple Secondary Offsets:=====
-=====Foreground Clip Bottom Y-offset:=====
+====+Fixed Messages:====
-=====Foreground Clip Width:=====
-=====Foreground Clip Height:=====
-=====Afterburner Clip Height:=====
-=====Show Background:=====
-=====Max Speed Label Offsets:=====
-=====Min Speed Label Offsets:=====
-=====Orbit Center Offsets:=====
-=====Orbit Radius:=====
-====+Threat Indicator:====
 =====Position:=====
 *Screen coordinates for this gauge
@@ Line 921: / Line 1,031: @@
 *Syntax: '''Integer'''
-=====Slew:=====
-*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
-*Syntax: '''Boolean'''
-=====Arc Filename:=====
+===Gauge Configuration Options===
-*Filename for the background graphic for this gauge
+Since a vast majority of gauges share the same entries, the configuration options for each gauge have been grouped here for formatting consistency.
-*Syntax: '''Filename'''
-=====Dumbfire Filename:=====
+=====Position:=====
-*Filename for the background graphic for this gauge
+Defines the screen coordinates for the upper left corner of this gauge.
-*Syntax: '''Filename'''
-=====Lock Filename:=====
+*Syntax: '''Integer''' horizontal pixel, '''Integer''' vertical pixel position
-*Filename for the background graphic for this gauge
-*Syntax: '''Filename'''
-=====Dumbfire Offsets:=====
+Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Training Messages:|+Training Messages:]], [[Hud_gauges.tbl#+Support:|+Support]]
-*Filename for the background graphic for this gauge
-*Syntax: '''Filename'''
-=====Lock Offsets:=====
-*Filename for the background graphic for this gauge
-*Syntax: '''Filename'''
-====+Multiplayer Messages:====
+=====Color:=====
-=====Position:=====
+Optional. Overrides both previous color settings ([[Hud_gauges.tbl#$Color: 1|$Font]] HUD option and [[Hud_gauges#$Color: 2|$Font]] ship class option) for this particular gauge.
-*Screen coordinates for this gauge
-*Syntax: '''(Integer, Integer)'''
+*Syntax: See [[Hud_gauges.tbl#$Color: 1]]
-=====Font:=====
+Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Support:|+Support]]
-*As per the global option above.
-*Syntax: '''Integer'''
-====+Voice Status:====
-=====Position:=====
-*Screen coordinates for this gauge
-*Syntax: '''(Integer, Integer)'''
 =====Font:=====
-*As per the global option above.
+Optional. Overrides both previous font settings ([[Hud_gauges.tbl#$Font: 1|$Font]] HUD option and [[Hud_gauges#$Font: 2|$Font]] ship class option) for this particular gauge.
-*Syntax: '''Integer'''
+*Syntax: See [[Hud_gauges.tbl#$Font: 1]]
-=====Slew:=====
+Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Training Messages:|+Training Messages:]], [[Hud_gauges.tbl#+Support:|+Support]]
-*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
-*Syntax: '''Boolean'''
-====+Ping:====
-=====Position:=====
-*Screen coordinates for this gauge
-*Syntax: '''(Integer, Integer)'''
-=====Font:=====
+=====Name:=====
-*As per the global option above.
+Defines the name of this custom gauge.
-*Syntax: '''Integer'''
-=====Slew:=====
+*Syntax: '''String'''
-*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
+*Max Length: 32 characters
-*Syntax: '''Boolean'''
-====+Supernova:====
+Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]
-=====Position:=====
-*Screen coordinates for this gauge
-*Syntax: '''(Integer, Integer)'''
-=====Font:=====
-*As per the global option above.
-*Syntax: '''Integer'''
-=====Slew:=====
+=====Text:=====
-*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
+Default text to be displayed. Can be altered using the hud-set-message, hud-set-text and hud-set-directive sexps.
-*Syntax: '''Boolean'''
-====+Lock Indicator:====
+*Syntax: '''String'''
-=====Font:=====
+*Max Length: 32 characters
-*As per the global option above.
-*Syntax: '''Integer'''
+Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]
-=====Lock Filename:=====
-=====Locked Filename:=====
-=====Lock Center Offsets:=====
-=====Locked Center Offsets:=====
-====+Offscreen Indicator:====
+=====X Offset:=====
-=====Font:=====
+Optional. Defines the horizontal pixel offset (from the gauge's origin defined by [[Hud_gauges#$Position:]]) that the Text will be displayed.
-*As per the global option above.
-*Syntax: '''Integer'''
-====+Target Brackets:====
-=====Font:=====
-*As per the global option above.
 *Syntax: '''Integer'''
+*Units: Pixels
-=====Dot Filename:=====
+Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]
-====+Hostile Triangle:====
-=====Position:=====
-*Screen coordinates for this gauge
-*Syntax: '''(Integer, Integer)'''
-=====Font:=====
+=====Y Offset:=====
-*As per the global option above.
+Optional. Defines the vertical pixel offset (from the gauge's origin defined by [[Hud_gauges#$Position:]]) that the Text will be displayed.
 *Syntax: '''Integer'''
+*Units: Pixels
-=====Slew:=====
+Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]
-*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
-*Syntax: '''Boolean'''
+=====Gauge Type:=====
+Defines the type of gauge this is.
-=====Radius:=====
+*Syntax: '''String'''
-=====Triangle Base:=====
+*Valid Values: Any one of the possible [[gauge types]].
-=====Triangle Height:=====
-====+Target Triangle:====
+Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]
-=====Position:=====
-*Screen coordinates for this gauge
-*Syntax: '''(Integer, Integer)'''
-=====Font:=====
-*As per the global option above.
-*Syntax: '''Integer'''
 =====Slew:=====
-*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
+Optional. Determines whether or not this gauge is affected by afterburner shaking or similar effects. (May also follow the player's head movements when using TrackIR)
 *Syntax: '''Boolean'''
-=====Radius:=====
+Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Support:|+Support]]
-=====Triangle Base:=====
-=====Triangle Height:=====
-====+Missile Triangles:====
+=====Max Lines:=====
-=====Position:=====
+Optional. Specifies the maximum number of message lines that are displayed.
-*Screen coordinates for this gauge
-*Syntax: '''(Integer, Integer)'''
-=====Font:=====
-*As per the global option above.
 *Syntax: '''Integer'''
+*Default Value: 3
-=====Slew:=====
+Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]
-*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
-*Syntax: '''Boolean'''
-=====Radius:=====
-=====Triangle Base:=====
-=====Triangle Height:=====
-====+Lead Indicator:====
+=====Max Width:=====
-=====Font:=====
+Optional. Determines how long each message line may be.
-*As per the global option above.
 *Syntax: '''Integer'''
+*Units: Pixels
-=====Filename:=====
+Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]
-*Filename for the background graphic for this gauge
-*Syntax: '''Filename'''
-=====Center Offsets:=====
-====+Orientation Tee:====
+=====Line Height:=====
-=====Position:=====
+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)
-*Screen coordinates for this gauge
-*Syntax: '''(Integer, Integer)'''
-=====Font:=====
-*As per the global option above.
 *Syntax: '''Integer'''
+*Units: Pixels
+*Default Value: 12
-=====Slew:=====
+Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]
-*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
-*Syntax: '''Boolean'''
-=====Radius:=====
-====+Lead Sight:====
+=====Total Lifetime:=====
-=====Position:=====
+Optional. Determines the maximum time the message gauge will be displayed from the time a new message is received.
-*Screen coordinates for this gauge
-*Syntax: '''(Integer, Integer)'''
-=====Font:=====
-*As per the global option above.
 *Syntax: '''Integer'''
+*Units: milliseconds
+*Default Value: 14000 (14 seconds)
+Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]
-=====Filename:=====
-*Filename for the background graphic for this gauge
-*Syntax: '''Filename'''
-====+Kills:====
+=====Scroll Time:=====
-=====Position:=====
+Optional. Determines the time for the messages to scroll up one step.( See [[Hud_gauges.tbl#Step Size:]] )
-*Screen coordinates for this gauge
-*Syntax: '''(Integer, Integer)'''
-=====Font:=====
-*As per the global option above.
 *Syntax: '''Integer'''
+*Units: milliseconds
+*Default Value: 30
-=====Slew:=====
+Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]
-*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
-*Syntax: '''Boolean'''
+=====Step Size:=====
+Optional. Determines how many pixels to shift message lines during scrolling. Messages will be shifted up by this amount until they are on the next line (as defined by [[Hud_gauges.tbl#Line Height:]])
-=====Filename:=====
+*Syntax: '''Integer'''
-*Filename for the background graphic for this gauge
+*Units: Pixels
-*Syntax: '''Filename'''
+*Default Value: 3
-=====Text Offsets:=====
+Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]
-=====Value Offsets:=====
-====+Weapon Linking:====
-=====Position:=====
-*Screen coordinates for this gauge
-*Syntax: '''(Integer, Integer)'''
-=====Font:=====
+=====Active by default:=====
-*As per the global option above.
+Optional. Determines whether or not this gauge is always active, or only available after being activated via sexp.
-*Syntax: '''Integer'''
-=====Slew:=====
-*Optional. Whether this gauge is affected by afterburner shaking or similar effects.
 *Syntax: '''Boolean'''
-=====Arc Filename:=====
+Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]
-=====Single Primary Filename:=====
-=====Double Primary Filename:=====
-=====Single Secondary Filename:=====
-=====Double Secondary Filename:=====
-=====Triple Secondary Filename:=====
-=====Single Primary Offsets:=====
-=====Double Primary Offsets:=====
-=====Single Secondary Offsets:=====
-=====Double Secondary Offsets:=====
-=====Triple Secondary Offsets:=====
-====+Fixed Messages:====
-=====Position:=====
-*Screen coordinates for this gauge
-*Syntax: '''(Integer, Integer)'''
-=====Font:=====
+=====Filename:=====
-*As per the global option above.
+Designates the file used for this gauge's the background graphic
-*Syntax: '''Integer'''
+*Syntax: '''Filename'''
-===Gauge Configuration Options===
+Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Support:|+Support]]
-Since a vast majority of gauges share the same entries, the configuration options for each gauge have been grouped here for formatting consistency.
-=====Position:=====
+=====Top Background Filename:=====
-Defines the screen coordinates for the upper left corner of this gauge.
+Optional. Designates which file to use for the top background. (?)
-*Syntax: '''Integer''' horizontal pixel, '''Integer''' vertical pixel position
+*Syntax: '''Filename'''
-Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Training Messages:|+Training Messages:]], [[Hud_gauges.tbl#+Support:|+Support]]
+Used by: [[Hud_gauges.tbl#+Damage|+Damage]]
-=====Color:=====
+=====Bottom Background Filename:=====
-Optional. Overrides both previous color settings ([[Hud_gauges.tbl#$Color: 1|$Font]] HUD option and [[Hud_gauges#$Color: 2|$Font]] ship class option) for this particular gauge.
+Optional. Designates which file to use for the Bottom background (?)
-*Syntax: See [[Hud_gauges.tbl#$Color: 1]]
+*Syntax: '''Filename'''
-Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Support:|+Support]]
+Used by: [[Hud_gauges.tbl#+Damage|+Damage]]
-=====Font:=====
+=====Left Background Filename:=====
-Optional. Overrides both previous font settings ([[Hud_gauges.tbl#$Font: 1|$Font]] HUD option and [[Hud_gauges#$Font: 2|$Font]] ship class option) for this particular gauge.
+Optional. Designates which file to use for the Left background (?)
-*Syntax: See [[Hud_gauges.tbl#$Font: 1]]
+*Syntax: '''Filename'''
-Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Training Messages:|+Training Messages:]], [[Hud_gauges.tbl#+Support:|+Support]]
+Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status]]
-=====Name:=====
+=====Right Background Filename:=====
-Defines the name of this custom gauge.
+Optional. Designates which file to use for the Right background (?)
-*Syntax: '''String'''
+*Syntax: '''Filename'''
-*Max Length: 32 characters
-Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]
+Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status]]
-=====Text:=====
+=====Entry Background Filename:=====
-Default text to be displayed. Can be altered using the hud-set-message, hud-set-text and hud-set-directive sexps.
+Optional. Designates which file to use for the Entry background (?)
-*Syntax: '''String'''
+*Syntax: '''Filename'''
-*Max Length: 32 characters
-Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]
+Used by: [[Hud_gauges.tbl#+Damage|+Damage]], [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status]]
-=====X Offset:=====
+=====Dot Filename:=====
-Optional. Defines the horizontal pixel offset (from the gauge's origin defined by [[Hud_gauges#$Position:]]) that the Text will be displayed.
+Optional. Designates which file to use for the wingman graphic (a.k.a. the Dot)
-*Syntax: '''Integer'''
+*Syntax: '''Filename'''
-*Units: Pixels
-Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]
+Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status]]
-=====Y Offset:=====
+=====Header Offsets:=====
-Optional. Defines the vertical pixel offset (from the gauge's origin defined by [[Hud_gauges#$Position:]]) that the Text will be displayed.
+Optional. Designates the offset from the gauge's upper left corner for the Support Ship header (?)
-*Syntax: '''Integer'''
+*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
 *Units: Pixels
-Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]
+Used by: [[Hud_gauges.tbl#+Support:|+Support]], [[Hud_gauges.tbl#+Damage|+Damage]]
-=====Gauge Type:=====
+=====Text Y-offset:=====
-Defines the type of gauge this is.
+Optional. Designates the offset from the gauge's upper left corner for the Support Ship Text. (?)
-*Syntax: '''String'''
+*Syntax: '''Integer''' vertical offset
-*Valid Values: Any one of the possible [[gauge types]].
+*Units: Pixels
-Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]
+Used by: [[Hud_gauges.tbl#+Support:|+Support]]
-=====Slew:=====
+=====Text Offsets:=====
-Optional. Determines whether or not this gauge is affected by afterburner shaking or similar effects. (May also follow the player's head movements when using TrackIR)
+Optional. Defines the screen position offsets for the text label.
-*Syntax: '''Boolean'''
+*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
+*Units: Pixels
-Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Support:|+Support]]
+Used by: :[[Hud_gauges.tbl#+Countermeasures:|+Countermeasures]]
-=====Max Lines:=====
+=====Value Offsets:=====
-Optional. Specifies the maximum number of message lines that are displayed.
+Optional. Defines the screen position offsets for the value label.
-*Syntax: '''Integer'''
+*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
-*Default Value: 3
+*Units: Pixels
-Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]
+Used by: :[[Hud_gauges.tbl#+Countermeasures:|+Countermeasures]]
-=====Max Width:=====
+=====Dock Status X-offset:=====
-Optional. Determines how long each message line may be.
+Optional. Designates the offset from the gauge's upper left corner for the Support Ship's dock status. (?)
-*Syntax: '''Integer'''
+*Syntax: '''Integer''' vertical offset
 *Units: Pixels
-Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]
+Used by: [[Hud_gauges.tbl#+Support:|+Support]]
-=====Line Height:=====
+=====Dock Time X-offset:=====
-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)
+Optional. Designates the offset from the gauge's upper left corner for the Support Ship's dock time. (?)
-*Syntax: '''Integer'''
+*Syntax: '''Integer''' vertical offset
 *Units: Pixels
-*Default Value: 12
-Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]
+Used by: [[Hud_gauges.tbl#+Support:|+Support]]
-=====Total Lifetime:=====
+=====Hull Integrity Offsets:=====
-Optional. Determines the maximum time the message gauge will be displayed from the time a new message is received.
+Optional. Designates the offsets from the gauge's upper left corner for the for the Damage gauge Hull integrity textbox(?)
-*Syntax: '''Integer'''
+*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
-*Units: milliseconds
+*Units: Pixels
-*Default Value: 14000 (14 seconds)
-Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]
+Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]
-=====Scroll Time:=====
+=====Hull Integrity Value X-offset:=====
-Optional. Determines the time for the messages to scroll up one step.( See [[Hud_gauges.tbl#Step Size:]] )
+Optional. Designates the offsets from the hull integrity textbox's upper left corner for the hull integrity value. (?)
-*Syntax: '''Integer'''
+*Syntax: '''Integer''' horizontal offset
-*Units: milliseconds
+*Units: Pixels
-*Default Value: 30
-Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]
+Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]
-=====Step Size:=====
+=====Top Background Height:=====
-Optional. Determines how many pixels to shift message lines during scrolling. Messages will be shifted up by this amount until they are on the next line (as defined by [[Hud_gauges.tbl#Line Height:]])
+Optional. Designates the height of the Top background (?)
 *Syntax: '''Integer'''
 *Units: Pixels
-*Default Value: 3
-Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]
+Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]
-=====Active by default:=====
+=====Left Background Width:=====
-Optional. Determines whether or not this gauge is always active, or only available after being activated via sexp.
+Optional. Defines the width of the Left Background.
-*Syntax: '''Boolean'''
+*Syntax: '''Integer'''
+*Units: Pixels
-Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]
+Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status]]
-=====Filename:=====
+=====Entry Width:=====
-Designates the file used for this gauge's the background graphic
+Optional. Defines the width of the Entry Background (?)
-*Syntax: '''Filename'''
+*Syntax: '''Integer'''
+*Units: Pixels
-Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Support:|+Support]]
+Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status]]
-=====Top Background Filename:=====
+=====Subsystem Entry Height:=====
-Optional. Designates which file to use for the top background. (?)
+Optional. Designates the height of the Subsystem entry (?)
-*Syntax: '''Filename'''
+*Syntax: '''Integer'''
+*Units: Pixels
-Used by: [[Hud_gauges.tbl#+Damage|+Damage]]
+Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]
-=====Bottom Background Filename:=====
+=====Subsystem List Start Offsets:=====
-Optional. Designates which file to use for the Bottom background (?)
+Optional. Designates the offsets from the gauge's upper left corner for the for the start of the Subsytem List (?)
-*Syntax: '''Filename'''
+*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
+*Units: Pixels
-Used by: [[Hud_gauges.tbl#+Damage|+Damage]]
+Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]
-=====Left Background Filename:=====
+=====Subsystem Entry Value X-offset:=====
-Optional. Designates which file to use for the Left background (?)
+Optional. Designates the horizontal offset from the Subsystem List's position (?)
-*Syntax: '''Filename'''
+*Syntax: '''Integer'''
+*Units: Pixels
-Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status]]
+Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]
-=====Right Background Filename:=====
+=====Single Wing Offsets:=====
-Optional. Designates which file to use for the Right background (?)
+Optional. Designates the offset from the gauge's upper left corner for a single wing (?)
-*Syntax: '''Filename'''
+*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
+*Units: Pixels
 Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status]]
-=====Entry Background Filename:=====
+=====Multiple Wing Start Offsets:=====
-Optional. Designates which file to use for the Entry background (?)
+Optional. Designates the offset from the gauge's upper left corner for multiple wings (?)
-*Syntax: '''Filename'''
+*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
+*Units: Pixels
-Used by: [[Hud_gauges.tbl#+Damage|+Damage]], [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status]]
-=====Dot Filename:=====
-Optional. Designates which file to use for the wingman graphic (a.k.a. the Dot)
-*Syntax: '''Filename'''
 Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status]]
-=====Header Offsets:=====
+=====Wing Name Offsets:=====
 Optional. Designates the offset from the gauge's upper left corner for the Support Ship header (?)
@@ Line 1,369: / Line 1,385: @@
 *Units: Pixels
-Used by: [[Hud_gauges.tbl#+Support:|+Support]], [[Hud_gauges.tbl#+Damage|+Damage]]
+Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status]]
-=====Text Y-offset:=====
+=====Dot Offsets:=====
-Optional. Designates the offset from the gauge's upper left corner for the Support Ship Text. (?)
+Optional. Designates the offset from the gauge's upper left corner for the All wingman status icons.
+*Syntax:
-*Syntax: '''Integer''' vertical offset
+:'''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
-Used by: [[Hud_gauges.tbl#+Support:|+Support]]
+{{Warning|
+All 5 wingman positions must be defined}}
+Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status]]
-=====Text Offsets:=====
-Optional. Defines the screen position offsets for the text label.
-*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
+=====Expansion Mode:=====
-*Units: Pixels
+Optional. Denotes which direction (in relation to the player's wing) that the other wings should be appended to the gauge
-Used by: :[[Hud_gauges.tbl#+Countermeasures:|+Countermeasures]]
+*Syntax: '''String'''
+*Valid Values:
+:*"Right"    ;; Wings are added to the right of the previous wing
+Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status]]
-=====Value Offsets:=====
-Optional. Defines the screen position offsets for the value label.
+=====Auto Offsets:=====
+Optional. Defines the screen coordinates for the "Auto" text label.
 *Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
 *Units: Pixels
-Used by: :[[Hud_gauges.tbl#+Countermeasures:|+Countermeasures]]
+Used by: [[Hud_gagues.tbl#+Auto Speed:|+Auto Speed]], [[Hud_gagues.tbl#+Auto Target:|+Auto Target]]
-=====Dock Status X-offset:=====
+=====Speed Offsets:=====
-Optional. Designates the offset from the gauge's upper left corner for the Support Ship's dock status. (?)
+Optional. Defines the screen coordinates for the "Speed" text label.
-*Syntax: '''Integer''' vertical offset
+*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
 *Units: Pixels
-Used by: [[Hud_gauges.tbl#+Support:|+Support]]
+Used by: [[Hud_gagues.tbl#+Auto Speed:|+Auto Speed]]
-=====Dock Time X-offset:=====
+=====Target Offsets:=====
-Optional. Designates the offset from the gauge's upper left corner for the Support Ship's dock time. (?)
+Optional. Defines the screen coordinates for the "Target" text label.
-*Syntax: '''Integer''' vertical offset
+*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
 *Units: Pixels
-Used by: [[Hud_gauges.tbl#+Support:|+Support]]
+Used by: [[Hud_gauges.tbl#+Auto Target:|+Auto Target:]]
-=====Hull Integrity Offsets:=====
+=====Animation Offsets:=====
-Optional. Designates the offsets from the gauge's upper left corner for the for the Damage gauge Hull integrity textbox(?)
+Optional. Defines the offsets for the animation graphis.
 *Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
 *Units: Pixels
-Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]
+Used by: [[Hud_gauges.tbl#+Talking Head]]
-=====Hull Integrity Value X-offset:=====
+=====Animation Background Size:=====
-Optional. Designates the offsets from the hull integrity textbox's upper left corner for the hull integrity value. (?)
+Optional. Defines the size of the animation's background (?)
-*Syntax: '''Integer''' horizontal offset
+*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
 *Units: Pixels
-Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]
+Used by: [[Hud_gauges.tbl#+Talking Head]]
-=====Top Background Height:=====
+=====List Start Offsets:=====
-Optional. Designates the height of the Top background (?)
+Optional. Defines the screen coordinate offsets for the start of the Directives list.
-*Syntax: '''Integer'''
+*Syntax: '''Integer''' x, '''Integer''' y
-*Units: Pixels
-Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]
-=====Left Background Width:=====
-Optional. Defines the width of the Left Background.
-*Syntax: '''Integer'''
 *Units: Pixels
-Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status]]
+Used by: [[Hud_guages.tbl#+Directives:|+Directives:]]
-=====Entry Width:=====
+=====Entry Height:=====
-Optional. Defines the width of the Entry Background (?)
+Optional. Defines the height of each Directive
 *Syntax: '''Integer'''
 *Units: Pixels
-Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status]]
+Used by: [[Hud_guages.tbl#+Directives:|+Directives:]]
-=====Subsystem Entry Height:=====
-Optional. Designates the height of the Subsystem entry (?)
-*Syntax: '''Integer'''
-*Units: Pixels
-Used by: [[Hud_gauges.tbl#+Damage:|+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: [[Hud_gauges.tbl#+Damage:|+Damage:]]
-=====Subsystem Entry Value X-offset:=====
-Optional. Designates the horizontal offset from the Subsystem List's position (?)
-*Syntax: '''Integer'''
-*Units: Pixels
-Used by: [[Hud_gauges.tbl#+Damage:|+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: [[Hud_gagues.tbl#+Wingman Status:|+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: [[Hud_gagues.tbl#+Wingman Status:|+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: [[Hud_gagues.tbl#+Wingman Status:|+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: [[Hud_gagues.tbl#+Wingman Status:|+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: [[Hud_gagues.tbl#+Wingman Status:|+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: [[Hud_gagues.tbl#+Auto Speed:|+Auto Speed]], [[Hud_gagues.tbl#+Auto Target:|+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: [[Hud_gagues.tbl#+Auto Speed:|+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: [[Hud_gauges.tbl#+Auto Target:|+Auto Target:]]
 [[Category:Tables]]