/datum/hud

Var Details

hud_zones

List of /datum/hud_zones, see hudzones/README

Proc Details

create_hud_zone

Creates a hud zone within the bounds of the screen at the supplied coordinates

Arguments:

coords: assoc list with format list(x_low = num, y_low = num, x_high = num, y_high = num)

x_low and y_low are the x and y coordinates of the bottom left corner of the zone
x_high and y_high are the x and y coordinates of the top right corner of the zone

alias: string, key for the hud zone

horizontal_edge: what horizontal side of the hud zone are new elements added from? can be EAST or WEST- Defaults to WEST

for example, if its EAST then the first element is added at the right edge of the zone
the second element is added to the left side of the first element
the third element is added to the left side of the second element, etc.

vertical_edge: what vertical side of the hud zone are new elements added from? can be NORTH or SOUTH - Defaults to SOUTH

for example, if its NORTH then the first element is added at the top edge of the zone
the second element is added to the bottom side of the first element
the third element is added to the bottom side of the second element, etc.

ignore_overlap: Whether to ignore if this hud zone overlaps with other hud zones - Defaults to FALSE

Returns: null if passed bad arguments, FALSE if there was an error placing it, the new /datum/hud_zone otherwise

debug_print_all

debug purposes only, call this to print ALL of the information you could ever need

delete_hud_zone

Deletes a hud zone and all elements inside of it

get_hudzone

Returns the /datum/hud_zone with zone_alias, null if passed bad arguments

screen_boundary_check

Returns TRUE if a rectangle defined by coords is within screen dimensions, FALSE if it isnt

zone_overlap_check

Returns TRUE if a rectangle defined by coords doesnt overlap with any existing hud zone, FALSE if it does