unit_hud_interface

🚧 This article is a stub. You can help expand it by submitting content in pull requests or issues in this wiki's source repo.

...

Structure and fields #

Field Type Comments
anchor enum
Option Value Comments
top left 0x0
top right 0x1
bottom left 0x2
bottom right 0x3
center 0x4
pad(2)
pad(32)
hud background anchor offset
Point2DInt
  • x: i16
  • y: i16
hud background width scale f32
  • Default value: 1.
hud background height scale f32
  • Default value: 1.
hud background scaling flags bitfield(16)
Flag Mask Comments
don't scale offset 0x1
don't scale size 0x2
use high res scale 0x4
pad(2)
pad(20)
hud background default color
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
hud background flashing color
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
hud background flash period f32
hud background flash delay f32
hud background number of flashes u16
hud background flash flags bitfield(16)
Flag Mask Comments
reverse default flashing colors 0x1
hud background flash length f32
hud background disabled color
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
pad(4)
hud background sequence index Index: u16
pad(2)
hud background multitex overlay Block?
Field Type Comments
pad(2)
type i16
framebuffer blend function enum
Option Value Comments
alpha blend 0x0
multiply 0x1
double multiply 0x2
add 0x3
subtract 0x4
component min 0x5
component max 0x6
alpha multiply add 0x7
pad(2)
pad(32)
primary anchor enum
Option Value Comments
top left 0x0
top right 0x1
bottom left 0x2
bottom right 0x3
center 0x4
secondary anchor enum
Option Value Comments
texture 0x0
screen 0x1
tertiary anchor enum
Option Value Comments
texture 0x0
screen 0x1
zero to one blend function enum
Option Value Comments
add 0x0
subtract 0x1
multiply 0x2
multiply2x 0x3
dot 0x4
one to two blend function enum
Option Value Comments
add 0x0
subtract 0x1
multiply 0x2
multiply2x 0x3
dot 0x4
pad(2)
primary scale
Point2D
  • x: f32
  • y: f32
secondary scale
Point2D
  • x: f32
  • y: f32
tertiary scale
Point2D
  • x: f32
  • y: f32
primary offset
Point2D
  • x: f32
  • y: f32
secondary offset
Point2D
  • x: f32
  • y: f32
tertiary offset
Point2D
  • x: f32
  • y: f32
primary wrap mode enum
Option Value Comments
clamp 0x0
wrap 0x1
secondary wrap mode enum
Option Value Comments
clamp 0x0
wrap 0x1
tertiary wrap mode enum
Option Value Comments
clamp 0x0
wrap 0x1
pad(2)
pad(184)
effectors Block?
Field Type Comments
pad(64)
destination type enum
Option Value Comments
tint 0 1 0x0
horizontal offset 0x1
vertical offset 0x2
fade 0 1 0x3
destination enum
Option Value Comments
geometry offset 0x0
primary map 0x1
secondary map 0x2
tertiary map 0x3
source enum
Option Value Comments
player pitch 0x0
player pitch tangent 0x1
player yaw 0x2
weapon ammo total 0x3
weapon ammo loaded 0x4
weapon heat 0x5
explicit uses low bound 0x6
weapon zoom level 0x7
pad(2)
in bounds f32 (source units) (min & max)
out bounds f32 (pixels) (min & max)
pad(64)
tint color lower bound
ColorRGB
  • red: f32
  • green: f32
  • blue: f32
tint color upper bound
ColorRGB
  • red: f32
  • green: f32
  • blue: f32
periodic function enum
Option Value Comments
one 0x0
zero 0x1
cosine 0x2
cosine variable period 0x3
diagonal wave 0x4
diagonal wave variable period 0x5
slide 0x6
slide variable period 0x7
noise 0x8
jitter 0x9
wander 0xa
spark 0xb
pad(2)
function period f32 (seconds)
function phase f32 (seconds)
pad(32)
pad(128)
pad(4)
shield panel background anchor offset
Point2DInt
  • x: i16
  • y: i16
shield panel background width scale f32
  • Default value: 1.
shield panel background height scale f32
  • Default value: 1.
