/tg/ Station 13 - Modules - TypesDefine Details

code/__DEFINES/wiremod.dm

COMPONENT_TRIGGERED_BYHelper define that can only be used in /obj/item/circuit_component/input_received()
CIRCUIT_TRIGGERDefine to be placed at any proc that is triggered by a port.
PORT_TYPE_ANYCan accept any datatype. Only works for inputs, output types will runtime.
PORT_TYPE_STRINGString datatype
PORT_TYPE_NUMBERNumber datatype
PORT_TYPE_SIGNALSignal datatype
PORT_TYPE_LISTList datatype
PORT_TYPE_TABLETable datatype. Derivative of list, contains other lists with matching columns.
PORT_TYPE_OPTIONOptions datatype. Derivative of string.
PORT_TYPE_ATOMAtom datatype
PORT_TYPE_DATUMDatum datatype
PORT_ATOM_MAX_RANGEThe maximum range between a port and an atom
COMPONENT_MIN_RANDOM_POSThe minimum position of the x and y co-ordinates of the component in the UI
COMPONENT_MAX_RANDOM_POSThe maximum position of the x and y co-ordinates of the component in the UI
COMPONENT_MAX_POSThe maximum position in both directions that a component can be in. Prevents someone from positioning a component at an absurdly high value.
COMPONENT_SIGNALThe value that is sent whenever a component is simply sending a signal. This can be anything, and is currently the seconds since roundstart.
SHELL_FLAG_CIRCUIT_FIXEDWhether a circuit is stuck on a shell and cannot be removed (by a user)
SHELL_FLAG_REQUIRE_ANCHORWhether the shell needs to be anchored for the circuit to be on.
SHELL_FLAG_USB_PORTWhether or not the shell has a USB port.
SHELL_FLAG_ALLOW_FAILURE_ACTIONWhether the shell allows actions to be peformed on a shell if the action fails. This will additionally block the messages from being displayed.
USB_CABLE_MAX_RANGEThe maximum range a USB cable can be apart from a source
CIRCUIT_FLAG_INPUT_SIGNALCreates an input trigger that means the component won't be triggered unless the trigger is pulsed.
CIRCUIT_FLAG_OUTPUT_SIGNALCreates an output trigger that sends a pulse whenever the component is successfully triggered
CIRCUIT_FLAG_UNDUPEABLEProhibits the component from being duplicated via the module duplicator
CIRCUIT_FLAG_ADMINMarks a circuit component as admin only. Admins will only be able to link/unlink with these circuit components.
CIRCUIT_FLAG_HIDDENThis circuit component does not show in the menu.
CIRCUIT_FLAG_INSTANTThis circuit component has been marked as a component that has instant execution and will show up in the UI as so. This will only cause a visual change.
DATATYPE_FLAG_ALLOW_MANUAL_INPUTThe datatype supports manual inputs
DATATYPE_FLAG_AVOID_VALUE_UPDATEThe datatype won't update the value when it is connected to the port

Define Details

CIRCUIT_FLAG_ADMIN

Marks a circuit component as admin only. Admins will only be able to link/unlink with these circuit components.

CIRCUIT_FLAG_HIDDEN

This circuit component does not show in the menu.

CIRCUIT_FLAG_INPUT_SIGNAL

Creates an input trigger that means the component won't be triggered unless the trigger is pulsed.

CIRCUIT_FLAG_INSTANT

This circuit component has been marked as a component that has instant execution and will show up in the UI as so. This will only cause a visual change.

CIRCUIT_FLAG_OUTPUT_SIGNAL

Creates an output trigger that sends a pulse whenever the component is successfully triggered

CIRCUIT_FLAG_UNDUPEABLE

Prohibits the component from being duplicated via the module duplicator

CIRCUIT_TRIGGER

Define to be placed at any proc that is triggered by a port.

COMPONENT_MAX_POS

The maximum position in both directions that a component can be in. Prevents someone from positioning a component at an absurdly high value.

COMPONENT_MAX_RANDOM_POS

The maximum position of the x and y co-ordinates of the component in the UI

COMPONENT_MIN_RANDOM_POS

The minimum position of the x and y co-ordinates of the component in the UI

COMPONENT_SIGNAL

The value that is sent whenever a component is simply sending a signal. This can be anything, and is currently the seconds since roundstart.

COMPONENT_TRIGGERED_BY

Helper define that can only be used in /obj/item/circuit_component/input_received()

DATATYPE_FLAG_ALLOW_MANUAL_INPUT

The datatype supports manual inputs

DATATYPE_FLAG_AVOID_VALUE_UPDATE

The datatype won't update the value when it is connected to the port

PORT_ATOM_MAX_RANGE

The maximum range between a port and an atom

PORT_TYPE_ANY

Can accept any datatype. Only works for inputs, output types will runtime.

PORT_TYPE_ATOM

Atom datatype

PORT_TYPE_DATUM

Datum datatype

PORT_TYPE_LIST

List datatype

PORT_TYPE_NUMBER

Number datatype

PORT_TYPE_OPTION

Options datatype. Derivative of string.

PORT_TYPE_SIGNAL

Signal datatype

PORT_TYPE_STRING

String datatype

PORT_TYPE_TABLE

Table datatype. Derivative of list, contains other lists with matching columns.

SHELL_FLAG_ALLOW_FAILURE_ACTION

Whether the shell allows actions to be peformed on a shell if the action fails. This will additionally block the messages from being displayed.

SHELL_FLAG_CIRCUIT_FIXED

Whether a circuit is stuck on a shell and cannot be removed (by a user)

SHELL_FLAG_REQUIRE_ANCHOR

Whether the shell needs to be anchored for the circuit to be on.

SHELL_FLAG_USB_PORT

Whether or not the shell has a USB port.

USB_CABLE_MAX_RANGE

The maximum range a USB cable can be apart from a source