(global)

Vars
Failsafe	Failsafe
MAX_EXPLOSION_RANGE	This was a define, but I changed it to a variable so it can be changed in-game.(kept the all-caps definition because... code...) -Errorage
Master	StonedMC
SSminimaps
SSpager_status	Updates BYOND pager status periodically
SSstats_collector	Collects simple round statistics periodically
SStgui	tgui subsystem
SStimer
deployed_fultons	A list of fultons currently airborne.
fallen_list_cross	This is for dogtags placed on crosses- they will show up at the end-round memorial.
note_categories	Note categories in text form, in order of their numerical #defines.
obfs_x	A number between -500 and 500.
obfs_y	A number between -500 and 500.
secret_force_mode	If this is anything but "secret", the secret rotation will forceably choose this mode.
Procs
CreateBans	DEBUG
HandleUserlessProcCall	Handles a userless proccall, used by circuits.
HandleUserlessSDQL	Handles a userless sdql, used by TGS.
TurfBlockedNonWindow	the actual dir between the start and target turf The direction that mover's path is being blocked by
WrapAdminProcCall	Wrapper for proccalls where the datum is flagged as vareditted
______qdel_list_wrapper	the underscores are to encourage people not to use this directly.
_addtimer	Create a new timer and insert it in the queue. You should not call this directly, and should instead use the addtimer macro, which includes source information.
_animate_filter	Auxtools REALLY doesn't know how to handle filters as values; when passed as arguments to auxtools-called procs, they aren't simply treated as nulls - they don't even count towards the length of args. For example, calling some_proc([a filter], foo, bar) from auxtools is equivalent to calling some_proc(foo, bar). Thus, we can't use _animate directly on filters. Use this to perform animation steps on a filter. Consecutive steps on the same filter can be achieved by calling _animate with no target.
_pick_list	Allow me to explain for some reason, if pick() is passed arglist(args) directly and args contains only one list it considers it to be a list of lists this means something like _pick(list) would fail need to do this instead
add_keybinding	Adds an instanced keybinding to the global tracker
add_verb	handles adding verbs and updating the stat panel browser
admin_ticket_log	Use this proc when an admin takes action that may be related to an open ticket on what what can be a client, ckey, or mob player_message: If the message should be shown in the player ticket panel, fill this out log_in_blackbox: Whether or not this message with the blackbox system. If disabled, this message should be logged with a different proc call
anyprob	chances are 1:value. anyprob(1) will always return true
at_least	Takes a value, and a threshold it has to at least match returns the correctly signed value max'd to the threshold
bit_count	counts the number of bits in Byond's 16-bit width field, in constant time and memory!
bitfield_to_list	Converts a bitfield to a list of numbers (or words if a wordlist is provided)
capitalize_first_letters	Finds the first letter of each word in the provided string and capitalize them
center_image	Center's an image. Requires: The Image The x dimension of the icon file used in the image The y dimension of the icon file used in the image eg: center_image(image_to_center, 32,32) eg2: center_image(image_to_center, 96,96)
check_asay_links	Checks a given message to see if any of the words are something we want to treat specially, as detailed below.
color_matrix_from_string	Converts a hex color string to a color matrix.
color_matrix_recolor_red	Creates a matrix to re-paint a sprite, replacing shades of red with corresponding shades of a new color. In the base sprite, Hue must always be pure red. Saturation and Lightness can be anything. Arg is a hex string for a color. Proc is by Lummox JR, www.byond.com/forum/post/2209545 color_matrix_recolor_rgb is more complex, but gives more precise control over the palette, at least if using 3 or fewer colours.
color_matrix_recolor_rgb	Creates a matrix to re-paint a sprite, replacing pure red, green, and blue with 3 different shades. Doesn't work with mixed tones of RGB or whites or greys -- must be pure. R/G/B 255 becomes the new color, darker shades become correspondingly darker. The arg is a list of hex colours, for ex "list("#d4c218", "#b929f7", "#339933"". if you want variations of the same color, color_matrix_recolor_red() is simpler.
debug_variable	Get displayed variable in VV variable list
default_ui_state	The sane defaults for a UI such as a computer or a machine.
delete_all_SS_and_recreate_master	Delete all existing SS to basically start over
deltimer	Delete a timer
display_power	Format a power value in W, kW, MW, or GW.
end_cooldown	Callback called by a timer to end an associative-list-indexed cooldown.
flick_overlay_to_clients	Add an image to a list of clients and calls a proc to remove it after a duration
generate_asset_name	Generate a filename for this asset The same asset will always lead to the same asset name (Generated names do not include file extention.)
generate_bitfields	Turns /datum/bitfield subtypes into a list for use in debugging
getFlatIcon	Create a single /icon from a given /atom or /image.
get_active_player_count	Get active players who are playing in the round
get_angle	Calculate the angle between two movables and the west\|east coordinate
get_angle_raw	Angle between two arbitrary points and horizontal line same as /proc/get_angle
get_bbox_of_atoms	Get a bounding box of a list of atoms.
get_line	Get a list of turfs in a line from `starting_atom` to `ending_atom`.
get_pixel_angle	for getting the angle when animating something's pixel_x and pixel_y
get_pixel_position_x	Gives X position on pixel grid of an object, accounting for offsets
get_pixel_position_y	Gives Y position on pixel grid of an object, accounting for offsets
get_radios_in_view	only gets FUNCTIONING radios
getpois	Returns a list of all items of interest with their name
give_action	Gives an action to a mob and returns it
icon_exists	Checks if the given iconstate exists in the given file, caching the result. Setting scream to TRUE will print a stack trace ONCE.
init_keybindings	Creates and sorts all the keybinding datums
initiate_surgery_moment	Does the surgery initiation. Returns TRUE if the triggering attack should be halted.
is_valid_src	Check if a datum has not been deleted and is a valid source
list_clear_nulls	Removes any null entries from the list Returns TRUE if the list had nulls, FALSE otherwise
load_map	Shortcut function to parse a map and apply it to the world.
log_tgui	Appends a tgui-related log entry. All arguments are optional.
make_tuple	Returns the name of the mathematical tuple of same length as the number arg (rounded down).
map_pill_icons	Pills.
md5asfile	Save file as an external file then md5 it. Used because md5ing files stored in the rsc sometimes gives incorrect md5 results.
mergeListsSum	Sums values in two associative lists, from mergee into result, in place
message_to_html	Message-related procs
mutable_appearance	Helper similar to image()
pick_n_take	Pick a random element from the list and remove it from the list.
pick_weight	Picks a random element from a list based on a weighting system. For example, given the following list: A = 6, B = 3, C = 1, D = 0 A would have a 60% chance of being picked, B would have a 30% chance of being picked, C would have a 10% chance of being picked, and D would have a 0% chance of being picked. You should only pass integers in.
playsound_area	Plays sound to all mobs that are map-level contents of an area
playsound_z	Play sound for all on-map clients on a given Z-level. Good for ambient sounds.
qdel	Should be treated as a replacement for the 'del' keyword.
recover_all_SS_and_recreate_master	Recreate all SSs which will still cause data survive due to Recover(), the new Master will then find and take them from global.vars
recursive_holder_check	Will attempt to find what's holding this item if it's being contained by something, ie if it's in a satchel held by a human, this'll return the human
remove_image_from_client	Removes an image from a client's `.images`. Useful as a callback.
remove_images_from_clients	Like remove_image_from_client, but will remove the image from a list of clients
remove_verb	handles removing verb and sending it to browser to update, use this for removing verbs
reset_cooldown	Proc used by stoppable timers to end a cooldown before the time has ran out.
return_generator_args	returns the arguments given to a generator and manually extracts them from the internal byond object returns:
reverse_range	replaces reverseList ~Carnie
send2adminchat	Sends a message to TGS admin chat channels.
send2chat	Sends a message to TGS chat channels.
show_blurb	*Shows a ticker reading out the given text on a client's screen. targets = mob or list of mobs to show it to.
show_blurb_uscm	Shows operation start blurb to living marines. Slightly different for squad marines, pilots, and deploying ship crew/passengers. exempt_ztraits = trait or list of traits of zlevels where any marines don't see the message, ex. marine faction survivors colonyside shouldn't see the ship marines' drop message. Ex. ZTRAIT_GROUND by default. unit = the unit the marines are from. FF, Dust Raiders etc. Military crew see this. base = the base the marines are staging from. The ship, Whiskey Outpost etc. Noncombat crew see this.
show_location_blurb	Reads out a description of game time, game date, main ship and current area. Originally for displaying roundstart messages on a conventional SS13 server.
shuffle_inplace	same as shuffle, but returns nothing and acts on list in place
sort_list	sort any value in a list
tgui_Topic	Middleware for /client/Topic.
tgui_alert	Creates a TGUI alert window and returns the user's response.
tgui_alert_async	Creates an asynchronous TGUI alert window with an associated callback.
tgui_input_list	Creates a TGUI input list window and returns the user's response.
tgui_input_list_async	Creates an asynchronous TGUI input list window with an associated callback.
tgui_input_number	Creates a TGUI window with a number input. Returns the user's response as num \| null.
tgui_input_number_async	Creates an asynchronous TGUI number input window with an associated callback.
tgui_input_real_number	A clone of tgui_input_number that defaults to accepting negative inputs too.
tgui_input_text	Creates a TGUI window with a text input. Returns the user's response.
timeleft	Get the remaining deciseconds on a timer
to_chat	Sends the message to the recipient (target).
to_chat_immediate	Circumvents the message queue and sends the message to the recipient (target) as soon as possible.
ui_status_only_living	Returns a UI status such that the dead will be able to watch, but not interact.
ui_status_user_is_abled	Returns a UI status such that users with debilitating conditions, such as being dead or not having power for silicons, will not be able to interact. Being dead will disable UI, being incapacitated will continue updating it, and anything else will make it interactive.
ui_status_user_is_adjacent	Returns a UI status such that users adjacent to source will be able to interact, far away users will be able to see, and anyone farther won't see anything. Dead users will receive updates no matter what, though you likely want to add a [`ui_status_only_living`] check for finer observer interactions.
ui_status_user_is_advanced_tool_user	Returns a UI status such that advanced tool users will be able to interact, but everyone else can only watch.
ui_status_user_is_conscious_and_lying_down	Returns UI_INTERACTIVE if the user is conscious and lying down. Returns UI_UPDATE otherwise.
ui_status_user_strictly_adjacent	Return UI_INTERACTIVE if the user is strictly adjacent to the target atom, whether they can see it or not. Return UI_CLOSE otherwise.
unique_list	Return a list with no duplicate entries
unique_list_in_place	same as unique_list, but returns nothing and acts on list in place (also handles associated values properly)
updatetimedelay	Update the delay on an existing LOOPING timer Will come into effect on the next process
url2htmlloader	Return html to load a url. for use inside of browse() calls to html assets that might be loaded on a cdn.
worldtime2text	Returns the world time in english. Do not use to get date information - starts at 0 + 12 hours.