shield panel background scaling flags bitfield(16)
Flag Mask Comments
don't scale offset 0x1
don't scale size 0x2
use high res scale 0x4
pad(2)
pad(20)
shield panel background default color
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
shield panel background flashing color
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
shield panel background flash period f32
shield panel background flash delay f32
shield panel background number of flashes u16
shield panel background flash flags bitfield(16)
Flag Mask Comments
reverse default flashing colors 0x1
shield panel background flash length f32
shield panel background disabled color
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
pad(4)
shield panel background sequence index Index: u16
pad(2)
shield panel background multitex overlay Block?
Field Type Comments
pad(2)
type i16
framebuffer blend function enum
Option Value Comments
alpha blend 0x0
multiply 0x1
double multiply 0x2
add 0x3
subtract 0x4
component min 0x5
component max 0x6
alpha multiply add 0x7
pad(2)
pad(32)
primary anchor enum
Option Value Comments
top left 0x0
top right 0x1
bottom left 0x2
bottom right 0x3
center 0x4
secondary anchor enum
Option Value Comments
texture 0x0
screen 0x1
tertiary anchor enum
Option Value Comments
texture 0x0
screen 0x1
zero to one blend function enum
Option Value Comments
add 0x0
subtract 0x1
multiply 0x2
multiply2x 0x3
dot 0x4
one to two blend function enum
Option Value Comments
add 0x0
subtract 0x1
multiply 0x2
multiply2x 0x3
dot 0x4
pad(2)
primary scale
Point2D
  • x: f32
  • y: f32
secondary scale
Point2D
  • x: f32
  • y: f32
tertiary scale
Point2D
  • x: f32
  • y: f32
primary offset
Point2D
  • x: f32
  • y: f32
secondary offset
Point2D
  • x: f32
  • y: f32
tertiary offset
Point2D
  • x: f32
  • y: f32
primary wrap mode enum
Option Value Comments
clamp 0x0
wrap 0x1
secondary wrap mode enum
Option Value Comments
clamp 0x0
wrap 0x1
tertiary wrap mode enum
Option Value Comments
clamp 0x0
wrap 0x1
pad(2)
pad(184)
effectors Block?
Field Type Comments
pad(64)
destination type enum
Option Value Comments
tint 0 1 0x0
horizontal offset 0x1
vertical offset 0x2
fade 0 1 0x3
destination enum
Option Value Comments
geometry offset 0x0
primary map 0x1
secondary map 0x2
tertiary map 0x3
source enum
Option Value Comments
player pitch 0x0
player pitch tangent 0x1
player yaw 0x2
weapon ammo total 0x3
weapon ammo loaded 0x4
weapon heat 0x5
explicit uses low bound 0x6
weapon zoom level 0x7
pad(2)
in bounds f32 (source units) (min & max)
out bounds f32 (pixels) (min & max)
pad(64)
tint color lower bound
ColorRGB
  • red: f32
  • green: f32
  • blue: f32
tint color upper bound
ColorRGB
  • red: f32
  • green: f32
  • blue: f32
periodic function enum
Option Value Comments
one 0x0
zero 0x1
cosine 0x2
cosine variable period 0x3
diagonal wave 0x4
diagonal wave variable period 0x5
slide 0x6
slide variable period 0x7
noise 0x8
jitter 0x9
wander 0xa
spark 0xb
pad(2)
function period f32 (seconds)
function phase f32 (seconds)
pad(32)
pad(128)
pad(4)
shield panel meter anchor offset
Point2DInt
  • x: i16
  • y: i16
shield panel meter width scale f32
  • Default value: 1.
shield panel meter height scale f32
  • Default value: 1.
shield panel meter scaling flags bitfield(16)
Flag Mask Comments
don't scale offset 0x1
don't scale size 0x2
use high res scale 0x4
pad(2)
pad(20)
shield panel meter color at meter minimum
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
shield panel meter color at meter maximum
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
shield panel meter flash color
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
shield panel meter empty color
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
shield panel meter flags bitfield(8)
Flag Mask Comments
use min max for state changes 0x1
interpolate between min max flash colors as state changes 0x2
interpolate color along hsv space 0x4
more colors for hsv interpolation 0x8
invert interpolation 0x10
shield panel meter minimum meter value i8
shield panel meter sequence index Index: u16
shield panel meter alpha multiplier i8
shield panel meter alpha bias i8
shield panel meter value scale i16
shield panel meter opacity f32
shield panel meter translucency f32
shield panel meter disabled color
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
pad(16)
shield panel meter overcharge minimum color
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
shield panel meter overcharge maximum color
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
shield panel meter overcharge flash color
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
shield panel meter overcharge empty color
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
pad(16)
health panel background anchor offset
Point2DInt
  • x: i16
  • y: i16
