ui_widget_definition

🚧 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
widget type enum
Option Value Comments
container 0x0
text box 0x1
spinner list 0x2
column list 0x3
game model not implemented 0x4
movie not implemented 0x5
custom not implemented 0x6
controller index enum
Option Value Comments
player 1 0x0
player 2 0x1
player 3 0x2
player 4 0x3
any player 0x4
name char[32]
bounds
Rectangle2D
  • top: i16
  • left: i16
  • bottom: i16
  • right: i16
flags bitfield(32)
Flag Mask Comments
pass unhandled events to focused child 0x1
pause game time 0x2
flash background bitmap 0x4
dpad up down tabs thru children 0x8
dpad left right tabs thru children 0x10
dpad up down tabs thru list items 0x20
dpad left right tabs thru list items 0x40
dont focus a specific child widget 0x80
pass unhandled events to all children 0x100
render regardless of controller index 0x200
pass handled events to all children 0x400
return to main menu if no history 0x800
always use tag controller index 0x1000
always use nifty render fx 0x2000
don't push history 0x4000
force handle mouse 0x8000
milliseconds to auto close u32
milliseconds auto close fade time u32
game data inputs Block?
Field Type Comments
function enum
Option Value Comments
null 0x0
player settings menu update desc 0x1
unused 0x2
playlist settings menu update desc 0x3
gametype select menu update desc 0x4
multiplayer type menu update desc 0x5
solo level select update 0x6
difficulty menu update desc 0x7
build number textbox only 0x8
server list update 0x9
network pregame status update 0xa
splitscreen pregame status update 0xb
net splitscreen prejoin players 0xc
mp profile list update 0xd
3wide player profile list update 0xe
plyr prof edit select menu upd8 0xf
player profile small menu update 0x10
game settings lists text update 0x11
solo game objective text 0x12
color picker update 0x13
game settings lists pic update 0x14
main menu fake animate 0x15
mp level select update 0x16
get active plyr profile name 0x17
get edit plyr profile name 0x18
get edit game settings name 0x19
get active plyr profile color 0x1a
mp set textbox map name 0x1b
mp set textbox game ruleset 0x1c
mp set textbox teams noteams 0x1d
mp set textbox score limit 0x1e
mp set textbox score limit type 0x1f
mp set bitmap for map 0x20
mp set bitmap for ruleset 0x21
mp set textbox 0x22
mp edit profile set rule text 0x23
system link status check 0x24
mp game directions 0x25
teams no teams bitmap update 0x26
warn if diff will nuke saved game 0x27
dim if no net cable 0x28
pause game set textbox inverted 0x29
dim unless two controllers 0x2a
controls update menu 0x2b
video menu update 0x2c
gamespy screen update 0x2d
common button bar update 0x2e
gamepad update menu 0x2f
server settings update 0x30
audio menu update 0x31
mp prof vehicles update 0x32
solo map list update 0x33
mp map list update 0x34
gt select list update 0x35
gt edit list update 0x36
load game list update 0x37
checking for updates 0x38
direct ip connect update 0x39
network settings update 0x3a
pad(2)
pad(32)
event handlers Block?
Field Type Comments
flags bitfield(32)
Flag Mask Comments
close current widget 0x1
close other widget 0x2
close all widgets 0x4
open widget 0x8
reload self 0x10
reload other widget 0x20
give focus to widget 0x40
run function 0x80
replace self w widget 0x100
go back to previous widget 0x200
run scenario script 0x400
try to branch on failure 0x800
event type enum
Option Value Comments
a button 0x0
b button 0x1
x button 0x2
y button 0x3
black button 0x4
white button 0x5
left trigger 0x6
right trigger 0x7
dpad up 0x8
dpad down 0x9
dpad left 0xa
dpad right 0xb
start button 0xc
back button 0xd
left thumb 0xe
right thumb 0xf
left analog stick up 0x10
left analog stick down 0x11
left analog stick left 0x12
left analog stick right 0x13
left analog stick up 1 0x14
right analog stick down 0x15
right analog stick left 0x16
right analog stick right 0x17
created 0x18
deleted 0x19
get focus 0x1a
lose focus 0x1b
left mouse 0x1c
middle mouse 0x1d
right mouse 0x1e
double click 0x1f
custom activation 0x20
post render 0x21
function enum
Option Value Comments
null 0x0
list goto next item 0x1
list goto previous item 0x2
unused 0x3
unused 1 0x4
initialize sp level list solo 0x5
initialize sp level list coop 0x6
dispose sp level list 0x7
solo level set map 0x8
set difficulty 0x9
start new game 0xa
pause game restart at checkpoint 0xb
pause game restart level 0xc
pause game return to main menu 0xd
clear multiplayer player joins 0xe
join controller to mp game 0xf
initialize net game server list 0x10
start network game server 0x11
dispose net game server list 0x12
shutdown network game 0x13
net game join from server list 0x14
split screen game initialize 0x15
coop game initialize 0x16
main menu intialize 0x17
mp type menu initialize 0x18
pick play stage for quick start 0x19
mp level list initialize 0x1a
mp level list dispose 0x1b
mp level select 0x1c
mp profiles list initialize 0x1d
mp profiles list dispose 0x1e
mp profile set for game 0x1f
swap player team 0x20
net game join player 0x21
player profile list initialize 0x22
player profile list dispose 0x23
3wide plyr prof set for game 0x24
1wide plyr prof set for game 0x25
mp profile begin editing 0x26
mp profile end editing 0x27
mp profile set game engine 0x28
mp profile change name 0x29
mp profile set ctf rules 0x2a
mp profile set koth rules 0x2b
mp profile set slayer rules 0x2c
mp profile set oddball rules 0x2d
mp profile set racing rules 0x2e
mp profile set player options 0x2f
mp profile set item options 0x30
mp profile set indicator opts 0x31
mp profile init game engine 0x32
mp profile init name 0x33
mp profile init ctf rules 0x34
mp profile init koth rules 0x35
mp profile init slayer rules 0x36
mp profile init oddball rules 0x37
mp profile init racing rules 0x38
mp profile init player opts 0x39
mp profile init item options 0x3a
mp profile init indicator opts 0x3b
mp profile save changes 0x3c
color picker menu initialize 0x3d
color picker menu dispose 0x3e
color picker select color 0x3f
player profile begin editing 0x40
player profile end editing 0x41
player profile change name 0x42
player profile save changes 0x43
plyr prf init cntl settings 0x44
plyr prf init adv cntl set 0x45
plyr prf save cntl settings 0x46
plyr prf save adv cntl set 0x47
mp game player quit 0x48
main menu switch to solo game 0x49
request del player profile 0x4a
request del playlist profile 0x4b
final del player profile 0x4c
final del playlist profile 0x4d
cancel profile delete 0x4e
create edit playlist profile 0x4f
create edit player profile 0x50
net game speed start 0x51
net game delay start 0x52
net server accept conx 0x53
net server defer start 0x54
net server allow start 0x55
disable if no xdemos 0x56
run xdemos 0x57
sp reset controller choices 0x58
sp set p1 controller choice 0x59
sp set p2 controller choice 0x5a
error if no network connection 0x5b
start server if none advertised 0x5c
net game unjoin player 0x5d
close if not editing profile 0x5e
exit to xbox dashboard 0x5f
new campaign chosen 0x60
new campaign decision 0x61
pop history stack once 0x62
difficulty menu init 0x63
begin music fade out 0x64
new game if no plyr profiles 0x65
exit gracefully to xbox dashboard 0x66
pause game invert pitch 0x67
start new coop game 0x68
pause game invert spinner get 0x69
pause game invert spinner set 0x6a
main menu quit game 0x6b
mouse emit accept event 0x6c
mouse emit back event 0x6d
mouse emit dpad left event 0x6e
mouse emit dpad right event 0x6f
mouse spinner 3wide click 0x70
controls screen init 0x71
video screen init 0x72
controls begin binding 0x73
gamespy screen init 0x74
gamespy screen dispose 0x75
gamespy select header 0x76
gamespy select item 0x77
gamespy select button 0x78
plr prof init mouse set 0x79
plr prof change mouse set 0x7a
plr prof init audio set 0x7b
plr prof change audio set 0x7c
plr prof change video set 0x7d
controls screen dispose 0x7e
controls screen change set 0x7f
mouse emit x event 0x80
gamepad screen init 0x81
gamepad screen dispose 0x82
gamepad screen change gamepads 0x83
gamepad screen select item 0x84
mouse screen defaults 0x85
audio screen defaults 0x86
video screen defaults 0x87
controls screen defaults 0x88
profile set edit begin 0x89
profile manager delete 0x8a
profile manager select 0x8b
gamespy dismiss error 0x8c
server settings init 0x8d
ss edit server name 0x8e
ss edit server password 0x8f
ss start game 0x90
video test dialog init 0x91
video test dialog dispose 0x92
video test dialog accept 0x93
gamespy dismiss filters 0x94
gamespy update filter settings 0x95
gamespy back handler 0x96
mouse spinner 1wide click 0x97
controls back handler 0x98
controls advanced launch 0x99
controls advanced ok 0x9a
mp pause menu open 0x9b
mp game options open 0x9c
mp choose team 0x9d
mp prof init vehicle options 0x9e
mp prof save vehicle options 0x9f
single prev cl item activated 0xa0
mp prof init teamplay options 0xa1
mp prof save teamplay options 0xa2
mp game options choose 0xa3
emit custom activation event 0xa4
plr prof cancel audio set 0xa5
plr prof init network options 0xa6
plr prof save network options 0xa7
credits post render 0xa8
difficulty item select 0xa9
credits initialize 0xaa
credits dispose 0xab
gamespy get patch 0xac
video screen dispose 0xad
campaign menu init 0xae
campaign menu continue 0xaf
load game menu init 0xb0
load game menu dispose 0xb1
load game menu activated 0xb2
solo menu save checkpoint 0xb3
mp type set mode 0xb4
checking for updates ok 0xb5
checking for updates dismiss 0xb6
direct ip connect init 0xb7
direct ip connect go 0xb8
direct ip edit field 0xb9
network settings edit a port 0xba
network settings defaults 0xbb
load game menu delete request 0xbc
load game menu delete finish 0xbd
script char[32]
search and replace functions Block?
Field Type Comments
search string char[32]
replace function enum
Option Value Comments
null 0x0
widget s controller 0x1
build number 0x2
pid 0x3
pad(128)
text color
ColorARGB
  • alpha: f32
  • red: f32
  • green: f32
  • blue: f32
justification enum
Option Value Comments
left justify 0x0
right justify 0x1
center justify 0x2
flags 1 bitfield(32)
Flag Mask Comments
editable 0x1
password 0x2
flashing 0x4
don't do that weird focus test 0x8
pad(12)
string list index Index: u16
horiz offset i16
vert offset i16
pad(26)
pad(2)
flags 2 bitfield(32)
Flag Mask Comments
list items generated in code 0x1
list items from string list tag 0x2
list items only one tooltip 0x4
list single preview no scroll 0x8
header bounds
Rectangle2D
  • top: i16
  • left: i16
  • bottom: i16
  • right: i16
footer bounds
Rectangle2D
  • top: i16
  • left: i16
  • bottom: i16
  • right: i16
pad(32)
pad(32)
pad(256)
conditional widgets Block?
Field Type Comments
name char[32]
flags bitfield(32)
Flag Mask Comments
load if event handler function fails 0x1
custom controller index Index: u16
pad(26)
pad(128)
pad(128)
child widgets Block?
Field Type Comments
name char[32]
flags bitfield(32)
Flag Mask Comments
use custom controller index 0x1
custom controller index Index: u16
vertical offset i16
horizontal offset i16
pad(22)

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)