hud
/datum/hud

Vars
always_visible_inventory	Screen objects that never exit view.
combo_display	Displays a HUD element that indicates the current combo, as well as what has been inputted so far.
current_plane_offset	Think of multiz as a stack of z levels. Each index in that stack has its own group of plane masters This variable is the plane offset our mob/client is currently "on" We use it to track what we should show/not show Goes from 0 to the max (z level stack size - 1)
hotkey_ui_hidden	This is to hide the buttons that can be used via hotkeys. (hotkeybuttons list of buttons)
hud_shown	Used for the HUD toggle (F12)
hud_version	the hud version used (standard, reduced, none)
inventory_shown	the inventory
last_byond_version	The BYOND version of the client that was last logged into this mob. Currently used to rebuild all plane master groups when going between 515<->516.
master_groups	Assoc list of key => "plane master groups" This is normally just the main window, but it'll occasionally contain things like spyglasses windows
plane_master_controllers	Assoc list of controller groups, associated with key string group name with value of the plane master controller ref
Procs
add_ammo_hud	Add an ammo hud to the user informing of the ammo count of ammo_owner
build_plane_groups	Creates the required plane masters to fill out new z layers (because each "level" of multiz gets its own plane master set)
get_plane_group	Returns the corresponding plane group datum if one exists
get_plane_master	Returns the plane master that matches the input plane from the passed in group
get_planes_from	Returns all the planes belonging to the passed in group key
get_true_plane_masters	Returns a list of all plane masters that match the input true plane, drawn from the passed in group (ignores z layer offsets)
remove_ammo_hud	Remove the ammo hud related to the gun G from the user
update_ammo_hud	Update the ammo hud related to the gun G
update_interactive_emotes	Update the hud; taken from how alerts do it, but slimmed down

Var Details

var
always_visible_inventory
– /list

Screen objects that never exit view.

var
combo_display
– /atom/movable/screen/combo

Displays a HUD element that indicates the current combo, as well as what has been inputted so far.

var
current_plane_offset
–

Think of multiz as a stack of z levels. Each index in that stack has its own group of plane masters This variable is the plane offset our mob/client is currently "on" We use it to track what we should show/not show Goes from 0 to the max (z level stack size - 1)

var
hotkey_ui_hidden
–

This is to hide the buttons that can be used via hotkeys. (hotkeybuttons list of buttons)

var
hud_shown
–

Used for the HUD toggle (F12)

var
hud_version
–

the hud version used (standard, reduced, none)

var
inventory_shown
–

the inventory

var
last_byond_version
–

The BYOND version of the client that was last logged into this mob. Currently used to rebuild all plane master groups when going between 515<->516.

var
master_groups
– /list/datum/plane_master_group

Assoc list of key => "plane master groups" This is normally just the main window, but it'll occasionally contain things like spyglasses windows

var
plane_master_controllers
– /list/atom/movable/plane_master_controller

Assoc list of controller groups, associated with key string group name with value of the plane master controller ref

Proc Details

proc
add_ammo_hud
(/datum/ammo_owner, /list/ammo_type, ammo_count)

Add an ammo hud to the user informing of the ammo count of ammo_owner

proc
build_plane_groups
(starting_offset, ending_offset)

Creates the required plane masters to fill out new z layers (because each "level" of multiz gets its own plane master set)

proc
get_plane_group
(key)

Returns the corresponding plane group datum if one exists

proc
get_plane_master
(plane, group_key)

Returns the plane master that matches the input plane from the passed in group

proc
get_planes_from
(group_key)

Returns all the planes belonging to the passed in group key

proc
get_true_plane_masters
(true_plane, group_key)

Returns a list of all plane masters that match the input true plane, drawn from the passed in group (ignores z layer offsets)

proc
remove_ammo_hud
(/datum/ammo_owner)

Remove the ammo hud related to the gun G from the user

proc
update_ammo_hud
(/datum/ammo_owner, /list/ammo_type, ammo_count)

Update the ammo hud related to the gun G

proc
update_interactive_emotes
()

Update the hud; taken from how alerts do it, but slimmed down

hud /datum/hud

Vars

Procs

Var Details

var always_visible_inventory – /list

var combo_display – /atom/movable/screen/combo

var current_plane_offset –

var hotkey_ui_hidden –

var hud_shown –

var hud_version –

var inventory_shown –

var last_byond_version –

var master_groups – /list/datum/plane_master_group

var plane_master_controllers – /list/atom/movable/plane_master_controller