Space Station 13 - Modules - TypesVar Details

global_vars

Vars

AdminProcCallCountHow many procs have been called
AdminProcCallSpamPreventionList to handle proc call spam prevention
AdminProcCallerWho is currently calling procs
BSACooldownIs admin BSA (damage a user) currently on cooldown?
LastAdminCalledProcLast proc called
LastAdminCalledTargetLast target to have a proc called on it
LastAdminCalledTargetUIDUID of the admin who last called
PDAsGlobal list of all PDAs in the world
acid_overlayACID
active_security_positionsActive security roles
admin_mutes_assocAssociative list of people who are muted via admin mutes
admin_objective_listStores objective names as list keys, and their corresponding typepaths as list values.
admin_statetgui state: admin_state
allNewscastersGlobal list that contains all existing newscasters in the world.
all_objectivesStores a reference to every objective which currently exists.
always_statetgui state: always_state
blurb_witnessesList of ckeys that have seen a blurb of a given key.
can_pass_info_varsList of vars on /datum/can_pass_info to use when checking two instances for equality
character_physiquesGlobal list for descriptors
command_head_positionsOnly roles that are command of departments, for revolution and similar stuff
command_positionsAll roles that are within the command category
configurationGlobal configuration datum holder for all the config sections
conscious_statetgui state: conscious_state
deep_inventory_statetgui state: deep_inventory_state
default_statetgui state: default_state
disable_explosionsAre explosions currently disabled for EORG?
dna_activity_boundsDNA 2: The Spaghetti Strikes Back
dna_mutationsAssoc list. Key = type of the mutation, value = the mutation
dooc_enabledIs OOC currently enabled for dead people?
dsay_enabledIs deadchat currently enabled?
em_mask_matrixA globaly cached version of EM_MASK_MATRIX for quick access.
enter_allowedAllow new players to enter the game?
frozen_atom_listFreeze Mob/Mech Verb -- Ported from NSS Pheonix (Unbound Travels)//////
game_yearThe current game year
ghost_hud_panelStores an instance of /datum/ui_module/ghost_hud_panel so that ghosts can use this to open their HUD panel.
global_singulo_idAmount of singulos created during the round(note that this will include teslas as well)
gravity_generatorsGlobal list of all active gravity generators. Keyed by the Z level
hands_statetgui state: hands_state
hudsGLOBAL HUD LIST
human_adjacent_statetgui state: human_adjacent_state
inventory_statetgui state: inventory_state
join_motdJoin MOTD for the server
join_tosJoin TOS for the server
library_catalogLibrary Catalog global is for storing a library catalog datum that will track book, category, and report lists for the library
looc_enabledIs LOOC currently enabled?
looping_soundsList of looping sounds
marker_beacon_colorsMarker Beacons
mod_themesGlobal list of all /datum/mod_theme
mouse_respawn_timeAmount of time (in minutes) that must pass between a player dying as a mouse and repawning as a mouse
multiverseMultiverse Blade
news_networkThe feed network singleton. Contains all channels (which contain all stories).
next_unique_datum_idThe next UID to be used (Increments by 1 for each UID)
nologeventAre we in a no-log event (EORG, highlander, etc)?
not_incapacitated_statetgui state: not_incapacitated_state
not_incapacitated_turf_statetgui state: not_incapacitated_turf_state
notcontained_statetgui state: notcontained_state
observer_statetgui state: observer_state
ooc_enabledIs OOC currently enabled?
physical_obscured_statetgui state: physical_obscured_state
physical_statetgui state: physical_state
rnd_tech_id_to_nameAssoc list of all RND techs with ID to name
security_positionsRoles that include any semblence of security, mostly for jobbans
seeds_cached_base64_iconsStores a list of the cached seed icons. Used in the seed extractor and the gene modder
self_statetgui state: self_state
slower_restartWill our restart be slower?
smokes_activeCounter for the current amount of smoke
sparks_activeCounter for the current amount of sparks
special_role_timesMinimum age (in days) for accounts to play these roles.
strippable_statetgui state: strippable_state
tcomms_machinesGlobal list for all telecomms machines in the world
tgs_logLog of TGS stuff that can be viewed ingame
tilt_critsList of possible crits from things tipping over
trait_name_mapvalue -> trait name, generated on use from trait_by_type global
ui_loginstgui login
ui_modalsui modals
uid_logLog of all UIDs created in the round. Assoc list with type as key and amount as value
viewer_statetgui state: viewer_state
wire_color_directoryList of wire colors for each object type of that round. One for airlocks, one for vendors, etc.
world_topic_handlersList of all world topic handler datums. Populated inside makeDatumRefLists()
world_topic_spam_prevention_handlersList of all world topic spam prevention handlers. See code/modules/world_topic/_spam_prevention_handler.dm

Var Details

AdminProcCallCount

How many procs have been called

AdminProcCallSpamPrevention

List to handle proc call spam prevention

AdminProcCaller

Who is currently calling procs

BSACooldown

Is admin BSA (damage a user) currently on cooldown?

LastAdminCalledProc

Last proc called

LastAdminCalledTarget

Last target to have a proc called on it

LastAdminCalledTargetUID

UID of the admin who last called

PDAs

Global list of all PDAs in the world

acid_overlay

ACID

active_security_positions

Active security roles

admin_mutes_assoc

Associative list of people who are muted via admin mutes

admin_objective_list

Stores objective names as list keys, and their corresponding typepaths as list values.

admin_state

tgui state: admin_state

Checks that the user is an admin, end-of-story.

allNewscasters

Global list that contains all existing newscasters in the world.