Var Details

var
Failsafe
– /static/datum/controller/failsafe

Failsafe

Pretty much pokes the MC to make sure it's still alive.

var
MAX_EXPLOSION_RANGE
–

This was a define, but I changed it to a variable so it can be changed in-game.(kept the all-caps definition because... code...) -Errorage

var
Master
– /static/datum/controller/master

StonedMC

Designed to properly split up a given tick among subsystems Note: if you read parts of this code and think "why is it doing it that way" Odds are, there is a reason

var
SSminimaps
– /static/datum/controller/subsystem/minimaps

Minimaps subsystem

Handles updating and handling of the by-zlevel minimaps

Minimaps are a low priority subsystem that fires relatively often the Initialize proc for this subsystem draws the maps as one of the last initializing subsystems

Fire() for this subsystem doesn't actually update anything, and purely just reapplies the overlays that it already tracks actual updating of marker locations is handled by /datum/controller/subsystem/minimaps/proc/on_move and zlevel changes are handled in /datum/controller/subsystem/minimaps/proc/on_z_change tracking of the actual atoms you want to be drawn on is done by means of datums holding info pertaining to them with /datum/hud_displays

var
SSpager_status
– /static/datum/controller/subsystem/pager_status

Updates BYOND pager status periodically

var
SSstats_collector
– /static/datum/controller/subsystem/stats_collector

