Difference between revisions of "Hud gauges.tbl"

From FreeSpace Wiki
Jump to: navigation, search
(More editing done. Breaking at +Weapons gauge for now)
(Decided to go a different route of formatting. This should be much smaller and be more style consitant. (pausing at +Talking Head))
Line 171: Line 171:
 
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.
 
Following entries define gauge-specific behavior. For the most part, each gauge has its own overrides that, if not defined, would otherwise use the global values.
  
{{Note|
+
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.
Please do not define non-custom gauges more than once within a ship class configuration group}}
 
 
 
Also, All gauges may take the optional string "default," to specify that default behavior should be used. In this case, retail resolutions (640x480 or 1024x768) for that particular gauge will be used (and the global resolutions will be ignored)
 
  
  
Line 180: Line 177:
 
Adds a custom gauge type.
 
Adds a custom gauge type.
  
 
+
*Valid Sub-Entries:
=====Position:=====
+
:[[Hud_gauges.tbl#Position:|Position:]]
Defines the screen coordinates for the upper left corner of this gauge.
+
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
 
+
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
*Syntax: '''Integer''' horizontal pixel, '''Integer''' vertical pixel position
+
:[[Hud_gauges.tbl#Name:|Name:]]
 
+
:[[Hud_gauges.tbl#Text:|Text:]]
 
+
:[[Hud_gauges.tbl#X-Offset|X-Offset:]] (Optional)
=====Color:=====
+
:[[Hud_gauges.tbl#Y-Offset|Y-Offset:]] (Optional)
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#Gauge Type:|Gauge Type:]]
 
+
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
*Syntax: See [[Hud_gauges.tbl#$Color: 1]]
+
:[[Hud_gauges.tbl#Active by default:|Active by default:]] (Optional)
 
+
:[[Hud_gauges.tbl#Filename:|Filename:]]
 
 
=====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.
 
 
 
*Syntax: See [[Hud_gauges.tbl#$Font: 1]]
 
 
 
 
 
=====Name:=====
 
Defines the name of this custom gauge.
 
 
 
*Syntax: '''String'''
 
*Max Length: 32 characters
 
 
 
 
 
=====Text:=====
 
Default text to be displayed. Can be altered using the hud-set-message, hud-set-text and hud-set-directive sexps.
 
 
 
*Syntax: '''String'''
 
*Max Length: 32 characters
 
 
 
 
 
=====X Offset:=====
 
Optional. Defines the horizontal pixel offset (from the gauge's origin defined by [[Hud_gauges#$Position:]]) that the Text will be displayed.
 
 
 
*Syntax: '''Integer'''
 
*Units: Pixels
 
 
 
 
 
=====Y Offset:=====
 
Optional. Defines the vertical pixel offset (from the gauge's origin defined by [[Hud_gauges#$Position:]]) that the Text will be displayed.
 
 
 
*Syntax: '''Integer'''
 
*Units: Pixels
 
 
 
 
 
=====Gauge Type:=====
 
Defines the type of gauge this is.
 
 
 
*Syntax: '''String'''
 
*Valid Values: Any one of the possible [[gauge types]].
 
 
 
 
 
=====Slew:=====
 
Optional. Determines whether or not this gauge is affected by afterburner shaking or similar effects. (May also follow the player's head movements when using TrackIR)
 
 
 
*Syntax: '''Boolean'''
 
 
 
 
 
=====Active by default:=====
 
Optional. Determines whether or not this gauge is always active, or only available after being activated via sexp.
 
 
 
*Syntax: '''Boolean'''
 
 
 
 
 
=====Filename:=====
 
Designates the file used for this gauge's the background graphic
 
 
 
*Syntax: '''Filename'''
 
  
  
Line 255: Line 194:
 
Adds a gauge that display mission messages.
 
Adds a gauge that display mission messages.
  
 
+
*Valid Sub-Entries:
=====Position:=====
+
:[[Hud_gauges.tbl#Position:|Position]]
Defines the screen coordinates for the upper left corner of this gauge.
+
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
 
+
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
*Syntax: '''Integer''' horizontal coordinate, '''Integer''' vertical coordinate
+
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
*Units: Pixels
+
:[[Hud_gauges.tbl#Max Lines:|Max Lines:]] (Optional)
*Valid Values: All positive values
+
:[[Hud_gauges.tbl#Max Width:|Max Width:]] (Optional)
 
+
:[[Hud_gauges.tbl#Line Height:|Line Height]] (Optional)
 
+
:[[Hud_gauges.tbl#Total Lifetime:|Total Lifetime:]] (Optional)
=====Color:=====
+
:[[Hud_gauges.tbl#Scroll Time:|Scroll Time]] (Optional)
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#Step Size:|Step Size:]] (Optional)
 
 
*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.
 
 
 
*Syntax: See [[Hud_gauges.tbl#$Font: 1]]
 
 
 
 
 
=====Slew:=====
 
Optional. Determines whether or not this gauge is affected by afterburner shaking or similar effects. (May also follow the player's head movements when using TrackIR)
 
 
 
*Syntax: '''Boolean'''
 
 
 
 
 
=====Max Lines:=====
 
Optional. Specifies the maximum number of message lines that are displayed.
 
 
 
*Syntax: '''Integer'''
 
*Default Value: 3
 
 
 
 
 
=====Max Width:=====
 
Optional. Determines how long each message line may be.
 
 
 
*Syntax: '''Integer'''
 
*Units: Pixels
 
 
 
 
 
=====Line Height:=====
 
Optional. Determines the distance between line origins. (i.g. for a 12pt Font, there are needs to be at least 12 pixels between the bottom of one line and the next, otherwise the text will overlap each)
 
 
 
*Syntax: '''Integer'''
 
*Units: Pixels
 
*Default Value: 12
 
 
 
 
 
=====Total Lifetime:=====
 
Optional. Determines the maximum time the message gauge will be displayed from the time a new message is received.
 
 
 
*Syntax: '''Integer'''
 
*Units: milliseconds
 
*Default Value: 14000 (14 seconds)
 
 
 
 
 
=====Scroll Time:=====
 
Optional. Determines the time for the messages to scroll up one step.( See [[Hud_gauges.tbl#Step Size:]] )
 
 
 
*Syntax: '''Integer'''
 
*Units: milliseconds
 
*Default Value: 30
 
 
 
 
 
=====Step Size:=====
 
Optional. Determines how many pixels to shift message lines during scrolling. Messages will be shifted up by this amount until they are on the next line (as defined by [[Hud_gauges.tbl#Line Height:]])
 
 
 
*Syntax: '''Integer'''
 
*Units: Pixels
 
*Default Value: 3
 
  
  
Line 331: Line 210:
 
Adds a text box, like the ones seen in the FS1 and FS2 training missions.
 
Adds a text box, like the ones seen in the FS1 and FS2 training missions.
  
 
+
*Valid Sub-Entries:
=====Position:=====
+
:[[Hud_gauges.tbl#Position:|Position]]
Defines the screen coordinates for the upper left corner of this gauge.
+
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
 
 
*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
 
*Units: Pixels
 
 
 
 
 
=====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.
 
 
 
*Syntax: See [[Hud_gauges.tbl#$Font: 1]]
 
 
 
  
  
Line 349: Line 218:
 
Adds a text box that shows the Support ship's status and ETA
 
Adds a text box that shows the Support ship's status and ETA
  
 
+
*Valid Sub-Entries:
=====Position:=====
+
:[[Hud_gauges.tbl#Position:|Position]]
Defines the screen coordinates for the upper left corner of this gauge.
+
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
 
+
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
+
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
*Units: Pixels
+
:[[Hud_gauges.tbl#Filename:|Filename:]]
 
+
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
 
+
:[[Hud_gauges.tbl#Text Y-offset:|Text Y-offset:]] (Optional)
=====Color:=====
+
:[[Hud_gauges.tbl#Dock Status X-offset:|Dock Status X-offset:]] (Optional)
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#Dock Time X-offset:|Dock Time X-offset:]] (Optional)
 
 
*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.
 
 
 
*Syntax: See [[Hud_gauges.tbl#$Font: 1]]
 
 
 
 
 
=====Slew:=====
 
Optional. Determines whether or not this gauge is affected by afterburner shaking or similar effects. (May also follow the player's head movements when using TrackIR)
 
 
 
*Syntax: '''Boolean'''
 
 
 
 
 
=====Filename:=====
 
Designates the file used for this gauge's the background graphic
 
 
 
*Syntax: '''Filename'''
 
 
 
=====Header Offsets:=====
 
Optional. Designates the offset from the gauge's upper left corner for the Support Ship header (?)
 
 
 
*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
 
*Units: Pixels
 
 
 
 
 
=====Text Y-offset:=====
 
Optional. Designates the offset from the gauge's upper left corner for the Support Ship Text. (?)
 
 
 
*Syntax: '''Integer''' vertical offset
 
*Units: Pixels
 
 
 
 
 
=====Dock Status X-offset:=====
 
Optional. Designates the offset from the gauge's upper left corner for the Support Ship's dock status. (?)
 
 
 
*Syntax: '''Integer''' vertical offset
 
*Units: Pixels
 
 
 
 
 
=====Dock Time X-offset:=====
 
Optional. Designates the offset from the gauge's upper left corner for the Support Ship's dock time. (?)
 
 
 
*Syntax: '''Integer''' vertical offset
 
*Units: Pixels
 
 
 
  
  
Line 412: Line 233:
 
Adds a gauge that shows how much damage a target (or the player?) has.
 
Adds a gauge that shows how much damage a target (or the player?) has.
  
 
+
*Valid Sub-Entries:
=====Position:=====
+
:[[Hud_gauges.tbl#Position:|Position]]
Defines the screen coordinates for the upper left corner of this gauge.
+
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
 
+
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
+
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
*Units: Pixels
+
:[[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)
=====Color:=====
+
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
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#Hull Integrity Offsets:|Hull Integrity Offsets]] (Optional)
 
+
:[[Hud_gauges.tbl#Hull Integrity Value X-offset:|Hull Integrity Value X-offset]] (Optional)
*Syntax: See [[Hud_gauges.tbl#$Color: 1]]
+
:[[Hud_gauges.tbl#Top Background Height:|Top Background Height:]] (Optional)
 
+
:[[Hud_gauges.tbl#Subsystem Entry Height:|Subsystem Entry Height:]] (Optional)
 
+
:[[Hud_gauges.tbl#Subsystem List Start Offsets:|Subsystem List Start Offsets:]] (Optional)
=====Font:=====
+
:[[Hud_gauges.tbl#Subsystem Entry Value X-offset:|Subsystem Entry Value X-offset:]] (Optional)
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: See [[Hud_gauges.tbl#$Font: 1]]
 
 
 
 
 
=====Slew:=====
 
Optional. Determines whether or not this gauge is affected by afterburner shaking or similar effects. (May also follow the player's head movements when using TrackIR)
 
 
 
*Syntax: '''Boolean'''
 
 
 
 
 
=====Top Background Filename:=====
 
Optional. Designates which file to use for the top background. (?)
 
 
 
*Syntax: '''Filename'''
 
 
 
 
 
=====Entry Background Filename:=====
 
Optional. Designates which file to use for the Entry background (?)
 
 
 
*Syntax: '''Filename'''
 
 
 
 
 
=====Bottom Background Filename:=====
 
Optional. Designates which file to use for the Bottom background (?)
 
 
 
*Syntax: '''Filename'''
 
 
 
 
 
=====Header Offsets:=====
 
Optional. Designates the offsets from the gauge's upper left corner for the for the Damage gauge header (?)
 
 
 
*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
 
*Units: Pixels
 
 
 
 
 
=====Hull Integrity Offsets:=====
 
Optional. Designates the offsets from the gauge's upper left corner for the for the Damage gauge Hull integrity textbox(?)
 
 
 
*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
 
*Units: Pixels
 
 
 
 
 
=====Hull Integrity Value X-offset:=====
 
Optional. Designates the offsets from the hull integrity textbox's upper left corner for the hull integrity value. (?)
 
 
 
*Syntax: '''Integer''' horizontal offset
 
*Units: Pixels
 
 
 
 
 
=====Top Background Height:=====
 
Optional. Designates the height of the Top background (?)
 
 
 
*Syntax: '''Integer'''
 
*Units: Pixels
 
 
 
 
 
=====Subsystem Entry Height:=====
 
Optional. Designates the height of the Subsystem entry (?)
 
 
 
*Syntax: '''Integer'''
 
*Units: Pixels
 
 
 
 
 
=====Subsystem List Start Offsets:=====
 
Optional. Designates the offsets from the gauge's upper left corner for the for the start of the Subsytem List (?)
 
 
 
*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
 
*Units: Pixels
 
 
 
 
 
=====Subsystem Entry Value X-offset:=====
 
Optional. Designates the horizontal offset from the Subsystem List's position (?)
 
 
 
*Syntax: '''Integer'''
 
*Units: Pixels
 
 
 
  
  
Line 509: Line 253:
 
Adds a gauge that monitors the status of your wing and squadron.
 
Adds a gauge that monitors the status of your wing and squadron.
  
 
+
*Valid Sub-entries:
=====Position:=====
+
:[[Hud_gauges.tbl#Position:|Position]]
Defines the screen coordinates for the upper left corner of this gauge.
+
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
 
+
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
+
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
*Units: Pixels
+
:[[Hud_gauges.tbl#Left Background Filename:|Left Background Filename:]] (Optional)
 
+
:[[Hud_gauges.tbl#Right Background Filename:|Right Background Filename:]] (Optional)
 
+
:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional)
=====Color:=====
+
:[[Hud_gauges.tbl#Dot Filename:|Dot Filename:]] (Optional)
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#Header Offsets:|Header Offsets:]] (Optional)
 
+
:[[Hud_gauges.tbl#Left Background Width:|Left Background Width:]] (Optional)
*Syntax: See [[Hud_gauges.tbl#$Color: 1]]
+
:[[Hud_gauges.tbl#Entry Width:|Entry Width:]] (Optional)
 
+
:[[Hud_gauges.tbl#Single Wing Offsets:|Single Wing Offsets:]] (Optional)
 
+
:[[Hud_gauges.tbl#Multiple Wing Start Offsets:|Multiple Wing Start Offsets:]] (Optional)
=====Font:=====
+
:[[Hud_gauges.tbl#Wing Name Offsets:|Wing Name Offsets:]] (Optional)
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.
+
:[[Hud_gauges.tbl#Dot Offsets:|Dot Offsets:]] (Optional)
 
+
:[[Hud_gauges.tbl#Expansion Mode:|Expansion Mode:]] (Optional)
*Syntax: See [[Hud_gauges.tbl#$Font: 1]]
+
:[[Hud_gauges.tbl#:|:]] (Optional)
 
 
 
 
=====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'''
 
 
 
 
 
=====Left Background Filename:=====
 
Optional. Designates which file to use for the Left background (?)
 
 
 
*Syntax: '''Filename'''
 
 
 
 
 
=====Entry Background Filename:=====
 
Optional. Designates which file to use for the Entry background (?)
 
 
 
*Syntax: '''Filename'''
 
 
 
 
 
=====Right Background Filename:=====
 
Optional. Designates which file to use for the Right background (?)
 
 
 
*Syntax: '''Filename'''
 
 
 
 
 
=====Dot Filename:=====
 
Optional. Designates which file to use for the wingman graphic (a.k.a. the Dot)
 
 
 
*Syntax: '''Filename'''
 
 
 
 
 
=====Header Offsets:=====
 
Optional. Designates the offset from the gauge's upper left corner for the Wingman header (?)
 
 
 
*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
 
*Units: Pixels
 
 
 
 
 
=====Left Background Width:=====
 
Optional. Defines the width of the Left Background.
 
 
 
*Syntax: '''Integer'''
 
*Units: Pixels
 
 
 
 
 
=====Entry Width:=====
 
Optional. Defines the width of the Entry Background (?)
 
 
 
*Syntax: '''Integer'''
 
*Units: Pixels
 
 
 
 
 
=====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
 
 
 
 
 
=====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
 
 
 
 
 
=====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
 
 
 
=====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}}
 
 
 
 
 
=====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
 
 
 
  
  
Line 626: Line 276:
 
Adds the Auto-Speed mode gauge.
 
Adds the Auto-Speed mode gauge.
  
 
+
*Valid Sub-entries:
=====Position:=====
+
:[[Hud_gauges.tbl#Position:|Position]]
*Screen coordinates for this gauge
+
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
*Syntax: '''(Integer, Integer)'''
+
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
=====Position:=====
+
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
Defines the screen coordinates for the upper left corner of this gauge.
+
:[[Hud_gauges.tbl#Filename:|Filename:]]
 
+
:[[Hud_gauges.tbl#Auto Offsets:|Auto Offsets:]] (Optional)
*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
+
:[[Hud_gauges.tbl#Speed Offsets:|Speed Offsets:]] (Optional)
*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.
 
 
 
*Syntax: See [[Hud_gauges.tbl#$Font: 1]]
 
 
 
 
 
=====Slew:=====
 
Optional. Determines whether or not this gauge is affected by afterburner shaking or similar effects. (May also follow the player's head movements when using TrackIR)
 
 
 
*Syntax: '''Boolean'''
 
 
 
 
 
=====Filename:=====
 
Optional. Designates which file to use for the background of this gauge.
 
 
 
*Syntax: '''Filename'''
 
 
 
 
 
=====Auto Offsets:=====
 
Optional. Defines the screen coordinates for the "Auto" text label.
 
 
 
*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
 
*Units: Pixels
 
 
 
 
 
=====Speed Offsets:=====
 
Optional. Defines the screen coordinates for the "Speed" text label.
 
 
 
*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
 
*Units: Pixels
 
  
  
Line 678: Line 289:
 
Adds the Auto-target mode gauge.
 
Adds the Auto-target mode gauge.
  
 
+
*Valid Sub-entries:
=====Position:=====
+
:[[Hud_gauges.tbl#Position:|Position]]
Defines the screen coordinates for the upper left corner of this gauge.
+
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
 
+
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
+
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
*Units: Pixels
+
:[[Hud_gauges.tbl#Filename:|Filename:]]
 
+
:[[Hud_gauges.tbl#Auto Offsets:|Auto Offsets:]] (Optional)
 
+
:[[Hud_gauges.tbl#Target Offsets:|Target Offsets:]] (Optional)
=====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.
 
 
 
*Syntax: See [[Hud_gauges.tbl#$Font: 1]]
 
 
 
 
 
=====Slew:=====
 
Optional. Determines whether or not this gauge is affected by afterburner shaking or similar effects. (May also follow the player's head movements when using TrackIR)
 
 
 
*Syntax: '''Boolean'''
 
 
 
 
 
=====Filename:=====
 
Optional. Designates which file to use for the background of this gauge.
 
 
 
*Syntax: '''Filename'''
 
 
 
 
 
=====Auto Offsets:=====
 
Optional. Defines the screen coordinates for the "Auto" text label.
 
 
 
*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
 
*Units: Pixels
 
 
 
 
 
=====Target Offsets:=====
 
Optional. Defines the screen coordinates for the "Target" text label.
 
 
 
*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
 
*Units: Pixels
 
  
  
Line 727: Line 302:
 
Adds a gauge that monitors the amount of remaining countermeasures the player's ship currently has.
 
Adds a gauge that monitors the amount of remaining countermeasures the player's ship currently has.
  
 
+
*Valid Sub-entries:
=====Position:=====
+
:[[Hud_gauges.tbl#Position:|Position]]
Defines the screen coordinates for the upper left corner of this gauge.
+
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
 
+
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
+
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
*Units: Pixels
+
:[[Hud_gauges.tbl#Filename:|Filename:]]
 
+
:[[Hud_gauges.tbl#Text Offsets:|Text Offsets:]] (Optional)
 
+
:[[Hud_gauges.tbl#Value Offsets:|Value Offsets:]] (Optional)
=====Color:=====
+
:[[Hud_gauges.tbl#:|:]] (Optional)
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.
 
 
 
*Syntax: See [[Hud_gauges.tbl#$Font: 1]]
 
 
 
 
 
=====Slew:=====
 
Optional. Determines whether or not this gauge is affected by afterburner shaking or similar effects. (May also follow the player's head movements when using TrackIR)
 
 
 
*Syntax: '''Boolean'''
 
 
 
 
 
=====Filename:=====
 
Optional. Designates which file to use for the background of this gauge.
 
 
 
*Syntax: '''Filename''
 
 
 
 
 
=====Text Offsets:=====
 
Optional. Defines the screen position offsets for the "Countermeasures:" label.
 
 
 
*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
 
*Units: Pixels
 
 
 
 
 
=====Value Offsets:=====
 
Optional. Defines the screen position offsets for the number of remaining countermeasures.
 
 
 
*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
 
*Units: Pixels
 
 
 
  
  
Line 1,619: Line 1,158:
 
*As per the global option above.
 
*As per the global option above.
 
*Syntax: '''Integer'''
 
*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: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Training Messages:|+Training Messages:]], [[Hud_gauges.tbl#+Support:|+Support]]
 +
 +
 +
=====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]]
 +
 +
Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Support:|+Support]]
 +
 +
 +
=====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.
 +
 +
*Syntax: See [[Hud_gauges.tbl#$Font: 1]]
 +
 +
Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Training Messages:|+Training Messages:]], [[Hud_gauges.tbl#+Support:|+Support]]
 +
 +
 +
=====Name:=====
 +
Defines the name of this custom gauge.
 +
 +
*Syntax: '''String'''
 +
*Max Length: 32 characters
 +
 +
Used by: [[Hud_gauges.tbl#+Custom:|+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: [[Hud_gauges.tbl#+Custom:|+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: [[Hud_gauges.tbl#+Custom:|+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: [[Hud_gauges.tbl#+Custom:|+Custom:]]
 +
 +
 +
=====Gauge Type:=====
 +
Defines the type of gauge this is.
 +
 +
*Syntax: '''String'''
 +
*Valid Values: Any one of the possible [[gauge types]].
 +
 +
Used by: [[Hud_gauges.tbl#+Custom:|+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: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Support:|+Support]]
 +
 +
 +
=====Max Lines:=====
 +
Optional. Specifies the maximum number of message lines that are displayed.
 +
 +
*Syntax: '''Integer'''
 +
*Default Value: 3
 +
 +
Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]
 +
 +
 +
=====Max Width:=====
 +
Optional. Determines how long each message line may be.
 +
 +
*Syntax: '''Integer'''
 +
*Units: Pixels
 +
 +
Used by: [[Hud_gauges.tbl#+Messages:|+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: [[Hud_gauges.tbl#+Messages:|+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: [[Hud_gauges.tbl#+Messages:|+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: [[Hud_gauges.tbl#+Messages:|+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: [[Hud_gauges.tbl#+Messages:|+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: [[Hud_gauges.tbl#+Custom:|+Custom:]]
 +
 +
 +
=====Filename:=====
 +
Designates the file used for this gauge's the background graphic
 +
 +
*Syntax: '''Filename'''
 +
 +
Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Support:|+Support]]
 +
 +
 +
=====Top Background Filename:=====
 +
Optional. Designates which file to use for the top background. (?)
 +
 +
*Syntax: '''Filename'''
 +
 +
Used by: [[Hud_gauges.tbl#+Damage|+Damage]]
 +
 +
 +
=====Bottom Background Filename:=====
 +
Optional. Designates which file to use for the Bottom background (?)
 +
 +
*Syntax: '''Filename'''
 +
 +
Used by: [[Hud_gauges.tbl#+Damage|+Damage]]
 +
 +
 +
=====Left Background Filename:=====
 +
Optional. Designates which file to use for the Left background (?)
 +
 +
*Syntax: '''Filename'''
 +
 +
Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status]]
 +
 +
 +
=====Right Background Filename:=====
 +
Optional. Designates which file to use for the Right background (?)
 +
 +
*Syntax: '''Filename'''
 +
 +
Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status]]
 +
 +
 +
=====Entry Background Filename:=====
 +
Optional. Designates which file to use for the Entry background (?)
 +
 +
*Syntax: '''Filename'''
 +
 +
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:=====
 +
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_gauges.tbl#+Support:|+Support]], [[Hud_gauges.tbl#+Damage|+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: [[Hud_gauges.tbl#+Support:|+Support]]
 +
 +
 +
=====Text Offsets:=====
 +
Optional. Defines the screen position offsets for the text label.
 +
 +
*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
 +
*Units: Pixels
 +
 +
Used by: :[[Hud_gauges.tbl#+Countermeasures:|+Countermeasures]]
 +
 +
 +
=====Value Offsets:=====
 +
Optional. Defines the screen position offsets for the value label.
 +
 +
*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
 +
*Units: Pixels
 +
 +
Used by: :[[Hud_gauges.tbl#+Countermeasures:|+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: [[Hud_gauges.tbl#+Support:|+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: [[Hud_gauges.tbl#+Support:|+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: [[Hud_gauges.tbl#+Damage:|+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: [[Hud_gauges.tbl#+Damage:|+Damage:]]
 +
 +
 +
=====Top Background Height:=====
 +
Optional. Designates the height of the Top background (?)
 +
 +
*Syntax: '''Integer'''
 +
*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]]
 +
 +
 +
=====Entry Width:=====
 +
Optional. Defines the width of the Entry Background (?)
 +
 +
*Syntax: '''Integer'''
 +
*Units: Pixels
 +
 +
Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status]]
 +
 +
 +
=====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]]
 
[[Category:Tables]]

Revision as of 18:23, 16 July 2012

This feature requires FreeSpace Open

Revision information.....

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


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

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

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

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


Contents

HUD Configurations

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


$Load Retail Configuration:

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

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

  • Syntax: Boolean


$Color:

Optional. Sets the default HUD color for all gauges.

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


$Font:

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

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


$Max Directives:

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

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


$Max Escort Ships:

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

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


$Length Unit Multiplier:

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

  • Syntax: Float
  • Valid Values: Any positive number


$Speed Unit Multiplier:

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

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


$Wireframe Targetbox:

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

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


$Targetbox Shader Effect:

FS2 Open, 3.6.16:

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

  • Syntax: Integer
  • Valid Values: Any positive number


$Lock Wireframe Mode:

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

  • Syntax: Boolean


$Reticle Style:

Optional. Defines which aiming reticle to use.

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


#Gauge Config

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


$Ship:

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

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

  • Syntax: String, ship class name


$Load Retail Configuration:

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

  • Syntax: Boolean


$Color:

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


$Font:

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


$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)
Hud_gauges.tbl#Bottom Background Filename: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)
: (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)
: (Optional)


+Talking Head:

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


Position:

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

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


Color:

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


Font:

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


Filename:

Optional. Designates which file to use for the background of this gauge.

  • Syntax: 'Filename


Header Offsets:

Optional. Defines the offsets for the header label.

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


Animation Offsets:

Optional. Defines the offsets for the animation graphis.

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


Animation Background Size:

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

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


+Directives:

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


Position:

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

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


Color:

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


Font:

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


Top Background Filename:

Optional. Designates which file to use for the Top Background. (?)

  • Syntax: Filename


Entry Background Filename:

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

  • Syntax: Filename


Bottom Background Filename:

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

  • Syntax: Filename


Header Offsets:

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


List Start Offsets:

Optional. Defines the screen coordinate offsets for the start of the Directives list.

  • Syntax: Integer x, Integer y
  • Units: Pixels


Entry Height:

Optional. Defines the height of each Directive

  • Syntax: Integer
  • Units: Pixels


+Weapons:

Adds a weapon status and ammunition gauge.


Position:

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

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


Color:

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


Font:

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


Slew:

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

  • Syntax: Boolean


Top Background Filename:

Optional. Designates which file to use for the Top Background. (?)

  • Syntax: Filename


Entry Background Filename:

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

  • Syntax: Filename


Bottom Background Filename:

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

  • Syntax: Filename


Header Offsets:

Optional. 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
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Slew:
  • Optional. Whether this gauge is affected by afterburner shaking or similar effects.
  • Syntax: Boolean
Filename:
  • Filename for the background graphic for this gauge
  • Syntax: Filename

+Mini Target Shields:

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

+Player Shields:

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

+Target Shields:

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

+Escort View:

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

+Mission Time:

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

+ETS Retail:

FS2 Open, 3.6.14:

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

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

+ETS Weapons:

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

+ETS Engines:

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

+ETS Shields:

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

+Target Monitor:

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

+Extra Target Data:

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

+Radar:

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

+Radar Orb:

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

+Radar BSG:

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

+Afterburner Energy:

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

+Weapon Energy:

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

+Text Warnings:

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

+Center Reticle:

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

+Throttle:

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

+Threat Indicator:

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

+Multiplayer Messages:

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

+Voice Status:

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

+Ping:

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

+Supernova:

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

+Lock Indicator:

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

+Offscreen Indicator:

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

+Target Brackets:

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

+Hostile Triangle:

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

+Target Triangle:

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

+Missile Triangles:

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

+Lead Indicator:

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

+Orientation Tee:

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

+Lead Sight:

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

+Kills:

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

+Weapon Linking:

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

+Fixed Messages:

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


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.

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