Goonstation 13 - Modules - TypesVar Details - Proc Details

/datum/client_image_group

Vars

always_visibleIf true this image is always visible ignoring loc's invisibiltiy etc
minds_with_associated_mob_imageAssociative list containing minds and the images attached to their mobs.
mob_to_associated_images_lookupAssociative list containing images for a given mob.
subscribed_clients_with_subcountAssociative list containing subscribed clients with counts.
subscribed_minds_with_subcountAssociative list containing subscribed minds with counts.
subscribed_mobs_with_subcountAssociative list containing subscribed mobs and the amount of times they subscribed to the image group (to handle multiple sources).

Procs

add_clientAdds a client directly, this should rarely be necessary.
add_imageAdds an image to the image list and adds it to all mobs' clients directly where appropriate. Registers signal to track mob invisibility changes.
add_mindAdds a mind to the mind list, adds all images to its client and registers signals on it.
add_mind_mob_overlayAdd an image that will attempt to attach itself to the mob inhabited by a mind, and update itself should the associated mind move to another mob.
add_mobAdds a mob to the mob list, adds all images to its client and registers signals on it.
image_conditionChecks whether an image is elligible to be attached to be displayed to a client.
on_mind_attachwhen a registered mind attaches to a mob
on_mind_detachwhen a registered mind detaches from a mob
on_mob_invisibility_changedRemoves or adds images to clients depending on the mob who the icons belong to's invisibility.
remove_clientRemoves a client directly, this should rarely be necessary.
remove_imageRemoves an image from the image list and from mobs' clients.
remove_mind_mob_overlayRemove a mind mob image.
remove_mobRemoves a mob from the mob list, removes the images from its client and unregisters signals on it. Force overrides subcount and removes it no matter what.
remove_mob_forcedRegistered on PARENT_PRE_DISPOSING, removes the mob from the list and unregisters signals from the mob when it's deleted.

Var Details

always_visible

If true this image is always visible ignoring loc's invisibiltiy etc

minds_with_associated_mob_image

Associative list containing minds and the images attached to their mobs.

mob_to_associated_images_lookup

Associative list containing images for a given mob.

subscribed_clients_with_subcount

Associative list containing subscribed clients with counts.

subscribed_minds_with_subcount

Associative list containing subscribed minds with counts.

subscribed_mobs_with_subcount

Associative list containing subscribed mobs and the amount of times they subscribed to the image group (to handle multiple sources).

Proc Details

add_client

Adds a client directly, this should rarely be necessary.

add_image

Adds an image to the image list and adds it to all mobs' clients directly where appropriate. Registers signal to track mob invisibility changes.

add_mind

Adds a mind to the mind list, adds all images to its client and registers signals on it.

add_mind_mob_overlay

Add an image that will attempt to attach itself to the mob inhabited by a mind, and update itself should the associated mind move to another mob.

add_mob

Adds a mob to the mob list, adds all images to its client and registers signals on it.

image_condition

Checks whether an image is elligible to be attached to be displayed to a client.

on_mind_attach

when a registered mind attaches to a mob

on_mind_detach

when a registered mind detaches from a mob

on_mob_invisibility_changed

Removes or adds images to clients depending on the mob who the icons belong to's invisibility.

remove_client

Removes a client directly, this should rarely be necessary.

remove_image

Removes an image from the image list and from mobs' clients.

remove_mind_mob_overlay

Remove a mind mob image.

remove_mob

Removes a mob from the mob list, removes the images from its client and unregisters signals on it. Force overrides subcount and removes it no matter what.

remove_mob_forced

Registered on PARENT_PRE_DISPOSING, removes the mob from the list and unregisters signals from the mob when it's deleted.