Collects simple round statistics periodically

var
SStgui
– /static/datum/controller/subsystem/tgui

tgui subsystem

Contains all tgui state and subsystem code.

var
SStimer
– /static/datum/controller/subsystem/timer

Timer Subsystem

Handles creation, callbacks, and destruction of timed events.

It is important to understand the buckets used in the timer subsystem are just a series of doubly-linked lists. The object at a given index in bucket_list is a /datum/timedevent, the head of a list, which has prev and next references for the respective elements in that bucket's list.

var
deployed_fultons
– /static/list

A list of fultons currently airborne.

var
fallen_list_cross
– /list

This is for dogtags placed on crosses- they will show up at the end-round memorial.

var
note_categories
– /static/list

Note categories in text form, in order of their numerical #defines.

var
obfs_x
– /static

A number between -500 and 500.

var
obfs_y
– /static

A number between -500 and 500.

var
secret_force_mode
–

If this is anything but "secret", the secret rotation will forceably choose this mode.

Proc Details

proc
CreateBans
()

DEBUG

proc
HandleUserlessProcCall
(user, /datum/target, procname, /list/arguments)

Handles a userless proccall, used by circuits.

Arguments:

user - a string used to identify the user
target - the target to proccall on
proc - the proc to call
arguments - any arguments

proc
HandleUserlessSDQL
(user, query_text)

Handles a userless sdql, used by TGS.

Arguments:

user - a string used to identify the user
query_text - the query text

proc
TurfBlockedNonWindow
(/turf/loc)

the actual dir between the start and target turf The direction that mover's path is being blocked by

proc
WrapAdminProcCall
(/datum/target, procname, /list/arguments)

Wrapper for proccalls where the datum is flagged as vareditted

proc
______qdel_list_wrapper
(/list/L)

the underscores are to encourage people not to use this directly.

proc
_addtimer
(/datum/callback/callback, wait, flags, /datum/controller/subsystem/timer/timer_subsystem, file, line)

Create a new timer and insert it in the queue. You should not call this directly, and should instead use the addtimer macro, which includes source information.

Arguments:

callback the callback to call on timer finish
wait deciseconds to run the timer for
flags flags for this timer, see: code__DEFINES\subsystems.dm
timer_subsystem the subsystem to insert this timer into

proc
_animate_filter
(/atom/target, filter_index, set_vars, time, loop, easing, flags)

Auxtools REALLY doesn't know how to handle filters as values; when passed as arguments to auxtools-called procs, they aren't simply treated as nulls - they don't even count towards the length of args. For example, calling some_proc([a filter], foo, bar) from auxtools is equivalent to calling some_proc(foo, bar). Thus, we can't use _animate directly on filters. Use this to perform animation steps on a filter. Consecutive steps on the same filter can be achieved by calling _animate with no target.

proc
_pick_list
(/list/pick_from)

Allow me to explain for some reason, if pick() is passed arglist(args) directly and args contains only one list it considers it to be a list of lists this means something like _pick(list) would fail need to do this instead

I hate this timeline

proc
add_keybinding
(/datum/keybinding/instance)

Adds an instanced keybinding to the global tracker

proc
add_verb
(/client/target, verb_or_list_to_add)

handles adding verbs and updating the stat panel browser

pass the verb type path to this instead of adding it directly to verbs so the statpanel can update Arguments:

target - Who the verb is being added to, client or mob typepath
verb - typepath to a verb, or a list of verbs, supports lists of lists

proc
admin_ticket_log
(what, message, player_message, log_in_blackbox)

Use this proc when an admin takes action that may be related to an open ticket on what what can be a client, ckey, or mob player_message: If the message should be shown in the player ticket panel, fill this out log_in_blackbox: Whether or not this message with the blackbox system. If disabled, this message should be logged with a different proc call

proc
anyprob
(value)

chances are 1:value. anyprob(1) will always return true

proc
at_least
(new_value, threshold)

Takes a value, and a threshold it has to at least match returns the correctly signed value max'd to the threshold

proc
bit_count
(bit_field)

counts the number of bits in Byond's 16-bit width field, in constant time and memory!

proc
bitfield_to_list
(bitfield, /list/wordlist)

Converts a bitfield to a list of numbers (or words if a wordlist is provided)

proc
capitalize_first_letters
(string)

Finds the first letter of each word in the provided string and capitalize them

proc
center_image
(/image/image_to_center, x_dimension, y_dimension)

Center's an image. Requires: The Image The x dimension of the icon file used in the image The y dimension of the icon file used in the image eg: center_image(image_to_center, 32,32) eg2: center_image(image_to_center, 96,96)

proc
check_asay_links
(msg)

Checks a given message to see if any of the words are something we want to treat specially, as detailed below.

There are 3 cases where a word is something we want to act on

Admin pings, like @adminckey. Pings the admin in question, text is not clickable
Datum refs, like @0x2001169 or @mob_23. Clicking on the link opens up the VV for that datum
Ticket refs, like #3. Displays the status and ahelper in the link, clicking on it brings up the ticket panel for it. Returns a list being used as a tuple. Index ASAY_LINK_NEW_MESSAGE_INDEX contains the new message text (with clickable links and such) while index ASAY_LINK_PINGED_ADMINS_INDEX contains a list of pinged admin clients, if there are any.

