module

MOD Module - A special device installed in a MODsuit allowing the suit to do new stuff.

Vars
active	Is the module active
active_power_cost	Power use when active
allow_flags	flags that let the module ability be used in odd circumstances
complexity	How much space it takes up in the MOD
cooldown_time	Cooldown after use
cooldown_timer	Timer for the cooldown
device	If we're an active module, what item are we?
idle_power_cost	Power use when idle
incompatible_modules	What modules are we incompatible with?
mask_worn_overlay	If TRUE worn overlay will be masked with the suit, preventing any bits from poking out of its controur
mod	Linked MODsuit
module_type	If it's passive, togglable, usable or active
overlay_icon_file	Icon file for the overlay.
overlay_state_active	Overlay given to the user when the module is active
overlay_state_inactive	Overlay given to the user when the module is inactive
overlay_state_use	Overlay given to the user when the module is used, lasts until cooldown finishes
part_activated	Are all parts needed active- have we ran on_part_activation
part_process	Do we need the parts to be extended to run process
pinned_to	List of REF()s mobs we are pinned to, linked with their action buttons
removable	If it can be removed
required_slots	A list of slots required in the suit to work. Formatted like list(x\|y, z, ...) where either x or y are required and z is required.
tgui_id	ID used by their TGUI
use_energy_cost	Power use when used, we call it manually
use_mod_colors	Does the overlay use the control unit's colors?
used_signal	The mouse button needed to use this module
Procs
activate	Called when the module is activated
add_module_overlay	Adds the worn overlays to the suit.
add_ui_configuration	Generates an element of the get_configuration list with a display name, type and value
add_ui_data	Adds additional things to the MODsuit ui_data()
can_install	Additional checks for whenever a module can be installed into a suit or not
check_power	Checks if there is enough power in the suit
configure_edit	Receives configure edits from the TGUI and edits the vars
deactivate	Called when the module is deactivated
drain_power	Drains power from the suit charge
dropkey	On drop key, concels a device item.
get_configuration	Creates a list of configuring options for this module, possible configs include number, bool, color, list, button.
has_required_parts	Looks through the MODsuit's parts to see if it has the parts required to support this module
on_activation	Called from the module's activate()
on_active_process	Called on the MODsuit's process if it is an active module
on_deactivation	Called from the module's deactivate()
on_device_deletion	Called when the device gets deleted on active modules
on_equip	Called when the MODsuit is equipped
on_exit	Called when the device moves to a different place on active modules
on_install	Called from MODsuit's install() proc, so when the module is installed
on_part_activation	Called when the MODsuit is activated
on_part_deactivation	Called when the MODsuit is deactivated
on_process	Called on the MODsuit's process
on_select	Called when the module is selected from the TGUI, radial or the action button
on_select_use	Called when an activated module without a device is used
on_special_click	Called when an activated module without a device is active and the user alt/middle-clicks
on_unequip	Called when the MODsuit is unequipped
on_uninstall	Called from MODsuit's uninstall() proc, so when the module is uninstalled
on_use	Called from the module's used()
pin	Pins the module to the user's action buttons
start_cooldown	Apply a cooldown until this item can be used again
update_signal	Updates the signal used by active modules to be activated
used	Called when the module is used

Var Details

var
active
–

Is the module active

var
active_power_cost
–

Power use when active

var
allow_flags
–

flags that let the module ability be used in odd circumstances

var
complexity
–

How much space it takes up in the MOD

var
cooldown_time
–

Cooldown after use

var
cooldown_timer
–

Timer for the cooldown

var
device
– /obj/item

If we're an active module, what item are we?

var
idle_power_cost
–

Power use when idle

var
incompatible_modules
– /list

What modules are we incompatible with?

var
mask_worn_overlay
–

If TRUE worn overlay will be masked with the suit, preventing any bits from poking out of its controur

var
mod
– /obj/item/mod/control

Linked MODsuit

var
module_type
–

If it's passive, togglable, usable or active

var
overlay_icon_file
–

Icon file for the overlay.

var
overlay_state_active
–

Overlay given to the user when the module is active

var
overlay_state_inactive
–

Overlay given to the user when the module is inactive

var
overlay_state_use
–

Overlay given to the user when the module is used, lasts until cooldown finishes

var
part_activated
–

Are all parts needed active- have we ran on_part_activation

var
part_process
–

Do we need the parts to be extended to run process

var
pinned_to
– /list

List of REF()s mobs we are pinned to, linked with their action buttons

var
removable
–

If it can be removed

var
required_slots
– /list

A list of slots required in the suit to work. Formatted like list(x|y, z, ...) where either x or y are required and z is required.

var
tgui_id
–

ID used by their TGUI

