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
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
active_pollsActive polls
admin_mod_statetgui state: mod_state
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
ai_death_alarm_jobsMARK: Job lists
alive_player_listAll alive mobs with clients.
allNewscastersGlobal list that contains all existing newscasters in the world.
always_statetgui state: always_state
antag_paradise_double_antag_chanceChance to roll double antag for traitors in ANTAG-PARADISE gamemode.
antag_paradise_special_weightsWeights for all special antags in ANTAG-PARADISE gamemode.
antag_paradise_weightsWeights for all minor antags in ANTAG-PARADISE gamemode.
areasJust a list of all the area objects in the game Note, areas can have duplicate types
areas_by_typeAn association from typepath to area instance. Only includes areas with unique set.
blacklisted_tesla_typesThings that we don't want to shock.
blob_telepathy_mobsAll living mobs which can hear blob telepathy
blurb_witnessesList of ckeys that have seen a blurb of a given key.
cached_mapsList of all the maps that have been cached for /proc/load_map
can_pass_info_varsList of vars on /datum/can_pass_info to use when checking two instances for equality
cargo_announcersList of cargo consoles that print reports on completed/expired orders
centcomm_store
changeling_mutationsList of all items changeling can get through his powers. Update if needed.
conscious_statetgui state: conscious_state
contained_statetgui state: contained_state
conveyors_by_idList of all used conveyors and switches by id
current_observers_listAll observers with clients that joined as observers.
dead_player_listAll dead mobs with clients. Does not include observers.
deep_inventory_statetgui state: deep_inventory_state
default_statetgui state: default_state
dna_activity_boundsDNA 2: The Spaghetti Strikes Back
dug_up_basaltUsed by ashstorms to replenish basalt tiles that have been dug up without going through all of them.
dye_registryDye registry, add dye colors and their resulting output here if you want the sprite to change instead of just the color.
em_mask_matrixA globaly cached version of EM_MASK_MATRIX for quick access.
frozen_atom_listFreeze Mob/Mech Verb -- Ported from NSS Pheonix (Unbound Travels)//////
fullbright_overlaysList of plane offset + 1 -> mutable appearance to use Fills with offsets as they are generated
ghost_hud_panelStores an instance of /datum/ui_module/ghost_hud_panel so that ghosts can use this to open their HUD panel.
glide_size_multiplierCompensating for time dilation
global_trait_name_mapvalue -> trait name, list of ALL traits that exist in the game, used for any type of accessing.
gravity_generatorsGlobal list of all active gravity generators. Keyed by the Z level
halo_callbacksCallback checks for datum/element/halo_attach
halo_overlaysHalo overlays for datum/element/halo_attach
hands_statetgui state: hands_state
hivemind_bankHIVE MIND UPLOAD/DOWNLOAD DNA
holomap_color_to_nameUsed in generating area preview icons.
hudsGLOBAL HUD LIST
huds_by_categorygets filled by each /datum/atom_hud/New(). associative list of the form: list(hud category = list(all global atom huds that use that category))
human_adjacent_statetgui state: human_adjacent_state
icon_dimensionsCache of the width and height of icon files, to avoid repeating the same expensive operation
inventory_statetgui state: inventory_state
landmarks_listlist of all landmarks created
looping_soundsList of looping sounds
marker_beacon_colorsMarker Beacons
megafauna_spawn_listGlobal list of megafauna spawns on cave gen
modulo_angle_to_dirConverts an angle (degrees) into an ss13 direction
multiverseMultiverse Blade
news_networkThe feed network singleton. Contains all channels (which contain all stories).
not_incapacitated_statetgui state: not_incapacitated_state
not_incapacitated_turf_statetgui state: not_incapacitated_turf_state
notcontained_statetgui state: notcontained_state
nutrition_levelsList of all /datum/nutrition_level
observer_statetgui state: observer_state
physical_obscured_statetgui state: physical_obscured_state
physical_statetgui state: physical_state
pillars_by_zList of z pillars (datums placed in the bottom left of XbyX squares that control transparency in that space) The pillars are stored in triple depth lists indexed by (world_size % pillar_size) + 1 They are created at transparent turf request, and deleted when no turfs remain
poll_optionsAll poll option datums of running polls
pollsAll currently running polls held as datums
possible_changeling_IDsChangeling aliases.
see_through_mapsglobal statics for the see_through_component coordinate maps For ease of use, include a comment in the shape of the coordinate map, where O is nothing, X is a hidden tile and A is the object List-coordinate layout is list(relative_x, relative_y, relative_z) Turf finding algorithm needs the z and you can totally use it, but I can't think of any reason to ever do it Also it'd be really cool if you could keep the list-coordinates in here represent their actual relative coords, dont use tabs though since their spacing can differ
self_statetgui state: self_state
sfx_datum_by_keyAssoc list of datum by key. Initialized in SSsounds init. k = SFX_KEY (see below) v = singleton sound_effect datum ref
simple_animalsOne for each AI_* status define, List of all simple animals, including clientless
sortedAreasUsed by jump-to-area etc. Updated by area/updateName() If this is null, it needs to be recalculated. Use get_sorted_areas() as a getter please
start_landmarks_listlist of all job spawn points created
station_fire_alarmsA list of fire alarms on the station, separated by Z. Used cause there are a lot of fire alarms on any given station Z.
strippable_statetgui state: strippable_state
tcomms_machinesGlobal list for all telecomms machines in the world
things_to_shockThings that we want to shock.
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
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
world_uplinksList of all uplinks in the world.
z_statetgui state: z_state

Var Details

AdminProcCallCount

How many procs have been called

