datum
Vars | |
| abstract_type | Abstract-ness is a meta-property of a class that is used to indicate that the class is intended to be used as a base class for others, and should not (or cannot) be instantiated. We have no such language concept in DM, and so we provide a datum member that can be used to hint at abstractness for circumstances where we would like that to be the case, such as base behavior providers. If set, a path at/above this one that expects not to be instantiated. |
|---|---|
| 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. |
Procs | |
| IsAbstract | If true, this datum is an instance of an abstract type. Oops. |
| 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
abstract_type
Abstract-ness is a meta-property of a class that is used to indicate that the class is intended to be used as a base class for others, and should not (or cannot) be instantiated. We have no such language concept in DM, and so we provide a datum member that can be used to hint at abstractness for circumstances where we would like that to be the case, such as base behavior providers. If set, a path at/above this one that expects not to be instantiated.
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.
Proc Details
IsAbstract
If true, this datum is an instance of an abstract type. Oops.
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.
@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
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
@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