Arguments:

msg - the message being scanned

proc
color_matrix_from_string
(string)

Converts a hex color string to a color matrix.

proc
color_matrix_recolor_red
(new_color)

Creates a matrix to re-paint a sprite, replacing shades of red with corresponding shades of a new color. In the base sprite, Hue must always be pure red. Saturation and Lightness can be anything. Arg is a hex string for a color. Proc is by Lummox JR, www.byond.com/forum/post/2209545 color_matrix_recolor_rgb is more complex, but gives more precise control over the palette, at least if using 3 or fewer colours.

proc
color_matrix_recolor_rgb
(/list/replacement_shades)

Creates a matrix to re-paint a sprite, replacing pure red, green, and blue with 3 different shades. Doesn't work with mixed tones of RGB or whites or greys -- must be pure. R/G/B 255 becomes the new color, darker shades become correspondingly darker. The arg is a list of hex colours, for ex "list("#d4c218", "#b929f7", "#339933"". if you want variations of the same color, color_matrix_recolor_red() is simpler.

proc
debug_variable
(name, value, level, /datum/D, sanitize)

Get displayed variable in VV variable list

proc
default_ui_state
(/mob/user, /atom/source)

The sane defaults for a UI such as a computer or a machine.

proc
delete_all_SS_and_recreate_master
()

Delete all existing SS to basically start over

proc
deltimer
(id, /datum/controller/subsystem/timer/timer_subsystem)

Delete a timer

Arguments:

id a timerid or a /datum/timedevent

proc
display_power
(powerused)

Format a power value in W, kW, MW, or GW.

proc
end_cooldown
(/datum/source, index)

Callback called by a timer to end an associative-list-indexed cooldown.

Arguments:

source - datum storing the cooldown
index - string index storing the cooldown on the cooldowns associative list

This sends a signal reporting the cooldown end.

proc
flick_overlay_to_clients
(/image/image_to_show, /list/show_to, duration)

Add an image to a list of clients and calls a proc to remove it after a duration

proc
generate_asset_name
(file)

Generate a filename for this asset The same asset will always lead to the same asset name (Generated names do not include file extention.)

proc
generate_bitfields
()

Turns /datum/bitfield subtypes into a list for use in debugging

proc
getFlatIcon
(/image/A, defdir, deficon, defstate, defblend, start, no_anim)

Create a single /icon from a given /atom or /image.

Very low-performance. Should usually only be used for HTML, where BYOND's appearance system (overlays/underlays, etc.) is not available.

Only the first argument is required.

proc
get_active_player_count
(alive_check, afk_check, faction_check, faction)

Get active players who are playing in the round

proc
get_angle
(/atom/movable/start, /atom/movable/end)

Calculate the angle between two movables and the west|east coordinate

proc
get_angle_raw
(start_x, start_y, start_pixel_x, start_pixel_y, end_x, end_y, end_pixel_x, end_pixel_y)

Angle between two arbitrary points and horizontal line same as /proc/get_angle

proc
get_bbox_of_atoms
(/list/atoms)

Get a bounding box of a list of atoms.

Arguments:

atoms - List of atoms. Can accept output of view() and range() procs.

Returns: list(x1, y1, x2, y2)

proc
get_line
(/atom/starting_atom, /atom/ending_atom)

Get a list of turfs in a line from starting_atom to ending_atom.

Uses the ultra-fast Bresenham Line-Drawing Algorithm.

proc
get_pixel_angle
(y, x)

for getting the angle when animating something's pixel_x and pixel_y

proc
get_pixel_position_x
(/atom/subject, relative)

Gives X position on pixel grid of an object, accounting for offsets

proc
get_pixel_position_y
(/atom/subject, relative)

Gives Y position on pixel grid of an object, accounting for offsets

proc
get_radios_in_view
(R, /atom/source)

only gets FUNCTIONING radios

proc
getpois
(mobs_only, skip_mindless, specify_dead_role)

Returns a list of all items of interest with their name

proc
give_action
(/mob/L, action_path, ...)

Gives an action to a mob and returns it

If mob already has the action, unhide it if it's hidden

Can pass additional initialization args

proc
icon_exists
(file, state, scream)

Checks if the given iconstate exists in the given file, caching the result. Setting scream to TRUE will print a stack trace ONCE.

proc
init_keybindings
()

Creates and sorts all the keybinding datums

proc
initiate_surgery_moment
(/obj/item/tool, /mob/living/carbon/target, /obj/limb/affecting, /mob/living/user)

Does the surgery initiation. Returns TRUE if the triggering attack should be halted.

proc
is_valid_src
(/datum/source_datum)

Check if a datum has not been deleted and is a valid source

proc
list_clear_nulls
(/list/list_to_clear)

Removes any null entries from the list Returns TRUE if the list had nulls, FALSE otherwise

proc
load_map
(dmm_file, x_offset, y_offset, z_offset, cropMap, measureOnly, no_changeturf, x_lower, x_upper, y_lower, y_upper, placeOnTop)

Shortcut function to parse a map and apply it to the world.

dmm_file: A .dmm file to load (Required).
x_offset, y_offset, z_offset: Positions representign where to load the map (Optional).
cropMap: When true, the map will be cropped to fit the existing world dimensions (Optional).
measureOnly: When true, no changes will be made to the world (Optional).
no_changeturf: When true, turf/AfterChange won't be called on loaded turfs
x_lower, x_upper, y_lower, y_upper: Coordinates (relative to the map) to crop to (Optional).
placeOnTop: Whether to use turf/PlaceOnTop rather than turf/ChangeTurf (Optional).

proc
log_tgui
(user, message, context, /datum/tgui_window/window, /datum/src_object)

