Paradise 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
acid_overlayACID
admin_mutes_assocAssociative list of people who are muted via admin mutes
admin_statetgui state: admin_state
allNewscastersGlobal list that contains all existing newscasters in the world.
always_statetgui state: always_state
centcomm_store
configurationGlobal configuration datum holder for all the config sections
conscious_statetgui state: conscious_state
contained_statetgui state: contained_state
debug2Enable debugging of things such as job starts and other things
deep_inventory_statetgui state: deep_inventory_state
default_statetgui state: default_state
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?
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.
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
looc_enabledIs LOOC currently enabled?
marker_beacon_colorsMarker Beacons
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)
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_statetgui state: physical_state
self_statetgui state: self_state
slower_restartWill our restart be slower?
tcomms_machinesGlobal list for all telecomms machines in the world
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
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
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

acid_overlay

ACID

admin_mutes_assoc

Associative list of people who are muted via admin mutes

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.

always_state

tgui state: always_state

Always grants the user STATUS_INTERACTIVE. Period.

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.

configuration

Global configuration datum holder for all the config sections

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.

debug2

Enable debugging of things such as job starts and other things

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.

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?

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.

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

looc_enabled

Is LOOC currently enabled?

marker_beacon_colors

Marker Beacons

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)

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_state

tgui state: physical_state

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

self_state

tgui state: self_state

Only checks that the user and src_object are the same.

slower_restart

Will our restart be slower?

tcomms_machines

Global list for all telecomms machines in the world

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

z_state

tgui state: z_state

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