Paradise Station 13 - Modules - TypesVar Details - Proc Details

atom

Vars

base_icon_stateUsed for changing icon states for different base sprites.
bottom_left_cornerSmoothing variable
bottom_right_cornerSmoothing variable
canSmoothWithList of smoothing groups this atom can smooth with. If this is null and atom is smooth, it smooths only with itself.
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
smoothing_flagsIcon-smoothing behavior.
smoothing_groupsWhat smoothing groups does this atom belongs to, to match canSmoothWith. If null, nobody can smooth with it.
smoothing_junctionWhat directions this is currently smoothing with. IMPORTANT: This uses the smoothing direction flags as defined in icon_smoothing.dm, instead of the BYOND flags.
top_left_cornerSmoothing variable
top_right_cornerSmoothing variable

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.
bitmask_smoothBasic smoothing proc. The atom checks for adjacent directions to smooth with and changes the icon_state based on that.
calculate_adjacenciesScans all adjacent turfs to find targets to smooth with.
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!
find_type_in_directionScans direction to find targets to smooth with.
get_orbitersSimple helper proc to get a list of everything directly orbiting the current atom, without checking contents, or null if nothing is.
get_orbiters_recursiveRecursive getter method to return a list of all ghosts transitively orbiting this atom. This will find orbiters either directly orbiting the followed atom, or any orbiters orbiting them (and so on).
get_orbiters_up_hierarchyCheck every object in the hierarchy above ourselves for orbiters, and return the full list of them. If an object is being held in a backpack, returns orbiters of the backpack, the person If recursive == TRUE, this will also check recursively through any ghosts seen to make sure we find everything upstream
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
remove_orbiterRemove an orbiter from the atom it's orbiting.
rename_interactive
set_smoothed_icon_stateChanges the icon state based on the new junction bitmask. Returns the old junction value.
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

base_icon_state

Used for changing icon states for different base sprites.

bottom_left_corner

Smoothing variable

bottom_right_corner

Smoothing variable

canSmoothWith

List of smoothing groups this atom can smooth with. If this is null and atom is smooth, it smooths only with itself.

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

smoothing_flags

Icon-smoothing behavior.

smoothing_groups

What smoothing groups does this atom belongs to, to match canSmoothWith. If null, nobody can smooth with it.

smoothing_junction

What directions this is currently smoothing with. IMPORTANT: This uses the smoothing direction flags as defined in icon_smoothing.dm, instead of the BYOND flags.

top_left_corner

Smoothing variable

top_right_corner

Smoothing variable

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.

bitmask_smooth

Basic smoothing proc. The atom checks for adjacent directions to smooth with and changes the icon_state based on that.

Returns the previous smoothing_junction state so the previous state can be compared with the new one after the proc ends, and see the changes, if any.

Objects override this to prevent unanchored objects from smoothing, see /obj/bitmask_smooth()

calculate_adjacencies

Scans all adjacent turfs to find targets to smooth with.

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

find_type_in_direction

Scans direction to find targets to smooth with.

get_orbiters

Simple helper proc to get a list of everything directly orbiting the current atom, without checking contents, or null if nothing is.

get_orbiters_recursive

Recursive getter method to return a list of all ghosts transitively orbiting this atom. This will find orbiters either directly orbiting the followed atom, or any orbiters orbiting them (and so on).

This shouldn't be passed arugments.

get_orbiters_up_hierarchy

Check every object in the hierarchy above ourselves for orbiters, and return the full list of them. If an object is being held in a backpack, returns orbiters of the backpack, the person If recursive == TRUE, this will also check recursively through any ghosts seen to make sure we find everything upstream

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

remove_orbiter

Remove an orbiter from the atom it's orbiting.

rename_interactive

set_smoothed_icon_state

Changes the icon state based on the new junction bitmask. Returns the old junction value.

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