circuit_datatype

A circuit datatype. Used to determine the datatype of a port and also handle any additional behaviour.

Vars
abstract	Whether this datatype should be loaded into the global circuit_datatypes list.
can_receive_from	The datatypes that this datatype can receive from.
color	The color of the port in the UI. Doesn't work with hex colours.
datatype	The key. Used to identify the datatype. Should be a define.
datatype_flags	The flags of the circuit datatype
is_extensive	Whether we should extensively convert this datatype, important for composite lists who may not have datatypes that need implicit conversions
Procs
can_receive_from_datatype	Determines if a datatype is compatible with another port of a different type. Note: This is ALWAYS called on the input port, never on the output port. Inputs need to care about what types they're receiving, output ports don't have to care.
convert_value	Returns the value to be set for the port
convert_value_extensive	Similar to convert value, however it doesn't get called by a port when a value is set. Useful for extensive conversions that may only need to be done for player inputs (e.g. lists)
datatype_ui_data	The data to send to the UI attached to the port. Received by the type in FUNDAMENTAL_PORT_TYPES
get_datatype	Used by composite datatypes. Returns a single datatype from the list if it exists by index.
get_datatypes	Used by composite datatypes. Returns all the datatypes that build this datatype up.
handle_manual_input	When an input is manually set by a player. This is where extra sanitizing can happen. Will still call convert_value()
is_compatible	Determines if a port is compatible with this datatype. This WILL throw a runtime if it returns false. This is for sanity checking and it should not return false unless under extraordinary circumstances or people fail to write proper code.
on_gain	Called when the datatype is given to a port.
on_loss	Called when the datatype is removed from a port.

Var Details

var
abstract
–

Whether this datatype should be loaded into the global circuit_datatypes list.

var
can_receive_from
– /list

The datatypes that this datatype can receive from.

var
color
–

The color of the port in the UI. Doesn't work with hex colours.

var
datatype
–

The key. Used to identify the datatype. Should be a define.

var
datatype_flags
–

The flags of the circuit datatype

var
is_extensive
–

Whether we should extensively convert this datatype, important for composite lists who may not have datatypes that need implicit conversions

Proc Details

proc
can_receive_from_datatype
(datatype_to_check)

Determines if a datatype is compatible with another port of a different type. Note: This is ALWAYS called on the input port, never on the output port. Inputs need to care about what types they're receiving, output ports don't have to care.

Arguments:

datatype_to_check - The datatype to check

proc
convert_value
(/datum/port/port, value_to_convert, force)

Returns the value to be set for the port

Used for implicit conversions between outputs and inputs (e.g. number -> string) and applying/removing signals on inputs

proc
convert_value_extensive
(/datum/port/port, value_to_convert, force)

Similar to convert value, however it doesn't get called by a port when a value is set. Useful for extensive conversions that may only need to be done for player inputs (e.g. lists)

proc
datatype_ui_data
(/datum/port/port)

The data to send to the UI attached to the port. Received by the type in FUNDAMENTAL_PORT_TYPES

Arguments:

port - The port sending the data.

proc
get_datatype
(index)

Used by composite datatypes. Returns a single datatype from the list if it exists by index.

proc
get_datatypes
()

Used by composite datatypes. Returns all the datatypes that build this datatype up.

proc
handle_manual_input
(/datum/port/input/port, /mob/user, user_input)

When an input is manually set by a player. This is where extra sanitizing can happen. Will still call convert_value()

Arguments:

port - The port sending the data.

proc
is_compatible
(/datum/port/port)

Determines if a port is compatible with this datatype. This WILL throw a runtime if it returns false. This is for sanity checking and it should not return false unless under extraordinary circumstances or people fail to write proper code.

Arguments:

port - The port to check if it is compatible.

proc
on_gain
(/datum/port/gained_port)

Called when the datatype is given to a port.

Arguments:

gained_port - The gained port.

proc
on_loss
(/datum/port/lost_port)

Called when the datatype is removed from a port.

Arguments:

lost_port - The removed port.

circuit_datatype /datum/circuit_datatype

Vars

Procs

Var Details

var abstract –

var can_receive_from – /list

var color –

var datatype –

var datatype_flags –

var is_extensive –

Proc Details

proc can_receive_from_datatype(datatype_to_check)

proc convert_value(/datum/port/port, value_to_convert, force)

proc convert_value_extensive(/datum/port/port, value_to_convert, force)

proc datatype_ui_data(/datum/port/port)

proc get_datatype(index)

proc get_datatypes()

proc handle_manual_input(/datum/port/input/port, /mob/user, user_input)

proc is_compatible(/datum/port/port)

proc on_gain(/datum/port/gained_port)

proc on_loss(/datum/port/lost_port)

circuit_datatype
/datum/circuit_datatype

var
abstract
–

var
can_receive_from
– /list

var
color
–

var
datatype
–

var
datatype_flags
–

var
is_extensive
–

proc
can_receive_from_datatype
(datatype_to_check)

proc
convert_value
(/datum/port/port, value_to_convert, force)

proc
convert_value_extensive
(/datum/port/port, value_to_convert, force)

proc
datatype_ui_data
(/datum/port/port)

proc
get_datatype
(index)

proc
get_datatypes
()

proc
handle_manual_input
(/datum/port/input/port, /mob/user, user_input)

proc
is_compatible
(/datum/port/port)

proc
on_gain
(/datum/port/gained_port)

proc
on_loss
(/datum/port/lost_port)