AdminProcCallSpamPrevention

List to handle proc call spam prevention

AdminProcCaller

Who is currently calling procs

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

active_polls

Active polls

admin_mod_state

tgui state: mod_state

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

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.

ai_death_alarm_jobs

MARK: Job lists

alive_player_list

All alive mobs with clients.

allNewscasters

Global list that contains all existing newscasters in the world.

always_state

tgui state: always_state

Always grants the user UI_INTERACTIVE. Period.

antag_paradise_double_antag_chance

Chance to roll double antag for traitors in ANTAG-PARADISE gamemode.

antag_paradise_special_weights

Weights for all special antags in ANTAG-PARADISE gamemode.

antag_paradise_weights

Weights for all minor antags in ANTAG-PARADISE gamemode.

areas

Just a list of all the area objects in the game Note, areas can have duplicate types

areas_by_type

An association from typepath to area instance. Only includes areas with unique set.

blacklisted_tesla_types

Things that we don't want to shock.

blob_telepathy_mobs

All living mobs which can hear blob telepathy

blurb_witnesses

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

cached_maps

List of all the maps that have been cached for /proc/load_map

can_pass_info_vars

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

cargo_announcers

List of cargo consoles that print reports on completed/expired orders

centcomm_store

By Nexypoo

The idea is to give people who do their jobs a reward.

Ideally, these items should be cosmetic in nature to avoid fucking up round balance. People joining the round get between $100 and $500. Keep this in mind.

Money should not persist between rounds, although a "bank" system to voluntarily store money between rounds might be cool. It'd need to be a bit volatile: perhaps completing job objectives = good stock market, shitty job objective completion = shitty economy.

Goal for now is to get the store itself working, however.

changeling_mutations

List of all items changeling can get through his powers. Update if needed.

conscious_state

tgui state: conscious_state

Only checks if the user is conscious.

contained_state

tgui state: contained_state

Checks that the user is inside the src_object.

conveyors_by_id

List of all used conveyors and switches by id

current_observers_list

All observers with clients that joined as observers.

dead_player_list

All dead mobs with clients. Does not include observers.

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

dna_activity_bounds

DNA 2: The Spaghetti Strikes Back

@author N3X15 nexisentertainment@gmail.com

dug_up_basalt

Used by ashstorms to replenish basalt tiles that have been dug up without going through all of them.

dye_registry

Dye registry, add dye colors and their resulting output here if you want the sprite to change instead of just the color.

em_mask_matrix

A globaly cached version of EM_MASK_MATRIX for quick access.

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.

fullbright_overlays

List of plane offset + 1 -> mutable appearance to use Fills with offsets as they are generated

ghost_hud_panel

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

glide_size_multiplier

Compensating for time dilation

global_trait_name_map

value -> trait name, list of ALL traits that exist in the game, used for any type of accessing.

gravity_generators

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

halo_callbacks

Callback checks for datum/element/halo_attach

halo_overlays

Halo overlays for datum/element/halo_attach

hands_state

tgui state: hands_state

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

hivemind_bank

HIVE MIND UPLOAD/DOWNLOAD DNA

holomap_color_to_name

Used in generating area preview icons.

huds

GLOBAL HUD LIST

huds_by_category

gets filled by each /datum/atom_hud/New(). associative list of the form: list(hud category = list(all global atom huds that use that category))

human_adjacent_state

tgui state: human_adjacent_state

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

icon_dimensions

Cache of the width and height of icon files, to avoid repeating the same expensive operation

inventory_state

tgui state: inventory_state

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

landmarks_list

list of all landmarks created

looping_sounds

List of looping sounds

marker_beacon_colors

Marker Beacons

megafauna_spawn_list

Global list of megafauna spawns on cave gen

modulo_angle_to_dir

Converts an angle (degrees) into an ss13 direction

multiverse

Multiverse Blade

news_network

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

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.

nutrition_levels

List of all /datum/nutrition_level

observer_state

tgui state: observer_state

Checks that the user is an observer/ghost.

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.

pillars_by_z

List of z pillars (datums placed in the bottom left of XbyX squares that control transparency in that space) The pillars are stored in triple depth lists indexed by (world_size % pillar_size) + 1 They are created at transparent turf request, and deleted when no turfs remain

poll_options

All poll option datums of running polls

polls

All currently running polls held as datums

possible_changeling_IDs

Changeling aliases.

see_through_maps

global statics for the see_through_component coordinate maps For ease of use, include a comment in the shape of the coordinate map, where O is nothing, X is a hidden tile and A is the object List-coordinate layout is list(relative_x, relative_y, relative_z) Turf finding algorithm needs the z and you can totally use it, but I can't think of any reason to ever do it Also it'd be really cool if you could keep the list-coordinates in here represent their actual relative coords, dont use tabs though since their spacing can differ

self_state

tgui state: self_state

Only checks that the user and src_object are the same.

sfx_datum_by_key

Assoc list of datum by key. Initialized in SSsounds init. k = SFX_KEY (see below) v = singleton sound_effect datum ref

simple_animals

One for each AI_* status define, List of all simple animals, including clientless

sortedAreas

Used by jump-to-area etc. Updated by area/updateName() If this is null, it needs to be recalculated. Use get_sorted_areas() as a getter please

start_landmarks_list

list of all job spawn points created

station_fire_alarms

A list of fire alarms on the station, separated by Z. Used cause there are a lot of fire alarms on any given station Z.

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

things_to_shock

Things that we want to shock.

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() 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

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

List of all uplinks in the world.

z_state

tgui state: z_state

Only checks that the Z-level of the user and src_object are the same.