health panel background width scale f32
  • Default value: 1.
health panel background height scale f32
  • Default value: 1.
health panel background scaling flags bitfield(16)
Flag Mask Comments
don't scale offset 0x1
don't scale size 0x2
use high res scale 0x4
pad(2)
pad(20)
health panel background default color
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
health panel background flashing color
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
health panel background flash period f32
health panel background flash delay f32
health panel background number of flashes u16
health panel background flash flags bitfield(16)
Flag Mask Comments
reverse default flashing colors 0x1
health panel background flash length f32
health panel background disabled color
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
pad(4)
health panel background sequence index Index: u16
pad(2)
health panel background multitex overlay Block?
Field Type Comments
pad(2)
type i16
framebuffer blend function enum
Option Value Comments
alpha blend 0x0
multiply 0x1
double multiply 0x2
add 0x3
subtract 0x4
component min 0x5
component max 0x6
alpha multiply add 0x7
pad(2)
pad(32)
primary anchor enum
Option Value Comments
top left 0x0
top right 0x1
bottom left 0x2
bottom right 0x3
center 0x4
secondary anchor enum
Option Value Comments
texture 0x0
screen 0x1
tertiary anchor enum
Option Value Comments
texture 0x0
screen 0x1
zero to one blend function enum
Option Value Comments
add 0x0
subtract 0x1
multiply 0x2
multiply2x 0x3
dot 0x4
one to two blend function enum
Option Value Comments
add 0x0
subtract 0x1
multiply 0x2
multiply2x 0x3
dot 0x4
pad(2)
primary scale
Point2D
  • x: f32
  • y: f32
secondary scale
Point2D
  • x: f32
  • y: f32
tertiary scale
Point2D
  • x: f32
  • y: f32
primary offset
Point2D
  • x: f32
  • y: f32
secondary offset
Point2D
  • x: f32
  • y: f32
tertiary offset
Point2D
  • x: f32
  • y: f32
primary wrap mode enum
Option Value Comments
clamp 0x0
wrap 0x1
secondary wrap mode enum
Option Value Comments
clamp 0x0
wrap 0x1
tertiary wrap mode enum
Option Value Comments
clamp 0x0
wrap 0x1
pad(2)
pad(184)
effectors Block?
Field Type Comments
pad(64)
destination type enum
Option Value Comments
tint 0 1 0x0
horizontal offset 0x1
vertical offset 0x2
fade 0 1 0x3
destination enum
Option Value Comments
geometry offset 0x0
primary map 0x1
secondary map 0x2
tertiary map 0x3
source enum
Option Value Comments
player pitch 0x0
player pitch tangent 0x1
player yaw 0x2
weapon ammo total 0x3
weapon ammo loaded 0x4
weapon heat 0x5
explicit uses low bound 0x6
weapon zoom level 0x7
pad(2)
in bounds f32 (source units) (min & max)
out bounds f32 (pixels) (min & max)
pad(64)
tint color lower bound
ColorRGB
  • red: f32
  • green: f32
  • blue: f32
tint color upper bound
ColorRGB
  • red: f32
  • green: f32
  • blue: f32
periodic function enum
Option Value Comments
one 0x0
zero 0x1
cosine 0x2
cosine variable period 0x3
diagonal wave 0x4
diagonal wave variable period 0x5
slide 0x6
slide variable period 0x7
noise 0x8
jitter 0x9
wander 0xa
spark 0xb
pad(2)
function period f32 (seconds)
function phase f32 (seconds)
pad(32)
pad(128)
pad(4)
health panel meter anchor offset
Point2DInt
  • x: i16
  • y: i16
health panel meter width scale f32
  • Default value: 1.
health panel meter height scale f32
  • Default value: 1.
