machinery

Machines in the world, such as computers, pipes, and airlocks.

Overview: Used to create objects that need a per step proc call. Default definition of 'Initialize()' stores a reference to src machine in global 'machines list'. Default definition of 'Destroy' removes reference to src machine in global 'machines list'.

Class Variables: use_power (num) current state of auto power use. Possible Values: NO_POWER_USE -- no auto power use IDLE_POWER_USE -- machine is using power at its idle power level ACTIVE_POWER_USE -- machine is using power at its active power level

active_power_usage (num) Value for the amount of power to use when in active power mode

idle_power_usage (num) Value for the amount of power to use when in idle power mode

power_channel (num) What channel to draw from when drawing power for power mode Possible Values: AREA_USAGE_EQUIP:1 -- Equipment Channel AREA_USAGE_LIGHT:2 -- Lighting Channel AREA_USAGE_ENVIRON:3 -- Environment Channel

component_parts (list) A list of component parts of machine used by frame based machines.

stat (bitflag) Machine status bit flags. Possible bit flags: BROKEN -- Machine is broken NOPOWER -- No power is being supplied to machine. MAINT -- machine is currently under going maintenance. EMPED -- temporary broken by EMP pulse

Class Procs: Initialize()

Destroy()

update_mode_power_usage()
	updates the static_power_usage var of this machine and makes its static power usage from its area accurate.
	called after the idle or active power usage has been changed.

update_power_channel()
	updates the static_power_usage var of this machine and makes its static power usage from its area accurate.
	called after the power_channel var has been changed or called to change the var itself.

unset_static_power()
	completely removes the current static power usage of this machine from its area.
	used in the other power updating procs to then readd the correct power usage.


 Default definition uses 'use_power', 'power_channel', 'active_power_usage',
 'idle_power_usage', 'powered()', and 'use_power()' implement behavior.

powered(chan = -1) 'modules/power/power.dm' Checks to see if area that contains the object has power available for power channel given in 'chan'. -1 defaults to power_channel

use_power(amount, chan=-1) 'modules/power/power.dm' Deducts 'amount' from the power channel 'chan' of the area that contains the object.

power_change() 'modules/power/power.dm' Called by the area that contains the object when ever that area under goes a power state change (area runs out of power, or area channel is turned off).

RefreshParts() 'game/machinery/machine.dm' Called to refresh the variables in the machine that are contributed to by parts contained in the component_parts list. (example: glass and material amounts for the autolathe)

 Default definition does nothing.

process() 'game/machinery/machine.dm' Called by the 'machinery subsystem' once per machinery tick for each machine that is listed in its 'machines' list.

process_atmos() Called by the 'air subsystem' once per atmos tick for each machine that is listed in its 'atmos_machines' list. Compiled by Aygar

