Weapon hud interface

## Overview

weapon\_hud\_interface tags are used to reference bitmaps for use with specific weapons. These tags are also control the behavior and visage of the final post-processed bitmap image on-screen. Scroll down to view all the major tabs located within the weapon\_hud\_interface tags to view information on each tab and their sub-categories.

## Child HUD reference

This section allows you to reference another separate weapon\_hud\_interface tag to stack on top of the current one. They work similarly to Photoshop layers, in that the referenced images within the tags can be stacked and rendered on top of, and along side each other. Do **NOT** create a reference loop or else the game will crash (Exception!) when loading a map with the looped HUD tags.

## Static Elements

### State Attached To

1. **Total Ammo** - This is the state which uses the values of the currently equipped weapons' "Total Ammo", or ammo that is available to the player but not necessarily loaded into the weapon (spare ammo).
2. **Loaded Ammo** - This is the state which uses the values of the currently equipped weapons' "Loaded Ammo", or ammo that is loaded into the "clip/magazine" of the weapon and is available for immediate firing.
3. **Heat** - This is the state of the equipped weapons' heat values (as determined by the .weapon tag's heat values). (add more info on the scaling of the heat)
4. **Age** - For all intents and purposes, this is the amount of battery charge left in the weapon (Plasma Pistol battery charge, for example)
5. **Secondary Weapon Total Ammo** - Information Unavailable
6. **Secondary Weapon Loaded Ammo' *'***- Information Unavailable
7. **Distance To Target' *'***- Information Unavailable
8. **Elevation To Target' *'***- Information Unavailable

### Can Use On Map Type

1. **Any** - Information Unavailable (Possibly deals with split-screen 'multiplayer', not online\co-op VS Single Player)
2. **Solo** - Information Unavailable
3. **Multiplayer** - Information Unavailable

### Anchor Offset

1. **X**
2. **Y**

### Width Scale

1. **X**
2. **Y**

### Height Scale

1. **X**
2. **Y**

### Scaling Flags

1. **Don't Scale Offset**
2. **Don't Scale Size**
3. **Use High Res Scale**

### Interface Bitmap

1. Information on interface bitmaps will go here soon

### Default Color

1. Information on default colors will go here soon

### Flashing Color

1. Information on flashing colors will go here soon

### Flash Period

1. Information on flash periods will go here soon

### Flash Delay

1. Information on flash delays will go here soon

### Number Of Flashes

1. Information on number of flashes will go here soon

### Flash Flags

1. Information on flash flags will go here soon

### Flash length

1. Information on flash lengths will go here soon

### Disabled Color

1. Information on disabled color will go here soon

### Sequence Index

1. Information on sequence indexes will go here soon

## Multilex Overlays (Dynamic Bitmaps)

Multilex overlays can be used for a variety of purposes. These bitmaps are generally called Dynamic Bitmaps because they are in some ways more flexible than other static bitmaps, even though they technically reside within the Static Bitmaps section.

### Notable Examples

**Effectors**

1. This is a part of the Multilex Overlays. This section further controls the behavior referenced in the Static Bitmaps section.