health panel meter scaling flags bitfield(16)
Flag Mask Comments
don't scale offset 0x1
don't scale size 0x2
use high res scale 0x4
pad(2)
pad(20)
health panel meter color at meter minimum
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
health panel meter color at meter maximum
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
health panel meter flash color
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
health panel meter empty color
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
health panel meter flags bitfield(8)
Flag Mask Comments
use min max for state changes 0x1
interpolate between min max flash colors as state changes 0x2
interpolate color along hsv space 0x4
more colors for hsv interpolation 0x8
invert interpolation 0x10
health panel meter minimum meter value i8
health panel meter sequence index Index: u16
health panel meter alpha multiplier i8
health panel meter alpha bias i8
health panel meter value scale i16
health panel meter opacity f32
health panel meter translucency f32
health panel meter disabled color
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
pad(16)
health panel meter medium health left color
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
health panel meter max color health fraction cutoff f32
health panel meter min color health fraction cutoff f32
pad(20)
motion sensor background anchor offset
Point2DInt
  • x: i16
  • y: i16
motion sensor background width scale f32
  • Default value: 1.
motion sensor background height scale f32
  • Default value: 1.
motion sensor background scaling flags bitfield(16)
Flag Mask Comments
don't scale offset 0x1
don't scale size 0x2
use high res scale 0x4
pad(2)
pad(20)
motion sensor background default color
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
motion sensor background flashing color
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
motion sensor background flash period f32
motion sensor background flash delay f32
motion sensor background number of flashes u16
motion sensor background flash flags bitfield(16)
Flag Mask Comments
reverse default flashing colors 0x1
motion sensor background flash length f32
motion sensor background disabled color
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
pad(4)
motion sensor background sequence index Index: u16
pad(2)
motion sensor background multitex overlays Block?
Field Type Comments
pad(2)
type i16
framebuffer blend function enum
Option Value Comments
alpha blend 0x0
multiply 0x1
double multiply 0x2
add 0x3
subtract 0x4
component min 0x5
component max 0x6
alpha multiply add 0x7
pad(2)
pad(32)
primary anchor enum
Option Value Comments
top left 0x0
top right 0x1
bottom left 0x2
bottom right 0x3
center 0x4
secondary anchor enum
Option Value Comments
texture 0x0
screen 0x1
tertiary anchor enum
Option Value Comments
texture 0x0
screen 0x1
zero to one blend function enum
Option Value Comments
add 0x0
subtract 0x1
multiply 0x2
multiply2x 0x3
dot 0x4
one to two blend function enum
Option Value Comments
add 0x0
subtract 0x1
multiply 0x2
multiply2x 0x3
dot 0x4
pad(2)
primary scale
Point2D
  • x: f32
  • y: f32
secondary scale
Point2D
  • x: f32
  • y: f32
tertiary scale
Point2D
  • x: f32
  • y: f32
primary offset
Point2D
  • x: f32
  • y: f32
secondary offset
Point2D
  • x: f32
  • y: f32
tertiary offset
Point2D
  • x: f32
  • y: f32
primary wrap mode enum
Option Value Comments
clamp 0x0
wrap 0x1
secondary wrap mode enum
Option Value Comments
clamp 0x0
wrap 0x1
tertiary wrap mode enum
Option Value Comments
clamp 0x0
wrap 0x1
pad(2)
pad(184)
effectors Block?
Field Type Comments
pad(64)
destination type enum
Option Value Comments
tint 0 1 0x0
horizontal offset 0x1
vertical offset 0x2
fade 0 1 0x3
destination enum
Option Value Comments
geometry offset 0x0
primary map 0x1
secondary map 0x2
tertiary map 0x3
source enum
Option Value Comments
player pitch 0x0
player pitch tangent 0x1
player yaw 0x2
weapon ammo total 0x3
weapon ammo loaded 0x4
weapon heat 0x5
explicit uses low bound 0x6
weapon zoom level 0x7
pad(2)
in bounds f32 (source units) (min & max)
out bounds f32 (pixels) (min & max)
pad(64)
tint color lower bound
ColorRGB
  • red: f32
  • green: f32
  • blue: f32
tint color upper bound
ColorRGB
  • red: f32
  • green: f32
  • blue: f32
periodic function enum
Option Value Comments
one 0x0
zero 0x1
cosine 0x2
cosine variable period 0x3
diagonal wave 0x4
diagonal wave variable period 0x5
slide 0x6
slide variable period 0x7
noise 0x8
jitter 0x9
wander 0xa
spark 0xb
pad(2)
function period f32 (seconds)
function phase f32 (seconds)
pad(32)
pad(128)
pad(4)
motion sensor foreground anchor offset
Point2DInt
  • x: i16
  • y: i16
motion sensor foreground width scale f32
  • Default value: 1.
motion sensor foreground height scale f32
  • Default value: 1.
