datum
/datum

Vars
abstract_type	If set, a path at/above this one that expects not to be instantiated.
extensions	Lazylist (Type paths - Types of `/datum/extension`). List of extensions currently set for this datum.
gc_destroyed	Int. `world.time` when this datum was destroyed, or `GC_CURRENTLY_BEING_QDELETED` if currently being deleted. Controlled by `qdel()`.
instance_configurator	If this datum is pooled, the last configurator applied (if any).
instance_pool	If this datum is pooled, the pool it belongs to.
is_processing	Whether or not this datum is currently being processed, and by which subsystem. Controlled by the various `START_PROCESSING()` and `STOP_PROCESSING()` defines.
weakref	One-way reference to a `/weakref` instance that refers to this datum, if one exists.
Procs
Destroy	Default implementation of clean-up code. This should be overridden to remove all references pointing to the object being destroyed. Return the appropriate `QDEL_HINT`; in most cases this is `QDEL_HINT_QUEUE`.
IsAbstract	If true, this datum is an instance of an abstract type. Oops.
Process	The processing handler for this datum. Called regularly by the relevant subsystem defined by `is_processing`.
apply_visual	Applies visual overlays relating to viewing through a specific datum, i.e. cameras.
remove_visual	Removes visual overlays relating to viewing through a specific datum, i.e. cameras.
ui_data	Data to be sent to the UI. This must be implemented for a UI to work.
ui_interact	The ui_interact proc is used to open and update Nano UIs If ui_interact is not used then the UI will not update correctly ui_interact is currently defined for /atom/movable

Var Details

var
abstract_type

If set, a path at/above this one that expects not to be instantiated.

var
extensions
– /list/datum/extension

Lazylist (Type paths - Types of /datum/extension). List of extensions currently set for this datum.

Not recommended to set or reference directly. See the following procs instead:

/proc/set_extension()
/proc/get_or_create_extension()
/proc/get_extension()
/proc/has_extension()
/proc/construct_extension_instance()
/proc/remove_extension()

var
gc_destroyed

Int. world.time when this datum was destroyed, or GC_CURRENTLY_BEING_QDELETED if currently being deleted. Controlled by qdel().

var
instance_configurator
– /singleton/instance_configurator

If this datum is pooled, the last configurator applied (if any).

var
instance_pool
– /singleton/instance_pool

If this datum is pooled, the pool it belongs to.

var
is_processing

Whether or not this datum is currently being processed, and by which subsystem. Controlled by the various START_PROCESSING*() and STOP_PROCESSING*() defines.

var
weakref
– /weakref

One-way reference to a /weakref instance that refers to this datum, if one exists.

Proc Details

proc
Destroy
()

Default implementation of clean-up code. This should be overridden to remove all references pointing to the object being destroyed. Return the appropriate QDEL_HINT; in most cases this is QDEL_HINT_QUEUE.

proc
IsAbstract
()

If true, this datum is an instance of an abstract type. Oops.

proc
Process
()

The processing handler for this datum. Called regularly by the relevant subsystem defined by is_processing.

Return PROCESS_KILL to tell the subsystem to stop processing this datum.

proc
apply_visual
(/mob/M)

Applies visual overlays relating to viewing through a specific datum, i.e. cameras.

proc
remove_visual
(/mob/M)

Removes visual overlays relating to viewing through a specific datum, i.e. cameras.

proc
ui_data
(/mob/user, ui_key)

Data to be sent to the UI. This must be implemented for a UI to work.

@param user /mob The mob who interacting with the UI @param ui_key string A string key to use for this UI. Allows for multiple unique UIs on one obj/mob (defaut value "main")

@return data /list Data to be sent to the UI

proc
ui_interact
(/mob/user, ui_key, /datum/nanoui/ui, force_open, /datum/nanoui/master_ui, /datum/topic_state/state)

The ui_interact proc is used to open and update Nano UIs If ui_interact is not used then the UI will not update correctly ui_interact is currently defined for /atom/movable

@param user /mob The mob who is interacting with this UI @param ui_key string A string key to use for this UI. Allows for multiple unique UIs on one obj/mob (defaut value "main") @param ui /datum/nanoui This parameter is passed by the nanoui process() proc when updating an open UI @param force_open boolean Force the UI to (re)open, even if it's already open

@return nothing

datum /datum

Vars

Procs

Var Details

var abstract_type

var extensions – /list/datum/extension

var gc_destroyed

var instance_configurator – /singleton/instance_configurator

var instance_pool – /singleton/instance_pool

var is_processing

var weakref – /weakref

Proc Details

proc Destroy()

proc IsAbstract()

proc Process()

proc apply_visual(/mob/M)

proc remove_visual(/mob/M)

proc ui_data(/mob/user, ui_key)

proc ui_interact(/mob/user, ui_key, /datum/nanoui/ui, force_open, /datum/nanoui/master_ui, /datum/topic_state/state)