attachment_handler

Vars
attachable_overlays	List of the attachment overlay images. This is so that we can easily swap overlays in and out.
attachables_allowed	Typepath list that stores type data of allowed attachments. The attachment needs the attachment element to be able to attach regardless of what is stored here.
attachment_data_by_slot	Assoc list that stores the attachment data of an attachment in the slot.
attachment_offsets	List of offsets for the parent that adjusts the attachment overlay. slot1_x = 1, slot1_y = 1, slot2_x = 3, slot2_y = 7, etc. Can be null, in that case the offsets for all the attachments default to 0.
can_attach	Proc the parent calls to see if its eligable for attachment.
on_attach	Proc the parent calls on attach.
on_detach	Proc the parent calls on detach.
slots	Assoc list that stores the refs of the attachments to the parent. 'slot = reference'
Procs
apply_custom	Updates the mob sprite of the attachment.
attach_without_user	This is for other objects to be able to attach things without the need for a user.
can_attach	Checks the current slots of the parent and if there are attachments that can be removed in those slots. Basically it makes sure theres room for the attachment.
clean_references	Deletes the attachments when the parent deletes.
detach_check	Checks if you are actually able to detach an item or not
do_attach	The gun has another gun attached to it Theres probably a better way to do this. This is the do_after and user checks for attaching.
do_detach	Does the detach, shows the user the removable attachments and handles the do_after.
finish_detach	Actually detaches the attachment. This can be called directly to bypass checks.
finish_handle_attachment	Finishes setting up the attachment. This is where the attachment actually attaches. This can be called directly to bypass any checks to directly attach an object.
remove_overlay	Handles the removal of attachment overlays when the item is unequipped
start_detach	Starts with the detach, is called when the user Alt-Clicks the parent.
start_handle_attachment	Starts processing the attack, and whether or not the attachable can attack.
update_parent_overlay	This updates the overlays of the parent and applies the right ones.

Var Details

var
attachable_overlays
– /list

List of the attachment overlay images. This is so that we can easily swap overlays in and out.

var
attachables_allowed
– /list

Typepath list that stores type data of allowed attachments. The attachment needs the attachment element to be able to attach regardless of what is stored here.

var
attachment_data_by_slot
– /list

Assoc list that stores the attachment data of an attachment in the slot.

var
attachment_offsets
– /list

List of offsets for the parent that adjusts the attachment overlay. slot1_x = 1, slot1_y = 1, slot2_x = 3, slot2_y = 7, etc. Can be null, in that case the offsets for all the attachments default to 0.

var
can_attach
– /datum/callback

Proc the parent calls to see if its eligable for attachment.

var
on_attach
– /datum/callback

Proc the parent calls on attach.

var
on_detach
– /datum/callback

Proc the parent calls on detach.

var
slots
– /list

Assoc list that stores the refs of the attachments to the parent. 'slot = reference'

Proc Details

proc
apply_custom
(/datum/source, /mutable_appearance/standing, inhands, icon_used, state_used)

Updates the mob sprite of the attachment.

proc
attach_without_user
(/datum/source, /obj/item/attachment)

This is for other objects to be able to attach things without the need for a user.

proc
can_attach
(/obj/item/attachment, /mob/living/user, /list/attachment_data)

Checks the current slots of the parent and if there are attachments that can be removed in those slots. Basically it makes sure theres room for the attachment.

proc
clean_references
()

Deletes the attachments when the parent deletes.

proc
detach_check
(/mob/user)

Checks if you are actually able to detach an item or not

proc
do_attach
(/obj/item/attachment, /mob/attacher, /list/attachment_data)

The gun has another gun attached to it Theres probably a better way to do this. This is the do_after and user checks for attaching.

proc
do_detach
(/mob/living/user, /list/attachments_to_remove)

Does the detach, shows the user the removable attachments and handles the do_after.

proc
finish_detach
(/obj/item/attachment, /list/attachment_data, /mob/living/user)

Actually detaches the attachment. This can be called directly to bypass checks.

proc
finish_handle_attachment
(/obj/item/attachment, /list/attachment_data, /mob/attacker)

Finishes setting up the attachment. This is where the attachment actually attaches. This can be called directly to bypass any checks to directly attach an object.

proc
remove_overlay
()

Handles the removal of attachment overlays when the item is unequipped

proc
start_detach
(/datum/source, /mob/user)

Starts with the detach, is called when the user Alt-Clicks the parent.

proc
start_handle_attachment
(/datum/source, /obj/attacking, /mob/attacker)

Starts processing the attack, and whether or not the attachable can attack.

proc
update_parent_overlay
(/datum/source)

This updates the overlays of the parent and applies the right ones.

attachment_handler /datum/component/attachment_handler

Vars

Procs

Var Details

var attachable_overlays – /list

var attachables_allowed – /list

var attachment_data_by_slot – /list

var attachment_offsets – /list

var can_attach – /datum/callback

var on_attach – /datum/callback

var on_detach – /datum/callback

var slots – /list

Proc Details

proc apply_custom(/datum/source, /mutable_appearance/standing, inhands, icon_used, state_used)

proc attach_without_user(/datum/source, /obj/item/attachment)

proc can_attach(/obj/item/attachment, /mob/living/user, /list/attachment_data)

proc clean_references()

proc detach_check(/mob/user)

proc do_attach(/obj/item/attachment, /mob/attacher, /list/attachment_data)

proc do_detach(/mob/living/user, /list/attachments_to_remove)

proc finish_detach(/obj/item/attachment, /list/attachment_data, /mob/living/user)

proc finish_handle_attachment(/obj/item/attachment, /list/attachment_data, /mob/attacker)

proc remove_overlay()

proc start_detach(/datum/source, /mob/user)

proc start_handle_attachment(/datum/source, /obj/attacking, /mob/attacker)

proc update_parent_overlay(/datum/source)