Vars
active_power_usage	the amount of static power load this machine adds to its area's power_usage list when use_power = ACTIVE_POWER_USE
atmos_processing	Is this machine currently in the atmos machinery queue?
has_disk_slot	Can insert a disk into this machine
hibernating	Used by SSairmachines for optimizing scrubbers and vent pumps.
idle_power_usage	the amount of static power load this machine adds to its area's power_usage list when use_power = IDLE_POWER_USE
inserted_disk	A design disk that may-or-may-not be inserted into this machine.
internal_disk	The place that designs are stored. This will be created by apply_default_parts().
is_operational	A combination of factors such as having power, not being broken and so on. Boolean.
last_used_time	world.time of last use by /mob/living
last_user_mobtype	Mobtype of last user. Typecast to /mob/living for initial() usage
master_id	General purpose 'master' ID for slave machines.
net_class	A short string shown to players fingerprinting the device type as part of `command:ping`
net_id	Network ID, see network_flags for autopopulation info.
netjack	Linked Network Terminal
network_flags	Do we use packet networks/link to netjacks? see _DEFINES/packetnet.dm
ping_addition	Additional data stapled to pings, reduces network usage for some machines.
processing_flags	Viable flags to go here are START_PROCESSING_ON_INIT, or START_PROCESSING_MANUALLY. See code__DEFINES\machines.dm for more information on these flags.
selected_disk	Used for data management.
static_power_usage	the current amount of static power usage this machine is taking from its area
subsystem_type	What subsystem this machine will use, which is generally SSmachines or SSfastprocess. By default all machinery use SSmachines. This fires a machine's process() roughly every 2 seconds.
use_power	This is for automatic power consumption.
Procs
AI_notify_hack	Alerts the AI that a hack is in progress.
begin_processing	Helper proc for telling a machine to start processing with the subsystem type that is located in its `subsystem_type` var.
create_signal	A wrapper to generate basic, minimally-compliant data packets easily. Returns a `datum/signal` with prefilled `s_addr` and `d_addr` added to `datagram`
directly_use_power	An alternative to 'use_power', this proc directly costs the APC in direct charge, as opposed to being calculated periodically.
disk_copy	Copy data from the internal disk to an inserted one or visa-versa.
dump_contents	Drop every movable atom in the machine's contents list, including any components and circuit.
dump_inventory_contents	Drop every movable atom in the machine's contents list that is not a component_part.
eject_disk	Eject an inserted disk. Pass a user to put the disk in their hands.
end_processing	Helper proc for telling a machine to stop processing with the subsystem type that is located in its `subsystem_type` var.
link_to_jack	Attempt to locate a network jack on the same tile and link to it, unlinking from any existing terminal. Passes through the return code from [/obj/machinery/power/data_terminal/proc/connect_machine()]
on_set_is_operational	Called when the value of `is_operational` changes, so we can react to it.
on_set_machine_stat	Called when the value of `machine_stat` changes, so we can react to it.
open_machine	Opens the machine.
post_signal	Send a signal from a ref. Data sent in signals must be dereferenced. If you're sending a forged source address (You should have a good reason for this...) set `preserve_s_addr = TRUE
power_change	Called whenever the power settings of the containing area change
remove_area_power_relationship	proc to call when the machine stops requiring power after a duration of requiring power saves memory by removing the power relationship with its area if it exists and loses area sensitivity does not affect power usage itself
set_is_operational	Called when we want to change the value of the `is_operational` variable. Boolean.
set_machine_stat	Called when we want to change the value of the machine_stat variable. Holds bitflags.
setup_area_power_relationship	proc to call when the machine starts to require power after a duration of not requiring power sets up power related connections to its area if it exists and becomes area sensitive does not affect power usage itself
spawn_frame	Spawns a frame where this machine is. If the machine was not disassmbled, the frame is spawned damaged. If the frame couldn't exist on this turf, it's smashed down to metal sheets.
toggle_disk	Toggle the selected disk between internal and inserted.
try_put_in_hand	Puts passed object in to user's hand
unlink_from_jack	Unlink from a network terminal `ignore_check` is used as part of machinery destroy.
unset_static_power	internal proc that removes all static power usage from the current area
update_current_power_usage	makes this machine draw power from its area according to which use_power mode it is set to
update_mode_power_usage	sets the power_usage linked to the specified use_power_mode to new_usage e.g. update_mode_power_usage(ACTIVE_POWER_USE, 10) sets active_power_use = 10 and updates its power draw from the machines area if use_power == ACTIVE_POWER_USE
update_power_channel	updates the power channel this machine uses. removes the static power usage from the old channel and readds it to the new channel
update_use_power	updates the use_power var for this machine and updates its static power usage from its area to reflect the new value
use_power_from_net	Attempts to draw power directly from the APC's Powernet rather than the APC's battery. For high-draw machines, like the cell charger

Var Details

var
active_power_usage
–

the amount of static power load this machine adds to its area's power_usage list when use_power = ACTIVE_POWER_USE

var
atmos_processing
–

Is this machine currently in the atmos machinery queue?

var
has_disk_slot
–

Can insert a disk into this machine

var
hibernating
–

Used by SSairmachines for optimizing scrubbers and vent pumps.

var
idle_power_usage
–

the amount of static power load this machine adds to its area's power_usage list when use_power = IDLE_POWER_USE

var
inserted_disk
– /obj/item/disk/data

A design disk that may-or-may-not be inserted into this machine.

var
internal_disk
– /obj/item/disk/data

The place that designs are stored. This will be created by apply_default_parts().

var
is_operational
–

A combination of factors such as having power, not being broken and so on. Boolean.

var
last_used_time
–

world.time of last use by /mob/living

var
last_user_mobtype
– /mob/living

Mobtype of last user. Typecast to /mob/living for initial() usage