Appends a tgui-related log entry. All arguments are optional.

proc
make_tuple
(number)

Returns the name of the mathematical tuple of same length as the number arg (rounded down).

proc
map_pill_icons
()

Pills.

Returns a list mapping pill icon classes to icon states

proc
md5asfile
(file)

Save file as an external file then md5 it. Used because md5ing files stored in the rsc sometimes gives incorrect md5 results.

proc
mergeListsSum
(/list/result, /list/mergee)

Sums values in two associative lists, from mergee into result, in place

proc
message_to_html
(message)

Message-related procs

Message format (/list):

type - Message type, must be one of defines in code/__DEFINES/chat.dm
text - Plain message text
html - HTML message text
Optional metadata, can be any key/value pair.

proc
mutable_appearance
(icon, icon_state, layer, plane, alpha, appearance_flags)

Helper similar to image()

proc
pick_n_take
(/list/L)

Pick a random element from the list and remove it from the list.

proc
pick_weight
(/list/list_to_pick)

Picks a random element from a list based on a weighting system. For example, given the following list: A = 6, B = 3, C = 1, D = 0 A would have a 60% chance of being picked, B would have a 30% chance of being picked, C would have a 10% chance of being picked, and D would have a 0% chance of being picked. You should only pass integers in.

proc
playsound_area
(/area/A, soundin, vol, channel, status, vol_cat, /list/echo, y_s_offset, x_s_offset)

Plays sound to all mobs that are map-level contents of an area

proc
playsound_z
(z, soundin, volume, vol_cat, echo, y_s_offset, x_s_offset)

Play sound for all on-map clients on a given Z-level. Good for ambient sounds.

proc
qdel
(/datum/D, force, ...)

Should be treated as a replacement for the 'del' keyword.

Datums passed to this will be given a chance to clean up references to allow the GC to collect them.

proc
recover_all_SS_and_recreate_master
()

Recreate all SSs which will still cause data survive due to Recover(), the new Master will then find and take them from global.vars

proc
recursive_holder_check
(/obj/item/held_item, recursion_limit)

Will attempt to find what's holding this item if it's being contained by something, ie if it's in a satchel held by a human, this'll return the human

proc
remove_image_from_client
(/image/image_to_remove, /client/remove_from)

Removes an image from a client's .images. Useful as a callback.

proc
remove_images_from_clients
(/image/image_to_remove, /list/show_to)

Like remove_image_from_client, but will remove the image from a list of clients

proc
remove_verb
(/client/target, verb_or_list_to_remove)

handles removing verb and sending it to browser to update, use this for removing verbs

pass the verb type path to this instead of removing it from verbs so the statpanel can update Arguments:

target - Who the verb is being removed from, client or mob typepath
verb - typepath to a verb, or a list of verbs, supports lists of lists

proc
reset_cooldown
(/datum/source, index)

Proc used by stoppable timers to end a cooldown before the time has ran out.

Arguments:

source - datum storing the cooldown
index - string index storing the cooldown on the cooldowns associative list

This sends a signal reporting the cooldown end, passing the time left as an argument.

proc
return_generator_args
(/generator/target)

returns the arguments given to a generator and manually extracts them from the internal byond object returns:

flat list of strings for args given to the generator.
Note: this means things like "list(1,2,3)" will need to be processed

proc
reverse_range
(/list/inserted_list, start, end)

replaces reverseList ~Carnie

proc
send2adminchat
(category, message, embed_links)

Sends a message to TGS admin chat channels.

category - The category of the mssage. message - The message to send.

proc
send2chat
(message, channel_tag, admin_only)

Sends a message to TGS chat channels.

message - The message to send. channel_tag - Required. If "", the message with be sent to all connected (Game-type for TGS3) channels. Otherwise, it will be sent to TGS4 channels with that tag (Delimited by ','s). admin_only - Determines if this communication can only be sent to admin only channels.

proc
show_blurb
(/list/mob/targets, duration, message, scroll_down, screen_position, text_alignment, text_color, blurb_key, ignore_key, speed)

*Shows a ticker reading out the given text on a client's screen. targets = mob or list of mobs to show it to.

duration = how long it lingers after it finishes ticking.

message = the message to display. Due to using maptext it isn't very flexible format-wise. 11px font, up to 480 pixels per line. Use \n for line breaks. Single-character HTML tags (, , etc.) are handled correctly but others display strangely. Note that maptext can display text macros in strange ways, ex. \improper showing as "Ã¿". Lines containing only spaces, including ones only containing "\improper ", don't display.

scroll_down = by default each line pushes the previous line upwards - this tells it to start high and scroll down. Ticks on \n - does not autodetect line breaks in long strings.

screen_position = screen loc for the bottom-left corner of the blurb.

text_alignment = "right", "left", or "center"

text_color = color of the text.

blurb_key = a key used for specific blurb types so they are not shown repeatedly. Ex. someone who joins as CLF repeatedly only seeing the mission blurb the first time.

ignore_key = used to skip key checks. Ex. a USCM ERT member shouldn't see the normal USCM drop message, but should see their own spawn message even if the player already dropped as USCM.*
proc
show_blurb_uscm
(/list/exempt_ztraits, unit, base)

Shows operation start blurb to living marines. Slightly different for squad marines, pilots, and deploying ship crew/passengers. exempt_ztraits = trait or list of traits of zlevels where any marines don't see the message, ex. marine faction survivors colonyside shouldn't see the ship marines' drop message. Ex. ZTRAIT_GROUND by default. unit = the unit the marines are from. FF, Dust Raiders etc. Military crew see this. base = the base the marines are staging from. The ship, Whiskey Outpost etc. Noncombat crew see this.
proc
show_location_blurb
(/list/mob/targets, /area/A, duration)

Reads out a description of game time, game date, main ship and current area. Originally for displaying roundstart messages on a conventional SS13 server.
proc
shuffle_inplace
(/list/inserted_list)

