minimaps

Vars
cic_drawings	assoc list of CIC private drawings
client_minimap_copies	list of individual client minimap copies for tracking and updates
drawn_images	assoc list of hash = image of images drawn by players
earlyadds	list of callbacks we need to invoke late because Initialize happens early, or a Z-level was loaded after init
frozen_overlay_states	assoc list storing frozen overlay states when updates are sent
hashed_minimaps	assoc list of minimap objects that are hashed so we have to update as few as possible
images_by_source	Assoc list of images we hold by their source
minimaps_by_z	Minimap hud display datums sorted by zlevel
removal_cbs	Assoc list of removal callbacks to invoke to remove images from the raw lists
transmitted_drawings	assoc list of transmitted drawings
update_targets	the update target datums, sorted by update flag type
update_targets_unsorted	Nonassoc list of updators we want to have their overlays reapplied
updators_by_datum	list of holders for data relating to tracked zlevel and tracked atum
Procs
add_marker	Adds an atom we want to track with blips to the subsystem Arguments:
add_to_updaters	Adds an atom to the processing updators that will have blips drawn on them Arguments:
apply_drawings_to_live_minimaps	Applies existing drawings to live minimaps after a Live Update is sent
apply_existing_drawings_to_minimap	Applies existing drawings to a specific live minimap when first opened
create_ceiling_overlay	Creates ceiling protection overlay for a specific client and z-level
fetch_minimap_object	Fetches a /atom/movable/screen/minimap instance or creates on if none exists Note this does not destroy them when the map is unused, might be a potential thing to do? Arguments:
get_drawing_image	fetches the drawing icon for a minimap flag and returns it, creating it if needed. assumes minimap_flag is ONE flag
has_marker	Checks if the source has a marker already set
load_new_z	Creates a minimap for a particular z level
on_z_change	Called on zlevel change of a blip-atom so we can update the image lists as needed
refresh_cic_drawing_overlays	Refreshes CIC drawing overlays for real time updates
refresh_static_minimaps	Refreshes all non-live minimaps with current data
remove_client_copy	Removes client copy from tracking when deleted
remove_earlyadd	Removes the object from the earlyadds list, in case it was qdel'd before the z-level was fully loaded
remove_marker	Removes an atom and it's blip from the subsystem
remove_updator	Removes a atom from the subsystems updating overlays
removeimage	removes an image from raw tracked lists, invoked by callback

Var Details

var
cic_drawings
– /list/image

assoc list of CIC private drawings

var
client_minimap_copies
– /list/atom/movable/screen/minimap

list of individual client minimap copies for tracking and updates

var
drawn_images
– /list/image

assoc list of hash = image of images drawn by players

var
earlyadds
– /list/list/datum/callback

list of callbacks we need to invoke late because Initialize happens early, or a Z-level was loaded after init

var
frozen_overlay_states
– /list

assoc list storing frozen overlay states when updates are sent

var
hashed_minimaps
– /list

assoc list of minimap objects that are hashed so we have to update as few as possible

var
images_by_source
– /list/image

Assoc list of images we hold by their source

var
minimaps_by_z
– /list/datum/hud_displays

Minimap hud display datums sorted by zlevel

var
removal_cbs
– /list/datum/callback

Assoc list of removal callbacks to invoke to remove images from the raw lists

var
transmitted_drawings
– /list/image

assoc list of transmitted drawings

var
update_targets
– /list

the update target datums, sorted by update flag type

var
update_targets_unsorted
– /list/datum/minimap_updator

Nonassoc list of updators we want to have their overlays reapplied

var
updators_by_datum
– /list/datum/minimap_updator

list of holders for data relating to tracked zlevel and tracked atum

Proc Details

proc
add_marker
(/atom/target, hud_flags, /image/blip, image_x, image_y, is_label)

Adds an atom we want to track with blips to the subsystem Arguments:

target: atom we want to track
hud_flags: tracked HUDs we want this atom to be displayed on
marker: image or mutable_appearance we want to be using on the map

proc
add_to_updaters
(/atom/target, flags, ztarget, drawing, labels)

