datum

Var Details

_status_traits

Status traits attached to this datum

active_timers

Active timers with this datum as the target

comp_lookup

Any datum registered to receive signals from this datum is in this list

Lazy associated list in the structure of signal -> registree/list of registrees

datum_components

Components attached to this datum

Lazy associated list in the structure of type -> component/list of components

datum_flags

Datum level flags

filter_data

List for handling persistent filters.

gc_destroyed

Tick count time when this object was destroyed.

If this is non zero then the object has been garbage collected and is awaiting either a hard del by the GC subsystme, or to be autocollected (if it has no references)

isprocessing

Used by SSprocessing

signal_procs

Lazy associated list in the structure of target -> list(signal -> proctype) that are run when the datum receives that signal

tgui_shared_states

global

Associative list of JSON-encoded shared states that were set by tgui clients.

weak_reference

A weak reference to another datum

Proc Details

CanProcCall

Proc to check if a datum allows proc calls on it

Returns TRUE if you can call a proc on the datum, FALSE if you cant

Destroy

Default implementation of clean-up code.

This should be overridden to remove all references pointing to the object being destroyed, if you do override it, make sure to call the parent and return its return value by default

Return an appropriate QDEL_HINT to modify handling of your deletion; in most cases this is QDEL_HINT_QUEUE.

The base case is responsible for doing the following

• Erasing timers pointing to this datum
• Erasing compenents on this datum
• Notifying datums listening to signals from this datum that we are going away

Returns QDEL_HINT_QUEUE

GetComponent

Return any component assigned to this datum of the given type

This will throw an error if it's possible to have more than one component of that type on the parent

Arguments:

• datum/component/c_type The typepath of the component you want to get a reference to

GetComponents

Get all components of a given type that are attached to this datum

Arguments:

• c_type The component type path

GetExactComponent

Return any component assigned to this datum of the exact given type

This will throw an error if it's possible to have more than one component of that type on the parent

Arguments:

• datum/component/c_type The typepath of the component you want to get a reference to

RegisterSignal

Register to listen for a signal from the passed in target

This sets up a listening relationship such that when the target object emits a signal the source datum this proc is called upon, will receive a callback to the given proctype Return values from procs registered must be a bitfield

Arguments:

• datum/target The target to listen for signals from
• sig_type_or_types Either a string signal name, or a list of signal names (strings)
• proctype The proc to call back when the signal is emitted
• override If a previous registration exists you must explicitly set this

TakeComponent

Transfer this component to another parent

Component is taken from source datum

Arguments:

• datum/component/target Target datum to transfer to

TransferComponents

Transfer all components to target

All components from source datum are taken

Arguments:

• /datum/target the target to move the components to

UID

Gets or creates the UID of a datum

BYOND refs are recycled, so this system prevents that. If a datum does not have a UID when this proc is ran, one will be created Returns the UID of the datum

UnregisterSignal

Stop listening to a given signal from target

Breaks the relationship between target and source datum, removing the callback when the signal fires

Doesn't care if a registration exists or not

Arguments:

• datum/target Datum to stop listening to signals from
• sig_typeor_types Signal string key or list of signal keys to stop listening to specifically

_AddComponent

Creates an instance of new_type in the datum and attaches to it as parent

Sends the COMSIG_COMPONENT_ADDED signal to the datum

Returns the component that was created. Or the old component in a dupe situation where COMPONENT_DUPE_UNIQUE was set

If this tries to add a component to an incompatible type, the component will be deleted and the result will be null. This is very unperformant, try not to do it

Properly handles duplicate situations based on the dupe_mode var

_AddElement

Finds the singleton for the element type given and attaches it to src

_LoadComponent

Get existing component of type, or create it and return a reference to it

Use this if the item needs to exist at the time of this call, but may not have been created before now

Arguments:

• component_type The typepath of the component to create or return
• ... additional arguments to be passed when creating the component if it does not exist

_RemoveElement

Finds the singleton for the element type given and detaches it from src You only need additional arguments beyond the type if you're using ELEMENT_BESPOKE

_SendSignal

Internal proc to handle most all of the signaling procedure

Will runtime if used on datums with an empty component list

Use the SEND_SIGNAL define instead

_clear_signal_refs

Only override this if you know what you're doing. You do not know what you're doing This is a threat

add_filter

• Add a filter to the datum.

• This is on datum level, despite being most commonly / primarily used on atoms, so that filters can be applied to images / mutable appearances.

• Can also be used to assert a filter's existence. I.E. update a filter regardless if it exists or not.

• Arguments:

• • name - Filter name
• • priority - Priority used when sorting the filter.
• • params - Parameters of the filter.

add_traits

Proc that handles adding multiple traits to a target via a list. Must have a common source and target.

change_filter_priority

Updates the priority of the passed filter key

check_special_completion

For objectives with special checks (is that slime extract unused? does that intellicard have an ai in it? etcetc)

dump_harddel_info

Return text from this proc to provide extra context to hard deletes that happen to it Optional, you should use this for cases where replication is difficult and extra context is required Can be called more then once per object, use harddel_deets_dumped to avoid duplicate calls (I am so sorry)

get_filter

Returns the filter associated with the passed key

get_filter_index

Returns the indice in filters of the given filter name. If it is not found, returns null.

is_invalid_target

Originally an Objective proc. Changed to a datum proc to allow for the proc to be run on minds, before the objective is created

modify_filter

• Update a filter's parameter to the new one. If the filter doesnt exist we won't do anything.

• Arguments:

• • name - Filter name
• • new_params - New parameters of the filter
• • overwrite - TRUE means we replace the parameter list completely. FALSE means we only replace the things on new_params.

remove_filter

Removes the passed filter, or multiple filters, if supplied with a list.

remove_traits

