cyberpresidentvanellope/Paradise
1
0
Fork 0
mirror of https://github.com/ParadiseSS13/Paradise.git synced 2026-08-29 15:08:02 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
Paradise/obj/item/mod/module.html
T

1 line
28 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../../../"><link rel="stylesheet" href="dmdoc.css"><title>/obj/item/mod/module - Space Station 13</title></head><body><header><a href="index.html">Space Station 13</a> - <a href="index.html#modules">Modules</a> - <a href="index.html#types">Types</a> — <a href="obj/item/mod/module.html#var">Var Details</a> - <a href="obj/item/mod/module.html#proc">Proc Details</a></header><main><h1>module <aside>/<a href="obj.html">obj</a>/<a href="obj/item.html">item</a>/<a href="obj/item/mod/module.html">mod/module</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L2"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 2"></a></h1><p>MOD Module - A special device installed in a MODsuit allowing the suit to do new stuff.</p><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="obj/item/mod/module.html#var/active">active</a></th><td>Is the module active</td></tr><tr><th><a href="obj/item/mod/module.html#var/active_power_cost">active_power_cost</a></th><td>Power use when active</td></tr><tr><th><a href="obj/item/mod/module.html#var/allow_flags">allow_flags</a></th><td>flags that let the module ability be used in odd circumstances</td></tr><tr><th><a href="obj/item/mod/module.html#var/complexity">complexity</a></th><td>How much space it takes up in the MOD</td></tr><tr><th><a href="obj/item/mod/module.html#var/cooldown_time">cooldown_time</a></th><td>Cooldown after use</td></tr><tr><th><a href="obj/item/mod/module.html#var/cooldown_timer">cooldown_timer</a></th><td>Timer for the cooldown</td></tr><tr><th><a href="obj/item/mod/module.html#var/device">device</a></th><td>If we're an active module, what item are we?</td></tr><tr><th><a href="obj/item/mod/module.html#var/icon_monitor">icon_monitor</a></th><td>Replaces the sprite for monitor heads</td></tr><tr><th><a href="obj/item/mod/module.html#var/idle_power_cost">idle_power_cost</a></th><td>Power use when idle</td></tr><tr><th><a href="obj/item/mod/module.html#var/incompatible_modules">incompatible_modules</a></th><td>What modules are we incompatible with?</td></tr><tr><th><a href="obj/item/mod/module.html#var/mod">mod</a></th><td>Linked MODsuit</td></tr><tr><th><a href="obj/item/mod/module.html#var/mod_color_overide">mod_color_overide</a></th><td>Does the mod overide the colour in some way?</td></tr><tr><th><a href="obj/item/mod/module.html#var/module_UID">module_UID</a></th><td>The UID of the module. Don't ask.</td></tr><tr><th><a href="obj/item/mod/module.html#var/module_type">module_type</a></th><td>If it's passive, togglable, usable or active</td></tr><tr><th><a href="obj/item/mod/module.html#var/overlay_icon_file">overlay_icon_file</a></th><td>Icon file for the overlay.</td></tr><tr><th><a href="obj/item/mod/module.html#var/overlay_state_active">overlay_state_active</a></th><td>Overlay given to the user when the module is active</td></tr><tr><th><a href="obj/item/mod/module.html#var/overlay_state_inactive">overlay_state_inactive</a></th><td>Overlay given to the user when the module is inactive</td></tr><tr><th><a href="obj/item/mod/module.html#var/overlay_state_use">overlay_state_use</a></th><td>Overlay given to the user when the module is used, lasts until cooldown finishes</td></tr><tr><th><a href="obj/item/mod/module.html#var/pinned_to">pinned_to</a></th><td>List of UID()s mobs we are pinned to, linked with their action buttons</td></tr><tr><th><a href="obj/item/mod/module.html#var/removable">removable</a></th><td>If it can be removed</td></tr><tr><th><a href="obj/item/mod/module.html#var/tgui_id">tgui_id</a></th><td>ID used by their TGUI</td></tr><tr><th><a href="obj/item/mod/module.html#var/use_mod_colors">use_mod_colors</a></th><td>Does the overlay use the control unit's colors?</td></tr><tr><th><a href="obj/item/mod/module.html#var/use_power_cost">use_power_cost</a></th><td>Power use when used, we call it manually</td></tr><tr><th><a href="obj/item/mod/module.html#var/used_signal">used_signal</a></th><td>The mouse button needed to use this module</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="obj/item/mod/module.html#proc/add_module_overlay">add_module_overlay</a></th><td>Adds the worn overlays to the suit.</td></tr><tr><th><a href="obj/item/mod/module.html#proc/add_ui_configuration">add_ui_configuration</a></th><td>Generates an element of the get_configuration list with a display name, type and value</td></tr><tr><th><a href="obj/item/mod/module.html#proc/add_ui_data">add_ui_data</a></th><td>Adds additional things to the MODsuit ui_data()</td></tr><tr><th><a href="obj/item/mod/module.html#proc/check_power">check_power</a></th><td>Checks if there is enough power in the suit</td></tr><tr><th><a href="obj/item/mod/module.html#proc/configure_edit">configure_edit</a></th><td>Receives configure edits from the TGUI and edits the vars</td></tr><tr><th><a href="obj/item/mod/module.html#proc/drain_power">drain_power</a></th><td>Drains power from the suit charge</td></tr><tr><th><a href="obj/item/mod/module.html#proc/dropkey">dropkey</a></th><td>On drop key, concels a device item.</td></tr><tr><th><a href="obj/item/mod/module.html#proc/generate_worn_overlay">generate_worn_overlay</a></th><td>Generates an icon to be used for the suit's worn overlays</td></tr><tr><th><a href="obj/item/mod/module.html#proc/get_configuration">get_configuration</a></th><td>Creates a list of configuring options for this module</td></tr><tr><th><a href="obj/item/mod/module.html#proc/on_activation">on_activation</a></th><td>Called when the module is activated</td></tr><tr><th><a href="obj/item/mod/module.html#proc/on_active_process">on_active_process</a></th><td>Called on the MODsuit's process if it is an active module</td></tr><tr><th><a href="obj/item/mod/module.html#proc/on_deactivation">on_deactivation</a></th><td>Called when the module is deactivated</td></tr><tr><th><a href="obj/item/mod/module.html#proc/on_device_deletion">on_device_deletion</a></th><td>Called when the device gets deleted on active modules</td></tr><tr><th><a href="obj/item/mod/module.html#proc/on_equip">on_equip</a></th><td>Called when the MODsuit is equipped</td></tr><tr><th><a href="obj/item/mod/module.html#proc/on_exit">on_exit</a></th><td>Called when the device moves to a different place on active modules</td></tr><tr><th><a href="obj/item/mod/module.html#proc/on_install">on_install</a></th><td>Called from MODsuit's install() proc, so when the module is installed.</td></tr><tr><th><a href="obj/item/mod/module.html#proc/on_process">on_process</a></th><td>Called on the MODsuit's process</td></tr><tr><th><a href="obj/item/mod/module.html#proc/on_select">on_select</a></th><td>Called when the module is selected from the TGUI, radial or the action button</td></tr><tr><th><a href="obj/item/mod/module.html#proc/on_select_use">on_select_use</a></th><td>Called when an activated module without a device is used</td></tr><tr><th><a href="obj/item/mod/module.html#proc/on_special_click">on_special_click</a></th><td>Called when an activated module without a device is active and the user alt/middle-clicks</td></tr><tr><th><a href="obj/item/mod/module.html#proc/on_suit_activation">on_suit_activation</a></th><td>Called when the MODsuit is activated</td></tr><tr><th><a href="obj/item/mod/module.html#proc/on_suit_deactivation">on_suit_deactivation</a></th><td>Called when the MODsuit is deactivated</td></tr><tr><th><a href="obj/item/mod/module.html#proc/on_unequip">on_unequip</a></th><td>Called when the MODsuit is unequipped</td></tr><tr><th><a href="obj/item/mod/module.html#proc/on_uninstall">on_uninstall</a></th><td>Called from MODsuit's uninstall() proc, so when the module is uninstalled.</td></tr><tr><th><a href="obj/item/mod/module.html#proc/on_use">on_use</a></th><td>Called when the module is used</td></tr><tr><th><a href="obj/item/mod/module.html#proc/pin">pin</a></th><td>Pins the module to the user's action buttons</td></tr><tr><th><a href="obj/item/mod/module.html#proc/update_signal">update_signal</a></th><td>Updates the signal used by active modules to be activated</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/active"><aside class="declaration">var </aside>active <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L12"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 12"></a></h3><p>Is the module active</p><h3 id="var/active_power_cost"><aside class="declaration">var </aside>active_power_cost <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L18"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 18"></a></h3><p>Power use when active</p><h3 id="var/allow_flags"><aside class="declaration">var </aside>allow_flags <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L48"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 48"></a></h3><p>flags that let the module ability be used in odd circumstances</p><h3 id="var/complexity"><aside class="declaration">var </aside>complexity <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L14"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 14"></a></h3><p>How much space it takes up in the MOD</p><h3 id="var/cooldown_time"><aside class="declaration">var </aside>cooldown_time <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L42"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 42"></a></h3><p>Cooldown after use</p><h3 id="var/cooldown_timer"><aside class="declaration">var </aside>cooldown_timer <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L50"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 50"></a></h3><p>Timer for the cooldown</p><h3 id="var/device"><aside class="declaration">var </aside>device <aside>– /<a href="obj.html">obj</a>/<a href="obj/item.html">item</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L26"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 26"></a></h3><p>If we're an active module, what item are we?</p><h3 id="var/icon_monitor"><aside class="declaration">var </aside>icon_monitor <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L54"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 54"></a></h3><p>Replaces the sprite for monitor heads</p><h3 id="var/idle_power_cost"><aside class="declaration">var </aside>idle_power_cost <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L16"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 16"></a></h3><p>Power use when idle</p><h3 id="var/incompatible_modules"><aside class="declaration">var </aside>incompatible_modules <aside>– /list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L40"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 40"></a></h3><p>What modules are we incompatible with?</p><h3 id="var/mod"><aside class="declaration">var </aside>mod <aside>– /<a href="obj.html">obj</a>/<a href="obj/item.html">item</a>/<a href="obj/item/mod/control.html">mod/control</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L24"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 24"></a></h3><p>Linked MODsuit</p><h3 id="var/mod_color_overide"><aside class="declaration">var </aside>mod_color_overide <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L38"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 38"></a></h3><p>Does the mod overide the colour in some way?</p><h3 id="var/module_UID"><aside class="declaration">var </aside>module_UID <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L52"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 52"></a></h3><p>The UID of the module. Don't ask.</p><h3 id="var/module_type"><aside class="declaration">var </aside>module_type <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L10"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 10"></a></h3><p>If it's passive, togglable, usable or active</p><h3 id="var/overlay_icon_file"><aside class="declaration">var </aside>overlay_icon_file <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L34"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 34"></a></h3><p>Icon file for the overlay.</p><h3 id="var/overlay_state_active"><aside class="declaration">var </aside>overlay_state_active <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L30"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 30"></a></h3><p>Overlay given to the user when the module is active</p><h3 id="var/overlay_state_inactive"><aside class="declaration">var </aside>overlay_state_inactive <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L28"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 28"></a></h3><p>Overlay given to the user when the module is inactive</p><h3 id="var/overlay_state_use"><aside class="declaration">var </aside>overlay_state_use <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L32"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 32"></a></h3><p>Overlay given to the user when the module is used, lasts until cooldown finishes</p><h3 id="var/pinned_to"><aside class="declaration">var </aside>pinned_to <aside>– /list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L46"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 46"></a></h3><p>List of UID()s mobs we are pinned to, linked with their action buttons</p><h3 id="var/removable"><aside class="declaration">var </aside>removable <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L8"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 8"></a></h3><p>If it can be removed</p><h3 id="var/tgui_id"><aside class="declaration">var </aside>tgui_id <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L22"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 22"></a></h3><p>ID used by their TGUI</p><h3 id="var/use_mod_colors"><aside class="declaration">var </aside>use_mod_colors <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L36"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 36"></a></h3><p>Does the overlay use the control unit's colors?</p><h3 id="var/use_power_cost"><aside class="declaration">var </aside>use_power_cost <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L20"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 20"></a></h3><p>Power use when used, we call it manually</p><h3 id="var/used_signal"><aside class="declaration">var </aside>used_signal <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L44"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 44"></a></h3><p>The mouse button needed to use this module</p><h2 id="proc">Proc Details</h2><h3 id="proc/add_module_overlay"><aside class="declaration">proc </aside>add_module_overlay<aside>(/<a href="mob.html">mob</a>/<a href="mob/living.html">living</a>/user) <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L291"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 291"></a></aside></h3><p>Adds the worn overlays to the suit.</p><h3 id="proc/add_ui_configuration"><aside class="declaration">proc </aside>add_ui_configuration<aside>(display_name, type, value, /list/values) <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L262"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 262"></a></aside></h3><p>Generates an element of the get_configuration list with a display name, type and value</p><h3 id="proc/add_ui_data"><aside class="declaration">proc </aside>add_ui_data<aside>() <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L254"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 254"></a></aside></h3><p>Adds additional things to the MODsuit ui_data()</p><h3 id="proc/check_power"><aside class="declaration">proc </aside>check_power<aside>(amount) <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L250"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 250"></a></aside></h3><p>Checks if there is enough power in the suit</p><h3 id="proc/configure_edit"><aside class="declaration">proc </aside>configure_edit<aside>(key, value) <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L266"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 266"></a></aside></h3><p>Receives configure edits from the TGUI and edits the vars</p><h3 id="proc/drain_power"><aside class="declaration">proc </aside>drain_power<aside>(amount) <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L242"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 242"></a></aside></h3><p>Drains power from the suit charge</p><h3 id="proc/dropkey"><aside class="declaration">proc </aside>dropkey<aside>(/<a href="mob.html">mob</a>/<a href="mob/living.html">living</a>/user) <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L346"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 346"></a></aside></h3><p>On drop key, concels a device item.</p><h3 id="proc/generate_worn_overlay"><aside class="declaration">proc </aside>generate_worn_overlay<aside>(/<a href="mob.html">mob</a>/<a href="mob/living.html">living</a>/<a href="mob/living/carbon.html">carbon</a>/<a href="mob/living/carbon/human.html">human</a>/user) <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L295"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 295"></a></aside></h3><p>Generates an icon to be used for the suit's worn overlays</p><h3 id="proc/get_configuration"><aside class="declaration">proc </aside>get_configuration<aside>() <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L258"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 258"></a></aside></h3><p>Creates a list of configuring options for this module</p><h3 id="proc/on_activation"><aside class="declaration">proc </aside>on_activation<aside>() <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L105"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 105"></a></aside></h3><p>Called when the module is activated</p><h3 id="proc/on_active_process"><aside class="declaration">proc </aside>on_active_process<aside>() <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L210"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 210"></a></aside></h3><p>Called on the MODsuit's process if it is an active module</p><h3 id="proc/on_deactivation"><aside class="declaration">proc </aside>on_deactivation<aside>(display_message, deleting) <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L144"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 144"></a></aside></h3><p>Called when the module is deactivated</p><h3 id="proc/on_device_deletion"><aside class="declaration">proc </aside>on_device_deletion<aside>(/<a href="datum.html">datum</a>/source) <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L283"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 283"></a></aside></h3><p>Called when the device gets deleted on active modules</p><h3 id="proc/on_equip"><aside class="declaration">proc </aside>on_equip<aside>() <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L233"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 233"></a></aside></h3><p>Called when the MODsuit is equipped</p><h3 id="proc/on_exit"><aside class="declaration">proc </aside>on_exit<aside>(/<a href="datum.html">datum</a>/source, /<a href="atom.html">atom</a>/<a href="atom/movable.html">movable</a>/part, direction) <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L270"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 270"></a></aside></h3><p>Called when the device moves to a different place on active modules</p><h3 id="proc/on_install"><aside class="declaration">proc </aside>on_install<aside>() <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L214"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 214"></a></aside></h3><p>Called from MODsuit's install() proc, so when the module is installed.</p><h3 id="proc/on_process"><aside class="declaration">proc </aside>on_process<aside>() <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L199"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 199"></a></aside></h3><p>Called on the MODsuit's process</p><h3 id="proc/on_select"><aside class="declaration">proc </aside>on_select<aside>() <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L90"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 90"></a></aside></h3><p>Called when the module is selected from the TGUI, radial or the action button</p><h3 id="proc/on_select_use"><aside class="declaration">proc </aside>on_select_use<aside>(/<a href="atom.html">atom</a>/target) <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L184"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 184"></a></aside></h3><p>Called when an activated module without a device is used</p><h3 id="proc/on_special_click"><aside class="declaration">proc </aside>on_special_click<aside>(/<a href="mob.html">mob</a>/source, /<a href="atom.html">atom</a>/target) <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L193"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 193"></a></aside></h3><p>Called when an activated module without a device is active and the user alt/middle-clicks</p><h3 id="proc/on_suit_activation"><aside class="declaration">proc </aside>on_suit_activation<aside>() <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L223"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 223"></a></aside></h3><p>Called when the MODsuit is activated</p><h3 id="proc/on_suit_deactivation"><aside class="declaration">proc </aside>on_suit_deactivation<aside>(deleting) <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L228"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 228"></a></aside></h3><p>Called when the MODsuit is deactivated</p><h3 id="proc/on_unequip"><aside class="declaration">proc </aside>on_unequip<aside>() <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L238"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 238"></a></aside></h3><p>Called when the MODsuit is unequipped</p><h3 id="proc/on_uninstall"><aside class="declaration">proc </aside>on_uninstall<aside>(deleting) <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L218"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 218"></a></aside></h3><p>Called from MODsuit's uninstall() proc, so when the module is uninstalled.</p><h3 id="proc/on_use"><aside class="declaration">proc </aside>on_use<aside>() <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L168"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 168"></a></aside></h3><p>Called when the module is used</p><h3 id="proc/pin"><aside class="declaration">proc </aside>pin<aside>(/<a href="mob.html">mob</a>/user) <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L332"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 332"></a></aside></h3><p>Pins the module to the user's action buttons</p><h3 id="proc/update_signal"><aside class="declaration">proc </aside>update_signal<aside>(value) <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/mod/modules/_modules.dm#L323"><img src="git.png" width="16" height="16" title="code/modules/mod/modules/_modules.dm 323"></a></aside></h3><p>Updates the signal used by active modules to be activated</p></main><footer>paradise.dme <a href="https://github.com/ParadiseSS13/Paradise/tree/edee60476d21ee840643bd1abe7f6003a8c65773">edee604</a> (master) — <a href="https://github.com/SpaceManiac/SpacemanDMM/blob/master/crates/dmdoc/README.md">dmdoc 1.11.0</a></footer></body></html>
Reference in New Issue View Git Blame Copy Permalink