atom_hud

Vars
hud_atoms	associative list of the form: list(z level = list(hud atom)). tracks what hud atoms for this hud exists in what z level so we can only give users the hud images that they can actually see.
hud_atoms_all_z_levels	used for signal tracking purposes, associative list of the form: list(hud atom = TRUE) that isn't separated by z level
hud_exceptions	huduser = list(atoms with their hud hidden) - aka everyone hates targeted invisibility
hud_icons	these will be the indexes for the atom's hud_list
hud_users	associative list of the form: list(z level = list(hud user client mobs)). tracks mobs that can "see" us
hud_users_all_z_levels	used for signal tracking purposes, associative list of the form: list(hud user = number of times this hud was added to this user). that isn't separated by z level
next_time_allowed	mobs associated with the next time this hud can be added to them
queued_to_see	mobs that have triggered the cooldown and are queued to see the hud, but do not yet
uses_global_hud_category	whether or not this atom_hud type updates the global huds_by_category list. some subtypes can't work like this since they're supposed to "belong" to one target atom each. it will still go in the other global hud lists.
Procs
add_all_atoms_to_single_mob_hud	all passed in hud_atoms's hud images (that are part of this atom_hud) to requesting_mob's client.images list optimization of /datum/atom_hud/proc/add_atom_to_single_mob_hud for hot cases, we assert that no nulls will be passed in via the list
add_atom_to_all_mob_huds	add just hud_atom's hud images (that are part of this atom_hud) to all the requesting_mobs's client.images list optimization of /datum/atom_hud/proc/add_atom_to_single_mob_hud for hot cases, we assert that no nulls will be passed in via the list
add_atom_to_hud	add new_hud_atom to this hud
add_atom_to_single_mob_hud	add just hud_atom's hud images (that are part of this atom_hud) to requesting_mob's client.images list
add_single_hud_category_on_atom	adds a newly active hud category's image on a hud atom to every mob that could see it
get_hud_atoms_for_z_level	returns a list of all hud atoms in the given z level and linked lower z levels (because hud users in higher z levels can see below)
get_hud_users_for_z_level	returns a list of all hud users in the given z level and linked upper z levels (because hud users in higher z levels can see below)
hide_from	Hides the images in this hud from former_viewer If absolute is set to true, this will forcefully remove the hud, even if sources in theory remain
on_atom_or_user_z_level_changed	when a hud atom or hud user changes z levels this makes sure it gets the images it needs and removes the images it doesn't need. because of how signals work we need the same proc to handle both use cases because being a hud atom and being a hud user aren't mutually exclusive
remove_all_atoms_from_single_hud	remove every hud image for this hud pulled from atoms_to_remove from client_mob's client.images list optimization of /datum/atom_hud/proc/remove_atom_from_single_hud for hot cases, we assert that no nulls will be passed in via the list
remove_atom_from_all_huds	remove every hud image for this hud on atom_to_remove from client_mobs's client.images list optimization of /datum/atom_hud/proc/remove_atom_from_single_hud for hot cases, we assert that no nulls will be passed in via the list
remove_atom_from_hud	remove this atom from this hud completely
remove_atom_from_single_hud	remove every hud image for this hud on atom_to_remove from client_mob's client.images list
remove_single_hud_category_on_atom	removes the image or images in hud_atom.hud_list[hud_category_to_remove] from every mob that can see it but leaves every other image from that atom there.
show_to	show this hud to the passed in user

Var Details

var
hud_atoms
– /list/atom

associative list of the form: list(z level = list(hud atom)). tracks what hud atoms for this hud exists in what z level so we can only give users the hud images that they can actually see.

var
hud_atoms_all_z_levels
– /list/atom

used for signal tracking purposes, associative list of the form: list(hud atom = TRUE) that isn't separated by z level

var
hud_exceptions
– /list

huduser = list(atoms with their hud hidden) - aka everyone hates targeted invisibility

var
hud_icons
– /list

these will be the indexes for the atom's hud_list

var
hud_users
– /list

associative list of the form: list(z level = list(hud user client mobs)). tracks mobs that can "see" us

var
hud_users_all_z_levels
– /list/mob

used for signal tracking purposes, associative list of the form: list(hud user = number of times this hud was added to this user). that isn't separated by z level

var
next_time_allowed
– /list

mobs associated with the next time this hud can be added to them

var
queued_to_see
– /list

mobs that have triggered the cooldown and are queued to see the hud, but do not yet

var
uses_global_hud_category
–

whether or not this atom_hud type updates the global huds_by_category list. some subtypes can't work like this since they're supposed to "belong" to one target atom each. it will still go in the other global hud lists.

Proc Details

proc
add_all_atoms_to_single_mob_hud
(/mob/requesting_mob, /list/atom/hud_atoms)