motion sensor foreground scaling flags bitfield(16)
Flag Mask Comments
don't scale offset 0x1
don't scale size 0x2
use high res scale 0x4
pad(2)
pad(20)
motion sensor foreground default color
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
motion sensor foreground flashing color
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
motion sensor foreground flash period f32
motion sensor foreground flash delay f32
motion sensor foreground number of flashes u16
motion sensor foreground flash flags bitfield(16)
Flag Mask Comments
reverse default flashing colors 0x1
motion sensor foreground flash length f32
motion sensor foreground disabled color
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
pad(4)
motion sensor foreground sequence index Index: u16
pad(2)
motion sensor foreground multitex overlays Block?
Field Type Comments
pad(2)
type i16
framebuffer blend function enum
Option Value Comments
alpha blend 0x0
multiply 0x1
double multiply 0x2
add 0x3
subtract 0x4
component min 0x5
component max 0x6
alpha multiply add 0x7
pad(2)
pad(32)
primary anchor enum
Option Value Comments
top left 0x0
top right 0x1
bottom left 0x2
bottom right 0x3
center 0x4
secondary anchor enum
Option Value Comments
texture 0x0
screen 0x1
tertiary anchor enum
Option Value Comments
texture 0x0
screen 0x1
zero to one blend function enum
Option Value Comments
add 0x0
subtract 0x1
multiply 0x2
multiply2x 0x3
dot 0x4
one to two blend function enum
Option Value Comments
add 0x0
subtract 0x1
multiply 0x2
multiply2x 0x3
dot 0x4
pad(2)
primary scale
Point2D
  • x: f32
  • y: f32
secondary scale
Point2D
  • x: f32
  • y: f32
tertiary scale
Point2D
  • x: f32
  • y: f32
primary offset
Point2D
  • x: f32
  • y: f32
secondary offset
Point2D
  • x: f32
  • y: f32
tertiary offset
Point2D
  • x: f32
  • y: f32
primary wrap mode enum
Option Value Comments
clamp 0x0
wrap 0x1
secondary wrap mode enum
Option Value Comments
clamp 0x0
wrap 0x1
tertiary wrap mode enum
Option Value Comments
clamp 0x0
wrap 0x1
pad(2)
pad(184)
effectors Block?
Field Type Comments
pad(64)
destination type enum
Option Value Comments
tint 0 1 0x0
horizontal offset 0x1
vertical offset 0x2
fade 0 1 0x3
destination enum
Option Value Comments
geometry offset 0x0
primary map 0x1
secondary map 0x2
tertiary map 0x3
source enum
Option Value Comments
player pitch 0x0
player pitch tangent 0x1
player yaw 0x2
weapon ammo total 0x3
weapon ammo loaded 0x4
weapon heat 0x5
explicit uses low bound 0x6
weapon zoom level 0x7
pad(2)
in bounds f32 (source units) (min & max)
out bounds f32 (pixels) (min & max)
pad(64)
tint color lower bound
ColorRGB
  • red: f32
  • green: f32
  • blue: f32
tint color upper bound
ColorRGB
  • red: f32
  • green: f32
  • blue: f32
periodic function enum
Option Value Comments
one 0x0
zero 0x1
cosine 0x2
cosine variable period 0x3
diagonal wave 0x4
diagonal wave variable period 0x5
slide 0x6
slide variable period 0x7
noise 0x8
jitter 0x9
wander 0xa
spark 0xb
pad(2)
function period f32 (seconds)
function phase f32 (seconds)
pad(32)
pad(128)
pad(4)
pad(32)
motion sensor center anchor offset
Point2DInt
  • x: i16
  • y: i16
motion sensor center width scale f32
  • Default value: 1.
motion sensor center height scale f32
  • Default value: 1.
motion sensor center scaling flags bitfield(16)
Flag Mask Comments
don't scale offset 0x1
don't scale size 0x2
use high res scale 0x4
pad(2)
pad(20)
auxiliary overlay anchor enum
Option Value Comments
top left 0x0
top right 0x1
bottom left 0x2
bottom right 0x3
center 0x4
pad(2)
pad(32)
overlays Block?
Field Type Comments
anchor offset
Point2DInt
  • x: i16
  • y: i16
width scale f32
  • Default value: 1.
height scale f32
  • Default value: 1.
