Goonstation 13 - Modules - TypesDefine Details

_std/defines/atom.dm

isatomIs this an atom? idk ask mr. molecule man
isobjbuilt-in isobj returns true for /atom/movable
opposite_dir_toThis is relevant to atoms so it goes here!!!! do not @ me
ADMIN_INTERACT_PROCSMakes the given procs available for use with the admin interact menu Example: ADMIN_INTERACT_PROCS(/obj/machinery/nuclearbomb, proc/arm, proc/disarm) would add the *arm and *disarm options to the admin interact menu for nuclear bombs. Will display the "name" of the proc if it has one, for example set name = "foo" will result in the proc's entry in the interact menu being "Foo".
SPACE_PUSHINGused for removing us from mantapush list when we get deleted
MANTA_PUSHINGused for removing us from spacepush list when we get beleted
HAS_PARTICLESYSTEMatom has a particlesystem right now - used for clean gc to clear refs to itself etc blah
HAS_PARTICLESYSTEM_TARGETatom is a particlesystem target - " "
HAS_BAD_SMOKEatom has a bad smoke pointing to it right now - used for clean gc to clear refs to itself etc blah
IS_LIMB_ITEMim a limb
HAS_KUDZUif a turf has kudzu.
HAS_NBGGif a turf has NBGG.
BEING_CRUSHEREDif an atom/movable is in the crusher (so conveyors don't push it around)
USE_PROXIMITYAtom implements HasProximity() call in some way.
USE_FLUID_ENTERAtom implements EnteredFluid() call in some way.
USE_GRAB_CHOKEAtom can be held as an item and have a grab inside it to choke somebuddy
HANDLE_STICKERAtom implements var/active = XXX and responds to sticker removal methods (burn-off + acetone). this atom MUST have an 'active' var. im sory.
IMMUNE_MANTA_PUSHcannot be pushed by MANTAwaters
IS_TRINKETused for trinkets GC
NO_MOUSEDROP_QOLoverrides the click drag mousedrop pickup QOL kinda stuff
IMMUNE_TRENCH_WARPAtom won't get warped to z5 via floor holes on underwater maps
UNCROSS_BUMP_CHECKUncross should call this after setting . to make sure Bump gets called if needed
HELP_MESSAGE_OVERRIDEUse this to override the help message instead of doing it directly
RegisterHelpMessageHandlerWrapper around RegisterSignal for help messages. Use this when you want a component to add a custom help message to its parent. Makes it so the target is given the Help verb Note that we never remove the help verb and this is mostly because it's easier, unlikely to happen often and also not a big deal as the help verb just says that there's no help message if there's no help message. The reason why we skip mob is that mob.verbs is different from obj.verbs etc. Basically if you are trying to do this to a mob probably you will need to include HELP_MESSAGE_OVERRIDE on the mob to give it the static help verb. Sorry.
UnregisterHelpMessageHandlerWrapper around UnregisterSignal for help messages, identical to UnregisterSignal but here for parity
UNANCHOREDFor an unanchored movable atom
ANCHOREDFor an atom that can't be moved by player actions
ANCHORED_ALWAYSFor an atom that's always immovable, even by stuff like black holes and gravity artifacts.
UNDERFLOORThe atom is below the floor tiles.
OVERFLOORThe atom is above the floor tiles.

Define Details

ADMIN_INTERACT_PROCS

Makes the given procs available for use with the admin interact menu Example: ADMIN_INTERACT_PROCS(/obj/machinery/nuclearbomb, proc/arm, proc/disarm) would add the *arm and *disarm options to the admin interact menu for nuclear bombs. Will display the "name" of the proc if it has one, for example set name = "foo" will result in the proc's entry in the interact menu being "Foo".

ANCHORED

For an atom that can't be moved by player actions

ANCHORED_ALWAYS

For an atom that's always immovable, even by stuff like black holes and gravity artifacts.

BEING_CRUSHERED

if an atom/movable is in the crusher (so conveyors don't push it around)

HANDLE_STICKER

Atom implements var/active = XXX and responds to sticker removal methods (burn-off + acetone). this atom MUST have an 'active' var. im sory.

HAS_BAD_SMOKE

atom has a bad smoke pointing to it right now - used for clean gc to clear refs to itself etc blah

HAS_KUDZU

if a turf has kudzu.

HAS_NBGG

if a turf has NBGG.

HAS_PARTICLESYSTEM

atom has a particlesystem right now - used for clean gc to clear refs to itself etc blah

HAS_PARTICLESYSTEM_TARGET

atom is a particlesystem target - " "

HELP_MESSAGE_OVERRIDE

Use this to override the help message instead of doing it directly

IMMUNE_MANTA_PUSH

cannot be pushed by MANTAwaters

IMMUNE_TRENCH_WARP

Atom won't get warped to z5 via floor holes on underwater maps

IS_LIMB_ITEM

im a limb

IS_TRINKET

used for trinkets GC

MANTA_PUSHING

used for removing us from spacepush list when we get beleted

NO_MOUSEDROP_QOL

overrides the click drag mousedrop pickup QOL kinda stuff

OVERFLOOR

The atom is above the floor tiles.

RegisterHelpMessageHandler

Wrapper around RegisterSignal for help messages. Use this when you want a component to add a custom help message to its parent. Makes it so the target is given the Help verb Note that we never remove the help verb and this is mostly because it's easier, unlikely to happen often and also not a big deal as the help verb just says that there's no help message if there's no help message. The reason why we skip mob is that mob.verbs is different from obj.verbs etc. Basically if you are trying to do this to a mob probably you will need to include HELP_MESSAGE_OVERRIDE on the mob to give it the static help verb. Sorry.

SPACE_PUSHING

used for removing us from mantapush list when we get deleted

UNANCHORED

For an unanchored movable atom

UNCROSS_BUMP_CHECK

Uncross should call this after setting . to make sure Bump gets called if needed

UNDERFLOOR

The atom is below the floor tiles.

USE_FLUID_ENTER

Atom implements EnteredFluid() call in some way.

USE_GRAB_CHOKE

Atom can be held as an item and have a grab inside it to choke somebuddy

USE_PROXIMITY

Atom implements HasProximity() call in some way.

UnregisterHelpMessageHandler

Wrapper around UnregisterSignal for help messages, identical to UnregisterSignal but here for parity

isatom

Is this an atom? idk ask mr. molecule man

isobj

built-in isobj returns true for /atom/movable

opposite_dir_to

This is relevant to atoms so it goes here!!!! do not @ me