all passed in hud_atoms's hud images (that are part of this atom_hud) to requesting_mob's client.images list optimization of /datum/atom_hud/proc/add_atom_to_single_mob_hud for hot cases, we assert that no nulls will be passed in via the list

proc
add_atom_to_all_mob_huds
(/list/mob/requesting_mobs, /atom/hud_atom)

add just hud_atom's hud images (that are part of this atom_hud) to all the requesting_mobs's client.images list optimization of /datum/atom_hud/proc/add_atom_to_single_mob_hud for hot cases, we assert that no nulls will be passed in via the list

proc
add_atom_to_hud
(/atom/new_hud_atom)

add new_hud_atom to this hud

proc
add_atom_to_single_mob_hud
(/mob/requesting_mob, /atom/hud_atom)

add just hud_atom's hud images (that are part of this atom_hud) to requesting_mob's client.images list

proc
add_single_hud_category_on_atom
(/atom/hud_atom, hud_category_to_add)

adds a newly active hud category's image on a hud atom to every mob that could see it

proc
get_hud_atoms_for_z_level
(z_level)

returns a list of all hud atoms in the given z level and linked lower z levels (because hud users in higher z levels can see below)

proc
get_hud_users_for_z_level
(z_level)

returns a list of all hud users in the given z level and linked upper z levels (because hud users in higher z levels can see below)

proc
hide_from
(/mob/former_viewer, absolute)

Hides the images in this hud from former_viewer If absolute is set to true, this will forcefully remove the hud, even if sources in theory remain

proc
on_atom_or_user_z_level_changed
(/atom/movable/moved_atom, /turf/old_turf, /turf/new_turf)

when a hud atom or hud user changes z levels this makes sure it gets the images it needs and removes the images it doesn't need. because of how signals work we need the same proc to handle both use cases because being a hud atom and being a hud user aren't mutually exclusive

proc
remove_all_atoms_from_single_hud
(/mob/client_mob, /list/atom/atoms_to_remove)

remove every hud image for this hud pulled from atoms_to_remove from client_mob's client.images list optimization of /datum/atom_hud/proc/remove_atom_from_single_hud for hot cases, we assert that no nulls will be passed in via the list

proc
remove_atom_from_all_huds
(/list/mob/client_mobs, /atom/atom_to_remove)

remove every hud image for this hud on atom_to_remove from client_mobs's client.images list optimization of /datum/atom_hud/proc/remove_atom_from_single_hud for hot cases, we assert that no nulls will be passed in via the list

proc
remove_atom_from_hud
(/atom/hud_atom_to_remove)

remove this atom from this hud completely

proc
remove_atom_from_single_hud
(/mob/client_mob, /atom/atom_to_remove)

remove every hud image for this hud on atom_to_remove from client_mob's client.images list

proc
remove_single_hud_category_on_atom
(/atom/hud_atom, hud_category_to_remove)

removes the image or images in hud_atom.hud_list[hud_category_to_remove] from every mob that can see it but leaves every other image from that atom there.

proc
show_to
(/mob/new_viewer)

show this hud to the passed in user

atom_hud /datum/atom_hud

Vars

Procs

Var Details

var hud_atoms – /list/atom

var hud_atoms_all_z_levels – /list/atom

var hud_exceptions – /list

var hud_icons – /list

var hud_users – /list

var hud_users_all_z_levels – /list/mob

var next_time_allowed – /list

var queued_to_see – /list

var uses_global_hud_category –

Proc Details

proc add_all_atoms_to_single_mob_hud(/mob/requesting_mob, /list/atom/hud_atoms)

proc add_atom_to_all_mob_huds(/list/mob/requesting_mobs, /atom/hud_atom)

proc add_atom_to_hud(/atom/new_hud_atom)

proc add_atom_to_single_mob_hud(/mob/requesting_mob, /atom/hud_atom)

proc add_single_hud_category_on_atom(/atom/hud_atom, hud_category_to_add)

proc get_hud_atoms_for_z_level(z_level)

proc get_hud_users_for_z_level(z_level)

proc hide_from(/mob/former_viewer, absolute)

proc on_atom_or_user_z_level_changed(/atom/movable/moved_atom, /turf/old_turf, /turf/new_turf)

proc remove_all_atoms_from_single_hud(/mob/client_mob, /list/atom/atoms_to_remove)

proc remove_atom_from_all_huds(/list/mob/client_mobs, /atom/atom_to_remove)

proc remove_atom_from_hud(/atom/hud_atom_to_remove)

proc remove_atom_from_single_hud(/mob/client_mob, /atom/atom_to_remove)

proc remove_single_hud_category_on_atom(/atom/hud_atom, hud_category_to_remove)

proc show_to(/mob/new_viewer)