same as shuffle, but returns nothing and acts on list in place
proc
sort_list
(/list/list_to_sort, cmp)

sort any value in a list
proc
tgui_Topic
(href_list)

Middleware for /client/Topic.

return bool If TRUE, prevents propagation of the topic call.
proc
tgui_alert
(/mob/user, message, title, /list/buttons, timeout)

Creates a TGUI alert window and returns the user's response.

This proc should be used to create alerts that the caller will wait for a response from. Arguments:

user - The user to show the alert to.

message - The content of the alert, shown in the body of the TGUI window.

title - The of the alert modal, shown on the top of the TGUI window.

buttons - The options that can be chosen by the user, each string is assigned a button on the UI.

timeout - The timeout of the alert, after which the modal will close and qdel itself. Set to zero for no timeout.

proc
tgui_alert_async
(/mob/user, message, title, /list/buttons, /datum/callback/callback, timeout)

Creates an asynchronous TGUI alert window with an associated callback.

This proc should be used to create alerts that invoke a callback with the user's chosen option. Arguments:

user - The user to show the alert to.

message - The content of the alert, shown in the body of the TGUI window.

title - The of the alert modal, shown on the top of the TGUI window.

buttons - The options that can be chosen by the user, each string is assigned a button on the UI.

callback - The callback to be invoked when a choice is made.

timeout - The timeout of the alert, after which the modal will close and qdel itself. Set to zero for no timeout.

proc
tgui_input_list
(/mob/user, message, title, /list/buttons, timeout, theme)

Creates a TGUI input list window and returns the user's response.

This proc should be used to create alerts that the caller will wait for a response from. Arguments:

user - The user to show the alert to.

message - The content of the alert, shown in the body of the TGUI window.

title - The title of the list input, shown on the top of the TGUI window.

buttons - The options that can be chosen by the user, each string is assigned a button on the UI.

timeout - The timeout of the alert, after which the list input will close and qdel itself. Set to zero for no timeout.

theme - The ui theme to use for the TGUI window.

proc
tgui_input_list_async
(/mob/user, message, title, /list/buttons, /datum/callback/callback, timeout, theme)

Creates an asynchronous TGUI input list window with an associated callback.

This proc should be used to create inputs that invoke a callback with the user's chosen option. Arguments:

user - The user to show the alert to.

message - The content of the alert, shown in the body of the TGUI window.

title - The of the alert modal, shown on the top of the TGUI window.

buttons - The options that can be chosen by the user, each string is assigned a button on the UI.

callback - The callback to be invoked when a choice is made.

timeout - The timeout of the alert, after which the modal will close and qdel itself. Set to zero for no timeout.

theme - The ui theme to use for the TGUI window.

proc
tgui_input_number
(/mob/user, message, title, default, max_value, min_value, timeout, integer_only)

Creates a TGUI window with a number input. Returns the user's response as num | null.

This proc should be used to create windows for number entry that the caller will wait for a response from. If tgui fancy chat is turned off: Will return a normal input. If a max or min value is specified, will validate the input inside the UI and ui_act.

Arguments:

user - The user to show the number input to.

message - The content of the number input, shown in the body of the TGUI window.

title - The title of the number input modal, shown on the top of the TGUI window.

default - The default (or current) value, shown as a placeholder. Users can press refresh with this.

max_value - Specifies a maximum value. If none is set, any number can be entered. Pressing "max" defaults to 1000.

min_value - Specifies a minimum value. Often 0.

timeout - The timeout of the number input, after which the modal will close and qdel itself. Set to zero for no timeout.

proc
tgui_input_number_async
(/mob/user, message, title, default, max_value, min_value, /datum/callback/callback, timeout)

Creates an asynchronous TGUI number input window with an associated callback.

This proc should be used to create number inputs that invoke a callback with the user's entry.

Arguments:

user - The user to show the number input to.

message - The content of the number input, shown in the body of the TGUI window.

title - The title of the number input modal, shown on the top of the TGUI window.

default - The default (or current) value, shown as a placeholder. Users can press refresh with this.

max_value - Specifies a maximum value. If none is set, any number can be entered. Pressing "max" defaults to 1000.

min_value - Specifies a minimum value. Often 0.

callback - The callback to be invoked when a choice is made.

timeout - The timeout of the number input, after which the modal will close and qdel itself. Set to zero for no timeout.

proc
tgui_input_real_number
(/mob/user, message, title, default, max_value, min_value, timeout, integer_only)

A clone of tgui_input_number that defaults to accepting negative inputs too.
proc
tgui_input_text
(/mob/user, message, title, default, max_length, multiline, encode, timeout)

Creates a TGUI window with a text input. Returns the user's response.

This proc should be used to create windows for text entry that the caller will wait for a response from. If tgui fancy chat is turned off: Will return a normal input. If max_length is specified, will return stripped_multiline_input.

Arguments:

user - The user to show the text input to.

message - The content of the text input, shown in the body of the TGUI window.

title - The title of the text input modal, shown on the top of the TGUI window.

default - The default (or current) value, shown as a placeholder.

max_length - Specifies a max length for input. MAX_MESSAGE_LEN is default (1024)

multiline - Bool that determines if the input box is much larger. Good for large messages, laws, etc.

encode - Toggling this determines if input is filtered via html_encode. Setting this to FALSE gives raw input.

timeout - The timeout of the textbox, after which the modal will close and qdel itself. Set to zero for no timeout.

proc
timeleft
(id, /datum/controller/subsystem/timer/timer_subsystem)

Get the remaining deciseconds on a timer

Arguments:

id a timerid or a /datum/timedevent

proc
to_chat
(target, html, type, text, avoid_highlighting, handle_whitespace, trailing_newline, confidential)

Sends the message to the recipient (target).

Recommended way to write to_chat calls:

