fax
/obj/machinery/fax

Vars
allow_exotic_faxes	If true you can fax things which strictly speaking are not paper.
allowed_types	List of types which should always be allowed to be faxed
exotic_types	List of types which should be allowed to be faxed if hacked
fax_history	This is where the dispatch and reception history for each fax is stored.
fax_id	The unique ID by which the fax will build a list of existing faxes.
fax_name	The name of the fax displayed in the list. Not necessarily unique to some EMAG jokes.
frontier_network	Necessary to hide syndicate faxes from the general list. Doesn't mean he's EMAGGED!
hurl_contents	If true we will eject faxes at speed rather than sedately place them into a tray.
jammed	If true, the fax machine is jammed and needs cleaning
loaded_item_ref	A weak reference to an inserted object.
radio	Internal radio for announcing over comms
radio_channel	Radio channel to speak into
radio_cooldown	Cooldown for aformentioned radio, prevents radio spam
seconds_electrified	World ticks the machine is electrified for.
special_networks	List with a fake-networks(not a fax actually), for request manager.
visible_to_network	True if the fax machine should be visible to other fax machines in general.
Procs
animate_object_travel	Procedure for animating an object entering or leaving the fax machine. Arguments:
can_load_item	Returns true if an item can be loaded into the fax machine.
clear_jam	Attempts to clean out a jammed machine using a passed item. Returns true if successful.
emag_act	Emag the device if the panel is open. Emag does not bring you into the frontier network, but makes it visible to you.
emp_act	EMP Interaction
fax_name_exist	Checks fax names for a match.
find_overlay_state	Returns an appropriate icon state to represent a passed item. Arguments:
history_add	A procedure that makes entries in the history of fax transactions.
history_clear	Clears the history of fax operations.
is_allowed_type	Returns true if an item is of a type which can currently be loaded into this fax machine. This list expands if you snip a particular wire.
log_fax	Records logs of bureacratic action Arguments:
multitool_act	Using the multi-tool with the panel closed causes the fax network name to be renamed.
receive	Procedure for accepting papers from another fax machine.
screwdriver_act	Open and close the wire panel.
send	The procedure for sending a paper to another fax machine.
shock	Attempts to shock the passed user, returns true if they are shocked.
travel_animation_complete	Called when the travel animation should end. Reset animation and overlay states. Arguments:
vend_item	Actually vends an item out of the fax machine. Moved into its own proc to allow a delay for the animation. This will either deposit the item on the fax machine, or throw it if you have hacked a wire. Arguments:
wrench_act	Unanchor/anchor

Var Details

var
allow_exotic_faxes
–

If true you can fax things which strictly speaking are not paper.

var
allowed_types
– /static/list

List of types which should always be allowed to be faxed

var
exotic_types
– /static/list

List of types which should be allowed to be faxed if hacked

var
fax_history
– /list

This is where the dispatch and reception history for each fax is stored.

var
fax_id
–

The unique ID by which the fax will build a list of existing faxes.

var
fax_name
–

The name of the fax displayed in the list. Not necessarily unique to some EMAG jokes.

var
frontier_network
–

Necessary to hide syndicate faxes from the general list. Doesn't mean he's EMAGGED!

var
hurl_contents
–

If true we will eject faxes at speed rather than sedately place them into a tray.

var
jammed
–

If true, the fax machine is jammed and needs cleaning

var
loaded_item_ref
– /datum/weakref

A weak reference to an inserted object.

var
radio
– /obj/item/radio

Internal radio for announcing over comms

var
radio_channel
–

Radio channel to speak into

var
radio_cooldown
–

Cooldown for aformentioned radio, prevents radio spam

var
seconds_electrified
–

World ticks the machine is electrified for.

var
special_networks
– /list

List with a fake-networks(not a fax actually), for request manager.

var
visible_to_network
–

True if the fax machine should be visible to other fax machines in general.

Proc Details

proc
animate_object_travel
(/obj/item/item, animation_state, overlay_state)

Procedure for animating an object entering or leaving the fax machine. Arguments:

item - The object which is travelling.
animation_state - An icon state to apply to the fax machine.
overlay_state - An icon state to apply as an overlay to the fax machine.

proc
can_load_item
(/obj/item/item)

Returns true if an item can be loaded into the fax machine.

proc
clear_jam
(/obj/item/item, /mob/user)

Attempts to clean out a jammed machine using a passed item. Returns true if successful.

↑
emag_act
(/mob/user)