var
master_id
–

General purpose 'master' ID for slave machines.

var
net_class
–

A short string shown to players fingerprinting the device type as part of command:ping

var
net_id
–

Network ID, see network_flags for autopopulation info.

var
netjack
– /obj/machinery/power/data_terminal

Linked Network Terminal

var
network_flags
–

Do we use packet networks/link to netjacks? see _DEFINES/packetnet.dm

var
ping_addition
–

Additional data stapled to pings, reduces network usage for some machines.

var
processing_flags
–

Viable flags to go here are START_PROCESSING_ON_INIT, or START_PROCESSING_MANUALLY. See code__DEFINES\machines.dm for more information on these flags.

var
selected_disk
– /obj/item/disk/data

Used for data management.

var
static_power_usage
–

the current amount of static power usage this machine is taking from its area

var
subsystem_type
–

What subsystem this machine will use, which is generally SSmachines or SSfastprocess. By default all machinery use SSmachines. This fires a machine's process() roughly every 2 seconds.

var
use_power
–

This is for automatic power consumption.

Proc Details

proc
AI_notify_hack
()

Alerts the AI that a hack is in progress.

Sends all AIs a message that a hack is occurring. Specifically used for space ninja tampering as this proc was originally in the ninja files. However, the proc may also be used elsewhere.

proc
begin_processing
()

Helper proc for telling a machine to start processing with the subsystem type that is located in its subsystem_type var.

proc
create_signal
(destination_id, /list/datagram)

A wrapper to generate basic, minimally-compliant data packets easily. Returns a datum/signal with prefilled s_addr and d_addr added to datagram

proc
directly_use_power
(amount)

An alternative to 'use_power', this proc directly costs the APC in direct charge, as opposed to being calculated periodically.

Amount: How much power the APC's cell is to be costed.

proc
disk_copy
(/mob/user, index, data, unique)

Copy data from the internal disk to an inserted one or visa-versa.

dump_contents
()

Drop every movable atom in the machine's contents list, including any components and circuit.

proc
dump_inventory_contents
(/list/subset)

Drop every movable atom in the machine's contents list that is not a component_part.

Proc does not drop components and will skip over anything in the component_parts list. Call dump_contents() to drop all contents including components. Arguments:

subset - If this is not null, only atoms that are also contained within the subset list will be dropped.

proc
eject_disk
(/mob/user)

Eject an inserted disk. Pass a user to put the disk in their hands.

proc
end_processing
()

Helper proc for telling a machine to stop processing with the subsystem type that is located in its subsystem_type var.

proc
link_to_jack
()

Attempt to locate a network jack on the same tile and link to it, unlinking from any existing terminal. Passes through the return code from [/obj/machinery/power/data_terminal/proc/connect_machine()]

proc
on_set_is_operational
(old_value)

Called when the value of is_operational changes, so we can react to it.

proc
on_set_machine_stat
(old_value)

Called when the value of machine_stat changes, so we can react to it.

proc
open_machine
(drop)

Opens the machine.

Will update the machine icon and any user interfaces currently open. Arguments:

drop - Boolean. Whether to drop any stored items in the machine. Does not include components.

proc
post_signal
(/datum/signal/sending_signal, preserve_s_addr)

Send a signal from a ref. Data sent in signals must be dereferenced. If you're sending a forged source address (You should have a good reason for this...) set `preserve_s_addr = TRUE

NONE OF THE ABOVE IS TRUE IF YOU ARE machinery/power, AS THEY DEAL DIRECTLY WITH SSPACKETS INSTEAD OF ABSTRACTED TERMINALS

proc
power_change
()

Called whenever the power settings of the containing area change

by default, check equipment channel & set flag, can override if needed

Returns TRUE if the NOPOWER flag was toggled

proc
remove_area_power_relationship
()

proc to call when the machine stops requiring power after a duration of requiring power saves memory by removing the power relationship with its area if it exists and loses area sensitivity does not affect power usage itself

proc
set_is_operational
(new_value)

Called when we want to change the value of the is_operational variable. Boolean.

proc
set_machine_stat
(new_value)

Called when we want to change the value of the machine_stat variable. Holds bitflags.

proc
setup_area_power_relationship
()