to_chat(client, type = MESSAGE_TYPE_INFO, html = "You have found <strong>[object]</strong>")
proc
to_chat_immediate
(target, html, type, text, avoid_highlighting, handle_whitespace, trailing_newline, confidential)

Circumvents the message queue and sends the message to the recipient (target) as soon as possible.
proc
ui_status_only_living
(/mob/user, source)

Returns a UI status such that the dead will be able to watch, but not interact.
proc
ui_status_user_is_abled
(/mob/user, /atom/source)

Returns a UI status such that users with debilitating conditions, such as being dead or not having power for silicons, will not be able to interact. Being dead will disable UI, being incapacitated will continue updating it, and anything else will make it interactive.
proc
ui_status_user_is_adjacent
(/mob/user, /atom/source, allow_tk)

Returns a UI status such that users adjacent to source will be able to interact, far away users will be able to see, and anyone farther won't see anything. Dead users will receive updates no matter what, though you likely want to add a [ui_status_only_living] check for finer observer interactions.
proc
ui_status_user_is_advanced_tool_user
(/mob/user)

Returns a UI status such that advanced tool users will be able to interact, but everyone else can only watch.
proc
ui_status_user_is_conscious_and_lying_down
(/mob/user)

Returns UI_INTERACTIVE if the user is conscious and lying down. Returns UI_UPDATE otherwise.
proc
ui_status_user_strictly_adjacent
(/mob/user, /atom/target)

Return UI_INTERACTIVE if the user is strictly adjacent to the target atom, whether they can see it or not. Return UI_CLOSE otherwise.
proc
unique_list
(/list/inserted_list)

Return a list with no duplicate entries
proc
unique_list_in_place
(/list/inserted_list)

same as unique_list, but returns nothing and acts on list in place (also handles associated values properly)
proc
updatetimedelay
(id, new_wait, /datum/controller/subsystem/timer/timer_subsystem)

Update the delay on an existing LOOPING timer Will come into effect on the next process

Arguments:

id a timerid or a /datum/timedevent

new_wait the new wait to give this looping timer

proc
url2htmlloader
(url)

Return html to load a url. for use inside of browse() calls to html assets that might be loaded on a cdn.
proc
worldtime2text
(format, time)

Returns the world time in english. Do not use to get date information - starts at 0 + 12 hours.

(global)

Vars

Procs

Var Details

var Failsafe – /static/datum/controller/failsafe

var MAX_EXPLOSION_RANGE –

var Master – /static/datum/controller/master

var SSminimaps – /static/datum/controller/subsystem/minimaps

Minimaps subsystem

var SSpager_status – /static/datum/controller/subsystem/pager_status

var SSstats_collector – /static/datum/controller/subsystem/stats_collector

var SStgui – /static/datum/controller/subsystem/tgui

var SStimer – /static/datum/controller/subsystem/timer

Timer Subsystem

var deployed_fultons – /static/list

var fallen_list_cross – /list

var note_categories – /static/list

var obfs_x – /static

var obfs_y – /static

var secret_force_mode –

Proc Details

proc CreateBans()

proc HandleUserlessProcCall(user, /datum/target, procname, /list/arguments)

proc HandleUserlessSDQL(user, query_text)

proc TurfBlockedNonWindow(/turf/loc)

proc WrapAdminProcCall(/datum/target, procname, /list/arguments)

proc ______qdel_list_wrapper(/list/L)

proc _addtimer(/datum/callback/callback, wait, flags, /datum/controller/subsystem/timer/timer_subsystem, file, line)

proc _animate_filter(/atom/target, filter_index, set_vars, time, loop, easing, flags)

proc _pick_list(/list/pick_from)

proc add_keybinding(/datum/keybinding/instance)

proc add_verb(/client/target, verb_or_list_to_add)

proc admin_ticket_log(what, message, player_message, log_in_blackbox)

proc anyprob(value)

proc at_least(new_value, threshold)

proc bit_count(bit_field)

proc bitfield_to_list(bitfield, /list/wordlist)

proc capitalize_first_letters(string)

proc center_image(/image/image_to_center, x_dimension, y_dimension)

proc check_asay_links(msg)

proc color_matrix_from_string(string)

proc color_matrix_recolor_red(new_color)

proc color_matrix_recolor_rgb(/list/replacement_shades)

proc debug_variable(name, value, level, /datum/D, sanitize)

proc default_ui_state(/mob/user, /atom/source)

proc delete_all_SS_and_recreate_master()

proc deltimer(id, /datum/controller/subsystem/timer/timer_subsystem)

proc display_power(powerused)

proc end_cooldown(/datum/source, index)

proc flick_overlay_to_clients(/image/image_to_show, /list/show_to, duration)

proc generate_asset_name(file)

proc generate_bitfields()

proc getFlatIcon(/image/A, defdir, deficon, defstate, defblend, start, no_anim)

proc get_active_player_count(alive_check, afk_check, faction_check, faction)

proc get_angle(/atom/movable/start, /atom/movable/end)

proc get_angle_raw(start_x, start_y, start_pixel_x, start_pixel_y, end_x, end_y, end_pixel_x, end_pixel_y)

proc get_bbox_of_atoms(/list/atoms)

proc get_line(/atom/starting_atom, /atom/ending_atom)

proc get_pixel_angle(y, x)

proc get_pixel_position_x(/atom/subject, relative)

proc get_pixel_position_y(/atom/subject, relative)

proc get_radios_in_view(R, /atom/source)

proc getpois(mobs_only, skip_mindless, specify_dead_role)

proc give_action(/mob/L, action_path, ...)

proc icon_exists(file, state, scream)

proc init_keybindings()

proc initiate_surgery_moment(/obj/item/tool, /mob/living/carbon/target, /obj/limb/affecting, /mob/living/user)

proc is_valid_src(/datum/source_datum)

proc list_clear_nulls(/list/list_to_clear)

