Paradise Station 13 - Modules - TypesVar Details - Proc Details

atom

Vars

chat_colorLast color calculated for the the chatmessage overlays. Used for caching.
chat_color_nameLast name used to calculate a color for the chatmessage overlays. Used for caching.
container_typeChemistry.
dont_savewhat icon the mob uses for speechbubbles
filter_dataFor handling persistent filters
rad_insulationRadiation insulation types

Procs

AltClickNoInteractUse this instead of [/mob/proc/AltClickOn] where you only want turf content listing without additional atom alt-click interaction
acid_actRespond to acid being used on our atom
after_slipBase proc, intended to be overriden.
clean_radiationRemoves some radiation from an atom
contents_ui_distancepublic
detailed_examineUsed for showing a more detailed description in the 'Examine' tab after examining the atom.
detailed_examine_antagUsed for showing a more detailed description to antags in the 'Examine' after examining the atom.
detailed_examine_fluffUsed for showing flavour text in the 'Examine' tab after examining the atom.
emp_actProc which will make the atom act accordingly to an EMP. This proc can sleep depending on the implementation. So assume it sleeps!
get_all_adjacent_turfsProc which gets all adjacent turfs to src, including the turf that src is on.
get_runechat_colorProc to allow atoms to set their own runechat colour
is_drainableIs this atom drainable of reagents
is_drawableCan we draw from this atom with an injectable atom
is_injectableIs this atom injectable into other atoms
is_open_containerConvenience proc to see if a container is open for chemistry handling
is_refillableCan this atoms reagents be refilled
mech_melee_attackHandle melee attack by a mech
persistent_loadAtom Persistent Loader
persistent_saveAtom Persistent Saver
rad_actRespond to a radioactive wave hitting this atom
rename_interactive
shuttleRotateBase proc
storage_depthReturns the storage depth of an atom up to the area level.
storage_depth_turfLike /atom/proc/storage_depth, but returns the depth to the nearest turf.
zap_actRespond to an electric bolt action on our item

Var Details

chat_color

Last color calculated for the the chatmessage overlays. Used for caching.

chat_color_name

Last name used to calculate a color for the chatmessage overlays. Used for caching.

container_type

Chemistry.

dont_save

what icon the mob uses for speechbubbles

filter_data

For handling persistent filters

rad_insulation

Radiation insulation types

Proc Details

AltClickNoInteract

Use this instead of [/mob/proc/AltClickOn] where you only want turf content listing without additional atom alt-click interaction

acid_act

Respond to acid being used on our atom

Default behaviour is to send COMSIG_ATOM_ACID_ACT and return

after_slip

Base proc, intended to be overriden.

This should only be called from one place: inside the slippery component. Called after a human mob slips on this atom.

If you want the person who slipped to have something special done to them, put it here.

clean_radiation

Removes some radiation from an atom

Removes a configurable amount of radiation from an atom and stops green glow if radiation gets low enough through it. Arguments:

contents_ui_distance

public

Check the distance for a living mob. Really only used for checks outside the context of a mob. Otherwise, use shared_living_ui_distance().

required src_object The object which owns the UI. required user mob The mob who opened/is using the UI.

return UI_state The state of the UI.

detailed_examine

Used for showing a more detailed description in the 'Examine' tab after examining the atom.

Shown as blue text in the Examine tab.

detailed_examine_antag

Used for showing a more detailed description to antags in the 'Examine' after examining the atom.

Shown as red text in the Examine tab.

detailed_examine_fluff

Used for showing flavour text in the 'Examine' tab after examining the atom.

Shown as green text in the Examine tab. The custom flavour text of /mob subtypes override this.

emp_act

Proc which will make the atom act accordingly to an EMP. This proc can sleep depending on the implementation. So assume it sleeps!

severity - The severity of the EMP. Either EMP_HEAVY or EMP_LIGHT

get_all_adjacent_turfs

Proc which gets all adjacent turfs to src, including the turf that src is on.

This is similar to doing for(var/turf/T in range(1, src)). However it is slightly more performant. Additionally, the above proc becomes more costly the more atoms there are nearby. This proc does not care about that.

get_runechat_color

Proc to allow atoms to set their own runechat colour

This is a proc designed to be overridden in places if you want a specific atom to use a specific runechat colour Exampls include consoles using a colour based on their screen colour, and mobs using a colour based off of a customisation property

is_drainable

Is this atom drainable of reagents

is_drawable

Can we draw from this atom with an injectable atom

is_injectable

Is this atom injectable into other atoms

is_open_container

Convenience proc to see if a container is open for chemistry handling

is_refillable

Can this atoms reagents be refilled

mech_melee_attack

Handle melee attack by a mech

persistent_load

Atom Persistent Loader

Overridden on every atom which needs to load persistent data

persistent_save

Atom Persistent Saver

Overridden on every atom which needs to save persistent data

rad_act

Respond to a radioactive wave hitting this atom

Default behaviour is to send COMSIG_ATOM_RAD_ACT and return

rename_interactive

shuttleRotate

Base proc

storage_depth

Returns the storage depth of an atom up to the area level.

The storage depth is the number of storage items the atom is contained in. Returns -1 if the atom was not found in a container.

storage_depth_turf

Like /atom/proc/storage_depth, but returns the depth to the nearest turf.

Returns -1 if there's no top level turf. (A loc was null somewhere, or a non-turf atom's loc was an area somehow.)

zap_act

Respond to an electric bolt action on our item

Default behaviour is to return, we define here to allow for cleaner code later on