scaling flags bitfield(16)
Flag Mask Comments
don't scale offset 0x1
don't scale size 0x2
use high res scale 0x4
pad(2)
pad(20)
default color
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
flashing color
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
flash period f32
flash delay f32
number of flashes u16
flash flags bitfield(16)
Flag Mask Comments
reverse default flashing colors 0x1
flash length f32
disabled color
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
pad(4)
sequence index Index: u16
pad(2)
multitex overlay Block?
Field Type Comments
pad(2)
type i16
framebuffer blend function enum
Option Value Comments
alpha blend 0x0
multiply 0x1
double multiply 0x2
add 0x3
subtract 0x4
component min 0x5
component max 0x6
alpha multiply add 0x7
pad(2)
pad(32)
primary anchor enum
Option Value Comments
top left 0x0
top right 0x1
bottom left 0x2
bottom right 0x3
center 0x4
secondary anchor enum
Option Value Comments
texture 0x0
screen 0x1
tertiary anchor enum
Option Value Comments
texture 0x0
screen 0x1
zero to one blend function enum
Option Value Comments
add 0x0
subtract 0x1
multiply 0x2
multiply2x 0x3
dot 0x4
one to two blend function enum
Option Value Comments
add 0x0
subtract 0x1
multiply 0x2
multiply2x 0x3
dot 0x4
pad(2)
primary scale
Point2D
  • x: f32
  • y: f32
secondary scale
Point2D
  • x: f32
  • y: f32
tertiary scale
Point2D
  • x: f32
  • y: f32
primary offset
Point2D
  • x: f32
  • y: f32
secondary offset
Point2D
  • x: f32
  • y: f32
tertiary offset
Point2D
  • x: f32
  • y: f32
primary wrap mode enum
Option Value Comments
clamp 0x0
wrap 0x1
secondary wrap mode enum
Option Value Comments
clamp 0x0
wrap 0x1
tertiary wrap mode enum
Option Value Comments
clamp 0x0
wrap 0x1
pad(2)
pad(184)
effectors Block?
Field Type Comments
pad(64)
destination type enum
Option Value Comments
tint 0 1 0x0
horizontal offset 0x1
vertical offset 0x2
fade 0 1 0x3
destination enum
Option Value Comments
geometry offset 0x0
primary map 0x1
secondary map 0x2
tertiary map 0x3
source enum
Option Value Comments
player pitch 0x0
player pitch tangent 0x1
player yaw 0x2
weapon ammo total 0x3
weapon ammo loaded 0x4
weapon heat 0x5
explicit uses low bound 0x6
weapon zoom level 0x7
pad(2)
in bounds f32 (source units) (min & max)
out bounds f32 (pixels) (min & max)
pad(64)
tint color lower bound
ColorRGB
  • red: f32
  • green: f32
  • blue: f32
tint color upper bound
ColorRGB
  • red: f32
  • green: f32
  • blue: f32
periodic function enum
Option Value Comments
one 0x0
zero 0x1
cosine 0x2
cosine variable period 0x3
diagonal wave 0x4
diagonal wave variable period 0x5
slide 0x6
slide variable period 0x7
noise 0x8
jitter 0x9
wander 0xa
spark 0xb
pad(2)
function period f32 (seconds)
function phase f32 (seconds)
pad(32)
pad(128)
pad(4)
type enum
Option Value Comments
integrated light 0x0
flags bitfield(16)
Flag Mask Comments
use team color 0x1
pad(24)
pad(16)
sounds Block?
Field Type Comments
latched to bitfield(32)
Flag Mask Comments
shield recharging 0x1
shield damaged 0x2
shield low 0x4
shield empty 0x8
health low 0x10
health empty 0x20
health minor damage 0x40
health major damage 0x80
scale f32
pad(32)
meters Block?
Field Type Comments
type enum
Option Value Comments
integrated light 0x0
pad(2)
pad(16)
background anchor offset
Point2DInt
  • x: i16
  • y: i16
background width scale f32
  • Default value: 1.
background height scale f32
  • Default value: 1.