proc load_map(dmm_file, x_offset, y_offset, z_offset, cropMap, measureOnly, no_changeturf, x_lower, x_upper, y_lower, y_upper, placeOnTop)

proc log_tgui(user, message, context, /datum/tgui_window/window, /datum/src_object)

proc make_tuple(number)

proc map_pill_icons()

proc md5asfile(file)

proc mergeListsSum(/list/result, /list/mergee)

proc message_to_html(message)

proc mutable_appearance(icon, icon_state, layer, plane, alpha, appearance_flags)

proc pick_n_take(/list/L)

proc pick_weight(/list/list_to_pick)

proc playsound_area(/area/A, soundin, vol, channel, status, vol_cat, /list/echo, y_s_offset, x_s_offset)

var
Failsafe
– /static/datum/controller/failsafe

var
MAX_EXPLOSION_RANGE
–

var
Master
– /static/datum/controller/master

var
SSminimaps
– /static/datum/controller/subsystem/minimaps

var
SSpager_status
– /static/datum/controller/subsystem/pager_status

var
SSstats_collector
– /static/datum/controller/subsystem/stats_collector

var
SStgui
– /static/datum/controller/subsystem/tgui

var
SStimer
– /static/datum/controller/subsystem/timer

var
deployed_fultons
– /static/list

var
fallen_list_cross
– /list

var
note_categories
– /static/list

var
obfs_x
– /static

var
obfs_y
– /static

var
secret_force_mode
–

proc
CreateBans
()

proc
HandleUserlessProcCall
(user, /datum/target, procname, /list/arguments)

proc
HandleUserlessSDQL
(user, query_text)

proc
TurfBlockedNonWindow
(/turf/loc)

proc
WrapAdminProcCall
(/datum/target, procname, /list/arguments)

proc
______qdel_list_wrapper
(/list/L)

proc
_addtimer
(/datum/callback/callback, wait, flags, /datum/controller/subsystem/timer/timer_subsystem, file, line)

proc
_animate_filter
(/atom/target, filter_index, set_vars, time, loop, easing, flags)

proc
_pick_list
(/list/pick_from)

proc
add_keybinding
(/datum/keybinding/instance)

proc
add_verb
(/client/target, verb_or_list_to_add)

proc
admin_ticket_log
(what, message, player_message, log_in_blackbox)

proc
anyprob
(value)

proc
at_least
(new_value, threshold)

proc
bit_count
(bit_field)

proc
bitfield_to_list
(bitfield, /list/wordlist)

proc
capitalize_first_letters
(string)

proc
center_image
(/image/image_to_center, x_dimension, y_dimension)

proc
check_asay_links
(msg)

proc
color_matrix_from_string
(string)

proc
color_matrix_recolor_red
(new_color)

proc
color_matrix_recolor_rgb
(/list/replacement_shades)

proc
debug_variable
(name, value, level, /datum/D, sanitize)

proc
default_ui_state
(/mob/user, /atom/source)

proc
delete_all_SS_and_recreate_master
()

proc
deltimer
(id, /datum/controller/subsystem/timer/timer_subsystem)

proc
display_power
(powerused)

proc
end_cooldown
(/datum/source, index)

proc
flick_overlay_to_clients
(/image/image_to_show, /list/show_to, duration)

proc
generate_asset_name
(file)

proc
generate_bitfields
()

proc
getFlatIcon
(/image/A, defdir, deficon, defstate, defblend, start, no_anim)

proc
get_active_player_count
(alive_check, afk_check, faction_check, faction)

proc
get_angle
(/atom/movable/start, /atom/movable/end)

proc
get_angle_raw
(start_x, start_y, start_pixel_x, start_pixel_y, end_x, end_y, end_pixel_x, end_pixel_y)

proc
get_bbox_of_atoms
(/list/atoms)

proc
get_line
(/atom/starting_atom, /atom/ending_atom)

proc
get_pixel_angle
(y, x)

proc
get_pixel_position_x
(/atom/subject, relative)

proc
get_pixel_position_y
(/atom/subject, relative)

proc
get_radios_in_view
(R, /atom/source)

proc
getpois
(mobs_only, skip_mindless, specify_dead_role)

proc
give_action
(/mob/L, action_path, ...)

proc
icon_exists
(file, state, scream)

proc
init_keybindings
()

proc
initiate_surgery_moment
(/obj/item/tool, /mob/living/carbon/target, /obj/limb/affecting, /mob/living/user)

proc
is_valid_src
(/datum/source_datum)

proc
list_clear_nulls
(/list/list_to_clear)

proc
load_map
(dmm_file, x_offset, y_offset, z_offset, cropMap, measureOnly, no_changeturf, x_lower, x_upper, y_lower, y_upper, placeOnTop)

proc
log_tgui
(user, message, context, /datum/tgui_window/window, /datum/src_object)

proc
make_tuple
(number)

proc
map_pill_icons
()

proc
md5asfile
(file)

proc
mergeListsSum
(/list/result, /list/mergee)

proc
message_to_html
(message)

proc
mutable_appearance
(icon, icon_state, layer, plane, alpha, appearance_flags)

proc
pick_n_take
(/list/L)

proc
pick_weight
(/list/list_to_pick)

proc
playsound_area
(/area/A, soundin, vol, channel, status, vol_cat, /list/echo, y_s_offset, x_s_offset)

proc
playsound_z
(z, soundin, volume, vol_cat, echo, y_s_offset, x_s_offset)

proc
qdel
(/datum/D, force, ...)

proc
recover_all_SS_and_recreate_master
()

proc
recursive_holder_check
(/obj/item/held_item, recursion_limit)

proc
remove_image_from_client
(/image/image_to_remove, /client/remove_from)

proc
remove_images_from_clients
(/image/image_to_remove, /list/show_to)

proc
remove_verb
(/client/target, verb_or_list_to_remove)