var
use_energy_cost
–

Power use when used, we call it manually

var
use_mod_colors
–

Does the overlay use the control unit's colors?

var
used_signal
–

The mouse button needed to use this module

Proc Details

proc
activate
()

Called when the module is activated

proc
add_module_overlay
(/obj/item/source, /list/overlays, /mutable_appearance/standing, isinhands, icon_file)

Adds the worn overlays to the suit.

proc
add_ui_configuration
(display_name, type, value, /list/values)

Generates an element of the get_configuration list with a display name, type and value

proc
add_ui_data
()

Adds additional things to the MODsuit ui_data()

proc
can_install
(/obj/item/mod/control/mod)

Additional checks for whenever a module can be installed into a suit or not

proc
check_power
(amount)

Checks if there is enough power in the suit

proc
configure_edit
(key, value)

Receives configure edits from the TGUI and edits the vars

proc
deactivate
(display_message, deleting)

Called when the module is deactivated

proc
drain_power
(amount)

Drains power from the suit charge

proc
dropkey
(/mob/living/user)

On drop key, concels a device item.

proc
get_configuration
(/mob/user)

Creates a list of configuring options for this module, possible configs include number, bool, color, list, button.

proc
has_required_parts
(/list/parts, need_active)

Looks through the MODsuit's parts to see if it has the parts required to support this module

proc
on_activation
()

Called from the module's activate()

proc
on_active_process
(seconds_per_tick)

Called on the MODsuit's process if it is an active module

proc
on_deactivation
(display_message, deleting)

Called from the module's deactivate()

proc
on_device_deletion
(/datum/source)

Called when the device gets deleted on active modules

proc
on_equip
()

Called when the MODsuit is equipped

proc
on_exit
(/datum/source, /atom/movable/part, direction)

Called when the device moves to a different place on active modules

proc
on_install
()

Called from MODsuit's install() proc, so when the module is installed

proc
on_part_activation
()

Called when the MODsuit is activated

proc
on_part_deactivation
(deleting)

Called when the MODsuit is deactivated

proc
on_process
(seconds_per_tick)

Called on the MODsuit's process

proc
on_select
()

Called when the module is selected from the TGUI, radial or the action button

proc
on_select_use
(/atom/target)

Called when an activated module without a device is used

proc
on_special_click
(/mob/source, /atom/target)

Called when an activated module without a device is active and the user alt/middle-clicks

proc
on_unequip
()

Called when the MODsuit is unequipped

proc
on_uninstall
(deleting)

Called from MODsuit's uninstall() proc, so when the module is uninstalled

proc
on_use
()

Called from the module's used()

proc
pin
(/mob/user)

Pins the module to the user's action buttons

proc
start_cooldown
(applied_cooldown)

Apply a cooldown until this item can be used again

proc
update_signal
(value)

Updates the signal used by active modules to be activated

proc
used
()

Called when the module is used

module /obj/item/mod/module

Vars

Procs

Var Details

var active –

var active_power_cost –

var allow_flags –

var complexity –

var cooldown_time –

var cooldown_timer –

var device – /obj/item

var idle_power_cost –

var incompatible_modules – /list

var mask_worn_overlay –

var mod – /obj/item/mod/control

var module_type –

var overlay_icon_file –

var overlay_state_active –

var overlay_state_inactive –

var overlay_state_use –

var part_activated –

var part_process –

var pinned_to – /list

var removable –

var required_slots – /list

var tgui_id –

var use_energy_cost –

var use_mod_colors –

var used_signal –

Proc Details

proc activate()

proc add_module_overlay(/obj/item/source, /list/overlays, /mutable_appearance/standing, isinhands, icon_file)

proc add_ui_configuration(display_name, type, value, /list/values)

proc add_ui_data()

proc can_install(/obj/item/mod/control/mod)

proc check_power(amount)

proc configure_edit(key, value)

proc deactivate(display_message, deleting)

proc drain_power(amount)

proc dropkey(/mob/living/user)

proc get_configuration(/mob/user)

proc has_required_parts(/list/parts, need_active)

proc on_activation()

proc on_active_process(seconds_per_tick)

proc on_deactivation(display_message, deleting)

proc on_device_deletion(/datum/source)

proc on_equip()

proc on_exit(/datum/source, /atom/movable/part, direction)

proc on_install()

proc on_part_activation()

proc on_part_deactivation(deleting)

proc on_process(seconds_per_tick)

proc on_select()

proc on_select_use(/atom/target)

proc on_special_click(/mob/source, /atom/target)

proc on_unequip()

proc on_uninstall(deleting)

proc on_use()

proc pin(/mob/user)

proc start_cooldown(applied_cooldown)

proc update_signal(value)

proc used()