background scaling flags bitfield(16)
Flag Mask Comments
don't scale offset 0x1
don't scale size 0x2
use high res scale 0x4
pad(2)
pad(20)
background default color
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
background flashing color
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
background flash period f32
background flash delay f32
background number of flashes u16
background flash flags bitfield(16)
Flag Mask Comments
reverse default flashing colors 0x1
background flash length f32
background disabled color
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
pad(4)
background sequence index Index: u16
pad(2)
background multitex overlay Block?
Field Type Comments
pad(2)
type i16
framebuffer blend function enum
Option Value Comments
alpha blend 0x0
multiply 0x1
double multiply 0x2
add 0x3
subtract 0x4
component min 0x5
component max 0x6
alpha multiply add 0x7
pad(2)
pad(32)
primary anchor enum
Option Value Comments
top left 0x0
top right 0x1
bottom left 0x2
bottom right 0x3
center 0x4
secondary anchor enum
Option Value Comments
texture 0x0
screen 0x1
tertiary anchor enum
Option Value Comments
texture 0x0
screen 0x1
zero to one blend function enum
Option Value Comments
add 0x0
subtract 0x1
multiply 0x2
multiply2x 0x3
dot 0x4
one to two blend function enum
Option Value Comments
add 0x0
subtract 0x1
multiply 0x2
multiply2x 0x3
dot 0x4
pad(2)
primary scale
Point2D
  • x: f32
  • y: f32
secondary scale
Point2D
  • x: f32
  • y: f32
tertiary scale
Point2D
  • x: f32
  • y: f32
primary offset
Point2D
  • x: f32
  • y: f32
secondary offset
Point2D
  • x: f32
  • y: f32
tertiary offset
Point2D
  • x: f32
  • y: f32
primary wrap mode enum
Option Value Comments
clamp 0x0
wrap 0x1
secondary wrap mode enum
Option Value Comments
clamp 0x0
wrap 0x1
tertiary wrap mode enum
Option Value Comments
clamp 0x0
wrap 0x1
pad(2)
pad(184)
effectors Block?
Field Type Comments
pad(64)
destination type enum
Option Value Comments
tint 0 1 0x0
horizontal offset 0x1
vertical offset 0x2
fade 0 1 0x3
destination enum
Option Value Comments
geometry offset 0x0
primary map 0x1
secondary map 0x2
tertiary map 0x3
source enum
Option Value Comments
player pitch 0x0
player pitch tangent 0x1
player yaw 0x2
weapon ammo total 0x3
weapon ammo loaded 0x4
weapon heat 0x5
explicit uses low bound 0x6
weapon zoom level 0x7
pad(2)
in bounds f32 (source units) (min & max)
out bounds f32 (pixels) (min & max)
pad(64)
tint color lower bound
ColorRGB
  • red: f32
  • green: f32
  • blue: f32
tint color upper bound
ColorRGB
  • red: f32
  • green: f32
  • blue: f32
periodic function enum
Option Value Comments
one 0x0
zero 0x1
cosine 0x2
cosine variable period 0x3
diagonal wave 0x4
diagonal wave variable period 0x5
slide 0x6
slide variable period 0x7
noise 0x8
jitter 0x9
wander 0xa
spark 0xb
pad(2)
function period f32 (seconds)
function phase f32 (seconds)
pad(32)
pad(128)
pad(4)
meter anchor offset
Point2DInt
  • x: i16
  • y: i16
meter width scale f32
  • Default value: 1.
meter height scale f32
  • Default value: 1.
meter scaling flags bitfield(16)
Flag Mask Comments
don't scale offset 0x1
don't scale size 0x2
use high res scale 0x4
pad(2)
pad(20)
meter color at meter minimum
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
meter color at meter maximum
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
meter flash color
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
meter empty color
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
meter flags bitfield(8)
Flag Mask Comments
use min max for state changes 0x1
interpolate between min max flash colors as state changes 0x2
interpolate color along hsv space 0x4
more colors for hsv interpolation 0x8
invert interpolation 0x10
meter minimum meter value i8
meter sequence index Index: u16
meter alpha multiplier i8
meter alpha bias i8
meter value scale i16
meter opacity f32
meter translucency f32
meter disabled color
ColorARGBInt
  • alpha: u8
  • red: u8
  • green: u8
  • blue: u8
pad(16)
meter minimum fraction cutoff f32
meter more flags bitfield(32)
Flag Mask Comments
show only when active 0x1
flash once if activated while disabled 0x2
pad(24)
pad(64)
pad(356)
pad(48)

This information was partially generated using Invader tag definitions.

Acknowledgements

Thanks to the following individuals for their research or contributions to this topic:

  • Kavawuvi (Invader tag definitions)
  • MosesOfEgypt (Tag structure research)