byond - Modules - TypesVar Details - Proc Details

armor_module

Vars

attach_delayTime it takes to attach.
attach_features_flagsBitfield flags of various features.
attach_iconIcon sheet of the attachment overlays
attachment_layerLayer for the attachment to be applied to.
attachments_allowedAllowed attachment types
attachments_by_slotList of slots this attachment has.
base_iconReplacement for initial icon that allows for the code to work with multiple variants
can_attachProc typepath that is called when this is item is being attached to something. Returns TRUE if it can attach.
detach_delayTime it takes to detach.
light_modLight modifier for attachment to an armor piece
mob_overlay_iconUsed for when the mob attach overlay icon is different than icon.
mob_pixel_shift_xPixel shift for the mob overlay on the X axis.
mob_pixel_shift_yPixel shift for the mob overlay on the Y axis.
on_attachProc typepath that is called when this is attached to something.
on_detachProc typepath that is called when this is detached from something.
parentReference to parent modular armor suit.
pixel_shift_xPixel shift for the item overlay on the X axis.
pixel_shift_yPixel shift for the item overlay on the Y axis.
prefered_slotSlot that is required for the action to appear to the equipper. If null the action will appear whenever the item is equiped to a slot.
slotSlot the attachment is able to occupy.
starting_attachmentsStarting attachments that are spawned with this.
toggle_signalThe signal for this module if it can toggled
variants_by_parent_typeAssoc list that uses the parents type as a key. type = "new_icon_state". This will change the icon state depending on what type the parent is. If the list is empty, or the parent type is not within, it will have no effect.

Procs

activateCalled on ui_action_click. Used for activating the module.
can_attachCalled before a module is attached.
handle_actionsAdds or removes actions based on whether the parent is in the correct slot.
handle_unequip_actionscalled when the item is dropped: relevant when item is forcedropped from a non-hand slot so we can remove the actions.
on_attachCalled when the module is added to the armor.
on_detachCalled when the module is removed from the armor.

Var Details

attach_delay

Time it takes to attach.

attach_features_flags

Bitfield flags of various features.

attach_icon

Icon sheet of the attachment overlays

attachment_layer

Layer for the attachment to be applied to.

attachments_allowed

Allowed attachment types

attachments_by_slot

List of slots this attachment has.

base_icon

Replacement for initial icon that allows for the code to work with multiple variants

can_attach

Proc typepath that is called when this is item is being attached to something. Returns TRUE if it can attach.

detach_delay

Time it takes to detach.

light_mod

Light modifier for attachment to an armor piece

mob_overlay_icon

Used for when the mob attach overlay icon is different than icon.

mob_pixel_shift_x

Pixel shift for the mob overlay on the X axis.

mob_pixel_shift_y

Pixel shift for the mob overlay on the Y axis.

on_attach

Proc typepath that is called when this is attached to something.

on_detach

Proc typepath that is called when this is detached from something.

parent

Reference to parent modular armor suit.

pixel_shift_x

Pixel shift for the item overlay on the X axis.

pixel_shift_y

Pixel shift for the item overlay on the Y axis.

prefered_slot

Slot that is required for the action to appear to the equipper. If null the action will appear whenever the item is equiped to a slot.

slot

Slot the attachment is able to occupy.

starting_attachments

Starting attachments that are spawned with this.

toggle_signal

The signal for this module if it can toggled

variants_by_parent_type

Assoc list that uses the parents type as a key. type = "new_icon_state". This will change the icon state depending on what type the parent is. If the list is empty, or the parent type is not within, it will have no effect.

Proc Details

activate

Called on ui_action_click. Used for activating the module.

can_attach

Called before a module is attached.

handle_actions

Adds or removes actions based on whether the parent is in the correct slot.

handle_unequip_actions

called when the item is dropped: relevant when item is forcedropped from a non-hand slot so we can remove the actions.

on_attach

Called when the module is added to the armor.

on_detach

Called when the module is removed from the armor.