Hud gauges.tbl
| This feature requires FreeSpace Open |
Revision information.....
- FSO Revision: 9018
The hud_gauges.tbl is used for modifying the elements of the HUD. Not all gauges can be modified. However, custom gauges may be added to mimic their behavior (such as the wingman status display).
HUD Elements in FS2 are called Gauges, and each gauge has various options to customize appearance and, in some cases, their behavior as well.
This table is one of the Modular Tables and can be extended with xxx-hdg.tbm
Contents
- 1 HUD Configurations
- 2 #Gauge Config
- 2.1 $Ship:
- 2.2 $Base:
- 2.3 $Required Aspect:
- 2.4 $Min:
- 2.5 $Max:
- 2.6 $Gauges:
- 2.6.1 +Custom:
- 2.6.2 +Messages:
- 2.6.3 +Training Messages:
- 2.6.4 +Support:
- 2.6.5 +Damage:
- 2.6.6 +Wingman Status:
- 2.6.7 +Auto Speed:
- 2.6.8 +Auto Target:
- 2.6.9 +Countermeasures:
- 2.6.10 +Talking Head:
- 2.6.11 +Directives:
- 2.6.12 +Weapons:
- 2.6.13 +Objective notify:
- 2.6.14 +Squad Message
- 2.6.15 +Lag:
- 2.6.16 +Mini Target Shields:
- 2.6.17 +Player Shields:
- 2.6.18 +Target Shields:
- 2.6.19 +Escort View:
- 2.6.20 +Mission Time:
- 2.6.21 +ETS Retail:
- 2.6.22 +ETS Weapons:
- 2.6.23 +ETS Engines:
- 2.6.24 +ETS Shields:
- 2.6.25 +Target Monitor:
- 2.6.26 +Extra Target Data:
- 2.6.27 +Radar:
- 2.6.28 +Radar Orb:
- 2.6.29 +Radar BSG:
- 2.6.30 +Afterburner Energy:
- 2.6.31 +Weapon Energy:
- 2.6.32 +Text Warnings:
- 2.6.33 +Center Reticle:
- 2.6.34 +Throttle:
- 2.6.35 +Threat Indicator:
- 2.6.36 +Multiplayer Messages:
- 2.6.37 +Voice Status:
- 2.6.38 +Ping:
- 2.6.39 +Supernova:
- 2.6.40 +Lock Indicator:
- 2.6.41 +Offscreen Indicator:
- 2.6.42 +Target Brackets:
- 2.6.43 +Hostile Triangle:
- 2.6.44 +Target Triangle:
- 2.6.45 +Missile Triangles:
- 2.6.46 +Lead Indicator:
- 2.6.47 +Orientation Tee:
- 2.6.48 +Lead Sight:
- 2.6.49 +Kills:
- 2.6.50 +Weapon Linking:
- 2.6.51 +Fixed Messages:
- 2.7 $End Gauges
- 3 #End
- 4 Gauge Configuration Options
- 4.1 Position:
- 4.2 Color:
- 4.3 Font:
- 4.4 Name:
- 4.5 Text:
- 4.6 X Offset:
- 4.7 Y Offset:
- 4.8 Gauge Type:
- 4.9 Slew:
- 4.10 Max Lines:
- 4.11 Max Width:
- 4.12 Line Height:
- 4.13 Total Lifetime:
- 4.14 Scroll Time:
- 4.15 Step Size:
- 4.16 Active by default:
- 4.17 Filename:
- 4.18 Top Background Filename:
- 4.19 Bottom Background Filename:
- 4.20 Left Background Filename:
- 4.21 Right Background Filename:
- 4.22 Entry Background Filename:
- 4.23 Primary List Top Background Filename:
- 4.24 Primary List Middle Background Filename:
- 4.25 Primary List Bottom Background Filename:
- 4.26 Secondary List Top Background Filename:
- 4.27 Secondary List Entry Background Filename:
- 4.28 Secondary List Bottom Background Filename:
- 4.29 Dot Filename:
- 4.30 Header Offsets:
- 4.31 Text Y-offset:
- 4.32 Text Offsets:
- 4.33 Value Offsets:
- 4.34 Dock Status X-offset:
- 4.35 Dock Time X-offset:
- 4.36 Hull Integrity Offsets:
- 4.37 Hull Integrity Value X-offset:
- 4.38 Top Background Height:
- 4.39 Left Background Width:
- 4.40 Entry Width:
- 4.41 Subsystem Entry Height:
- 4.42 Subsystem List Start Offsets:
- 4.43 Subsystem Entry Value X-offset:
- 4.44 Single Wing Offsets:
- 4.45 Multiple Wing Start Offsets:
- 4.46 Wing Name Offsets:
- 4.47 Dot Offsets:
- 4.48 Expansion Mode:
- 4.49 Auto Offsets:
- 4.50 Speed Offsets:
- 4.51 Target Offsets:
- 4.52 Animation Offsets:
- 4.53 Animation Background Size:
- 4.54 List Start Offsets:
- 4.55 Entry Height:
- 4.56 Top Primary Background X-offset:
- 4.57 Text X-offset:
- 4.58 Top Primary Frame Height:
- 4.59 Top Secondary Frame Height:
- 4.60 Primary List Start Y-offset:
- 4.61 Secondary List Start Y-offset:
- 4.62 Primary Weapon Ammo X-offset:
- 4.63 Primary Weapon Link X-offset:
- 4.64 Primary Weapon Name X-offset:
- 4.65 Secondary Weapon Ammo X-offset:
- 4.66 Secondary Weapon Linked X-offset:
- 4.67 Secondary Weapon Name X-offset:
- 4.68 Secondary Weapon Reload X-offset:
- 4.69 Primary Weapon Entry Height:
- 4.70 Secondary Weapon Entry Height:
- 4.71 3 Digit Hull Offsets:
- 4.72 2 Digit Hull Offsets:
- 4.73 1 Digit Hull Offsets:
- 4.74 Objective Text Y-offset:
- 4.75 Objective Value Y-offset
- 4.76 Subspace Text Y-offset:
- 4.77 Subspace Value Y-offset
- 4.78 Red Alert Text Y-offset
- 4.79 Red Alert Value Y-offset
- 4.80 Command X-offset:
- 4.81 Page Up Offsets:
- 4.82 Page Down Offsets:
- 4.83 Entry Height:
- 4.84 Entry Stagger Width:
- 4.85 Header Text:
- 4.86 Header Offsets:
- 4.87 List Start Offsets:
- 4.88 Hull X-offset:
- 4.89 Name X-offset:
- 4.90 Status X-offset:
- 4.91 Foreground Clip Height:
- 4.92 Letter Offsets:
- 4.93 Top Offsets:
- 4.94 Bottom Offsets:
- 4.95 Gauge Offset:
- 4.96 Monitor Filename:
- 4.97 Integrity Bar Filename:
- 4.98 Viewport Offsets:
- 4.99 Viewport Size:
- 4.100 Integrity Bar Offsets:
- 4.101 Integrity Bar Foreground Clip Height:
- 4.102 Status Offsets:
- 4.103 Name Offsets:
- 4.104 Class Offsets:
- 4.105 Distance Offsets:
- 4.106 Speed Offsets:
- 4.107 Hull Offsets:
- 4.108 Cargo Contents Offsets:
- 4.109 Cargo Scan Start Offsets:
- 4.110 Cargo Scan Size:
- 4.111 Bracket Offsets:
- 4.112 Dock Offsets:
- 4.113 Order Offsets:
- 4.114 Time Offsets:
- 4.115 Infinity Distance Offsets:
- 4.116 Long Distance Offsets:
- 4.117 Short Distance Offsets:
- 4.118 Size:
- 4.119 XY Disc Filename:
- 4.120 XZ YZ Disc Filename:
- 4.121 Sweep Disc Filename:
- 4.122 Default Contact Filename:
- 4.123 Unknown Contact Filename:
- 4.124 Cockpit Target:
- 4.125 Loop Volume:
- 4.126 Minimum Beep Delay:
- 4.127 Foreground Clip Height:
- 4.128 Firepoint display:
- 4.129 Firepoint size:
- 4.130 Firepoint X coordinate multiplier:
- 4.131 Firepoint Y coordinate multiplier:
- 4.132 Foreground Clip Bottom Y-offset:
- 4.133 Foreground Clip Width:
- 4.134 Foreground Clip Height:
- 4.135 Afterburner Clip Height:
- 4.136 Show Background:
- 4.137 Max Speed Label Offsets:
- 4.138 Min Speed Label Offsets:
- 4.139 Orbit Center Offsets:
- 4.140 Orbit Radius:
- 4.141 Arc Filename:
- 4.142 Dumbfire Filename:
- 4.143 Lock Filename:
- 4.144 Dumbfire Offsets:
- 4.145 Lock Offsets:
- 4.146 Lock Filename:
- 4.147 Locked Filename:
- 4.148 Lock Center Offsets:
- 4.149 Locked Center Offsets:
- 4.150 Radius:
- 4.151 Triangle Base:
- 4.152 Triangle Height:
- 4.153 Center Offsets:
- 4.154 Single Primary Filename:
- 4.155 Double Primary Filename:
- 4.156 Single Secondary Filename:
- 4.157 Double Secondary Filename:
- 4.158 Triple Secondary Filename:
- 4.159 Single Primary Offsets:
- 4.160 Double Primary Offsets:
- 4.161 Single Secondary Offsets:
- 4.162 Double Secondary Offsets:
- 4.163 Triple Secondary Offsets:
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
$Length Unit Multiplier:
Optional. Sets the multiplier to applied to the reported distances. For example, if the multiplier is 0.5, then the distance reported to the player will (or at least should) be 0.5 x actual distance.
- Syntax: Float
- Valid Values: Any positive number
$Speed Unit Multiplier:
Optional. Analogous to $Length Unit Multiplier, this sets the multiplier to be applied to all speeds reported to the player. For example, if the multiplier is 0.5, the the speed reported to the player will (or at least should) be 0.5 x actual speed.
- Syntax: Float
- Valid Values: Any positive number
- Default Values:
- The value used in $Length Unit Multiplier, or
- 1, if $Length Unit Multiplier is undefined
$Wireframe Targetbox:
Optional. Defines the default draw method for the target viewer (a.k.a. targetbox).
- Syntax: Integer Draw method ID
- Valid Values:
- 0 - Standard with full, bright lighting
- 1 - Wireframe
- 2 - Standard with proper lighting (i.e. lit the same as the actual target)
- 3 - Untextured with full bright lighting (i.e. drawn with a single flat color)
$Targetbox Shader Effect:
Optional. If set, defines a unique ID for a shader effect to be used when rendering a ship for the targeting box. The ID will be passed to the main shader as in #Ship_Effects, but a table entry for the effect is not needed.
- Syntax: Integer
- Valid Values: Any positive number
$Lock Wireframe Mode:
Optional. If set, prevents targetbox draw method from being changed during the gaming session.
- Syntax: Boolean
$Reticle Style:
Optional. Defines which aiming reticle to use.
- Syntax: String
- Valid Values:
- FS1 - uses reticle1_fs1.ani
- FS2 - uses reticle1.ani
$Comms Menu Hides Messages:
Optional. Defines whether the wingman comms menu and regular messages may be drawn at the same time.
- Syntax: Boolean
- Default Value: false (messages are not visible while the comms menu is open)
#Gauge Config
The following entries define default gauge appearance and behavior. Each gauge has the option of overriding these options.
$Ship:
Optional. If defined, the following config data will only be used if the player ship is of the supplied ship class. Can be defined multiple times within a #Gauge config group to allow unique HUD configurations per ship class.
If not defined, all following config data will be applied to all ships.
- Syntax: String, ship class name
$Load Retail Configuration:
Optional. Overrides the $Load Retail Configuration global option for this ship class.
- Syntax: Boolean
$Color:
Optional. Overrides the $Color global option for this ship class.
- Syntax: See $Color
$Font:
Optional. Overrides the $Font global option for this ship class.
- Syntax: See $Font
$Base:
Defines the base resolution for this HUD configuration.
- Syntax: (Integer width, Integer height)
- Valid Values: All supported resolutions (?)
$Required Aspect:
Optional. If set, this configuration will only be loaded for the specified aspect ratios.
- Syntax: String
- Valid Values:
- "Full Screen" (4:3)
- "Wide Screen" (16:9, 16:10, or similar)
$Min:
Minimum resolution for this config. Any resolution lower than specified will not use this configuration.
- Syntax: (Integer width, Integer height)
- Valid Values: All supported resolutions (?)
$Max:
Maximum resolution for this config. Any resolution higher than specified will not use this configuration.
- Syntax: (Integer width, Integer height)
- Valid Values: All supported resolutions (?)
$Gauges:
Following entries define gauge-specific behavior. For the most part, each gauge has its own overrides that, if not defined, would otherwise use the global values.
Since many gauges have the same configuration options, each gauge entry has a list of valid sub-entries. Unless stated otherwise, these options must be defined in the same order as they are shown, starting from the top and ending at the bottom.
+Custom:
Adds a custom gauge type.
- Valid Sub-Entries:
- Position:
- Color: (Optional)
- Font: (Optional)
- Name:
- Text:
- X-Offset: (Optional)
- Y-Offset: (Optional)
- Gauge Type:
- Slew: (Optional)
- Active by default: (Optional)
- Filename:
+Messages:
Adds a gauge that display mission messages.
- Valid Sub-Entries:
- Position
- Color: (Optional)
- Font: (Optional)
- Slew: (Optional)
- Max Lines: (Optional)
- Max Width: (Optional)
- Line Height (Optional)
- Total Lifetime: (Optional)
- Scroll Time (Optional)
- Step Size: (Optional)
+Training Messages:
Adds a text box, like the ones seen in the FS1 and FS2 training missions.
- Valid Sub-Entries:
+Support:
Adds a text box that shows the Support ship's status and ETA
- Valid Sub-Entries:
- Position
- Color: (Optional)
- Font: (Optional)
- Slew: (Optional)
- Filename:
- Header Offsets: (Optional)
- Text Y-offset: (Optional)
- Dock Status X-offset: (Optional)
- Dock Time X-offset: (Optional)
+Damage:
Adds a gauge that shows how much damage a target (or the player?) has.
- Valid Sub-Entries:
- Position
- Color: (Optional)
- Font: (Optional)
- Slew: (Optional)
- Top Background Filename: (Optional)
- Entry Background Filename: (Optional)
- Bottom Background Filename: (Optional)
- Header Offsets: (Optional)
- Hull Integrity Offsets (Optional)
- Hull Integrity Value X-offset (Optional)
- Top Background Height: (Optional)
- Subsystem Entry Height: (Optional)
- Subsystem List Start Offsets: (Optional)
- Subsystem Entry Value X-offset: (Optional)
+Wingman Status:
Adds a gauge that monitors the status of your wing and squadron.
- Valid Sub-entries:
- Position
- Color: (Optional)
- Font: (Optional)
- Slew: (Optional)
- Left Background Filename: (Optional)
- Right Background Filename: (Optional)
- Entry Background Filename: (Optional)
- Dot Filename: (Optional)
- Header Offsets: (Optional)
- Left Background Width: (Optional)
- Entry Width: (Optional)
- Single Wing Offsets: (Optional)
- Multiple Wing Start Offsets: (Optional)
- Wing Name Offsets: (Optional)
- Dot Offsets: (Optional)
- Expansion Mode: (Optional)
+Auto Speed:
Adds the Auto-Speed mode gauge.
- Valid Sub-entries:
- Position
- Color: (Optional)
- Font: (Optional)
- Slew: (Optional)
- Filename:
- Auto Offsets: (Optional)
- Speed Offsets: (Optional)
+Auto Target:
Adds the Auto-target mode gauge.
- Valid Sub-entries:
- Position
- Color: (Optional)
- Font: (Optional)
- Slew: (Optional)
- Filename:
- Auto Offsets: (Optional)
- Target Offsets: (Optional)
+Countermeasures:
Adds a gauge that monitors the amount of remaining countermeasures the player's ship currently has.
- Valid Sub-entries:
- Position
- Color: (Optional)
- Font: (Optional)
- Slew: (Optional)
- Filename:
- Text Offsets: (Optional)
- Value Offsets: (Optional)
+Talking Head:
Adds a video window to display pilot message videos (a.k.a talking heads).
- Valid Sub-entries:
- Position
- Color: (Optional)
- Font: (Optional)
- Slew: (Optional)
- Filename:
- Header Offsets: (Optional)
- Animation Offsets: (Optional)
- Animation Background Size: (Optional)
+Directives:
Adds a gauge that displays all currently active directives (includes current , completed, and failed)
- Valid Sub-entries:
- Position
- Color: (Optional)
- Font: (Optional)
- Top Background Filename: (Optional)
- Entry Background Filename: (Optional)
- Bottom Background Filename: (Optional)
- Header Offsets: (Optional)
- Top Background Height: (Optional)
- List Start Offsets: (Optional)
- Entry Height: (Optional)
+Weapons:
Adds a weapon status and ammunition gauge.
- Valid Sub-entries:
- Position
- Color: (Optional)
- Font: (Optional)
- Slew: (Optional)
- Primary List Top Background Filename: (Optional)
- Primary List Middle Background Filename: (Optional)
- Primary List Bottom Background Filename: (Optional)
- Secondary List Top Background Filename: (Optional)
- Secondary List Entry Background Filename: (Optional)
- Secondary List Bottom Background Filename: (Optional)
- Header Offsets: (Optional)
- Text X-offset: (Optional)
- Top Primary Frame Height: (Optional)
- Top Secondary Frame Height: (Optional)
- Primary List Start Y-offset: (Optional)
- Secondary List Start Y-offset: (Optional)
- Primary Weapon Ammo X-offset: (Optional)
- Primary Weapon Link X-offset: (Optional)
- Primary Weapon Name X-offset: (Optional)
- Secondary Weapon Ammo X-offset: (Optional)
- Secondary Weapon Linked X-offset: (Optional)
- Secondary Weapon Name X-offset: (Optional)
- Secondary Weapon Reload X-offset: (Optional)
- Primary Weapon Entry Height: (Optional)
- Secondary Weapon Entry Height: (Optional)
+Objective notify:
Adds a Objective notifier gauge. This gauge alerts the player when receiving a new objective, or when an objective has been completed or failed. Additionally, this gauge alerts the player when entering subspace, and when a Red Alert mission orders are being received (prior to a forced subspace jump).
- Valid Sub-entries:
- Position
- Color: (Optional)
- Font: (Optional)
- Slew: (Optional)
- Filename:
- Objective Text Y-offset: (Optional)
- Objective Value Y-offset: (Optional)
- Subspace Text Y-offset: (Optional)
- Subspace Value Y-offset: (Optional)
- Red Alert Text Y-offset: (Optional)
- Red Alert Value Y-offset: (Optional)
+Squad Message
Adds the squad message gauge. In FS1 and FS2, this gauge is used to send commands to your squad. (?)
- Valid sub-entries:
- Position (Optional)
- Color: (Optional)
- Font: (Optional)
- Slew: (Optional)
- Top Background Filename: (Optional)
- Entry Background Filename: (Optional)
- Bottom Background Filename: (Optional)
- Header Offsets: (Optional)
- Top Background Height: (Optional)
- List Start Offsets: (Optional)
- Entry Height: (Optional)
- Command X-offset (Optional)
- Hud_gauges.tbl#Page Up Offsets:Page Up Offsets (Optional)
- Hud_gauges.tbl#Page Down Offsets:Page Down Offsets (Optional)
+Lag:
Adds a Lag gauge.
- Valid Sub-entries:
+Mini Target Shields:
Adds a mini Target shields gauge. In FS1 and FS2, the Mini Target Shield gauge is the one right below the center reticle, and shows the hull damage in %
- Valid Sub-entries:
- Position
- Color: (Optional)
- Font: (Optional)
- Slew: (Optional)
- Filename:
- 3 Digit Hull Offsets: (Optional)
- 2 Digit Hull Offsets: (Optional)
- 1 Digit Hull Offsets: (Optional)
+Player Shields:
Adds a gauge that shows the shield and hull status icon of the player's craft or ship.
- Valid Sub-entries:
+Target Shields:
Adds a gauge that shows the shield and hull status icon of the targeted craft or ship.
- Valid Sub-entries:
+Escort View:
Adds an escort monitor/view gauge. This gauge monitors the status of all ships assigned to the player to escort.
- Valid Sub-entries:
- Position (Optional)
- Color: (Optional)
- Font: (Optional)
- Slew: (Optional)
- Top Background Filename: (Optional)
- Entry Background Filename: (Optional)
- Bottom Background Filename: (Optional)
- Entry Height (Optional)
- Entry Stagger Width: (Optional)
- Header Text (Optional)
- Header Offsets: (Optional)
- List Start Offsets: (Optional)
- Hull X-offset (Optional)
- Name X-offset (Optional)
- Status X-offset (Optional)
+Mission Time:
Adds a gauge that displays the current mission time.
- Valid Sub-entries:
- Position (Optional)
- Color: (Optional)
- Font: (Optional)
- Slew: (Optional)
- Filename: (Optional)
- Text Offsets: (Optional)
- Value Offsets: (Optional)
+ETS Retail:
Draws the three other ETS gauges as a single gauge. Will automatically rearrange itself (like retail) if shields or other systems are missing. SVN 8830
- Valid Sub-entries:
- Position (Optional)
- Color: (Optional)
- Font: (Optional)
- Slew: (Optional)
- Filename: (Optional)
- Foreground Clip Height: (Optional)
- Letter Offsets: (Optional)
- Top Offsets: (Optional)
- Bottom Offsets: (Optional)
- Gauge Offset: (Optional)
+ETS Weapons:
Adds a gauge that displays the energy transfer rate for the energy weapons.
- Valid Sub-entries:
- Position (Optional)
- Color: (Optional)
- Font: (Optional)
- Slew: (Optional)
- Filename: (Optional)
- Foreground Clip Height: (Optional)
- Letter Offsets: (Optional)
- Top Offsets: (Optional)
- Bottom Offsets: (Optional)
+ETS Engines:
Adds a gauge that displays the energy transfer rate for the afterburner/engines.
- Valid Sub-entries:
- Position (Optional)
- Color: (Optional)
- Font: (Optional)
- Slew: (Optional)
- Filename: (Optional)
- Foreground Clip Height: (Optional)
- Letter Offsets: (Optional)
- Top Offsets: (Optional)
- Bottom Offsets: (Optional)
+ETS Shields:
Adds a gauge that displays the energy transfer rate for the shields.
- Valid Sub-entries:
- Position (Optional)
- Color: (Optional)
- Font: (Optional)
- Slew: (Optional)
- Filename: (Optional)
- Foreground Clip Height: (Optional)
- Letter Offsets: (Optional)
- Top Offsets: (Optional)
- Bottom Offsets: (Optional)
+Target Monitor:
Adds a target monitor gauge that shows the targeted ship's relative orientation and hull strength, among other things.
- Valid Sub-entries:
- Position (Optional)
- Color: (Optional)
- Font: (Optional)
- Monitor Filename: (Optional)
- Integrity Bar Filename: (Optional)
- Viewport Offsets: (Optional)
- Viewport Size: (Optional)
- Integrity Bar Offsets: (Optional)
- Integrity Bar Foreground Clip Height: (Optional)
- Status Offsets: (Optional)
- Name Offsets: (Optional)
- Class Offsets: (Optional)
- Distance Offsets: (Optional)
- Speed Offsets: (Optional)
- Hull Offsets: (Optional)
- Cargo Contents Offsets: (Optional)
- Cargo Scan Start Offsets: (Optional)
- Cargo Scan Size: (Optional)
+Extra Target Data:
Adds a gauge that displays "extra" target data, such as its current orders and docking status.
- Valid Sub-Entries:
- Position (Optional)
- Color: (Optional)
- Font: (Optional)
- Slew: (Optional)
- Filename: (Optional)
- Bracket Offsets: (Optional)
- Dock Offsets: (Optional)
- Order Offsets: (Optional)
- Time Offsets: (Optional)
+Radar:
Adds a standard radar gauge
- Valid Sub-entries:
- Position (Optional)
- Color: (Optional)
- Font: (Optional)
- Filename: (Optional)
- Infinity Distance Offsets (Optional)
- Long Distance Offsets: (Optional)
- Short Distance Offsets: (Optional)
+Radar Orb:
Adds a 3D orb radar gauge
- Valid Sub-entries:
- Position (Optional)
- Color: (Optional)
- Font: (Optional)
- Filename: (Optional)
- Infinity Distance Offsets (Optional)
- Long Distance Offsets: (Optional)
- Short Distance Offsets: (Optional)
+Radar BSG:
Adds a BSG style radar.
- Position (Optional)
- Font: (Optional)
- Size: (Optional)
- XY Disc Filename: (Optional)
- XZ YZ Disc Filename: (Optional)
- Sweep Disc Filename: (Optional)
- Default Contact Filename: (Optional)
- Unknown Contact Filename: (Optional)
- Cockpit Target: (Optional)
- Loop Volume: (Optional)
- Minimum Beep Delay (Optional)
+Afterburner Energy:
Adds a gauge that shows the remaining afterburner energy.
- Valid Sub-Entries:
- Position (Optional)
- Color: (Optional)
- Font: (Optional)
- Slew: (Optional)
- Filename: (Optional)
- Foreground Clip Height: (Optional)
+Weapon Energy:
Adds a gauge that shows the remaining weapon energy.
- Valid Sub-Entries:
- Position (Optional)
- Color: (Optional)
- Font: (Optional)
- Slew: (Optional)
- Filename: (Optional)
- Foreground Clip Height: (Optional)
- Text Offsets: (Optional)
+Text Warnings:
Adds a gauge that warns the player (of something).
- Valid Sub-Entries:
+Center Reticle:
Adds a "custom" center reticle.
- Valid Sub-Entries:
- Position (Optional)
- Color: (Optional)
- Font: (Optional)
- Filename: (Optional)
- Firepoint display: (Optional)
- Firepoint size: (Optional)
- Firepoint X coordinate multiplier: (Optional)
- Firepoint Y coordinate multiplier: (Optional)
+Throttle:
Adds a gauge that shows the current throttle position.
- Valid Sub-Entries:
- Position (Optional)
- Color: (Optional)
- Font: (Optional)
- Filename: (Optional)
- Foreground Clip Bottom Y-offset: (Optional)
- Foreground Clip Width: (Optional)
- Foreground Clip Height: (Optional)
- Afterburner Clip Height: (Optional)
- Show Background: (Optional)
- Max Speed Label Offsets: (Optional)
- Min Speed Label Offsets: (Optional)
- Orbit Center Offsets: (Optional)
- Orbit Radius: (Optional)
+Threat Indicator:
Adds a gauge that indicates when a lock-on has been achieved by an attacker, and if the player is being shot at.
- Valid Sub-Entries:
- Position (Optional)
- Color: (Optional)
- Font: (Optional)
- Slew: (Optional)
- Arc Filename: (Optional)
- Dumbfire Filename: (Optional)
- Lock Filename: (Optional)
- Dumbfire Offsets: (Optional)
- Lock Offsets: (Optional)
+Multiplayer Messages:
Adds a gauge that displays the multiplayer messages.
- Valid Sub-Entries:
+Voice Status:
Adds a gauge that displays the voice status.
- Valid Sub-Entries:
+Ping:
Adds a gauge that the ping time to the multiplayer server.
- Valid Sub-Entries:
+Supernova:
Adds a gauge that warns the player of an impending supernova shock wave.
- Valid Sub-Entries:
+Lock Indicator:
Adds a Lock Indicator gauge.
- Valid Sub-Entries:
- Font: (Optional)
- Lock Filename: (Optional)
- Locked Filename: (Optional)
- Lock Center Offsets: (Optional)
- Locked Center Offsets: (Optional)
+Offscreen Indicator:
Adds an Offscreen Indicator.
- Valid Sub-Entries:
- Font: (Optional)
+Target Brackets:
Adds a Target Bracket gauge. This is drawn around current target(s) and talkers.
- Valid Sub-Entries:
- Font: (Optional)
- Dot Filename: (Optional)
+Hostile Triangle:
Adds a gauge that points to the nearest attacker, if it is off-screen and is not currently targeted.
- Valid Sub-entries:
- Font: (Optional)
- Slew: (Optional)
- Radius (Optional)
- Triangle Base: (Optional)
- Triangle Height: (Optional)
+Target Triangle:
Adds a gauge that points to the targeted craft, if it is currently off-screen.
- Valid Sub-entries:
- Font: (Optional)
- Slew: (Optional)
- Radius (Optional)
- Triangle Base: (Optional)
- Triangle Height: (Optional)
+Missile Triangles:
Adds a gauge that is used during attempting to lock onto a target when using an aspect seeking missile.
- Valid Sub-entries:
- Font: (Optional)
- Slew: (Optional)
- Radius (Optional)
- Triangle Base: (Optional)
- Triangle Height: (Optional)
+Lead Indicator:
Adds a gauge that is used to raise the probability of hitting a target with primary weapons.
- Valid Sub-entries:
- Font: (Optional)
- Filename: (Optional)
- Center Offsets: (Optional)
+Orientation Tee:
Adds a gauge that indicates the targeted craft's orientation in relation to the player's craft.
- Valid Sub-Entries:
+Lead Sight:
- Valid Sub-Entries:
+Kills:
Adds a gauge that keeps track of how many kills the player has scored during a mission.
- Valid Sub-Entries:
- Position (Optional)
- Color: (Optional)
- Font: (Optional)
- Slew: (Optional)
- Filename: (Optional)
- Text Offsets: (Optional)
- Value Offsets: (Optional)
+Weapon Linking:
Adds a gauge that indicates the selected weapons and their firing rates.
- Valid Sub-Entries:
- Position (Optional)
- Color: (Optional)
- Font: (Optional)
- Slew: (Optional)
- Arc Filename: (Optional)
- Single Primary Filename: (Optional)
- Double Primary Filename: (Optional)
- Single Secondary Filename: (Optional)
- Double Secondary Filename: (Optional)
- Triple Secondary Filename: (Optional)
- Single Primary Offsets: (Optional)
- Double Primary Offsets: (Optional)
- Single Secondary Offsets: (Optional)
- Double Secondary Offsets: (Optional)
- Triple Secondary Offsets: (Optional)
+Fixed Messages:
- Valid Sub-Entries:
$End Gauges
The Gauges section must end with $End Gauges. No Exceptions.
#End
The very last entry in the Hud_gauges.tbl must be #End. No Exceptions.
Gauge Configuration Options
Since a vast majority of gauges share the same entries, the configuration options for each gauge have been grouped here for formatting consistency.
Position:
Defines the screen coordinates for the upper left corner of this gauge.
- Syntax: Integer horizontal pixel, Integer vertical pixel position
Used by: +Custom:, +Training Messages:, +Support
Color:
Optional. Overrides both previous color settings ($Color HUD option and $Color ship class option) for this particular gauge.
- Syntax: See $Color:
Font:
Optional. Overrides both previous font settings ($Font HUD option and $Font ship class option) for this particular gauge.
- Syntax: See $Font:
Used by: +Custom:, +Training Messages:, +Support
Name:
Defines the name of this custom gauge.
- Syntax: String
- Max Length: 32 characters
Used by: +Custom:
Text:
Default text to be displayed. Can be altered using the hud-set-message, hud-set-text and hud-set-directive sexps.
- Syntax: String
- Max Length: 32 characters
Used by: +Custom:
X Offset:
Optional. Defines the horizontal pixel offset (from the gauge's origin as defined by Position:) that the Text will be displayed.
- Syntax: Integer
- Units: Pixels
Used by: +Custom:
Y Offset:
Optional. Defines the vertical pixel offset (from the gauge's origin defined by Position:) that the Text will be displayed.
- Syntax: Integer
- Units: Pixels
Used by: +Custom:
Gauge Type:
Defines the type of gauge this is.
- Syntax: String
- Valid Values: Any one of the possible gauge types.
Used by: +Custom:
Slew:
Optional. Determines whether or not this gauge is affected by afterburner shaking or similar effects. (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
Used by: +Messages:
Max Width:
Optional. Determines how long each message line may be.
- Syntax: Integer
- Units: Pixels
Used by: +Messages:
Line Height:
Optional. Determines the distance between line origins. (i.g. for a 12pt Font, there are needs to be at least 12 pixels between the bottom of one line and the next, otherwise the text will overlap each)
- Syntax: Integer
- Units: Pixels
- Default Value: 12
Used by: +Messages:
Total Lifetime:
Optional. Determines the maximum time the message gauge will be displayed from the time a new message is received.
- Syntax: Integer
- Units: milliseconds
- Default Value: 14000 (14 seconds)
Used by: +Messages:
Scroll Time:
Optional. Determines the time for the messages to scroll up one step.( See Step Size: )
- Syntax: Integer
- Units: milliseconds
- Default Value: 30
Used by: +Messages:
Step Size:
Optional. Determines how many pixels to shift message lines during scrolling. Messages will be shifted up by this amount until they are on the next line (as defined by Line Height:)
- Syntax: Integer
- Units: Pixels
- Default Value: 3
Used by: +Messages:
Active by default:
Optional. Determines whether or not this gauge is always active, or only available after being activated via sexp.
- Syntax: Boolean
Used by: +Custom:
Filename:
Designates the file used for this gauge's the background graphic
- Syntax: Filename
Top Background Filename:
Optional. Designates which file to use for the top background. (?)
- Syntax: Filename
Used by: +Damage
Bottom Background Filename:
Optional. Designates which file to use for the Bottom background (?)
- Syntax: Filename
Used by: +Damage
Left Background Filename:
Optional. Designates which file to use for the Left background (?)
- Syntax: Filename
Used by: +Wingman Status:
Right Background Filename:
Optional. Designates which file to use for the Right background (?)
- Syntax: Filename
Used by: +Wingman Status:
Entry Background Filename:
Optional. Designates which file to use for the Entry background
- Syntax: Filename
Used by: +Damage, +Wingman Status:
Primary List Top Background Filename:
Optional. Designates which file to use for the Primary List Top Background
Used by: +Weapons:
Primary List Middle Background Filename:
Optional. Designates which file to use for the Primary List Middle Background
Used by: +Weapons:
Primary List Bottom Background Filename:
Optional. Designates which file to use for the Primary List Bottom Background
Used by: +Weapons:
Secondary List Top Background Filename:
Optional. Designates which file to use for the Secondary List Top Background
Used by: +Weapons:
Secondary List Entry Background Filename:
Optional. Designates which file to use for the Secondary List Entry Background
Used by: +Weapons:
Secondary List Bottom Background Filename:
Optional. Designates which file to use for the Secondary List Bottom Background
Used by: +Weapons:
Dot Filename:
Optional. Designates which file to use for the wingman graphic (a.k.a. the Dot)
- Syntax: Filename
Used by: +Wingman Status:
Header Offsets:
Optional. Designates the offset from the gauge's upper left corner for the Support Ship header (?)
- Syntax: Integer horizontal offset, Integer vertical offset
- Units: Pixels
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
Used by: +Wingman Status:
Expansion Mode:
Optional. Denotes which direction (in relation to the player's wing) that the other wings should be appended to the gauge
- Syntax: String
- Valid Values:
- "Right" ;; Wings are added to the right of the previous wing
Used by: +Wingman Status:
Auto Offsets:
Optional. Defines the screen coordinates for the "Auto" text label.
- Syntax: Integer horizontal position, Integer vertical position
- Units: Pixels
Used by: +Auto Speed:, +Auto Target:
Speed Offsets:
Optional. Defines the screen coordinates for the "Speed" text label.
- Syntax: Integer horizontal position, Integer vertical position
- Units: Pixels
Used by: +Auto Speed:
Target Offsets:
Optional. Defines the screen coordinates for the "Target" text label.
- Syntax: Integer horizontal position, Integer vertical position
- Units: Pixels
Used by: +Auto Target:
Animation Offsets:
Optional. Defines the offsets for the animation graphics.
- Syntax: Integer horizontal offset, Integer vertical offset
- Units: Pixels
Used by: +Talking Head:
Animation Background Size:
Optional. Defines the size of the animation's background (?)
- Syntax: Integer horizontal offset, Integer vertical offset
- Units: Pixels
Used by: +Talking Head:
List Start Offsets:
Optional. Defines the screen coordinate offsets for the start of the Directives list.
- Syntax: Integer x, Integer y
- Units: Pixels
Used by: +Directives:
Entry Height:
Optional. Defines the height of each Directive
- Syntax: Integer
- Units: Pixels
Used by: +Directives:
Top Primary Background X-offset:
Optional. Defines the screen coordinate offset for the Top Primary Background
- Syntax: Integer
- Units: Pixels
Used by: +Weapons:
Text X-offset:
Used by: +Weapons:
Top Primary Frame Height:
Used by: +Weapons:
Top Secondary Frame Height:
Used by: +Weapons:
Primary List Start Y-offset:
Used by: +Weapons:
Secondary List Start Y-offset:
Used by: +Weapons:
Primary Weapon Ammo X-offset:
Used by: +Weapons:
Primary Weapon Link X-offset:
Used by: +Weapons:
Primary Weapon Name X-offset:
Used by: +Weapons:
Secondary Weapon Ammo X-offset:
Used by: +Weapons:
Secondary Weapon Linked X-offset:
Used by: +Weapons:
Secondary Weapon Name X-offset:
Used by: +Weapons:
Secondary Weapon Reload X-offset:
Used by: +Weapons:
Primary Weapon Entry Height:
Used by: +Weapons:
Secondary Weapon Entry Height:
Used by: +Weapons:
3 Digit Hull Offsets:
Designates the screen position offsets for the hull damage % when it is the 3 digit range (i.e. >= 100%)
- Syntax: Integer x offset, Integer y offset
- Units: Pixels
Used by: +Mini Target Shields:
2 Digit Hull Offsets:
Designates the screen position offsets for the hull damage % when it is the 2 digit range (i.e. 100% > hull damage% >= 10%)
- Syntax: Integer x offset, Integer y offset
- Units: Pixels
Used by: +Mini Target Shields:
1 Digit Hull Offsets:
Designates the screen position offsets for the hull damage % when it is the 1 digit range (i.e. 10% > hull damage% >= 0%)
- Syntax: Integer x offset, Integer y offset
- Units: Pixels
Used by: +Mini Target Shields:
Objective Text Y-offset:
Designates the screen position offset for the Objective label
- Syntax: Integer y offset
- Units: Pixels
Used by: +Objective notify:
Objective Value Y-offset
Designates the screen position offset for the Objective value
- Syntax: Integer y offset
- Units: Pixels
Used by: +Objective notify:
Subspace Text Y-offset:
Designates the screen position offset for the Subspace label
- Syntax: Integer y offset
- Units: Pixels
Used by: +Objective notify:
Subspace Value Y-offset
Designates the screen position offset for the Subspace value (?)
- Syntax: Integer y offset
- Units: Pixels
Used by: +Objective notify:
Red Alert Text Y-offset
Designates the screen position offset for the Red Alert label
- Syntax: Integer y offset
- Units: Pixels
Used by: +Objective notify:
Red Alert Value Y-offset
Designates the screen position offset for the Red Alert value (?)
- Syntax: Integer y offset
- Units: Pixels
Used by: +Objective notify:
Command X-offset:
- Syntax: Integer x offset
- Units: Pixels
Used by: +Squad Message:
Page Up Offsets:
- Syntax: Integer x offset, Integer y offset
- Units: Pixels
Used by: +Squad Message:
Page Down Offsets:
- Syntax: Integer x offset, Integer y offset
- Units: Pixels
Used by: +Squad Message:
Entry Height:
Used by: +Escort View:
Entry Stagger Width:
Used by: +Escort View:
Header Text:
Used by: +Escort View:
Header Offsets:
Used by: +Escort View:
List Start Offsets:
Used by: +Escort View:
Hull X-offset:
Used by: +Escort View:
Name X-offset:
Used by: +Escort View:
Status X-offset:
Used by: +Escort View:
Foreground Clip Height:
Used by: +ETS Retail:
Letter Offsets:
Used by: +ETS Retail:
Top Offsets:
Used by: +ETS Retail:
Bottom Offsets:
Used by: +ETS Retail:
Gauge Offset:
- Distance between the individual weapon/shield/engine ETS gauges that comprise this gauge
- Syntax: Integer
Used by: +ETS Retail:
Monitor Filename:
Used by: +Target Monitor:
Integrity Bar Filename:
Used by: +Target Monitor:
Viewport Offsets:
Used by: +Target Monitor:
Viewport Size:
Used by: +Target Monitor:
Integrity Bar Offsets:
Used by: +Target Monitor:
Integrity Bar Foreground Clip Height:
Used by: +Target Monitor:
Status Offsets:
Used by: +Target Monitor:
Name Offsets:
Used by: +Target Monitor:
Class Offsets:
Used by: +Target Monitor:
Distance Offsets:
Used by: +Target Monitor:
Speed Offsets:
Used by: +Target Monitor:
Hull Offsets:
Used by: +Target Monitor:
Cargo Contents Offsets:
Used by: +Target Monitor:
Cargo Scan Start Offsets:
Used by: +Target Monitor:
Cargo Scan Size:
Used by: +Target Monitor:
Bracket Offsets:
Used by: +Extra Target Data:
Dock Offsets:
Used by: +Extra Target Data:
Order Offsets:
Used by: +Extra Target Data:
Time Offsets:
Used by: +Extra Target Data:
Infinity Distance Offsets:
Used by: +Radar:
Long Distance Offsets:
Used by: +Radar:
Short Distance Offsets:
Used by: +Radar:
Size:
Used by: +Radar BSG:
XY Disc Filename:
Used by: +Radar BSG:
XZ YZ Disc Filename:
Used by: +Radar BSG:
Sweep Disc Filename:
Used by: +Radar BSG:
Default Contact Filename:
Used by: +Radar BSG:
Unknown Contact Filename:
Used by: +Radar BSG:
Cockpit Target:
Used by: +Radar BSG:
Canvas Size:
Used by: +Radar BSG:
Display Offset:
Used by: +Radar BSG:
Display Size:
Used by: +Radar BSG:
Loop Volume:
Used by: +Radar BSG
Minimum Beep Delay:
Used by: +Radar BSG
Foreground Clip Height:
Used by: +Afterburner Energy:
Firepoint display:
Displays the positions of the gun firepoints on your ship
- Syntax: Boolean, YES or NO
Used by: +Center Reticle
Firepoint size:
Diameter of the gunpoint circles. Must be 4 or greater in order to work properly.
- Syntax: Integer
Used by: +Center Reticle
Firepoint X coordinate multiplier:
Used by: +Center Reticle
Firepoint Y coordinate multiplier:
Used by: +Center Reticle
Foreground Clip Bottom Y-offset:
Used by: +Throttle:
Foreground Clip Width:
Used by: +Throttle:
Foreground Clip Height:
Used by: +Throttle:
Afterburner Clip Height:
Used by: +Throttle:
Show Background:
Used by: +Throttle:
Max Speed Label Offsets:
Used by: +Throttle:
Min Speed Label Offsets:
Used by: +Throttle:
Orbit Center Offsets:
Used by: +Throttle:
Orbit Radius:
Used by: +Throttle:
Arc Filename:
- Filename for the background graphic for this gauge
- Syntax: Filename
Used by: +Threat Indicator:
Dumbfire Filename:
- Filename for the background graphic for this gauge
- Syntax: Filename
Used by: +Threat Indicator:
Lock Filename:
- Filename for the background graphic for this gauge
- Syntax: Filename
Used by: +Threat Indicator:
Dumbfire Offsets:
- Filename for the background graphic for this gauge
- Syntax: Filename
Used by: +Threat Indicator:
Lock Offsets:
- Filename for the background graphic for this gauge
- Syntax: Filename
Used by: +Threat Indicator:
Lock Filename:
Used by: +Lock Indicator:
Locked Filename:
Used by: +Lock Indicator:
Lock Center Offsets:
Used by: +Lock Indicator:
Locked Center Offsets:
Used by: +Lock Indicator:
Radius:
Defines the distance from the center of the screen to the base of the Hostile Triangle gauge.
- Syntax: Integer
- Default value:
- Units: Pixels
Used by: +Hostile Triangle:
Triangle Base:
Defines the width of the Hostile Triangle's base.
- Syntax: Float
- Default value:
- Units: Pixels
Used by: +Hostile Triangle:
Triangle Height:
Defines the height of the Hostile Triangle.
- Syntax: Float
Default value:
- Units: Pixels
Used by: +Hostile Triangle:
Center Offsets:
Used by: +Lead Indicator:
Single Primary Filename:
Designates the file to use for the primary single fire-mode.
Used by: +Weapon Linking:
Double Primary Filename:
Used by: +Weapon Linking:
Single Secondary Filename:
Used by: +Weapon Linking:
Double Secondary Filename:
Used by: +Weapon Linking:
Triple Secondary Filename:
Used by: +Weapon Linking:
Single Primary Offsets:
Used by: +Weapon Linking:
Double Primary Offsets:
Used by: +Weapon Linking:
Single Secondary Offsets:
Used by: +Weapon Linking:
Double Secondary Offsets:
Used by: +Weapon Linking:
Triple Secondary Offsets:
Used by: +Weapon Linking:
