/datum/hud

Vars
always_visible_inventory	Screen objects that never exit view.
atmos_debug_overlays	If this client is being shown atmos debug overlays or not
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)
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
screentip_color	The color to use for the screentips. This is updated by the preference for cheaper reads than would be had with a proc call, especially on one of the hottest procs in the game (MouseEntered).
screentip_images	Whether to use text or images for click hints. Same behavior as `screentips_enabled`--very hot, updated when the preference is updated.
screentip_text	UI for screentips that appear when you mouse over things
screentips_enabled	Whether or not screentips are enabled. This is updated by the preference for cheaper reads than would be had with a proc call, especially on one of the hottest procs in the game (MouseEntered).
Procs
build_action_groups	Generates and fills new action groups with our mob's current actions
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)
generate_landings	Generates visual landings for all groups that the button is not a memeber of
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)
hide_action	Removes the passed in action from its current position on the screen
hide_landings	Clears all currently visible landings
show_hud	Shows this hud's hud to some mob
view_audit_buttons	Ensures all of our buttons are properly within the bounds of our client's view, moves them if they're not

Var Details

var
always_visible_inventory
– /list

Screen objects that never exit view.

var
atmos_debug_overlays
–

If this client is being shown atmos debug overlays or not

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
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

var
screentip_color
–

The color to use for the screentips. This is updated by the preference for cheaper reads than would be had with a proc call, especially on one of the hottest procs in the game (MouseEntered).

var
screentip_images
–

Whether to use text or images for click hints. Same behavior as screentips_enabled--very hot, updated when the preference is updated.

var
screentip_text
– /atom/movable/screen/screentip

UI for screentips that appear when you mouse over things

var
screentips_enabled
–

Whether or not screentips are enabled. This is updated by the preference for cheaper reads than would be had with a proc call, especially on one of the hottest procs in the game (MouseEntered).

Proc Details

proc
build_action_groups
()

Generates and fills new action groups with our mob's current actions

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
generate_landings
(/atom/movable/screen/movable/action_button/button)

Generates visual landings for all groups that the button is not a memeber of

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
hide_action
(/atom/movable/screen/movable/action_button/button)

Removes the passed in action from its current position on the screen

proc
hide_landings
()

Clears all currently visible landings

proc
show_hud
(version, /mob/viewmob)

Shows this hud's hud to some mob

Arguments

version - denotes which style should be displayed. blank or 0 means "next version"
viewmob - what mob to show the hud to. Can be this hud's mob, can be another mob, can be null (will use this hud's mob if so)

proc
view_audit_buttons
()

Ensures all of our buttons are properly within the bounds of our client's view, moves them if they're not

/datum/hud

Vars

Procs

Var Details

var always_visible_inventory – /list

var atmos_debug_overlays –

var current_plane_offset –

var last_byond_version –

var master_groups – /list/datum/plane_master_group

var plane_master_controllers – /list/atom/movable/plane_master_controller

var screentip_color –

var screentip_images –

var screentip_text – /atom/movable/screen/screentip

var screentips_enabled –

Proc Details

proc build_action_groups()

proc build_plane_groups(starting_offset, ending_offset)

proc generate_landings(/atom/movable/screen/movable/action_button/button)

proc get_plane_group(key)

proc get_plane_master(plane, group_key)

proc get_planes_from(group_key)

proc get_true_plane_masters(true_plane, group_key)

proc hide_action(/atom/movable/screen/movable/action_button/button)

proc hide_landings()

proc show_hud(version, /mob/viewmob)

proc view_audit_buttons()