Difference between revisions of "Hud gauges.tbl"

From FreeSpace Wiki
Jump to: navigation, search
(Firepoint size:)
m (Revision fix)
Line 1: Line 1:
 
{{SCP table}}
 
{{SCP table}}
 +
 +
{{TableVersion|????}}
  
 
hud_gauges.tbl is used for modifying the elements of the HUD. It is as of now currently unfinished. Not all gauges can be modified. However, it can still be used to add custom gauges equivalent to something like the wingman status display.
 
hud_gauges.tbl is used for modifying the elements of the HUD. It is as of now currently unfinished. Not all gauges can be modified. However, it can still be used to add custom gauges equivalent to something like the wingman status display.

Revision as of 12:12, 13 December 2011

This feature requires SCP

Revision information.....

FSO Revision: ????
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. It is as of now currently unfinished. Not all gauges can be modified. However, it can still be used to add custom gauges equivalent to something like the wingman status display.

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

Contents

Gauge system overview

  • HUD Elements in FS2 are called Gauges. Each gauge has various options to customize appearance and, in some cases, gauge behaviour.

Table Contents

$Load Retail Configuration:

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

$Font:

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

$Max Directives:

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

$Max Escort Ships:

  • Sets the number of escort ships shown in the list. Entries more than 16 will cause the list to overflow into the weapons list under a resolution of 1024x768.
  • Syntax: Integer

$Length Unit Multiplier:

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

$Speed Unit Multiplier:

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

$Wireframe Targetbox:

  • Defines the default draw method for the targetbox
  • Syntax: Integer
    • Options:
  • 0 - Standard with full bright lighting
  • 1 - Wireframe
  • 2 - Standard with proper lighting

$Lock Wireframe Mode:

  • If set, prevents targetbox draw method from being changed during the gaming session. This can be used by modders to define an unchangable look for their mod.
  • Syntax: Boolean


$Reticle Style:

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

#Gauge Config

$Ship:

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

$Load Retail Configuration:

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

$Font:

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

$Base:

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

$Required Aspect:

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

$Min:

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

$Max:

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

$Gauges:

+Custom:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Name:
  • Name of this custom gauge.
  • Syntax: String, max length 32 characters
Text:
  • Default text to be displayed. Can be altered using the hud-set-message, hud-set-text and hud-set-directive sexps.
  • Syntax: String, max length 32 characters
X Offset:
  • Text will be displayed with an offset of x pixels from the gauge origin.
  • Syntax: Integer
Y Offset:
  • Text will be displayed with an offset of y pixels from the gauge origin.
  • Syntax: Integer
Gauge Type:
  • Each custom gauge must have a type.
  • Syntax: String, one of the possible gauge types.
Slew:
  • Optional. Whether this gauge is affected by afterburner shaking or similar effects.
  • Syntax: Boolean
Color:
  • Optional. Defines the colour to use for this gauge.
  • Syntax: Integer Integer Integer
Active by default:
  • Optional. Whether this gauge is always active, or only available after being activated via sexp.
  • Syntax: Boolean
Filename:
  • Filename for the background graphic for this gauge
  • Syntax: Filename

+Messages:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Slew:
  • Optional. Whether this gauge is affected by afterburner shaking or similar effects.
  • Syntax: Boolean
Max Lines:
  • Optional. Maximum number of message lines that are displayed.
  • Syntax: Integer, default is 3
Max Width:
  • Optional. How many pixels the message lines may be long.
  • Syntax: Integer
Line Height:
  • Optional. Vertical separation between message lines in pixels.
  • Syntax: Integer
Total Lifetime:
  • Optional. Message lifetime in milliseconds.
  • Syntax: Integer
Scroll Time:
  • Optional. Time to scroll one line.
  • Syntax: Integer
Step Size:
  • Optional.
  • Syntax: Integer

+Training Messages:

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

+Support:

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

+Damage:

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

+Wingman Status:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Slew:
  • Optional. Whether this gauge is affected by afterburner shaking or similar effects.
  • Syntax: Boolean
Left Background Filename:
Entry Background Filename:
Right Background Filename:
Dot Filename:
Header Offsets:
Left Background Width:
Entry Width:
Single Wing Offsets:
Multiple Wing Start Offsets:
Wing Name Offsets:
Dot Offsets:
Expansion Mode:

+Auto Speed:

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

+Auto Target:

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

+Countermeasures:

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

+Talking Head:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Filename:
Header Offsets:
Animation Offsets:
Animation Background Size:

+Directives:

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

+Weapons:

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

+Lag:

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

+Mini Target Shields:

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

+Player Shields:

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

+Target Shields:

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

+Escort View:

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

+Mission Time:

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

+ETS Weapons:

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

+ETS Engines:

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

+ETS Shields:

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

+Target Monitor:

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

+Extra Target Data:

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

+Radar:

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

+Radar Orb:

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

+Radar BSG:

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

+Afterburner Energy:

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

+Weapon Energy:

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

+Text Warnings:

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

+Center Reticle:

Position:
  • Screen coordinates for this gauge
  • Syntax: (Integer, Integer)
Font:
  • As per the global option above.
  • Syntax: Integer
Filename:
  • Filename for the background graphic for this gauge
  • Syntax: Filename
Firepoint display:
  • 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