Emag the device if the panel is open. Emag does not bring you into the frontier network, but makes it visible to you.

↑
emp_act
(severity)

EMP Interaction

proc
fax_name_exist
(new_fax_name)

Checks fax names for a match.

Called to check the new fax name against the names of other faxes to prevent the use of identical names. Arguments:

new_fax_name - The text of the name to be checked for a match.

proc
find_overlay_state
(/obj/item/item, state_prefix)

Returns an appropriate icon state to represent a passed item. Arguments:

item - Item to interrogate.
state_prefix - Icon state action prefix to mutate.

proc
history_add
(history_type, history_fax_name)

A procedure that makes entries in the history of fax transactions.

Called to record the operation in the fax history list. Records the type of operation, the name of the fax machine with which the operation was performed, and the station time. Arguments:

history_type - Type of operation. By default, "Send" and "Receive" should be used.
history_fax_name - The name of the fax machine that performed the operation.

proc
history_clear
()

Clears the history of fax operations.

proc
is_allowed_type
(/obj/item/item)

Returns true if an item is of a type which can currently be loaded into this fax machine. This list expands if you snip a particular wire.

proc
log_fax
(/obj/item/sent, destination_id, name)

Records logs of bureacratic action Arguments:

sent - The object being sent
destination_id - The unique ID of the fax machine
name - The friendly name of the fax machine, but these can be spoofed so the ID is also required

↑
multitool_act
(/mob/living/user, /obj/item/I)

Using the multi-tool with the panel closed causes the fax network name to be renamed.

proc
receive
(/atom/movable/loaded, sender_name, important)

Procedure for accepting papers from another fax machine.

The procedure is called in proc/send() of the other fax. It receives a paper-like object and "prints" it. Arguments:

loaded - The object to be printed.
sender_name - The sender's name, which will be displayed in the message and recorded in the history of operations.

↑
screwdriver_act
(/mob/living/user, /obj/item/screwdriver)

Open and close the wire panel.

proc
send
(/atom/movable/loaded, id)

The procedure for sending a paper to another fax machine.

The object is called inside /obj/machinery/fax to send the thing to another fax machine. The procedure searches among all faxes for the desired fax ID and calls proc/receive() on that fax. If the thing is sent successfully, it returns TRUE. Arguments:

loaded - The object to be sent.
id - The network ID of the fax machine you want to send the item to.

proc
shock
(/mob/living/user, chance)

Attempts to shock the passed user, returns true if they are shocked.

Arguments:

user - the user to shock
chance - probability the shock happens

proc
travel_animation_complete
(/mutable_appearance/remove_overlay)

Called when the travel animation should end. Reset animation and overlay states. Arguments:

remove_overlay - Overlay to remove.

proc
vend_item
(/atom/movable/vend)

Actually vends an item out of the fax machine. Moved into its own proc to allow a delay for the animation. This will either deposit the item on the fax machine, or throw it if you have hacked a wire. Arguments:

vend - Item to vend from the fax machine.

↑
wrench_act
(/mob/living/user, /obj/item/tool)

Unanchor/anchor

fax /obj/machinery/fax

Vars

Procs

Var Details

var allow_exotic_faxes –

var allowed_types – /static/list

var exotic_types – /static/list

var fax_history – /list

var fax_id –

var fax_name –

var frontier_network –

var hurl_contents –

var jammed –

var loaded_item_ref – /datum/weakref

var radio – /obj/item/radio

var radio_channel –

var radio_cooldown –

var seconds_electrified –

var special_networks – /list

var visible_to_network –

Proc Details

proc animate_object_travel(/obj/item/item, animation_state, overlay_state)

proc can_load_item(/obj/item/item)

proc clear_jam(/obj/item/item, /mob/user)

↑emag_act(/mob/user)

↑emp_act(severity)

proc fax_name_exist(new_fax_name)

proc find_overlay_state(/obj/item/item, state_prefix)

proc history_add(history_type, history_fax_name)

proc history_clear()

proc is_allowed_type(/obj/item/item)

proc log_fax(/obj/item/sent, destination_id, name)

↑multitool_act(/mob/living/user, /obj/item/I)

proc receive(/atom/movable/loaded, sender_name, important)

↑screwdriver_act(/mob/living/user, /obj/item/screwdriver)

proc send(/atom/movable/loaded, id)

proc shock(/mob/living/user, chance)

proc travel_animation_complete(/mutable_appearance/remove_overlay)

proc vend_item(/atom/movable/vend)

↑wrench_act(/mob/living/user, /obj/item/tool)