proc to call when the machine starts to require power after a duration of not requiring power sets up power related connections to its area if it exists and becomes area sensitive does not affect power usage itself

proc
spawn_frame
(disassembled)

Spawns a frame where this machine is. If the machine was not disassmbled, the frame is spawned damaged. If the frame couldn't exist on this turf, it's smashed down to metal sheets.

Arguments:

disassembled - If FALSE, the machine was destroyed instead of disassembled and the frame spawns at reduced integrity.

proc
toggle_disk
(/mob/user)

Toggle the selected disk between internal and inserted.

proc
try_put_in_hand
(/obj/object, /mob/living/user)

Puts passed object in to user's hand

Puts the passed object in to the users hand if they are adjacent. If the user is not adjacent then place the object on top of the machine.

Vars:

object (obj) The object to be moved in to the users hand.
user (mob/living) The user to recive the object

proc
unlink_from_jack
(ignore_check)

Unlink from a network terminal ignore_check is used as part of machinery destroy.

proc
unset_static_power
()

internal proc that removes all static power usage from the current area

proc
update_current_power_usage
()

makes this machine draw power from its area according to which use_power mode it is set to

proc
update_mode_power_usage
(use_power_mode, new_usage)

sets the power_usage linked to the specified use_power_mode to new_usage e.g. update_mode_power_usage(ACTIVE_POWER_USE, 10) sets active_power_use = 10 and updates its power draw from the machines area if use_power == ACTIVE_POWER_USE

Arguments:

use_power_mode - the use_power power mode to change. if IDLE_POWER_USE changes idle_power_usage, ACTIVE_POWER_USE changes active_power_usage
new_usage - the new value to set the specified power mode var to

proc
update_power_channel
(new_power_channel)

updates the power channel this machine uses. removes the static power usage from the old channel and readds it to the new channel

proc
update_use_power
(new_use_power)

updates the use_power var for this machine and updates its static power usage from its area to reflect the new value

proc
use_power_from_net
(amount, take_any)

Attempts to draw power directly from the APC's Powernet rather than the APC's battery. For high-draw machines, like the cell charger

Checks the surplus power on the APC's powernet, and compares to the requested amount. If the requested amount is available, this proc will add the amount to the APC's usage and return that amount. Otherwise, this proc will return FALSE. If the take_any var arg is set to true, this proc will use and return any surplus that is under the requested amount, assuming that the surplus is above zero. Args:

amount, the amount of power requested from the Powernet. In standard loosely-defined SS13 power units.
take_any, a bool of whether any amount of power is acceptable, instead of all or nothing. Defaults to FALSE

machinery /obj/machinery

Vars

Procs

Var Details

var active_power_usage –

var atmos_processing –

var has_disk_slot –

var hibernating –

var idle_power_usage –

var inserted_disk – /obj/item/disk/data

var internal_disk – /obj/item/disk/data

var is_operational –

var last_used_time –

var last_user_mobtype – /mob/living

var master_id –

var net_class –

var net_id –

var netjack – /obj/machinery/power/data_terminal

var network_flags –

var ping_addition –

var processing_flags –

var selected_disk – /obj/item/disk/data

var static_power_usage –

var subsystem_type –

var use_power –

Proc Details

proc AI_notify_hack()

proc begin_processing()

proc create_signal(destination_id, /list/datagram)

proc directly_use_power(amount)

proc disk_copy(/mob/user, index, data, unique)

dump_contents()

proc dump_inventory_contents(/list/subset)

proc eject_disk(/mob/user)

proc end_processing()

proc link_to_jack()

proc on_set_is_operational(old_value)

proc on_set_machine_stat(old_value)

proc open_machine(drop)

proc post_signal(/datum/signal/sending_signal, preserve_s_addr)

proc power_change()

proc remove_area_power_relationship()

proc set_is_operational(new_value)

proc set_machine_stat(new_value)

proc setup_area_power_relationship()

proc spawn_frame(disassembled)

proc toggle_disk(/mob/user)

proc try_put_in_hand(/obj/object, /mob/living/user)

proc unlink_from_jack(ignore_check)

proc unset_static_power()

proc update_current_power_usage()

proc update_mode_power_usage(use_power_mode, new_usage)

proc update_power_channel(new_power_channel)

proc update_use_power(new_use_power)

proc use_power_from_net(amount, take_any)