all_objectives

Stores a reference to every objective which currently exists.

always_state

tgui state: always_state

Always grants the user UI_INTERACTIVE. Period.

blurb_witnesses

List of ckeys that have seen a blurb of a given key.

can_pass_info_vars

List of vars on /datum/can_pass_info to use when checking two instances for equality

character_physiques

Global list for descriptors

command_head_positions

Only roles that are command of departments, for revolution and similar stuff

command_positions

All roles that are within the command category

configuration

Global configuration datum holder for all the config sections

conscious_state

tgui state: conscious_state

Only checks if the user is conscious.

deep_inventory_state

tgui state: deep_inventory_state

Checks that the src_object is in the user's deep (backpack, box, toolbox, etc) inventory.

default_state

tgui state: default_state

Checks a number of things -- mostly physical distance for humans and view for robots.

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

disable_explosions

Are explosions currently disabled for EORG?

dna_activity_bounds

DNA 2: The Spaghetti Strikes Back

@author N3X15 nexisentertainment@gmail.com

dna_mutations

Assoc list. Key = type of the mutation, value = the mutation

dooc_enabled

Is OOC currently enabled for dead people?

dsay_enabled

Is deadchat currently enabled?

em_mask_matrix

A globaly cached version of EM_MASK_MATRIX for quick access.

enter_allowed

Allow new players to enter the game?

frozen_atom_list

Freeze Mob/Mech Verb -- Ported from NSS Pheonix (Unbound Travels)//////

Allows admin's to right click on any mob/mech and freeze them in place.

game_year

The current game year

ghost_hud_panel

Stores an instance of /datum/ui_module/ghost_hud_panel so that ghosts can use this to open their HUD panel.

global_singulo_id

Amount of singulos created during the round(note that this will include teslas as well)

gravity_generators

Global list of all active gravity generators. Keyed by the Z level

hands_state

tgui state: hands_state

Checks that the src_object is in the user's hands.

huds

GLOBAL HUD LIST

human_adjacent_state

tgui state: human_adjacent_state

In addition to default checks, only allows interaction for a human adjacent user.

inventory_state

tgui state: inventory_state

Checks that the src_object is in the user's top-level (hand, ear, pocket, belt, etc) inventory.

join_motd

Join MOTD for the server

join_tos

Join TOS for the server

library_catalog

Library Catalog global is for storing a library catalog datum that will track book, category, and report lists for the library

looc_enabled

Is LOOC currently enabled?

looping_sounds

List of looping sounds

marker_beacon_colors

Marker Beacons

mod_themes

Global list of all /datum/mod_theme

mouse_respawn_time

Amount of time (in minutes) that must pass between a player dying as a mouse and repawning as a mouse

multiverse

Multiverse Blade

news_network

The feed network singleton. Contains all channels (which contain all stories).

next_unique_datum_id

The next UID to be used (Increments by 1 for each UID)

nologevent

Are we in a no-log event (EORG, highlander, etc)?

not_incapacitated_state

tgui state: not_incapacitated_state

Checks that the user isn't incapacitated

not_incapacitated_turf_state

tgui state: not_incapacitated_turf_state

Checks that the user isn't incapacitated and that their loc is a turf

notcontained_state

tgui state: notcontained_state

Checks that the user is not inside src_object, and then makes the default checks.

observer_state

tgui state: observer_state

Checks that the user is an observer/ghost.

ooc_enabled

Is OOC currently enabled?

physical_obscured_state

tgui state: physical_obscured_state

Short-circuits the default state to only check physical distance, being in view doesn't matter

physical_state

tgui state: physical_state

Short-circuits the default state to only check physical distance.

rnd_tech_id_to_name

Assoc list of all RND techs with ID to name

security_positions

Roles that include any semblence of security, mostly for jobbans

seeds_cached_base64_icons

Stores a list of the cached seed icons. Used in the seed extractor and the gene modder

self_state

tgui state: self_state

Only checks that the user and src_object are the same.

slower_restart

Will our restart be slower?

smokes_active

Counter for the current amount of smoke

sparks_active

Counter for the current amount of sparks

special_role_times

Minimum age (in days) for accounts to play these roles.

strippable_state

tgui state: strippable_state

Checks if user can strip the mob src_object

tcomms_machines

Global list for all telecomms machines in the world

tgs_log

Log of TGS stuff that can be viewed ingame

tilt_crits

List of possible crits from things tipping over

trait_name_map

value -> trait name, generated on use from trait_by_type global

ui_logins

tgui login

Allows the handling of logins using IDs within tgui.

Two key procs:

How to use (DM side):

  1. Call /obj/proc/ui_login_act at the start of your ui_act() proc
  2. Call /obj/proc/ui_login_data in your ui_data() proc while passing the data list
  3. In your object, call /obj/proc/ui_login_get to get the current login state.
  4. Optional: call /obj/proc/ui_login_attackby in your attackby__legacy__attackchain() to make the login process easier.

How to use (JS side): Use the and interfaces.

ui_modals

ui modals

Allows creation of modals within tgui.

uid_log

Log of all UIDs created in the round. Assoc list with type as key and amount as value

viewer_state

tgui state: viewer_state

State for only viewing, regardless of distance. Different from observer_state, which grants interactivity exclusively if an observer/admin.

wire_color_directory

List of wire colors for each object type of that round. One for airlocks, one for vendors, etc.

world_topic_handlers

List of all world topic handler datums. Populated inside makeDatumRefLists()

world_topic_spam_prevention_handlers

List of all world topic spam prevention handlers. See code/modules/world_topic/_spam_prevention_handler.dm