Adds an atom to the processing updators that will have blips drawn on them Arguments:

target: the target we want to be updating the overlays on
flags: flags for the types of blips we want to be updated
ztarget: zlevel we want to be updated with

proc
apply_drawings_to_live_minimaps
(minimap_flag)

Applies existing drawings to live minimaps after a Live Update is sent

proc
apply_existing_drawings_to_minimap
(/atom/movable/screen/minimap/target_map, minimap_flags)

Applies existing drawings to a specific live minimap when first opened

proc
create_ceiling_overlay
(/client/target_client, z_level)

Creates ceiling protection overlay for a specific client and z-level

proc
fetch_minimap_object
(zlevel, flags, live, popup, drawing, /client/for_client)

Fetches a /atom/movable/screen/minimap instance or creates on if none exists Note this does not destroy them when the map is unused, might be a potential thing to do? Arguments:

zlevel: zlevel to fetch map for
flags: map flags to fetch from

proc
get_drawing_image
(zlevel, minimap_flag, drawing)

fetches the drawing icon for a minimap flag and returns it, creating it if needed. assumes minimap_flag is ONE flag

proc
has_marker
(/atom/source)

Checks if the source has a marker already set

proc
load_new_z
(/datum/dcs, /datum/space_level/z_level)

Creates a minimap for a particular z level

proc
on_z_change
(/atom/movable/source, oldz, newz)

Called on zlevel change of a blip-atom so we can update the image lists as needed

TODO gross amount of assoc usage and unneeded ALL FLAGS iteration

proc
refresh_cic_drawing_overlays
(zlevel, minimap_flag)

Refreshes CIC drawing overlays for real time updates

proc
refresh_static_minimaps
(minimap_flag)

Refreshes all non-live minimaps with current data

proc
remove_client_copy
(/atom/movable/screen/minimap/source)

Removes client copy from tracking when deleted

proc
remove_earlyadd
(/atom/source)

Removes the object from the earlyadds list, in case it was qdel'd before the z-level was fully loaded

proc
remove_marker
(/atom/source)

Removes an atom and it's blip from the subsystem

proc
remove_updator
(/atom/target)

Removes a atom from the subsystems updating overlays

proc
removeimage
(/image/blip, /atom/target, hud_flags)

removes an image from raw tracked lists, invoked by callback

Minimaps /datum/controller/subsystem/minimaps

Vars

Procs

Var Details

var cic_drawings – /list/image

var client_minimap_copies – /list/atom/movable/screen/minimap

var drawn_images – /list/image

var earlyadds – /list/list/datum/callback

var frozen_overlay_states – /list

var hashed_minimaps – /list

var images_by_source – /list/image

var minimaps_by_z – /list/datum/hud_displays

var removal_cbs – /list/datum/callback

var transmitted_drawings – /list/image

var update_targets – /list

var update_targets_unsorted – /list/datum/minimap_updator

var updators_by_datum – /list/datum/minimap_updator

Proc Details

proc add_marker(/atom/target, hud_flags, /image/blip, image_x, image_y, is_label)

proc add_to_updaters(/atom/target, flags, ztarget, drawing, labels)

proc apply_drawings_to_live_minimaps(minimap_flag)

proc apply_existing_drawings_to_minimap(/atom/movable/screen/minimap/target_map, minimap_flags)

proc create_ceiling_overlay(/client/target_client, z_level)

proc fetch_minimap_object(zlevel, flags, live, popup, drawing, /client/for_client)

proc get_drawing_image(zlevel, minimap_flag, drawing)

proc has_marker(/atom/source)

proc load_new_z(/datum/dcs, /datum/space_level/z_level)

proc on_z_change(/atom/movable/source, oldz, newz)

proc refresh_cic_drawing_overlays(zlevel, minimap_flag)

proc refresh_static_minimaps(minimap_flag)

proc remove_client_copy(/atom/movable/screen/minimap/source)

proc remove_earlyadd(/atom/source)

proc remove_marker(/atom/source)

proc remove_updator(/atom/target)

proc removeimage(/image/blip, /atom/target, hud_flags)