Proc that handles removing multiple traits from a target via a list. Must have a common source and target.

signal_qdel

Signal qdel

Proc intended to be used when someone wants the src datum to be qdeled when a certain signal is sent to them.

Example usage: RegisterSignal(item, COMSIG_QDELETING, /datum/proc/signal_qdel)

string_assoc_list

Caches associative lists with non-numeric stringify-able index keys and stringify-able values (text/typepath -> text/path/number).

transition_filter

• Update a filter's parameter and animate this change. If the filter doesnt exist we won't do anything.

• Basically a datum/proc/modify_filter call but with animations. Unmodified filter parameters are kept.

• Arguments:

• • name - Filter name
• • new_params - New parameters of the filter
• • time - time arg of the BYOND animate() proc.
• • easing - easing arg of the BYOND animate() proc.
• • loop - loop arg of the BYOND animate() proc.

ui_act

public

Called on a UI when the UI receieves a href. Think of this as Topic().

required action string The action/button that has been invoked by the user. required params list A list of parameters attached to the button.

return bool If the UI should be updated or not.

ui_assets

public

Called on an object when a tgui object is being created, allowing you to push various assets to tgui, for examples spritesheets.

return list List of asset datums or file paths.

ui_close

public

Called on a UI's object when the UI is closed, not to be confused with client/verb/uiclose(), which closes the ui window

ui_data

public

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

required user mob The mob interacting with the UI.

return list Data to be sent to the UI.

ui_host

private

The UI's host object (usually src_object). This allows modules/datums to have the UI attached to them, and be a part of another object.

ui_interact

External tgui definitions, such as src_object APIs.

Copyright (c) 2020 Aleksej Komarov SPDX-License-Identifier: MIT

public

Used to open and update UIs. If this proc is not implemented properly, the UI will not update correctly.

required user mob The mob who opened/is using the UI. optional ui datum/tgui The UI to be updated, if it exists.

ui_modal_act

Call this from a proc that is called in ui_act() to process modal actions

Example: /obj/machinery/chem_master/proc/ui_act_modal You can then switch based on the return value and show different modals depending on the answer. Arguments:

• source - The source datum
• action - The called action
• params - The params to the action

ui_modal_answer

Calls the source's currently assigned modal's (if there is one) on_answer() proc. Private.

Arguments:

• source - The source datum
• id - The ID of the modal
• answer - The provided answer

ui_modal_bento

Opens a bento input UI modal

Internally checks if the answer is in the list of choices. Arguments:

• source - The source datum
• id - The ID of the modal
• text - The text to display above the answers
• delegate - The proc to call when submitted
• arguments - List of arguments passed to and from JS (mostly useful for chaining modals)
• value - The default value of the bento
• choices - The list of available choices in the bento

ui_modal_boolean

Opens a yes/no UI modal

Arguments:

• source - The source datum
• id - The ID of the modal
• text - The text to display above the answers
• delegate - The proc to call when "Yes" is pressed
• delegate_no - The proc to call when "No" is pressed
• arguments - List of arguments passed to and from JS (mostly useful for chaining modals)
• yes_text - The text to show in the "Yes" button
• no_text - The text to show in the "No" button

ui_modal_choice

Opens a dropdown input UI modal

Internally checks if the answer is in the list of choices. Arguments:

• source - The source datum
• id - The ID of the modal
• text - The text to display above the answers
• delegate - The proc to call when submitted
• arguments - List of arguments passed to and from JS (mostly useful for chaining modals)
• value - The default value of the dropdown
• choices - The list of available choices in the dropdown

ui_modal_clear

Clears the current modal for a given datum

Arguments:

• source - The source datum

ui_modal_data

Call this from ui_data() to return modal information if needed

Arguments:

• source - The source datum

ui_modal_input

Opens a text input UI modal

Arguments:

• source - The source datum
• id - The ID of the modal
• text - The text to display above the answers
• delegate - The proc to call when submitted
• arguments - List of arguments passed to and from JS (mostly useful for chaining modals)
• value - The default value of the input
• max_length - The maximum char length of the input

ui_modal_message

Opens a message UI modal

Arguments:

• source - The source datum
• id - The ID of the modal
• text - The text to display above the answers
• delegate - The proc to call when closed
• arguments - List of arguments passed to and from JS (mostly useful for chaining modals)

ui_modal_new

Registers a given modal to a source. Private.

Arguments:

• source - The source datum
• modal - The datum/ui_modal to register
• replace_previous - Whether any modal currently assigned to source should be replaced
• instant_update - Whether the changes should reflect immediately

ui_modal_preprocess_answer

Passes an answer from JS through the modal's proc.

Used namely for cutting the text short if it's longer than an input modal's max_length. Arguments:

• source - The source datum
• answer - The provided answer

ui_state

private

The UI's state controller to be used for created uis This is a proc over a var for memory reasons

ui_static_data

public

Static Data to be sent to the UI.

Static data differs from normal data in that it's large data that should be sent infrequently. This is implemented optionally for heavy uis that would be sending a lot of redundant data frequently. Gets squished into one object on the frontend side, but the static part is cached.

required user mob The mob interacting with the UI.

return list Statuic Data to be sent to the UI.

ui_status

Base state and helpers for states. Just does some sanity checks, implement a proper state for in-depth checks.

Copyright (c) 2020 Aleksej Komarov SPDX-License-Identifier: MIT

public

Checks the UI state for a mob.

required user mob The mob who opened/is using the UI. required state datum/ui_state The state to check.

return UI_state The state of the UI.

update_filters

Reapplies all the filters.

update_static_data

public

Forces an update on static data. Should be done manually whenever something happens to change static data.

required user the mob currently interacting with the ui optional ui ui to be updated

vv_edit_var

Called when a var is edited with the new value to change to