| SPAWN_RUINS | Ruins will spawn on this z-level |
|---|---|
| REACHABLE_SPACE_ONLY | A level that can be navigated to through space, but for real this time. |
+ A level that can be navigated to through space, but for real this time.
+ Ruins will spawn on this z-level
Vars | |
| always_unpowered | If TRUE, machines that require power in this area will never be powered |
|---|---|
| apc | All APCs currently constructed in this area |
| apc_starts_off | If TRUE, the local powernet in this area will have all its power channels switched off |
| can_get_auto_cryod | Do we despawn the person in this area? Pretty much just used in security areas that aren't permabrig |
| fast_despawn | Do we quickly despawn the person in this area? Pretty much just used in permabrig |
| global_uid | Static var that is incremented when the UID of a area is being assigned. |
| hide_attacklogs | For areas such as thunderdome which generate a lot of spammy attacklogs. Reduces log priority. |
| is_haunted | "Haunted" areas such as the morgue and chapel are easier to boo. Because flavor. |
| lightswitch | Is the lightswitch in this area on? Controls whether or not lights are on and off |
| map_name | Set in New(); preserves the name set by the map maker, even if renamed by the Blueprints. |
| master_air_alarm | The air alarm to use for atmos_alert consoles |
| max_ambience_cooldown | Used to decide what the maximum time between ambience is |
| min_ambience_cooldown | Used to decide what the minimum time between ambience is |
| moving | Is a shuttle moving to our area? |
| parallax_move_direction | Handles the direction parallax will be moved in. References |
| powernet | The local powernet of this area, this is where all machine/apc/object power related operations are handled |
| requires_power | If TRUE, this area's local powernet will require power to properly operate machines |
| scrubbers | The list of scrubbers in our area. |
| sound_environment | Used to decide what kind of reverb the area makes sound have |
| turret_controls | Turrets use this list to see if individual power/lethal settings are allowed. Contains the /obj/machinery/turretid for this area |
| valid_territory | used for cult summoning areas on station zlevel |
| vents | The list of vents in our area. |
| window_tint | Is the window tint control in this area on? Controls whether electrochromic windows and doors are tinted or not |
Procs | |
| ModifyFiredoors | Try to close all the firedoors in the area |
| atmosalert | Generate an atmospheric alert for this area |
| burglaralert | Raise a burglar alert for this area |
| close_and_lock_door | Close and lock a door passed into this proc |
| firealert | Generate a firealarm alert for this area |
| firereset | Reset the firealarm alert for this area |
| poweralert | Generate a power alert for this area |
| process | If 100 ticks has elapsed, toggle all the firedoors closed again |
| set_fire_alarm_effect | Trigger the fire alarm visual affects in an area |
| unset_fire_alarm_effects | unset the fire alarm visual affects in an area |
If TRUE, machines that require power in this area will never be powered
All APCs currently constructed in this area
If TRUE, the local powernet in this area will have all its power channels switched off
Do we despawn the person in this area? Pretty much just used in security areas that aren't permabrig
Do we quickly despawn the person in this area? Pretty much just used in permabrig
Static var that is incremented when the UID of a area is being assigned.
For areas such as thunderdome which generate a lot of spammy attacklogs. Reduces log priority.
"Haunted" areas such as the morgue and chapel are easier to boo. Because flavor.
Is the lightswitch in this area on? Controls whether or not lights are on and off
Set in New(); preserves the name set by the map maker, even if renamed by the Blueprints.
The air alarm to use for atmos_alert consoles
Used to decide what the maximum time between ambience is
Used to decide what the minimum time between ambience is
Is a shuttle moving to our area?
Handles the direction parallax will be moved in. References
The local powernet of this area, this is where all machine/apc/object power related operations are handled
If TRUE, this area's local powernet will require power to properly operate machines
The list of scrubbers in our area.
Used to decide what kind of reverb the area makes sound have
Turrets use this list to see if individual power/lethal settings are allowed. Contains the /obj/machinery/turretid for this area
used for cult summoning areas on station zlevel
The list of vents in our area.
Is the window tint control in this area on? Controls whether electrochromic windows and doors are tinted or not
Try to close all the firedoors in the area
Generate an atmospheric alert for this area
+Sends to all ai players, alert consoles, drones and alarm monitor programs in the world
Raise a burglar alert for this area
+Close and locks all doors in the area and alerts silicon mobs of a break in
+Alarm auto resets after 600 ticks
Close and lock a door passed into this proc
+Does this need to exist on area? probably not
Generate a firealarm alert for this area
+Sends to all ai players, alert consoles, drones and alarm monitor programs in the world
+Also starts the area processing on SSobj
Reset the firealarm alert for this area
+resets the alert sent to all ai players, alert consoles, drones and alarm monitor programs +in the world
+Also cycles the icons of all firealarms and deregisters the area from processing on SSOBJ
Generate a power alert for this area
+Sends to all ai players, alert consoles, drones and alarm monitor programs in the world
If 100 ticks has elapsed, toggle all the firedoors closed again
Trigger the fire alarm visual affects in an area
+Updates the fire light on fire alarms in the area and sets all lights to emergency mode
unset the fire alarm visual affects in an area
Procs | |
| list_getmobs | Returns a LIST of the MOBS in one of the depot area's lists. |
|---|---|
| list_show | Returns a STRING, containing the NAMES of the mobs in the provided list, JOINED together with ", " |
| list_shownames | Returns a LIST of the NAMES of the mobs in the provided list. |
Returns a LIST of the MOBS in one of the depot area's lists.
+E.g. list_getmobs(depotarea.guard_list) returns a list of the extra guard mobs in the depot. +Arguments:
+Returns a STRING, containing the NAMES of the mobs in the provided list, JOINED together with ", "
+E.g. list_show(depotarea.guard_list) returns a string like: +"Syndicate Backup (123), Syndicate Backup(456), Syndicate Backup(789)", etc. +Arguments:
+Returns a LIST of the NAMES of the mobs in the provided list.
+E.g. list_shownames(depotarea.guard_list) returns a list of the names of extra guard mobs in depot. +Arguments:
+Vars | |
| alternate_appearances | The alternate appearances we own. Lazylist |
|---|---|
| base_icon_state | Used for changing icon states for different base sprites. |
| bottom_left_corner | Smoothing variable |
| bottom_right_corner | Smoothing variable |
| bubble_icon | What icon the mob uses for speechbubbles |
| canSmoothWith | List of smoothing groups this atom can smooth with. If this is null and atom is smooth, it smooths only with itself. |
| chat_color | Last color calculated for the the chatmessage overlays. Used for caching. |
| chat_color_name | Last name used to calculate a color for the chatmessage overlays. Used for caching. |
| drag_start | Contains the world.time of when we start dragging something with our mouse. Used to prevent weird situations where you fail to click on something |
| explosion_block | Value used to increment ex_act() if reactionary_explosions is on |
| filter_data | For handling persistent filters |
| flags_ricochet | how the atom should handle ricochet behavior |
| germ_level | The higher the germ level, the more germ on the atom. |
| hud_list | This atom's HUD (med/sec, etc) images. Associative list. |
| hud_possible | HUD images that this atom can provide. |
| light_power | Intensity of the light. Can be negative to remove light |
| managed_overlays | overlays managed by update_overlays to prevent removing overlays that weren't added by the same proc. Single items are stored on their own, not in a list. |
| map_json_data | This var isn't actually used for anything, but is present so that DM's map reader doesn't forfeit on reading a JSON-serialized map. AKA DO NOT FUCK WITH |
| pass_flags_self | pass_flags that we are. If any of this matches a pass_flag on a moving thing, by default, we let them through. |
| rad_insulation | Radiation insulation types |
| receive_ricochet_chance_mod | When a projectile tries to ricochet off this atom, the projectile ricochet chance is multiplied by this |
| receive_ricochet_damage_coeff | When a projectile ricochets off this atom, it deals the normal damage * this modifier to this atom |
| simulated | Filter for actions - used by lighting overlays |
| smoothing_flags | Icon-smoothing behavior. |
| smoothing_groups | What smoothing groups does this atom belongs to, to match canSmoothWith. If null, nobody can smooth with it. |
| smoothing_junction | What directions this is currently smoothing with. IMPORTANT: This uses the smoothing direction flags as defined in icon_smoothing.dm, instead of the BYOND flags. |
| suit_fibers | List of fibers that this atom has |
| top_left_corner | Smoothing variable |
| top_right_corner | Smoothing variable |
| viewing_alternate_appearances | The alternate appearances we're viewing, stored here to reestablish them after Logout()s. Lazylist |
Procs | |
| AltClickNoInteract | Use this instead of [/mob/proc/AltClickOn] where you only want turf content listing without additional atom alt-click interaction |
| CanPathfindPass | This proc is used for telling whether something can pass by this atom in a given direction, for use by the pathfinding system. |
| Topic | Passes Stat Browser Panel clicks to the game and calls client click on an atom |
| acid_act | Respond to acid being used on our atom |
| after_slip | Base proc, intended to be overriden. |
| bitmask_smooth | Basic smoothing proc. The atom checks for adjacent directions to smooth with and changes the icon_state based on that. |
| calculate_adjacencies | Scans all adjacent turfs to find targets to smooth with. |
| clean_radiation | Removes some radiation from an atom |
| contents_ui_distance | public |
| defile | Begin defile and malfunction on-atom definitions |
| emag_act | This is when an atom is emagged. Should return false if it fails, or it has no emag_act defined. |
| emp_act | Proc which will make the atom act accordingly to an EMP. +This proc can sleep depending on the implementation. So assume it sleeps! |
| examine_more | Extended description of an object. Allows you to double examine objects and have them give you a second description of an item. Useful for writing flavourful stuff. |
| find_type_in_direction | Scans direction to find targets to smooth with. |
| get_orbiters | Simple helper proc to get a list of everything directly orbiting the current atom, without checking contents, or null if nothing is. |
| get_orbiters_recursive | Recursive getter method to return a list of all ghosts transitively orbiting this atom. +This will find orbiters either directly orbiting the followed atom, or any orbiters orbiting them (and so on). |
| get_orbiters_up_hierarchy | Check every object in the hierarchy above ourselves for orbiters, and return the full list of them. +If an object is being held in a backpack, returns orbiters of the backpack, the person +If recursive == TRUE, this will also check recursively through any ghosts seen to make sure we find everything upstream |
| get_runechat_color | Proc to allow atoms to set their own runechat colour |
| hit_by_thrown_mob | This proc applies special effects of a carbon mob hitting something, be it a wall, structure, or window. You can set mob_hurt to false to avoid double dipping through subtypes if returning ..() |
| is_drainable | Is this atom drainable of reagents |
| is_drawable | Can we draw from this atom with an injectable atom |
| is_injectable | Is this atom injectable into other atoms |
| is_open_container | Convenience proc to see if a container is open for chemistry handling |
| is_refillable | Can this atoms reagents be refilled |
| mech_melee_attack | Handle melee attack by a mech |
| persistent_load | Atom Persistent Loader |
| persistent_save | Atom Persistent Saver |
| rad_act | Respond to a radioactive wave hitting this atom |
| ray_filter_helper | Used to create rays on an item. Make sure to removefilter("rays") when done with it |
| remove_orbiter | Remove an orbiter from the atom it's orbiting. |
| rename_interactive | |
| return_analyzable_air | Return the air if we can analyze it |
| set_smoothed_icon_state | Changes the icon state based on the new junction bitmask. Returns the old junction value. |
| shuttleRotate | Base proc |
| storage_depth | Returns the storage depth of an atom up to the area level. |
| storage_depth_turf | Like /atom/proc/storage_depth, but returns the depth to the nearest turf. |
| tool_act | If it returns TRUE, attack chain stops |
| update_appearance | Updates the appearence of the icon |
| update_desc | Updates the description of the atom |
| update_icon | Updates the icon of the atom |
| update_icon_state | Updates the icon state of the atom |
| update_name | Signal sent should the appearance be updated. This is more broad if listening to a more specific signal doesn't cut it +Updates the name of the atom |
| update_overlays | Updates the overlays of the atom. It has to return a list of overlays if it can't call the parent to create one. The list can contain anything that would be valid for the add_overlay proc: Images, mutable appearances, icon states... |
| zap_act | Respond to an electric bolt action on our item |
The alternate appearances we own. Lazylist
Used for changing icon states for different base sprites.
Smoothing variable
Smoothing variable
What icon the mob uses for speechbubbles
List of smoothing groups this atom can smooth with. If this is null and atom is smooth, it smooths only with itself.
Last color calculated for the the chatmessage overlays. Used for caching.
Last name used to calculate a color for the chatmessage overlays. Used for caching.
Contains the world.time of when we start dragging something with our mouse. Used to prevent weird situations where you fail to click on something
Value used to increment ex_act() if reactionary_explosions is on
For handling persistent filters
how the atom should handle ricochet behavior
The higher the germ level, the more germ on the atom.
This atom's HUD (med/sec, etc) images. Associative list.
HUD images that this atom can provide.
Intensity of the light. Can be negative to remove light
overlays managed by update_overlays to prevent removing overlays that weren't added by the same proc. Single items are stored on their own, not in a list.
This var isn't actually used for anything, but is present so that DM's map reader doesn't forfeit on reading a JSON-serialized map. AKA DO NOT FUCK WITH
pass_flags that we are. If any of this matches a pass_flag on a moving thing, by default, we let them through.
Radiation insulation types
When a projectile tries to ricochet off this atom, the projectile ricochet chance is multiplied by this
When a projectile ricochets off this atom, it deals the normal damage * this modifier to this atom
Filter for actions - used by lighting overlays
Icon-smoothing behavior.
What smoothing groups does this atom belongs to, to match canSmoothWith. If null, nobody can smooth with it.
What directions this is currently smoothing with. IMPORTANT: This uses the smoothing direction flags as defined in icon_smoothing.dm, instead of the BYOND flags.
List of fibers that this atom has
Smoothing variable
Smoothing variable
The alternate appearances we're viewing, stored here to reestablish them after Logout()s. Lazylist
Use this instead of [/mob/proc/AltClickOn] where you only want turf content listing without additional atom alt-click interaction
This proc is used for telling whether something can pass by this atom in a given direction, for use by the pathfinding system.
+Trying to generate one long path across the station will call this proc on every single object on every single tile that we're seeing if we can move through, likely +multiple times per tile since we're likely checking if we can access said tile from multiple directions, so keep these as lightweight as possible.
+For turfs this will only be used if pathing_pass_method is TURF_PATHING_PASS_PROC
+Arguments:
+Passes Stat Browser Panel clicks to the game and calls client click on an atom
Respond to acid being used on our atom
+Default behaviour is to send COMSIG_ATOM_ACID_ACT and return
Base proc, intended to be overriden.
+This should only be called from one place: inside the slippery component. +Called after a human mob slips on this atom.
+If you want the person who slipped to have something special done to them, put it here.
Basic smoothing proc. The atom checks for adjacent directions to smooth with and changes the icon_state based on that.
+Returns the previous smoothing_junction state so the previous state can be compared with the new one after the proc ends, and see the changes, if any.
+Objects override this to prevent unanchored objects from smoothing, see /obj/bitmask_smooth()
Scans all adjacent turfs to find targets to smooth with.
Removes some radiation from an atom
+Removes a configurable amount of radiation from an atom +and stops green glow if radiation gets low enough through it. +Arguments:
+public
+Check the distance for a living mob. +Really only used for checks outside the context of a mob. +Otherwise, use shared_living_ui_distance().
+required src_object The object which owns the UI. +required user mob The mob who opened/is using the UI.
+return UI_state The state of the UI.
Begin defile and malfunction on-atom definitions
This is when an atom is emagged. Should return false if it fails, or it has no emag_act defined.
Proc which will make the atom act accordingly to an EMP. +This proc can sleep depending on the implementation. So assume it sleeps!
+severity - The severity of the EMP. Either EMP_HEAVY or EMP_LIGHT
Extended description of an object. Allows you to double examine objects and have them give you a second description of an item. Useful for writing flavourful stuff.
Scans direction to find targets to smooth with.
Simple helper proc to get a list of everything directly orbiting the current atom, without checking contents, or null if nothing is.
Recursive getter method to return a list of all ghosts transitively orbiting this atom. +This will find orbiters either directly orbiting the followed atom, or any orbiters orbiting them (and so on).
+This shouldn't be passed arugments.
Check every object in the hierarchy above ourselves for orbiters, and return the full list of them. +If an object is being held in a backpack, returns orbiters of the backpack, the person +If recursive == TRUE, this will also check recursively through any ghosts seen to make sure we find everything upstream
Proc to allow atoms to set their own runechat colour
+This is a proc designed to be overridden in places if you want a specific atom to use a specific runechat colour +Exampls include consoles using a colour based on their screen colour, and mobs using a colour based off of a customisation property
This proc applies special effects of a carbon mob hitting something, be it a wall, structure, or window. You can set mob_hurt to false to avoid double dipping through subtypes if returning ..()
Is this atom drainable of reagents
Can we draw from this atom with an injectable atom
Is this atom injectable into other atoms
Convenience proc to see if a container is open for chemistry handling
Can this atoms reagents be refilled
Handle melee attack by a mech
Atom Persistent Loader
+Overridden on every atom which needs to load persistent data
Atom Persistent Saver
+Overridden on every atom which needs to save persistent data
Respond to a radioactive wave hitting this atom
+Default behaviour is to send COMSIG_ATOM_RAD_ACT and return
Used to create rays on an item. Make sure to removefilter("rays") when done with it
Remove an orbiter from the atom it's orbiting.
Call this when you want to present a renaming prompt to the user.
+It's a simple proc, but handles annoying edge cases such as forgetting to add a "cancel" button, +or being able to rename stuff remotely.
+Arguments:
+src.name, or if we want to do everything except that.Returns: Either null if the renaming was aborted, or the user-provided sanitized string.
+Return the air if we can analyze it
Changes the icon state based on the new junction bitmask. Returns the old junction value.
Base proc
Returns the storage depth of an atom up to the area level.
+The storage depth is the number of storage items the atom is contained in.
+Returns -1 if the atom was not found in a container.
Like /atom/proc/storage_depth, but returns the depth to the nearest turf.
+Returns -1 if there's no top level turf. (A loc was null somewhere, or a non-turf atom's loc was an area somehow.)
If it returns TRUE, attack chain stops
Updates the appearence of the icon
+Mostly delegates to update_name, update_desc, and update_icon
+Arguments:
+Updates the description of the atom
Updates the icon of the atom
Updates the icon state of the atom
Signal sent should the appearance be updated. This is more broad if listening to a more specific signal doesn't cut it +Updates the name of the atom
Updates the overlays of the atom. It has to return a list of overlays if it can't call the parent to create one. The list can contain anything that would be valid for the add_overlay proc: Images, mutable appearances, icon states...
Respond to an electric bolt action on our item
+Default behaviour is to return, we define here to allow for cleaner code later on
Vars | |
| blocks_emissive | Either FALSE, [EMISSIVE_BLOCK_GENERIC], or EMISSIVE_BLOCK_UNIQUE |
|---|---|
| buckle_lying | Bed-like behaviour, forces the mob to lie down if buckle_lying != -1 |
| buckle_offset | The Pixel_y to offset the buckled mob by |
| buckle_prevents_pull | Can we pull the mob while they're buckled. Currently set to false on every movable |
| buckle_requires_restraints | Require people to be handcuffed before being able to buckle. eg: pipes |
| buckled_mobs | Lazylist of the mobs buckled to this object. |
| can_be_unanchored | Used for icon smoothing. Won't smooth if it ain't anchored and can be unanchored. Only set to true on windows |
| em_block | Internal holder for emissive blocker object, do not use directly use blocks_emissive |
| face_while_pulling | Face towards the atom while pulling it |
| max_buckled_mobs | The max amount of mobs that can be buckled to this object. Currently set to 1 on every movable |
| orbiting_uid | UID for the atom which the current atom is orbiting |
| thought_bubble_image | Icon state for thought bubbles. Normally set by mobs. |
Procs | |
| abstract_move | meant for movement with zero side effects. only use for objects that are supposed to move "invisibly" (like camera mobs or ghosts) +if you want something to move onto a tile with a beartrap or recycler or tripmine or mouse without that object knowing about it at all, use this +most of the time you want forceMove() |
| admin_Freeze | Created here as a base proc. Override as needed for any type of object or mob you want able to be frozen. |
| can_reach | A backwards depth-limited breadth-first-search to see if the target is +logically "in" anything adjacent to us. |
| create_point_bubble | Create a bubble pointing at a particular icon and icon state. +See args for create_point_bubble_from_atom. |
| create_point_bubble_from_atom | Create a point bubble towards a given item. |
| create_point_bubble_from_icons | Create a point bubble towards a given item, from an icon/icon state. |
| create_point_bubble_from_path | See above, this uses an uninstantiated path. |
| deadchat_plays | Adds the deadchat_plays component to this atom with simple movement commands. |
| end_throw | called after an items throw is ended. |
| fall_and_crush | Tip over this atom onto a turf, crushing things in its path. |
| key_loop | Key loop to check for movement keys held and move in the desired direction. |
| on_crush_thing | useful callback for things that want special behavior on crush |
| orbit | Set an atom to orbit around another one. This atom will follow the base atom's movement and rotate around it. |
| point_at | Point at an atom |
| shove_impact | called when a mob gets shoved into an items turf. false means the mob will be shoved backwards normally, true means the mob will not be moved by the disarm proc. |
| stop_deadchat_plays | Easy way to remove the component when the fun has been played out |
| stop_orbit | Stop this atom from orbiting whatever it's orbiting. |
| tilt_over | Tip over an atom without too much fuss. This won't cause damage to anything, and just rotates the thing and (optionally) adds the component. |
| untilt | Untilt a tilted object. |
Either FALSE, [EMISSIVE_BLOCK_GENERIC], or EMISSIVE_BLOCK_UNIQUE
Bed-like behaviour, forces the mob to lie down if buckle_lying != -1
The Pixel_y to offset the buckled mob by
Can we pull the mob while they're buckled. Currently set to false on every movable
Require people to be handcuffed before being able to buckle. eg: pipes
Lazylist of the mobs buckled to this object.
Used for icon smoothing. Won't smooth if it ain't anchored and can be unanchored. Only set to true on windows
Internal holder for emissive blocker object, do not use directly use blocks_emissive
Face towards the atom while pulling it
The max amount of mobs that can be buckled to this object. Currently set to 1 on every movable
UID for the atom which the current atom is orbiting
Icon state for thought bubbles. Normally set by mobs.
meant for movement with zero side effects. only use for objects that are supposed to move "invisibly" (like camera mobs or ghosts) +if you want something to move onto a tile with a beartrap or recycler or tripmine or mouse without that object knowing about it at all, use this +most of the time you want forceMove()
Created here as a base proc. Override as needed for any type of object or mob you want able to be frozen.
A backwards depth-limited breadth-first-search to see if the target is +logically "in" anything adjacent to us.
Create a bubble pointing at a particular icon and icon state. +See args for create_point_bubble_from_atom.
Create a point bubble towards a given item.
+Arguments:
+Create a point bubble towards a given item, from an icon/icon state.
+Arguments:
+See above, this uses an uninstantiated path.
Adds the deadchat_plays component to this atom with simple movement commands.
+Returns the component added. +Arguments:
+called after an items throw is ended.
Tip over this atom onto a turf, crushing things in its path.
+Arguments:
+Key loop to check for movement keys held and move in the desired direction.
useful callback for things that want special behavior on crush
Set an atom to orbit around another one. This atom will follow the base atom's movement and rotate around it.
+orbiter: atom which will be doing the orbiting +radius: range to orbit at, radius of the circle formed by orbiting +clockwise: whether you orbit clockwise or anti clockwise +rotation_speed: how fast to rotate +rotation_segments: the resolution of the orbit circle, less = a more block circle, this can be used to produce hexagons (6 segments) triangles (3 segments), and so on, 36 is the best default. +pre_rotation: Chooses to rotate src 90 degress towards the orbit dir (clockwise/anticlockwise), useful for things to go "head first" like ghosts +lock_in_orbit: Forces src to always be on A's turf, otherwise the orbit cancels when src gets too far away (eg: ghosts) +force_move: If true, ghosts will be ForceMoved instead of having their .loc updated directly. +orbit_layer: layer that the orbiter should be on. The original layer will be restored on orbit end.
Point at an atom
+Intended to enable and standardise the pointing animation for all atoms
+Not intended as a replacement for the mob verb
called when a mob gets shoved into an items turf. false means the mob will be shoved backwards normally, true means the mob will not be moved by the disarm proc.
Easy way to remove the component when the fun has been played out
Stop this atom from orbiting whatever it's orbiting.
Tip over an atom without too much fuss. This won't cause damage to anything, and just rotates the thing and (optionally) adds the component.
+Arguments:
+Untilt a tilted object.
Internal atom that copies an appearance on to the blocker plane
+This means that the atom in question will block any emissive sprites. +This should only be used internally. If you are directly creating more of these, +you're almost guaranteed to be doing something wrong.
Atom that manages and controls multiple planes. It's an atom so we can hook into add_filter etc. Multiple controllers can control one plane.
Vars | |
| controlled_planes | List of planes in this controllers control. Initially this is a normal list, but becomes an assoc list of plane numbers as strings | plane instance |
|---|---|
| owner_hud | hud that owns this controller |
Procs | |
| New | Ensures that all the planes are correctly in the controlled_planes list. |
| add_atom_colour | Full override so we can just use filterrific |
| add_filter | Full override so we can just use filterrific |
| get_filters | Gets all filters for this controllers plane masters |
| remove_atom_colour | Removes an instance of colour_type from the atom's atom_colours list |
| remove_filter | Full override so we can just use filterrific |
| transition_filter | Transitions all filters owned by this plane master controller |
| update_atom_colour | Resets the atom's color to null, and then sets it to the highest priority colour available |
List of planes in this controllers control. Initially this is a normal list, but becomes an assoc list of plane numbers as strings | plane instance
hud that owns this controller
Ensures that all the planes are correctly in the controlled_planes list.
Full override so we can just use filterrific
Full override so we can just use filterrific
Gets all filters for this controllers plane masters
Removes an instance of colour_type from the atom's atom_colours list
Full override so we can just use filterrific
Transitions all filters owned by this plane master controller
Resets the atom's color to null, and then sets it to the highest priority colour available
Vars | |
| assigned_map | Map name assigned to this object. +Automatically set by /client/proc/add_obj_to_map. |
|---|---|
| del_on_map_removal | Mark this object as garbage-collectible after you clean the map +it was registered on. |
Procs | |
| fill_rect | Sets screen_loc to fill a rectangular area of the map. |
| set_position | Sets screen_loc of this screen object, in form of point coordinates, +with optional pixel offset (px, py). |
Map name assigned to this object. +Automatically set by /client/proc/add_obj_to_map.
Mark this object as garbage-collectible after you clean the map +it was registered on.
+This could probably be changed to be a proc, for conditional removal. +But for now, this works.
Sets screen_loc to fill a rectangular area of the map.
+If applicable, "assigned_map" has to be assigned before this proc call.
Sets screen_loc of this screen object, in form of point coordinates, +with optional pixel offset (px, py).
+If applicable, "assigned_map" has to be assigned before this proc call.
Exists so you have a place to put your buttons when you move them around
Procs | |
| hit_by | Reacts to having a button dropped on it |
|---|---|
Reacts to having a button dropped on it
Vars | |
| alerttooltipstyle | Tool-tip for the alert. |
|---|---|
| override_alerts | If true, this should override any other alerts of the same type thrown. |
| owner | The mob that this alert was originally thrown to. |
| severity | Some alerts may have different icon states based on severity, this adjusts that. |
| timeout | How long before this alert automatically clears itself (in deciseconds). If zero, remains until cleared. |
Tool-tip for the alert.
If true, this should override any other alerts of the same type thrown.
The mob that this alert was originally thrown to.
Some alerts may have different icon states based on severity, this adjusts that.
How long before this alert automatically clears itself (in deciseconds). If zero, remains until cleared.
Vars | |
| follow_target | The atom being followed |
|---|---|
| followers | The atoms following it |
| next_targets | Queue of next atoms to follow |
| thing_followed | Title for the thing that will be followed. |
| time_between_switches | After a followed item is qdeleted, wait this long before switching to the next target, allowing you to see aftermath. |
Procs | |
| Initialize | Create a new augury alert. |
| change_targets | Change the atom that everyone is currently following, moving everyone to the new object. |
| on_following_qdel | Executed when the parent is deleted. +Don't immediately kill ourselves, since it's possible that we might want to move somewhere else +(for example, after a meteor strike) |
| remove_follower_on_stop_orbit | Called when someone stops orbiting our followed object, so they can actually get out of the loop. |
The atom being followed
The atoms following it
Queue of next atoms to follow
Title for the thing that will be followed.
After a followed item is qdeleted, wait this long before switching to the next target, allowing you to see aftermath.
Create a new augury alert.
+Arguments:
+Change the atom that everyone is currently following, moving everyone to the new object.
+Arguments:
+Executed when the parent is deleted. +Don't immediately kill ourselves, since it's possible that we might want to move somewhere else +(for example, after a meteor strike)
Called when someone stops orbiting our followed object, so they can actually get out of the loop.
Vars | |
| item_UID | UID of the item being given. |
|---|---|
| receiver_UID | UID of the mob who's being offered the item. |
UID of the item being given.
UID of the mob who's being offered the item.
Alert which appears for a user when another player is attempting to offer them an item. +The user can click the alert to accept, or simply do nothing to not take the item.
Vars | |
| giver_UID | UID of the mob offering the receiver an item. |
|---|---|
| item_UID | UID of the item being given. |
| receiver_UID | UID of the mob who has this alert. |
UID of the mob offering the receiver an item.
UID of the item being given.
UID of the mob who has this alert.
Vars | |
| color_timer_id | Id of any currently running timers that set our color matrix |
|---|---|
Id of any currently running timers that set our color matrix
An effect which tracks the cursor's location on the screen
Vars | |
| given_turf | The turf we send to the scope component. |
|---|---|
| given_x | Pixel x we send to the scope component. |
| given_y | Pixel y we send to the scope component. |
| mouse_params | Mouse parameters, for calculation. |
| owner | The mob whose cursor we are tracking. |
| view_list | Client view size of the scoping mob. |
Procs | |
| assign_to_mob | Links this up with a mob |
| on_move | Update when the mob we're assigned to has moved |
The turf we send to the scope component.
Pixel x we send to the scope component.
Pixel y we send to the scope component.
Mouse parameters, for calculation.
The mob whose cursor we are tracking.
Client view size of the scoping mob.
Links this up with a mob
Update when the mob we're assigned to has moved
Vars | |
| range_modifier | Multiplier for given_X an given_y. |
|---|---|
Multiplier for given_X an given_y.
Procs | |
| mouse_params_to_position | Takes mouse parmas as input, returns a string representing the appropriate mouse position |
|---|---|
Takes mouse parmas as input, returns a string representing the appropriate mouse position
Vars | |
| actiontooltipstyle | The style of tool-tip. |
|---|---|
| id | A unique bitflag, combined with the name of our linked action this lets us persistently remember any user changes to our position |
| last_hovered_ref | UID of the last thing we hovered over. Used for managing action button dragging. |
| linked_action | The action triggered by this button. |
| linked_keybind | The keybind that will trigger this action button. |
| location | Where we are currently placed on the hud. SCRN_OBJ_DEFAULT asks the linked action what it thinks |
| locked | Whether or not this button is locked, preventing it from being dragged. |
| our_hud | The HUD this action button belongs to |
| shown_to_observers | Whether or not this should be shown to observers |
The style of tool-tip.
A unique bitflag, combined with the name of our linked action this lets us persistently remember any user changes to our position
UID of the last thing we hovered over. Used for managing action button dragging.
The action triggered by this button.
The keybind that will trigger this action button.
Where we are currently placed on the hud. SCRN_OBJ_DEFAULT asks the linked action what it thinks
Whether or not this button is locked, preventing it from being dragged.
The HUD this action button belongs to
Whether or not this should be shown to observers
Vars | |
| scroll_direction | How should we move the palette's actions? +Positive scrolls down the list, negative scrolls back |
|---|---|
How should we move the palette's actions? +Positive scrolls down the list, negative scrolls back
Things placed on this mask the lighting plane. Doesn't render directly.
+Gets masked by blocking plane. Use for things that you want blocked by +mobs, items, etc.
Vars | |
| appear_animation_duration | Amount of time the blurbs appering (alpha changing from 0 to 255). 0 means blurb is fully opaque from the start |
|---|---|
| blurb_text | Text that will be shown in blurb |
| chars_per_interval | Number of chars from the text that will be displayed per interval. Defaults to 1 |
| fade_animation_duration | Amount of time the blurb takes to fade (alpha changing from 255 to 0). 0 means blurb is instantly removed from the screen after finished |
| font_family | Font family |
| font_size | Font size in pixels |
| hold_for | Amount of time the blurb will be present on the screen. 0 means that blurb will dissappear immediately |
| interval | The interval between chars rendering |
| text_alignment | Where text is aligned |
| text_color | Color of text in RGB |
| text_outline_color | Color of text outline |
| text_outline_width | Width of text outline in pixels |
Amount of time the blurbs appering (alpha changing from 0 to 255). 0 means blurb is fully opaque from the start
Text that will be shown in blurb
Number of chars from the text that will be displayed per interval. Defaults to 1
Amount of time the blurb takes to fade (alpha changing from 255 to 0). 0 means blurb is instantly removed from the screen after finished
Font family
Font size in pixels
Amount of time the blurb will be present on the screen. 0 means that blurb will dissappear immediately
The interval between chars rendering
Where text is aligned
Color of text in RGB
Color of text outline
Width of text outline in pixels
Vars | |
| ViewMods | Was used to handle view modifications. Now only used for a mecha module. Please just edit the string in the future |
|---|---|
| ViewModsActive | Stores the viewmod we set using this system. Only used for a mecha module |
| ViewPreferedIconSize | Stores the icon size we use for skins. As the server has control freak enabled, this is always static |
| active_keybindings | The client's active keybindings, depending on their active mob. |
| admin_music_volume | Copyright (c) 2020 Aleksej Komarov +SPDX-License-Identifier: MIT +Admin music volume, from 0 to 1. |
| byondacc_age | Days since the client's BYOND account was created |
| byondacc_date | Date the client registered their BYOND account on |
| click_intercept_time | Time when the click was intercepted |
| completed_asset_jobs | List of all completed blocking send jobs awaiting acknowledgement by send_asset |
| connection_time | world.time they connected |
| cui_entries | List of the clients CUIs |
| description_holders | Persistent storage for the flavour text of examined atoms. |
| drag_details | The params we passed at the start of the drag, in list form |
| drag_start | When we started the currently active drag |
| fullscreen | The current fullscreen state for /client/toggle_fullscreen() |
| input_data | Input datum, what the client is pressing. |
| jbh | The client's job ban holder |
| last_asset_job | The ID of the last asset job |
| last_completed_asset_job | The ID of the last asset job that was properly finished |
| last_discord_pm_time | Last world.time that a PM was send to discord by a player |
| last_parallax_shift | Stored world.tim of the last parallax update. Used to make sure parallax isn't updated too often |
| macro_sets | Basically a local variable on a client datum. Used when setting macros and nowhere else |
| mouseParams | Used in MouseDrag to preserve the original mouse click parameters |
| mouse_down_icon | Used to make a special mouse cursor, this one for mouse up icon |
| mouse_location_UID | Used in MouseDrag to preserve the last mouse-entered location. |
| mouse_object_UID | Used in MouseDrag to preserve the last mouse-entered object. |
| mouse_override_icon | Used to override the mouse cursor so it doesnt get reset |
| mouse_up_icon | Used to make a special mouse cursor, this one for mouse up icon |
| moused_over | The client's currently moused over datum, limited to movable and stored as UID |
| movement_kb_dirs | The client's movement keybindings to directions, which work regardless of modifiers. |
| movingmob | Used with parallax to update the parallax offsets when the subsystem fires. Compared to the clients Eye variable |
| next_mouse_macro_warning | Used to throw an admin warning if someone used a mouse macro. Also stores the world time so we can send funny noises to them |
| obj_window | Our object window datum. It stores info about and handles behavior for the object tab |
| pai_save | Client's pAI save |
| panel_tabs | list of all tabs |
| parallax_animate_timer | Handles how parallax loops in situations like shuttles leaving. Stores the timer that handles that |
| parallax_layers | List of parallax layers a client is viewing. Accessed when paralax is updated |
| parallax_layers_cached | A cached list of available parallax layers. This may potentially be changeable to a static variable. Updated upon changing parallax prefs |
| parallax_layers_max | The amount of parallax layers that will exist on your screen. Affected by the parallax preference |
| parallax_movedir | The direction parallax will be moved it. References parallax_move_direction on areas |
| parallax_static_layers_tail | Added to parallax layers when parallax settings are changed |
| parallax_throttle | Deciseconds of added delay to parallax by client preferences |
| parent_type | Client is casted to /datum so that we're able to use datum variables, search for clients through datums, and not need to duplicate code for GCing |
| previous_turf | Used with parallax to grab the offset needed. Uses the X and Y coords of the turf stored here |
| received_discord_pm | Last world/time that a PM was sent to the player by an admin |
| recent_examines | A lazy list of atoms we've examined in the last RECENT_EXAMINE_MAX_WINDOW (default 2) seconds, so that we will call /atom/proc/examine_more instead of [/atom/proc/examine] on them when examining +A lazy list of atoms we've examined in the last RECENT_EXAMINE_MAX_WINDOW (default 2) seconds, so that we will call /atom/proc/examine_more instead of [/atom/proc/examine] on them when examining |
| screen_maps | Used with the camera console to clear out the screen objects it adds to the client when the console is deleted |
| seen_messages | Messages currently seen by this client |
| selected_target | Autoclick list of two elements, first being the clicked thing, second being the parameters. |
| sent_assets | List of all asset filenames sent to this client by the asset cache, along with their assoicated md5s |
| show_verb_panel | hides the byond verb panel as we use our own custom version |
| spell_tabs | list of tabs containing spells and abilities |
| stat_panel | Stat panel window declaration, we don't usually allow this but tgui windows/panels are exceptions |
| stat_tab | our current tab |
| tgui_cache_reloaded | global |
| tgui_panel | Copyright (c) 2020 Aleksej Komarov +SPDX-License-Identifier: MIT |
| tgui_say | Assigned say modal of the client |
| tgui_windows | global |
| topiclimiter | Used for limiting the rate of topic sends by the client to avoid abuse |
| tos_consent | Has the client accepted the TOS about data collection and other stuff |
| version_blocked | If true, client cannot ready up, late join, or observe. Used for players with EXTREMELY old byond versions. |
| watchlisted | Is the client watchlisted |
Procs | |
| Key_Down | This list defines the keys in legacy mode that get passed on to the rebindable input system +It cannot be bigger since, while typing, the keys would be passed to whatever they are set in the rebind input system |
| Process_Grab | Process_Grab() +Called by client/Move() +Checks to see if you are being grabbed and if so attemps to break it |
| Process_Incorpmove | Process_Incorpmove +Called by client/Move() +Allows mobs to run though walls |
| _Topic | dumb workaround because byond doesnt seem to recognize the Topic() typepath for /datum/proc/Topic() from the client Topic, +so we cant queue it without this |
| admin_observe | Allow an admin to observe someone. +mentors are allowed to use this verb while living, but with some stipulations: +if they attempt to do anything that would stop their orbit, they will immediately be returned to their body. |
| admin_observe_target | targeted form of admin_observe: this should only appear in the right-click menu. |
| asset_cache_confirm_arrival | Process asset cache client topic calls for "asset_cache_confirm_arrival=[INT]" |
| asset_cache_preload_data | Process asset cache client topic calls for "asset_cache_preload_data=[HTML+JSON_STRING] |
| asset_cache_update_json | Updates the client side stored json file used to keep track of what assets the client has between restarts/reconnects. |
| browse_queue_flush | Blocks until all currently sending browse and browse_rs assets have been sent. +Due to byond limitations, this proc will sleep for 1 client round trip even if the client has no pending asset sends. +This proc will return an untrue value if it had to return before confirming the send, such as timeout or the client going away. |
| clear_all_maps | Clears all the maps of registered screen objects. |
| clear_map | Clears the map of registered screen objects. |
| close_popup | Closes a popup. |
| create_eventmob_for | WARNING!** +The jobban stuff looks mangled and disgusting +But it looks beautiful in-game +-Nodrak +**WARNING! |
| create_popup | Creates a popup window with a basic map element in it, without any +further initialization. |
| display_job_bans | Lists all active jobbans for src client |
| fix_tgui_panel | tgui panel / chat troubleshooting verb |
| get_byond_account_date | Sets the clients BYOND date up properly |
| handle_popup_close | When the popup closes in any way (player or proc call) it calls this. |
| init_verbs | Compiles a full list of verbs and sends it to the browser |
| maxview | Returns the biggest number from client.view so we can do easier maths |
| on_stat_panel_message | Handles incoming messages from the stat-panel TGUI. |
| register_map_obj | Registers screen obj with the client, which makes it visible on the +assigned map, and becomes a part of the assigned map's lifecycle. |
| retrieve_byondacc_data | Retrieves the BYOND accounts data from the BYOND servers |
| set_macros | This proc sets the built in BYOND macros for keypresses to pass inputs on to the rebindable input system or the legacy system +If you plan on ripping out the legacy system, see the set_macros() proc at the following commit: https://github.com/S34NW/Paradise/commit/83a0a0b0c633807cc5a88a630f623cec24e16027 |
| setup_popup | Create the popup, and get it ready for generic use by giving +it a background. |
| tgui_say_create_open_command | Creates a JSON encoded message to open TGUI say modals properly. |
| timer_log | Opens a log of timers |
| toggle_fullscreen | Handles fullscreen on the client. |
| uiclose | verb |
| uid_log | Opens a log of UIDs |
Was used to handle view modifications. Now only used for a mecha module. Please just edit the string in the future
Stores the viewmod we set using this system. Only used for a mecha module
Stores the icon size we use for skins. As the server has control freak enabled, this is always static
The client's active keybindings, depending on their active mob.
Copyright (c) 2020 Aleksej Komarov +SPDX-License-Identifier: MIT +Admin music volume, from 0 to 1.
Days since the client's BYOND account was created
Date the client registered their BYOND account on
Time when the click was intercepted
List of all completed blocking send jobs awaiting acknowledgement by send_asset
world.time they connected
List of the clients CUIs
Persistent storage for the flavour text of examined atoms.
The params we passed at the start of the drag, in list form
When we started the currently active drag
The current fullscreen state for /client/toggle_fullscreen()
Input datum, what the client is pressing.
The client's job ban holder
The ID of the last asset job
The ID of the last asset job that was properly finished
Last world.time that a PM was send to discord by a player
Stored world.tim of the last parallax update. Used to make sure parallax isn't updated too often
Basically a local variable on a client datum. Used when setting macros and nowhere else
Used in MouseDrag to preserve the original mouse click parameters
Used to make a special mouse cursor, this one for mouse up icon
Used in MouseDrag to preserve the last mouse-entered location.
Used in MouseDrag to preserve the last mouse-entered object.
Used to override the mouse cursor so it doesnt get reset
Used to make a special mouse cursor, this one for mouse up icon
The client's currently moused over datum, limited to movable and stored as UID
The client's movement keybindings to directions, which work regardless of modifiers.
Used with parallax to update the parallax offsets when the subsystem fires. Compared to the clients Eye variable
Used to throw an admin warning if someone used a mouse macro. Also stores the world time so we can send funny noises to them
Our object window datum. It stores info about and handles behavior for the object tab
Client's pAI save
list of all tabs
Handles how parallax loops in situations like shuttles leaving. Stores the timer that handles that
List of parallax layers a client is viewing. Accessed when paralax is updated
A cached list of available parallax layers. This may potentially be changeable to a static variable. Updated upon changing parallax prefs
The amount of parallax layers that will exist on your screen. Affected by the parallax preference
The direction parallax will be moved it. References parallax_move_direction on areas
Added to parallax layers when parallax settings are changed
Deciseconds of added delay to parallax by client preferences
Client is casted to /datum so that we're able to use datum variables, search for clients through datums, and not need to duplicate code for GCing
Used with parallax to grab the offset needed. Uses the X and Y coords of the turf stored here
Last world/time that a PM was sent to the player by an admin
A lazy list of atoms we've examined in the last RECENT_EXAMINE_MAX_WINDOW (default 2) seconds, so that we will call /atom/proc/examine_more instead of [/atom/proc/examine] on them when examining +A lazy list of atoms we've examined in the last RECENT_EXAMINE_MAX_WINDOW (default 2) seconds, so that we will call /atom/proc/examine_more instead of [/atom/proc/examine] on them when examining
Used with the camera console to clear out the screen objects it adds to the client when the console is deleted
Messages currently seen by this client
Autoclick list of two elements, first being the clicked thing, second being the parameters.
List of all asset filenames sent to this client by the asset cache, along with their assoicated md5s
hides the byond verb panel as we use our own custom version
list of tabs containing spells and abilities
Stat panel window declaration, we don't usually allow this but tgui windows/panels are exceptions
our current tab
global
+TRUE if cache was reloaded by tgui dev server at least once.
Copyright (c) 2020 Aleksej Komarov +SPDX-License-Identifier: MIT
Assigned say modal of the client
global
+Tracks open windows for a user.
Used for limiting the rate of topic sends by the client to avoid abuse
Has the client accepted the TOS about data collection and other stuff
If true, client cannot ready up, late join, or observe. Used for players with EXTREMELY old byond versions.
Is the client watchlisted
This list defines the keys in legacy mode that get passed on to the rebindable input system +It cannot be bigger since, while typing, the keys would be passed to whatever they are set in the rebind input system
Process_Grab() +Called by client/Move() +Checks to see if you are being grabbed and if so attemps to break it
Process_Incorpmove +Called by client/Move() +Allows mobs to run though walls
dumb workaround because byond doesnt seem to recognize the Topic() typepath for /datum/proc/Topic() from the client Topic, +so we cant queue it without this
Allow an admin to observe someone. +mentors are allowed to use this verb while living, but with some stipulations: +if they attempt to do anything that would stop their orbit, they will immediately be returned to their body.
targeted form of admin_observe: this should only appear in the right-click menu.
Process asset cache client topic calls for "asset_cache_confirm_arrival=[INT]"
Process asset cache client topic calls for "asset_cache_preload_data=[HTML+JSON_STRING]
Updates the client side stored json file used to keep track of what assets the client has between restarts/reconnects.
Blocks until all currently sending browse and browse_rs assets have been sent. +Due to byond limitations, this proc will sleep for 1 client round trip even if the client has no pending asset sends. +This proc will return an untrue value if it had to return before confirming the send, such as timeout or the client going away.
Clears all the maps of registered screen objects.
Clears the map of registered screen objects.
+Not really needed most of the time, as the client's screen list gets reset +on relog. any of the buttons are going to get caught by garbage collection +anyway. they're effectively qdel'd.
Closes a popup.
WARNING!** +The jobban stuff looks mangled and disgusting +But it looks beautiful in-game +-Nodrak +**WARNING!
Creates a popup window with a basic map element in it, without any +further initialization.
+Ratio is how many pixels by how many pixels (keep it simple).
+Returns a map name.
Lists all active jobbans for src client
+from_client_connection - If true, user will not receive any info in chat if they have no job bans, used when a player loads into to the lobby.
tgui panel / chat troubleshooting verb
Sets the clients BYOND date up properly
+If the client does not have a saved BYOND account creation date, retrieve it from the website +If they do have a saved date, use that from the DB, because this value will never change +Arguments:
+When the popup closes in any way (player or proc call) it calls this.
Compiles a full list of verbs and sends it to the browser
Returns the biggest number from client.view so we can do easier maths
Handles incoming messages from the stat-panel TGUI.
Registers screen obj with the client, which makes it visible on the +assigned map, and becomes a part of the assigned map's lifecycle.
Retrieves the BYOND accounts data from the BYOND servers
+Makes a web request to byond.com to retrieve the details for the BYOND account associated with the clients ckey. +Returns the data in a parsed, associative list
This proc sets the built in BYOND macros for keypresses to pass inputs on to the rebindable input system or the legacy system +If you plan on ripping out the legacy system, see the set_macros() proc at the following commit: https://github.com/S34NW/Paradise/commit/83a0a0b0c633807cc5a88a630f623cec24e16027
Create the popup, and get it ready for generic use by giving +it a background.
+Width and height are multiplied by 64 by default.
Creates a JSON encoded message to open TGUI say modals properly.
+Arguments: +channel - The channel to open the modal in. +Returns: +string - A JSON encoded message to open the modal.
Opens a log of timers
+In-round ability to view what has created a timer, and how many times a timer for that path has been created
Handles fullscreen on the client.
verb
+Called by UIs when they are closed. +Must be a verb so winset() can call it.
+required uiref ref The UI that was closed.
Opens a log of UIDs
+In-round ability to view what has created a UID, and how many times a UID for that path has been declared
| MC_AVG_OVER_TIME | creates a running average of "things elapsed" per time period when you need to count via a smaller time period. +eg you want an average number of things happening per second but you measure the event every tick (50 milliseconds). +make sure both time intervals are in the same units. doesnt work if current_duration > total_duration or if total_duration == 0 |
|---|---|
| SS_BACKGROUND | Subsystem only runs on spare cpu (after all non-background subsystems have ran that tick) +SS_BACKGROUND has its own priority bracket, this overrides SS_TICKER's priority bump |
| SS_TICKER | (also forces it to run first in the tick (unless SS_BACKGROUND)) |
+ creates a running average of "things elapsed" per time period when you need to count via a smaller time period. +eg you want an average number of things happening per second but you measure the event every tick (50 milliseconds). +make sure both time intervals are in the same units. doesnt work if current_duration > total_duration or if total_duration == 0
+ Subsystem only runs on spare cpu (after all non-background subsystems have ran that tick) +SS_BACKGROUND has its own priority bracket, this overrides SS_TICKER's priority bump
+ (also forces it to run first in the tick (unless SS_BACKGROUND))
| BUTTON | Mouse button that was just clicked/released +if(modifiersBUTTON == LEFT_CLICK) |
|---|---|
| MOUSE_OPACITY_TRANSPARENT | Objects will ignore being clicked on regardless of their transparency (used in parallax, lighting effects, holograms, lasers, etc.) |
| MOUSE_OPACITY_ICON | Objects will be clicked on if it is the topmost object and the pixel isn't transparent at the position of the mouse (default behavior for 99.99% of game objects) |
| MOUSE_OPACITY_OPAQUE | Objects will be always be clicked on regardless of pixel transparency or other objects at that location (used in space vines, storage containers) |
+ Mouse button that was just clicked/released +if(modifiersBUTTON == LEFT_CLICK)
+ Objects will be clicked on if it is the topmost object and the pixel isn't transparent at the position of the mouse (default behavior for 99.99% of game objects)
+ Objects will be always be clicked on regardless of pixel transparency or other objects at that location (used in space vines, storage containers)
+ Objects will ignore being clicked on regardless of their transparency (used in parallax, lighting effects, holograms, lasers, etc.)
| TOBITSHIFT | Gets shift x that would be required the bitflag (1<<x) |
|---|---|
| IS_INT | Checks if a number is an integer, or a float |
+ Checks if a number is an integer, or a float
+ Gets shift x that would be required the bitflag (1<<x)
| GENERAL_PROTECT_DATUM | Protects a datum from being VV'd |
|---|
+ Protects a datum from being VV'd
| MAPTICK_MC_MIN_RESERVE | Percentage of tick to leave for master controller to run |
|---|---|
| TICK_BYOND_RESERVE | Tick limit while running normally |
| TICK_LIMIT_TO_RUN | Tick limit used to resume things in stoplag |
| TICK_LIMIT_MC | Tick limit for MC while running |
| TICK_USAGE | for general usage of tick_usage |
| TICK_USAGE_REAL | to be used where the result isn't checked |
| TICK_CHECK | Returns true if tick_usage is above the limit |
| CHECK_TICK | runs stoplag if tick_usage is above the limit |
| RUNNING_BEFORE_MASTER | Checks if a sleeping proc is running before or after the master controller |
| VERB_SHOULD_YIELD | Returns true if a verb ought to yield to the MC (IE: queue up to be processed by a subsystem) |
| TICK_CHECK_HIGH_PRIORITY | Returns true if tick usage is above 95, for high priority usage |
| CHECK_TICK_HIGH_PRIORITY | runs stoplag if tick_usage is above 95, for high priority usage |
+ runs stoplag if tick_usage is above the limit
+ runs stoplag if tick_usage is above 95, for high priority usage
+ Percentage of tick to leave for master controller to run
+ Checks if a sleeping proc is running before or after the master controller
+ Tick limit while running normally
+ Returns true if tick_usage is above the limit
+ Returns true if tick usage is above 95, for high priority usage
+ Tick limit for MC while running
+ Tick limit used to resume things in stoplag
+ for general usage of tick_usage
+ to be used where the result isn't checked
+ Returns true if a verb ought to yield to the MC (IE: queue up to be processed by a subsystem)
| RUST_G_VERSION | Version of RUST-G that this codebase wants |
|---|
+ Version of RUST-G that this codebase wants
| SCRN_OBJ_DEFAULT | Whatever the base action datum thinks is best |
|---|---|
| SCRN_OBJ_FLOATING | Floating somewhere on the hud, not in any predefined place |
| SCRN_OBJ_IN_LIST | In the list of buttons stored at the top of the screen |
| SCRN_OBJ_IN_PALETTE | In the collapseable palette |
+ Whatever the base action datum thinks is best
+ Floating somewhere on the hud, not in any predefined place
+ In the list of buttons stored at the top of the screen
+ In the collapseable palette
| CIDWARNING_SUPPRESSED_NOTETEXT | Note text for suppressed CID warning |
|---|---|
| CIDTRACKING_PSUEDO_CKEY | Note "ckey" for CID info tracking. Do not EVER update this. |
| ANTAGTRACKING_PSUEDO_CKEY | Note "ckey" for roundstart antag rolling tracking. Do not EVER update this. |
| CONNECTION_TYPE_ESTABLISHED | Client was let into the server |
| CONNECTION_TYPE_DROPPED_IPINTEL | Client was disallowed due to IPIntel |
| CONNECTION_TYPE_DROPPED_BANNED | Client was disallowed due to being banned |
| CONNECTION_TYPE_DROPPED_INVALID | Client was disallowed due to invalid data |
+ Note "ckey" for roundstart antag rolling tracking. Do not EVER update this.
+ Note "ckey" for CID info tracking. Do not EVER update this.
+ Note text for suppressed CID warning
+ Client was disallowed due to being banned
+ Client was disallowed due to invalid data
+ Client was disallowed due to IPIntel
+ Client was let into the server
| ANNOUNCE_KIND_DEFAULT | These values are used when logging user-initiated announcements. |
|---|
+ These values are used when logging user-initiated announcements.
| CONTRACT_STATUS_INVALID | Contractors +The contract is invalid for some reason and cannot be taken. It may be made valid later. |
|---|---|
| CONTRACT_STATUS_INACTIVE | The contract hasn't been started yet. |
| CONTRACT_STATUS_ACTIVE | The contract is in progress. |
| CONTRACT_STATUS_COMPLETED | The contract has been completed successfully. |
| CONTRACT_STATUS_FAILED | The contract failed for some reason. |
| EXTRACTION_DIFFICULTY_EASY | Easy difficulty area to extract the kidnapee. Low rewards. |
| EXTRACTION_DIFFICULTY_MEDIUM | Medium difficulty area to extract the kidnapee. Moderate rewards. |
| EXTRACTION_DIFFICULTY_HARD | Hard difficulty area to extract the kidnapee. High rewards. |
| CONTRACT_STRINGS_WANTED | The name of the strings file containing data to use for contract fluff texts. |
| UPLINK_SPECIAL_SPAWNING | Traitors |
| CHANGELING_INNATE_POWER | Changelings +Denotes that this power is free and should be given to all changelings by default. |
| CHANGELING_PURCHASABLE_POWER | Denotes that this power can only be obtained by purchasing it. |
| CHANGELING_UNOBTAINABLE_POWER | Denotes that this power can not be obtained normally. Primarily used for base types such as /datum/action/changeling/weapon. |
| ABDUCTOR_VEST_STEALTH | Abductors |
| PULSEDEMON_SOURCE_DRAIN_INVALID | Pulse Demon |
+ Abductors
+ Changelings +Denotes that this power is free and should be given to all changelings by default.
+ Denotes that this power can only be obtained by purchasing it.
+ Denotes that this power can not be obtained normally. Primarily used for base types such as /datum/action/changeling/weapon.
+ The contract is in progress.
+ The contract has been completed successfully.
+ The contract failed for some reason.
+ The contract hasn't been started yet.
+ Contractors +The contract is invalid for some reason and cannot be taken. It may be made valid later.
+ The name of the strings file containing data to use for contract fluff texts.
+ Easy difficulty area to extract the kidnapee. Low rewards.
+ Hard difficulty area to extract the kidnapee. High rewards.
+ Medium difficulty area to extract the kidnapee. Moderate rewards.
+ Pulse Demon
+ Traitors
| APC_CHANNEL_SETTING_OFF | Power channel is off, anything connected to it is not powered, cannot be set manually by players |
|---|---|
| APC_CHANNEL_SETTING_AUTO_OFF | APC power channel Setting Off, if set while apc is "on" set apc to "off" otherwise set to "auto-off" |
| APC_CHANNEL_SETTING_ON | APC power channel setting on, |
+ APC power channel Setting Off, if set while apc is "on" set apc to "off" otherwise set to "auto-off"
+ Power channel is off, anything connected to it is not powered, cannot be set manually by players
+ APC power channel setting on,
| URL2HTMLLOADER | Get html to load a url. +for use inside of browse() calls to html assets that might be loaded on a cdn. |
|---|---|
| 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 extension. |
+ Generate a filename for this asset +The same asset will always lead to the same asset name +Generated names do not include file extension.
+ Get html to load a url. +for use inside of browse() calls to html assets that might be loaded on a cdn.
| COLD_ROOM_TEMP | -14C - Temperature used for kitchen cold room, medical freezer, etc. |
|---|---|
| SERVER_ROOM_TEMP | -193C - Temperature used for server rooms |
| ENVIRONMENT_LAVALAND | Lavaland environment: hot, low pressure. |
| ENVIRONMENT_TEMPERATE | Temperate environment: Normal atmosphere, 20 C. |
| ENVIRONMENT_COLD | Cold environment: Normal atmosphere, -93 C. |
+ -14C - Temperature used for kitchen cold room, medical freezer, etc.
+ Cold environment: Normal atmosphere, -93 C.
+ Lavaland environment: hot, low pressure.
+ Temperate environment: Normal atmosphere, 20 C.
+ -193C - Temperature used for server rooms
| BIOCHIP_EMOTE_TRIGGER_INTENTIONAL | If used, an implant will trigger when an emote is intentionally used. |
|---|---|
| BIOCHIP_EMOTE_TRIGGER_UNINTENTIONAL | If used, an implant will trigger when an emote is forced/unintentionally used. |
| BIOCHIP_EMOTE_TRIGGER_ALWAYS | If used, an implant will always trigger when the user makes an emote. |
| BIOCHIP_TRIGGER_DEATH_ONCE | If used, an implant will trigger on the user's first death. |
| BIOCHIP_TRIGGER_DEATH_ANY | If used, an implant will trigger any time a user dies. |
| BIOCHIP_TRIGGER_NOT_WHEN_GIBBED | If used, an implant will NOT trigger on death when a user is gibbed. |
| BIOCHIP_ACTIVATED_PASSIVE | The implant is passively active (like a mindshield) |
| BIOCHIP_ACTIVATED_ACTIVE | The implant is activated manually by a trigger |
+ The implant is activated manually by a trigger
+ The implant is passively active (like a mindshield)
+ If used, an implant will always trigger when the user makes an emote.
+ If used, an implant will trigger when an emote is intentionally used.
+ If used, an implant will trigger when an emote is forced/unintentionally used.
+ If used, an implant will trigger any time a user dies.
+ If used, an implant will trigger on the user's first death.
+ If used, an implant will NOT trigger on death when a user is gibbed.
| VERB_CALLBACK | like CALLBACK but specifically for verb callbacks |
|---|
+ like CALLBACK but specifically for verb callbacks
| CHAT_RELIABILITY_HISTORY_SIZE | Copyright (c) 2020 Aleksej Komarov +SPDX-License-Identifier: MIT +How many chat payloads to keep in history |
|---|---|
| CHAT_RELIABILITY_MAX_RESENDS | How many resends to allow before giving up |
+ Copyright (c) 2020 Aleksej Komarov +SPDX-License-Identifier: MIT +How many chat payloads to keep in history
+ How many resends to allow before giving up
| MAX_EQUIPABLE_ACCESSORIES | max number of accessories that can be equiped to one piece of clothing |
|---|
+ max number of accessories that can be equiped to one piece of clothing
| COLOR_THEME_MIDNIGHT | Main colors for UI themes |
|---|---|
| COLORTONE_DEAD_EXT_ORGAN | Color for dead external organs/zombies |
+ Color for dead external organs/zombies
+ Main colors for UI themes
| SECONDS_TO_JITTER | Jitter decays at a rate of 3 per life cycle, 15 if resting. |
|---|---|
| SHAME | Stam crits the effected mob, as well as ensures they dont die from suicide |
| AUTOFIRE_STAT_IDLE | Compatible firemode is in the gun. Wait until it's held in the user hands. |
| AUTOFIRE_STAT_ALERT | Gun is active and in the user hands. Wait until user does a valid click. |
| AUTOFIRE_STAT_FIRING | Gun is shooting. |
+ Gun is active and in the user hands. Wait until user does a valid click.
+ Gun is shooting.
+ Compatible firemode is in the gun. Wait until it's held in the user hands.
+ Jitter decays at a rate of 3 per life cycle, 15 if resting.
+ Stam crits the effected mob, as well as ensures they dont die from suicide
| GIRDER_NORMAL | girder construction states |
|---|---|
| RWALL_INTACT | rwall construction states |
| WINDOW_OUT_OF_FRAME | window construction states |
| AIRLOCK_ASSEMBLY_NEEDS_WIRES | airlock assembly construction states |
| AICONTROLDISABLED_OFF | used by airlocks and airlock wires. |
| PLASTIC_FLAPS_NORMAL | plastic flaps construction states |
| MOUNTED_FRAME_SIMFLOOR | Mounted Frames BITMASK |
| EMPTY_CORE | ai core defines |
| NARSIE_WINDOW_COLOUR | other construction-related things +windows affected by nar'sie turn this color. |
| FULLTILE_WINDOW_DIR | let's just pretend fulltile windows being children of border windows is fine |
| TINT_CONTROL_RANGE_AREA | Range of a tint control button, that works only in its area. |
| TINT_CONTROL_GROUP_NONE | ID of a tint control button with no group specified, so it controls only windows also with no group specified ('null-like' id). |
| MAT_METAL | Material defines, for determining how much of a given material an item contains |
| MINERAL_MATERIAL_AMOUNT | The amount of materials you get from a sheet of mineral like iron/diamond/glass etc |
| MAX_STACK_SIZE | The maximum size of a stack object. |
| MAXCOIL | maximum amount of cable in a coil |
+ used by airlocks and airlock wires.
+ airlock assembly construction states
+ ai core defines
+ let's just pretend fulltile windows being children of border windows is fine
+ girder construction states
+ Material defines, for determining how much of a given material an item contains
+ maximum amount of cable in a coil
+ The maximum size of a stack object.
+ The amount of materials you get from a sheet of mineral like iron/diamond/glass etc
+ Mounted Frames BITMASK
+ other construction-related things +windows affected by nar'sie turn this color.
+ plastic flaps construction states
+ rwall construction states
+ ID of a tint control button with no group specified, so it controls only windows also with no group specified ('null-like' id).
+ Range of a tint control button, that works only in its area.
+ window construction states
| MAX_BLOODCHARGE | Maximum number of spells with an empowering rune |
|---|---|
| RUNELESS_MAX_BLOODCHARGE | Maximum number of spells without an empowering rune |
| CULT_POPULATION_THRESHOLD | At what population does it switch to highpop values |
| CULT_RISEN_LOW | Percent before rise (Lowpop) |
| CULT_ASCENDANT_LOW | Percent before ascend (Lowpop) |
| CULT_RISEN_HIGH | Percent before rise (Highpop) |
| CULT_ASCENDANT_HIGH | Percent before ascend (Highpop) |
| GET_CULT_DATA | Safely accesses SSticker.cult_data, returns the default if cult data is not set up yet. Allows for both variable and proc call access. |
| IS_CULTIST | Checks that the given element is living an has a cult antag datum |
+ Percent before ascend (Highpop)
+ Percent before ascend (Lowpop)
+ At what population does it switch to highpop values
+ Percent before rise (Highpop)
+ Percent before rise (Lowpop)
+ Safely accesses SSticker.cult_data, returns the default if cult data is not set up yet. Allows for both variable and proc call access.
+ Checks that the given element is living an has a cult antag datum
+ Maximum number of spells with an empowering rune
+ Maximum number of spells without an empowering rune
| COMPONENT_INCOMPATIBLE | Return this from /datum/component/Initialize or datum/component/OnTransfer to have the component be deleted if it's applied to an incorrect type.
+parent must not be modified if this is to be returned.
+This will be noted in the runtime logs |
|---|---|
| COMPONENT_NOTRANSFER | Returned in PostTransfer to prevent transfer, similar to COMPONENT_INCOMPATIBLE |
| ELEMENT_INCOMPATIBLE | Return value to cancel attaching |
| ELEMENT_DETACH_ON_HOST_DESTROY | Causes the detach proc to be called when the host object is being deleted |
| ELEMENT_BESPOKE | Only elements created with the same arguments given after id_arg_index share an element instance
+The arguments are the same when the text and number values are the same and all other values have the same ref |
| COMPONENT_DUPE_HIGHLANDER | old component is deleted (default) |
| COMPONENT_DUPE_ALLOWED | duplicates allowed |
| COMPONENT_DUPE_UNIQUE | new component is deleted |
| COMPONENT_DUPE_UNIQUE_PASSARGS | old component is given the initialization args of the new |
| COMPONENT_DUPE_SELECTIVE | each component of the same type is consulted as to whether the duplicate should be allowed |
+ duplicates allowed
+ old component is deleted (default)
+ each component of the same type is consulted as to whether the duplicate should be allowed
+ new component is deleted
+ old component is given the initialization args of the new
+ Return this from /datum/component/Initialize or datum/component/OnTransfer to have the component be deleted if it's applied to an incorrect type.
+parent must not be modified if this is to be returned.
+This will be noted in the runtime logs
+ Returned in PostTransfer to prevent transfer, similar to COMPONENT_INCOMPATIBLE
+ Only elements created with the same arguments given after id_arg_index share an element instance
+The arguments are the same when the text and number values are the same and all other values have the same ref
+ Causes the detach proc to be called when the host object is being deleted
+ Return value to cancel attaching
| SEND_SIGNAL | Used to trigger signals and call procs registered for that signal +The datum hosting the signal is automaticaly added as the first argument +Returns a bitfield gathered from all registered procs +Arguments given here are packaged in a list and given to _SendSignal |
|---|---|
| SIGNAL_HANDLER | Signifies that this proc is used to handle signals. +Every proc you pass to RegisterSignal must have this. |
| AddElement | A wrapper for _AddElement that allows us to pretend we're using normal named arguments |
| RemoveElement | A wrapper for _RemoveElement that allows us to pretend we're using normal named arguments |
| AddComponent | A wrapper for _AddComponent that allows us to pretend we're using normal named arguments |
+ A wrapper for _AddComponent that allows us to pretend we're using normal named arguments
+ A wrapper for _AddElement that allows us to pretend we're using normal named arguments
+ A wrapper for _RemoveElement that allows us to pretend we're using normal named arguments
+ Used to trigger signals and call procs registered for that signal +The datum hosting the signal is automaticaly added as the first argument +Returns a bitfield gathered from all registered procs +Arguments given here are packaged in a list and given to _SendSignal
+ Signifies that this proc is used to handle signals. +Every proc you pass to RegisterSignal must have this.
| COMSIG_GLOB_NEW_Z | from base of datum/controller/subsystem/mapping/proc/add_new_zlevel(): (list/args) |
|---|---|
| COMSIG_GLOB_VAR_EDIT | called after a successful var edit somewhere in the world: (list/args) |
| COMSIG_GLOB_EXPLOSION | called after an explosion happened : (epicenter, devastation_range, heavy_impact_range, light_impact_range, took, orig_dev_range, orig_heavy_range, orig_light_range) |
| COMSIG_GLOB_MOB_CREATED | mob was created somewhere : (mob) |
| COMSIG_GLOB_MOB_DEATH | mob died somewhere : (mob , gibbed) |
| COMSIG_GLOB_LIVING_SAY_SPECIAL | global living say plug - use sparingly: (mob/speaker , message) |
| COMSIG_GLOB_PLAY_CINEMATIC | called by datum/cinematic/play() : (datum/cinematic/new_cinematic) |
| COMSIG_GLOB_BUTTON_PRESSED | ingame button pressed (/obj/machinery/button/button) |
| COMSIG_GLOB_JOB_AFTER_SPAWN | job subsystem has spawned and equipped a new mob |
| COMSIG_GLOB_CABLE_UPDATED | cable was placed or joined somewhere : (turf) |
| COMSIG_SUN_MOVED | signals from globally accessible objects +from SSsun when the sun changes position : (azimuth) |
| COMSIG_SECURITY_LEVEL_CHANGE_PLANNED | from SSsecurity_level on planning security level change : (previous_level_number, new_level_number) |
| COMSIG_SECURITY_LEVEL_CHANGED | from SSsecurity_level when the security level changes : (previous_level_number, new_level_number) |
| COMSIG_COMPONENT_ADDED | when a component is added to a datum: (/datum/component) |
| COMSIG_COMPONENT_REMOVING | before a component is removed from a datum because of RemoveComponent: (/datum/component) |
| COMSIG_PARENT_PREQDELETED | before a datum's Destroy() is called: (force), returning a nonzero value will cancel the qdel operation |
| COMSIG_PARENT_QDELETING | just before a datum's Destroy() is called: (force), at this point none of the other components chose to interrupt qdel and Destroy will be called |
| COMSIG_TOPIC | generic topic handler (usr, href_list) |
| COMSIG_ELEMENT_ATTACH | fires on the target datum when an element is attached to it (/datum/element) |
| COMSIG_ELEMENT_DETACH | fires on the target datum when an element is attached to it (/datum/element) |
| COMSIG_ATOM_CREATED | from base of atom/proc/Initialize(): sent any time a new atom is created |
| COMSIG_PARENT_ATTACKBY | from base of atom/attackby(): (/obj/item, /mob/living, params) |
| COMPONENT_NO_AFTERATTACK | Return this in response if you don't want afterattack to be called |
| COMSIG_ATOM_HULK_ATTACK | from base of atom/attack_hulk(): (/mob/living/carbon/human) |
| COMSIG_ATOM_ATTACK_ANIMAL | from base of atom/animal_attack(): (/mob/user) |
| COMSIG_PARENT_EXAMINE | from base of atom/examine(): (/mob) |
| COMSIG_ATOM_GET_EXAMINE_NAME | from base of atom/get_examine_name(): (/mob, list/overrides) |
| COMSIG_ATOM_UPDATE_APPEARANCE | from base of /atom/proc/update_appearance: (updates) |
| COMSIG_ATOM_NO_UPDATE_NAME | If returned from COMSIG_ATOM_UPDATE_APPEARANCE it prevents the atom from updating its name. |
| COMSIG_ATOM_NO_UPDATE_DESC | If returned from COMSIG_ATOM_UPDATE_APPEARANCE it prevents the atom from updating its desc. |
| COMSIG_ATOM_NO_UPDATE_ICON | If returned from COMSIG_ATOM_UPDATE_APPEARANCE it prevents the atom from updating its icon. |
| COMSIG_ATOM_UPDATE_NAME | from base of /atom/proc/update_name: (updates) |
| COMSIG_ATOM_UPDATE_DESC | from base of /atom/proc/update_desc: (updates) |
| COMSIG_ATOM_UPDATE_ICON | from base of /atom/update_icon: () |
| COMSIG_ATOM_NO_UPDATE_ICON_STATE | If returned from COMSIG_ATOM_UPDATE_ICON it prevents the atom from updating its icon state. |
| COMSIG_ATOM_NO_UPDATE_OVERLAYS | If returned from COMSIG_ATOM_UPDATE_ICON it prevents the atom from updating its overlays. |
| COMSIG_ATOM_UPDATE_ICON_STATE | Sent after atom/update_icon_state is called by /atom/update_icon: () |
| COMSIG_ATOM_UPDATE_OVERLAYS | Sent after atom/update_overlays is called by /atom/update_icon: (list/new_overlays) |
| COMSIG_ATOM_UPDATED_ICON | from base of /atom/update_icon: (signalOut, did_anything) |
| COMSIG_ATOM_ENTERED | from base of atom/Entered(): (atom/movable/entering, /atom) |
| COMSIG_ATOM_EXIT | from base of atom/Exit(): (/atom/movable/exiting, /atom/newloc) |
| COMSIG_ATOM_EXITED | from base of atom/Exited(): (atom/movable/exiting, atom/newloc) |
| COMSIG_ATOM_BUMPED | from base of atom/Bumped(): (/atom/movable) |
| COMSIG_ATOM_EX_ACT | from base of atom/ex_act(): (severity, target) |
| COMSIG_ATOM_EMP_ACT | from base of atom/emp_act(): (severity) |
| COMSIG_ATOM_FIRE_ACT | from base of atom/fire_act(): (exposed_temperature, exposed_volume) |
| COMSIG_ATOM_BULLET_ACT | from base of atom/bullet_act(): (/obj/projectile, def_zone) |
| COMSIG_ATOM_BLOB_ACT | from base of atom/blob_act(): (/obj/structure/blob) |
| COMSIG_ATOM_ACID_ACT | from base of atom/acid_act(): (acidpwr, acid_volume) |
| COMSIG_ATOM_EMAG_ACT | from base of atom/emag_act(): (/mob/user) |
| COMSIG_ATOM_RAD_ACT | from base of atom/rad_act(intensity) |
| COMSIG_ATOM_NARSIE_ACT | from base of atom/narsie_act(): () |
| COMSIG_ATOM_RCD_ACT | from base of atom/rcd_act(): (/mob, /obj/item/construction/rcd, passed_mode) |
| COMSIG_ATOM_SING_PULL | from base of atom/singularity_pull(): (S, current_size) |
| COMSIG_ATOM_BSA_BEAM | from obj/machinery/bsa/full/proc/fire(): () |
| COMSIG_ATOM_SET_LIGHT | from base of atom/set_light(): (l_range, l_power, l_color) |
| COMSIG_ATOM_DIR_CHANGE | from base of atom/setDir(): (old_dir, new_dir) |
| COMSIG_ATOM_CONTENTS_DEL | from base of atom/handle_atom_del(): (atom/deleted) |
| COMSIG_ATOM_HAS_GRAVITY | from base of atom/has_gravity(): (turf/location, list/forced_gravities) |
| COMSIG_ATOM_RAD_PROBE | from proc/get_rad_contents(): () |
| COMSIG_ATOM_RAD_CONTAMINATING | from base of datum/radiation_wave/radiate(): (strength) |
| COMSIG_ATOM_RAD_WAVE_PASSING | from base of datum/radiation_wave/check_obstructions(): (datum/radiation_wave, width) |
| COMSIG_ATOM_SCREWDRIVER_ACT | from base of atom/screwdriver_act(): (mob/living/user, obj/item/I) |
| COMSIG_ATOM_WRENCH_ACT | from base of atom/wrench_act(): (mob/living/user, obj/item/I) |
| COMSIG_ATOM_MULTITOOL_ACT | from base of atom/multitool_act(): (mob/living/user, obj/item/I) |
| COMSIG_ATOM_WELDER_ACT | from base of atom/welder_act(): (mob/living/user, obj/item/I) |
| COMSIG_ATOM_WIRECUTTER_ACT | from base of atom/wirecutter_act(): (mob/living/user, obj/item/I) |
| COMSIG_ATOM_CROWBAR_ACT | from base of atom/crowbar_act(): (mob/living/user, obj/item/I) |
| COMSIG_ATOM_ANALYSER_ACT | from base of atom/analyser_act(): (mob/living/user, obj/item/I) |
| COMSIG_ATOM_INTERCEPT_TELEPORT | called when teleporting into a protected turf: (channel, turf/origin) |
| COMSIG_ATOM_HEARER_IN_VIEW | called when an atom is added to the hearers on get_hearers_in_view(): (list/processing_list, list/hearers) |
| COMSIG_ATOM_ORBIT_BEGIN | called when an atom starts orbiting another atom: (atom) |
| COMSIG_ATOM_ORBIT_STOP | called when an atom stops orbiting another atom: (atom) |
| COMSIG_ATOM_ORBITER_STOP | called on an atom who has stopped orbiting another atom (atom/orbiter, atom/formerly_orbited) |
| COMSIG_ATOM_HITBY | from base of atom/hitby(atom/movable/AM, skipcatch, hitpush, blocked, datum/thrownthing/throwingdatum) |
| COMSIG_ATOM_UPDATE_SHARPNESS | Called when an atom is sharpened or dulled. |
| COMSIG_ATOM_PREHIT | from base of atom/atom_prehit(obj/item/projectile/P): |
| COMPONENT_CANCEL_ATTACK_CHAIN | This response cancels the attack chain entirely. If sent early, it might cause some later effects to be skipped. |
| COMSIG_ATOM_INITIALIZED_ON | Called from atom/Initialize() of target: (atom/target) |
| COMSIG_ATOM_ATTACK_GHOST | from base of atom/attack_ghost(): (mob/dead/observer/ghost) |
| COMSIG_ATOM_ATTACK_HAND | from base of atom/attack_hand(): (mob/user) |
| COMSIG_ATOM_ATTACK_PAW | from base of atom/attack_paw(): (mob/user) |
| COMSIG_ATOM_INTERCEPT_Z_FALL | called for each movable in a turf contents on /turf/zImpact(): (atom/movable/A, levels) |
| COMSIG_ATOM_START_PULL | called on a movable (NOT living) when someone starts pulling it (atom/movable/puller, state, force) |
| COMSIG_LIVING_START_PULL | called on /living when someone starts pulling it (atom/movable/puller, state, force) |
| COMSIG_CLIENT_CLICK | from base of client/Click(): (atom/target, atom/location, control, params, mob/user) |
| COMSIG_CLIENT_MOUSEDOWN | from base of client/MouseDown(): (/client, object, location, control, params) |
| COMSIG_CLIENT_MOUSEUP | from base of client/MouseUp(): (/client, object, location, control, params) |
| COMSIG_CLIENT_MOUSEDRAG | from base of client/MouseUp(): (/client, object, location, control, params) |
| COMSIG_ENTER_AREA | from base of area/Entered(): (/area) |
| COMSIG_EXIT_AREA | from base of area/Exited(): (/area) |
| COMSIG_CLICK | from base of atom/Click(): (location, control, params, mob/user) |
| COMSIG_CLICK_SHIFT | from base of atom/ShiftClick(): (/mob) |
| COMSIG_CLICK_CTRL | from base of atom/CtrlClickOn(): (/mob) |
| COMSIG_CLICK_ALT | from base of atom/AltClick(): (/mob) |
| COMPONENT_CANCEL_ALTCLICK | Cancel the alt-click, since this isn't properly part of the attack chain |
| COMSIG_CLICK_CTRL_SHIFT | from base of atom/CtrlShiftClick(/mob) |
| COMSIG_MOUSEDROP_ONTO | from base of atom/MouseDrop(): (/atom/over, /mob/user) |
| COMSIG_MOUSEDROPPED_ONTO | from base of atom/MouseDrop_T: (/atom/from, /mob/user) |
| COMSIG_POWERNET_POWER_CHANGE | from base of /datum/local_powernet/proc/power_change() |
| COMSIG_AREA_ENTERED | from base of area/Entered(): (atom/movable/M) |
| COMSIG_AREA_EXITED | from base of area/Exited(): (atom/movable/M) |
| COMSIG_TURF_CHANGE | from base of turf/ChangeTurf(): (path, list/new_baseturfs, flags, list/transferring_comps) |
| COMSIG_TURF_HAS_GRAVITY | from base of atom/has_gravity(): (atom/asker, list/forced_gravities) |
| COMSIG_TURF_MULTIZ_NEW | from base of turf/New(): (turf/source, direction) |
| COMSIG_MOVABLE_PRE_MOVE | from base of atom/movable/Moved(): (/atom) |
| COMSIG_MOVABLE_MOVED | from base of atom/movable/Moved(): (/atom, dir) |
| COMSIG_MOVABLE_CROSS | from base of atom/movable/Cross(): (/atom/movable) |
| COMSIG_MOVABLE_CROSSED | from base of atom/movable/Crossed(): (/atom/movable) |
| COMSIG_CROSSED_MOVABLE | when we cross over something (calling Crossed() on that atom) |
| COMSIG_MOVABLE_UNCROSS | from base of atom/movable/Uncross(): (/atom/movable) |
| COMSIG_MOVABLE_UNCROSSED | from base of atom/movable/Uncrossed(): (/atom/movable) |
| COMSIG_MOVABLE_BUMP | from base of atom/movable/Bump(): (/atom) |
| COMSIG_MOVABLE_IMPACT | from base of atom/movable/throw_impact(): (/atom/hit_atom, /datum/thrownthing/throwingdatum) |
| COMSIG_MOVABLE_IMPACT_ZONE | from base of mob/living/hitby(): (mob/living/target, hit_zone) |
| COMSIG_MOVABLE_BUCKLE | from base of atom/movable/buckle_mob(): (mob, force) |
| COMSIG_MOVABLE_UNBUCKLE | from base of atom/movable/unbuckle_mob(): (mob, force) |
| COMSIG_MOVABLE_PRE_THROW | from base of atom/movable/throw_at(): (list/args) |
| COMSIG_MOVABLE_POST_THROW | from base of atom/movable/throw_at(): (datum/thrownthing, spin) |
| COMSIG_MOVABLE_THROW_LANDED | from base of datum/thrownthing/finalize(): (obj/thrown_object, datum/thrownthing) used for when a throw is finished |
| COMSIG_MOVABLE_Z_CHANGED | from base of atom/movable/onTransitZ(): (old_z, new_z) |
| COMSIG_MOVABLE_SECLUDED_LOCATION | called when the movable is placed in an unaccessible area, used for stationloving: () |
| COMSIG_MOVABLE_HEAR | from base of atom/movable/Hear(): (proc args list(message, atom/movable/speaker, message_language, raw_message, radio_freq, list/spans, message_mode)) |
| COMSIG_MOVABLE_TRY_UNTILT | Called just before something gets untilted |
| COMPONENT_BLOCK_UNTILT | Return this to block an untilt attempt |
| COMSIG_MOVABLE_UNTILTED | Called when something gets untilted, from /datum/element/tilted/proc/do_untilt(atom/movable/source, mob/user) |
| COMSIG_MOVABLE_DISPOSING | called when the movable is added to a disposal holder object for disposal movement: (obj/structure/disposalholder/holder, obj/machinery/disposal/source) |
| COMSIG_MOVABLE_EXIT_DISPOSALS | called when the movable is removed from a disposal holder object: /obj/structure/disposalpipe/proc/expel(): (obj/structure/disposalholder/H, turf/T, direction) |
| COMSIG_MIND_TRANSER_TO | from base of /datum/mind/proc/transfer_to(mob/living/new_character) |
| COMSIG_BODY_TRANSFER_TO | called on the mob instead of the mind |
| COMSIG_MIND_INITIALIZE | called when the mind is initialized (called every time the mob logins) |
| COMSIG_MOB_LOGIN | from base of /mob/Login(): () |
| COMSIG_HUMAN_LOGIN | called in human/login |
| COMSIG_MOB_LOGOUT | from base of /mob/Logout(): () |
| COMSIG_MOB_DEATH | from base of mob/death(): (gibbed) |
| COMSIG_MOB_STATCHANGE | from base of mob/set_stat(): (new_stat) |
| COMSIG_MOB_CLICKON | from base of mob/clickon(): (atom/A, params) |
| COMSIG_MOB_MIDDLECLICKON | from base of mob/MiddleClickOn(): (atom/A) |
| COMSIG_MOB_ALTCLICKON | from base of mob/AltClickOn(): (atom/A) |
| COMSIG_MOB_ALLOWED | from base of obj/allowed(mob/M): (/obj) returns bool, if TRUE the mob has id access to the obj |
| COMSIG_MOB_RECEIVE_MAGIC | from base of mob/anti_magic_check(): (mob/user, magic, holy, tinfoil, chargecost, self, protection_sources) |
| COMSIG_MOB_HUD_CREATED | from base of mob/create_mob_hud(): () |
| COMSIG_MOB_ATTACK_HAND | from base of atom/attack_hand(): (mob/user) |
| COMSIG_MOB_ITEM_ATTACK | from base of /obj/item/attack(): (mob/M, mob/user) |
| COMSIG_MOB_APPLY_DAMAGE | from base of /mob/living/proc/apply_damage(): (damage, damagetype, def_zone) |
| COMSIG_MOB_ITEM_AFTERATTACK | from base of obj/item/afterattack(): (atom/target, mob/user, proximity_flag, click_parameters) |
| COMSIG_MOB_ITEM_ATTACK_QDELETED | from base of obj/item/attack_qdeleted(): (atom/target, mob/user, proxiumity_flag, click_parameters) |
| COMSIG_MOB_ATTACK_RANGED | from base of mob/RangedAttack(): (atom/A, params) |
| COMSIG_MOB_THROW | from base of /mob/throw_item(): (atom/target) |
| COMSIG_MOB_WILLINGLY_DROP | called when a user willingly drops something (i.e. keybind, or UI action) |
| COMSIG_MOB_WEAPON_APPEARS | called when a user is getting new weapon and we want to remove previous weapon to clear hands |
| COMSIG_MOB_EXAMINATE | from base of /mob/verb/examinate(): (atom/target) |
| COMSIG_MOB_UPDATE_SIGHT | from base of /mob/update_sight(): () |
| COMSIG_MOB_SAY | from /mob/living/say(): () |
| COMSIG_MOB_DEADSAY | from /mob/say_dead(): (mob/speaker, message) |
| COMSIG_MOB_PREEMOTE | Signal fired when an emote is used but before it's executed. +from /datum/emote/proc/try_run_emote(): (key, intentional) |
| COMPONENT_BLOCK_EMOTE_UNUSABLE | Return this to block an emote and let the user know the emote is unusable. |
| COMPONENT_BLOCK_EMOTE_SILENT | Return this to block an emote silently. |
| COMSIG_MOB_EMOTE | General signal fired when a mob does any old emote +from /datum/emote/proc/run_emote(): (key, intentional) |
| COMSIG_MOB_EMOTED | Specific signal used to track when a specific emote is used. +From /datum/emote/run_emote(): (P, key, m_type, message, intentional) |
| COMSIG_MOB_EMOTE_AT | From /datum/emote/select_param(): (target, key, intentional) |
| COMSIG_MOB_SWAPPING_HANDS | from base of mob/swap_hand(): (obj/item) |
| COMPONENT_BLOCK_SWAP | Prevent the mob from changing hands |
| COMSIG_MOB_SWAPPED_HANDS | Performed after the hands are swapped. |
| COMSIG_LIVING_RESIST | from base of mob/living/resist() (/mob/living) |
| COMSIG_LIVING_IGNITED | from base of mob/living/IgniteMob() (/mob/living) |
| COMSIG_LIVING_EXTINGUISHED | from base of mob/living/ExtinguishMob() (/mob/living) |
| COMSIG_LIVING_ELECTROCUTE_ACT | from base of mob/living/electrocute_act(): (shock_damage, source, siemens_coeff, flags) |
| COMSIG_LIVING_SHOCK_PREVENTED | sent when items with siemen coeff. of 0 block a shock: (power_source, source, siemens_coeff, dist_check) |
| COMSIG_LIVING_MINOR_SHOCK | sent by stuff like stunbatons and tasers: () |
| COMSIG_LIVING_PRE_DEFIB | Sent from defibrillators when everything seems good and the user will be shocked: (defibber, defib_item, ghost) |
| COMPONENT_BLOCK_DEFIB | If returned from LIVING_BEFORE_DEFIB or LIVING_DEFIBBED, the defibrillation will fail |
| COMPONENT_DEFIB_OVERRIDE | If returned, don't even show the "failed" message, defer to the signal handler to do that. |
| COMPONENT_DEFIB_FAKEDEATH_ACCEPTED | If returned, allow to revive through false death. |
| COMPONENT_DEFIB_FAKEDEATH_DENIED | If returned, make the fake death look like a unresponsive ghost. |
| COMSIG_LIVING_DEFIBBED | send from defibs on ressurection: (defibber, defib_item, ghost) |
| COMSIG_LIVING_REVIVE | from base of mob/living/revive() (full_heal, admin_revive) |
| COMSIG_LIVING_REGENERATE_LIMBS | from base of /mob/living/regenerate_limbs(): (noheal, excluded_limbs) |
| COMSIG_LIVING_ATTACH_LIMB | from base of /obj/item/bodypart/proc/attach_limb(): (new_limb, special) allows you to fail limb attachment |
| COMSIG_PROCESS_BORGCHARGER_OCCUPANT | sent from borg recharge stations: (amount, repairs) |
| COMSIG_MOB_CLIENT_LOGIN | sent when a mob/login() finishes: (client) |
| COMSIG_BORG_SAFE_DECONSTRUCT | sent from borg mobs to itself, for tools to catch an upcoming destroy() due to safe decon (rather than detonation) |
| COMSIG_LIVING_FIRE_TICK | sent from living mobs every tick of fire |
| COMSIG_LIVING_STATUS_STUN | from base of mob/living/Stun() (amount, ignore_canstun) |
| COMSIG_LIVING_STATUS_WEAKEN | from base of mob/living/Stun() (amount, ignore_canstun) |
| COMSIG_LIVING_STATUS_PARALYSE | from base of mob/living/Knockdown() (amount, ignore_canstun) +#define COMSIG_LIVING_STATUS_KNOCKDOWN "living_knockdown" // one day +from base of mob/living/Paralyse() (amount, ignore_canstun) |
| COMSIG_LIVING_STATUS_IMMOBILIZE | from base of mob/living/Immobilize() (amount, ignore_canstun) |
| COMSIG_LIVING_STATUS_UNCONSCIOUS | from base of mob/living/Unconscious() (amount, ignore_canstun) |
| COMSIG_LIVING_STATUS_SLEEP | from base of mob/living/Sleeping() (amount, ignore_canstun) |
| COMSIG_LIVING_CAN_TRACK | from base of /mob/living/can_track(): (mob/user) |
| COMSIG_LIVING_WRITE_MEMORY | from base of mob/living/Write_Memory() |
| COMSIG_CARBON_SOUNDBANG | from base of mob/living/carbon/soundbang_act(): (list(intensity)) |
| COMSIG_CARBON_GAIN_ORGAN | from /item/organ/proc/Insert() (/obj/item/organ/) |
| COMSIG_CARBON_LOSE_ORGAN | from /item/organ/proc/Remove() (/obj/item/organ/) |
| COMSIG_CARBON_EQUIP_HAT | from /mob/living/carbon/doUnEquip(obj/item/I, force, newloc, no_move, invdrop, silent) |
| COMSIG_CARBON_UNEQUIP_HAT | from /mob/living/carbon/doUnEquip(obj/item/I, force, newloc, no_move, invdrop, silent) |
| COMSIG_CARBON_EMBED_RIP | defined twice, in carbon and human's topics, fired when interacting with a valid embedded_object to pull it out (mob/living/carbon/target, /obj/item, /obj/item/bodypart/L) |
| COMSIG_CARBON_EMBED_REMOVAL | called when removing a given item from a mob, from mob/living/carbon/remove_embedded_object(mob/living/carbon/target, /obj/item) |
| COMSIG_CARBON_SWAP_HANDS | From /mob/living/carbon/swap_hand(): Called when the user swaps their active hand |
| COMSIG_CARBON_TOGGLE_THROW | From /mob/living/carbon/toggle_throw_mode() |
| COMSIG_CARBON_THROWN_ITEM_CAUGHT | From /mob/living/carbon/human/hitby() |
| COMSIG_CARBON_FLASH_EYES | From /mob/living/carbon/flash_eyes() |
| COMSIG_CARBON_UPDATE_HANDCUFFED | From /mob/living/carbon/update_handcuffed() |
| COMSIG_CARBON_REGENERATE_ICONS | From /mob/living/carbon/regenerate_icons() |
| COMSIG_CARBON_ENTER_STAMINACRIT | From /mob/living/carbon/enter_stamcrit() |
| COMSIG_CARBON_EXIT_STAMINACRIT | From /mob/living/carbon/update_stamina() |
| COMSIG_CARBON_STAMINA_REGENERATED | From /mob/living/carbon/handle_status_effects() |
| COMSIG_OBJ_DECONSTRUCT | from base of obj/deconstruct(): (disassembled) |
| COMSIG_OBJ_SETANCHORED | called in /obj/structure/setAnchored(): (value) |
| COMSIG_OBJ_DEFAULT_UNFASTEN_WRENCH | from base of code/game/machinery |
| COMSIG_OBJ_HIDE | from base of /turf/proc/levelupdate(). (intact) true to hide and false to unhide |
| COMSIG_OBJ_UPDATE_ICON | called in /obj/update_icon() |
| COMSIG_MACHINERY_BROKEN | from /obj/machinery/obj_break(damage_flag): (damage_flag) |
| COMSIG_MACHINERY_POWER_LOST | from base power_change() when power is lost |
| COMSIG_MACHINERY_POWER_RESTORED | from base power_change() when power is restored |
| COMSIG_ITEM_ATTACK | from base of obj/item/attack(): (/mob/living/target, /mob/living/user) |
| COMSIG_ITEM_ATTACK_SELF | from base of obj/item/attack_self(): (/mob) |
| COMSIG_ITEM_ATTACK_OBJ | from base of obj/item/attack_obj(): (/obj, /mob) |
| COMSIG_ITEM_PRE_ATTACK | from base of obj/item/pre_attack(): (atom/target, mob/user, params) |
| COMSIG_ITEM_BEING_ATTACKED | from base of obj/item/pre_attack(): (atom/target, mob/user, params) |
| COMSIG_ITEM_AFTERATTACK | from base of obj/item/afterattack(): (atom/target, mob/user, params) |
| COMSIG_ITEM_ATTACK_QDELETED | from base of obj/item/attack_qdeleted(): (atom/target, mob/user, params) |
| COMSIG_ITEM_PRE_UNEQUIP | from base of obj/item/equipped(): (/mob/equipper, slot) +called on /obj/item before unequip from base of [mob/proc/doUnEquip]: (force, atom/newloc, no_move, invdrop, silent) |
| COMPONENT_ITEM_BLOCK_UNEQUIP | only the pre unequip can be cancelled |
| COMSIG_ITEM_DROPPED | from base of obj/item/dropped(): (mob/user) |
| COMSIG_ITEM_PICKUP | from base of obj/item/pickup(): (/mob/taker) |
| COMSIG_ITEM_ATTACK_ZONE | from base of mob/living/carbon/attacked_by(): (mob/living/carbon/target, mob/living/user, hit_zone) |
| COMSIG_ITEM_IMBUE_SOUL | return a truthy value to prevent ensouling, checked in /datum/spell/lichdom/cast(): (mob/user) |
| COMSIG_ITEM_MARK_RETRIEVAL | called before marking an object for retrieval, checked in /datum/spell/summonitem/cast() : (mob/user) |
| COMSIG_ITEM_HIT_REACT | from base of obj/item/hit_reaction(): (list/args) |
| COMSIG_ITEM_WEARERCROSSED | called on item when crossed by something (): (/atom/movable, mob/living/crossed) |
| COMSIG_ITEM_MICROWAVE_ACT | called on item when microwaved (): (obj/machinery/microwave/M) |
| COMSIG_ITEM_SHARPEN_ACT | from base of item/sharpener/attackby(): (amount, max) |
| COMSIG_TOOL_IN_USE | from base of [/obj/item/proc/tool_check_callback]: (mob/living/user) |
| COMSIG_TOOL_START_USE | from base of [/obj/item/proc/tool_start_check]: (mob/living/user) |
| COMSIG_TOOL_ATTACK | from base of [/obj/item/proc/tool_attack_chain]: (atom/tool, mob/user) |
| COMSIG_ITEM_DISABLE_EMBED | from [/obj/item/proc/disableEmbedding]: |
| COMSIG_MINE_TRIGGERED | from [/obj/effect/mine/proc/triggermine]: |
| COMSIG_ITEM_GET_WORN_OVERLAYS | Called by /obj/item/proc/worn_overlays(list/overlays, mutable_appearance/standing, isinhands, icon_file) |
| COMSIG_ASSEMBLY_PULSED | Called by /obj/item/assembly/signaler(called_from_radio) |
| COMSIG_DEFIB_PADDLES_APPLIED | Defib-specific signals +Called when a defibrillator is first applied to someone. (mob/living/user, mob/living/target, harmful) |
| COMPONENT_BLOCK_DEFIB_DEAD | Defib is out of power. |
| COMPONENT_BLOCK_DEFIB_MISC | Something else: we won't have a custom message for this and should let the defib handle it. |
| COMSIG_DEFIB_SHOCK_APPLIED | Called when a defib has been successfully used, and a shock has been applied. (mob/living/user, mob/living/target, harmful, successful) |
| COMSIG_DEFIB_READY | Called when a defib's cooldown has run its course and it is once again ready. () |
| COMSIG_ITEM_SOLD | called when an item is sold by the exports subsystem |
| COMSIG_STRUCTURE_UNWRAPPED | called when a wrapped up structure is opened by hand |
| COMSIG_ITEM_SPLIT_VALUE | called when a wrapped up item is opened by hand |
| COMSIG_ITEM_SPLIT_PROFIT | called when getting the item's exact ratio for cargo's profit. |
| COMSIG_ITEM_SPLIT_PROFIT_DRY | called when getting the item's exact ratio for cargo's profit, without selling the item. |
| COMSIG_SHOES_STEP_ACTION | from [/mob/living/carbon/human/Move]: () |
| COMSIG_SUIT_SPACE_TOGGLE | from base of /obj/item/clothing/suit/space/proc/toggle_spacesuit(): (obj/item/clothing/suit/space/suit) |
| COMSIG_IMPLANT_ACTIVATED | from base of /obj/item/bio_chip/proc/activate(): () |
| COMSIG_IMPLANT_IMPLANTING | from base of /obj/item/bio_chip/proc/implant(): (list/args) |
| COMSIG_IMPLANT_OTHER | called on already installed implants when a new one is being added in /obj/item/bio_chip/proc/implant(): (list/args, obj/item/bio_chip/new_implant) |
| COMSIG_IMPLANT_EXISTING_UPLINK | called on implants being implanted into someone with an uplink implant: (datum/component/uplink) |
| COMSIG_IMPLANT_IMPLANTED | called on implants, after a successful implantation: (mob/living/target, mob/user, silent, force) |
| COMSIG_IMPLANT_REMOVED | called on implants, after an implant has been removed: (mob/living/source, silent, special) |
| COMSIG_PDA_CHANGE_RINGTONE | called on pda when the user changes the ringtone: (mob/living/user, new_ringtone) |
| COMSIG_RADIO_NEW_FREQUENCY | called from base of /obj/item/radio/proc/set_frequency(): (list/args) |
| COMSIG_PEN_ROTATED | called after rotation in /obj/item/pen/attack_self(): (rotation, mob/living/carbon/user) |
| COMSIG_GUN_TRY_FIRE | called in /obj/item/gun/fire_gun (user, target, flag, params) |
| COMSIG_MOB_TRY_FIRE | called in /obj/item/gun/afterattack (user, target, flag, params) |
| COMSIG_GUN_FIRED | called in /obj/item/gun/process_fire (user, target) |
| COMSIG_AUTOFIRE_ONMOUSEDOWN | called in /datum/component/automatic_fire/proc/on_mouse_down: (client/clicker, atom/target, turf/location, control, params) |
| COMSIG_AUTOFIRE_SHOT | called in /datum/component/automatic_fire/proc/process_shot(): (atom/target, mob/living/shooter, allow_akimbo, params) |
| COMSIG_GRENADE_PRIME | called in /obj/item/gun/process_fire (user, target, params, zone_override) |
| COMSIG_GRENADE_ARMED | called in /obj/item/gun/process_fire (user, target, params, zone_override) |
| COMSIG_PROJECTILE_SELF_ON_HIT | from base of /obj/projectile/proc/on_hit(): (atom/movable/firer, atom/target, Angle) |
| COMSIG_PROJECTILE_ON_HIT | from base of /obj/projectile/proc/on_hit(): (atom/movable/firer, atom/target, Angle) |
| COMSIG_PROJECTILE_BEFORE_FIRE | from base of /obj/projectile/proc/fire(): (obj/projectile, atom/original_target) |
| COMSIG_PROJECTILE_FIRE | from the base of /obj/projectile/proc/fire(): () |
| COMSIG_PROJECTILE_PREHIT | sent to targets during the process_hit proc of projectiles |
| COMSIG_PROJECTILE_RANGE_OUT | sent to targets during the process_hit proc of projectiles |
| COMSIG_EMBED_TRY_FORCE | sent when trying to force an embed (mainly for projectiles, only used in the embed element) |
| COMSIG_PELLET_CLOUD_INIT | sent to targets during the process_hit proc of projectiles |
| COMSIG_MECHA_ACTION_ACTIVATE | sent from mecha action buttons to the mecha they're linked to |
| COMSIG_HUMAN_EARLY_UNARMED_ATTACK | from mob/living/carbon/human/UnarmedAttack(): (atom/target, proximity) |
| COMSIG_HUMAN_MELEE_UNARMED_ATTACK | from mob/living/carbon/human/UnarmedAttack(): (atom/target, proximity) |
| COMSIG_HUMAN_MELEE_UNARMED_ATTACKBY | from mob/living/carbon/human/UnarmedAttack(): (mob/living/carbon/human/attacker) |
| COMSIG_HUMAN_DISARM_HIT | Hit by successful disarm attack (mob/living/carbon/human/attacker,zone_targeted) |
| COMSIG_JOB_RECEIVED | Whenever EquipRanked is called, called after job is set |
| COMSIG_HUMAN_CHANGE_BODY_ACCESSORY | From mob/living/carbon/human/change_body_accessory(): (mob/living/carbon/human/H, body_accessory_style) |
| COMSIG_HUMAN_CHANGE_HEAD_ACCESSORY | From mob/living/carbon/human/change_head_accessory(): (mob/living/carbon/human/H, head_accessory_style) |
| COMSIG_LIVING_MOB_BUMP | From base of mob/living/MobBump() (mob/living) |
| COMSIG_HUMAN_SUICIDE_ACT | From mob/living/carbon/human/do_suicide() |
| COMSIG_HUMAN_RECEIVE_CPR | Sent from mob/living/carbon/human/do_cpr(): (mob/living/carbon/human/H, new_seconds_of_life) |
| COMSIG_HUMAN_ATTACKED | From mob/living/carbon/human/attackedby(): (mob/living/carbon/human/attacker). Also found on species/disarm and species/harm |
| COMSIG_HUMAN_CHECK_SHIELDS | from /mob/living/carbon/human/proc/check_shields(): (atom/hit_by, damage, attack_text, attack_type, armour_penetration, damage_type) |
| COMSIG_HUMAN_CREATE_MOB_HUD | from /mob/living/carbon/human/create_mob_hud() |
| COMSIG_SPECIES_GAIN | from datum/species/on_species_gain(): (datum/species/new_species, datum/species/old_species) |
| COMSIG_SPECIES_LOSS | from datum/species/on_species_loss(): (datum/species/lost_species) |
| COMSIG_SONG_START | sent to the instrument when a song starts playing |
| COMSIG_SONG_END | sent to the instrument when a song stops playing |
| COMSIG_TURF_IS_WET | Component Specific Signals +(): Returns bitflags of wet values. |
| COMSIG_TURF_MAKE_DRY | (max_strength, immediate, duration_decrease = INFINITY): Returns bool. |
| COMSIG_COMPONENT_CLEAN_ACT | called on an object to clean it of cleanables. Usualy with soap: (num/strength) |
| COMSIG_COMPONENT_CLEAN_FACE_ACT | called when you wash your face at a sink: (num/strength) |
| COMSIG_FOOD_EATEN | from base of obj/item/food/snacks/attack(): (mob/living/eater, mob/feeder) |
| COMSIG_ATOM_EXPOSE_REAGENTS | from base of atom/expose_reagents(): (/list, /datum/reagents, chemholder, volume_modifier) |
| COMSIG_GIBS_STREAK | from base of /obj/effect/decal/cleanable/blood/gibs/streak(): (list/directions, list/diseases) |
| COMSIG_ADD_MOOD_EVENT | called when you send a mood event from anywhere in the code. |
| COMSIG_ADD_MOOD_EVENT_RND | Mood event that only RnD members listen for |
| COMSIG_CLEAR_MOOD_EVENT | called when you clear a mood event from anywhere in the code. |
| COMSIG_COMPONENT_NTNET_RECEIVE | called on an object by its NTNET connection component on receive. (sending_id(number), sending_netname(text), data(datum/netdata)) |
| COMSIG_HAS_NANITES | () returns TRUE if nanites are found |
| COMSIG_NANITE_IS_STEALTHY | () returns TRUE if nanites have stealth |
| COMSIG_NANITE_DELETE | () deletes the nanite component |
| COMSIG_NANITE_GET_PROGRAMS | (list/nanite_programs) - makes the input list a copy the nanites' program list |
| COMSIG_NANITE_GET_VOLUME | (amount) Returns nanite amount |
| COMSIG_NANITE_SET_VOLUME | (amount) Sets current nanite volume to the given amount |
| COMSIG_NANITE_ADJUST_VOLUME | (amount) Adjusts nanite volume by the given amount |
| COMSIG_NANITE_SET_MAX_VOLUME | (amount) Sets maximum nanite volume to the given amount |
| COMSIG_NANITE_SET_CLOUD | (amount(0-100)) Sets cloud ID to the given amount |
| COMSIG_NANITE_SET_CLOUD_SYNC | (method) Modify cloud sync status. Method can be toggle, enable or disable |
| COMSIG_NANITE_SET_SAFETY | (amount) Sets safety threshold to the given amount |
| COMSIG_NANITE_SET_REGEN | (amount) Sets regeneration rate to the given amount |
| COMSIG_NANITE_SIGNAL | (code(1-9999)) Called when sending a nanite signal to a mob. |
| COMSIG_NANITE_COMM_SIGNAL | (comm_code(1-9999), comm_message) Called when sending a nanite comm signal to a mob. |
| COMSIG_NANITE_SCAN | (mob/user, full_scan) - sends to chat a scan of the nanites to the user, returns TRUE if nanites are detected |
| COMSIG_NANITE_UI_DATA | (list/data, scan_level) - adds nanite data to the given data list - made for ui_data procs |
| COMSIG_NANITE_ADD_PROGRAM | (datum/nanite_program/new_program, datum/nanite_program/source_program) Called when adding a program to a nanite component |
| COMPONENT_PROGRAM_INSTALLED | Installation successful |
| COMPONENT_PROGRAM_NOT_INSTALLED | Installation failed, but there are still nanites |
| COMSIG_NANITE_SYNC | (datum/component/nanites, full_overwrite, copy_activation) Called to sync the target's nanites to a given nanite component |
| COMSIG_CONTAINS_STORAGE | () - returns bool. |
| COMSIG_TRY_STORAGE_INSERT | (obj/item/inserting, mob/user, silent, force) - returns bool |
| COMSIG_TRY_STORAGE_SHOW | (mob/show_to, force) - returns bool. |
| COMSIG_TRY_STORAGE_HIDE_FROM | (mob/hide_from) - returns bool |
| COMSIG_TRY_STORAGE_HIDE_ALL | returns bool |
| COMSIG_TRY_STORAGE_SET_LOCKSTATE | (newstate) |
| COMSIG_IS_STORAGE_LOCKED | () - returns bool. MUST CHECK IF STORAGE IS THERE FIRST! |
| COMSIG_TRY_STORAGE_TAKE_TYPE | (type, atom/destination, amount = INFINITY, check_adjacent, force, mob/user, list/inserted) - returns bool - type can be a list of types. |
| COMSIG_TRY_STORAGE_FILL_TYPE | (type, amount = INFINITY, force = FALSE). Force will ignore max_items, and amount is normally clamped to max_items. |
| COMSIG_TRY_STORAGE_TAKE | (obj, new_loc, force = FALSE) - returns bool |
| COMSIG_TRY_STORAGE_QUICK_EMPTY | (loc) - returns bool - if loc is null it will dump at parent location. |
| COMSIG_TRY_STORAGE_RETURN_INVENTORY | (list/list_to_inject_results_into, recursively_search_inside_storages = TRUE) |
| COMSIG_TRY_STORAGE_CAN_INSERT | (obj/item/insertion_candidate, mob/user, silent) - returns bool |
| COMSIG_TWOHANDED_WIELD | from base of datum/component/two_handed/proc/wield(mob/living/carbon/user): (/mob/user) |
| COMSIG_TWOHANDED_UNWIELD | from base of datum/component/two_handed/proc/unwield(mob/living/carbon/user): (/mob/user) |
| COMSIG_ACTION_TRIGGER | from base of datum/action/proc/Trigger(): (datum/action) |
| COMSIG_ACTION_GRANTED | From /datum/action/Grant(): (mob/grant_to) |
| COMSIG_MOB_GRANTED_ACTION | From /datum/action/Grant(): (datum/action) |
| COMSIG_ACTION_REMOVED | From /datum/action/Remove(): (mob/removed_from) |
| COMSIG_MOB_REMOVED_ACTION | From /datum/action/Remove(): (datum/action) |
| COMSIG_ACTION_SCROLLED | From base of /atom/movable/screen/movable/action_button/MouseWheel(src, delta_x, delta_y, location, control, params) |
| COMSIG_GHOST_START_OBSERVING | from observer_base/do_observe(): (mob/now_followed) |
| COMSIG_GHOST_STOP_OBSERVING | from observer_base/do_observe(): (mob/no_longer_following) |
| COMSIG_XENO_SLIME_CLICK_CTRL | from slime CtrlClickOn(): (/mob) |
| COMSIG_XENO_SLIME_CLICK_ALT | from slime AltClickOn(): (/mob) |
| COMSIG_XENO_SLIME_CLICK_SHIFT | from slime ShiftClickOn(): (/mob) |
| COMSIG_XENO_TURF_CLICK_SHIFT | from turf ShiftClickOn(): (/mob) |
| COMSIG_XENO_TURF_CLICK_CTRL | from turf AltClickOn(): (/mob) |
| COMSIG_XENO_MONKEY_CLICK_CTRL | from monkey CtrlClickOn(): (/mob) |
| COMSIG_TRIGGERED_ALARM | Alarm manager signals |
| COMSIG_OBJECTIVE_TARGET_FOUND | from datum/objective/proc/find_target(list/target_blacklist) |
| COMSIG_OBJECTIVE_CHECK_VALID_TARGET | from datum/objective/is_invalid_target() |
| COMSIG_MOD_MODULE_SELECTED | Called when a module is selected to be the active one from on_select(obj/item/mod/module/module) |
| COMSIG_MOD_DEPLOYED | Called when a MOD deploys one or more of its parts. |
| COMSIG_MOD_RETRACTED | Called when a MOD retracts one or more of its parts. |
| COMSIG_MOD_TOGGLED | Called when a MOD is finished toggling itself. |
| COMSIG_MOD_ACTIVATE | Called when a MOD activation is called from toggle_activate(mob/user) |
| MOD_CANCEL_ACTIVATE | Cancels the suit's activation |
| COMSIG_MOD_MODULE_REMOVED | Called when a MOD finishes having a module removed from it. |
| COMSIG_MOD_MODULE_ADDED | Called when a MOD finishes having a module added to it. |
| COMSIG_MOD_MODULE_REMOVAL | Called when a MOD is having modules removed from crowbar_act(mob/user, obj/crowbar) |
| MOD_CANCEL_REMOVAL | Cancels the removal of modules |
| COMSIG_MODULE_TRIGGERED | Called when a module attempts to activate, however it does. At the end of checks so you can add some yourself, or work on trigger behavior (mob/user) |
| MOD_ABORT_USE | Cancels activation, with no message. Include feedback on your cancel. |
| COMSIG_MODULE_ACTIVATED | Called when a module activates, after all checks have passed and cooldown started. |
| COMSIG_MODULE_DEACTIVATED | Called when a module deactivates, after all checks have passed. |
| COMSIG_MODULE_USED | Called when a module is used, after all checks have passed and cooldown started. |
| COMSIG_MOD_WEARER_SET | Called when the MODsuit wearer is set. |
| COMSIG_MOD_WEARER_UNSET | Called when the MODsuit wearer is unset. |
| COMSIG_TICKER_ROUND_STARTING | Called when the round has started, but before GAME_STATE_PLAYING. |
| COMSIG_CURSED_SLOT_MACHINE_USE | from /obj/structure/cursed_slot_machine/handle_status_effect() when someone pulls the handle on the slot machine |
| SLOT_MACHINE_USE_CANCEL | we've used up the number of times we may use this slot machine. womp womp. |
| SLOT_MACHINE_USE_POSTPONE | we haven't used up all our attempts to gamble away our life but we should chill for a few seconds |
| COMSIG_CURSED_SLOT_MACHINE_LOST | from /obj/structure/cursed_slot_machine/determine_victor() when someone loses. |
| COMSIG_GLOB_CURSED_SLOT_MACHINE_WON | from /obj/structure/cursed_slot_machine/determine_victor() when someone finally wins. |
| COMSIG_DO_MOB_STRIP | from of mob/MouseDrop(): (/atom/over, /mob/user) |
| COMSIG_ADMIN_DECONTAMINATE | Used by admin-tooling to remove radiation |
| COMSIG_SHADE_TO_CONSTRUCT_TRANSFER | Sent when bodies transfer between shades/shards and constructs |
+ If returned from LIVING_BEFORE_DEFIB or LIVING_DEFIBBED, the defibrillation will fail
+ Defib is out of power.
+ Something else: we won't have a custom message for this and should let the defib handle it.
+ Return this to block an emote silently.
+ Return this to block an emote and let the user know the emote is unusable.
+ Prevent the mob from changing hands
+ Return this to block an untilt attempt
+ Cancel the alt-click, since this isn't properly part of the attack chain
+ This response cancels the attack chain entirely. If sent early, it might cause some later effects to be skipped.
+ If returned, allow to revive through false death.
+ If returned, make the fake death look like a unresponsive ghost.
+ If returned, don't even show the "failed" message, defer to the signal handler to do that.
+ only the pre unequip can be cancelled
+ Return this in response if you don't want afterattack to be called
+ Installation successful
+ Installation failed, but there are still nanites
+ From /datum/action/Grant(): (mob/grant_to)
+ From /datum/action/Remove(): (mob/removed_from)
+ From base of /atom/movable/screen/movable/action_button/MouseWheel(src, delta_x, delta_y, location, control, params)
+ from base of datum/action/proc/Trigger(): (datum/action)
+ called when you send a mood event from anywhere in the code.
+ Mood event that only RnD members listen for
+ Used by admin-tooling to remove radiation
+ from base of area/Entered(): (atom/movable/M)
+ from base of area/Exited(): (atom/movable/M)
+ Called by /obj/item/assembly/signaler(called_from_radio)
+ from base of atom/acid_act(): (acidpwr, acid_volume)
+ from base of atom/analyser_act(): (mob/living/user, obj/item/I)
+ from base of atom/animal_attack(): (/mob/user)
+ from base of atom/attack_ghost(): (mob/dead/observer/ghost)
+ from base of atom/attack_hand(): (mob/user)
+ from base of atom/attack_paw(): (mob/user)
+ from base of atom/blob_act(): (/obj/structure/blob)
+ from obj/machinery/bsa/full/proc/fire(): ()
+ from base of atom/bullet_act(): (/obj/projectile, def_zone)
+ from base of atom/Bumped(): (/atom/movable)
+ from base of atom/handle_atom_del(): (atom/deleted)
+ from base of atom/proc/Initialize(): sent any time a new atom is created
+ from base of atom/crowbar_act(): (mob/living/user, obj/item/I)
+ from base of atom/setDir(): (old_dir, new_dir)
+ from base of atom/emag_act(): (/mob/user)
+ from base of atom/emp_act(): (severity)
+ from base of atom/Entered(): (atom/movable/entering, /atom)
+ from base of atom/Exit(): (/atom/movable/exiting, /atom/newloc)
+ from base of atom/Exited(): (atom/movable/exiting, atom/newloc)
+ from base of atom/expose_reagents(): (/list, /datum/reagents, chemholder, volume_modifier)
+ from base of atom/ex_act(): (severity, target)
+ from base of atom/fire_act(): (exposed_temperature, exposed_volume)
+ from base of atom/get_examine_name(): (/mob, list/overrides)
+ from base of atom/has_gravity(): (turf/location, list/forced_gravities)
+ called when an atom is added to the hearers on get_hearers_in_view(): (list/processing_list, list/hearers)
+ from base of atom/hitby(atom/movable/AM, skipcatch, hitpush, blocked, datum/thrownthing/throwingdatum)
+ from base of atom/attack_hulk(): (/mob/living/carbon/human)
+ Called from atom/Initialize() of target: (atom/target)
+ called when teleporting into a protected turf: (channel, turf/origin)
+ called for each movable in a turf contents on /turf/zImpact(): (atom/movable/A, levels)
+ from base of atom/multitool_act(): (mob/living/user, obj/item/I)
+ from base of atom/narsie_act(): ()
+ If returned from COMSIG_ATOM_UPDATE_APPEARANCE it prevents the atom from updating its desc.
+ If returned from COMSIG_ATOM_UPDATE_APPEARANCE it prevents the atom from updating its icon.
+ If returned from COMSIG_ATOM_UPDATE_ICON it prevents the atom from updating its icon state.
+ If returned from COMSIG_ATOM_UPDATE_APPEARANCE it prevents the atom from updating its name.
+ If returned from COMSIG_ATOM_UPDATE_ICON it prevents the atom from updating its overlays.
+ called on an atom who has stopped orbiting another atom (atom/orbiter, atom/formerly_orbited)
+ called when an atom starts orbiting another atom: (atom)
+ called when an atom stops orbiting another atom: (atom)
+ from base of atom/atom_prehit(obj/item/projectile/P):
+ from base of atom/rad_act(intensity)
+ from base of datum/radiation_wave/radiate(): (strength)
+ from proc/get_rad_contents(): ()
+ from base of datum/radiation_wave/check_obstructions(): (datum/radiation_wave, width)
+ from base of atom/rcd_act(): (/mob, /obj/item/construction/rcd, passed_mode)
+ from base of atom/screwdriver_act(): (mob/living/user, obj/item/I)
+ from base of atom/set_light(): (l_range, l_power, l_color)
+ from base of atom/singularity_pull(): (S, current_size)
+ called on a movable (NOT living) when someone starts pulling it (atom/movable/puller, state, force)
+ from base of /atom/update_icon: (signalOut, did_anything)
+ from base of /atom/proc/update_appearance: (updates)
+ from base of /atom/proc/update_desc: (updates)
+ from base of /atom/update_icon: ()
+ Sent after atom/update_icon_state is called by /atom/update_icon: ()
+ from base of /atom/proc/update_name: (updates)
+ Sent after atom/update_overlays is called by /atom/update_icon: (list/new_overlays)
+ Called when an atom is sharpened or dulled.
+ from base of atom/welder_act(): (mob/living/user, obj/item/I)
+ from base of atom/wirecutter_act(): (mob/living/user, obj/item/I)
+ from base of atom/wrench_act(): (mob/living/user, obj/item/I)
+ called in /datum/component/automatic_fire/proc/on_mouse_down: (client/clicker, atom/target, turf/location, control, params)
+ called in /datum/component/automatic_fire/proc/process_shot(): (atom/target, mob/living/shooter, allow_akimbo, params)
+ called on the mob instead of the mind
+ sent from borg mobs to itself, for tools to catch an upcoming destroy() due to safe decon (rather than detonation)
+ called when removing a given item from a mob, from mob/living/carbon/remove_embedded_object(mob/living/carbon/target, /obj/item)
+ defined twice, in carbon and human's topics, fired when interacting with a valid embedded_object to pull it out (mob/living/carbon/target, /obj/item, /obj/item/bodypart/L)
+ From /mob/living/carbon/enter_stamcrit()
+ from /mob/living/carbon/doUnEquip(obj/item/I, force, newloc, no_move, invdrop, silent)
+ From /mob/living/carbon/update_stamina()
+ From /mob/living/carbon/flash_eyes()
+ from /item/organ/proc/Insert() (/obj/item/organ/)
+ from /item/organ/proc/Remove() (/obj/item/organ/)
+ From /mob/living/carbon/regenerate_icons()
+ from base of mob/living/carbon/soundbang_act(): (list(intensity))
+ From /mob/living/carbon/handle_status_effects()
+ From /mob/living/carbon/swap_hand(): Called when the user swaps their active hand
+ From /mob/living/carbon/human/hitby()
+ From /mob/living/carbon/toggle_throw_mode()
+ from /mob/living/carbon/doUnEquip(obj/item/I, force, newloc, no_move, invdrop, silent)
+ From /mob/living/carbon/update_handcuffed()
+ called when you clear a mood event from anywhere in the code.
+ from base of atom/Click(): (location, control, params, mob/user)
+ from base of atom/AltClick(): (/mob)
+ from base of atom/CtrlClickOn(): (/mob)
+ from base of atom/CtrlShiftClick(/mob)
+ from base of atom/ShiftClick(): (/mob)
+ from base of client/Click(): (atom/target, atom/location, control, params, mob/user)
+ from base of client/MouseDown(): (/client, object, location, control, params)
+ from base of client/MouseUp(): (/client, object, location, control, params)
+ from base of client/MouseUp(): (/client, object, location, control, params)
+ when a component is added to a datum: (/datum/component)
+ called on an object to clean it of cleanables. Usualy with soap: (num/strength)
+ called when you wash your face at a sink: (num/strength)
+ called on an object by its NTNET connection component on receive. (sending_id(number), sending_netname(text), data(datum/netdata))
+ before a component is removed from a datum because of RemoveComponent: (/datum/component)
+ () - returns bool.
+ when we cross over something (calling Crossed() on that atom)
+ from /obj/structure/cursed_slot_machine/determine_victor() when someone loses.
+ from /obj/structure/cursed_slot_machine/handle_status_effect() when someone pulls the handle on the slot machine
+ Defib-specific signals +Called when a defibrillator is first applied to someone. (mob/living/user, mob/living/target, harmful)
+ Called when a defib's cooldown has run its course and it is once again ready. ()
+ Called when a defib has been successfully used, and a shock has been applied. (mob/living/user, mob/living/target, harmful, successful)
+ from of mob/MouseDrop(): (/atom/over, /mob/user)
+ fires on the target datum when an element is attached to it (/datum/element)
+ fires on the target datum when an element is attached to it (/datum/element)
+ sent when trying to force an embed (mainly for projectiles, only used in the embed element)
+ from base of area/Entered(): (/area)
+ from base of area/Exited(): (/area)
+ from base of obj/item/food/snacks/attack(): (mob/living/eater, mob/feeder)
+ from observer_base/do_observe(): (mob/now_followed)
+ from observer_base/do_observe(): (mob/no_longer_following)
+ from base of /obj/effect/decal/cleanable/blood/gibs/streak(): (list/directions, list/diseases)
+ ingame button pressed (/obj/machinery/button/button)
+ cable was placed or joined somewhere : (turf)
+ from /obj/structure/cursed_slot_machine/determine_victor() when someone finally wins.
+ called after an explosion happened : (epicenter, devastation_range, heavy_impact_range, light_impact_range, took, orig_dev_range, orig_heavy_range, orig_light_range)
+ job subsystem has spawned and equipped a new mob
+ global living say plug - use sparingly: (mob/speaker , message)
+ mob was created somewhere : (mob)
+ mob died somewhere : (mob , gibbed)
+ from base of datum/controller/subsystem/mapping/proc/add_new_zlevel(): (list/args)
+ called by datum/cinematic/play() : (datum/cinematic/new_cinematic)
+ called after a successful var edit somewhere in the world: (list/args)
+ called in /obj/item/gun/process_fire (user, target, params, zone_override)
+ called in /obj/item/gun/process_fire (user, target, params, zone_override)
+ called in /obj/item/gun/process_fire (user, target)
+ called in /obj/item/gun/fire_gun (user, target, flag, params)
+ () returns TRUE if nanites are found
+ From mob/living/carbon/human/attackedby(): (mob/living/carbon/human/attacker). Also found on species/disarm and species/harm
+ From mob/living/carbon/human/change_body_accessory(): (mob/living/carbon/human/H, body_accessory_style)
+ From mob/living/carbon/human/change_head_accessory(): (mob/living/carbon/human/H, head_accessory_style)
+ from /mob/living/carbon/human/proc/check_shields(): (atom/hit_by, damage, attack_text, attack_type, armour_penetration, damage_type)
+ from /mob/living/carbon/human/create_mob_hud()
+ Hit by successful disarm attack (mob/living/carbon/human/attacker,zone_targeted)
+ from mob/living/carbon/human/UnarmedAttack(): (atom/target, proximity)
+ called in human/login
+ from mob/living/carbon/human/UnarmedAttack(): (atom/target, proximity)
+ from mob/living/carbon/human/UnarmedAttack(): (mob/living/carbon/human/attacker)
+ Sent from mob/living/carbon/human/do_cpr(): (mob/living/carbon/human/H, new_seconds_of_life)
+ From mob/living/carbon/human/do_suicide()
+ from base of /obj/item/bio_chip/proc/activate(): ()
+ called on implants being implanted into someone with an uplink implant: (datum/component/uplink)
+ called on implants, after a successful implantation: (mob/living/target, mob/user, silent, force)
+ from base of /obj/item/bio_chip/proc/implant(): (list/args)
+ called on already installed implants when a new one is being added in /obj/item/bio_chip/proc/implant(): (list/args, obj/item/bio_chip/new_implant)
+ called on implants, after an implant has been removed: (mob/living/source, silent, special)
+ () - returns bool. MUST CHECK IF STORAGE IS THERE FIRST!
+ from base of obj/item/afterattack(): (atom/target, mob/user, params)
+ from base of obj/item/attack(): (/mob/living/target, /mob/living/user)
+ from base of obj/item/attack_obj(): (/obj, /mob)
+ from base of obj/item/attack_qdeleted(): (atom/target, mob/user, params)
+ from base of obj/item/attack_self(): (/mob)
+ from base of mob/living/carbon/attacked_by(): (mob/living/carbon/target, mob/living/user, hit_zone)
+ from base of obj/item/pre_attack(): (atom/target, mob/user, params)
+ from [/obj/item/proc/disableEmbedding]:
+ from base of obj/item/dropped(): (mob/user)
+ Called by /obj/item/proc/worn_overlays(list/overlays, mutable_appearance/standing, isinhands, icon_file)
+ from base of obj/item/hit_reaction(): (list/args)
+ return a truthy value to prevent ensouling, checked in /datum/spell/lichdom/cast(): (mob/user)
+ called before marking an object for retrieval, checked in /datum/spell/summonitem/cast() : (mob/user)
+ called on item when microwaved (): (obj/machinery/microwave/M)
+ from base of obj/item/pickup(): (/mob/taker)
+ from base of obj/item/pre_attack(): (atom/target, mob/user, params)
+ from base of obj/item/equipped(): (/mob/equipper, slot) +called on /obj/item before unequip from base of [mob/proc/doUnEquip]: (force, atom/newloc, no_move, invdrop, silent)
+ from base of item/sharpener/attackby(): (amount, max)
+ called when an item is sold by the exports subsystem
+ called when getting the item's exact ratio for cargo's profit.
+ called when getting the item's exact ratio for cargo's profit, without selling the item.
+ called when a wrapped up item is opened by hand
+ called on item when crossed by something (): (/atom/movable, mob/living/crossed)
+ Whenever EquipRanked is called, called after job is set
+ from base of /obj/item/bodypart/proc/attach_limb(): (new_limb, special) allows you to fail limb attachment
+ from base of /mob/living/can_track(): (mob/user)
+ send from defibs on ressurection: (defibber, defib_item, ghost)
+ from base of mob/living/electrocute_act(): (shock_damage, source, siemens_coeff, flags)
+ from base of mob/living/ExtinguishMob() (/mob/living)
+ sent from living mobs every tick of fire
+ from base of mob/living/IgniteMob() (/mob/living)
+ sent by stuff like stunbatons and tasers: ()
+ From base of mob/living/MobBump() (mob/living)
+ Sent from defibrillators when everything seems good and the user will be shocked: (defibber, defib_item, ghost)
+ from base of /mob/living/regenerate_limbs(): (noheal, excluded_limbs)
+ from base of mob/living/resist() (/mob/living)
+ from base of mob/living/revive() (full_heal, admin_revive)
+ sent when items with siemen coeff. of 0 block a shock: (power_source, source, siemens_coeff, dist_check)
+ called on /living when someone starts pulling it (atom/movable/puller, state, force)
+ from base of mob/living/Immobilize() (amount, ignore_canstun)
+ from base of mob/living/Knockdown() (amount, ignore_canstun) +#define COMSIG_LIVING_STATUS_KNOCKDOWN "living_knockdown" // one day +from base of mob/living/Paralyse() (amount, ignore_canstun)
+ from base of mob/living/Sleeping() (amount, ignore_canstun)
+ from base of mob/living/Stun() (amount, ignore_canstun)
+ from base of mob/living/Unconscious() (amount, ignore_canstun)
+ from base of mob/living/Stun() (amount, ignore_canstun)
+ from base of mob/living/Write_Memory()
+ from /obj/machinery/obj_break(damage_flag): (damage_flag)
+ from base power_change() when power is lost
+ from base power_change() when power is restored
+ sent from mecha action buttons to the mecha they're linked to
+ called when the mind is initialized (called every time the mob logins)
+ from base of /datum/mind/proc/transfer_to(mob/living/new_character)
+ from [/obj/effect/mine/proc/triggermine]:
+ from base of obj/allowed(mob/M): (/obj) returns bool, if TRUE the mob has id access to the obj
+ from base of mob/AltClickOn(): (atom/A)
+ from base of /mob/living/proc/apply_damage(): (damage, damagetype, def_zone)
+ from base of atom/attack_hand(): (mob/user)
+ from base of mob/RangedAttack(): (atom/A, params)
+ from base of mob/clickon(): (atom/A, params)
+ sent when a mob/login() finishes: (client)
+ from /mob/say_dead(): (mob/speaker, message)
+ from base of mob/death(): (gibbed)
+ General signal fired when a mob does any old emote +from /datum/emote/proc/run_emote(): (key, intentional)
+ Specific signal used to track when a specific emote is used. +From /datum/emote/run_emote(): (P, key, m_type, message, intentional)
+ From /datum/emote/select_param(): (target, key, intentional)
+ from base of /mob/verb/examinate(): (atom/target)
+ From /datum/action/Grant(): (datum/action)
+ from base of mob/create_mob_hud(): ()
+ from base of obj/item/afterattack(): (atom/target, mob/user, proximity_flag, click_parameters)
+ from base of /obj/item/attack(): (mob/M, mob/user)
+ from base of obj/item/attack_qdeleted(): (atom/target, mob/user, proxiumity_flag, click_parameters)
+ from base of /mob/Login(): ()
+ from base of /mob/Logout(): ()
+ from base of mob/MiddleClickOn(): (atom/A)
+ Signal fired when an emote is used but before it's executed. +from /datum/emote/proc/try_run_emote(): (key, intentional)
+ from base of mob/anti_magic_check(): (mob/user, magic, holy, tinfoil, chargecost, self, protection_sources)
+ From /datum/action/Remove(): (datum/action)
+ from /mob/living/say(): ()
+ from base of mob/set_stat(): (new_stat)
+ Performed after the hands are swapped.
+ from base of mob/swap_hand(): (obj/item)
+ from base of /mob/throw_item(): (atom/target)
+ called in /obj/item/gun/afterattack (user, target, flag, params)
+ from base of /mob/update_sight(): ()
+ called when a user is getting new weapon and we want to remove previous weapon to clear hands
+ called when a user willingly drops something (i.e. keybind, or UI action)
+ Called when a module activates, after all checks have passed and cooldown started.
+ Called when a module deactivates, after all checks have passed.
+ Called when a module attempts to activate, however it does. At the end of checks so you can add some yourself, or work on trigger behavior (mob/user)
+ Called when a module is used, after all checks have passed and cooldown started.
+ Called when a MOD activation is called from toggle_activate(mob/user)
+ Called when a MOD deploys one or more of its parts.
+ Called when a MOD finishes having a module added to it.
+ Called when a MOD is having modules removed from crowbar_act(mob/user, obj/crowbar)
+ Called when a MOD finishes having a module removed from it.
+ Called when a module is selected to be the active one from on_select(obj/item/mod/module/module)
+ Called when a MOD retracts one or more of its parts.
+ Called when a MOD is finished toggling itself.
+ Called when the MODsuit wearer is set.
+ Called when the MODsuit wearer is unset.
+ from base of atom/MouseDrop_T: (/atom/from, /mob/user)
+ from base of atom/MouseDrop(): (/atom/over, /mob/user)
+ from base of atom/movable/buckle_mob(): (mob, force)
+ from base of atom/movable/Bump(): (/atom)
+ from base of atom/movable/Cross(): (/atom/movable)
+ from base of atom/movable/Crossed(): (/atom/movable)
+ called when the movable is added to a disposal holder object for disposal movement: (obj/structure/disposalholder/holder, obj/machinery/disposal/source)
+ called when the movable is removed from a disposal holder object: /obj/structure/disposalpipe/proc/expel(): (obj/structure/disposalholder/H, turf/T, direction)
+ from base of atom/movable/Hear(): (proc args list(message, atom/movable/speaker, message_language, raw_message, radio_freq, list/spans, message_mode))
+ from base of atom/movable/throw_impact(): (/atom/hit_atom, /datum/thrownthing/throwingdatum)
+ from base of mob/living/hitby(): (mob/living/target, hit_zone)
+ from base of atom/movable/Moved(): (/atom, dir)
+ from base of atom/movable/throw_at(): (datum/thrownthing, spin)
+ from base of atom/movable/Moved(): (/atom)
+ from base of atom/movable/throw_at(): (list/args)
+ called when the movable is placed in an unaccessible area, used for stationloving: ()
+ from base of datum/thrownthing/finalize(): (obj/thrown_object, datum/thrownthing) used for when a throw is finished
+ Called just before something gets untilted
+ from base of atom/movable/unbuckle_mob(): (mob, force)
+ from base of atom/movable/Uncross(): (/atom/movable)
+ from base of atom/movable/Uncrossed(): (/atom/movable)
+ Called when something gets untilted, from /datum/element/tilted/proc/do_untilt(atom/movable/source, mob/user)
+ from base of atom/movable/onTransitZ(): (old_z, new_z)
+ (datum/nanite_program/new_program, datum/nanite_program/source_program) Called when adding a program to a nanite component
+ (amount) Adjusts nanite volume by the given amount
+ (comm_code(1-9999), comm_message) Called when sending a nanite comm signal to a mob.
+ () deletes the nanite component
+ (list/nanite_programs) - makes the input list a copy the nanites' program list
+ (amount) Returns nanite amount
+ () returns TRUE if nanites have stealth
+ (mob/user, full_scan) - sends to chat a scan of the nanites to the user, returns TRUE if nanites are detected
+ (amount(0-100)) Sets cloud ID to the given amount
+ (method) Modify cloud sync status. Method can be toggle, enable or disable
+ (amount) Sets maximum nanite volume to the given amount
+ (amount) Sets regeneration rate to the given amount
+ (amount) Sets safety threshold to the given amount
+ (amount) Sets current nanite volume to the given amount
+ (code(1-9999)) Called when sending a nanite signal to a mob.
+ (datum/component/nanites, full_overwrite, copy_activation) Called to sync the target's nanites to a given nanite component
+ (list/data, scan_level) - adds nanite data to the given data list - made for ui_data procs
+ from datum/objective/is_invalid_target()
+ from datum/objective/proc/find_target(list/target_blacklist)
+ from base of obj/deconstruct(): (disassembled)
+ from base of code/game/machinery
+ from base of /turf/proc/levelupdate(). (intact) true to hide and false to unhide
+ called in /obj/structure/setAnchored(): (value)
+ called in /obj/update_icon()
+ from base of atom/attackby(): (/obj/item, /mob/living, params)
+ from base of atom/examine(): (/mob)
+ before a datum's Destroy() is called: (force), returning a nonzero value will cancel the qdel operation
+ just before a datum's Destroy() is called: (force), at this point none of the other components chose to interrupt qdel and Destroy will be called
+ called on pda when the user changes the ringtone: (mob/living/user, new_ringtone)
+ sent to targets during the process_hit proc of projectiles
+ called after rotation in /obj/item/pen/attack_self(): (rotation, mob/living/carbon/user)
+ from base of /datum/local_powernet/proc/power_change()
+ sent from borg recharge stations: (amount, repairs)
+ from base of /obj/projectile/proc/fire(): (obj/projectile, atom/original_target)
+ from the base of /obj/projectile/proc/fire(): ()
+ from base of /obj/projectile/proc/on_hit(): (atom/movable/firer, atom/target, Angle)
+ sent to targets during the process_hit proc of projectiles
+ sent to targets during the process_hit proc of projectiles
+ from base of /obj/projectile/proc/on_hit(): (atom/movable/firer, atom/target, Angle)
+ called from base of /obj/item/radio/proc/set_frequency(): (list/args)
+ from SSsecurity_level when the security level changes : (previous_level_number, new_level_number)
+ from SSsecurity_level on planning security level change : (previous_level_number, new_level_number)
+ Sent when bodies transfer between shades/shards and constructs
+ from [/mob/living/carbon/human/Move]: ()
+ sent to the instrument when a song stops playing
+ sent to the instrument when a song starts playing
+ from datum/species/on_species_gain(): (datum/species/new_species, datum/species/old_species)
+ from datum/species/on_species_loss(): (datum/species/lost_species)
+ called when a wrapped up structure is opened by hand
+ from base of /obj/item/clothing/suit/space/proc/toggle_spacesuit(): (obj/item/clothing/suit/space/suit)
+ signals from globally accessible objects +from SSsun when the sun changes position : (azimuth)
+ Called when the round has started, but before GAME_STATE_PLAYING.
+ from base of [/obj/item/proc/tool_attack_chain]: (atom/tool, mob/user)
+ from base of [/obj/item/proc/tool_check_callback]: (mob/living/user)
+ from base of [/obj/item/proc/tool_start_check]: (mob/living/user)
+ generic topic handler (usr, href_list)
+ Alarm manager signals
+ (obj/item/insertion_candidate, mob/user, silent) - returns bool
+ (type, amount = INFINITY, force = FALSE). Force will ignore max_items, and amount is normally clamped to max_items.
+ returns bool
+ (mob/hide_from) - returns bool
+ (obj/item/inserting, mob/user, silent, force) - returns bool
+ (loc) - returns bool - if loc is null it will dump at parent location.
+ (list/list_to_inject_results_into, recursively_search_inside_storages = TRUE)
+ (newstate)
+ (mob/show_to, force) - returns bool.
+ (obj, new_loc, force = FALSE) - returns bool
+ (type, atom/destination, amount = INFINITY, check_adjacent, force, mob/user, list/inserted) - returns bool - type can be a list of types.
+ from base of turf/ChangeTurf(): (path, list/new_baseturfs, flags, list/transferring_comps)
+ from base of atom/has_gravity(): (atom/asker, list/forced_gravities)
+ Component Specific Signals +(): Returns bitflags of wet values.
+ (max_strength, immediate, duration_decrease = INFINITY): Returns bool.
+ from base of turf/New(): (turf/source, direction)
+ from base of datum/component/two_handed/proc/unwield(mob/living/carbon/user): (/mob/user)
+ from base of datum/component/two_handed/proc/wield(mob/living/carbon/user): (/mob/user)
+ from monkey CtrlClickOn(): (/mob)
+ from slime AltClickOn(): (/mob)
+ from slime CtrlClickOn(): (/mob)
+ from slime ShiftClickOn(): (/mob)
+ from turf AltClickOn(): (/mob)
+ from turf ShiftClickOn(): (/mob)
+ Cancels activation, with no message. Include feedback on your cancel.
+ Cancels the suit's activation
+ Cancels the removal of modules
+ we've used up the number of times we may use this slot machine. womp womp.
+ we haven't used up all our attempts to gamble away our life but we should chill for a few seconds
| NO_DIRECTION | define purely for readability, cables especially need to use this as NO_DIRECTION represents a "node" |
|---|---|
| FLIP_DIR_HORIZONTALLY | Using the ^ operator or XOR, we can compared TRUE East and West bits against our direction, +since XOR will only return TRUE if one bit is False and the other is True, if East is 0, that bit will return TRUE +and if West is 1, then that bit will return 0 +hence EAST (0010) XOR EAST|WEST (0011) --> WEST (0001) +Flips a direction along the horizontal axis, will convert E -> W, W -> E, NE -> NW, SE -> SW, etc |
| FLIP_DIR_VERTICALLY | Flips a direction along the vertical axis, will convert N -> S, S -> N, NE -> SE, SW -> NW, etc |
| IS_DIR_DIAGONAL | for directions, each cardinal direction only has 1 TRUE bit, so 1000 or 0100 for example, so when you subtract 1
+from a cardinal direction it results in that directions initial TRUE bit always switching to FALSE, so if you & check it
+against its initial self, it will return false, indicating that the direction is straight and not diagonal
+returns TRUE if direction is diagonal and false if not |
| IS_DIR_CARDINAL | returns TRUE if direction is cardinal and false if not |
| REVERSE_DIR | Inverse direction, taking into account UP|DOWN if necessary. |
+ Using the ^ operator or XOR, we can compared TRUE East and West bits against our direction, +since XOR will only return TRUE if one bit is False and the other is True, if East is 0, that bit will return TRUE +and if West is 1, then that bit will return 0 +hence EAST (0010) XOR EAST|WEST (0011) --> WEST (0001) +Flips a direction along the horizontal axis, will convert E -> W, W -> E, NE -> NW, SE -> SW, etc
+ Flips a direction along the vertical axis, will convert N -> S, S -> N, NE -> SE, SW -> NW, etc
+ returns TRUE if direction is cardinal and false if not
+ for directions, each cardinal direction only has 1 TRUE bit, so 1000 or 0100 for example, so when you subtract 1
+from a cardinal direction it results in that directions initial TRUE bit always switching to FALSE, so if you & check it
+against its initial self, it will return false, indicating that the direction is straight and not diagonal
+returns TRUE if direction is diagonal and false if not
+ define purely for readability, cables especially need to use this as NO_DIRECTION represents a "node"
+ Inverse direction, taking into account UP|DOWN if necessary.
| ACCOUNT_SECURITY_ID | //ACOUNT SECURITY LEVELS//// +There is no security on this account, it can be accessed through someone's ID card/account number |
|---|---|
| ACCOUNT_SECURITY_PIN | Before accessing this account, the pin number must be provided |
| ACCOUNT_SECURITY_RESTRICTED | This account can only be accessed through restricted terminals |
| ACCOUNT_SECURITY_CC | This acount can only be accessed by admins/CC characters |
| ACCOUNT_SECURITY_VENDOR | This account is only accessible to NPCs and Vendors (aka, only through code) |
| CREW_MEMBER_STARTING_BALANCE | STARTING CASH AMOUNTS |
| CREW_BASE_PAY_LOW | BASE PAY AMOUNTS |
| DATABASE_LOG_THRESHHOLD | Transactions on money accounts will automatically be logged if they involve over 2500 space credits |
| MAX_STACKABLE_CASH | //CASH LIMITS/CAPS///// +The total amount of space cash that can be stacked |
| MERCH_CAT_APPAREL | merch computer categories |
| SUPPLY_EMERGENCY | supply packs |
| MAIL_DELIVERY_BONUS | mail deliveries |
+ This acount can only be accessed by admins/CC characters
+ //ACOUNT SECURITY LEVELS//// +There is no security on this account, it can be accessed through someone's ID card/account number
+ Before accessing this account, the pin number must be provided
+ This account can only be accessed through restricted terminals
+ This account is only accessible to NPCs and Vendors (aka, only through code)
+ BASE PAY AMOUNTS
+ STARTING CASH AMOUNTS
+ Transactions on money accounts will automatically be logged if they involve over 2500 space credits
+ mail deliveries
+ //CASH LIMITS/CAPS///// +The total amount of space cash that can be stacked
+ merch computer categories
+ supply packs
| RANDOM_STORY_RIOTS | Random stories for newscasters |
|---|---|
| TRADE_GOOD_DEFAULT | Trade goods for trade destinations |
+ Random stories for newscasters
+ Trade goods for trade destinations
| EMOTE_VISIBLE | General defines used for emotes +Emote is visible. These emotes will be runechatted. |
|---|---|
| EMOTE_AUDIBLE | Emote is audible (in character). |
| EMOTE_FORCE_NO_RUNECHAT | Regardless of its existing flags, an emote with this flag will not be sent to runechat. |
| EMOTE_MOUTH | This emote uses the mouth, and so should be blocked if the user is muzzled or can't breathe (for humans). |
| EMOTE_READY | The user is not on emote cooldown, and is ready to emote whenever. |
| EMOTE_INFINITE | The user can spam emotes to their heart's content. |
| EMOTE_ADMIN_BLOCKED | The user cannot emote as they have been blocked by an admin. |
| EMOTE_ON_COOLDOWN | The user cannot emote until their cooldown expires. |
| EMOTE_PARAM_SEPARATOR | Marker to separate an emote key from its parameters in user input. |
| DEFAULT_EMOTE_COOLDOWN | Default cooldown for normal (non-audio) emotes. |
| AUDIO_EMOTE_COOLDOWN | Default cooldown for emote-emitted audio. |
| AUDIO_EMOTE_UNINTENTIONAL_COOLDOWN | Cooldown for emotes that are emitted unintentionally, to prevent them from getting audibly spammy. |
| EMOTE_TARGET_BHVR_MUST_MATCH | If this is set and a valid target is not found, the emote will not execute. |
| EMOTE_TARGET_BHVR_DEFAULT_TO_BASE | If this is set and a valid target is not found, the emote will just ignore the parameter entirely. |
| EMOTE_TARGET_BHVR_USE_PARAMS_ANYWAY | If this is set and a valid target is not found, the emote will work with the params that it has. |
| EMOTE_TARGET_BHVR_RAW | No matching/processing will be performed, and the target will be purely what's passed in. |
| EMOTE_TARGET_BHVR_NUM | The emote target should be just a number. Anything else will be rejected. |
| EMOTE_TARGET_BHVR_IGNORE | The emote target is used elsewhere, and processing should be skipped. |
| EMOTE_TARGET_MOB | The target will check all nearby living mobs. |
| EMOTE_TARGET_OBJ | The target will check all objects nearby. |
| EMOTE_TARGET_ANY | The target will check nearby mobs and objects. |
| EMOTE_PARAM_USE_POSTFIX | If passed as message_param, will default to using the message's postfix. |
| EMOTE_ACT_STOP_EXECUTION | If returned from act_on_target(), emote execution will stop. |
| USABLE_DEAD_EMOTES | List of emotes useable by ghosties |
+ Default cooldown for emote-emitted audio.
+ Cooldown for emotes that are emitted unintentionally, to prevent them from getting audibly spammy.
+ Default cooldown for normal (non-audio) emotes.
+ If returned from act_on_target(), emote execution will stop.
+ The user cannot emote as they have been blocked by an admin.
+ Emote is audible (in character).
+ Regardless of its existing flags, an emote with this flag will not be sent to runechat.
+ The user can spam emotes to their heart's content.
+ This emote uses the mouth, and so should be blocked if the user is muzzled or can't breathe (for humans).
+ The user cannot emote until their cooldown expires.
+ Marker to separate an emote key from its parameters in user input.
+ If passed as message_param, will default to using the message's postfix.
+ The user is not on emote cooldown, and is ready to emote whenever.
+ The target will check nearby mobs and objects.
+ If this is set and a valid target is not found, the emote will just ignore the parameter entirely.
+ The emote target is used elsewhere, and processing should be skipped.
+ If this is set and a valid target is not found, the emote will not execute.
+ The emote target should be just a number. Anything else will be rejected.
+ No matching/processing will be performed, and the target will be purely what's passed in.
+ If this is set and a valid target is not found, the emote will work with the params that it has.
+ The target will check all nearby living mobs.
+ The target will check all objects nearby.
+ General defines used for emotes +Emote is visible. These emotes will be runechatted.
+ List of emotes useable by ghosties
| NO_SCREENTIPS | Whether or not this atom shows screentips when hovered over |
|---|---|
| UPDATE_NAME | Update the atom's name |
| UPDATE_DESC | Update the atom's desc |
| UPDATE_ICON_STATE | Update the atom's icon state |
| UPDATE_OVERLAYS | Update the atom's overlays |
| UPDATE_ICON | Update the atom's icon |
| SHOCKED_2 | Prevents mobs from getting chainshocked by teslas and the supermatter |
| RAD_PROTECT_CONTENTS_2 | should the contents of this atom be acted upon |
| RAD_NO_CONTAMINATE_2 | should this object be allowed to be contaminated |
| IMMUNE_TO_SHUTTLECRUSH_2 | Prevents shuttles from deleting the item |
| NO_MALF_EFFECT_2 | Prevents malf AI animate + overload ability |
| CRITICAL_ATOM_2 | Use when this shouldn't be obscured by large icons. |
| RANDOM_BLOCKER_2 | Use this flag for items that can block randomly |
| ALLOW_BELT_NO_JUMPSUIT_2 | This flag allows for wearing of a belt item, even if you're not wearing a jumpsuit |
| RICOCHET_SHINY | If the thing can reflect light (lasers/energy) |
| RICOCHET_HARD | If the thing can reflect matter (bullets/bomb shrapnel) |
| MOBILITY_MOVE | can move |
| MOBILITY_STAND | can, and is, standing up |
| MOBILITY_PICKUP | can pickup items |
| MOBILITY_USE | can hold and use items |
| MOBILITY_PULL | can pull things |
+ This flag allows for wearing of a belt item, even if you're not wearing a jumpsuit
+ Use when this shouldn't be obscured by large icons.
+ Prevents shuttles from deleting the item
+ can move
+ can pickup items
+ can pull things
+ can, and is, standing up
+ can hold and use items
+ Prevents malf AI animate + overload ability
+ Whether or not this atom shows screentips when hovered over
+ should this object be allowed to be contaminated
+ should the contents of this atom be acted upon
+ Use this flag for items that can block randomly
+ If the thing can reflect matter (bullets/bomb shrapnel)
+ If the thing can reflect light (lasers/energy)
+ Prevents mobs from getting chainshocked by teslas and the supermatter
+ Update the atom's desc
+ Update the atom's icon
+ Update the atom's icon state
+ Update the atom's name
+ Update the atom's overlays
| FOOD_GOAL_SKIP | Used for secondary goals. +TOO easy, not accepted for variety goals. |
|---|---|
| FOOD_GOAL_EASY | Easy food, ask for a lot for single goals. |
| FOOD_GOAL_NORMAL | Normal food, ask for a middling amount for single goals. |
| FOOD_GOAL_HARD | Hard reagent, ask for a little for single goals. |
| FOOD_GOAL_EXCESSIVE | TOO hard, accepted for variety goals, but never used for single goals. |
| FOOD_GOAL_DUPLICATE | Same as FOOD_GOAL_EXCESSIVE, just different name to indicate that there's another version of this food that's used in variety goals. |
+ Same as FOOD_GOAL_EXCESSIVE, just different name to indicate that there's another version of this food that's used in variety goals.
+ Easy food, ask for a lot for single goals.
+ TOO hard, accepted for variety goals, but never used for single goals.
+ Hard reagent, ask for a little for single goals.
+ Normal food, ask for a middling amount for single goals.
+ Used for secondary goals. +TOO easy, not accepted for variety goals.
| NUKE_SITE_ON_STATION | The bomb is on-station. |
|---|---|
| NUKE_SITE_ON_STATION_ZLEVEL | The bomb is on station z-level, but not a station tile. |
| NUKE_SITE_OFF_STATION_ZLEVEL | The bomb is off station z-level. |
| NUKE_SITE_INVALID | The bomb's location cannot be found. |
+ The bomb's location cannot be found.
+ The bomb is off station z-level.
+ The bomb is on-station.
+ The bomb is on station z-level, but not a station tile.
| /proc/view_to_pixels | +Takes a string or num view, and converts it to pixel width/height in a list(pixel_width, pixel_height) |
|---|
| SMOOTH_CORNERS | Smoothing system in where adjacencies are calculated and used to build an image by mounting each corner at runtime. |
|---|---|
| SMOOTH_BITMASK | Smoothing system in where adjacencies are calculated and used to select a pre-baked icon_state, encoded by bitmasking. |
| SMOOTH_DIAGONAL_CORNERS | Atom has diagonal corners, with underlays under them. |
| SMOOTH_BORDER | Atom will smooth with the borders of the map. |
| SMOOTH_QUEUED | Atom is currently queued to smooth. |
| SMOOTH_OBJ | Smooths with objects, and will thus need to scan turfs for contents. |
| S_TURF | *SMOOTHING GROUPS |
| SMOOTH_GROUP_TURF | turf/simulated |
| SMOOTH_GROUP_TURF_CHASM | turf/simulated/chasm, /turf/simulated/floor/fakepit |
| SMOOTH_GROUP_FLOOR_LAVA | turf/simulated/floor/lava |
| SMOOTH_GROUP_FLOOR_TRANSPARENT_GLASS | turf/simulated/transparent/glass |
| SMOOTH_GROUP_FLOOR | turf/simulated/floor |
| SMOOTH_GROUP_FLOOR_GRASS | turf/simulated/floor/plating/grass |
| SMOOTH_GROUP_FLOOR_ICE | turf/simulated/floor/plating/ice |
| SMOOTH_GROUP_BEACH_WATER | turf/simulated/floor/beach/away/water |
| SMOOTH_GROUP_GLASS_FLOOR | turf/simulated/floor/transparent/glass and subtypes |
| SMOOTH_GROUP_GLASS_FLOOR_TITANIUM | turf/simulated/floor/transparent/glass/titanium and subtypes |
| SMOOTH_GROUP_CARPET | turf/simulated/floor/carpet |
| SMOOTH_GROUP_BAMBOO | turf/simulated/floor/bamboo |
| SMOOTH_GROUP_SIMULATED_TURFS | turf/simulated |
| SMOOTH_GROUP_MATERIAL_WALLS | turf/simulated/wall/material |
| SMOOTH_GROUP_SYNDICATE_WALLS | turf/simulated/wall/r_wall/syndicate, /turf/simulated/indestructible/syndicate |
| SMOOTH_GROUP_HOTEL_WALLS | turf/simulated/indestructible/hotelwall |
| SMOOTH_GROUP_MINERAL_WALLS | turf/simulated/mineral, /obj/structure/falsewall/rock_ancient |
| SMOOTH_GROUP_BOSS_WALLS | turf/simulated/indestructible/riveted/boss |
| SMOOTH_GROUP_SURVIVAL_TITANIUM_WALLS | turf/simulated/wall/mineral/titanium/survival |
| SMOOTH_GROUP_GRASS | turf/simulated/floor/grass |
| SMOOTH_GROUP_JUNGLE_GRASS | turf/simulated/floor/grass/jungle |
| SMOOTH_GROUP_WALLS | turf/simulated/wall, /obj/structure/falsewall |
| SMOOTH_GROUP_URANIUM_WALLS | turf/simulated/wall/mineral/uranium, /obj/structure/falsewall/uranium |
| SMOOTH_GROUP_GOLD_WALLS | turf/simulated/wall/mineral/gold, /obj/structure/falsewall/gold |
| SMOOTH_GROUP_SILVER_WALLS | turf/simulated/wall/mineral/silver, /obj/structure/falsewall/silver |
| SMOOTH_GROUP_DIAMOND_WALLS | turf/simulated/wall/mineral/diamond, /obj/structure/falsewall/diamond |
| SMOOTH_GROUP_PLASMA_WALLS | turf/simulated/wall/mineral/plasma, /obj/structure/falsewall/plasma |
| SMOOTH_GROUP_BANANIUM_WALLS | turf/simulated/wall/mineral/bananium, /obj/structure/falsewall/bananium |
| SMOOTH_GROUP_SANDSTONE_WALLS | turf/simulated/wall/mineral/sandstone, /obj/structure/falsewall/sandstone |
| SMOOTH_GROUP_WOOD_WALLS | turf/simulated/wall/mineral/wood, /obj/structure/falsewall/wood |
| SMOOTH_GROUP_IRON_WALLS | turf/simulated/wall/mineral/iron, /obj/structure/falsewall/iron |
| SMOOTH_GROUP_ABDUCTOR_WALLS | turf/simulated/wall/mineral/abductor, /obj/structure/falsewall/abductor |
| SMOOTH_GROUP_TITANIUM_WALLS | turf/simulated/wall/mineral/titanium, /obj/structure/falsewall/titanium |
| SMOOTH_GROUP_ASTEROID_WALLS | turf/simulated/mineral, /obj/structure/falsewall/rock_ancient |
| SMOOTH_GROUP_PLASTITANIUM_WALLS | turf/simulated/wall/mineral/plastitanium, /obj/structure/falsewall/plastitanium |
| SMOOTH_GROUP_SURVIVAL_TIANIUM_POD | turf/simulated/wall/mineral/titanium/survival/pod, /obj/machinery/door/airlock/survival_pod, /obj/structure/window/shuttle/survival_pod |
| SMOOTH_GROUP_HIERO_WALL | obj/effect/temp_visual/elite_tumor_wall, /obj/effect/temp_visual/hierophant/wall |
| SMOOTH_GROUP_BRASS_WALL | turf/simulated/wall/mineral/brass, /obj/structure/falsewall/brass |
| SMOOTH_GROUP_REGULAR_WALLS | turf/simulated/wall, /obj/structure/falsewall |
| SMOOTH_GROUP_REINFORCED_WALLS | turf/simulated/wall/r_wall, /obj/structure/falsewall/reinforced |
| SMOOTH_GROUP_CULT_WALLS | turf/simulated/wall/cult |
| SMOOTH_GROUP_WINDOW_FULLTILE | turf/simulated/indestructible/fakeglass, /obj/structure/window/full/basic, /obj/structure/window/full/plasmabasic, /obj/structure/window/full/plasmareinforced, /obj/structure/window/full/reinforced |
| SMOOTH_GROUP_WINDOW_FULLTILE_BRASS | obj/structure/window/brass/fulltile |
| SMOOTH_GROUP_WINDOW_FULLTILE_PLASTITANIUM | turf/simulated/indestructible/opsglass, /obj/structure/window/plasma/reinforced/plastitanium |
| SMOOTH_GROUP_WINDOW_FULLTILE_SHUTTLE | obj/structure/window/shuttle |
| SMOOTH_GROUP_LATTICE | obj/structure/lattice |
| SMOOTH_GROUP_AIRLOCK | obj/machinery/door/airlock |
| SMOOTH_GROUP_TABLES | obj/structure/table |
| SMOOTH_GROUP_WOOD_TABLES | obj/structure/table/wood |
| SMOOTH_GROUP_FANCY_WOOD_TABLES | obj/structure/table/wood/fancy |
| SMOOTH_GROUP_BRASS_TABLES | obj/structure/table/brass |
| SMOOTH_GROUP_ABDUCTOR_TABLES | obj/structure/table/abductor |
| SMOOTH_GROUP_GLASS_TABLES | obj/structure/table/glass |
| SMOOTH_GROUP_REINFORCED_TABLES | obj/structure/table/reinforced, /obj/structure/table/glass/reinforced |
| SMOOTH_GROUP_ALIEN_RESIN | obj/structure/alien/resin |
| SMOOTH_GROUP_ALIEN_WALLS | obj/structure/alien/resin/wall, |
| SMOOTH_GROUP_ALIEN_WEEDS | obj/structure/alien/weeds |
| SMOOTH_GROUP_SECURITY_BARRICADE | obj/structure/barricade/security |
| SMOOTH_GROUP_SANDBAGS | obj/structure/barricade/sandbags |
| SMOOTH_GROUP_SHUTTLE_PARTS | obj/structure/window/shuttle, /obj/structure/window/plasma/reinforced/plastitanium, /turf/simulated/indestructible/opsglass, /obj/structure/shuttle |
| SMOOTH_GROUP_CLEANABLE_DIRT | obj/effect/decal/cleanable/dirt |
| SMOOTH_GROUP_RIPPLE | obj/effect/temp_visual/ripple |
| SMOOTH_GROUP_CATWALK | obj/structure/lattice/catwalk |
+ Smoothing system in where adjacencies are calculated and used to select a pre-baked icon_state, encoded by bitmasking.
+ Atom will smooth with the borders of the map.
+ Smoothing system in where adjacencies are calculated and used to build an image by mounting each corner at runtime.
+ Atom has diagonal corners, with underlays under them.
+ obj/structure/table/abductor
+ turf/simulated/wall/mineral/abductor, /obj/structure/falsewall/abductor
+ obj/machinery/door/airlock
+ obj/structure/alien/resin
+ obj/structure/alien/resin/wall,
+ obj/structure/alien/weeds
+ turf/simulated/mineral, /obj/structure/falsewall/rock_ancient
+ turf/simulated/floor/bamboo
+ turf/simulated/wall/mineral/bananium, /obj/structure/falsewall/bananium
+ turf/simulated/floor/beach/away/water
+ turf/simulated/indestructible/riveted/boss
+ obj/structure/table/brass
+ turf/simulated/wall/mineral/brass, /obj/structure/falsewall/brass
+ turf/simulated/floor/carpet
+ obj/structure/lattice/catwalk
+ obj/effect/decal/cleanable/dirt
+ turf/simulated/wall/cult
+ turf/simulated/wall/mineral/diamond, /obj/structure/falsewall/diamond
+ obj/structure/table/wood/fancy
+ turf/simulated/floor
+ turf/simulated/floor/plating/grass
+ turf/simulated/floor/plating/ice
+ turf/simulated/floor/lava
+ turf/simulated/transparent/glass
+ turf/simulated/floor/transparent/glass and subtypes
+ turf/simulated/floor/transparent/glass/titanium and subtypes
+ obj/structure/table/glass
+ turf/simulated/wall/mineral/gold, /obj/structure/falsewall/gold
+ turf/simulated/floor/grass
+ obj/effect/temp_visual/elite_tumor_wall, /obj/effect/temp_visual/hierophant/wall
+ turf/simulated/indestructible/hotelwall
+ turf/simulated/wall/mineral/iron, /obj/structure/falsewall/iron
+ turf/simulated/floor/grass/jungle
+ obj/structure/lattice
+ turf/simulated/wall/material
+ turf/simulated/mineral, /obj/structure/falsewall/rock_ancient
+ turf/simulated/wall/mineral/plasma, /obj/structure/falsewall/plasma
+ turf/simulated/wall/mineral/plastitanium, /obj/structure/falsewall/plastitanium
+ turf/simulated/wall, /obj/structure/falsewall
+ obj/structure/table/reinforced, /obj/structure/table/glass/reinforced
+ turf/simulated/wall/r_wall, /obj/structure/falsewall/reinforced
+ obj/effect/temp_visual/ripple
+ obj/structure/barricade/sandbags
+ turf/simulated/wall/mineral/sandstone, /obj/structure/falsewall/sandstone
+ obj/structure/barricade/security
+ obj/structure/window/shuttle, /obj/structure/window/plasma/reinforced/plastitanium, /turf/simulated/indestructible/opsglass, /obj/structure/shuttle
+ turf/simulated/wall/mineral/silver, /obj/structure/falsewall/silver
+ turf/simulated
+ turf/simulated/wall/mineral/titanium/survival/pod, /obj/machinery/door/airlock/survival_pod, /obj/structure/window/shuttle/survival_pod
+ turf/simulated/wall/mineral/titanium/survival
+ turf/simulated/wall/r_wall/syndicate, /turf/simulated/indestructible/syndicate
+ obj/structure/table
+ turf/simulated/wall/mineral/titanium, /obj/structure/falsewall/titanium
+ turf/simulated
+ turf/simulated/chasm, /turf/simulated/floor/fakepit
+ turf/simulated/wall/mineral/uranium, /obj/structure/falsewall/uranium
+ turf/simulated/wall, /obj/structure/falsewall
+ turf/simulated/indestructible/fakeglass, /obj/structure/window/full/basic, /obj/structure/window/full/plasmabasic, /obj/structure/window/full/plasmareinforced, /obj/structure/window/full/reinforced
+ obj/structure/window/brass/fulltile
+ turf/simulated/indestructible/opsglass, /obj/structure/window/plasma/reinforced/plastitanium
+ obj/structure/window/shuttle
+ obj/structure/table/wood
+ turf/simulated/wall/mineral/wood, /obj/structure/falsewall/wood
+ Smooths with objects, and will thus need to scan turfs for contents.
+ Atom is currently queued to smooth.
+ *SMOOTHING GROUPS
+list/smoothing_groups variable.list/canSmoothWith variable to check whether smoothing is possible or not.| CHANNELS_PER_INSTRUMENT | Max number of playing notes per instrument. |
|---|---|
| INSTRUMENT_MAX_TOTAL_SUSTAIN | Maximum length a note should ever go for |
| INSTRUMENT_EXP_FALLOFF_MIN | These are per decisecond. |
| INSTRUMENT_MIN_SUSTAIN_DROPOFF | Minimum volume for when the sound is considered dead. |
+ Max number of playing notes per instrument.
+ These are per decisecond.
+ Maximum length a note should ever go for
+ Minimum volume for when the sound is considered dead.
| MAX_KEYPRESS_COMMANDLENGTH | Max length of a keypress command before it's considered to be a forged packet/bogus command |
|---|---|
| MAX_KEYPRESS_AUTOKICK | Max amount of keypress messages per second over two seconds before client is autokicked |
| HELD_KEY_BUFFER_LENGTH | Length of held key rolling buffer |
| MAX_COMMANDS_PER_KEY | Maximum keys that can be bound to one button |
+ Length of held key rolling buffer
+ Maximum keys that can be bound to one button
+ Max amount of keypress messages per second over two seconds before client is autokicked
+ Max length of a keypress command before it's considered to be a forged packet/bogus command
| MAP_EDITOR_TURF_LAYER | Which layer turfs appear on by default in the map editor. Should be unique! |
|---|---|
| EMISSIVE_PLANE | This plane masks out lighting to create an "emissive" effect, ie for glowing lights in otherwise dark areas. |
| EMISSIVE_RENDER_TARGET | The render target used by the emissive. |
| PLANE_MASTERS_GAME | Plane master controller keys |
+ This plane masks out lighting to create an "emissive" effect, ie for glowing lights in otherwise dark areas.
+ The render target used by the emissive.
+ Which layer turfs appear on by default in the map editor. Should be unique!
+ Plane master controller keys
| EMISSIVE_BLOCK_UNIQUE | Uses a dedicated render_target object to copy the entire appearance in real time to the blocking layer. For things that can change in appearance a lot from the base state, like humans. |
|---|---|
| EMISSIVE_COLOR | The color applied to all emissive overlays. |
| EM_BLOCK_COLOR | The color applied to all emissive blockers. Is meant to be the exact opposite of the EMMISIVE_COLOR |
| EMISSIVE_APPEARANCE_FLAGS | A set of appearance flags applied to all emissive and emissive blocker overlays. |
| EM_MASK_MATRIX | The color matrix used to mask out emissive blockers on the emissive plane. Alpha should default to zero, be solely dependent on the RGB value of EMISSIVE_COLOR, and be independant of the RGB value of EM_BLOCK_COLOR. |
| GETREDPART | Returns the red part of a #RRGGBB hex sequence as number |
| GETGREENPART | Returns the green part of a #RRGGBB hex sequence as number |
| GETBLUEPART | Returns the blue part of a #RRGGBB hex sequence as number |
| PARSE_LIGHT_COLOR | Parse the hexadecimal color into lumcounts of each perspective. |
+ A set of appearance flags applied to all emissive and emissive blocker overlays.
+ Uses a dedicated render_target object to copy the entire appearance in real time to the blocking layer. For things that can change in appearance a lot from the base state, like humans.
+ The color applied to all emissive overlays.
+ The color applied to all emissive blockers. Is meant to be the exact opposite of the EMMISIVE_COLOR
+ The color matrix used to mask out emissive blockers on the emissive plane. Alpha should default to zero, be solely dependent on the RGB value of EMISSIVE_COLOR, and be independant of the RGB value of EM_BLOCK_COLOR.
+ Returns the blue part of a #RRGGBB hex sequence as number
+ Returns the green part of a #RRGGBB hex sequence as number
+ Returns the red part of a #RRGGBB hex sequence as number
+ Parse the hexadecimal color into lumcounts of each perspective.
| GAMMALATHE | Used for gamma armoury lathe designs |
|---|---|
| SUPERMATTER_HEAT_PENALTY_THRESHOLD | Higher == Crystal safe operational temperature is higher. |
| AALARM_MODE_SCRUBBING | Air alarm modes |
+ Air alarm modes
+ Used for gamma armoury lathe designs
+ Higher == Crystal safe operational temperature is higher.
| MAPPING_DIRECTIONAL_HELPERS | Create directional subtypes for a path to simplify mapping. |
|---|
+ Create directional subtypes for a path to simplify mapping.
| MILLA_TILE_SIZE | The number of values per tile. |
|---|---|
| MILLA_INTERESTING_TILE_SIZE | The number of values per interesting tile. |
| MILLA_INTERESTING_REASON_DISPLAY | Interesting because it needs a display update. |
| MILLA_INTERESTING_REASON_HOT | Interesting because it's hot enough to start a fire. Excludes normal-temperature Lavaland tiles without an active fire. |
| MILLA_INTERESTING_REASON_WIND | Interesting because it has wind that can push stuff around. |
+ Interesting because it needs a display update.
+ Interesting because it's hot enough to start a fire. Excludes normal-temperature Lavaland tiles without an active fire.
+ Interesting because it has wind that can push stuff around.
+ The number of values per interesting tile.
+ The number of values per tile.
| GERM_LEVEL_AMBIENT | GERMS AND INFECTIONS |
|---|---|
| EMOJI_SET | Emoji icon set |
| RANGE_EDGE_TURFS | Returns the turfs on the edge of a square with CENTER in the middle and with the given RADIUS. If used near the edge of the map, will still work fine. |
| get_area | Grabs the area of a supplied object. Passing an area in to this will result in an error |
| REGION_ALL | Access Region Codes |
| GREYSCALE_COLOR_REPLACE | Pure Black and white colorblindness. Every species except Vulpkanins and Tajarans will have this. |
| PROTANOPIA_COLOR_REPLACE | Red colorblindness. Vulpkanins/Wolpins have this. |
| TRITANOPIA_COLOR_REPLACE | Yellow-Blue colorblindness. Tajarans/Farwas have this. |
| CLIENT_FROM_VAR | Return a Client |
| BASE_DEFIB_TIME_LIMIT | Past this much time the patient is unrecoverable (in deciseconds). |
| DEFIB_TIME_LOSS | Brain damage starts setting in on the patient after some time left rotting. |
| MAPTEXT | Prepares a text to be used for maptext. Use this so it doesn't look hideous. |
| PARALLAX_DELAY_DEFAULT | About 0.05 Seconds of delay |
| DISCORD_WEBHOOK_PRIMARY | Send to the primary Discord webhook |
| DISCORD_WEBHOOK_ADMIN | Send to the admin Discord webhook |
| DISCORD_WEBHOOK_MENTOR | Send to the mentor Discord webhook |
| UNTIL | Waits at a line of code until X is true |
| REFLECTABILITY_NEVER | Projectile reflectability defines |
| DEADCHAT_DEMOCRACY_MODE | Will execute a single command after the cooldown based on player votes. |
| DEADCHAT_ANARCHY_MODE | Allows each player to do a single command every cooldown. |
| MUTE_DEADCHAT_DEMOCRACY_MESSAGES | Mutes the democracy mode messages send to orbiters at the end of each cycle. Useful for when the cooldown is so low it'd get spammy. |
| SLEEP_CHECK_QDEL | Sleep check QDEL. Like sleep check death, but checks deleting. Good for non mobs. |
| BRAIN_DAMAGE_BOOK_TIME | Reading books can help with brain damage! +These are seperate times so that a user gains more benefits by reading more books, +but also cant infinitely switch between 1000 books. +The amount of time needed to pass to let a single book be read again for brain benefits |
| BRAIN_DAMAGE_MOB_TIME | The amount of time a mob needs to wait between any book reading |
| text_ref | Takes a datum as input, returns its ref string, or a cached version of it +This allows us to cache \ref creation, which ensures it'll only ever happen once per datum, saving string tree time +It is slightly less optimal then a []'d datum, but the cost is massively outweighed by the potential savings +It will only work for datums mind, for datum reasons +: because of the embedded typecheck |
| LOG_MAZE_PROGRESS | I dont recommend touching these map generator defines unless you know what you're doing with maze generators. |
| PINPOINTER_MODE_DET | Detective's mode on pinpointers |
| DISPOSAL_SOUND_COOLDOWN | How frequently disposals can make sounds, to prevent huge sound stacking |
| VOTE_RESULT_TYPE_MAJORITY | The different kinds of voting |
| RESTRICT_TYPE | A helper used by restrict_file_types.py to identify types to restrict in a file. Not used by byond at all. |
+ Past this much time the patient is unrecoverable (in deciseconds).
+ Reading books can help with brain damage! +These are seperate times so that a user gains more benefits by reading more books, +but also cant infinitely switch between 1000 books. +The amount of time needed to pass to let a single book be read again for brain benefits
+ The amount of time a mob needs to wait between any book reading
+ Return a Client
+ Allows each player to do a single command every cooldown.
+ Will execute a single command after the cooldown based on player votes.
+ Brain damage starts setting in on the patient after some time left rotting.
+ Send to the admin Discord webhook
+ Send to the mentor Discord webhook
+ Send to the primary Discord webhook
+ How frequently disposals can make sounds, to prevent huge sound stacking
+ Emoji icon set
+ GERMS AND INFECTIONS
+ Pure Black and white colorblindness. Every species except Vulpkanins and Tajarans will have this.
+ I dont recommend touching these map generator defines unless you know what you're doing with maze generators.
+ Prepares a text to be used for maptext. Use this so it doesn't look hideous.
+ Mutes the democracy mode messages send to orbiters at the end of each cycle. Useful for when the cooldown is so low it'd get spammy.
+ About 0.05 Seconds of delay
+ Detective's mode on pinpointers
+ Red colorblindness. Vulpkanins/Wolpins have this.
+ Returns the turfs on the edge of a square with CENTER in the middle and with the given RADIUS. If used near the edge of the map, will still work fine.
+ Projectile reflectability defines
+ Access Region Codes
+ A helper used by restrict_file_types.py to identify types to restrict in a file. Not used by byond at all.
+ Sleep check QDEL. Like sleep check death, but checks deleting. Good for non mobs.
+ Yellow-Blue colorblindness. Tajarans/Farwas have this.
+ Waits at a line of code until X is true
+ The different kinds of voting
+ Grabs the area of a supplied object. Passing an area in to this will result in an error
+ Takes a datum as input, returns its ref string, or a cached version of it +This allows us to cache \ref creation, which ensures it'll only ever happen once per datum, saving string tree time +It is slightly less optimal then a []'d datum, but the cost is massively outweighed by the potential savings +It will only work for datums mind, for datum reasons +: because of the embedded typecheck
| ORGAN_BROKEN | ORGAN DEFINES |
|---|---|
| STANDING_UP | Mob is standing up, usually associated with lying_angle value of 0. |
| LYING_DOWN | Mob is lying down, usually associated with lying_angle values of 90 or 270. |
| PIXEL_Y_OFFSET_LYING | How much a mob's sprite should be moved when they're lying down |
| REAGENTS_METABOLISM | REAGENT STUFF |
| SHOCK_NOGLOVES | Flags used by the flags parameter of electrocute act. +Makes it so that the shock doesn't take gloves into account. |
| SHOCK_TESLA | Used when the shock is from a tesla bolt. |
| SHOCK_ILLUSION | Used when an illusion shocks something. Makes the shock deal stamina damage and not trigger certain secondary effects. |
| SHOCK_NOSTUN | The shock doesn't stun. |
| MAX_GOLD_CORE_MOBS | Max amount of living Xenobio mobs allowed at any given time (excluding slimes). |
| EXAMINE_MORE_WINDOW | If you examine the same atom twice in this timeframe, we call examine_more() instead of examine() |
+ If you examine the same atom twice in this timeframe, we call examine_more() instead of examine()
+ Mob is lying down, usually associated with lying_angle values of 90 or 270.
+ Max amount of living Xenobio mobs allowed at any given time (excluding slimes).
+ ORGAN DEFINES
+ How much a mob's sprite should be moved when they're lying down
+ REAGENT STUFF
+ Used when an illusion shocks something. Makes the shock deal stamina damage and not trigger certain secondary effects.
+ Flags used by the flags parameter of electrocute act. +Makes it so that the shock doesn't take gloves into account.
+ The shock doesn't stun.
+ Used when the shock is from a tesla bolt.
+ Mob is standing up, usually associated with lying_angle value of 0.
| DEFAULT_MAX_COMPLEXITY | Default value for the max_complexity var on MODsuits |
|---|---|
| DEFAULT_CHARGE_DRAIN | Default cell drain per process on MODsuits |
| MOD_ACTIVATION_STEP_TIME | Default time for a part to seal |
| MODULE_PASSIVE | Passive module, just acts when put in naturally. |
| MODULE_USABLE | Usable module, does something when you press a button. |
| MODULE_TOGGLE | Toggle module, you turn it on/off and it does stuff. |
| MODULE_ACTIVE | Actively usable module, you may only have one selected at a time. |
| MODULE_ALLOW_INCAPACITATED | This module can be used while incapacitated |
| MODULE_ALLOW_INACTIVE | This module can be used while the suit is off |
+ Default cell drain per process on MODsuits
+ Default value for the max_complexity var on MODsuits
+ Actively usable module, you may only have one selected at a time.
+ This module can be used while the suit is off
+ This module can be used while incapacitated
+ Passive module, just acts when put in naturally.
+ Toggle module, you turn it on/off and it does stuff.
+ Usable module, does something when you press a button.
+ Default time for a part to seal
| NEWSCASTER_HEADLINES | Headlines screen index. |
|---|---|
| NEWSCASTER_JOBS | Available Jobs screen index. |
| NEWSCASTER_CHANNEL | View Channel screen index. |
| NEWSCASTER_CENSOR_AUTHOR | Censor author name. |
| NEWSCASTER_CENSOR_STORY | Censor story title, body and image. |
+ Censor author name.
+ Censor story title, body and image.
+ View Channel screen index.
+ Headlines screen index.
+ Available Jobs screen index.
| PW_CHANNEL_EQUIPMENT | Power Channel for equipment power users |
|---|---|
| PW_CHANNEL_LIGHTING | Power chanel for lighting power users |
| PW_CHANNEL_ENVIRONMENT | Power channel for environmental power users |
| PW_ALWAYS_UNPOWERED | Local powernet in this area will never be powered, even if its recieving power |
| PW_ALWAYS_POWERED | Local powernet in this area will always have power even if its not recieving power |
| MACHINE_FLICKER_CHANCE | roughly 1/2000 chance of a machine flickering on any given tick. That means in a two hour round each machine will flicker on average a little less than two times. |
| BROKEN | Machine is broken |
| NOPOWER | Machine is not recieving any power from the local powernet |
| MAINT | machine is currently under maintenance |
| EMPED | Machine is currently affected by EMP pulse |
| NO_POWER_USE | This machine is not currently consuming any power passively |
| IDLE_POWER_USE | This machine is consuming its idle power amount passively |
| ACTIVE_POWER_USE | This machine is consuming its active power amount passively |
| APC_NOT_CHARGING | APC is not recieving power |
| APC_IS_CHARGING | APC is currently recieving power and storing it |
| APC_FULLY_CHARGED | APC battery is at 100% |
+ This machine is consuming its active power amount passively
+ APC battery is at 100%
+ APC is currently recieving power and storing it
+ APC is not recieving power
+ Machine is broken
+ Machine is currently affected by EMP pulse
+ This machine is consuming its idle power amount passively
+ roughly 1/2000 chance of a machine flickering on any given tick. That means in a two hour round each machine will flicker on average a little less than two times.
+ machine is currently under maintenance
+ Machine is not recieving any power from the local powernet
+ This machine is not currently consuming any power passively
+ Local powernet in this area will always have power even if its not recieving power
+ Local powernet in this area will never be powered, even if its recieving power
+ Power channel for environmental power users
+ Power Channel for equipment power users
+ Power chanel for lighting power users
| PREFTOGGLE_SPECIAL | Special toggles, stuff that just overrides set_toggles entirely |
|---|---|
| PREFTOGGLE_SOUND | Interacts with the sound bitflag |
| PREFTOGGLE_TOGGLE1 | Interacts with the toggles bitflag |
| PREFTOGGLE_TOGGLE2 | Interacts with the toggles2 bitflag |
| _2FA_DISABLED | Client has 2FA disabled |
| _2FA_ENABLED_IP | Client will be prompted for 2FA on IP changes |
| _2FA_ENABLED_ALWAYS | Client will be prompted for 2FA always |
+ Interacts with the sound bitflag
+ Special toggles, stuff that just overrides set_toggles entirely
+ Interacts with the toggles bitflag
+ Interacts with the toggles2 bitflag
+ Client has 2FA disabled
+ Client will be prompted for 2FA always
+ Client will be prompted for 2FA on IP changes
| /procpath | Represents a proc or verb path. |
|---|
| GC_QUEUE_FILTER | short queue to filter out quick gc successes so they don't hang around in the main queue for 5 minutes |
|---|---|
| GC_QUEUE_CHECK | main queue that waits 5 minutes because thats the longest byond can hold a reference to our shit. |
| GC_QUEUE_HARDDELETE | short queue for things that hard delete instead of going thru the gc subsystem, this is purely so if they can softdelete, they will soft delete rather then wasting time with a hard delete. |
| GC_QUEUE_COUNT | Number of queues, used for allocating the nested lists. Don't forget to increase this if you add a new queue stage |
| GC_QUEUE_ITEM_QUEUE_TIME | Time this item entered the queue |
| GC_QUEUE_ITEM_REF | Ref to the item |
| GC_QUEUE_ITEM_GCD_DESTROYED | Item's gc_destroyed var value. Used to detect ref reuse. |
| GC_QUEUE_ITEM_INDEX_COUNT | Number of item indexes, used for allocating the nested lists. Don't forget to increase this if you add a new queue item index |
+ main queue that waits 5 minutes because thats the longest byond can hold a reference to our shit.
+ Number of queues, used for allocating the nested lists. Don't forget to increase this if you add a new queue stage
+ short queue to filter out quick gc successes so they don't hang around in the main queue for 5 minutes
+ short queue for things that hard delete instead of going thru the gc subsystem, this is purely so if they can softdelete, they will soft delete rather then wasting time with a hard delete.
+ Item's gc_destroyed var value. Used to detect ref reuse.
+ Number of item indexes, used for allocating the nested lists. Don't forget to increase this if you add a new queue item index
+ Time this item entered the queue
+ Ref to the item
| UNHUSK_DAMAGE_THRESHOLD | Health threshold for synthflesh and rezadone to unhusk someone |
|---|---|
| SYNTHFLESH_UNHUSK_AMOUNT | Amount of synthflesh required to unhusk someone |
| SYRINGE_DRAW | Syringe mob interaction modes |
| BLOOD_TYPE_FAKE_BLOOD | Like O- blood but doesn't contribute to blood_volume or vampire nutrition |
| REAGENT_GOAL_SKIP | Used for secondary goals. +TOO easy, not accepted for variety goals. |
| REAGENT_GOAL_EASY | Easy reagent, ask for a lot for single goals. |
| REAGENT_GOAL_NORMAL | Normal reagent, ask for a middling amount for single goals. |
| REAGENT_GOAL_HARD | Hard reagent, ask for a little for single goals. |
| REAGENT_GOAL_EXCESSIVE | TOO hard, accepted for variety goals, but never used for single goals. |
+ Like O- blood but doesn't contribute to blood_volume or vampire nutrition
+ Easy reagent, ask for a lot for single goals.
+ TOO hard, accepted for variety goals, but never used for single goals.
+ Hard reagent, ask for a little for single goals.
+ Normal reagent, ask for a middling amount for single goals.
+ Used for secondary goals. +TOO easy, not accepted for variety goals.
+ Amount of synthflesh required to unhusk someone
+ Syringe mob interaction modes
+ Health threshold for synthflesh and rezadone to unhusk someone
| /proc/rustg_get_version | +Gets the version of rust_g |
|---|---|
| rustg_setup_acreplace | Sets up the Aho-Corasick automaton with its default options. |
| rustg_setup_acreplace_with_options | Sets up the Aho-Corasick automaton using supplied options. |
| rustg_acreplace | Run the specified replacement engine with the provided haystack text to replace, returning replaced text. |
| rustg_acreplace_with_replacements | Run the specified replacement engine with the provided haystack text to replace, returning replaced text. |
| rustg_cnoise_generate | This proc generates a cellular automata noise grid which can be used in procedural generation methods. |
| rustg_dbp_generate | This proc generates a grid of perlin-like noise |
| rustg_dmi_icon_states | input: must be a path, not an /icon; you have to do your own handling if it is one, as icon objects can't be directly passed to rustg. |
| rustg_register_nodes_astar | Register a list of nodes into a rust library. This list of nodes must have been serialized in a json.
+Node {// Index of this node in the list of nodes
+unique_id: usize,
+// Position of the node in byond
+x: usize,
+y: usize,
+z: usize,
+// Indexes of nodes connected to this one
+connected_nodes_id: Vec |
| rustg_add_node_astar | Add a new node to the static list of nodes. Same rule as registering_nodes applies. +This node unique_id must be equal to the current length of the static list of nodes |
| rustg_remove_node_astart | *² |
| rustg_generate_path_astar | Compute the shortest path between start_node and goal_node using A*. Heuristic used is simple geometric distance |
| rustg_redis_connect_rq | Connects to a given redis server. |
| /proc/rustg_redis_disconnect_rq | +Disconnects from a previously connected redis server |
| rustg_redis_lpush | https://redis.io/commands/lpush/ |
| rustg_redis_lrange | https://redis.io/commands/lrange/ |
| rustg_redis_lpop | https://redis.io/commands/lpop/ |
| /proc/rustg_unix_timestamp | +Returns the timestamp as a string |
| rustg_worley_generate | This proc generates a noise grid using worley noise algorithm |
+ Run the specified replacement engine with the provided haystack text to replace, returning replaced text.
+Arguments:
+
+ Run the specified replacement engine with the provided haystack text to replace, returning replaced text.
+Arguments:
+
+ Add a new node to the static list of nodes. Same rule as registering_nodes applies. +This node unique_id must be equal to the current length of the static list of nodes
+ This proc generates a cellular automata noise grid which can be used in procedural generation methods.
+Returns a single string that goes row by row, with values of 1 representing an alive cell, and a value of 0 representing a dead cell.
+Arguments:
+
+ This proc generates a grid of perlin-like noise
+Returns a single string that goes row by row, with values of 1 representing an turned on cell, and a value of 0 representing a turned off cell.
+Arguments:
+
+ input: must be a path, not an /icon; you have to do your own handling if it is one, as icon objects can't be directly passed to rustg.
+output: json_encode'd list. json_decode to get a flat list with icon states in the order they're in inside the .dmi
+ Compute the shortest path between start_node and goal_node using A*. Heuristic used is simple geometric distance
+ Connects to a given redis server.
+Arguments:
+
+ https://redis.io/commands/lpop/
+Arguments
+Note: count was added in Redis version 6.2.0
+ https://redis.io/commands/lpush/
+Arguments
+
+ https://redis.io/commands/lrange/
+Arguments
+
+ Register a list of nodes into a rust library. This list of nodes must have been serialized in a json.
+Node {// Index of this node in the list of nodes
+unique_id: usize,
+// Position of the node in byond
+x: usize,
+y: usize,
+z: usize,
+// Indexes of nodes connected to this one
+connected_nodes_id: Vec
+ *²
+
+ Sets up the Aho-Corasick automaton with its default options.
+The search patterns list and the replacements must be of the same length when replace is run, but an empty replacements list is allowed if replacements are supplied with the replace call +Arguments:
+
+ Sets up the Aho-Corasick automaton using supplied options.
+The search patterns list and the replacements must be of the same length when replace is run, but an empty replacements list is allowed if replacements are supplied with the replace call +Arguments:
+
+ This proc generates a noise grid using worley noise algorithm
+Returns a single string that goes row by row, with values of 1 representing an alive cell, and a value of 0 representing a dead cell.
+Arguments:
+| SOUND_RANGE | Default range of a sound. |
|---|---|
| SOUND_RANGE_SET | Easy-to-math sound range for simpler coding with specific variables. Insert the exact range you wish the sound to be heard from. |
| SHORT_RANGE_SOUND_EXTRARANGE | default extra range for sounds considered to be quieter |
| SILENCED_SOUND_EXTRARANGE | The range deducted from sound range for things that are considered silent / sneaky |
| SOUND_DEFAULT_FALLOFF_DISTANCE | Percentage of sound's range where no falloff is applied |
| SOUND_FALLOFF_EXPONENT | The default exponent of sound falloff |
+ default extra range for sounds considered to be quieter
+ The range deducted from sound range for things that are considered silent / sneaky
+ Percentage of sound's range where no falloff is applied
+ The default exponent of sound falloff
+ Default range of a sound.
+ Easy-to-math sound range for simpler coding with specific variables. Insert the exact range you wish the sound to be heard from.
| STATION_TRAIT_ABSTRACT | For traits that shouldn't be selected, like abstract types (wow) |
|---|---|
| STATION_TRAIT_PLANETARY | Only run on planet stations |
| STATION_TRAIT_SPACE_BOUND | Only run on space stations |
| STATION_TRAIT_MAP_UNRESTRICTED | Not restricted by space or planet, can always just happen |
| FUTURE_STATION_TRAITS_FILE | The data file that future station traits forced by an admin are stored in |
+ The data file that future station traits forced by an admin are stored in
+ For traits that shouldn't be selected, like abstract types (wow)
+ Not restricted by space or planet, can always just happen
+ Only run on planet stations
+ Only run on space stations
| REAGENT_GOAL_FORGIVENESS | How many units can be missing from a reagent and still count to the goal. +Prevents floationg point rounding from making you fail even though you +seemed to have sent enough. |
|---|
+ How many units can be missing from a reagent and still count to the goal. +Prevents floationg point rounding from making you fail even though you +seemed to have sent enough.
| STATUS_EFFECT_FLESHMEND | Rapid burn/brute/oxy/blood healing from the cling ability |
|---|---|
| STATUS_EFFECT_BURNT_WINGS | Whether a moth's wings are burnt |
| STATUS_EFFECT_COCOONED | If a moth is in a cocoon |
| STATUS_EFFECT_OFFERING_ITEM | Status effect given when someone uses the Give Item command to offer an item to another player. |
| STATUS_EFFECT_FAKE_VIRUS | gives you fluff messages for cough, sneeze, headache, etc but without an actual virus |
| STATUS_EFFECT_LWAPSCOPE | This status effect lets the user see the lwap dots. |
| STATUS_EFFECT_REVIVABLE | This status effect allows a mob to be revived with a defibrillator. |
| STATUS_EFFECT_TELEPORT_ROULETTE | Causes a random safe teleport every 2 seconds for a limited time |
| STATUS_EFFECT_REMOVE_CUFFS | Status effects for different actions |
+ Whether a moth's wings are burnt
+ If a moth is in a cocoon
+ gives you fluff messages for cough, sneeze, headache, etc but without an actual virus
+ Rapid burn/brute/oxy/blood healing from the cling ability
+ This status effect lets the user see the lwap dots.
+ Status effect given when someone uses the Give Item command to offer an item to another player.
+ Status effects for different actions
+ This status effect allows a mob to be revived with a defibrillator.
+ Causes a random safe teleport every 2 seconds for a limited time
| STRIPPABLE_OBSCURING_NONE | This slot is not obscured. |
|---|---|
| STRIPPABLE_OBSCURING_COMPLETELY | This slot is completely obscured, and cannot be accessed. |
| STRIPPABLE_OBSCURING_HIDDEN | This slot can't be seen, but can be accessed. |
+ This slot is completely obscured, and cannot be accessed.
+ This slot can't be seen, but can be accessed.
+ This slot is not obscured.
| TIMER_DELETE_ME | Delete the timer on parent datum Destroy() and when deltimer'd |
|---|
+ Delete the timer on parent datum Destroy() and when deltimer'd
| SURGERY_BLOODSPREAD_NONE | Defines for surgery and other stuff. +Don't splash any blood. |
|---|---|
| SURGERY_BLOODSPREAD_HANDS | Cover the surgeon's hands in blood. |
| SURGERY_BLOODSPREAD_FULLBODY | Cover the surgeon's body in blood. |
| SURGERY_INITIATOR_ORGANIC | An initiator with this can start surgeries on organic organs. Make sure that anything that can be sharp gets this as well. |
| SURGERY_INITIATOR_ROBOTIC | An initiator with this can start surgeries on robotic organs. |
| ORGAN_CLOSED | Closed up. |
| ORGAN_ORGANIC_OPEN | An organic limb that's been opened, at least once. |
| ORGAN_ORGANIC_ENCASED_OPEN | An organ that's encased, probably with bone, where that casing has been cut through. |
| ORGAN_ORGANIC_VIOLENT_OPEN | An organ that has been violently opened, likely via damage. |
| ORGAN_SYNTHETIC_LOOSENED | Synthetic organ that's been unscrewed. |
| ORGAN_SYNTHETIC_OPEN | Synthetic organ that's had its panel opened. |
| SURGERY_BEGINSTEP_ABORT | Return this from begin_step() to abort the step and not try the surgery. |
| SURGERY_BEGINSTEP_SKIP | Return this from begin_step() to skip the current step entirely and proceed to the next one. +Use this if you would end up leaving someone in an invalid state. |
| SURGERY_STEP_INCOMPLETE | The surgery step was not completed for some reason, and the next action will again be on this step. |
| SURGERY_STEP_CONTINUE | The surgery step was completed, and the surgery should continue to the next step. |
| SURGERY_STEP_RETRY_ALWAYS | This step will automatically be retried without question as long as this is returned. +Be very cautious with this one! Make sure that any flow where this is used has an exit condition where something else will be returned. +Otherwise, the user will be stuck in a loop! |
| SURGERY_STEP_RETRY | This surgery step will be conditionally retried, so long as the surgery step's can_repeat() proc returns TRUE. +Otherwise, it'll behave just like SURGERY_STEP_INCOMPLETE. |
| SURGERY_INITIATE_CONTINUE_CHAIN | The surgery initiation isn't even going to be started. If you're working with the attack chain, this is probably what you'll be using. |
| SURGERY_INITIATE_SUCCESS | The surgery initiaition was a success. We're advancing the current surgery. |
| SURGERY_INITIATE_FAILURE | The surgery initiation was interrupted, or for some reason never completed. We don't want to return FALSE to the attack chain, though. |
| SURGERY_INITIATE_INTERRUPTED | The surgery never reached (or finished) the do_after. Go back to the state we were in before this even happened. |
+ Closed up.
+ An organ that's encased, probably with bone, where that casing has been cut through.
+ An organic limb that's been opened, at least once.
+ An organ that has been violently opened, likely via damage.
+ Synthetic organ that's been unscrewed.
+ Synthetic organ that's had its panel opened.
+ Return this from begin_step() to abort the step and not try the surgery.
+ Return this from begin_step() to skip the current step entirely and proceed to the next one. +Use this if you would end up leaving someone in an invalid state.
+ Cover the surgeon's body in blood.
+ Cover the surgeon's hands in blood.
+ Defines for surgery and other stuff. +Don't splash any blood.
+ The surgery initiation isn't even going to be started. If you're working with the attack chain, this is probably what you'll be using.
+ The surgery initiation was interrupted, or for some reason never completed. We don't want to return FALSE to the attack chain, though.
+ The surgery never reached (or finished) the do_after. Go back to the state we were in before this even happened.
+ The surgery initiaition was a success. We're advancing the current surgery.
+ An initiator with this can start surgeries on organic organs. Make sure that anything that can be sharp gets this as well.
+ An initiator with this can start surgeries on robotic organs.
+ The surgery step was completed, and the surgery should continue to the next step.
+ The surgery step was not completed for some reason, and the next action will again be on this step.
+ This surgery step will be conditionally retried, so long as the surgery step's can_repeat() proc returns TRUE. +Otherwise, it'll behave just like SURGERY_STEP_INCOMPLETE.
+ This step will automatically be retried without question as long as this is returned. +Be very cautious with this one! Make sure that any flow where this is used has an exit condition where something else will be returned. +Otherwise, the user will be stuck in a loop!
| MAX_CHARACTERS_PER_BOOKPAGE | Max Characters that can be on a single book page, this will give players an average of 5000 words worth of writing space (1000 per page) |
|---|---|
| SANITIZE_FILENAME | Removes characters incompatible with file names. |
+ Max Characters that can be on a single book page, this will give players an average of 5000 words worth of writing space (1000 per page)
+ Removes characters incompatible with file names.
| MOB_SHARED_COOLDOWN_1 | COOLDOWN SYSTEMS |
|---|
+ COOLDOWN SYSTEMS
| TGS_EVENT_REBOOT_MODE_CHANGE | Create this define if you want to do TGS configuration outside of this file. +Before a reboot mode change, extras parameters are the current and new reboot mode enums. |
|---|---|
| TGS_EVENT_PORT_SWAP | Before a port change is about to happen, extra parameters is new port. |
| TGS_EVENT_INSTANCE_RENAMED | Before the instance is renamed, extra parameter is the new name. |
| TGS_EVENT_WATCHDOG_REATTACH | After the watchdog reattaches to DD, extra parameter is the new /datum/tgs_version of the server. |
| TGS_EVENT_HEALTH_CHECK | When the watchdog sends a health check to DD. No parameters. |
| TGS_EVENT_REPO_RESET_ORIGIN | When the repository is reset to its origin reference. Parameters: Reference name, Commit SHA. |
| TGS_EVENT_REPO_CHECKOUT | When the repository performs a checkout. Parameters: Checkout git object. |
| TGS_EVENT_REPO_FETCH | When the repository performs a fetch operation. No parameters. |
| TGS_EVENT_REPO_MERGE_PULL_REQUEST | When the repository test merges. Parameters: PR Number, PR Sha, (Nullable) Comment made by TGS user. |
| TGS_EVENT_REPO_PRE_SYNCHRONIZE | Before the repository makes a sychronize operation. Parameters: Absolute repostiory path. |
| TGS_EVENT_ENGINE_INSTALL_START | Before a engine install operation begins. Parameters: Version string of the installing engine. |
| TGS_EVENT_ENGINE_INSTALL_FAIL | When a engine install operation fails. Parameters: Error message |
| TGS_EVENT_ENGINE_ACTIVE_VERSION_CHANGE | When the active engine version changes. Parameters: (Nullable) Version string of the current engine, version string of the new engine. |
| TGS_EVENT_COMPILE_START | When the compiler starts running. Parameters: Game directory path, origin commit SHA. |
| TGS_EVENT_COMPILE_CANCELLED | When a compile is cancelled. No parameters. |
| TGS_EVENT_COMPILE_FAILURE | When a compile fails. Parameters: Game directory path, [TRUE]/[FALSE] based on if the cause for failure was DMAPI validation. |
| TGS_EVENT_COMPILE_COMPLETE | When a compile operation completes. Note, this event fires before the new .dmb is loaded into the watchdog. Consider using the TGS_EVENT_DEPLOYMENT_COMPLETE instead. Parameters: Game directory path. |
| TGS_EVENT_INSTANCE_AUTO_UPDATE_START | When an automatic update for the current instance begins. No parameters. |
| TGS_EVENT_REPO_MERGE_CONFLICT | When the repository encounters a merge conflict: Parameters: Base SHA, target SHA, base reference, target reference. |
| TGS_EVENT_DEPLOYMENT_COMPLETE | When a deployment completes. No Parameters. |
| TGS_EVENT_WATCHDOG_SHUTDOWN | Before the watchdog shuts down. Not sent for graceful shutdowns. No parameters. |
| TGS_EVENT_WATCHDOG_DETACH | Before the watchdog detaches for a TGS update/restart. No parameters. |
| TGS_EVENT_WORLD_PRIME | Watchdog event when TgsInitializationComplete() is called. No parameters. |
| TGS_EVENT_REPO_SUBMODULE_UPDATE | After a single submodule update is performed. Parameters: Updated submodule name. |
| TGS_EVENT_PRE_DREAM_MAKER | After CodeModifications are applied, before DreamMaker is run. Parameters: Game directory path, origin commit sha, version string of the used engine. |
| TGS_EVENT_DEPLOYMENT_CLEANUP | Whenever a deployment folder is deleted from disk. Parameters: Game directory path. |
| TGS_REBOOT_MODE_NORMAL | The server will reboot normally. |
| TGS_REBOOT_MODE_SHUTDOWN | The server will stop running on reboot. |
| TGS_REBOOT_MODE_RESTART | The watchdog will restart on reboot. |
| TGS_SECURITY_TRUSTED | DreamDaemon Trusted security level. |
| TGS_SECURITY_SAFE | DreamDaemon Safe security level. |
| TGS_SECURITY_ULTRASAFE | DreamDaemon Ultrasafe security level. |
| TGS_VISIBILITY_PUBLIC | DreamDaemon public visibility level. |
| TGS_VISIBILITY_PRIVATE | DreamDaemon private visibility level. |
| TGS_VISIBILITY_INVISIBLE | DreamDaemon invisible visibility level. |
| TGS_ENGINE_TYPE_BYOND | The Build Your Own Net Dream engine. |
| TGS_ENGINE_TYPE_OPENDREAM | The OpenDream engine. |
| TGS_TOPIC | Put this at the start of [/world/proc/Topic]. |
| /datum/tgs_revision_information | Represents git revision information. |
| /datum/tgs_version | Represents a version. |
| /datum/tgs_revision_information/test_merge | Represents a merge of a GitHub pull request. |
| /datum/tgs_chat_channel | Represents a connected chat channel. |
| /datum/tgs_event_handler | User definable handler for TGS events. |
| /datum/tgs_chat_command | User definable chat command. |
| /datum/tgs_message_content | User definable chat message. |
| /datum/tgs_chat_embed/structure | User definable chat embed. Currently mirrors Discord chat embeds. See https://discord.com/developers/docs/resources/channel#embed-object-embed-structure for details. |
| /datum/tgs_chat_embed/media | Common datum for similar discord embed medias. |
| /datum/tgs_chat_embed/footer | See https://discord.com/developers/docs/resources/channel#embed-object-embed-footer-structure for details. |
| /datum/tgs_chat_embed/provider | See https://discord.com/developers/docs/resources/channel#embed-object-embed-provider-structure for details. |
| /datum/tgs_chat_embed/provider/author | See https://discord.com/developers/docs/resources/channel#embed-object-embed-author-structure for details. Must have name set in New(). |
| /datum/tgs_chat_embed/field | See https://discord.com/developers/docs/resources/channel#embed-object-embed-field-structure for details. Must have name and value set in New(). |
+ The Build Your Own Net Dream engine.
+ The OpenDream engine.
+ When a compile is cancelled. No parameters.
+ When a compile operation completes. Note, this event fires before the new .dmb is loaded into the watchdog. Consider using the TGS_EVENT_DEPLOYMENT_COMPLETE instead. Parameters: Game directory path.
+ When a compile fails. Parameters: Game directory path, [TRUE]/[FALSE] based on if the cause for failure was DMAPI validation.
+ When the compiler starts running. Parameters: Game directory path, origin commit SHA.
+ Whenever a deployment folder is deleted from disk. Parameters: Game directory path.
+ When a deployment completes. No Parameters.
+ When the active engine version changes. Parameters: (Nullable) Version string of the current engine, version string of the new engine.
+ When a engine install operation fails. Parameters: Error message
+ Before a engine install operation begins. Parameters: Version string of the installing engine.
+ When the watchdog sends a health check to DD. No parameters.
+ When an automatic update for the current instance begins. No parameters.
+ Before the instance is renamed, extra parameter is the new name.
+ Before a port change is about to happen, extra parameters is new port.
+ After CodeModifications are applied, before DreamMaker is run. Parameters: Game directory path, origin commit sha, version string of the used engine.
+ Create this define if you want to do TGS configuration outside of this file. +Before a reboot mode change, extras parameters are the current and new reboot mode enums.
+ When the repository performs a checkout. Parameters: Checkout git object.
+ When the repository performs a fetch operation. No parameters.
+ When the repository encounters a merge conflict: Parameters: Base SHA, target SHA, base reference, target reference.
+ When the repository test merges. Parameters: PR Number, PR Sha, (Nullable) Comment made by TGS user.
+ Before the repository makes a sychronize operation. Parameters: Absolute repostiory path.
+ When the repository is reset to its origin reference. Parameters: Reference name, Commit SHA.
+ After a single submodule update is performed. Parameters: Updated submodule name.
+ Before the watchdog detaches for a TGS update/restart. No parameters.
+ After the watchdog reattaches to DD, extra parameter is the new /datum/tgs_version of the server.
+ Before the watchdog shuts down. Not sent for graceful shutdowns. No parameters.
+ Watchdog event when TgsInitializationComplete() is called. No parameters.
+ The server will reboot normally.
+ The watchdog will restart on reboot.
+ The server will stop running on reboot.
+ DreamDaemon Safe security level.
+ DreamDaemon Trusted security level.
+ DreamDaemon Ultrasafe security level.
+ Put this at the start of [/world/proc/Topic].
+ DreamDaemon invisible visibility level.
+ DreamDaemon private visibility level.
+ DreamDaemon public visibility level.
| UI_INTERACTIVE | Green eye; fully interactive |
|---|---|
| UI_UPDATE | Orange eye; updates but is not interactive |
| UI_DISABLED | Red eye; disabled, does not update |
| UI_CLOSE | UI Should close |
| TGUI_WINDOW_SOFT_LIMIT | Maximum number of windows that can be suspended/reused |
| TGUI_WINDOW_HARD_LIMIT | Maximum number of open windows |
| TGUI_PING_TIMEOUT | Maximum ping timeout allowed to detect zombie windows |
| TGUI_REFRESH_FULL_UPDATE_COOLDOWN | Used for rate-limiting to prevent DoS by excessively refreshing a TGUI window |
| TGUI_WINDOW_CLOSED | Window does not exist |
| TGUI_WINDOW_LOADING | Window was just opened, but is still not ready to be sent data |
| TGUI_WINDOW_READY | Window is free and ready to receive data |
| TGUI_WINDOW_ID | Get a window id based on the provided pool index |
| TGUI_WINDOW_INDEX | Get a pool index of the provided window id |
| TGUI_CREATE_MESSAGE | Creates a message packet for sending via output() |
+ Creates a message packet for sending via output()
+ Maximum ping timeout allowed to detect zombie windows
+ Used for rate-limiting to prevent DoS by excessively refreshing a TGUI window
+ Window does not exist
+ Maximum number of open windows
+ Get a window id based on the provided pool index
+ Get a pool index of the provided window id
+ Window was just opened, but is still not ready to be sent data
+ Window is free and ready to receive data
+ Maximum number of windows that can be suspended/reused
+ UI Should close
+ Red eye; disabled, does not update
+ Green eye; fully interactive
+ Orange eye; updates but is not interactive
| TURF_PATHING_PASS_DENSITY | Turf will be passable if density is 0 |
|---|---|
| TURF_PATHING_PASS_PROC | Turf will be passable depending on [CanPathfindPass] return value |
| TURF_PATHING_PASS_NO | Turf is never passable |
+ Turf will be passable if density is 0
+ Turf is never passable
+ Turf will be passable depending on [CanPathfindPass] return value
| VERB_OVERTIME_QUEUE_THRESHOLD | verb queuing thresholds. remember that since verbs execute after SendMaps the player wont see the effects of the verbs on the game world +until SendMaps executes next tick, and then when that later update reaches them. thus most player input has a minimum latency of world.tick_lag + player ping. +however thats only for the visual effect of player input, when a verb processes the actual latency of game state changes or semantic latency is effectively 1/2 player ping, +unless that verb is queued for the next tick in which case its some number probably smaller than world.tick_lag. +so some verbs that represent player input are important enough that we only introduce semantic latency if we absolutely need to. +its for this reason why player clicks are handled in SSinput before even movement - semantic latency could cause someone to move out of range +when the verb finally processes but it was in range if the verb had processed immediately and overtimed. +queuing tick_usage threshold for verbs that are high enough priority that they only queue if the server is overtiming. +ONLY use for critical verbs |
|---|---|
| VERB_HIGH_PRIORITY_QUEUE_THRESHOLD | queuing tick_usage threshold for verbs that need lower latency more than most verbs. |
| VERB_DEFAULT_QUEUE_THRESHOLD | default queuing tick_usage threshold for most verbs which can allow a small amount of latency to be processed in the next tick |
| TRY_QUEUE_VERB | attempt to queue this verb process if the server is overloaded. evaluates to FALSE if queuing isnt necessary or if it failed. +_verification_args... are only necessary if the verb_manager subsystem youre using checks them in can_queue_verb() +if you put anything in _verification_args that ISNT explicitely put in the can_queue_verb() override of the subsystem youre using, +it will runtime. |
| QUEUE_OR_CALL_VERB | queue wrapper for TRY_QUEUE_VERB() when you want to call the proc if the server isnt overloaded enough to queue |
+ queue wrapper for TRY_QUEUE_VERB() when you want to call the proc if the server isnt overloaded enough to queue
+ attempt to queue this verb process if the server is overloaded. evaluates to FALSE if queuing isnt necessary or if it failed. +_verification_args... are only necessary if the verb_manager subsystem youre using checks them in can_queue_verb() +if you put anything in _verification_args that ISNT explicitely put in the can_queue_verb() override of the subsystem youre using, +it will runtime.
+ default queuing tick_usage threshold for most verbs which can allow a small amount of latency to be processed in the next tick
+ queuing tick_usage threshold for verbs that need lower latency more than most verbs.
+ verb queuing thresholds. remember that since verbs execute after SendMaps the player wont see the effects of the verbs on the game world +until SendMaps executes next tick, and then when that later update reaches them. thus most player input has a minimum latency of world.tick_lag + player ping. +however thats only for the visual effect of player input, when a verb processes the actual latency of game state changes or semantic latency is effectively 1/2 player ping, +unless that verb is queued for the next tick in which case its some number probably smaller than world.tick_lag. +so some verbs that represent player input are important enough that we only introduce semantic latency if we absolutely need to. +its for this reason why player clicks are handled in SSinput before even movement - semantic latency could cause someone to move out of range +when the verb finally processes but it was in range if the verb had processed immediately and overtimed. +queuing tick_usage threshold for verbs that are high enough priority that they only queue if the server is overtiming. +ONLY use for critical verbs
| ZOOM_METHOD_WIELD | How the scope component is toggled. +Wielding the object with both hands toggles the zoom. Requires the two-handed component to work. |
|---|---|
| ZOOM_METHOD_ITEM_ACTION | Activated by clicking an item action button specified by the item_action_type var. |
+ Activated by clicking an item action button specified by the item_action_type var.
+ How the scope component is toggled. +Wielding the object with both hands toggles the zoom. Requires the two-handed component to work.
| /proc/MakeAPICall | +Internal API Caller |
|---|
| SET_BITFLAG_LIST | System for storing bitflags past the 24 limit, making use of an associative list. |
|---|
+ System for storing bitflags past the 24 limit, making use of an associative list.
+Macro converts a list of integers into an associative list of bitflag entries for quicker comparison. +Example: list(0, 4, 26, 32)) => list( "0" = ( (1<<0) | (1<<4) ), "1" = ( (1<<2) | (1<<8) ) ) +Lists are cached into a global list of lists to avoid identical duplicates. +This system makes value comparisons faster than pairing every element of one list with every element of the other for evaluation.
+Arguments:
+| /proc/md5filepath | +Returns the md5 of a file at a given path. |
|---|---|
| /proc/md5asfile | +Save file as an external file then md5 it. +Used because md5ing files stored in the rsc sometimes gives incorrect md5 results. |
| /proc/get_valid_vent_spawns | +Returns a list of vents that can be used as a potential spawn if they meet the criteria set by the arguments |
|---|---|
| /proc/get_bbox_of_atoms | +Get a bounding box of a list of atoms. |
| /proc/makeDatumRefLists | +Initial Building |
|---|
| /proc/icon_exists | +Checks if the given iconstate exists in the given file, caching the result. Setting no_sprite to TRUE will print a stack trace ONCE. |
|---|
| /proc/generate_and_hash_rsc_file | +Generates a filename for a given asset. +Like generate_asset_name(), except returns the rsc reference and the rsc file hash as well as the asset name (sans extension) +Used so that certain asset files dont have to be hashed twice |
|---|---|
| /proc/get_dummy_savefile | +Gets a dummy savefile for usage in icon generation. +Savefiles generated from this proc will be empty. |
| /proc/icon2base64 | +Converts an icon to base64. Operates by putting the icon in the iconCache savefile, +exporting it as text, and then parsing the base64 from that. +(This relies on byond automatically storing icons in savefiles as base64) |
| /proc/is_valid_dmi_file | +given a text string, returns whether it is a valid dmi icons folder path |
| /proc/get_icon_dmi_path | +Given an icon object, dmi file path, or atom/image/mutable_appearance, attempts to find and return an associated dmi file path. +A weird quirk about dm is that /icon objects represent both compile-time or dynamic icons in the rsc, +But stringifying rsc references returns a dmi file path +ONLY if that icon represents a completely unchanged dmi file from when the game was compiled. +So if the given object is associated with an icon that was in the rsc when the game was compiled, this returns a path. otherwise it returns "" |
| /proc/icon2asset | +The dmi file path we attempt to return if the given object argument is associated with a stringifiable icon +If successful, this looks like "icons/path/to/dmi_file.dmi" +generate an asset for the given icon or the icon of the given appearance for [thing], and send it to any clients in target. +Arguments: |
| /proc/costly_icon2asset | +Costlier version of icon2asset() that uses getFlatIcon() to account for overlays, underlays, etc. Use with extreme moderation, ESPECIALLY on mobs. |
| /proc/emissive_appearance | +Produces a mutable appearance glued to the EMISSIVE_PLANE dyed to be the EMISSIVE_COLOR. Order of application matters: Default generated blockers are overlays, and will block its own emissive underlays. If you want an object to be both a blocker, and have their own emissive, it has to be an overlay instead. Grayscale lightmasks are visible in the BYOND right-click and Examine pane, unless they're covered up by another overlay. |
|---|---|
| /proc/emissive_blocker | +Produces a mutable appearance glued to the EMISSIVE_PLANE dyed to be the EM_BLOCK_COLOR. |
| COMPARE_KEY | Passed into BINARY_INSERT to compare keys |
|---|---|
| COMPARE_VALUE | Passed into BINARY_INSERT to compare values |
| BINARY_INSERT_TG | Binary search sorted insert from TG +INPUT: Object to be inserted +LIST: List to insert object into +TYPECONT: The typepath of the contents of the list +COMPARE: The object to compare against, usualy the same as INPUT +COMPARISON: The variable on the objects to compare +COMPTYPE: How should the values be compared? Either COMPARE_KEY or COMPARE_VALUE. |
| /proc/pickweight | +Picks an element based on its weight. +L - The input list |
| /proc/pick_multiple_unique | +Picks multiple unique elements from the suplied list. +If the given list has a length less than the amount given then it will return a list with an equal amount |
| LAZYINITLIST | Initialize the lazylist |
| UNSETEMPTY | If the provided list is empty, set it to null |
| ASSOC_UNSETEMPTY | If the provided key -> list is empty, remove it from the list |
| LAZYLISTDUPLICATE | Like LAZYCOPY - copies an input list if the list has entries, If it doesn't the assigned list is nulled |
| LAZYREMOVE | Remove an item from the list, set the list to null if empty |
| LAZYADD | Add an item to the list, if the list is null it will initialize it |
| LAZYOR | Add an item to the list if not already present, if the list is null it will initialize it |
| LAZYDISTINCTADD | Adds I to L, initializing L if necessary, if I is not already in L |
| LAZYACCESS | returns L[I] if L exists and I is a valid index of L, runtimes if L is not a list |
| LAZYLEN | Returns the length of L |
| LAZYNULL | Sets a list to null |
| LAZYCLEARLIST | Removes all elements from the list |
| LAZYCOPY | Use LAZYLISTDUPLICATE instead if you want it to null with no entries |
| LAZYSET | Sets the item K to the value V, if the list is null it will initialize it |
| LAZYSETLEN | Sets the length of a lazylist |
| LAZYADDASSOC | Adds to the item K the value V, if the list is null it will initialize it |
| LAZYADDASSOCLIST | This is used to add onto lazy assoc list when the value you're adding is a /list/. This one has extra safety over lazyaddassoc because the value could be null (and thus cant be used to += objects) |
| LAZYREMOVEASSOC | Removes the value V from the item K, if the item K is empty will remove it from the list, if the list is empty will set the list to null |
| LAZYACCESSASSOC | Accesses an associative list, returns null if nothing is found |
| QDEL_LAZYLIST | Qdel every item in the list before setting the list to null |
| LAZYIN | If the lazy list is currently initialized find item I in list L |
| ISINDEXSAFE | Returns whether a numerical index is within a given list's bounds. Faster than isnull(LAZYACCESS(L, I)). |
| LAZYORASSOCLIST | Performs an insertion on the given lazy list with the given key and value. If the value already exists, a new one will not be made. |
| /proc/make_associative | +A proc for turning a list into an associative list. |
| /proc/compare_list | +compare two lists, returns TRUE if they are the same |
| /proc/avoid_assoc_duplicate_keys | +takes an input_key, as text, and the list of keys already used, outputting a replacement key in the format of "[input_key] ([number_of_duplicates])" if it finds a duplicate +use this for lists of things that might have the same name, like mobs or objects, that you plan on giving to a player as input |
+ If the provided key -> list is empty, remove it from the list
+ Binary search sorted insert from TG +INPUT: Object to be inserted +LIST: List to insert object into +TYPECONT: The typepath of the contents of the list +COMPARE: The object to compare against, usualy the same as INPUT +COMPARISON: The variable on the objects to compare +COMPTYPE: How should the values be compared? Either COMPARE_KEY or COMPARE_VALUE.
+ Passed into BINARY_INSERT to compare keys
+ Passed into BINARY_INSERT to compare values
+ Returns whether a numerical index is within a given list's bounds. Faster than isnull(LAZYACCESS(L, I)).
+ returns L[I] if L exists and I is a valid index of L, runtimes if L is not a list
+ Accesses an associative list, returns null if nothing is found
+ Add an item to the list, if the list is null it will initialize it
+ Adds to the item K the value V, if the list is null it will initialize it
+ This is used to add onto lazy assoc list when the value you're adding is a /list/. This one has extra safety over lazyaddassoc because the value could be null (and thus cant be used to += objects)
+ Removes all elements from the list
+ Use LAZYLISTDUPLICATE instead if you want it to null with no entries
+ Adds I to L, initializing L if necessary, if I is not already in L
+ If the lazy list is currently initialized find item I in list L
+ Initialize the lazylist
+ Returns the length of L
+ Like LAZYCOPY - copies an input list if the list has entries, If it doesn't the assigned list is nulled
+ Sets a list to null
+ Add an item to the list if not already present, if the list is null it will initialize it
+ Performs an insertion on the given lazy list with the given key and value. If the value already exists, a new one will not be made.
+ Remove an item from the list, set the list to null if empty
+ Removes the value V from the item K, if the item K is empty will remove it from the list, if the list is empty will set the list to null
+ Sets the item K to the value V, if the list is null it will initialize it
+ Sets the length of a lazylist
+ Qdel every item in the list before setting the list to null
+ If the provided list is empty, set it to null
| /proc/random_body_accessory | +Returns a random body accessory for a given species name. Can be null based on is_optional argument. |
|---|---|
| /proc/add_attack_logs | +Creates attack (old and new) logs for the user and defense logs for the target. +Will message admins depending on the custom_level, user and target. |
| /proc/check_active_security_force | +|
| /proc/safe_get_ckey | +Safe ckey getter |
| /proc/round_health | +rounds value to limited symbols after the period for organ damage and other values |
| /proc/get_path_to | +This file contains the stuff you need for using JPS (Jump Point Search) pathing, an alternative to A* that skips +over large numbers of uninteresting tiles resulting in much quicker pathfinding solutions. |
|---|---|
| CAN_STEP | A helper macro to see if it's possible to step from the first turf into the second one, minding things like door access and directional windows. +Note that this can only be used inside the [datum/pathfind][pathfind datum] since it uses variables from said datum. +If you really want to optimize things, optimize this, cuz this gets called a lot. +We do early next.density check despite it being already checked in LinkBlockedWithAccess for short-circuit performance |
| STEP_NOT_HERE_BUT_THERE | Another helper macro for JPS, for telling when a node has forced neighbors that need expanding |
| /datum/jps_node | The JPS Node datum represents a turf that we find interesting enough to add to the open list and possibly search for new tiles from |
| /proc/HeapPathWeightCompare | +TODO: Macro this to reduce proc overhead |
| /datum/pathfind | The datum used to handle the JPS pathfinding, completely self-contained |
+ A helper macro to see if it's possible to step from the first turf into the second one, minding things like door access and directional windows. +Note that this can only be used inside the [datum/pathfind][pathfind datum] since it uses variables from said datum. +If you really want to optimize things, optimize this, cuz this gets called a lot. +We do early next.density check despite it being already checked in LinkBlockedWithAccess for short-circuit performance
+ Another helper macro for JPS, for telling when a node has forced neighbors that need expanding
| /proc/get_rad_contents | +A special GetAllContents that doesn't search past things with rad insulation +Components which return COMPONENT_BLOCK_RADIATION prevent further searching into that object's contents. The object itself will get returned still. +The ignore list makes those objects never return at all |
|---|
| /proc/screen_loc_to_offset | +Takes a screen loc string in the format +"+-left-offset:+-pixel,+-bottom-offset:+-pixel" +Where the :pixel is optional, and returns +A list in the format (x_offset, y_offset) +We require context to get info out of screen locs that contain relative info, so NORTH, SOUTH, etc |
|---|---|
| /proc/offset_to_screen_loc | +Takes a list in the form (x_offset, y_offset) +And converts it to a screen loc string +Accepts an optional view string/size to force the screen_loc around, so it can't go out of scope |
| /proc/get_valid_screen_location | +Returns a valid location to place a screen object without overflowing the viewport |
| /proc/cut_relative_direction | +Takes a screen_loc string and cut out any directions like NORTH or SOUTH |
| /proc/sanitize_for_ic | +sanitize() with a pre-set list of characters to remove from IC speech. |
|---|---|
| /proc/trim_length | +Returns a string that does not exceed max_length characters in size |
| /proc/strip_html_tags | +Strips HTML tags (and only tags) from the input. +The result may still include HTML entities, like ' for ' |
| /proc/client2rankcolour | +Proc to generate a "rank colour" from a client |
| /proc/format_si_suffix | +Formats num with an SI prefix. |
| /proc/wiki_link | +Creates a hyperlink for a specified wiki article. |
| /proc/start_watch | +Returns "watch handle" (really just a timestamp :V) |
|---|---|
| /proc/stop_watch | +Returns number of seconds elapsed. +@param wh number The "Watch Handle" from start_watch(). (timestamp) |
| /proc/seconds_to_clock | +Take a value in seconds and makes it display like a clock. Hours are stripped. (mm:ss) |
| /proc/seconds_to_full_clock | +Take a value in seconds and makes it display like a clock (h:mm:ss) |
| ADD_TRAIT | Adds a status trait to the target datum. |
|---|---|
| REMOVE_TRAIT | Removes a status trait from a target datum. |
| REMOVE_TRAITS_NOT_IN | Removes all status traits from a target datum which were NOT added by sources. |
| REMOVE_TRAITS_IN | Removes all status traits from a target datum which were added by sources. |
| HAS_MIND_TRAIT | A simple helper for checking traits in a mob's mind |
| UNIQUE_TRAIT_SOURCE | Gives a unique trait source for any given datum |
| TRAIT_DODGE_ALL_OBJECTS | Allows a mob to dodge all thrown objects |
| TRAIT_MENTOR_OBSERVING | used for dead mobs that are observing, but should not be afforded all the same platitudes as full ghosts. +This is a mind trait because ghosts can be frequently deleted and we want to be sure this sticks. |
| TRAIT_SHOW_WIRE_INFO | Show what machine/door wires do when held. |
| TRAIT_SUPERMATTER_IMMUNE | Immune to the SM / makes you immune to it when worn |
| TRAIT_WIELDED | An item that is being wielded. |
| TRAIT_OBSCURED_WIRES | Wires on this will have their titles randomized for those with SHOW_WIRES |
| TRAIT_FORCES_OPEN_DOORS_ITEM | Forces open doors after a delay specific to the item |
| TRAIT_NO_THROWN_MESSAGE | Makes the item no longer spit out a visible message when thrown |
| TRAIT_SILENT_INSERTION | Makes the item not display a message on storage insertion |
| TRAIT_SURGICAL | A surgical tool; when in hand in help intent (and with a surgery in progress) won't attack the user |
| TRAIT_ADVANCED_SURGICAL | An advanced surgical tool. If a surgical tool has this flag, it will be able to automatically repeat steps until they succeed. |
| TRAIT_TURF_COVERED | Prevent mobs on the turf from being affected by anything below that turf, such as a pulse demon going under it. Added by a /obj/structure with creates_cover set to TRUE |
| TRAIT_OIL_SLICKED | An item that is oiled. If sprayed with water, it's slowdown reverts to normal. |
| TRAIT_CAN_POINT_WITH | An item that can be pointed at mobs, while on non-help intent. |
| TRAIT_ORGAN_INSERTED_WHILE_DEAD | An organ that was inserted into a dead mob, that has not been revived yet |
| TRAIT_ADJACENCY_TRANSPARENT | An /obj that should not increase the "depth" of the search for adjacency, +e.g. a storage container or a modsuit. |
| TRAIT_CURRENTLY_Z_MOVING | A trait for determining if a atom/movable is currently crossing into another z-level by using of /turf/space z-level "destination-xyz" transfers |
| MENTOR_OBSERVING | Mentor observing |
| TRAIT_KNOCKEDOUT | Forces the user to stay unconscious. |
| TRAIT_IMMOBILIZED | Prevents voluntary movement. |
| TRAIT_FLOORED | Prevents voluntary standing or staying up on its own. |
| TRAIT_HANDS_BLOCKED | Prevents usage of manipulation appendages (picking, holding or using items, manipulating storage). |
| TRAIT_UI_BLOCKED | Inability to access UI hud elements. |
| TRAIT_CANNOT_PULL | Inability to pull things. |
| TRAIT_RESTRAINED | Abstract condition that prevents movement if being pulled and might be resisted against. Handcuffs and straight jackets, basically. |
| STATION_TRAIT_BANANIUM_SHIPMENTS | Traits given by station traits |
| TRAIT_BLUESPACE_SPEED | Removes slowdown while walking on these tiles. |
+ Adds a status trait to the target datum.
+Arguments: (All Required)
+
+ A simple helper for checking traits in a mob's mind
+ Mentor observing
+ Removes a status trait from a target datum.
+ROUNDSTART_TRAIT traits can't be removed without being specified in sources.
+Arguments:
+ Removes all status traits from a target datum which were added by sources.
Arguments:
+
+ Removes all status traits from a target datum which were NOT added by sources.
Arguments:
+
+ Traits given by station traits
+ An /obj that should not increase the "depth" of the search for adjacency, +e.g. a storage container or a modsuit.
+ An advanced surgical tool. If a surgical tool has this flag, it will be able to automatically repeat steps until they succeed.
+ Removes slowdown while walking on these tiles.
+ Inability to pull things.
+ An item that can be pointed at mobs, while on non-help intent.
+ A trait for determining if a atom/movable is currently crossing into another z-level by using of /turf/space z-level "destination-xyz" transfers
+ Allows a mob to dodge all thrown objects
+ Prevents voluntary standing or staying up on its own.
+ Forces open doors after a delay specific to the item
+ Prevents usage of manipulation appendages (picking, holding or using items, manipulating storage).
+ Prevents voluntary movement.
+ Forces the user to stay unconscious.
+ used for dead mobs that are observing, but should not be afforded all the same platitudes as full ghosts. +This is a mind trait because ghosts can be frequently deleted and we want to be sure this sticks.
+ Makes the item no longer spit out a visible message when thrown
+ Wires on this will have their titles randomized for those with SHOW_WIRES
+ An item that is oiled. If sprayed with water, it's slowdown reverts to normal.
+ An organ that was inserted into a dead mob, that has not been revived yet
+ Abstract condition that prevents movement if being pulled and might be resisted against. Handcuffs and straight jackets, basically.
+ Show what machine/door wires do when held.
+ Makes the item not display a message on storage insertion
+ Immune to the SM / makes you immune to it when worn
+ A surgical tool; when in hand in help intent (and with a surgery in progress) won't attack the user
+ Prevent mobs on the turf from being affected by anything below that turf, such as a pulse demon going under it. Added by a /obj/structure with creates_cover set to TRUE
+ Inability to access UI hud elements.
+ An item that is being wielded.
+ Gives a unique trait source for any given datum
| /proc/locateUID | +Locates a datum based off of the UID |
|---|---|
| /proc/is_type_in_UID_list | +If the list L contains a datum UID who's type matches D's type, returns the UID of that datum in the list. Otherwise returns null. |
| /proc/get_line | +Get a list of turfs in a line from starting_atom to ending_atom. |
|---|---|
| /proc/get_edge_target_turf | +Returns the turf located at the map edge in the specified direction relative to target_atom used for mass driver |
| /proc/get_ranged_target_turf | +|
| /proc/get_ranged_target_turf_direct | +Get ranged target turf, but with direct targets as opposed to directions |
| /datum/coords | Simple datum for storing coordinates. |
| /proc/get_living_players | +This proc returns every player with a client who is not a ghost or a new_player |
| /proc/get_atoms_of_type | +Returns a list of atoms in a location of a given type. Can be refined to look for pixel-shift. |
| /proc/parse_caught_click_modifiers | +Returns a turf based on text inputs, original turf and viewing client |
| /proc/get_channel_name | +Returns the clean name of an audio channel. |
| /proc/HTTPGet | +HTTP Get (Powered by RUSTG) |
| /proc/is_color_dark | +Given a color in the format of "#RRGGBB", will return if the color is dark. |
| /proc/type_list_to_counted_assoc_list | +This proc takes a list of types, and returns them in the format below. +[type] = amount of type in list. +Useful for recipes. |
| /proc/add_verb | +handles adding verbs and updating the stat panel browser |
|---|---|
| /proc/remove_verb | +handles removing verb and sending it to browser to update, use this for removing verbs |
| PROC_REF | Validates the proc exists on this type (or global unfortunately) |
|---|---|
| REGEX_REPLACE_HANDLER | Use this for every proc passed in as second argument in regex.Replace. regex.Replace does not allow calling procs by name but as of 515 using proc refs will always call the top level proc instead of overrides |
+ Validates the proc exists on this type (or global unfortunately)
+ Use this for every proc passed in as second argument in regex.Replace. regex.Replace does not allow calling procs by name but as of 515 using proc refs will always call the top level proc instead of overrides
| IS_MODE_COMPILED | All toggles for the GC ref finder |
|---|
+ All toggles for the GC ref finder
+End toggles for the GC ref finder
| /datum/bitfield | Specifies a bitfield for smarter debugging |
|---|
| /datum/middleClickOverride/callback_invoker | Middle click override which accepts a callback as an arugment in the New() proc.
+When the living mob that has this datum middle-clicks or alt-clicks on something, the callback will be invoked. |
|---|
| /atom/movable/screen/action_landing | Exists so you have a place to put your buttons when you move them around |
|---|
| /atom/movable/screen/alert/hunger/fat/machine | Machine "hunger" |
|---|---|
| /atom/movable/screen/alert/hunger/fat/vampire | Vampire "hunger" |
| /atom/movable/screen/alert/succumb | Gives the player the option to succumb while in critical condition |
| /atom/movable/screen/alert/augury/meteor | Meteor alert. +Appears during a meteor storm and allows for auto-following of debris. |
|---|
| /atom/movable/screen/fullscreen/stretch | Stretch version is suitable for images that stick to screen edges, as they scale with user screen size +For centrally located screen objects, use /atom/movable/screen/fullscreen/center |
|---|---|
| /atom/movable/screen/fullscreen/stretch/cursor_catcher | An effect which tracks the cursor's location on the screen |
| /atom/movable/screen/fullscreen/center | Centered fullscreen atoms +These are used to center a widescreen image so it scales properly across screen sizes, not suitable for screen images that eminate from the edge of the screen |
| /atom/movable/screen/map_view | A screen object, which acts as a container for turfs and other things +you want to show on the map, which you usually attach to "vis_contents". |
|---|---|
| /atom/movable/screen/background | A generic background object. +It is also implicitly used to allocate a rectangle on the map, which will +be used for auto-scaling the map. |
| /atom/movable/screen/plane_master/emissive | Things placed on this mask the lighting plane. Doesn't render directly. |
|---|
| /atom/movable/plane_master_controller | Atom that manages and controls multiple planes. It's an atom so we can hook into add_filter etc. Multiple controllers can control one plane. |
|---|
| /proc/radial_menu_helper | +Similar to show_radial_menu, but choices is a list of atoms, for which icons will be automatically generated. +Supports multiple items of the same name, 2 soaps will become soap (1) and soap (2) to the user. +Otherwise, has the exact same arguments as show_radial_menu |
|---|
| CONFIG_LOAD_BOOL | Wrapper to not overwrite a variable if a list key doesnt exist. Auto casts to bools. |
|---|---|
| CONFIG_LOAD_NUM | Wrapper to not overwrite a variable if a list key doesnt exist. Auto casts to number. |
| CONFIG_LOAD_NUM_MULT | Wrapper to not overwrite a variable if a list key doesnt exist. Auto casts to number, and accepts a macro argument for number maths (ds to min for example) |
| CONFIG_LOAD_STR | Wrapper to not overwrite a variable if a list key doesnt exist. Auto casts to string. |
| CONFIG_LOAD_RAW | Wrapper to not overwrite a variable if a list key doesnt exist. No casting done. |
| CONFIG_LOAD_LIST | Wrapper to not overwrite a variable if a list key doesnt exist. Ensures target is a list. |
+ Wrapper to not overwrite a variable if a list key doesnt exist. Auto casts to bools.
+ Wrapper to not overwrite a variable if a list key doesnt exist. Ensures target is a list.
+ Wrapper to not overwrite a variable if a list key doesnt exist. Auto casts to number.
+ Wrapper to not overwrite a variable if a list key doesnt exist. Auto casts to number, and accepts a macro argument for number maths (ds to min for example)
+ Wrapper to not overwrite a variable if a list key doesnt exist. No casting done.
+ Wrapper to not overwrite a variable if a list key doesnt exist. Auto casts to string.
| /datum/server_configuration | Represents a base configuration datum. Has everything else bundled into it |
|---|
| /datum/configuration_section/admin_configuration | Config holder for all admin related things |
|---|
| /datum/configuration_section/afk_configuration | Config holder for all AFK related things |
|---|
| /datum/configuration_section/custom_sprites_configuration | Config holder for all things regarding custom sprites |
|---|
| /datum/configuration_section/database_configuration | Config holder for all database related things |
|---|
| /datum/configuration_section/discord_configuration | Config holder for all things relating to discord webhooks |
|---|
| /datum/configuration_section/event_configuration | Config holder for all stuff relating to ingame random events |
|---|
| /datum/configuration_section/gamemode_configuration | Config holder for everything regarding gamemodes |
|---|
| /datum/configuration_section/general_configuration | Config holder for all general/misc things |
|---|
| /datum/configuration_section/ipintel_configuration | Config holder for all things relating to IPIntel |
|---|
| /datum/configuration_section/job_configuration | Config holder for all job related things |
|---|
| /datum/configuration_section/logging_configuration | Config holder for all things regarding logging |
|---|
| /datum/configuration_section/mc_configuration | Config holder for all things regarding the MC |
|---|
| /datum/configuration_section/metrics_configuration | Config holder for stuff relating to metrics management |
|---|
| /datum/configuration_section/movement_configuration | Config holder for values relating to mob movement speeds |
|---|
| /datum/configuration_section/overflow_configuration | Config holder for all overflow-server related things |
|---|
| /datum/configuration_section/redis_configuration | Config holder for all redis related things |
|---|
| /datum/configuration_section/ruin_configuration | Config holder for all things regarding space ruins and lavaland ruins |
|---|
| /datum/configuration_section/system_configuration | Config holder for stuff relating to server backend management and secrets |
|---|
| /datum/configuration_section/url_configuration | Config holder for all the server URLs |
|---|
| /datum/configuration_section/vote_configuration | Config holder for stuff relating to the ingame vote system |
|---|
| /var/Failsafe | +Failsafe |
|---|---|
| /datum/controller/failsafe | This thing pretty much just keeps poking the master controller |
| /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/delete_all_SS_and_recreate_master | +Delete all existing SS to basically start over |
| /var/Master | +StonedMC |
|---|
| /datum/controller/subsystem | Defines a subsystem to be managed by the Master Controller |
|---|
| /datum/resumable_cost_counter | A cost counter for resumable, repeating processes. |
|---|---|
| /datum/milla_safe | Create a subclass of this and implement on_run to manipulate tile air safely. |
| /var/SSambience | +The subsystem used to play ambience to users every now and then, makes them real excited. |
|---|
| /datum/feedback_variable | Datum to hold feedback data, which gets logged at round end |
|---|
| /var/SSchat | +Copyright (c) 2020 Aleksej Komarov +SPDX-License-Identifier: MIT |
|---|
| /var/SScleanup | +
|---|
| /datum/db_query | Datum based handler for all database queries |
|---|
| AUTO_CULL_TIME | Culling occurs when a client has not pressed a key in over 60 seconds. We stop processing their inputs until they press another key down. |
|---|
+ Culling occurs when a client has not pressed a key in over 60 seconds. We stop processing their inputs until they press another key down.
Copyright (c) 2022 Aleksej Komarov +SPDX-License-Identifier: MIT |
| /datum/object_window_info | Datum that holds and tracks info about a client's object window +Really only exists because I want to be able to do logic with signals +And need a safe place to do the registration |
|---|
| /var/SStgui | +tgui subsystem |
|---|
| BUCKET_LEN | Controls how many buckets should be kept, each representing a tick. (1 minutes worth) |
|---|---|
| BUCKET_POS | Helper for getting the correct bucket for a given timer |
| TIMER_MAX | Gets the maximum time at which timers will be invoked from buckets, used for deferring to secondary queue |
| TIMER_ID_MAX | Max float with integer precision |
| /var/SStimer | +|
| /datum/timedevent | This is the actual timer, it contains the callback and necessary data to maintain +the timer. |
| /proc/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. |
| /proc/deltimer | +Delete a timer |
+ Controls how many buckets should be kept, each representing a tick. (1 minutes worth)
+ Helper for getting the correct bucket for a given timer
+ Max float with integer precision
+ Gets the maximum time at which timers will be invoked from buckets, used for deferring to secondary queue
| /var/SSverb_manager | +SSverb_manager, a subsystem that runs every tick and runs through its entire queue without yielding like SSinput. +this exists because of how the byond tick works and where user inputted verbs are put within it. |
|---|---|
| /proc/_queue_verb | +queue a callback for the given verb/verblike proc and any given arguments to the specified verb subsystem, so that they process in the next tick. +intended to only work with verbs or verblike procs called directly from client input, use as part of TRY_QUEUE_VERB() and co. |
| /var/SSpersistent_data | +
|---|
| /datum/action/item_action/organ_action | prset for organ actions |
|---|
| /datum/ai_laws/asimov | Asimov |
|---|---|
| /datum/ai_laws/crewsimov | Crewsimov |
| /datum/ai_laws/quarantine | Quarantine. |
| /datum/ai_laws/nanotrasen | Nanotrasen/Malf |
| /datum/ai_laws/nanotrasen_aggressive | Nanotrasen Aggressive |
| /datum/ai_laws/robocop | Robocop |
| /datum/ai_laws/paladin | P.A.L.A.D.I.N. |
| /datum/ai_laws/corporate | Corporate |
| /datum/ai_laws/tyrant | T.Y.R.A.N.T. |
| /datum/ai_laws/antimov | Antimov |
| /datum/ai_laws/pranksimov | Pranksimov |
| /datum/ai_laws/cctv | CCTV |
| /datum/ai_laws/hippocratic | Hippocratic Oath |
| /datum/ai_laws/maintain | Station Efficiency |
| /datum/ai_laws/peacekeeper | Peacekeeper |
| /datum/ai_laws/deathsquad | Deathsquad |
| /datum/ai_laws/syndicate_override | Syndicate |
| /datum/ai_laws/ert_override | ERT |
| /datum/ai_laws/ninja_override | Ninja |
| /datum/ai_laws/drone | Drone |
| /datum/chat_payload | Stores information about a chat payload |
|---|
| CHAT_MESSAGE_SPAWN_TIME | How long the chat message's spawn-in animation will occur for |
|---|---|
| CHAT_MESSAGE_LIFESPAN | How long the chat message will exist prior to any exponential decay |
| CHAT_MESSAGE_EOL_FADE | How long the chat message's end of life fading animation will occur for |
| CHAT_MESSAGE_GRACE_PERIOD | Grace period for fade before we actually delete the chat message |
| CHAT_MESSAGE_EXP_DECAY | Factor of how much the message index (number of messages) will account to exponential decay |
| CHAT_MESSAGE_HEIGHT_DECAY | Factor of how much height will account to exponential decay |
| CHAT_MESSAGE_APPROX_LHEIGHT | Approximate height in pixels of an 'average' line, used for height decay |
| CHAT_MESSAGE_WIDTH | Max width of chat message in pixels |
| CHAT_MESSAGE_MAX_LENGTH | Max length of chat message in characters |
| CHAT_LAYER_Z_STEP | Maximum precision of float before rounding errors occur (in this context) |
| CHAT_LAYER_MAX_Z | The number of z-layer 'slices' usable by the chat message layering |
| WXH_TO_HEIGHT | Macro from Lummox used to get height from a MeasureText proc. +resolves the MeasureText() return value once, then resolves the height, then sets return_var to that. |
| /datum/chatmessage | Datum for generating a message overlay on the map |
+ The number of z-layer 'slices' usable by the chat message layering
+ Maximum precision of float before rounding errors occur (in this context)
+ Approximate height in pixels of an 'average' line, used for height decay
+ How long the chat message's end of life fading animation will occur for
+ Factor of how much the message index (number of messages) will account to exponential decay
+ Grace period for fade before we actually delete the chat message
+ Factor of how much height will account to exponential decay
+ How long the chat message will exist prior to any exponential decay
+ Max length of chat message in characters
+ How long the chat message's spawn-in animation will occur for
+ Max width of chat message in pixels
+ Macro from Lummox used to get height from a MeasureText proc. +resolves the MeasureText() return value once, then resolves the height, then sets return_var to that.
| /datum/click_intercept | Datum which is intended to be stored by a client's click_intercept variable.
+Used to override normal clicking behavior when clicking on an object.
+While active, a mob's ClickOn proc will redirect to the InterceptClickOn() proc instead. |
|---|
Loosely adapted from /vg/. This is an entity component system for adding behaviours to datums when inheritance doesn't quite cut it. By using signals and events instead of direct inheritance, you can inject behaviours without hacky overloads. It requires a different method of thinking, but is not hard to use correctly. If a behaviour can have application across more than one thing. Make it generic, make it a component. Atom/mob/obj event? Give it a signal, and forward it's arguments with a See this thread for an introduction to the system as a whole. + |
| /datum/component | The component datum |
|---|
| BOOMERANG_REBOUND_INTERVAL | The cooldown period between last_boomerang_throw and it's methods of implementing a rebound proc. |
|---|---|
| /datum/component/boomerang | If an object is given the boomerang component, it should be thrown back to the thrower after either hitting it's target, or landing on the thrown tile. +Thrown objects should be thrown back to the original thrower with this component, a number of tiles defined by boomerang_throw_range. |
+ The cooldown period between last_boomerang_throw and it's methods of implementing a rebound proc.
| /datum/component/boss_music | Attaches to a hostile simplemob and plays that music while they have a target. |
|---|
| /datum/component/codeword_hearing | Component that allows for highlighting of words or phrases in chat based on regular expressions. |
|---|
| /datum/component/connect_mob_behalf | This component behaves similar to connect_loc_behalf, but working off clients and mobs instead of loc +To be clear, we hook into a signal on a tracked client's mob +We retain the ability to react to that signal on a seperate listener, which makes this quite powerful |
|---|
| /datum/component/corpse_description | Mapping component which adds examine text to a corpse that is removed on revival (in case for some reason someone revives your space ruin mob) +For immersive environmental story telling |
|---|
| /datum/component/construct_held_body | A component for tracking and manipulating bodies held inside constructs/shades +Will drop the body/brain when the parent dies or is deleted. |
|---|
| /datum/component/deadchat_control | Deadchat Plays Things - The Componenting |
|---|
| /datum/component/defib | A component for an item that attempts to defibrillate a mob when activated. |
|---|
| /datum/component/footstep | Footstep component. Plays footsteps at parents location when it is appropriate. |
|---|
| /datum/component/label | The label component. |
|---|---|
| /datum/component/label/goal | A verson of the label component specific to labelling goal items. |
| /datum/component/largetransparency | Makes large icons partially see through if high priority atoms are behind them. |
|---|
| ORBIT_LOCK_IN | Code to handle atoms orbiting other atoms, following them as they move. +The basic logic is simple. We register a signal, COMSIG_MOVABLE_MOVED onto orbited atoms. +When the orbited atom moves, any ghosts orbiting them are moved to their turf. +We also register a MOVED signal onto the ghosts to cancel their orbit if they move themselves. +Complexities come in for items within other items (such as the NAD in a box in a backpack on an assistant pretending to be the captain), +as items in containers do not fire COMSIG_MOVABLE_MOVED when their container moves. |
|---|
+ Code to handle atoms orbiting other atoms, following them as they move. +The basic logic is simple. We register a signal, COMSIG_MOVABLE_MOVED onto orbited atoms. +When the orbited atom moves, any ghosts orbiting them are moved to their turf. +We also register a MOVED signal onto the ghosts to cancel their orbit if they move themselves. +Complexities come in for items within other items (such as the NAD in a box in a backpack on an assistant pretending to be the captain), +as items in containers do not fire COMSIG_MOVABLE_MOVED when their container moves.
+The signal logic for items in containers is as follows: +Assume 1 is some item (for example, the NAD) and 2 is a box. +When 1 is added to 2, we register the typical orbit COMSIG_MOVABLE_MOVED onto 2. +This in essence makes 2 the "leader", the atom that ghosts follow in movement. +As 2 is moved around (say, dragged on the floor) ghosts will follow it. +We also register a new intermediate COMSIG_MOVABLE_MOVED signal onto 1 that tracks if 1 is moved. +Remember, this will only fire if 1 is moved around containers, since it's impossible for it to actually move on its own. +If 1 is moved out of 2, this signal makes 1 the new leader. +Lastly, we add a COMSIG_ATOM_EXITED to 2, which tracks if 1 is removed from 2. +This EXITED signal cleans up any orbiting signals on and above 2. +If 2 is added to another item, (say a backpack, 3) +3 becomes the new leader +2 becomes an intermediate +1 is unchanged (but still carries the orbiter datum)
+You may be asking yourself: is this overengineered? +In part, yes. However, MOVED signals don't get fired for items in containers, so this is +really the next best way. +Also, is this really optimal? +As much as it can be, I believe. This signal-shuffling will not happen for any item that is just moving from turf to turf, +which should apply to 95% of cases (read: ghosts orbiting mobs).
| /datum/component/proximity_monitor | Attaching this component to an atom means that the atom will be able to detect mobs or objects moving within a specified radius of it. |
|---|---|
| /obj/effect/abstract/proximity_checker | Inteded for use with the proximity checker component /datum/component/proximity_monitor.
+Whenever a movable atom crosses this object, it calls HasProximity() on the object which is listening for proximity (hasprox_receiver). |
| /datum/component/scope | A component that allows players to use the item to zoom out. Mainly intended for firearms, but now works with other items too. |
|---|
| /datum/component/shielded | The shielded component causes the parent item to nullify a certain number of attacks against the wearer, see: shielded vests. |
|---|
| /datum/component/slippery | This is a component that can be applied to any movable atom (mob or obj). |
|---|
| /datum/element/squish | squish.dm |
|---|
| /datum/component/surgery_initiator | Allows an item to start (or prematurely stop) a surgical operation. |
|---|
| /datum/component/tilted | A component that should be attached to things that have been tilted over, and can be righted. +This can optionally block normal attack_hand interactions |
|---|
| /datum/component/two_handed | Two Handed Component |
|---|---|
| /obj/item/offhand | The offhand dummy item for two handed items |
| /datum/custom_user_item | Holder for CUIs |
|---|
| /datum/discord_webhook_payload | Holder datum for discord webhook POST send data |
|---|---|
| /datum/discord_embed | Holder datum for discord embeds |
| /datum/discord_embed_field | Holder datum for discord embed fields |
| /datum/symptom/dizzy | Not the egg |
|---|
| /datum/element | A holder for simple behaviour that can be attached to many different types |
|---|
| /datum/element/bombable_turf | Apply this to a turf (usually a wall) and it will be destroyed instantly by any explosion. +Most walls can already be destroyed by explosions so this is largely for usually indestructible ones. +For applying it in a map editor, use /obj/effect/mapping_helpers/bombable_wall |
|---|
| /datum/element/shatters_when_thrown | When attached to something, will make that thing shatter into shards on throw impact or z level falling |
|---|
| /datum/element/strippable | An element for atoms that, when dragged and dropped onto a mob, opens a strip panel. |
|---|---|
| /datum/strippable_item | A representation of an item that can be stripped down |
| /datum/strippable_item/mob_item_slot | A preset for equipping items onto mob slots |
| /proc/start_unequip_mob | +A utility function for /datum/strippable_items to start unequipping an item from a mob. |
| /proc/finish_unequip_mob | +A utility function for /datum/strippable_items to finish unequipping an item from a mob. |
| /datum/strip_menu | A representation of the stripping UI |
| /proc/create_strippable_list | +Creates an assoc list of keys to /datum/strippable_item |
| DEFAULT_MAX_STAT_ALLOWED | Sentinel for emote stats. +If this is set for max stat, then its value will be ignored. |
|---|---|
| /datum/emote | Most of the text that's not someone talking is based off of this. |
+ Sentinel for emote stats. +If this is set for max stat, then its value will be ignored.
| /datum/async_input | THIS WILL BE REMOVED IN THE FUTURE, I STRONGLY SUGGEST AGAINST USING THIS - GDN |
|---|
| /proc/do_teleport | +Will teleport the given atom to the given destination using the other parameters |
|---|
| /datum/http_request | Holder datum for ingame HTTP requests |
|---|---|
| /datum/http_response | Holder datum for HTTP responses |
| /datum/keybinding/mob/trigger_action_button | Don't add a name to this, shouldn't show up in the prefs menu |
|---|
| /datum/looping_sound/decreasing | Looping sounds that decrease volume by a specified % each loop until it reaches a specified total % volume. |
|---|
| /datum/looping_sound/kitchen/microwave | KITCHEN MACHINERY |
|---|
| /datum/movement_detector | A datum to handle the busywork of registering signals to handle in depth tracking of a movable |
|---|
| /datum/outfit/admin/modsuit/wizard | Technically not a MODsuit, we'll bundle it up in here for the future when it does become one |
|---|---|
| /datum/outfit/admin/tournament/tournament_gangster | gangster are supposed to fight each other. --rastaf0 |
| /datum/outfit/admin/tournament/tournament_chef | Steven Seagal FTW |
| /obj/item/encryptionkey/syndicate/all_channels | has to be a subtype and stuff |
|---|
| /datum/pathfinding_mover | A generalized datum for pathfinding, and moving to a target. |
|---|
| /datum/pipes/atmospheric/bent | Why is this not atmospheric/simple/bent you ask? Because otherwise the ordering of the pipes in the UI menu gets weird |
|---|---|
| /datum/pipes/transit | Pipe types for transit tubes. |
| /datum/position | For positions with map x/y/z and pixel x/y so you don't have to return lists. Could use addition/subtraction in the future I guess. |
|---|---|
| /datum/point_precise | A precise point on the map in absolute pixel locations based on world.icon_size. Pixels are FROM THE EDGE OF THE MAP! |
| /datum/point_precise/vector/processed | pixel_speed is per decisecond. |
| /datum/code_revision | Code Revision Datum |
|---|
| /datum/spell_handler | The base class for the handler systems spells use. +Subtypes of this class can be added to spells to modify their behaviour and change their can_cast. +Thus allowing for a more modular behaviour system. For example a vampire spell that jaunts can just add the vampire spell_handler to the jaunt spell |
|---|
| /datum/spell_targeting/alive_mob_list | Will find targets in the GLOB.alive_mob_list. The result will be in a random order |
|---|
| /datum/spell_targeting/aoe | An area of effect based spell targeting system. Will return all targets in the given range |
|---|
| /datum/spell_targeting/click | A click based spell targeting system. The clicked atom will be used to determine who/what to target |
|---|
| /datum/spell_targeting/clicked_atom | A simple spell targeting system. Will return the clicked atom as a target. Only works for 1 target max and is basically a dumbed down /datum/spell_targeting/click |
|---|
| /datum/spell_targeting/matter_eater | A spell targeting system especially made for the matter eater gene |
|---|
| /datum/spell_targeting/reachable_turfs | A spell targeting system which will return nearby turfs which are reachable from the users location. Will pad the targets with the user's location if needed |
|---|
| /datum/spell_targeting/remoteview | A spell targeting system which will return one user picked target from all alive mobs who have the remoteview block but do not have the psyresist block active. |
|---|
| /datum/spell_targeting/self | A spell targeting system which will return the caster as target |
|---|
| /datum/spell_targeting | The base class for the targeting systems spells use. |
|---|
| /datum/spell_targeting/spiral | Gets a list of turfs around the center atom to scramble. |
|---|
| /datum/spell_targeting/targeted | A spell targeting system which is able to select 1 to many targets in range/view of the caster. Has a random mode, distance from user based mode or a user input mode. |
|---|
| /datum/spell_targeting/telepathic | A spell targeting system which will allow the user to select a target from nearby living mobs. The name will be "Unknown entity" if the user can not see them |
|---|
| /datum/spell/alien_spell/regurgitate | First we check if there is a living queen |
|---|
| /obj/effect/dummy/slaughter | Can't use the wizard one, blocked by jaunt/slow |
|---|
| /datum/spell/charge_up | A click-based spell template which starts charging up once you click the action button/verb. Click again on something to activate the actual spell |
|---|
| /datum/spell/charge_up/bounce | A spell template that adds bounces to the charge_up spell template. The spell will bounce between targets once released. +Don't override cast and instead override apply_bounce_effect and the other procs |
|---|
| /datum/spell/aoe/conjure/construct/lesser | Construct Spells |
|---|
| /datum/station_trait | Base class of station traits. These are used to influence rounds in one way or the other by influencing the levers of the station. |
|---|
| /datum/station_trait/cybernetic_revolution | NOTE: THIS MAKES EMP MUCH MORE EXPENSIVE. |
|---|
| /datum/status_effect/his_wrath | does minor damage over time unless holding His Grace |
|---|---|
| /datum/status_effect/cultghost | is a cult ghost and can't use manifest runes, can see ghosts and dies if too far from summoner |
| /datum/status_effect/transient/confusion | Prevents moving straight, sometimes changing movement direction at random. +Decays at a rate of 1 per second. |
| /datum/status_effect/transient/dizziness | Slightly offsets the client's screen randomly every tick. +Decays at a rate of 1 per second, or 5 when resting. |
| /datum/status_effect/transient/drowsiness | Slows down and causes eye blur, with a 5% chance of falling asleep for a short time. +Decays at a rate of 1 per second, or 5 when resting. |
| /datum/status_effect/transient/drunkenness | Causes a myriad of status effects and other afflictions the stronger it is. +Decays at a rate of 1 per second if no alcohol remains inside. |
| /datum/status_effect/transient/silence/absolute | this one will mute all emote sounds including gasps |
| HALLUCINATE_COOLDOWN_FACTOR | This is multiplied with [/mob/var/hallucination] to determine the final cooldown. A higher hallucination value means shorter cooldown. |
| HALLUCINATE_CHANCE | Percentage defining the chance at which an hallucination may spawn past the cooldown. |
| /datum/status_effect/cursed | Status effect that gives the target miscellanous debuffs while throwing a status alert and causing them to smoke from the damage they're incurring. +Purposebuilt for cursed slot machines. |
+ Percentage defining the chance at which an hallucination may spawn past the cooldown.
+ This is multiplied with [/mob/var/hallucination] to determine the final cooldown. A higher hallucination value means shorter cooldown.
| /datum/status_effect/crusher_damage | tracks the damage dealt to this mob by kinetic crushers |
|---|---|
| /datum/status_effect/limited_bonus | A status effect that can have a certain amount of "bonus" duration added, which extends the duration every tick, +although there is a maximum amount of bonus time that can be active at any given time. |
| /datum/status_effect/grouped | Status effect from multiple sources, when all sources are removed, so is the effect +Adds itself to sources and destroys itself if one exists already, there are never multiple |
|---|---|
| /datum/status_effect/transient | A status effect that works off a (possibly decimal) counter before expiring, rather than a specified world.time. +This allows for a more precise tweaking of status durations at runtime (e.g. paralysis). |
| /datum/uplink_item/special | This uplink catagory is for uplink items avalible by special circumstances. Think station traits, or if some event rolling in a round gave traitors special items, or an objective. |
|---|
| /datum/uplink_item/stealthy_weapons/combat_minus | Nukies get combat gloves plus instead |
|---|---|
| /datum/uplink_item/device_tools/thermal_drill | Nukies get Diamond Tipped Thermal Safe Drill instead |
| /datum/uplink_item/bio_chips/uplink | Nukies get Nuclear Uplink Bio-chip instead |
| /datum/callback/verb_callback | like normal callbacks but they also record their creation time for measurement purposes |
|---|
| /area/mine | Mine areas |
|---|---|
| /area/mine/outpost | Outpost areas |
| /area/lavaland/surface/outdoors/outpost/catwalk | subtype of /surface so storms hit there |
| /area/mine/outpost/engineering | basically engi and atmos combined. I'm keeping it as "engineering" code wise, but "Life Support" sounds cooler in-game |
| /area/lavaland | Lavaland Areas |
| /area/lavaland/surface/outdoors/unexplored | monsters and ruins spawn here |
| /area/lavaland/surface/outdoors/unexplored/danger | megafauna will also spawn here |
| /area/awaycontent | AWAY AREAS |
|---|
| /area/start | will be unused once kurper gets his login interface patch done |
|---|
| /area/station/maintenance/assembly_line | Derelict Assembly Line |
|---|
| /proc/RoundDiagBar | +Diagnostic HUDs! |
|---|
| /obj/machinery/dna_scannernew | DNA MACHINES |
|---|
| /datum/mutation/grant_spell/morph | Vanilla Morph |
|---|
| /datum/action/innate/cult/blood_magic | Blood magic handles the creation of blood spells (formerly talismans) |
|---|---|
| /datum/action/innate/cult/blood_spell | The next generation of talismans, handles storage/creation of blood magic |
| /obj/item/restraints/handcuffs/energy/cult | For the shackling spell |
| /datum/objective/servecult | Given to cultists on conversion/roundstart |
|---|
| CULT_STRUCTURE_COOLDOWN | The amount of time necessary for a structure to be able to produce items after being built |
|---|
+ The amount of time necessary for a structure to be able to produce items after being built
| /obj/effect/rune/blood_boil | When invoked deals up to 30 burn damage to nearby non-cultists and sets them on fire. |
|---|
| /obj/item/clothing/head/helmet/abductor | AGENT GEAR |
|---|---|
| /obj/item/abductor/gizmo | SCIENTIST GEAR |
| /obj/item/screwdriver/abductor | ENGINEERING TOOLS |
| /obj/item/scalpel/alien | MEDICAL TOOLS |
| /obj/item/mop/advanced/abductor | JANITORIAL TOOLS |
| /obj/structure/bed/abductor | STRUCTURES |
| /obj/item/organ/internal/heart/gland/emp | TODO : Replace with something more interesting |
|---|
| /mob/living/simple_animal/demon/slaughter | The Monster |
|---|---|
| /mob/living/simple_animal/demon/slaughter/cult | Summoned as part of the cult objective "Bring the Slaughter" |
| /datum/action/innate/demon/whisper | The Powers |
| /obj/item/organ/internal/heart/demon | The Loot |
| /obj/item/guardiancreator | Creation |
|---|
| /datum/action/guardian | These are used by guardian hosts to interact with their guardians. These are not buttons that guardians themselves use. |
|---|---|
| /datum/action/guardian/communicate | Allows the guardian host to communicate with their guardian. |
| /datum/action/guardian/recall | Allows the guardian host to recall their guardian. |
| /datum/action/guardian/reset_guardian | Allows the guardian host to exchange their guardian's player for another. |
| /datum/spell/aoe/revenant/haunt_object | Makes objects be haunted and then throws them at conscious people to do damage, spooky! |
|---|---|
| /datum/spell/aoe/revenant/hallucinations | Gives everyone in a 7 tile radius 2 minutes of hallucinations |
| /obj/machinery/nuclearbomb/training | MARK: TRAINING NUKE |
|---|
| /datum/objective/debrain | I want braaaainssss |
|---|---|
| /datum/objective/protect | The opposite of killing a dude. |
| /datum/objective/protect/mindslave | subytpe for mindslave implants |
| /datum/objective_holder | An objective holder for minds, antag datums, and teams. |
|---|
| /datum/theft_objective | . |
|---|
| /obj/item/contract | Apprentice Contract |
|---|---|
| /obj/item/veilrender | Veil Render |
| /obj/item/scrying | Scrying |
| /obj/item/multisword/pike | If We are to be used and spent, let it be for a noble purpose. |
| /obj/item/necromantic_stone | Necromantic Stone |
| /datum/tarot/the_stars | I'm sorry matt, this is very funny. |
|---|---|
| /datum/tarot/reversed/the_fool | REVERSED ARCANA |
| /obj/structure/constructshell | Transferring to constructs |
|---|
| /obj/machinery/bluespace_beacon/syndicate/infiltrator | beacon guaranteed offline at roundstart for infiltrator base |
|---|
| /obj/machinery/camera/portable | Cameras which are placed inside of things, such as helmets. |
|---|
| VALID_REAGENTS | Reagents that can be inserted into the cloning pod (and not deleted by it). |
|---|---|
| VALID_BIOMASSABLES | Meats that can be used as biomass for the cloner. |
| FORBIDDEN_INTERNAL_ORGANS | Internal organs the cloner will never accept for insertion. |
| UPGRADE_LOCKED_ORGANS | Internal organs the cloner will only accept when fully upgraded. |
| FORBIDDEN_LIMBS | Limbs that the cloner won't accept. |
| ALLOWED_ROBOT_PARTS | A list of robot parts for use later, so that you can put them straight into the cloner from the exosuit fabricator. |
+ A list of robot parts for use later, so that you can put them straight into the cloner from the exosuit fabricator.
+ Internal organs the cloner will never accept for insertion.
+ Limbs that the cloner won't accept.
+ Internal organs the cloner will only accept when fully upgraded.
+ Meats that can be used as biomass for the cloner.
+ Reagents that can be inserted into the cloning pod (and not deleted by it).
| /datum/cloning_data | A datum to store the information gained by scanning a patient OR the fixes to be made to their body. |
|---|
| /obj/machinery/computer/med_data | TODO:SANITY |
|---|
| /obj/machinery/computer/monitor/secret | Hides the power monitor (such as ones on ruins & CentCom) from PDA's to prevent metagaming. |
|---|
| /obj/machinery/constructable_frame | Made into a seperate type to make future revisions easier. |
|---|
| /obj/structure/barricade/wooden | BARRICADE TYPES |
|---|
| /obj/machinery/flasher/portable | Portable version of the flasher. Only flashes when anchored |
|---|
| /obj/machinery/hologram/holopad | A stationary holopad for projecting hologram and making and receiving holocalls. |
|---|
| /obj/machinery/mass_driver_frame | MASS DRIVER FRAME |
|---|
| RC_ASSIST | Requests Console |
|---|
+ Requests Console
+Originally written by errorage, updated by: Carn, needs more work though. I just added some security fixes
| MAX_STORED_POWER | FIELD GEN START //shameless copypasta from fieldgen, powersink, and grille |
|---|---|
| /obj/machinery/shieldwall | Containment Field START |
+ FIELD GEN START //shameless copypasta from fieldgen, powersink, and grille
| /obj/machinery/syndicatebomb/training | Bomb Subtypes |
|---|---|
| /obj/item/bombcore | Bomb Cores |
| /obj/item/bombcore/training | Bomb Core Subtypes |
| /obj/item/syndicatedetonator | Syndicate Detonator (aka the big red button) |
| /obj/machinery/tcomms/relay | Extends the reach of telecomms to the z-level it is built on |
|---|
| /obj/machinery/tcomms | This is the base machine for both tcomms devices (core + relay) |
|---|---|
| /datum/tcomms_message | Datum which holds all the data for a message being sent |
| /proc/is_bad_connection | +Connection checker |
| /proc/broadcast_message | +Message Broadcast Proc |
| /obj/item/paper/tcommskey | Piece of paper that spawns with the default link password |
| /obj/machinery/tcomms/core | The core of the entire telecomms operation |
|---|
| /obj/machinery/economy/vending/wallmed/syndicate | Syndicate/Contraband Vendors |
|---|
| /obj/machinery/economy/vending/artvend | General miscellanious vendors |
|---|---|
| /obj/machinery/economy/vending/tool/free | we want a free version for engineering to use |
| /obj/machinery/economy/vending/cigarette/beach | Used in the lavaland_biodome_beach.dmm ruin |
| /datum/tilt_crit | Framework for custom vendor crits. |
|---|
| /datum/data/vending_product | Datum used to hold information about a product in a vending machine |
|---|
| /obj/machinery/holosign | HOLOSIGN |
|---|---|
| /obj/machinery/holosign_switch | SWITCH |
| /obj/item/mecha_parts/mecha_equipment/teleporter | TELEPORTER |
|---|---|
| /obj/item/mecha_parts/mecha_equipment/gravcatapult | GRAVITATIONAL CATAPULT |
| /obj/item/mecha_parts/mecha_equipment/anticcw_armor_booster | ///////////////////////// ARMOR BOOSTER MODULES ////////////////////////////////////////////////////////// +what is that noise? A BAWWW from TK mutants. |
| /obj/item/mecha_parts/mecha_equipment/repair_droid | REPAIR DROID |
| /obj/item/mecha_parts/mecha_equipment/tesla_energy_relay | TESLA ENERGY RELAY |
| /obj/item/mecha_parts/mecha_equipment/generator | GENERATOR |
| /obj/item/mecha_parts/mecha_equipment/weapon/ballistic | else the mousetraps are useless |
|---|
| /obj/machinery/mecha_part_fabricator | A machine that allows for the production of exosuits and robotic parts. |
|---|---|
| /obj/machinery/mecha_part_fabricator/robot | Cyborgs-only variant of /obj/machinery/mecha_part_fabricator. |
| /obj/item/mecha_parts | Mecha Parts |
|---|---|
| /obj/item/mecha_parts/chassis/ripley | Ripley |
| /obj/item/mecha_parts/chassis/gygax | Gygax |
| /obj/item/mecha_parts/chassis/durand | Durand |
| /obj/item/mecha_parts/chassis/firefighter | Firefighter |
| /obj/item/mecha_parts/chassis/honker | HONK |
| /obj/item/mecha_parts/chassis/reticence | Reticence |
| /obj/item/mecha_parts/chassis/phazon | Phazon |
| /obj/item/mecha_parts/chassis/odysseus | Odysseus |
| /obj/item/circuitboard/mecha | Circuitboards |
| /obj/structure/mecha_wreckage | Mecha wreckage |
|---|
| /obj/item/paintkit | Please don't use this for anything, it's a base type for custom mech paintjobs. |
|---|
| ANOMALY_MOVECHANCE | Chance of taking a step per second |
|---|
+ Chance of taking a step per second
| /obj/effect/decal/cleanable/blood/slime | this is the alien blood file, slimes are aliens. |
|---|
| /obj/effect/decal/cleanable/trail_holder | not a child of blood on purpose |
|---|---|
| /obj/effect/decal/cleanable/blood/gibs/cleangibs | most ironic name ever... |
| /obj/effect/decal/cleanable/pie_smudge | honk |
|---|---|
| /obj/effect/decal/cleanable/confetti | PARTY TIME! |
| /obj/structure/sign/poster/ripped | POSTER VARIATIONS |
|---|
| /obj/effect/particle_effect/ion_trails | Ion trails for jetpacks, ion thrusters and other space-flying things |
|---|
| /obj/effect/particle_effect/smoke | SMOKE SYSTEMS |
|---|
| /obj/effect/particle_effect/sparks/sparkles | SPARKLE FIREWORKS |
|---|
| /obj/effect/abstract | This is an object that is intended to able to be placed, but that is completely invisible. +The object should be immune to all forms of damage, or things that can delete it, such as the singularity, or explosions. |
|---|---|
| /obj/effect/abstract/particle_holder | These effects can be added to anything to hold particles, which is useful because Byond only allows a single particle per atom |
| /obj/structure/forcefield | Mimewalls |
|---|
| /obj/effect/landmark/newplayer_start | There should only be one of these, in the lobby art area |
|---|---|
| /obj/effect/landmark/mob_spawner | Mob spawners, spawns a mob and deletes the landmark |
| /obj/effect/landmark/mob_spawner/goldgrub | 75% chance to get a magmawing watcher, and 25% chance to get a icewing watcher (1/133, 1/400 respectively) |
| /obj/effect/spawner/airlock/long | Long and thin |
|---|---|
| /obj/effect/spawner/airlock/long/square | Square |
| /obj/effect/spawner/grouped_spawner | Can be used to group spawners together so you ensure a certain amount of things are spawned but can be spawned on multiple locations. |
|---|
| /obj/effect/spawner/lootdrop/crate_spawner | for ruins |
|---|
| /obj/effect/spawner/random_barrier/possibly_welded_airlock | these have no access restrictions, so for internal maintenance only |
|---|
| /obj/effect/temp_visual/heal | color is white by default, set to whatever is needed |
|---|---|
| /obj/effect/temp_visual/single_user | A visual effect that will be shown only to a particular user for a period of time. |
| /proc/empulse | +Will cause an EMP on the given epicenter. +This proc can sleep depending on the affected objects. So assume it sleeps! |
|---|
| /proc/create_shrapnel | +Creates an explosion of shrapnel at a turf. |
|---|
| /obj/item/cardboard_cutout/adaptive | Purchased by Syndicate agents, these cutouts are indistinguishable from normal cutouts but aren't discolored when their appearance is changed |
|---|
| JANGLE_COOLDOWN | How long before you can "jangle" your keyring again (to prevent spam) |
|---|
+ How long before you can "jangle" your keyring again (to prevent spam)
| /obj/item/flash/synthetic | just a regular flash now |
|---|
| /obj/item/flashlight/spotlight | invisible lighting source |
|---|
| /obj/item/geiger_counter | DISCLAIMER: I know nothing about how real-life Geiger counters work. This will not be realistic. ~Xhuis |
|---|
| /datum/painter | Contains variables for updating holder, as well as procs for choosing a colour and painting an atom. |
|---|
| /datum/painter/pipe/window | Yes, this is a pipe painter subtype. |
|---|
| /obj/item/beacon/bacon | Probably a better way of doing this, I'm lazy. |
|---|
| /obj/item/encryptionkey/heads/ai_integrated | ported from bay, this goes 'inside' the AI. |
|---|
| /obj/item/radio/headset/syndicate/alt | undisguised bowman with flash protection |
|---|---|
| /obj/item/radio/headset/heads/ai_integrated | No need to care about icons, it should be hidden inside the AI anyway. |
| /obj/item/radio/borg | Exists so that borg radios and headsets can override it. |
|---|
| /obj/item/t_scanner | T-RAY SCANNER |
|---|---|
| /proc/get_chemscan_results | +HEALTH ANALYZER |
| /obj/item/robotanalyzer | MACHINE ANALYZER |
| /obj/item/analyzer | GAS ANALYZER |
| /proc/atmos_scan | +Outputs a message to the user describing the target's gasmixes. +Used in chat-based gas scans. |
| /obj/item/reagent_scanner | REAGENT SCANNERS |
| /obj/item/slime_scanner | SLIME SCANNER |
| /obj/item/bodyanalyzer | BODY ANALYZERS |
| /obj/item/book/granter | Books that teach things. |
|---|
| /obj/item/mounted/frame/alarm_frame | Handheld air alarm frame, for placing on walls. |
|---|
| /obj/item/malf_upgrade | AI Upgrades |
|---|
| /obj/item/gripper/universal | Universal gripper. Not supplied to any cyborg by default. Could be varedited onto a borg for event stuff. Functions almost like a real hand! |
|---|
| /obj/item/borg | Cyborg Spec Items |
|---|
| /obj/item/salvage/ruin | Ruin Salvage, misc loot gained from looking around ruins. |
|---|---|
| /obj/item/salvage/loot | Loot salvage, gained from fighting space simplemobs. |
| /obj/item/stack/sheet/fur | basic fur sheets |
|---|
| /obj/item/stack/sheet/cardboard | BubbleWrap |
|---|
| /obj/item/nuke_core/plutonium | The steal objective, so it doesnt mess with the SM sliver on pinpointers and objectives |
|---|
| /obj/item/multitool | Multitool -- A multitool is used for hacking electronic devices. |
|---|
| /obj/item/aiModule/safeguard | Safeguard |
|---|---|
| /obj/item/aiModule/oneCrewMember | oneCrewMember |
| /obj/item/aiModule/protectStation | ProtectStation |
| /obj/item/aiModule/oxygen | OxygenIsToxicToCrew |
| /obj/item/aiModule/freeform | New Freeform +Slightly more dynamic freeform module -- TLE |
| /obj/item/aiModule/reset | Reset |
| /obj/item/aiModule/purge | Purge +-- TLE |
| /obj/item/aiModule/asimov | Asimov +-- TLE |
| /obj/item/aiModule/crewsimov | Crewsimov +-- TLE |
| /obj/item/aiModule/quarantine | Quarantine |
| /obj/item/aiModule/nanotrasen | Nanotrasen +-- TLE |
| /obj/item/aiModule/corp | Corporate |
| /obj/item/aiModule/drone | Drone |
| /obj/item/aiModule/robocop | Robocop +-- TLE |
| /obj/item/aiModule/paladin | P.A.L.A.D.I.N. +-- NEO |
| /obj/item/aiModule/tyrant | T.Y.R.A.N.T. +-- Darem |
| /obj/item/aiModule/antimov | Antimov +-- TLE |
| /obj/item/aiModule/pranksimov | Pranksimov |
| /obj/item/aiModule/nanotrasen_aggressive | NT Aggressive |
| /obj/item/aiModule/cctv | CCTV |
| /obj/item/aiModule/hippocratic | Hippocratic Oath |
| /obj/item/aiModule/maintain | Station Efficiency |
| /obj/item/aiModule/peacekeeper | Peacekeeper |
| /obj/item/aiModule/freeformcore | Freeform Core +Slightly more dynamic freeform module -- TLE |
| /obj/item/aiModule/syndicate | Hacked AI Module +Slightly more dynamic freeform module -- TLE |
| /obj/item/aiModule/toyAI | Ion Module +-- Incoming //No actual reason to inherit from ion boards here, either. sigh ~Miauw |
| /datum/rcd_act | A generic action for an RCD. |
|---|
| /obj/item/melee/classic_baton | Knocks down the hit mob when not on harm intent and when /obj/item/melee/classic_baton/on is TRUE |
|---|---|
| /obj/item/melee/classic_baton/ntcane | |
| /obj/item/melee/classic_baton/telescopic |
| /obj/item/bio_chip | Code for implants that can be inserted into a person and have some sort of passive or triggered action. |
|---|
| /datum/implant_fluff | Bio-chip fluff is just lore about the bio-chip that is accessed through the implantpad, you must attach +one of these datums to the implant_data var on a bio-chip for it to show it up. |
|---|
| /obj/item/bio_chip/gorilla_rampage | Dumb path but easier to search for admins |
|---|
| /obj/item/bio_chip/stealth | Implant which allows you to summon an MGS-style cardboard box that turns you invisble after a short delay. |
|---|
| /obj/item/storage/bag/dice | Thankfully no longer a pill bottle. |
|---|---|
| /obj/item/dice | depreciated d6, use /obj/item/dice/d6 if you actually want a d6 |
| /obj/item/grenade/plastic/c4 | The Explosives |
|---|
| /obj/item/garrote | 12TC traitor item |
|---|---|
| /obj/item/garrote/improvised | Made via tablecrafting |
| /obj/item/grenade/chem_grenade/cryo | Intended for rare cryogenic mixes. Cools the area moderately upon detonation. |
|---|---|
| /obj/item/grenade/chem_grenade/pyro | Intended for pyrotechnical mixes. Produces a small fire upon detonation, igniting potentially flammable mixtures. |
| /obj/item/grenade/chem_grenade/adv_release | Intended for weaker, but longer lasting effects. Could have some interesting uses. |
| /obj/item/grenade/clusterbuster/mega_bang | Clusterbuster of Clusterbusters |
|---|
| /proc/bang | +Creates a flashing effect that blinds and deafens mobs within range |
|---|
| /obj/item/projectile/bullet/shrapnel | Shrapnel that flies through the air and hits you |
|---|---|
| /obj/item/shrapnel | Shrapnel projectiles turn into this after trying to embed |
| /obj/item/grenade/smokebomb | We need to clear the walk_to on destroy to allow a grenade which uses walk_to or related to properly GC |
|---|
| /obj/item/nullrod/fluff | fluff subtype to be used for all donator nullrods |
|---|---|
| /obj/item/nullrod/ert | ERT subtype, applies sanctified property to any derived rod |
| /obj/item/nullrod/claymore/bostaff | May as well make it a "claymore" and inherit the blocking |
| /obj/item/kitchen/cutter | circular cutter by Ume |
|---|
| /obj/item/restraints/legcuffs/bola/tactical | traitor variant |
|---|---|
| /obj/item/restraints/legcuffs/bola/energy | For Security |
| /obj/item/book/manual | These are "programmatic books," that is books that are hard-coded into the game. Just for the sake of maintainability, keep +information subject to change (as in likely to change SOON) out of the non-wiki manuals as they require PRs to change +and it is not an author's responsbility to update manuals if they change a mechanic/recipe/feature referenced in one of them +Don't worry about adding them to the library, as long as they're one of these types it is automatically added. |
|---|---|
| /obj/item/book/manual/wiki | These are programmatic books that source its pages / "content" straight from the wiki +That means that this content can ONLY be changed by editing the wiki +Space Law and SOP Manuals can only be edited by Wiki Admins |
| /obj/item/melee/energy/sword/cyborg/saw | Used by medical Syndicate cyborgs |
|---|
| /obj/item/pneumatic_cannon/ghetto | Obtainable by improvised methods; more gas per use, less capacity, but smaller |
|---|
| /obj/item/storage/part_replacer | Stock Parts |
|---|
| /obj/item/storage/backpack/duffel/syndie/med/surgery_fake | for maint spawns |
|---|
| /obj/item/storage/bag/ore/holding | miners, your messiah has arrived |
|---|
| /obj/item/storage/belt/utility/syndi_researcher | A cool looking belt thats essentially a syndicate toolbox |
|---|---|
| /obj/item/storage/belt/grenade/tactical | Traitor bundle version |
| /obj/item/storage/box/stockparts/basic | for ruins where it's a bad idea to give access to an autolathe/protolathe, but still want to make stock parts accessible |
|---|
| /obj/item/storage/firstaid/aquatic_kit | Aquatic Starter Kit |
|---|
| /obj/item/storage/box/syndie_kit/bundle | Traitor bundles |
|---|---|
| /obj/item/storage/box/syndie_kit/bundle/spy | 172TC |
| /obj/item/storage/box/syndie_kit/bundle/agent13 | 159 |
| /obj/item/storage/box/syndie_kit/bundle/thief | 160TC |
| /obj/item/storage/box/syndie_kit/bundle/bond | 137TC |
| /obj/item/storage/box/syndie_kit/bundle/infiltrator | 155TC + RCD & Mesons Autoimplanter |
| /obj/item/storage/box/syndie_kit/bundle/payday | 185TC |
| /obj/item/storage/box/syndie_kit/bundle/implant | 200TC |
| /obj/item/storage/box/syndie_kit/bundle/hacker | 180TC |
| /obj/item/storage/box/syndie_kit/bundle/darklord | 170TC + Telekinesis |
| /obj/item/storage/box/syndie_kit/bundle/professional | 164TC |
| /obj/item/storage/box/syndie_kit/bundle/grenadier | 133TC + Tactical Grenadier Belt |
| /obj/item/storage/box/syndie_kit/bundle/metroid | 75TC + modules + laser gun |
| /obj/item/storage/box/syndie_kit/bundle/maint_loot | syndie briefcase has 600 credits for 5 TC. |
| /obj/item/melee/baton/infinite_cell | baton used for security bots |
|---|
| /obj/item/fireaxe | DEM AXES MAN, marker -Agouri |
|---|---|
| /obj/item/fireaxe/boneaxe | Blatant imitation of the fireaxe, but made out of bone. |
| /obj/item/spear/bonespear | Blatant imitation of spear, but made out of bone. Not valid for explosive modification. |
| /obj/item/butcher_chainsaw | CHAINSAW |
| BROOM_PUSH_LIMIT | Max number of atoms a broom can sweep at once |
| /obj/item/supermatter_halberd | Supermatter Halberd, used by Oblivion Enforcers |
+ Max number of atoms a broom can sweep at once
| /obj/item/banhammer |
|---|
| BURST | Used in the /status var |
|---|---|
| MIN_GROWTH_TIME | time it takes to grow a hugger |
+ Used in the /status var
+ time it takes to grow a hugger
| /obj/structure/closet/secure_closet/quartermaster/lavaland | used in mining outpost |
|---|
| /obj/structure/closet/statue | this type path is a crime, ponies what the fuck |
|---|
| /obj/structure/disaster_counter | Tracks how many shifts it has been since the counter with that ID was exploded. |
|---|
| /obj/structure/fluff/empty_terrarium | Empty terrariums are created when a preserved terrarium in a lavaland seed vault is activated. |
|---|---|
| /obj/structure/fluff/empty_sleeper | Empty sleepers are created by a good few ghost roles in lavaland. |
| /obj/structure/fluff/empty_cryostasis_sleeper | Empty cryostasis sleepers are created when a malfunctioning cryostasis sleeper in a lavaland shelter is activated |
| /obj/structure/fluff/drake_statue | Ash drake status spawn on either side of the necropolis gate in lavaland. |
| /obj/structure/fluff/drake_statue/falling | A variety of statue in disrepair; parts are broken off and a gemstone is missing |
| /obj/structure/grille/broken | Pre-broken grilles for map placement |
|---|
| /obj/structure/inflatable/door | Based on mineral door code |
|---|
| /obj/structure/kitchenspike_frame | Kitchen Spike |
|---|
| /obj/structure/loom | This is a loom. It's usually made out of wood and used to weave fabric like durathread or cotton into their respective cloth types. |
|---|
| /obj/structure/plasticflaps/mining | A specific type for mining that doesn't allow airflow because of them damn crates |
|---|
| /obj/structure/railing/corner | aesthetic corner sharp edges hurt oof ouch |
|---|---|
| /obj/structure/railing/cap | aestetic "end" for railing |
| /obj/structure/safe | A locked container that can only be opened by entering a combination through a dial. |
|---|---|
| /obj/structure/safe/floor | Like a safe, but without density. Can be hidden with flooring. |
| /obj/item/safe_internals | Can be used to replace a safe's broken mechanism. |
| /obj/item/paper/safe_code | Contains the (generated on map load) codes for all publicly known safes. |
| /obj/structure/statue/sandstone/venus | call me when we add marble i guess |
|---|
| /obj/structure/chair | fuck you Pete |
|---|
| /obj/structure/table/wood/poker | No specialties, Just a mapping object. |
|---|
| /obj/structure/sink/puddle | splishy splashy ^_^ |
|---|
| /sound | Default override for echo |
|---|---|
playsound +playsound is a proc used to play a 3D sound in a specific range. This uses SOUND_RANGE + extra_range to determine that. +source - Origin of sound +soundin - Either a file, or a string that can be used to get an SFX +vol - The volume of the sound, excluding falloff and pressure affection. +vary - bool that determines if the sound changes pitch every time it plays +extrarange - modifier for sound range. This gets added on top of SOUND_RANGE +falloff_exponent - Rate of falloff for the audio. Higher means quicker drop to low volume. Should generally be over 1 to indicate a quick dive to 0 rather than a slow dive. +frequency - playback speed of audio +channel - The channel the sound is played at +pressure_affected - Whether or not difference in pressure affects the sound (E.g. if you can hear in space) +ignore_walls - Whether or not the sound can pass through walls. +falloff_distance - Distance at which falloff begins. Sound is at peak volume (in regards to falloff) aslong as it is in this range. | |
| WATER_WEAKEN_TIME | Knockdown time for slipping on water |
|---|
+ Knockdown time for slipping on water
| RECURSION_MAX | Asteroid |
|---|---|
| /turf/simulated/floor/plating/asteroid/basalt/lava | lava underneath |
| /turf/simulated/floor/plating/asteroid/basalt/lava_land_surface | Surface. The surface is warm, but survivable without a suit. Internals are required. The floors break to chasms, which drop you into the underground. |
| /turf/simulated/floor/plating/asteroid/airless/cave/has_data | subtype for producing a tunnel with given data |
| /turf/simulated/floor/plating/asteroid/airless/cave/volcanic/has_data | subtype for producing a tunnel with given data |
+ Asteroid
| /obj/effect/abstract/chasm_storage | An abstract object which is basically just a bag that the chasm puts people inside |
|---|
| /turf/simulated/floor/grass/no_creep | This vairant shows up under normal turfs so fits in the regular 32x32 sprite |
|---|---|
| /turf/simulated/floor/grass/jungle/no_creep | This vairant shows up under normal turfs so fits in the regular 32x32 sprite |
| /turf/simulated/floor/indestructible/boss | you put stone tiles on this and use it as a base |
|---|
| /turf/simulated/floor/lava | Lava turf, burns things that are on it. +Currently a subtype of floor so that footsteps work on it. +Perhaps we could move it down to /turf/simulated/lava someday, as I dont think footsteps over lava are very important. |
|---|
| /turf/simulated/floor/beach/water | TODO - Refactor water so they share the same parent type - Or alternatively component something like that |
|---|
| /turf/simulated/floor/plasteel/airless/indestructible | For bomb testing range |
|---|
| /turf/simulated/mineral | Mineral deposits +wall piece |
|---|
| /datum/river_spawner | A straightforward system for making "rivers", paths made up of a specific +turf type that are generated in a random path on a z-level. |
|---|
| /turf/simulated/wall/mineral/titanium | //////////////////Titanium walls///////////////////// +has to use this path due to how building walls works |
|---|---|
| /turf/simulated/wall/mineral/plastitanium | Plastitanium walls |
| /turf/space/transit/north | moving to the north |
|---|---|
| /turf/space/transit/east | moving to the east |
| /proc/check_rights_all | +Requires the holder to have all the rights specified |
|---|
| /proc/message_adminTicket | +Sends a message to the staff able to see admin tickets +Arguments: +msg - The message being send +important - If the message is important. If TRUE it will ignore the CHAT_NO_TICKETLOGS preferences, +send a sound and flash the window. Defaults to FALSE |
|---|---|
| /proc/message_mentorTicket | +Sends a message to the staff able to see mentor tickets +Arguments: +msg - The message being send +important - If the message is important. If TRUE it will ignore the CHAT_NO_TICKETLOGS preferences, +send a sound and flash the window. Defaults to FALSE |
| /proc/is_special_character | +ADMIN HELPER PROCS +A proc that return whether the mob is a "Special Character" aka Antagonist |
| /proc/get_antag_type_strings_list | +A proc that return an array of capitalized strings containing name of the antag types they are |
| /proc/get_antag_type_truncated_plaintext_string | +A proc that return a string containing all the singled out antags . Empty string if not antag |
| /proc/get_admin_objective_targets | +Allows admins to safely pick from SSticker.minds for objectives |
| /datum/mindslaves | Master Servent Datum Sytems,Based on TG Gang system |
|---|
| /obj/item/antag_spawner/nuke_ops | BORGS AND OPERATIVES |
|---|---|
| /obj/item/antag_spawner/nuke_ops/borg_tele | SYNDICATE BORG |
| /obj/item/antag_spawner/slaughter_demon | ////////SLAUGHTER DEMON +Warning edgiest item in the game |
| /obj/item/antag_spawner/morph | MORPH |
| /obj/item/antag_spawner/revenant | Revenant |
| /obj/item/antag_spawner/pulse_demon | Pulse Demon |
| /datum/team | Datum used by team antagonists to track it's members and objectives the team needs to complete. |
|---|
| COMPACT_MODE | The evolution menu will be shown in the compact mode, with only powers and costs being displayed. |
|---|---|
| EXPANDED_MODE | The evolution menu will be shown in the expanded mode, with powers, costs, and power descriptions being displayed. |
+ The evolution menu will be shown in the compact mode, with only powers and costs being displayed.
+ The evolution menu will be shown in the expanded mode, with powers, costs, and power descriptions being displayed.
| /datum/action/changeling/weapon/arm_blade | * +|ARM BLADE| +* |
|---|---|
| /datum/action/changeling/weapon/tentacle | +|COMBAT TENTACLES| +** |
| /datum/action/changeling/weapon/shield | +|SHIELD| +* |
| /datum/action/changeling/suit/organic_space_suit | +|SPACE SUIT + HELMET| +** |
| /datum/action/changeling/suit/armor | * +|ARMOR| +* |
| /datum/action/changeling/dissonant_shriek/cyberrev | A more expensive version, used during rounds with cyber rev station trait for balance reasons. |
|---|
| /mob/living/simple_animal/hostile/poison/giant_spider/hunter/infestation_spider | Child of giant_spider because this should do everything the spider does and more |
|---|
| /datum/action/changeling/sting/cryo | Enable when mob cooling is fixed so that frostoil actually makes you cold, instead of mostly just hungry. |
|---|
| /datum/contractor_hub | Describes and manages the contracts and rewards for a single contractor. |
|---|
| /datum/objective/contract | Describes the target to kidnap and the extraction area of a /datum/syndicate_contract. |
|---|
| /datum/rep_purchase/item/balloon |
|---|
| /datum/rep_purchase/item/baton |
|---|
| /datum/rep_purchase/blackout |
|---|
| /datum/rep_purchase/item/fulton |
|---|
| /datum/rep_purchase/item/flare |
|---|
| /datum/rep_purchase/item/pinpointer |
|---|
| /datum/rep_purchase | Describes something that can be purchased with Contractor Rep. |
|---|---|
| /datum/rep_purchase/item | Describes an item that can be purchased with Contractor Rep. |
| /datum/rep_purchase/reroll |
|---|
| /datum/rep_purchase/item/zippo |
|---|
| /datum/syndicate_contract | Describes a contract that can be completed by a Contractor. |
|---|
| /obj/item/contractor_uplink | A contractor's point of contact with their Contractor Hub. |
|---|
| /obj/effect/contractor_flare | Used to designate where the /obj/effect/portal/advanced/contractor should spawn during the extraction process. |
|---|---|
| /obj/effect/portal/advanced/contractor | Used to extract contract targets and send them to the Syndicate jail for a few minutes. |
| /obj/structure/closet/secure_closet/contractor | Cannot be opened. Contains the belongings of all kidnapped targets. +Any item added inside stops processing and starts again when removed. |
| DEVIATION_NONE | No deviation at all. Flashed from the front or front-left/front-right. Alternatively, flashed in direct view. |
|---|---|
| DEVIATION_PARTIAL | Partial deviation. Flashed from the side. Alternatively, flashed out the corner of your eyes. |
| DEVIATION_FULL | Full deviation. Flashed from directly behind or behind-left/behind-rack. Not flashed at all. |
+ Full deviation. Flashed from directly behind or behind-left/behind-rack. Not flashed at all.
+ No deviation at all. Flashed from the front or front-left/front-right. Alternatively, flashed in direct view.
+ Partial deviation. Flashed from the side. Alternatively, flashed out the corner of your eyes.
| /obj/effect/beam/i_beam | IBeam |
|---|
This manages getting the asset to the client without doing unneeded re-sends, as well as utilizing any configured cdns. +There are two frameworks for using this system: +Make a datum in asset_list_items.dm with your browser assets for your thing. +Checkout asset_list.dm for the helper subclasses +The Call get_asset_datum() with the type of the datum you created to get your asset cache datum +Call .send(client|usr) on that datum to send the asset to the client. Depending on the asset transport this may or may not block. +Call .get_url_mappings() to get an associated list with the urls your assets can be found at. +See the documentation for The global variable Because byond browse() calls use non-blocking queues, if your code uses output() (which bypasses all of these queues) to invoke javascript functions you will need to first have the javascript announce to the server it has loaded before trying to invoke js functions. +To make your code work with any CDNs configured by the server, you must make sure assets are referenced from the url returned by CSS files that use url() can be made to use the CDN without needing to rewrite all url() calls in code by using the namespaced helper datum. See the documentation for |
| /datum/asset_cache_item | An internal datum containing info on items in the asset cache. Mainly used to cache md5 info for speed. |
|---|
| /datum/asset/simple | If you don't need anything complicated. |
|---|---|
| /datum/asset/group | For registering or sending multiple others at once |
| /datum/asset/simple/icon_states | Generates assets based on iconstates of a single icon |
| /datum/asset/simple/namespaced | Namespace'ed assets (for static css and html files)
+When sent over a cdn transport, all assets in the same asset datum will exist in the same folder, as their plain names.
+Used to ensure css files can reference files by url() without having to generate the css at runtime, both the css file and the files it depends on must exist in the same namespace asset datum. (Also works for html)
+For example blah.css with asset blah.png will get loaded as namespaces/a3d..14f/f12..d3c.css and namespaces/a3d..14f/blah.png. allowing the css file to load blah.png by a relative url rather then compute the generated url with get_url_mappings().
+The namespace folder's name will change if any of the assets change. (excluding parent assets) |
| /datum/asset/spritesheet/chem_master | Pill sprites for UIs |
|---|
| /datum/asset/spritesheet/orbit_job | Sprites for Orbit Role UI |
|---|
| ASSET_CACHE_TELL_CLIENT_AMOUNT | When sending mutiple assets, how many before we give the client a quaint little sending resources message |
|---|---|
| /datum/asset_transport | Base browse_rsc asset transport |
+ When sending mutiple assets, how many before we give the client a quaint little sending resources message
| /datum/asset_transport/webroot | CDN Webroot asset transport. |
|---|
| /obj/effect/hotspot/fake | Largely for the fireflash procs below |
|---|
| /datum/gas_mixture/bound_to_turf | Mathematical proofs: +get_breath_partial_pressure(gas_pp) --> gas_pp/total_moles()breath_pp = pp +get_true_breath_pressure(pp) --> gas_pp = pp/breath_pptotal_moles() |
|---|---|
| /datum/gas_mixture/readonly | A gas mixture that should not be modified after creation. |
| /obj/machinery/alarm/syndicate | general syndicate access |
|---|
| /obj/machinery/atmospherics/binary/valve/digital | can be controlled by AI |
|---|
| FILTER_NOTHING | Nothing will be filtered. |
|---|---|
| FILTER_TOXINS | Plasma, and Oxygen Agent B. |
| FILTER_OXYGEN | Oxygen only. |
| FILTER_NITROGEN | Nitrogen only. |
| FILTER_CO2 | Carbon dioxide only. |
| FILTER_N2O | Nitrous oxide only. |
+ Carbon dioxide only.
+ Nitrous oxide only.
+ Nitrogen only.
+ Nothing will be filtered.
+ Oxygen only.
+ Plasma, and Oxygen Agent B.
| /obj/machinery/atmospherics/trinary/tvalve/digital | can be controlled by AI |
|---|
| MAX_TARGET_PRESSURE | The maximum target_pressure you can set on the pump. Equates to about 1013.25 kPa. |
|---|---|
| DIRECTION_IN | The pump will be siphoning gas. |
| DIRECTION_OUT | The pump will be pumping gas out. |
+ The pump will be siphoning gas.
+ The pump will be pumping gas out.
+ The maximum target_pressure you can set on the pump. Equates to about 1013.25 kPa.
| /turf/simulated/floor/beach/away/sand/dense | for boundary "walls" |
|---|---|
| /turf/simulated/floor/beach/away/coastline/dense | for boundary "walls" |
| /turf/simulated/floor/beach/away/water/dense | for boundary "walls" |
| /obj/structure/closet/crate/secure/oldstation | Secure Crates: Access locked to Theta crew. Cannot be moved, destroyed, +emagged or EMPed because gamers can't be trusted not to game. |
|---|
| WATCHER_EGG_LIVELY_MOD | if greater than lively mod, jiggles faster |
|---|---|
| WATCHER_EGG_ACTIVE_MOD | If greater than active mod, egg is active and jiggles |
| /obj/item/food/snacks/egg/watcher | Egg which hatches into a helpful pet. Or you can eat it if you want. |
| /obj/item/watcher_hatchling | A cute pet who will occasionally attack lavaland mobs for you |
| /obj/effect/watcher_orbiter | Orbiting visual which shoots at mining mobs |
| /obj/item/projectile/baby_watcher_blast | Beam fired by a baby watcher, doesn't actually do less damage than its parent |
+ If greater than active mod, egg is active and jiggles
+ if greater than lively mod, jiggles faster
| CORPSE_INSTANT | this mob spawn creates the corpse instantly |
|---|---|
| CORPSE_ROUNDSTART | this mob spawn creates the corpse during GAME_STATE_PLAYING |
| /obj/effect/mob_spawn/human/alive/space_bar_patron | Alive ones, used as "core" for ghost roles now and in future. |
| /obj/effect/mob_spawn/human/corpse/abductor | Corpses, they can be used for "decoration" purpose. |
| /obj/effect/mob_spawn/mouse | Non-human spawners |
| /obj/effect/mob_spawn/corpse | these mob spawn subtypes trigger immediately (New or Initialize) and are not player controlled... since they're dead, you know? |
+ this mob spawn creates the corpse instantly
+ this mob spawn creates the corpse during GAME_STATE_PLAYING
Manager for buildmode modes. Contains logic to manage switching between each mode, and presenting a suitable user interface. +Special graphics used by buildmode modes for user interface purposes. +Implementer of buildmode behaviors. +Existing varieties: +
|
| /datum/job_ban_holder | Holder for job bans |
|---|
| /datum/client_login_processor | The holder class for all client data processing |
|---|
| /obj/item/clothing/glasses/meson/engine/tray | atmos techs have lived far too long without tray goggles while those damned engineers get their dual-purpose gogles all to themselves |
|---|
| /obj/item/clothing/gloves/color/fyellow | Cheap Chinese Crap |
|---|
| /obj/item/clothing/gloves/ring/silver/blessed | todo |
|---|
| /obj/item/clothing/head/beanie | Default is white, this is meant to be seen |
|---|
| /obj/item/clothing/head/stalhelm | Why do these exist - Because they aren't specifically Nazi Germany |
|---|---|
| /obj/item/clothing/head/beret/purple | Fluff? |
| /obj/item/clothing/shoes/magboots/elite | For the Syndicate Strike Team/SolGov/Tactical Teams |
|---|---|
| /obj/item/clothing/shoes/magboots/wizard | bundled with the wiz hardsuit |
| /obj/item/clothing/shoes/combat | basic syndicate combat boots for nuke ops and mob corpses |
|---|---|
| /obj/item/clothing/shoes/combat/swat | overpowered gimmick boots |
| /obj/item/clothing/shoes/galoshes/dry/lightweight | for red janitor ert. |
| /obj/item/clothing/suit/armor/reactive/random | Spawner for random reactive armor |
|---|
| /obj/item/clothing/suit/hooded/bee_costume | It's Hip! |
|---|---|
| /obj/item/clothing/suit/bloated_human | OH MY GOD WHAT HAVE YOU DONE!?!?!? |
| /obj/item/clothing/suit/draculacoat | Bleh! |
| /obj/item/clothing/suit/advanced_protective_suit | Advanced Protective Suit, AKA, God Mode in wearable form. |
| /obj/item/clothing/accessory/waistcoat | No overlay |
|---|---|
| /obj/item/clothing/accessory/medal/recruiter | Prize for the NT Recruiter emagged arcade |
| /obj/item/clothing/accessory/medal/gold/heroism/hardmode_full | Kill every hardmode boss. In a shift. Good luck. |
| /obj/item/clothing/accessory/scarf | No overlay |
| /obj/item/clothing/under/color/purple/sensor | for jani ert |
|---|
| /obj/item/clothing/under/psysuit | Don't modify the path, used by a fluff item |
|---|
| /obj/item/clothing/under/rank/medical/gown | Seems like it should be here for organisational purposes |
|---|
| /obj/item/weaponcrafting/gunkit | These gun kits are printed from the protolathe to then be used in making new weapons |
|---|
| /datum/crafting_recipe/rake | Category resorting incoming |
|---|
| USED_MOD_HELM | ///////////PARADISE STATION CUSTOM ITEMS/////////// |
|---|---|
| /obj/item/fluff/tattoo_gun | Generic tattoo gun, make subtypes for different folks |
| /obj/item/fluff/bird_painter | BirdtTalon: Kahkiri |
| /obj/item/claymore/fluff | MrBarrelrolll: Maximus Greenwood |
| /obj/item/fluff/rsik_katana | Xydonus: Rsik Ugsharki Atan |
| /obj/item/crowbar/fluff/zelda_creedy_1 | Zomgponies: Griffin Rowley |
| /obj/item/clothing/glasses/monocle/fluff/trubus | Trubus: Wolf O'Shaw |
| /obj/item/clothing/glasses/meson/fluff/book_berner_1 | Adrkiller59: Adam Cooper |
| /obj/item/clothing/glasses/sunglasses_fake/fluff/kaki | Rapidvalj: Kakicharakiti |
| /obj/item/fluff/rapid_wheelchair_kit | Rapidvalj: Hakikarahiti |
| /obj/item/lighter/zippo/fluff/purple | GodOfOreos: Jason Conrad |
| /obj/item/lighter/zippo/fluff/michael_guess_1 | mrbits: Callista Gold |
| /obj/item/lighter/zippo/fluff/duckchan | Duckchan: Rybys Romney |
| /obj/item/lighter/zippo/fluff/warriorstar | Warriorstar: DEADLOCK |
| /obj/item/fluff/dogwhistle | phantasmicdream: Zeke Varloss |
| /obj/item/storage/toolbox/fluff/lunchbox | godoforeos: Jason Conrad |
| /obj/item/fluff/desolate_coat_kit | DesolateG: Micheal Smith |
| /obj/item/fluff/fei_gasmask_kit | Fei Hazelwood: Tariq Yon-Dale |
| /obj/item/fluff/desolate_baton_kit | DesolateG: Micheal Smith |
| /obj/item/fluff/cardgage_helmet_kit | captain cardgage: Richard Ulery |
| /obj/item/fluff/merchant_sallet_modkit | Travelling Merchant: Trav Noble. This is what they spawn in with |
| /obj/item/fluff/k3_webbing_modkit | IK3I: Yakikatachi |
| /obj/item/fluff/pyro_wintersec_kit | DarkLordpyro: Valthorne Haliber |
| /obj/item/fluff/sylus_conversion_kit | Decemviri: Sylus Cain |
| /obj/item/clothing/glasses/hud/security/sunglasses/fluff/eyepro | ///////// Clothing //////////// |
| /obj/item/clothing/glasses/hud/security/sunglasses/fluff/voxxyhud | LP Spartan: Kaskreyarawkta |
| /obj/item/clothing/head/fluff/heather_winceworth | ///////// Hats //////////// +Regens: Heather Winceworth |
| /obj/item/clothing/head/valkyriehelmet | R3Valkyrie: Rikki |
| /obj/item/clothing/head/fluff/sparkyninja_beret | Sparkyninja: Neil Wilkinson |
| /obj/item/clothing/head/fluff/sigholt | sigholtstarsong: Sigholt Starsong |
| /obj/item/clothing/head/pirate/fluff/stumpy | MrFroztee: Stumpy |
| /obj/item/clothing/head/fluff/linda | Epic_Charger: Linda Clark |
| /obj/item/clothing/head/fluff/kaki | Rapidvalj: Kakicharakiti |
| /obj/item/clothing/head/helmet/fluff/merchant_sallet | Travelling Merchant: Trav Noble. This >>IS NOT<< what they spawn in with |
| /obj/item/clothing/head/fluff/elo | V-Force_Bomber: E.L.O. |
| /obj/item/clothing/suit/fluff | Suits |
| /obj/item/clothing/suit/storage/labcoat/fluff/pulsecoat | ozewse : Daniel Harper : Donated to them by Runemeds, who is the original donor. |
| /obj/item/clothing/suit/jacket/miljacket/patch | sniper_fairy : P.A.T.C.H. |
| /obj/item/clothing/suit/fluff/dusty_jacket | ComputerlessCitizen: Screech |
| /obj/item/clothing/suit/fluff/cheeky_sov_coat | CheekyCrenando: Srusu Rskuzu |
| /obj/item/clothing/suit/fluff/supplymaster_jacket | Denthamos: Henry Grandpa Gadow |
| /obj/item/clothing/suit/storage/labcoat/fluff/aeneas_rinil | Socialsystem: Lynn Fea |
| /obj/item/clothing/suit/jacket/fluff/kidosvest | Anxipal: Kido Qasteth |
| /obj/item/clothing/suit/jacket/fluff/jacksvest | Anxipal: Jack Harper |
| /obj/item/clothing/suit/fluff/kluys | Kluys: Cripty Pandaen |
| /obj/item/clothing/suit/storage/labcoat/fluff/red | Sweetjealousy: Sophie Faust-Noms |
| /obj/item/clothing/suit/storage/labcoat/fluff/ionward_labcoat | Ionward: Gemini |
| /obj/item/clothing/suit/fluff/stobarico_greatcoat | Stobarico: F.U.R.R.Y |
| /obj/item/clothing/suit/hooded/hoodie/fluff/linda | Epic_Charger: Linda Clark |
| /obj/item/clothing/head/hooded/hood/fluff/linda | Epic_Charger: Linda Clark |
| /obj/item/clothing/suit/hooded/hoodie/hylo | Hylocereus: Sam Aria |
| /obj/item/clothing/suit/hooded/fluff/bone | Doru7: Jack Bone |
| /obj/item/clothing/suit/armor/shodanscoat | RazekPraxis: SHODAN |
| /obj/item/clothing/suit/hooded/hoodie/fluff/xantholne | Xantholne: Meex Zwichsnicrur |
| /obj/item/clothing/head/hooded/hood/fluff/xantholne | Xantholne: Meex Zwichsnicrur |
| /obj/item/clothing/suit/hooded/hoodie/fluff/xydonus | Xydonus: Rsik Ugsharki Atan | Based off of the bomber jacket, but with a hood slapped on (for allowed suit storage) |
| /obj/item/clothing/suit/fluff/pineapple | Pineapple Salad: Dan Jello |
| /obj/item/fluff/pinapplehairgel | Pineapple Salad: Dan Jello |
| /obj/item/clothing/suit/hooded/wintercoat/fluff/shesi | MrSynnester : Shesi Skaklas |
| /obj/item/clothing/head/hooded/hood/fluff/shesi | MrSynnester : Shesi Skaklas |
| /obj/item/clothing/suit/jacket/dtx | AffectedArc07: DTX |
| /obj/item/clothing/under/fluff | Uniforms |
| /obj/item/clothing/under/fluff/counterfeitguise_uniform | thatdanguy23 : Rissa Williams |
| /obj/item/clothing/under/fluff/benjaminfallout | Benjaminfallout: Pretzel Brassheart |
| /obj/item/clothing/under/fluff/soviet_casual_uniform | Norstead : Natalya Sokolova |
| /obj/item/clothing/under/fluff/kharshai | Kharshai: Athena Castile |
| /obj/item/clothing/under/fluff/xantholne | Xantholne: Meex Zwichsnicrur |
| /obj/item/clothing/under/fluff/elishirt | FlattestGuitar9: Eli Randolph |
| /obj/item/clothing/under/fluff/jay_turtleneck | Jayfeather: Jay Wingler |
| /obj/item/clothing/under/psysuit/fluff/isaca_sirius_1 | Xilia: Isaca Sirius |
| /obj/item/clothing/under/fluff/jane_sidsuit | SyndiGirl: Zoey Scyth |
| /obj/item/clothing/under/fluff/honourable | MrBarrelrolll: Maximus Greenwood |
| /obj/item/clothing/under/fluff/aegis | PlagueWalker: A.E.G.I.S. |
| /obj/item/clothing/under/fluff/elo_turtleneck | vforcebomber: E.L.O. |
| /obj/item/clothing/mask/bandana/fluff/dar | ///////// Masks //////////// +sasanek12: Dar'Konr |
| /obj/item/clothing/mask/gas/sechailer/fluff/spartan | LP Spartan: Kaskreyarawkta |
| /obj/item/clothing/suit/storage/fox | Shoes +Sets |
| /obj/item/nullrod/fluff/chronx | chronx100: Hughe O'Splash |
| /obj/item/clothing/head/fluff/chronx | chronx100: Hughe O'Splash |
| /obj/item/clothing/suit/chaplain_hoodie/fluff/chronx | chronx100: Hughe O'Splash |
| /obj/item/clothing/shoes/black/fluff/chronx | chronx100: Hughe O'Splash |
| /obj/item/clothing/suit/armor/vest/fluff/tactical | m3hillus: Medusa Schlofield |
| /obj/item/clothing/suit/jacket/fluff/elliot_windbreaker | DaveTheHeadcrab: Elliot Campbell |
| /obj/item/storage/backpack/fluff/syndiesatchel | SkeletalElite: Rawkkihiki |
| /obj/item/storage/backpack/fluff/krich_back | lizardzsi: Krichahka |
| /obj/item/storage/backpack/fluff/ssscratches_back | Ssscratches: Lasshy-Bot |
| /obj/item/storage/backpack/fluff/thebrew | Greey: Korala Ice |
| /obj/item/clothing/head/wizard/fake/fluff/dreamy | phantasmicdream : Dreamy Rockwall |
| /obj/item/fluff/zekemirror | phantasmicdream : Zeke Varloss |
| /obj/item/clothing/accessory/necklace/locket/fluff/fethasnecklace | Fethas: Sefra'neem |
| /obj/item/bedsheet/fluff/hugosheet | HugoLuman: Dan Martinez |
| /obj/item/clothing/head/fluff/lfbowler | Lightfire: Hyperion |
| /obj/item/clothing/under/fluff/lfvicsuit | Lightfire: Hyperion |
| /obj/item/fluff/lighty_plasman_modkit | LightFire53: Ikelos |
| /obj/item/clothing/head/helmet/space/plasmaman/lf53_fluff | LightFire53: Ikelos |
| /obj/item/bikehorn/fluff/pinkbikehorn | Xerdies: Squiddle Toodle |
| /obj/item/clothing/accessory/medal/fluff/elo | V-Force_Bomber: E.L.O. |
| /obj/item/clothing/suit/fluff/vetcoat | Furasian: Fillmoore Grayson |
| /obj/item/clothing/suit/fluff/vetcoat/red | Furasian: Fillmoore Grayson |
| /obj/item/clothing/suit/fluff/vetcoat/navy | Furasian: Fillmoore Grayson |
| /obj/item/clothing/accessory/medal/fluff/panzermedal | PanzerSkull: GRN-DER |
| /obj/item/clothing/accessory/medal/fluff/XannZxiax | Sagrotter: Xann Zxiax |
| /obj/item/clothing/accessory/rbscarf | Rb303: Isthel Eisenwald |
| /obj/item/clothing/head/fluff/pinesalad_horns | Pineapple Salad: Dan Jello |
| /obj/item/storage/backpack/fluff/hiking | Pineapple Salad: Dan Jello |
| /obj/item/clothing/under/fluff/kiaoutfit | FullOfSkittles: Kiachi |
| /obj/item/clothing/head/fluff/kiahat | FullOfSkittles: Kiachi |
| /obj/item/clothing/mask/gas/fluff/kiamask | FullOfSkittles: Kiachi |
| /obj/item/clothing/gloves/ring/fluff/benjaminfallout | Benjaminfallout: Pretzel Brassheart |
| /obj/item/clothing/under/fluff/kikeridress | Gangelwaefre: Kikeri |
| /obj/item/clothing/mask/gas/fluff/kikerimask | Gangelwaefre: Kikeri |
| /obj/item/clothing/mask/gas/fluff/yahiyamask | Asmerath: Yahiya |
+ ///////////PARADISE STATION CUSTOM ITEMS///////////
+Usable Items
This README was last updated on October 2nd, 2022 +The Economy SubSystem performs a few important tasks that turns the gears of the economy +
The Space Credit system is split up into two important datums: money accounts ( A Credit Balance
+Accounts are primarily a store of space credits for crew
+ Account Security +Accounts are not perfectly secure and safe, in fact, they're built to be broken into when crew members are not careful with their credentials, or an antagonist chooses to try and access another's account +
Money Transfers +Money transfers are the transfer of space credits between money accounts, while the movement of space credits out of one account into another is handled by an account database, the actual requests that have not been resolved are stored and handled on money accounts +
Neither of these procs actually transfer money account and rather just deal with how the information is being stored and processed on the money account, the actual money transfer is done through the account database. +Why You Shouldn't use these Procs +You shouldn't be using these procs unless you intend to change how the account database interacts with money accounts. Like mentioned previously, money accounts are only for storing data and don't actual perform the functions and power the moving parts of the economy. This is because there can be upwards of 100 money accounts in one round, in order to make this memory performative, money accounts are focused on being as efficient as possible by utilizing LAZY LISTS and facilitating good Garbage Collection practices +Instead, if you want to perform calculations, purchases, transfers, etc with multiple money accounts, ALL of that should be done through a account database or some form of financial machinery but not the money account. +If Money accounts are just records of data, account databases are a store of multiple money data records. A most instances of any financial/economy machinery/programs should have a reference to the main station +database. You'll see a lot of machinery already use a var ref to the main station db, through this, most all economy actions can be performed. (Please see each procs documentation for usage). This is how you will interact with money account, through the account database. +Referencing Money Databases
+A good way to make sure your machine can access the station money database
+ Using a Money DB to find an account
+The only way to find personal money accounts in a money DB is with the account associated account number
+you can use For the main station type account db, you can also find departments, you can either get all the departments in one list an iterate through it yourself, or just provide the name of the department
+ Moving Money In and Out of Money Accounts
+You can charge a money account, when doing this through the account_db, you need to provide information about the purchase so that if the charge goes through, proper transaction logs can be created
+ You can add credits to a money account with the credit account proc, works similairly to charge account
+ Create a money transfer request datum on specified money account, notifies the money account to start storing this data
+ Money Account Security through the DB
+Check user permission to access a money account based on given parameters
+ for example, in order to interact with money account A you will need to go through your account database
+ As with the previousl example, you may notice that a lot of these procs exist on the money account level. Those are internal procs that exist for the account database to use. The reason for this is to ensure proper logging for players and admins, handle interactions where two money accounts are involved, and to prevent runtimes that may occur from value mismatches. Many procs such as a The power of an in-game economy exists because of how much control we have over it. Every credit spent needs to go somewhere, and every credit given needs to come from somewhere. One should avoid just crediting accounts on a whim or removing money for no reason. Since we don't have current implementations of supply/demand or rolling prices (increasing or decreasing), prices of items in-game are fixed. That means that the money supply is the only thing controlling how much or little of items that the crew can buy. +Space Credits Taps (In-Flow of Space Credits into the economy) +
Space Credit Drains/Exchanges (Out-Flow of space credits out of the economy) +
|
| /proc/get_departments_from_job | +matches a string job name to their department(s) and returns it as a list |
|---|
| /obj/machinery/economy | Base machine type for machinery that needs to interact with users spending Space Cash or credit from Money Accounts +has helper procs to automate account authentification and handling transactions. |
|---|
| /proc/emoji_parse | +Turns :ai: into an emoji in text. |
|---|
| /mob/living/simple_animal/hostile/blob | You will appear adjacent to the beacon |
|---|
| /obj/structure/blob/captured_nuke | alternative to blob just straight up destroying nukes |
|---|
| /datum/event | NOTE: Times are measured in master controller ticks! |
|---|
| /datum/spacevine_mutation/explosive | OH SHIT IT CAN CHAINREACT RUN!!! |
|---|---|
| /datum/spacevine_mutation/aggressive_spread | very OP, but im out of other ideas currently |
| /datum/event/tear | Dimensional tear event. |
|---|---|
| /obj/effect/tear | The portal used in the /datum/event/tear midround. |
| /datum/event/wizard/ghost | The spook is real |
|---|---|
| /datum/event/wizard/ghost_mute | The spook is silent |
| /obj/item/reagent_containers/drinks/bottle | Alchohol bottles! -Agouri |
|---|---|
| /obj/item/reagent_containers/drinks/bottle/orangejuice | JUICES AND STUFF |
| /obj/item/reagent_containers/drinks/bottle/molotov | MOLOTOV |
| /obj/item/reagent_containers/drinks | Drinks. |
|---|---|
| /obj/item/reagent_containers/drinks/trophy | Drinks. END |
| /obj/item/reagent_containers/drinks/trophy/bronze_cup/toolbox_win | 2023 toolbox tournament 3rd place went to paradise station. |
| /obj/item/reagent_containers/drinks/coffee | Drinks |
| /obj/item/reagent_containers/drinks/shaker | drinkingglass and shaker |
| /obj/item/reagent_containers/condiment | Condiments |
|---|---|
| /obj/item/reagent_containers/condiment/saltshaker | Seperate from above since it's a small shaker rather then |
| /obj/item/food/snacks/customizable/fullycustom | In the event you fuckers find something I forgot to add a customizable food for. |
|---|
| /obj/item/food/snacks/cookiedough | cookies by Ume |
|---|---|
| /obj/item/food/snacks/choc_pile | for reagent chocolate being spilled on turfs |
| /obj/item/food/snacks/mashed_potatoes | mashed taters |
|---|
| /obj/item/food/snacks/badrecipe | FOOD END |
|---|
| /obj/item/food | Food. |
|---|
| /datum/food_processor_process/meat | OBJECT RECIPIES |
|---|---|
| /datum/food_processor_process/mob/slime | MOB RECIPIES |
| /obj/machinery/smartfridge | Stores items of a specified type. |
|---|---|
| /obj/machinery/smartfridge/secure | Secure variant of the Smart Fridge. +Can be emagged and EMP'd to short the lock. |
| /obj/machinery/smartfridge/seeds | Seeds variant of the Smart Fridge. +Formerly known as MegaSeed Servitor, but renamed to avoid confusion with the vending machine. |
| /obj/machinery/smartfridge/foodcart | Variant of the Smart Fridge that holds food and drinks in a mobile form |
| /obj/machinery/smartfridge/secure/circuits | Circuit variant of the Smart Fridge. |
| /obj/machinery/smartfridge/medbay | Medical variant of the Smart Fridge. |
| /obj/machinery/smartfridge/secure/extract | Secure, Xenobiology variant of the Smart Fridge. |
| /obj/machinery/smartfridge/secure/medbay | Secure, Medical variant of the Smart Fridge. |
| /obj/machinery/smartfridge/secure/chemistry | Secure, Chemistry variant of the Smart Fridge. |
| /obj/machinery/smartfridge/secure/chemistry/preloaded | A Smart Chemical Storage but with some items already in. |
| /obj/machinery/smartfridge/secure/chemistry/preloaded/syndicate | A Smart Chemical Storage (Preloaded) but with exclusive access to Syndicate. |
| /obj/machinery/smartfridge/disks | Disk variant of the Smart Fridge. |
| /obj/machinery/smartfridge/secure/chemistry/virology | Secure, Virology variant of the Smart Chemical Storage. |
| /obj/machinery/smartfridge/secure/chemistry/virology/preloaded | A Smart Virus Storage but with some additional items. |
| /obj/machinery/smartfridge/secure/chemistry/virology/preloaded/syndicate | A Smart Virus Storage (Preloaded) but with exclusive access to Syndicate. |
| /obj/machinery/smartfridge/drinks | Drink variant of the Smart Fridge. |
| /obj/machinery/smartfridge/drying_rack | Variant of the Smart Fridge for drying stuff. +Doesn't have components. |
| /datum/recipe/microwave/wrap | FOOD ADDITTIONS |
|---|
| /datum/recipe/oven/cookies | cookies by Ume |
|---|---|
| /datum/recipe/oven/turkey | Magic |
| /obj/item/deck/unum | A deck of unum cards. Classic. |
|---|
| /obj/effect/hallucination/tripper | A generic hallucination that causes the target to trip if they cross it. |
|---|---|
| /obj/effect/hallucination/chaser | A generic hallucination that chases the target. |
| /obj/effect/hallucination/chaser/attacker | A generic hallucination based on the Chaser that attacks if close enough. |
| /obj/effect/hallucination/terror_infestation | Creates spider webs and a terror spider near a random vent around the target. |
|---|---|
| /obj/effect/hallucination/tripper/spider_web | A fake spider web that trips the target if crossed. |
| /obj/effect/hallucination/abduction | Sends an abductor agent after the target. On knockdown, spawns an abductor scientist next to the target. Nothing else happens. |
| /obj/effect/hallucination/loose_energy_ball | A progressive hallucination that begins with intermittent explosions, before displaying an energy ball that shocks the target. |
| /obj/effect/hallucination/assault | An imaginary attacker spawns close to the target and attacks them to stamcrit. |
| /obj/effect/hallucination/xeno_pounce | An imaginary alien hunter pounces towards the target. |
| /obj/effect/hallucination/audio | Plays a random sound. |
|---|---|
| /obj/effect/hallucination/audio/localized | Plays a random sound at a random location around the target. |
| /obj/effect/hallucination/bolts | Visually bolts a random number of airlocks around the target. |
| /obj/effect/hallucination/speech | Causes the target to hear a fake message from a random mob around them. |
| /obj/effect/hallucination/fake_danger | Sends a random danger message to the target's chat. |
| /obj/effect/hallucination/fake_health | Visually changes the target's health status to something it shouldn't be. |
| /obj/effect/hallucination/bolts/moderate | A variation that affects more airlocks. |
|---|---|
| /obj/effect/hallucination/fake_alert | Displays a random alert on the target's HUD. |
| /obj/effect/hallucination/fake_item | Displays a random fake item around the target. If it's on the floor and they try to pick it up, they will trip and fall. |
| /obj/effect/hallucination/fake_weapon | Displays a random fake weapon wielded by a human around the target. |
| /obj/effect/hallucination/chasms | Displays fake chasms around the target that if crossed, cause them to trip. |
| /obj/effect/hallucination/tripper/chasm | A fake chasm that if crossed by the target, causes them to trip. |
| /obj/effect/hallucination/delamination_alarm | A fake radio message and audio that alerts of an increasing SM unstability. |
| /obj/effect/hallucination/plasma_flood | A fake plasma flood emanating from a nearby vent. |
| /obj/effect/hallucination/husks | A random number of fake husks around the target. |
| /obj/effect/hallucination/stunprodding | A series of localized audio playback simulating a kidnapping with a stunprod. |
| /obj/effect/hallucination/energy_sword | A series of localized audio playback simulating an energy sword murder. |
| /obj/effect/hallucination/gunfire | A series of localized audio playback simulating a gunshot murder. |
| /obj/effect/hallucination/self_delusion | Changes the target's appearance to something else temporarily. |
| /obj/effect/hallucination/delusion | Changes the appearance of all humans around the target. |
| /obj/effect/hallucination | Base object for hallucinations. Contains basic behaviour to display an icon only to the target. |
|---|
| BASE_MAX_STORABLE_PLANTS | The base amount of plants that can be stored before taking our matter bin into account. |
|---|
+ The base amount of plants that can be stored before taking our matter bin into account.
| /obj/machinery/compost_bin | used to make soil from plants. +Doesn't have components. |
|---|
| /obj/item/grown/bananapeel/specialpeel | used by /obj/item/clothing/shoes/clown_shoes/banana_shoes |
|---|
| /obj/item/seeds/firelemon | combustible lemon is too long so firelemon |
|---|
| /obj/item/grown/sunflower | FLOWER POWER! |
|---|
| /obj/item/grown/nettle | abstract type |
|---|
| /obj/structure/bonfire | BONFIRES |
|---|---|
| /obj/structure/bonfire/lit | haha empty define |
| /obj/item/grown | Grown weapons |
|---|
| /obj/item/reagent_containers/spray/weedspray | -- Skie |
|---|---|
| /obj/item/reagent_containers/spray/pestspray | -- Skie |
| /obj/machinery/hydroponics/soil | Not actually hydroponics at all! Honk! |
|---|
| /datum/plant_gene/trait/fire_resistance | Lavaland |
|---|---|
| /datum/plant_gene/trait/plant_type | Parent type |
| BASE_MAX_SEEDS | Base Cap of the max amount of seeds you can store in a seed extractor |
|---|---|
| MAX_DISPENSE_SEEDS | Max Cap of the amount of seed we let players dispense at once |
| /proc/seedify | +Convert a grown object into seeds. |
+ Base Cap of the max amount of seeds you can store in a seed extractor
+ Max Cap of the amount of seed we let players dispense at once
| /proc/get_allowed_instrument_ids | +Get all non admin_only instruments as a list of text ids. |
|---|---|
| /datum/instrument | Instrument datums hold the data for any given instrument, as well as data on how to play it and what bounds there are to playing it. |
| /datum/instrument_key | Instrument key datums contain everything needed to know how to play a specific +note of an instrument.* |
|---|
| /obj/item/instrument/guitar/cyborg | This is a special guitar for the emagged service borg that hits pretty hard and can still play music. Clonk. |
|---|
| /datum/song | These are the actual backend behind instruments. +They attach to an atom and provide the editor + playback functionality. |
|---|
| LAVALAND_MIN_CAVE_Y | Approximate lower bound of the walkable land area on Lavaland, north of the southern lava border. |
|---|---|
| LAVALAND_MAX_CAVE_Y | Approximate upper bound of the walkable land area on Lavaland, south of the Legion entrance. |
+ Approximate upper bound of the walkable land area on Lavaland, south of the Legion entrance.
+ Approximate lower bound of the walkable land area on Lavaland, north of the southern lava border.
| MAX_PAGES | Max Writeable Content Pages per book, players really don't need more than this |
|---|---|
| /obj/item/book | Game Object which stores pages of text usually written by players, has other editable information such as the book's +title, author, summary, and categories. Has other values that are generated when books are acquired through the library +computer. |
+ Max Writeable Content Pages per book, players really don't need more than this
| DEFINE_CATEGORY | library category datum constructor helper, used to make easier the process of defining new report/book categories |
|---|---|
| MAX_PLAYER_UPLOADS | Maximum number of books that can be uploaded by a single ckey |
+ library category datum constructor helper, used to make easier the process of defining new report/book categories
+ Maximum number of books that can be uploaded by a single ckey
| LIBRARY_BOOKS_PER_PAGE | Defines how many player books appear on the player book archive TGUI tab |
|---|---|
| LOGIN_FULL | Login state for our computer, this state grants full access to functions |
| LOGIN_PUBLIC | Login state for our computer, this state grants basic access to functions |
| PRINTING_COOLDOWN | Wait time before printing another book, used to prevent spam |
| /obj/machinery/computer/library | This is the player facing machine that handles all library functions |
+ Defines how many player books appear on the player book archive TGUI tab
+ Login state for our computer, this state grants full access to functions
+ Login state for our computer, this state grants basic access to functions
+ Wait time before printing another book, used to prevent spam
| /datum/borrowbook | Datum used to keep track of who has borrowed what when and for how long. |
|---|---|
| /datum/cachedbook | Datum used to cache the SQL DB books locally in order to achieve a performance gain. |
| /atom/movable/emissive_blocker | Internal atom that copies an appearance on to the blocker plane |
|---|
| /datum/map | Map Datum |
|---|
| /obj/effect/baseturf_helper | Set the baseturfs of every turf in the /area/ it is placed. |
|---|---|
| /obj/effect/mapping_helpers/bombable_wall | Apply to a wall (or floor, technically) to ensure it is instantly destroyed by any explosion, even if usually invulnerable |
| /proc/announce_merge_conflict_marker | +We REALLY do not want un-addressed merge conflicts in maps for an +inexhaustible list of reasons. This should help ensure that this will not be +missed in case linters fail to catch it for any reason what-so-ever. |
|---|
| /proc/show_blurb | +Shows a ticker reading out the given text on a client's screen. |
|---|
| /obj/item/clothing/gloves/color/black/krav_maga/combat | for nukies |
|---|
| /obj/item/clothing/suit/hooded/explorer | Explorer's Suit and Mask |
|---|
| /obj/item/kinetic_crusher | Mining Hammer |
|---|
| /obj/item/lazarus_injector | Lazarus Injector |
|---|---|
| /obj/item/mobcapsule | Mob Capsule |
| /obj/item/stack/marker_beacon/ten | miners start with 10 of these |
|---|---|
| /obj/item/stack/marker_beacon/thirty | and they're bought in stacks of 1, 10, or 30 |
| /obj/item/mining_scanner | Mining Scanner |
|---|
| /obj/item/pickaxe | Pickaxes & Drills & Shovels |
|---|---|
| /obj/item/pickaxe/drill/cyborg/diamond | This is the BORG version! |
| /obj/item/hivelordstabilizer | Hivelord stabilizer |
|---|---|
| /obj/item/organ/internal/regenerative_core | Hivelord core |
| /obj/item/organ/internal/regenerative_core/legion | Legion core |
| /obj/item/resonator | Resonator |
|---|
| /obj/item/clothing/mask/facehugger/toy | Mining Equipment Vendor Items |
|---|
| /obj/item/wormhole_jaunter | Jaunter |
|---|---|
| /obj/effect/temp_visual/getaway_flare | Because the original contractor flare is not a temp visual, for some reason. |
| /obj/machinery/mineral/labor_prisoner_shuttle_console | Prisoners' Console |
|---|---|
| /obj/machinery/mineral/labor_points_checker | Point Lookup Console |
| /obj/structure/flora/ash/tall_shroom | exists only so that the spawning check doesn't allow these spawning near other things |
|---|---|
| /obj/structure/flora/ash/rock | Rocks |
| /obj/item/food/snacks/grown/ash_flora/shavings | for actual crafting |
| /obj/machinery/anomalous_crystal | Anomolous Crystal |
|---|---|
| /obj/machinery/anomalous_crystal/theme_warp | Warps the area you're in to look like a new one |
| /obj/machinery/anomalous_crystal/emitter | Generates a projectile when interacted with |
| /obj/machinery/anomalous_crystal/dark_reprise | Revives anyone nearby, but turns them into shadowpeople and renders them uncloneable, so the crystal is your only hope of getting up again if you go down. |
| /obj/machinery/anomalous_crystal/helpers | Lets ghost spawn as helpful creatures that can only heal people slightly. Incredibly fragile and they can't converse with humans |
| /obj/machinery/anomalous_crystal/possessor | Allows you to bodyjack small animals, then exit them at your leisure, but you can only do this once per activation. Because they blow up. Also, if the bodyjacked animal dies, SO DO YOU. |
| /obj/machinery/mineral | Mineral processing unit console |
|---|---|
| /obj/machinery/mineral/processing_unit | Mineral processing unit |
| /obj/machinery/mineral/ore_redemption | Turns all the various mining machines into a single unit to speed up tmining and establish a point system. |
|---|---|
| /obj/machinery/mineral/ore_redemption/golem | Golem variant of the ORM. |
| /obj/machinery/mineral/ore_redemption/labor | Labor camp variant of the ORM. Points can be claimed by anyone. |
| /obj/machinery/mineral/stacking_unit_console | Mineral stacking unit console |
|---|---|
| /obj/machinery/mineral/stacking_machine | Mineral stacking unit |
| /obj/machinery/mineral/unloading_machine | Unloading unit |
|---|
| /obj/machinery/mineral/equipment_vendor | Mining Equipment Vendor |
|---|---|
| /obj/machinery/mineral/equipment_vendor/golem | Mining Equiment Vendor (Golem) |
| /obj/machinery/mineral/equipment_vendor/labor | Mining Equiment Vendor (Gulag) |
| /obj/machinery/mineral/equipment_vendor/explorer | Mining Equipment Vendor (Explorer) |
| /datum/data/mining_equipment | Mining Equipment Datum |
| /obj/item/mining_voucher | Mining Equipment Voucher |
| /obj/item/card/mining_point_card | Mining Point Card |
| /obj/effect/light_emitter | Light |
|---|---|
| /obj/structure/closet/wardrobe/miner | Miner Lockers |
| /obj/machinery/computer/shuttle/mining | Shuttle Computer |
| /obj/item/flashlight/lantern | Lantern |
| /obj/structure/closet/crate/miningcar | Mining car (Crate like thing, not the rail car) |
| MINEDRONE_COLLECT | Mining drone |
|---|---|
| /obj/item/mine_bot_upgrade | Minebot Upgrades |
| /obj/item/mining_drone_cube | Mining drone cube |
+ Mining drone
| /obj/structure/ore_box | Ore box |
|---|
| /datum/emote/living/brain | Emotes usable by brains, but only while they're in MMIs. |
|---|
| /datum/emote/living/carbon/alien/humanoid | Emotes usable by humanoid xenomorphs. |
|---|
| /datum/strippable_item/hand | A strippable item for a hand |
|---|
| /datum/status_effect/offering_item | Status effect given to mobs after they've offered an item to another player using the Give Item action (/datum/click_intercept/give). |
|---|---|
| /datum/click_intercept/give | While a mob has this intercept, left clicking on a carbon mob will attempt to offer their currently held item to that mob. |
| /atom/movable/screen/alert/take_item | Alert which appears for a user when another player is attempting to offer them an item. +The user can click the alert to accept, or simply do nothing to not take the item. |
| /datum/body_accessory/tail/wingler_tail | Jay wingler fluff tail |
|---|---|
| /datum/body_accessory/tail/tiny | Pretty ambiguous as to what species it belongs to, tail could've been injured or docked. |
| /datum/body_accessory/tail/short | Same as above. |
| /datum/emote/living/carbon/human/monkey | Snowflake emotes only for le epic chimp |
|---|
| /datum/physiology | Datum that stores several modifiers in a way that isn't cleared by changing species |
|---|
| /proc/get_safe_species | +Returns a list of names of non-blacklisted or hazardous species. |
|---|
| /datum/species/diona/pod | Same name and everything; we want the same limitations on them; we just want their regeneration to kick in at all times and them to have special factions |
|---|
| /datum/species/skeleton | The OG skellybones, quite OP. As of this comment, only available through ash-drake loot (2023-03-07) |
|---|---|
| /datum/species/skeleton/lich | Wizard subtype, subtype to allow balancing separately from other skellies |
| /datum/species/skeleton/brittle | The most common (and weakest) type, legion corpses and skeleton map spawners are these |
| /datum/spell/recruit | POWERS/ABILITIES CODE |
|---|
Initial code credit for this goes to Uristqwerty. +Debugging, functionality, all comments and porting by Giacom. +This is a replacement for the current camera movement system, of the AI. Before +this, the AI had to move between cameras and could only see what the cameras +could see. Not only this but the cameras could see through walls, which created +problems. With this, the AI controls an "AI Eye" mob, which moves just like a +ghost; such as moving through walls and being invisible to players. The AI's eye +is set to this mob and then we use a system (explained below) to determine what +the cameras around the AI Eye can and cannot see. If the camera cannot see a +turf, it will black it out, otherwise it won't and the AI will be able to see +it. This creates several features, such as.. no more see-through-wall cameras, +easier to control camera movement, easier tracking, the AI only being able to +track mobs which are visible to a camera, only trackable mobs appearing on the +mob list and many more. +It works by first creating a camera network datum. Inside of this camera network +are "chunks" (which will be explained later) and "cameras". The cameras list is +kept up to date by obj/machinery/camera/New() and Destroy(). +Next the camera network has chunks. These chunks are a 16x16 tile block of turfs +and cameras contained inside the chunk. These turfs are then sorted out based on +what the cameras can and cannot see. If none of the cameras can see the turf, +inside the 16x16 block, it is listed as an "obscured" turf. Meaning the AI won't +be able to see it. +The camera network uses a streaming method in order to effeciently update +chunks. Since the server will have doors opening, doors closing, turf being +destroyed and other lag inducing stuff, we want to update it under certain +conditions and not every tick. +The chunks are not created straight away, only when an AI eye moves into it's +area is when it gets created. One a chunk is created, when a non glass door +opens/closes or an opacity turf is destroyed, we check to see if an AI Eye is +looking in the area. We do this with the "seenby" list, which updates everytime +an AI is near a chunk. If there is an AI eye inside the area, we update the +chunk that the changed atom is inside and all surrounding chunks, since a +camera's vision could leak onto another chunk. If there is no AI Eye, we instead +flag the chunk to update whenever it is loaded by an AI Eye. This is basically +how the chunks update and keep it in sync. We then add some lag reducing +measures, such as an UPDATE_BUFFER which stops a chunk from updating too many +times in a certain time-frame, only updating if the changed atom was blocking +sight; for example, we don't update glass airlocks or floors. +
|
| /datum/pai_software | Datum module for pAI software |
|---|
| /obj/item/gun/syringemalf | Malf Syringe Gun |
|---|---|
| /datum/robot_storage | |
| /datum/robot_storage/material | This datum is an alternative to the energy storages, instead being recharged in different ways |
| /proc/pick_unique_lawset | +returns a random non starting / kill crew lawset if the station has a unique ai lawset |
|---|
| /mob/living/simple_animal/bot/secbot/griefsky | This bot is powerful. If you managed to get 4 eswords somehow, you deserve this horror. Emag him for best results. |
|---|---|
| /mob/living/simple_animal/bot/secbot/griefsky/toy | A toy version of general griefsky! |
| /mob/living/simple_animal/hostile/construct/armoured | Juggernaut |
|---|---|
| /mob/living/simple_animal/hostile/construct/armoured/hostile | actually hostile, will move around, hit things |
| /mob/living/simple_animal/hostile/construct/wraith | Wraith |
| /mob/living/simple_animal/hostile/construct/wraith/hostile | actually hostile, will move around, hit things |
| /mob/living/simple_animal/hostile/construct/wraith/hostile/bubblegum | Used in bubblegum summoning. Needs MOB_SIZE_LARGE so crushers don't suffer |
| /mob/living/simple_animal/hostile/construct/builder | Artificer |
| /mob/living/simple_animal/hostile/construct/builder/hostile | actually hostile, will move around, hit things, heal other constructs |
| /mob/living/simple_animal/hostile/construct/behemoth | Behemoth |
| /mob/living/simple_animal/hostile/construct/behemoth/hostile | actually hostile, will move around, hit things |
| /mob/living/simple_animal/hostile/construct/harvester | Harvester |
| /mob/living/simple_animal/hostile/construct/harvester/hostile | actually hostile, will move around, hit things |
| /mob/living/simple_animal/pet/dog/corgi/puppy/void | Tribute to the corgis born in nullspace |
|---|---|
| /mob/living/simple_animal/pet/dog/pug | Pugs |
| /mob/living/simple_animal/hostile/illusion/escape | Actual Types |
|---|---|
| /mob/living/simple_animal/hostile/illusion/cult | Cult Illusions |
| /obj/item/projectile/energy/tesla_bolt | Leaving here for adminbus / so vetus still uses it. |
|---|---|
| /obj/effect/temp_visual/dragon_swoop/bubblegum/ancient_robot | this is the worst path I have ever made |
| /obj/item/melee/energy/cleaving_saw/miner | nerfed saw because it is very murdery |
|---|
| /obj/effect/temp_visual/hierophant/wall | smoothing and pooling were not friends, but pooling is dead. |
|---|---|
| /obj/effect/temp_visual/hierophant/chaser | a hierophant's chaser. follows target around, moving and producing a blast every speed deciseconds. |
| /mob/living/simple_animal/hostile/asteroid/elite/broodmother | A stronger, faster variation of the goliath. Has the ability to spawn baby goliaths, which it can later detonate at will. +When it's health is below half, tendrils will spawn randomly around it. When it is below a quarter of health, this effect is doubled. +It's attacks are as follows: |
|---|
| /mob/living/simple_animal/hostile/asteroid/elite/herald | A slow-moving projectile user with a few tricks up it's sleeve. Less unga-bunga than Colossus, with more cleverness in it's fighting style. +As it's health gets lower, the amount of projectiles fired per-attack increases. +It's attacks are as follows: |
|---|
| /mob/living/simple_animal/hostile/asteroid/elite/legionnaire | A towering skeleton, embodying the power of Legion. +As it's health gets lower, the head does more damage. +It's attacks are as follows: |
|---|
| /mob/living/simple_animal/hostile/asteroid/elite/pandora | A box with a similar design to the Hierophant which trades large, single attacks for more frequent smaller ones. +As it's health gets lower, the time between it's attacks decrease. +It's attacks are as follows: |
|---|
| /mob/living/simple_animal/hostile/syndicate/melee | Sword and shield |
|---|
| /obj/structure/alien/resin/flower_bud_enemy | inheriting basic attack/damage stuff from alien structures |
|---|
| /mob/living/simple_animal/hostile/winter/santa/stage_1 | stage 1: slow melee |
|---|---|
| /mob/living/simple_animal/hostile/winter/santa/stage_2 | stage 2: slow ranged |
| /mob/living/simple_animal/hostile/winter/santa/stage_3 | stage 3: fast rapidfire ranged |
| /mob/living/simple_animal/hostile/winter/santa/stage_4 | stage 4: fast spinebreaker |
| MOOD_RESET | Sentinel value; passing this as mood sets mood to null. |
|---|
+ Sentinel value; passing this as mood sets mood to null.
| /proc/shake_camera | +Shake the camera of the person viewing the mob SO REAL! |
|---|
| /datum/sprite_accessory/body_markings/tattoo | Tattoos applied post-round startup with tattoo guns in item_defines.dm |
|---|---|
| /datum/sprite_accessory/body_markings/tattoo/tiger_body | Yep, this is repeated. To be fixed later |
| /datum/sprite_accessory/facial_hair/britstache | START VG HAIRSTYLES |
|---|
| /datum/sprite_accessory/hair/short | END VG HAIRSTYLES |
|---|---|
| /datum/sprite_accessory/hair/birdnest | START VG HAIRSTYLES |
| /datum/sprite_accessory/hair/dave | END VG HAIRSTYLES// |
| /datum/sprite_accessory/hair/bun4 | Due to a vulp hairstyle called bun |
| /datum/sprite_accessory/hair/eighties_ponytail | //END POLARIS HAIRSTYLES/// |
| /datum/sprite_accessory/hair/fluff/pinapple_fluff_hair | Ume hairs end here/// +Fluff HairStyles// +Pineapple Salad hair fluff its for a slime..has to go under human |
| /datum/sprite_accessory/body_markings/tail/shared/short_tip | Species-ambiguous, generic short tail. |
|---|
| /datum/sprite_accessory/hair/fluff/zeke_fluff_tentacle | Zeke Fluff hair |
|---|
| /datum/sprite_accessory/body_markings/head/tajara/muzzle_alt_taj | Companion marking for Tajaran Belly 2. |
|---|---|
| /datum/sprite_accessory/body_markings/head/tajara/points_taj | Companion marking for Tajaran Points. |
| /datum/sprite_accessory/body_markings/head/tajara/patchy_taj | Companion marking for Tajaran Patches. |
| /datum/sprite_accessory/body_markings/tail/tajara/taj_wingler_stripes | Tiger stripes. |
|---|
| /datum/sprite_accessory/body_markings/head/unathi/banded_una | Companion marking for Unathi Banded. |
|---|---|
| /datum/sprite_accessory/body_markings/head/unathi/snout_narrow_una | Companion marking for Unathi Narrow Belly. |
| /datum/sprite_accessory/body_markings/head/unathi/points_una | Companion marking for Unathi Points. |
| /datum/sprite_accessory/body_markings/head/unathi/sharp/snout_narrow_una_sharp | Companion marking for Unathi Narrow Belly. |
| /datum/sprite_accessory/body_markings/head/vulpkanin/muzzle_vulp | Companion marking for Vulpkanin Belly Alt.. |
|---|---|
| /datum/sprite_accessory/body_markings/head/vulpkanin/muzzle_ears_vulp | Companion marking for Vulpkanin Belly Alt.. |
| /datum/sprite_accessory/body_markings/head/vulpkanin/points_fade_vulp | Companion marking for Vulpkanin Points Fade. |
| /datum/sprite_accessory/body_markings/head/vulpkanin/points_sharp_vulp | Companion marking for Vulpkanin Points Sharp. |
This is a step by step guide for creating a MODsuit theme, skin and module. +This is pretty simple, we go here and add a new definition, let's go with a Psychologist theme as an example. For people that want to see additional stuff, we add an extended description with some more insight into what the suit does. We also set the default skin to usually the theme name, like so. +Next we want to set the statistics, you can view them all in the theme file, so let's just grab our relevant ones, armor, charge and capacity and set them to what we establilished. Now we have a basic theme, it lacks a skin which will be covered in the next section, and an item, which we will add right now. This will create our psychological suit, equipped with a storage and flashlight modules by default. We might also want to make it craftable, in which case we go here and set this. +After that we put it in the techweb or whatever other source we want. Now our suit is almost ready, it just needs a skin. +So, now that we have our theme, we want to add a skin to it (or another theme of our choosing). Let's start with a basis. +We now have a psychological skin, this will apply the psychological icons to every part of the suit. Next we'll be looking at the flags. Boots, gauntlets and the chestplate are usually very standard, we set their thickmaterial and pressureproofness while hiding the jumpsuit on the chestplate. On the helmet however, we'll actually look at its' icon. Otherwise, with an open helmet that becomes closed (like the engineering skin), we'd do this. +There are specific cases of helmets that semi-cover the head, like the cosmohonk, apocryphal and whatnot. You can look at these for more specific suits. So let's say our suit is an open helmet design, and also add an alternate skin with a closed helmet called psychotherapeutic. It'd look something like this. +Thus we finished our codeside. Now we go to the icon files for the suits and simply add our new skin's icons. So, for our psychological suit, let's say we want a module that heals the brain damage of everyone in range. As we want this effect to be on demand, we probably want this to be an usable module. There are four types of modules: +
As we have an usable module, we want to set a cooldown time. All modules are also incompatible with themselves, have a specific power cost and complexity varying on how powerful they are, so let's update our definition, and also add a new variable for how much brain damage we'll heal. +Now, we want to override the on_use proc for our new effect. We want to make sure the use checks passed from parent. You can read about most procs and variables by reading this +After this, we want to put our special code, a basic effect of healing all mobs nearby for their brain damage and creating a beam to them. +We now have a basic module, we can add it to the techwebs to make it printable ingame, and we can add an inbuilt, advanced version of it for our psychological suit. We'll give it more healing power, no complexity and make it unremovable. +Now we want to add it to the psychological theme, which is very simple, finishing with this: +This finishes this hopefully easy to follow along tutorial. You should now know how to make a basic theme, a skin for it, and a module. |
| /obj/item/mod/construction/plating/rescue | I want to add a way to get the rarer modsuit types, that is limited. A low chance for traders to have plating for it seems interesting |
|---|---|
| /obj/item/mod/construction/plating/safeguard | Continued from above, none of these are steal objectives, and only the CE or RD one comes pre-installed with modules. You are getting the protection / speed / looks of these hardsuits, but no special modules. |
| /obj/item/mod/construction/plating/advanced | This may be a bad idea. I think this is an interesting idea. And you still need robotics to build it, and traders can charge as much for it as they want. Also with ones like the CE modsuit, it is the flagship mod. That means it is sold a lot. |
| /obj/item/mod/construction/plating/research | Don't think people will want the RD one though, it is as slow as shit. Anyway, here it is. Surely this will not end poorly. |
| /obj/item/mod | MODsuits, trade-off between armor and utility |
|---|
| /obj/item/mod/core/infinite | Admin only. |
|---|
| /proc/setup_mod_themes | +Global proc that sets up all MOD themes as singletons in a list and returns it. |
|---|---|
| /datum/mod_theme | MODsuit theme, instanced once and then used by MODsuits to grab various statistics. |
| /datum/mod_theme/standard | We don't want the civilian skin to apply to all modsuits, that causes issues. |
| /obj/item/mod/armor/mod_theme_responsory | This has no slowdown active, and no variation between levels. I am ASSUMING this will be gamma only. |
| /obj/item/mod/armor/mod_theme_administrative | considering this should not be used, it's getting just DS armor, not infinity in everything. |
| /obj/item/mod/control/pre_equipped/mining/vendor | visit robotics. |
|---|---|
| /obj/item/mod/control/pre_equipped/mining/asteroid | The asteroid skin, as that one looks more space worthy / older. Good for space ruins. |
| /obj/item/mod/control/pre_equipped/responsory/inquisitory | Diffrent look, as well as magic proof on TG. We don't have the magic proof stuff here, but it's perfect for inqusitors. Or if you want to give your ERT a fancy look. |
| /obj/item/mod/module | MOD Module - A special device installed in a MODsuit allowing the suit to do new stuff. |
|---|---|
| /obj/item/mod/module/anomaly_locked | Anomaly Locked - Causes the module to not function without an anomaly. |
| /obj/item/mod/module/anomaly_locked/kinesis | Kinesis - Gives you the ability to move and launch objects. |
|---|
| /obj/item/mod/module/pathfinder | Pathfinder - Can fly the suit from a long distance to an implant installed in someone. |
|---|
| /obj/item/mod/module/armor_booster | Armor Booster - Grants your suit more armor and speed in exchange for EVA protection. Also acts as a welding screen. |
|---|---|
| /obj/item/mod/module/insignia | Insignia - Gives you a skin specific stripe. |
| /obj/item/mod/module/noslip | Anti Slip - Prevents you from slipping on water. |
| /obj/item/mod/module/power_kick | Power kick - Lets the user launch themselves at someone to kick them. |
| /obj/item/mod/module/plate_compression | Plate Compression - Compresses the suit to normal size |
| /obj/item/mod/module/stealth | Cloaking - Lowers the user's visibility, can be interrupted by being touched or attacked. |
| /obj/item/mod/module/status_readout | Status Readout - Puts a lot of information including health, nutrition, fingerprints, temperature to the suit TGUI. |
| /obj/item/mod/module/ert_camera | Camera Module - Puts a camera in the modsuit that the ERT commander can see |
| /obj/item/mod/module/chameleon | Chameleon - lets the suit disguise as any item that would fit on that slot. |
| /obj/item/mod/module/energy_shield | Energy Shield - Gives you a rechargeable energy shield that nullifies attacks. |
| /obj/item/mod/module/welding | Welding Protection - Makes the helmet protect from flashes and welding. |
|---|---|
| /obj/item/mod/module/t_ray | T-Ray Scan - Scans the terrain for undertile objects. |
| /obj/item/mod/module/magboot | Magnetic Stability - Gives the user a slowdown but makes them negate gravity and be immune to slips. |
| /obj/item/mod/module/rad_protection | Radiation Protection - Gives the user rad info in the ui, currently |
| /obj/item/mod/module/tether | Emergency Tether - Shoots a grappling hook projectile in 0g that throws the user towards it. |
| /obj/item/mod/module/firefighting_tank | Atmos water tank module |
| /obj/item/mod/module/storage | Storage - Adds a storage component to the suit. |
|---|---|
| /obj/item/mod/module/jetpack | Ion Jetpack - Lets the user fly freely through space using battery charge. |
| /obj/item/mod/module/emp_shield | EMP Shield - Protects the suit from EMPs. |
| /obj/item/mod/module/flashlight | Flashlight - Gives the suit a customizable flashlight. |
| /obj/item/mod/module/dispenser | Dispenser - Dispenses an item after a time passes. |
| /obj/item/mod/module/thermal_regulator | Thermal Regulator - Regulates the wearer's core temperature. |
| /obj/item/mod/module/plasma_stabilizer | Plasma Stabilizer - Prevents plasmamen from igniting in the suit |
| /obj/item/mod/module/springlock | Springlock Mechanism - allows your modsuit to activate faster, but reagents are very dangerous. |
|---|---|
| /obj/item/mod/module/balloon | Balloon Blower - Blows a balloon. |
| /obj/item/mod/module/stamp | Stamper - Extends a stamp that can switch between accept/deny modes. |
| /obj/item/mod/module/injector | Injector - Gives the suit an extendable large-capacity piercing syringe. |
|---|---|
| /obj/item/mod/module/defibrillator | Defibrillator - Gives the suit an extendable pair of shock paddles. |
| /obj/item/mod/module/monitor | Crew Monitor - Deploys or retracts a built-in handheld crew monitor |
| /obj/item/mod/module/reagent_scanner | Reagent Scanner - Lets the user scan reagents. |
|---|---|
| /obj/item/mod/module/anomaly_locked/teleporter | Teleporter - Lets the user teleport to a nearby location. |
| /obj/item/mod/module/holster | Holster - Instantly holsters any not huge gun. |
|---|---|
| /obj/item/mod/module/dispenser/mirage | Mirage grenade dispenser - Dispenses grenades that copy the user's appearance. |
| /mob/living/simple_animal/hostile/illusion/mirage | It's just standing there, menacingly |
| /obj/item/mod/module/active_sonar | Active Sonar - Displays a hud circle on the turf of any living creatures in the given radius |
| /obj/item/mod/module/anomaly_locked/firewall | Firewall. Deployable dropwall that lights projectiles on fire. |
| /obj/item/mod/module/anomaly_locked/vortex_shotgun | Vortex arm mounted shotgun. Fucks up reality in front of it, very power draining. Compeating with the vortex arm and stealth armor after all |
| /obj/item/mod/module/anomaly_locked/cryogrenade | Cryogrenade. Freezes foes in place, cools them |
| /obj/item/mod/module/dispenser/smoke | Smoke Grenade Module, its tacticool. |
| /obj/item/mod/module/bikehorn | Bike Horn - Plays a bike horn sound. |
|---|
| /obj/item/mod/module/gps | Internal GPS - Extends a GPS you can use. |
|---|---|
| /obj/item/mod/module/clamp | Hydraulic Clamp - Lets you pick up and drop crates. |
| /obj/item/mod/module/drill | Drill - Lets you dig through rock and basalt. |
| /obj/item/mod/module/orebag | Ore Bag - Lets you pick up ores and drop them from the suit. |
| /obj/item/mod/module/visor | Base Visor - Adds a specific HUD and traits to you. |
|---|
| /datum/feed_network | Singleton that contains all informations related to newscasters (channels, stories). |
|---|---|
| /datum/feed_message | Describes a single feed story. Always owned by a /datum/feed_channel. |
| /datum/feed_channel | Describes a single feed channel. Owns a list of /datum/feed_message. |
| /obj/machinery/newscaster | For all of the crew's news need. Includes reading, submitting and printing stories. |
|---|
| /obj/item/newspaper | A newspaper displaying the stories of all channels contained within. |
|---|
| /obj/structure/filingcabinet/filingcabinet | not changing the path to avoid unecessary map issues, but please don't name stuff like this in the future -Pete |
|---|
| MAX_COPIES_PRINTABLE | Global limit on copied papers and photos, bundles are counted as a sum of their parts |
|---|
+ Global limit on copied papers and photos, bundles are counted as a sum of their parts
| /obj/item/camera_film | film |
|---|---|
| /obj/item/photo | photo |
| /obj/item/storage/photo_album | photo album |
| /obj/item/camera | camera |
| /obj/item/camera/digital | digital camera |
| CAMERA_STATE_COOLDOWN | video camera |
+ video camera
| /datum/picture | AI-specific |
|---|---|
| /obj/item/camera/siliconcam/ai_camera | camera AI can take pictures with |
| /obj/item/camera/siliconcam/robot_camera | camera cyborgs can take pictures with |
| /obj/item/camera/siliconcam/drone_camera | currently doesn't offer the verbs, thus cannot be used |
| /obj/item/cartridge/syndicate/nuclear | needed subtype so regular traitors can't open and close nuclear shuttle doors |
|---|
| /obj/machinery/power/apc/worn_out | |
|---|---|
| /obj/machinery/power/apc/off_station | APC type used for when you don't want the power alarm on the APC to show up on AI reports |
| /obj/machinery/power/apc/off_station/empty_charge | APCs used for ruins, this version also starts devoid of a charge |
| /obj/machinery/power/apc/syndicate | general syndicate access |
| /obj/item/stock_parts/cell/pulse | 200 pulse shots |
|---|---|
| /obj/item/stock_parts/cell/pulse/carbine | 25 pulse shots |
| /obj/item/stock_parts/cell/pulse/pistol | 10 pulse shots |
| /obj/item/stock_parts/cell/emproof/reactive | EMP proof so emp_act does not double dip. |
| /obj/singularity/narsie | Moving narsie to a child object of the singularity so it can be made to function differently. --NEO |
|---|
| /obj/machinery/the_singularitygen | SINGULARITY SPAWNER |
|---|
| EVENT_POWER_PENALTY_THRESHOLD | The cutoff for the minimum amount of power required to trigger the crystal invasion delamination event. |
|---|---|
| SUPERMATTER_ACCENT_SOUND_MIN_COOLDOWN | to prevent accent sounds from layering |
| SUPERMATTER_COLOUR | Colours used for effects. |
| /obj/machinery/atmospherics/supermatter_crystal/shard/hugbox/fakecrystal | Hugbox shard with crystal visuals, used in the Supermatter/Hyperfractal shuttle |
+ The cutoff for the minimum amount of power required to trigger the crystal invasion delamination event.
+ to prevent accent sounds from layering
+ Colours used for effects.
| /obj/singularity/energy_ball | The Tesla engine |
|---|
| /obj/machinery/light_construct | Incomplete light tube fixture |
|---|---|
| /obj/machinery/light_construct/small | Incomplete light bulb fixture |
| /obj/machinery/light | The standard light tube fixture |
| /obj/machinery/light/small | The smaller light bulb fixture |
| /obj/item/light | Parent type of light fittings (Light bulbs, light tubes) |
| /obj/item/light/tube | For use in an empty /obj/machinery/light |
| /obj/item/light/bulb | For use in an empty /obj/machinery/light/small |
Much like any other massive numbers system in SS13, the power (or powernet) system is complex and confusing to work with, only being trumped in complexity by atmospherics/LINDA. This README serves as a powernets 101 guide and breaks down how the system works. +There are two types of powernets in our code +
They are two completely different datum types from eachother and serve different completely different purposes. In a nutshell, regional powernets are dynamically sized and deal with physical machinery, cables, and generators whereas local powernets are statically locked into a single area each and work directly with APCs to handle individual machines interactions with the larger regional powernet. +An inter-area datum which handles 1 continuous set of cables ( On this datum you'll notice a lot of different vars handling power input, output, consumption, demand, etc +Starting in SSmachines,
+
|
| /datum/local_powernet | Manages all power related mechanics for a single /area +Machines in areas will directly register to this datum in order to receive power |
|---|
| /proc/propagate_network | +remove the old powernet and replace it with a new one throughout the network. |
|---|
| /datum/mapGenerator/syndicate/empty | walls and floor only |
|---|
| /obj/item/ammo_casing/energy/laser/cyborg | to balance cyborg energy cost seperately |
|---|---|
| /obj/item/ammo_casing/energy/disabler/cyborg | seperate balancing for cyborg, again |
| /obj/item/ammo_casing/energy/emitter/cyborg/proto | needed a slightly weaker ranged option to give to Safety Overriden borgs. The fire rate is about the same as an emitter if you put it on the ground. |
| /obj/item/ammo_box/magazine/internal | INTERNAL MAGAZINES |
|---|---|
| /obj/item/ammo_box/magazine/m10mm | EXTERNAL MAGAZINES |
| /obj/item/ammo_box/magazine/laser/ert | Used by red ERT. Keeps the size for them |
| /obj/item/gun/projectile/revolver/fingergun | Summoned by the Finger Gun spell, from advanced mimery traitor item |
|---|
| /obj/item/gun/projectile/shotgun/riot | for spawn in the armory |
|---|---|
| /obj/item/gun/projectile/shotgun/automatic/combat/cyborg | Service Malfunction Borg Combat Shotgun Variant |
| /obj/item/gun/syringe/rapidsyringe/preloaded | Version that comes pre-loaded with a given amount of syringes. |
|---|---|
| /obj/item/gun/syringe/rapidsyringe/preloaded/half | Version that comes loaded with half of the standard amount of syringes. Used in the uplink. |
| /obj/item/gun/syringe/rapidsyringe/preloaded/beaker_blaster | For shenanigans. This is essentially an RSG that never needs to be refilled with syringes. |
| /obj/item/gun/syringe/blowgun | craftable bamboo syringe gun |
| /obj/item/projectile/bullet/weakbullet | beanbag, heavy stamina damage |
|---|---|
| /obj/item/projectile/bullet/stunshot | taser slugs for shotguns, nothing special |
| /obj/item/projectile/bullet/mime/fake | ...Rather a large amount of stamina damage. Used in the mime mecha |
| MOVES_HITSCAN | Is this a hitscan projectile or not, if so move like one |
|---|---|
| MUZZLE_EFFECT_PIXEL_INCREMENT | How many pixels to move the muzzle flash up so your character doesn't look like they're shitting out lasers. |
+ Is this a hitscan projectile or not, if so move like one
+ How many pixels to move the muzzle flash up so your character doesn't look like they're shitting out lasers.
| /proc/goonchem_vortex | +Throws or pulls objects to/from a chem reaction |
|---|
| /datum/reagent/medicine/adminordrazine | An OP chemical for admins |
|---|
| /datum/reagent/consumable/ethanol/suicider | otherwise known as "I want to get so smashed my liver gives out and I die from alcohol poisoning". |
|---|---|
| /datum/reagent/consumable/ethanol/bilk | cocktail entities |
| /datum/reagent/consumable/ethanol/dragons_breath | inaccessible to players, but here for admin shennanigans |
| /datum/reagent/consumable/ethanol/bacchus_blessing | An EXTREMELY powerful drink. Smashed in seconds, dead in minutes. |
| /datum/reagent/blob/ripping_tendrils | does brute and a little stamina damage |
|---|---|
| /datum/reagent/blob/boiling_oil | sets you on fire, does burn damage |
| /datum/reagent/blob/envenomed_filaments | toxin, hallucination, and some bonus spore toxin |
| /datum/reagent/blob/lexorin_jelly | does tons of oxygen damage and a little brute |
| /datum/reagent/blob/kinetic | does semi-random brute damage |
| /datum/reagent/blob/cryogenic_liquid | does low burn damage and stamina damage and cools targets down |
| /datum/reagent/rotatium | Rotatium. Fucks up your rotation and is hilarious |
|---|---|
| /proc/phase_filter | +This filter proc makes a visual effect where the object is split into fragments, with vertical lines cut out of them. It will appear as 2 seperate things are made of the one object that was cut out |
| /datum/reagent/consumable | Food Reagents |
|---|---|
| /datum/reagent/consumable/nutriment | Pure nutriment, universally digestable and thus slightly less effective |
| /datum/reagent/consumable/nutriment/protein | Meat-based protein, digestable by carnivores and omnivores, worthless to herbivores |
| /datum/reagent/consumable/nutriment/plantmatter | Plant-based biomatter, digestable by herbivores and omnivores, worthless to carnivores |
| /datum/reagent/questionmark | Food Related, but non-nutritious +food poisoning |
| /datum/reagent/vomit | Vomit |
| /datum/reagent/consumable/entpoly | Lavaland Flora Reagents |
| /datum/reagent/medicine/syndicate_nanites | Used exclusively by Syndicate medical cyborgs |
|---|---|
| /datum/reagent/medicine/earthsblood | Created by ambrosia gaia plants |
| /datum/reagent/jestosterone | Formerly known as Nitrogen tungstide hypochlorite before NT fired the chemists for trying to be funny |
|---|---|
| /datum/reagent/plantnutrient | Hydroponics stuff |
| /datum/reagent/eyenewt | Alchemical Reagents |
| /datum/reagent/beer2 | disguised as normal beer for use by emagged service borgs |
|---|---|
| /datum/reagent/pestkiller | To-Do; make this more realistic. |
| /datum/reagent/teslium | Teslium. Causes periodic shocks, and makes shocks against the target much more effective. |
| /datum/reagent/teslium/blob | This version has it's shocks much less frequently, while retaining the shock multiplier |
| /datum/reagent/fuel/unholywater | if you somehow managed to extract this from someone, dont splash it on yourself and have a smoke |
|---|
| /proc/fire_flash_log | +Flashfire is a proc used to log fire causing chemical reactions. |
|---|
| /datum/reagents | The holder is the datum that holds a list of all reagents +currently in the object. |
|---|---|
| /proc/get_unrestricted_random_reagent_id | +Returns a random reagent ID, with real non blacklisted balance boosting action! |
| /datum/chemical_reaction/sbiten | DRINKS THAT REQUIRED IMPROVED SPRITES BELOW:: -Agouri |
|---|
| /datum/chemical_reaction/cookiedough | Cookies by Ume |
|---|
| /datum/chemical_reaction/phlogiston_fire | This MUST be above the smoke recipe. |
|---|
| /datum/chemical_reaction/pestkiller | To-Do make this more realistic |
|---|
| /obj/item/reagent_containers/applicator/dual/syndi | It magically goes through hardsuits. Don't ask how. |
|---|
| /obj/item/reagent_containers/glass/bottle/traitor | Traitor Poison Bottle |
|---|
| /obj/item/reagent_containers/dropper | Droppers. |
|---|
| /obj/item/reagent_containers/glass | (Mixing)Glass. |
|---|
| /obj/item/reagent_containers/hypospray | MARK: HYPOSPRAY |
|---|---|
| /obj/item/reagent_containers/hypospray/autoinjector/teporone | basilisks |
| /obj/item/reagent_containers/hypospray/autoinjector/stimpack | goliath kiting |
| /obj/item/reagent_containers/iv_bag/blood | Don't use this - just an abstract type to allow blood bags to have a common blood_type var for ease of creation. |
|---|
| /obj/item/reagent_containers/pill | A swallowable pill. Can be dissolved in reagent containers. |
|---|
| /obj/item/reagent_containers/spray/plantbgone | Plant-B-Gone +-- Skie |
|---|---|
| /obj/item/reagent_containers/spray/sticky_tar | Sticky tar spray |
| /obj/item/storage/conveyor | Stores conveyor belts, click floor to make belt, use a conveyor switch on this to link all belts to that lever. |
|---|
| /datum/redis_callback | Callback datum for subscribed redis channel handling |
|---|
| /datum/redis_message | Holder datum for redis messages |
|---|
| /datum/design |
|---|
| /datum/design/freeform_module | AI Module Disks |
|---|
| /datum/design/bucket | Autolathe Designs |
|---|
| /datum/design/milk | Biogenerator Designs |
|---|
| /datum/design/bluespace_crystal | Bluespace |
|---|
| /datum/design/aicore | Computer Boards |
|---|
| /datum/design/exwelder | Equipment |
|---|
| /datum/design/advmop | Janitorial Designs |
|---|
| /datum/design/thermomachine | Machine Boards |
|---|
| /datum/design/ripley_main | Mecha Module Disks |
|---|
| /datum/design/borg_suit | Mecha Designs |
|---|
| /datum/design/adv_reagent_scanner | Medical Tools |
|---|---|
| /datum/design/cyberimp_welding | Cybernetic Implants |
| /datum/design/bio_chip_implanter | Regular Implants |
| /datum/design/drill | Mining |
|---|
| /datum/design/design_disk | Misc Designs |
|---|
| /datum/design/mod_shell | MOD |
|---|
| /datum/design/basic_cell | Power Designs |
|---|
| /datum/design/smelter | SMELTABLE ALLOYS |
|---|
| /datum/design/basic_capacitor | Stock Parts |
|---|
| /datum/design/telecomms_core | Telecomms Equipment |
|---|
| /datum/design/nuclear_gun | Weapons |
|---|
| /datum/research | |
|---|---|
| /datum/research/autolathe/gamma | Gamma Armoury autolathe files |
| /datum/tech | |
| /datum/tech/toxins | not meant to be raised by deconstruction, do not give objects toxins as an origin_tech |
| /obj/item/slime_extract | Slime Extracts |
|---|---|
| /obj/item/slimepotion | Slime-derived potions |
| /datum/outfit/job/centcom/response_team/commander | COMMANDER |
|---|---|
| /datum/outfit/job/centcom/response_team/security | SECURITY |
| /datum/outfit/job/centcom/response_team/engineer | ENGINEER |
| /datum/outfit/job/centcom/response_team/medic | MEDIC |
| /datum/outfit/job/centcom/response_team/paranormal | PARANORMAL |
| /datum/outfit/job/centcom/response_team/janitorial | JANITORIAL |
| /obj/effect/clockwork/overlay/floor/bloodcult | this is used by BLOOD CULT, it shouldn't use such a path... |
|---|---|
| /obj/item/clockwork/alloy_shards/medium/gear_bit/large | gives more power |
| /obj/structure/cursed_slot_machine | Greed's slot machine: Used in the Greed ruin. Deals damage on each use, with a successful use giving a d20 of fate. |
|---|---|
| /obj/effect/gluttony | Gluttony's wall: Used in the Gluttony ruin. Only lets the overweight through. |
| /obj/structure/mirror/magic/pride | Pride's mirror: Used in the Pride ruin. |
| /obj/item/kitchen/knife/envy | Envy's knife: Found in the Envy ruin. Attackers take on the appearance of whoever they strike. |
| /datum/security_level | Security levels |
|---|---|
| /datum/security_level/green | GREEN |
| /datum/security_level/blue | BLUE |
| /datum/security_level/red | RED |
| /datum/security_level/gamma | Gamma |
| /datum/security_level/epsilon | Epsilon |
| /datum/security_level/delta | DELTA |
| /datum/server_command | Datum to handle both sending and receiving of server commands |
|---|
+
The following readme was last updated during Late 2015. The changes between Paradise & TG's shuttle system has diverged greatly since then. Do not take the documentation here's description of differences between tg & paradise seriously without double checking. +This folder belongs to the "shuttle" system. The shuttle system is used to control the +"Shuttles" on the map, which are, at their core, a rectangular area of turfs that "move". +The shuttle system is comprised of two primary files.
+ Shuttles are used for many purposes, including the end of rounds, so it's important to +understand them. +The Docking ports are split into two main types:
A crude ASCII example: +Would be classed by the values It is important to note that bounding boxes are always rectangular. However, shuttles
+are allowed to be any shape they so wish, as anything that matches the This, even though it is not exactly a rectangle, would be classified by the values
+
Would have a Would have a
There are three main differences between -tg-station13's shuttle system and the one in +use on Paradise, and none are very complex. +The biggest modification comes in the form of how docking ports interact with airlocks. +With -tg-station13's base code, any door on the shuttle will be closed, and any door +directly next to the mobile docking port will be closed off of the shuttle. +In Paradise, however, when a mobile docking port undocks from the stationary docking port,
+it will look for any door in the machine list who's In -tg-station13's shuttle system, all docking ports register with the shuttle controller
+on To fix this issue, all docking ports will not initialize automatically on |
| PREVIEW_OR_SHUTTLE_SPAWN_COOLDOWN | We really would rather not have admins altering this, this is the cooldown for the preview/shuttle spawning on the shuttle manipulator |
|---|
+ We really would rather not have admins altering this, this is the cooldown for the preview/shuttle spawning on the shuttle manipulator
| /proc/get_all_linked_levels_zpos | +Proc to get a list of all the linked-together Z-Levels |
|---|
| /datum/point | this is explicitly utilitarian datum type made specially for the space map generation and are absolutely unusable for anything else |
|---|
| /obj/machinery/power/bluespace_tap | A station goal that consumes enormous amounts of power to generate (mostly fluff) rewards |
|---|
|
| /datum/supply_packs/abstract | Abstract supply packs that don't contain any goods, but instead represent purchases that cargo can make. +A supply pack that does not contain physical objects, but instead fires some sort of callback when ordered. |
|---|---|
| /datum/supply_packs/abstract/admin_notify | A sample supply pack that notifies admins when it is purchased, but provides no items. |
| /datum/supply_packs/emergency | Section header - use these to set default supply group and crate type for sections |
|---|
| /datum/supply_packs/engineering/tools | the most robust crate |
|---|
| /datum/supply_packs/misc/paper | Paper Work |
|---|---|
| /datum/supply_packs/misc/janitor | Janitor Supplies |
| /datum/supply_packs/misc/servicecostume | Costumes |
| /datum/supply_packs/misc/formalwear | This is a very classy crate. |
| /datum/supply_packs/misc/teamcolors | For team sports like space polo |
| /datum/supply_packs/misc/polo | For space polo! Or horsehead Quiditch |
| /datum/supply_packs/misc/boxing | For non log spamming cargo brawls! |
| /datum/supply_packs/misc/station_goal | Station Goals |
| /datum/supply_packs/misc/randomised/ingredients | its a bit hacky... |
|---|---|
| /datum/supply_packs/organic/cow | livestock |
| /datum/supply_packs/organic/hydroponics | /// hippy gear +-- Skie |
| /datum/supply_packs/security/helmets | Armor: Basic |
|---|---|
| /datum/supply_packs/security/baton | Weapons: Basic |
| /datum/supply_packs/security/armory | Armory stuff |
| /datum/supply_packs/security/armory/riothelmets | Armor: Specialist |
| /datum/supply_packs/security/armory/ballistic | Weapons: Specialist |
| /datum/supply_packs/security/armory/epistol | costs 3/5ths of the normal e-guns for 3/4ths the total ammo, making it cheaper to arm more people, but less convient for any one person |
| /datum/supply_packs/security/armory/mindshield | Implants & etc |
| /datum/supply_packs/security/officerpack | Starter pack for an officer. Contains everything in a locker but backpack (officer already start with one). Convenient way to equip new officer on highpop. |
| /datum/supply_packs/abstract/shuttle | A "supply pack" that allows for purchasing a custom shuttle. |
|---|---|
| /datum/supply_packs/abstract/admin_notify/donations | Simple supply pack for easy admin modification |
| SURGERY_TOOL_HAND | This file consists of how we manage somewhat non-linear surgeries. +Essentially what goes on here is that we have some "proxy" surgery steps that get inserted into existing surgeries at key points. +Depending on the tool used after that point, the proxy step chooses the next step(s) that should be executed. |
|---|---|
| /datum/surgery/intermediate | A partial surgery that consists of a few steps that may be found in the middle of another operation. +An existing surgery can yield to an intermediate surgery for a few steps by way of a proxy surgery_step. |
| /datum/surgery_step/proxy | Here's the special sauce: a surgery step that can pretend to be a few different surgery steps. +These proxy steps will, depending on the tool that's used, either continue to the next surgery step, or temporarily spin off a new surgery +by adding new steps to the current surgery. |
| /datum/surgery_step/proxy/open_organ | Proxy surgery step to allow healing bleeding, bones, and burns. +Should be added into surgeries just after the first three standard steps. |
| /datum/surgery_step/proxy/ib | Mend IB without healing bones |
| /datum/surgery_step/proxy/robotics/repair_limb | The robotic equivalent |
+ This file consists of how we manage somewhat non-linear surgeries. +Essentially what goes on here is that we have some "proxy" surgery steps that get inserted into existing surgeries at key points. +Depending on the tool used after that point, the proxy step chooses the next step(s) that should be executed.
+These proxy steps use a list of surgeries, so a full procedure can be inserted into an existing surgery. Just make sure that the user's state +after an intermediate surgery is (in the context of the surgery) identical to before the intermediate surgery. Don't heal things that will +need to be healed during the surgery, for example.
+Adding a new intermediate surgery:
+| /datum/surgery/bone_repair | Surgery Datums |
|---|
| /obj/item/organ/internal/cyberimp/arm/janitorial/advanced | ERT implant, i dont overly expect this to get into the hands of crew |
|---|---|
| /obj/item/organ/internal/cyberimp/arm/janitorial/advanced/l | its for ERT, but still probably a good idea. |
| EXOTIC_BLEED_MULTIPLIER | BLOOD SYSTEM |
|---|
+ BLOOD SYSTEM
| /datum/organ/heart/always_beating | A subtype that is always beating. Abductor glands and demon hearts use this. |
|---|
| /obj/item/organ/external | EXTERNAL ORGANS |
|---|
| /obj/item/organ_extractor/abductor | Advanced abductor version. Is a lot faster with implanting into others |
|---|
| /obj/item/organ/internal/heart/diona | Turns into a nymph instantly, no transplanting possible. |
|---|---|
| /obj/item/organ/internal/brain/diona | Turns into a nymph instantly, no transplanting possible. |
| /obj/item/organ/internal/kidneys/diona | Turns into a nymph instantly, no transplanting possible. |
| /obj/item/organ/internal/appendix/diona | Turns into a nymph instantly, no transplanting possible. |
| /obj/item/organ/internal/eyes/diona | Turns into a nymph instantly, no transplanting possible. |
| /obj/item/organ/internal/liver/diona | Turns into a nymph instantly, no transplanting possible. |
| /obj/item/organ/external/chest | ORGAN DEFINES |
|---|
| /obj/item/organ/internal/eyes/tajaran/farwa | Being the lesser form of Tajara, Farwas have an utterly incurable version of their colourblindness. |
|---|
| /obj/item/organ/internal/eyes/vulpkanin/wolpin | Being the lesser form of Vulpkanin, Wolpins have an utterly incurable version of their colourblindness. |
|---|
| /obj/item/organ/internal/vocal_cords | organs that are activated through speech with the :x channel |
|---|
| GHETTO_DISINFECT_AMOUNT | Amount of units to transfer from the container to the organs during disinfection step. |
|---|---|
| MITO_REVIVAL_COST | Amount of mito necessary to revive an organ |
| /datum/surgery_step/proxy/manipulate_organs | The surgery step to trigger this whole situation |
+ Amount of units to transfer from the container to the organs during disinfection step.
+ Amount of mito necessary to revive an organ
| /datum/surgery_step/fix_dead_tissue | Debridement |
|---|
| /datum/surgery | Datum Surgery Helpers |
|---|---|
| /proc/spread_germs_to_organ | +Spread some nasty germs to an organ. |
| /proc/spread_germs_by_incision | +Spread germs directly from a tool. |
| /obj/item/scalpel/laser | parent type |
|---|---|
| /obj/item/scalpel/laser/laser1 | lasers also count as catuarys |
| /obj/item/scalpel/laser/manager | super tool! Retractor/hemostat |
| /obj/item/gps | A small item that reports its current location. Has a tag to help distinguish between them. |
|---|
| /obj/item/rcs | Used to teleport crates and closets to cargo telepads. |
|---|
| /obj/machinery/telepad | SCI TELEPAD |
|---|---|
| /obj/item/telepad_beacon | TELEPAD CALLER |
This folder should be placed on it's own inside a codebase that wishes to use the TGS DMAPI. Warranty void if modified. +
APIs communicate with TGS in two ways. All versions implement TGS -> DM communication using /world/Topic. DM -> TGS communication, called the bridge method, is different for each version. |
This folder contains all DMAPI code not directly involved in an API. +
|
This DMAPI implements bridge using file output which TGS monitors for. +
|
This DMAPI implements bridge requests using file output which TGS monitors for. It has a safe mode restriction. +
|
This DMAPI implements bridge requests using HTTP GET requests to TGS. It has no security restrictions. +
|
| /proc/tgui_Topic | +Middleware for /client/Topic. |
|---|
| /datum/ui_module/ghost_hud_panel | Allows ghosts to view a TGUI window which contains toggles for all HUD types available to them. |
|---|
| /datum/ui_modal | Modal datum (contains base information for a modal) |
|---|---|
| /datum/ui_modal/input | Input modal - has a text entry that can be used to enter an answer |
| /datum/ui_modal/input/choice | Choice modal - has a dropdown menu that can be used to select an answer |
| /datum/ui_modal/input/bento | Bento modal - Similar to choice, it displays the choices in a grid of images |
| /datum/ui_modal/boolean | Boolean modal - has yes/no buttons that do different actions depending on which is pressed |
| /datum/ui_login | Login state (there should be only one for one datum) |
|---|
Copyright (c) 2020 Aleksej Komarov +SPDX-License-Identifier: MIT |
Copyright (c) 2020 Aleksej Komarov +SPDX-License-Identifier: MIT |
Copyright (c) 2020 Aleksej Komarov +SPDX-License-Identifier: MIT |
Copyright (c) 2020 Aleksej Komarov +SPDX-License-Identifier: MIT |
Copyright (c) 2020 Aleksej Komarov +SPDX-License-Identifier: MIT |
Copyright (c) 2020 Aleksej Komarov +SPDX-License-Identifier: MIT |
Copyright (c) 2020 Aleksej Komarov +SPDX-License-Identifier: MIT |
Copyright (c) 2020 Aleksej Komarov +SPDX-License-Identifier: MIT |
Copyright (c) 2020 Aleksej Komarov +SPDX-License-Identifier: MIT |
Copyright (c) 2020 Aleksej Komarov +SPDX-License-Identifier: MIT |
| /datum/tgui | Copyright (c) 2020 Aleksej Komarov +SPDX-License-Identifier: MIT |
|---|
| /proc/tgui_alert | +Creates a TGUI alert window and returns the user's response. |
|---|---|
| /datum/tgui_alert | Datum used for instantiating and using a TGUI-controlled modal that prompts the user with +a message and has buttons for responses. |
| /proc/tgui_input_list | +Creates a TGUI input list window and returns the user's response. |
|---|---|
| /datum/tgui_list_input | Client does NOT have tgui_input on: Returns regular input |
| /proc/tgui_input_number | +Creates a TGUI window with a number input. Returns the user's response as num | null. |
|---|---|
| /datum/tgui_input_number | Datum used for instantiating and using a TGUI-controlled number input that prompts the user with +a message and has an input for number entry. |
| /proc/tgui_input_text | +Creates a TGUI window with a text input. Returns the user's response. |
|---|---|
| /datum/tgui_input_text | tgui_input_text |
/TG/ Chat, which will be referred to as TgChat from this point onwards, is a system in which we can send messages to clients in a controlled and semi-reliable manner. The standard way of sending messages to BYOND clients simply dumps whatever you output to them directly into their chat window, however BYOND allows us to load our own code on the client to change this behaviour in a way that allows us to do some pretty neat things. +TgChat handles sending messages from the server to the client through the use of JSON payloads, of which the format will change depending on the type of message and the intended client endpoint. An example of the payload for chat messages is as follows: +In the past there have been issues where BYOND will silently and without reason lose a message we sent to the client, to detect this and recover from it seamlessly TgChat also has a baked in reliability layer. This reliability layer is very primitive, and simply keeps track of received sequence numbers. Should the client receive an unexpected sequence number TgChat asks the server to resend any missing packets. +TgChat supports a round trip time ping measurement, which is displayed to the client so they can know how long it takes for their commands and inputs to reach the server. This is done by sending the client a ping request, To make organizing and managing chat easier and more functional for both players and admins, TgChat has the ability to filter out messages based on their primary tag, such as individual departmental radios, to a dedicated chat tab for easier reading and comprehension. These tabs can also be configured to highlist messages based on a simple keyword search. You can set a multitude of different keywords to search for and they will be highlighting for instant alerting of the client. Said tabs, highlighting rules, and your chat history will persist thanks to use of local storage on the client. Using local storage TgChat can ensure that your preferences are saved and maintained between client restarts and switching between other /TG/ servers. Local Storage is also used to keep your chat history aswell, should you need to scroll through your chat logs. |
| TGUI_TELEMETRY_MAX_CONNECTIONS | Copyright (c) 2020 Aleksej Komarov +SPDX-License-Identifier: MIT |
|---|---|
| TGUI_TELEMETRY_RESPONSE_WINDOW | Maximum time allocated for sending a telemetry packet. |
+ Copyright (c) 2020 Aleksej Komarov +SPDX-License-Identifier: MIT
+Maximum number of connection records allowed to analyze. +Should match the value set in the browser.
+ Maximum time allocated for sending a telemetry packet.
| /datum/tgui_panel | Copyright (c) 2020 Aleksej Komarov +SPDX-License-Identifier: MIT |
|---|
| /proc/message_to_html | +Message-related procs |
|---|
Copyright (c) 2020 Aleksej Komarov +SPDX-License-Identifier: MIT | |
| /proc/to_chat_immediate | +Circumvents the message queue and sends the message to the recipient (target) as soon as possible. +trailing_newline, confidential, and handle_whitespace currently have no effect, please fix this in the future or remove the arguments to lower cache! |
|---|---|
| /proc/to_chat | +Sends the message to the recipient (target). |
| /datum/tgui_window | Copyright (c) 2020 Aleksej Komarov +SPDX-License-Identifier: MIT |
|---|
| /datum/tgui_say | The tgui say modal. This initializes an input window which hides until +the user presses one of the speech hotkeys. Once something is entered, it will +delegate the speech to the proper channel. |
|---|
Vars | |
| cached_ref | A cached version of our \ref +The brunt of \ref costs are in creating entries in the string tree (a tree of immutable strings) +This avoids doing that more then once per datum by ensuring ref strings always have a reference to them after they're first pulled |
|---|---|
| isprocessing | Used by SSprocessing |
| status_traits | Status traits attached to this datum |
| tgui_shared_states | global |
Procs | |
| CanProcCall | Proc to check if a datum allows proc calls on it |
| GetComponent | Return any component assigned to this datum of the given type |
| GetComponents | Get all components of a given type that are attached to this datum |
| GetExactComponent | Return any component assigned to this datum of the exact given type |
| LoadComponent | Get existing component of type, or create it and return a reference to it |
| RegisterSignal | Register to listen for a signal from the passed in target |
| RegisterSignals | Registers multiple signals to the same proc. |
| TakeComponent | Transfer this component to another parent |
| TransferComponent | Transfer a single component from the source datum, to the target. |
| TransferComponents | Transfer all components to target |
| UID | Gets or creates the UID of a datum |
| UnregisterSignal | Stop listening to a given signal from target |
| _AddComponent | Creates an instance of new_type in the datum and attaches to it as parent |
| _AddElement | Finds the singleton for the element type given and attaches it to src |
| _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 |
| p_they | These are generally cheaper than looping contents so they go first |
| signal_qdel | |
| string_assoc_list | Caches associative lists with non-numeric stringify-able index keys and stringify-able values (text/typepath -> text/path/number). |
| ui_act | public |
| ui_assets | public |
| ui_close | public |
| ui_data | public |
| ui_host | private |
| ui_interact | External tgui definitions, such as src_object APIs. |
| ui_modal_act | Call this from a proc that is called in ui_act() to process modal actions |
| ui_modal_answer | Calls the source's currently assigned modal's (if there is one) on_answer() proc. Private. |
| ui_modal_bento | Opens a bento input UI modal |
| ui_modal_boolean | Opens a yes/no UI modal |
| ui_modal_choice | Opens a dropdown input UI modal |
| ui_modal_clear | Clears the current modal for a given datum |
| ui_modal_data | Call this from ui_data() to return modal information if needed |
| ui_modal_input | Opens a text input UI modal |
| ui_modal_message | Opens a message UI modal |
| ui_modal_new | Registers a given modal to a source. Private. |
| ui_modal_preprocess_answer | Passes an answer from JS through the modal's proc. |
| ui_state | private |
| ui_static_data | public |
| ui_status | Base state and helpers for states. Just does some sanity checks, +implement a proper state for in-depth checks. |
| update_static_data | public |
A cached version of our \ref +The brunt of \ref costs are in creating entries in the string tree (a tree of immutable strings) +This avoids doing that more then once per datum by ensuring ref strings always have a reference to them after they're first pulled
Used by SSprocessing
Status traits attached to this datum
global
+Associative list of JSON-encoded shared states that were set by +tgui clients.
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
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:
+Get all components of a given type that are attached to this datum
+Arguments:
+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:
+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:
+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:
+Registers multiple signals to the same proc.
Transfer this component to another parent
+Component is taken from source datum
+Arguments:
+Transfer a single component from the source datum, to the target.
+Arguments:
+Transfer all components to target
+All components from source datum are taken
+Arguments:
+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
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:
+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
Finds the singleton for the element type given and attaches it to src
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
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
These are generally cheaper than looping contents so they go first
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_PARENT_QDELETING, TYPE_PROC_REF(/datum, signal_qdel))
Caches associative lists with non-numeric stringify-able index keys and stringify-able values (text/typepath -> text/path/number).
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.
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.
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
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.
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.
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.
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:
+Calls the source's currently assigned modal's (if there is one) on_answer() proc. Private.
+Arguments:
+Opens a bento input UI modal
+Internally checks if the answer is in the list of choices. +Arguments:
+Opens a yes/no UI modal
+Arguments:
+Opens a dropdown input UI modal
+Internally checks if the answer is in the list of choices. +Arguments:
+Clears the current modal for a given datum
+Arguments:
+Call this from ui_data() to return modal information if needed
+Arguments:
+Opens a text input UI modal
+Arguments:
+Opens a message UI modal
+Arguments:
+Registers a given modal to a source. Private.
+Arguments:
+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:
+private
+The UI's state controller to be used for created uis +This is a proc over a var for memory reasons
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.
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.
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
Vars | |
| default_button_position | Where any buttons we create should be by default. Accepts screen_loc and location defines |
|---|---|
| show_to_observers | Whether or not this will be shown to observers |
| viewers | Map of huds viewing a button with our action -> their button |
Where any buttons we create should be by default. Accepts screen_loc and location defines
Whether or not this will be shown to observers
Map of huds viewing a button with our action -> their button
Vars | |
| active | If this power is active or not. Used for toggleable abilities. |
|---|---|
| bypass_fake_death | If this power can be used while the changeling has the TRAIT_FAKEDEATH trait. |
| category | Datum path used to determine the location and name of the power in changeling evolution menu UI |
| chemical_cost | Chemical cost to use this power. |
| cling | A reference to the changeling's changeling antag datum. |
| dna_cost | The cost of purchasing the power. |
| helptext | A description of what the power does. |
| power_type | Determines whether the power is always given to the changeling or if it must be purchased. |
| req_dna | The amount of victims the changeling needs to absorb before they can use this power. Changelings always start with a value of 1. |
| req_human | If you need to be in human form to activate this power. |
| req_stat | What stat value the changeling needs to have to use this power. Will be CONSCIOUS, UNCONSCIOUS or DEAD. |
If this power is active or not. Used for toggleable abilities.
If this power can be used while the changeling has the TRAIT_FAKEDEATH trait.
Datum path used to determine the location and name of the power in changeling evolution menu UI
Chemical cost to use this power.
A reference to the changeling's changeling antag datum.
The cost of purchasing the power.
A description of what the power does.
Determines whether the power is always given to the changeling or if it must be purchased.
The amount of victims the changeling needs to absorb before they can use this power. Changelings always start with a value of 1.
If you need to be in human form to activate this power.
What stat value the changeling needs to have to use this power. Will be CONSCIOUS, UNCONSCIOUS or DEAD.
Vars | |
| current_hand | Current hand given to human, null is we did not give hand, object if hand is given |
|---|---|
| hand | Type of acid hand we give to person |
Current hand given to human, null is we did not give hand, object if hand is given
Type of acid hand we give to person
Vars | |
| is_active | is ability active (we are invisible)? |
|---|---|
| recharge_slowdown | How much we slow chemical regeneration while active, in chems per second |
is ability active (we are invisible)?
How much we slow chemical regeneration while active, in chems per second
Vars | |
| ability_tabs | A list containing lists of category and abilities, related to this category. For each ability includes its name, description, helptext and cost. For use with the UI. |
|---|---|
| purchased_abilities | A list containing the typepaths of bought changeling abilities. For use with the UI. |
| view_mode | Which UI view will be displayed. Compact mode will show only power names, and will leave out their descriptions and helptext. |
A list containing lists of category and abilities, related to this category. For each ability includes its name, description, helptext and cost. For use with the UI.
A list containing the typepaths of bought changeling abilities. For use with the UI.
Which UI view will be displayed. Compact mode will show only power names, and will leave out their descriptions and helptext.
Vars | |
| is_operating | Checks if changeling is already spawning a spider |
|---|---|
| spider_counter | This var keeps track of the changeling's spider count |
Procs | |
| sting_action | Makes a spider. Good for setting traps and combat. |
Checks if changeling is already spawning a spider
This var keeps track of the changeling's spider count
Makes a spider. Good for setting traps and combat.
Vars | |
| click_override | A middle click override used to intercept changeling stings performed on a target. |
|---|---|
A middle click override used to intercept changeling stings performed on a target.
Vars | |
| recharge_slowdown | How much does the chemical recharge rate get reduced by having this weapon out? |
|---|---|
How much does the chemical recharge rate get reduced by having this weapon out?
Allows the guardian host to exchange their guardian's player for another.
Procs | |
| reset_cooldown | Takes the action button off cooldown and makes it available again. |
|---|---|
Takes the action button off cooldown and makes it available again.
Procs | |
| emerge | Removes moth from cocoon, restores burnt wings |
|---|---|
Removes moth from cocoon, restores burnt wings
The next generation of talismans, handles storage/creation of blood magic
Vars | |
| positioned | Have we already been positioned into our starting location? |
|---|---|
Have we already been positioned into our starting location?
Vars | |
| chosen_attack_num | The internal attack ID for the elite's OpenFire() proc to use |
|---|---|
| chosen_message | The displayed message into chat when this attack is selected |
The internal attack ID for the elite's OpenFire() proc to use
The displayed message into chat when this attack is selected
Vars | |
| on_cooldown | If TRUE, the box can't be deployed |
|---|---|
If TRUE, the box can't be deployed
Vars | |
| ready | First time clicking this will set it to TRUE, second time will activate it. |
|---|---|
Procs | |
| reset_ready | Resets the state requiring to be doubleclicked again. |
First time clicking this will set it to TRUE, second time will activate it.
Resets the state requiring to be doubleclicked again.
Vars | |
| module | Module we are linked to. |
|---|---|
| pinner_uid | A ref to the mob we are pinned to. |
Module we are linked to.
A ref to the mob we are pinned to.
Vars | |
| recall_cooldown | The cooldown for the recall. |
|---|---|
The cooldown for the recall.
Vars | |
| injection_amount | Keeps track of how much mephedrone we inject into people on activation |
|---|---|
Keeps track of how much mephedrone we inject into people on activation
Vars | |
| actions | The action buttons we're managing |
|---|---|
| column_max | Max amount of buttons we can have per row +Indexes at 1 |
| landing | Our landing screen object |
| location | The screen location we go by |
| max_rows | How many rows of actions we can have at max before we just stop hiding +Indexes at 1 |
| north_offset | The initial vertical offset of our action buttons |
| owner | The hud we're owned by |
| pixel_horiz_offset | The pixel horizontal offset of our action buttons |
| pixel_north_offset | The pixel vertical offset of our action buttons |
| row_offset | How far "ahead" of the first row we start. Lets us "scroll" our rows +Indexes at 1 |
Procs | |
| ButtonNumberToScreenCoords | Accepts a number represeting our position in the group, indexes at 0 to make the math nicer |
| clear_landing | Clears any landing objects we may currently have |
| generate_landing | Generates a landing object that can be dropped on to join this group |
| size | Returns the amount of objects we're storing at the moment |
The action buttons we're managing
Max amount of buttons we can have per row +Indexes at 1
Our landing screen object
The screen location we go by
How many rows of actions we can have at max before we just stop hiding +Indexes at 1
The initial vertical offset of our action buttons
The hud we're owned by
The pixel horizontal offset of our action buttons
The pixel vertical offset of our action buttons
How far "ahead" of the first row we start. Lets us "scroll" our rows +Indexes at 1
Accepts a number represeting our position in the group, indexes at 0 to make the math nicer
Clears any landing objects we may currently have
Generates a landing object that can be dropped on to join this group
Returns the amount of objects we're storing at the moment
Vars | |
| href_token | Unique-to-session randomly generated token given to each admin to help add detail to logs on admin interactions with hrefs |
|---|---|
| marked_datum | Our currently linked marked datum |
| rights | Bitflag containing the current rights this admin holder is assigned to |
| team_switch_tab_index | Our index into GLOB.antagonist_teams, so that admins can have pretty tabs in the Check Teams menu. |
Procs | |
| ccbdb_lookup_callback | CCBDB Lookup Callback |
| check_teams | Opens a window which lists the teams for the round. |
| create_ccbdb_lookup | CCBDB Lookup Initiator |
| list_teams | Returns HTML content for the "check teams" window. |
| modify_traits | Allow admin to add or remove traits of datum |
| restart | admins2.dm merge |
| show_player_panel | Panels |
| station_traits_panel | Opens the station traits admin panel |
Unique-to-session randomly generated token given to each admin to help add detail to logs on admin interactions with hrefs
Our currently linked marked datum
Bitflag containing the current rights this admin holder is assigned to
Our index into GLOB.antagonist_teams, so that admins can have pretty tabs in the Check Teams menu.
CCBDB Lookup Callback
+Callback assigned in /datum/admins/proc/create_ccbdb_lookup for async operations without a sleep()
+Arguments:
+Opens a window which lists the teams for the round.
CCBDB Lookup Initiator
+Checks the configuration before invoking the request to the CCBDB server.
+Arguments:
+Returns HTML content for the "check teams" window.
Allow admin to add or remove traits of datum
admins2.dm merge
Panels
Opens the station traits admin panel
Vars | |
| unique_ai | Is this lawset used by the unique ai trait? |
|---|---|
Procs | |
| clear_zeroth_laws | Clear Laws |
| delete_law | Remove Laws |
| get_state_law | Stating Laws |
| set_state_law | Set |
| set_zeroth_law | Add Laws |
Is this lawset used by the unique ai trait?
Clear Laws
Remove Laws
Stating Laws
+Get
Set
Add Laws
Vars | |
| add_log | Whether or not to log the announcement when made. |
|---|---|
| global_announcement | Global announcements are received regardless of being in range of a +radio, unless you're in the lobby, to prevent metagaming. |
| log_name | The name used when describing the announcement type in logs. |
| sound | What sound to play when the announcement is made. |
| style | A CSS class name. |
Whether or not to log the announcement when made.
Global announcements are received regardless of being in range of a +radio, unless you're in the lobby, to prevent metagaming.
The name used when describing the announcement type in logs.
What sound to play when the announcement is made.
A CSS class name.
Vars | |
| author | The name used to sign off on announcements. |
|---|---|
The name used to sign off on announcements.
Vars | |
| antag_datum_blacklist | List of other antag datum types that this type can't coexist with. |
|---|---|
| antag_hud_name | Holds the name of the hud's icon in the .dmi files, i.e "hudtraitor", "hudvampire", etc. |
| antag_hud_type | Holds the type of antagonist hud this datum will get, i.e. ANTAG_HUD_TRAITOR, ANTAG_HUD_VAMPIRE, etc. |
| antag_memory | Antagonist datum specific information that appears in the player's notes. Information stored here will be removed when the datum is removed from the player. |
| blurb_font | Intro Blurb Font |
| blurb_text_color | Intro Blurbs text colour |
| blurb_text_outline_width | Intro Blurbs outline width |
| clown_gain_text | If the owner is a clown, this text will be displayed to them when they gain this datum. |
| clown_removal_text | If the owner is a clown, this text will be displayed to them when they lose this datum. |
| clown_text_span_class | The spawn class to use for gain/removal clown text |
| give_objectives | Should we automatically give this antagonist objectives upon them gaining the datum? |
| job_rank | Used to determine if the player jobbanned from this role. Things like SPECIAL_ROLE_TRAITOR should go here to determine the role. |
| name | The name of the antagonist. |
| objective_holder | List of objectives connected to this datum. |
| owner | Mind that owns this datum. |
| replace_banned | Should we replace the role-banned player with a ghost? |
| roundend_category | Section of roundend report, datums with same category will be displayed together, also default header for the section. |
| show_in_roundend | Set to false to hide the antagonists from roundend report. |
| silent | Should the owner mob get a greeting text? Determines whether or not the greet() proc is called. |
| special_role | The special role that will be applied to the owner's special_role var. i.e. SPECIAL_ROLE_TRAITOR, SPECIAL_ROLE_VAMPIRE. |
| wiki_page_name | The url page name for this antagonist, appended to the end of the wiki url in the form of: [GLOB.configuration.url.wiki_url]/index.php/[wiki_page_name] |
Procs | |
| add_antag_hud | Adds this datum's antag hud to antag_mob. |
| add_antag_objective | Create and add an objective of the given type. |
| add_owner_to_gamemode | Adds the owner to their respective gamemode's list. For example SSticker.mode.traitors |= owner. |
| apply_innate_effects | This handles the application of antag huds/special abilities. |
| can_be_owned | Loops through the owner's antag_datums list and determines if this one is blacklisted by any others. |
| create_team | Creates a new antagonist team. |
| custom_blurb | This is the custom blurb message used on login for an antagonist. |
| detach_from_owner | Removes owner's dependencies on this antag datum.
+For example: removal of antag datum from owner's antag_datums, antag datum related teams etc.
+If your /datum/antagonist subtype adds more dependencies on owner - they should be cleared there. |
| farewell | Displays a message to the antag mob while the datum is being deleted, i.e. "Your powers are gone and you're no longer a vampire!" |
| finalize_antag | Give the antag any final information or items. |
| get_antag_objectives | Get all of this antagonist's objectives, including from the team. |
| get_team | Returns the team the antagonist belongs to, if any. |
| give_objectives | Give the antagonist their objectives. Base proc, override as needed. |
| greet | Displays a message and their objectives to the antag mob after the datum is added to them, i.e. "Greetings you are a traitor! etc. |
| handle_clown_mutation | Handles adding and removing the clumsy mutation from clown antags. |
| has_antag_objectives | Do we have any objectives at all, including from a team. +Faster than get_antag_objectives() |
| is_banned | Checks if the person trying to receive this datum is role banned from it. |
| on_body_transfer | Removes antagonist datum effects from the old body and applies it to the new one. |
| on_gain | Proc called when the datum is given to a mind. |
| remove_antag_hud | Removes this datum's antag hud from antag_mob. |
| remove_antag_objective | Complement to add_antag_objective that removes the objective. +Currently unused. |
| remove_innate_effects | This handles the removal of antag huds/special abilities. |
| remove_owner_from_gamemode | Removes the owner from their respective gamemode's list. For example SSticker.mode.traitors -= owner. |
| replace_banned_player | Attempts to replace the role banned antag with a ghost player. |
| restore_last_hud_and_role | Re-sets the antag hud and special_role of the owner to that of the previous antag datum they had before this one was added. |
List of other antag datum types that this type can't coexist with.
Holds the name of the hud's icon in the .dmi files, i.e "hudtraitor", "hudvampire", etc.
Holds the type of antagonist hud this datum will get, i.e. ANTAG_HUD_TRAITOR, ANTAG_HUD_VAMPIRE, etc.
Antagonist datum specific information that appears in the player's notes. Information stored here will be removed when the datum is removed from the player.
Intro Blurb Font
Intro Blurbs text colour
Intro Blurbs outline width
If the owner is a clown, this text will be displayed to them when they gain this datum.
If the owner is a clown, this text will be displayed to them when they lose this datum.
The spawn class to use for gain/removal clown text
Should we automatically give this antagonist objectives upon them gaining the datum?
Used to determine if the player jobbanned from this role. Things like SPECIAL_ROLE_TRAITOR should go here to determine the role.
The name of the antagonist.
List of objectives connected to this datum.
Mind that owns this datum.
Should we replace the role-banned player with a ghost?
Section of roundend report, datums with same category will be displayed together, also default header for the section.
Set to false to hide the antagonists from roundend report.
Should the owner mob get a greeting text? Determines whether or not the greet() proc is called.
The special role that will be applied to the owner's special_role var. i.e. SPECIAL_ROLE_TRAITOR, SPECIAL_ROLE_VAMPIRE.
The url page name for this antagonist, appended to the end of the wiki url in the form of: [GLOB.configuration.url.wiki_url]/index.php/[wiki_page_name]
Adds this datum's antag hud to antag_mob.
Arguments:
+Create and add an objective of the given type.
+If the given objective type needs a target, it will try to find a target which isn't already the target of different objective for this antag. +If one cannot be found, it tries one more time. If one still cannot be found, it will be added as a "Free Objective" without a target.
+Arguments:
+New() procAdds the owner to their respective gamemode's list. For example SSticker.mode.traitors |= owner.
This handles the application of antag huds/special abilities.
+Gives the antag mob their assigned hud. +If they're a clown, removes their clumsy mutataion.
+Arguments:
+Loops through the owner's antag_datums list and determines if this one is blacklisted by any others.
If it's in one of their blacklists, return FALSE. It cannot coexist with the datum we're trying to add here.
Creates a new antagonist team.
This is the custom blurb message used on login for an antagonist.
Removes owner's dependencies on this antag datum.
+For example: removal of antag datum from owner's antag_datums, antag datum related teams etc.
+If your /datum/antagonist subtype adds more dependencies on owner - they should be cleared there.
Displays a message to the antag mob while the datum is being deleted, i.e. "Your powers are gone and you're no longer a vampire!"
+Called in on_removal() if silent is set to FALSE.
Give the antag any final information or items.
Get all of this antagonist's objectives, including from the team.
Returns the team the antagonist belongs to, if any.
Give the antagonist their objectives. Base proc, override as needed.
Displays a message and their objectives to the antag mob after the datum is added to them, i.e. "Greetings you are a traitor! etc.
+Called in on_gain() if silent it set to FALSE.
Handles adding and removing the clumsy mutation from clown antags.
+Arguments:
+Do we have any objectives at all, including from a team. +Faster than get_antag_objectives()
Checks if the person trying to receive this datum is role banned from it.
Removes antagonist datum effects from the old body and applies it to the new one.
+Called in the/datum/mind/proc/transfer_to().
Arguments:
+Proc called when the datum is given to a mind.
Removes this datum's antag hud from antag_mob.
Arguments:
+Complement to add_antag_objective that removes the objective. +Currently unused.
This handles the removal of antag huds/special abilities.
+Removes the antag's assigned hud. +If they're a clown, gives them back their clumsy mutataion.
+Arguments:
+Removes the owner from their respective gamemode's list. For example SSticker.mode.traitors -= owner.
Attempts to replace the role banned antag with a ghost player.
Re-sets the antag hud and special_role of the owner to that of the previous antag datum they had before this one was added.
For example, if the owner has a traitor datum and a vampire datum, both at index 1 and 2 respectively, +After the vampire datum gets removed, it sets the owner's antag hud/role to whatever is set for traitor datum.
Vars | |
| absorbed_count | Number of victims the changeling has absorbed. |
|---|---|
| absorbed_dna | List of /datum/dna which have been absorbed through the DNA sting or absorb power. |
| absorbed_languages | List of /datum/language UIDs, learned from absorbed victims. |
| acquired_powers | A list of instanced /datum/action/changeling the changeling has aquired. |
| can_respec | If the changeling can respec their purchased abilities. |
| changelingID | The changeling's identifier when speaking in the hivemind, i.e. "Mr. Delta 123". |
| chem_charges | The current amount of chemicals the changeling has stored. |
| chem_recharge_rate | The amount of chemicals that recharges per Life() call. |
| chem_recharge_slowdown | Amount of chemical recharge slowdown, calculated as chem_recharge_rate - chem_recharge_slowdown |
| chem_storage | The total amount of chemicals able to be stored. |
| chosen_sting | The current sting power the changeling has active. |
| dna_max | How many total DNA strands the changeling can store for transformation. |
| genetic_points | The amount of points available to purchase changeling abilities. |
| innate_powers | A list of /datum/action/changeling typepaths with a power_type of CHANGELING_INNATE_POWER. |
| is_absorbing | If the changeling is in the process of absorbing someone. |
| mimicing | A name that will display in place of the changeling's real name when speaking. |
| protected_dna | List of /datum/dna which are not lost when the changeling has no more room for DNA. |
| purchaseable_powers | A list of /datum/action/changeling typepaths with a power_type of CHANGELING_PURCHASABLE_POWER. |
| regenerating | If the changeling is in the process of regenerating from their fake death. |
| sting_range | The range of changeling stings. |
Procs | |
| absorb_dna | Absorb the the target's DNA and their languages. |
| add_new_languages | Store the languages from the new_languages list into the absorbed_languages list. Teaches the changeling the new languages. |
| can_absorb_dna | Returns TRUE if the changeling can absorb the target mob's DNA. |
| get_dna | Gets a /datum/dna that matches the passed in tDNA. Also used as a check to see if the changeling has this DNA already stored. |
| get_powers_of_type | Gets a list of changeling action typepaths based on the passed in power_type. |
| give_power | Gives the changeling the passed in power. Subtracts the cost of the power from our genetic points. |
| remove_changeling_powers | Removes a changeling's abilities. |
| remove_specific_power | Removes all power_type abilities that the changeling has. Refunds the cost of the power from our genetic points. |
| remove_unnatural_languages | Removes all the languages the mob L has absorbed throughout their life as a changeling and should no longer have. |
| respec | Resets a changeling to the point they were when they first became a changeling, i.e no genetic points to spend, no non-innate powers, etc. |
| select_dna | Prompt the changeling with a list of names associated with their stored DNA. Return a /datum/dna based on the name chosen. |
| store_dna | Store the target DNA. If the DNA belongs to one of the changeling's "escape with identity" objectives, make the DNA protected. |
| trim_dna | Clears the most "stale" DNA from the absorbed_dna list. |
| try_respec | Respec the changeling's powers after first checking if they're able to respec. |
| update_languages | Teach the changeling every language in the absorbed_language list. Already known languages will be ignored. |
| using_stale_dna | Determines if the changeling's current DNA is stale. |
Number of victims the changeling has absorbed.
List of /datum/dna which have been absorbed through the DNA sting or absorb power.
List of /datum/language UIDs, learned from absorbed victims.
A list of instanced /datum/action/changeling the changeling has aquired.
If the changeling can respec their purchased abilities.
The changeling's identifier when speaking in the hivemind, i.e. "Mr. Delta 123".
The current amount of chemicals the changeling has stored.
The amount of chemicals that recharges per Life() call.
Amount of chemical recharge slowdown, calculated as chem_recharge_rate - chem_recharge_slowdown
The total amount of chemicals able to be stored.
The current sting power the changeling has active.
How many total DNA strands the changeling can store for transformation.
The amount of points available to purchase changeling abilities.
A list of /datum/action/changeling typepaths with a power_type of CHANGELING_INNATE_POWER.
If the changeling is in the process of absorbing someone.
A name that will display in place of the changeling's real name when speaking.
List of /datum/dna which are not lost when the changeling has no more room for DNA.
A list of /datum/action/changeling typepaths with a power_type of CHANGELING_PURCHASABLE_POWER.
If the changeling is in the process of regenerating from their fake death.
The range of changeling stings.
Absorb the the target's DNA and their languages.
+Arguments:
+Store the languages from the new_languages list into the absorbed_languages list. Teaches the changeling the new languages.
Arguments:
+Returns TRUE if the changeling can absorb the target mob's DNA.
+Arguments:
+Gets a /datum/dna that matches the passed in tDNA. Also used as a check to see if the changeling has this DNA already stored.
Arguments:
+Gets a list of changeling action typepaths based on the passed in power_type.
Arguments:
+Gives the changeling the passed in power. Subtracts the cost of the power from our genetic points.
Arugments:
+Removes a changeling's abilities.
+Arguments:
+power_type of CHANGELING_INNATE_POWER should be kept.Removes all power_type abilities that the changeling has. Refunds the cost of the power from our genetic points.
Arugments:
+Removes all the languages the mob L has absorbed throughout their life as a changeling and should no longer have.
Ignores languages the player has chosen from character creation, and species languages from the changeling mob's current species.
+Arguments:
+Resets a changeling to the point they were when they first became a changeling, i.e no genetic points to spend, no non-innate powers, etc.
Prompt the changeling with a list of names associated with their stored DNA. Return a /datum/dna based on the name chosen.
+Arguments:
+input() windowinput() windowStore the target DNA. If the DNA belongs to one of the changeling's "escape with identity" objectives, make the DNA protected.
+Arguments:
+Clears the most "stale" DNA from the absorbed_dna list.
Respec the changeling's powers after first checking if they're able to respec.
Teach the changeling every language in the absorbed_language list. Already known languages will be ignored.
Determines if the changeling's current DNA is stale.
Vars | |
| greet_text | Custom greeting text if you don't want to use the basic greeting. Specify this when making a new mindslave datum with New(). |
|---|---|
| master | A reference to the mind who minslaved us. |
Custom greeting text if you don't want to use the basic greeting. Specify this when making a new mindslave datum with New().
A reference to the mind who minslaved us.
Vars | |
| give_codewords | Should the traitor get codewords? |
|---|---|
| give_uplink | Should we give the traitor their uplink? |
Procs | |
| add_law_zero | Gives traitor AIs, and their connected cyborgs, a law 0. Additionally gives the AI their choose modules action button. |
| finalize_antag | Give human traitors their uplink, and AI traitors their law 0. Play the traitor an alert sound. |
| forge_ai_objectives | Create and assign a full set of AI traitor objectives. |
| forge_human_objectives | Create and assign a full set of randomized human traitor objectives. |
| forge_single_human_objective | Create and assign a single randomized human traitor objective. |
| give_codewords | Notify the traitor of their codewords and write them to antag_memory (notes). |
| give_uplink | Gives a traitor human their uplink, and uplink code. |
Should the traitor get codewords?
Should we give the traitor their uplink?
Gives traitor AIs, and their connected cyborgs, a law 0. Additionally gives the AI their choose modules action button.
Give human traitors their uplink, and AI traitors their law 0. Play the traitor an alert sound.
Create and assign a full set of AI traitor objectives.
Create and assign a full set of randomized human traitor objectives.
Create and assign a single randomized human traitor objective.
Notify the traitor of their codewords and write them to antag_memory (notes).
Gives a traitor human their uplink, and uplink code.
Vars | |
| drained_humans | list of the peoples UIDs that we have drained, and how much blood from each one |
|---|---|
| draining | who the vampire is draining of blood |
| iscloaking | handles the vampire cloak toggle |
| nullified | Nullrods and holywater make their abilities cost more |
| powers | list of available powers and passives |
| subclass | what vampire subclass the vampire is. |
| upgrade_tiers | a list of powers that all vampires unlock and at what blood level they unlock them, the rest of their powers are found in the vampire_subclass datum |
Procs | |
| adjust_blood | Handles unique drain ID checks and increases vampire's total and usable blood by blood_amount. Checks for ability upgrades. |
| change_subclass | Remove the vampire's current subclass and add the specified one. |
| clear_subclass | Remove and delete the vampire's current subclass and all associated abilities. |
| remove_all_powers | Removes all of the vampire's current powers. |
| subtract_usable_blood | Safely subtract vampire's bloodusable. Clamped between 0 and bloodtotal. |
list of the peoples UIDs that we have drained, and how much blood from each one
who the vampire is draining of blood
handles the vampire cloak toggle
Nullrods and holywater make their abilities cost more
list of available powers and passives
what vampire subclass the vampire is.
a list of powers that all vampires unlock and at what blood level they unlock them, the rest of their powers are found in the vampire_subclass datum
Handles unique drain ID checks and increases vampire's total and usable blood by blood_amount. Checks for ability upgrades.
+Arguments:
+Remove the vampire's current subclass and add the specified one.
+Arguments:
+Remove and delete the vampire's current subclass and all associated abilities.
+Arguments:
+Removes all of the vampire's current powers.
Safely subtract vampire's bloodusable. Clamped between 0 and bloodtotal.
+Arguments:
+Vars | |
| class_type | The class type of this apprentice, |
|---|---|
| my_teacher | Temporary reference to a mob for purposes of objectives, and general text for the apprentice. |
The class type of this apprentice,
Temporary reference to a mob for purposes of objectives, and general text for the apprentice.
Vars | |
| my_creator | Temporary reference to a mob for purposes of objectives, and general text for the apprentice. |
|---|---|
Temporary reference to a mob for purposes of objectives, and general text for the apprentice.
Procs | |
| get_serialized_url_mappings | Returns a cached tgui message of URL mappings |
|---|---|
Returns a cached tgui message of URL mappings
If you don't need anything complicated.
Vars | |
| assets | List of assets for this datum in the form of asset_filename = asset_file. At runtime the asset_file will be converted into a asset_cache datum |
|---|---|
| keep_local_name | TRUE for keeping local asset names when browse_rsc backend is used |
| legacy | Set to true to have this asset also be sent via browse_rsc when cdn asset transports are enabled |
List of assets for this datum in the form of asset_filename = asset_file. At runtime the asset_file will be converted into a asset_cache datum
TRUE for keeping local asset names when browse_rsc backend is used
Set to true to have this asset also be sent via browse_rsc when cdn asset transports are enabled
Generates assets based on iconstates of a single icon
Vars | |
| generic_icon_names | Generate icon filenames using GENERATE_ASSET_NAME instead the "[prefix].[icon_state_name].png" format |
|---|---|
| prefix | Used in asset name generation, (asset_name = "[prefix].[icon_state_name].png") |
Generate icon filenames using GENERATE_ASSET_NAME instead the "[prefix].[icon_state_name].png" format
Used in asset name generation, (asset_name = "[prefix].[icon_state_name].png")
Namespace'ed assets (for static css and html files)
+When sent over a cdn transport, all assets in the same asset datum will exist in the same folder, as their plain names.
+Used to ensure css files can reference files by url() without having to generate the css at runtime, both the css file and the files it depends on must exist in the same namespace asset datum. (Also works for html)
+For example blah.css with asset blah.png will get loaded as namespaces/a3d..14f/f12..d3c.css and namespaces/a3d..14f/blah.png. allowing the css file to load blah.png by a relative url rather then compute the generated url with get_url_mappings().
+The namespace folder's name will change if any of the assets change. (excluding parent assets)
Vars | |
| parents | parents - list of the parent asset or assets (in name = file assoicated format) for this namespace. +parent assets must be referenced by their generated url, but if an update changes a parent asset, it won't change the namespace's identity. |
|---|---|
parents - list of the parent asset or assets (in name = file assoicated format) for this namespace. +parent assets must be referenced by their generated url, but if an update changes a parent asset, it won't change the namespace's identity.
Vars | |
| sizes | "32x32" -> list(10, icon/normal, icon/stripped) |
|---|---|
| sprites | "foo_bar" -> list("32x32", 5) |
Procs | |
| ModifyInserted | A simple proc handing the Icon for you to modify before it gets turned into an asset. |
| icon_size_id | Returns the size class (ex design32x32) for a given sprite's icon |
"32x32" -> list(10, icon/normal, icon/stripped)
"foo_bar" -> list("32x32", 5)
A simple proc handing the Icon for you to modify before it gets turned into an asset.
+Arguments:
+Returns the size class (ex design32x32) for a given sprite's icon
+Arguments:
+An internal datum containing info on items in the asset cache. Mainly used to cache md5 info for speed.
Vars | |
| ext | our file extension e.g. .png, .gif, etc |
|---|---|
| hash | md5() of the file this asset item represents. |
| keep_local_name | TRUE for keeping local asset names when browse_rsc backend is used |
| legacy | Should this file also be sent via the legacy browse_rsc system +when cdn transports are enabled? |
| name | the name of this asset item, becomes the key in SSassets.cache list |
| namespace | Used by the cdn system to keep legacy css assets with their parent +css file. (css files resolve urls relative to the css file, so the +legacy system can't be used if the css file itself could go out over +the cdn) |
| namespace_parent | True if this is the parent css or html file for an asset's namespace |
| resource | the file this asset represents |
Procs | |
| New | Pass in a valid file_hash if you have one to save it from needing to do it again. +Pass in a valid dmi file path string e.g. "icons/path/to/dmi_file.dmi" to make generating the hash less expensive |
our file extension e.g. .png, .gif, etc
md5() of the file this asset item represents.
TRUE for keeping local asset names when browse_rsc backend is used
Should this file also be sent via the legacy browse_rsc system +when cdn transports are enabled?
the name of this asset item, becomes the key in SSassets.cache list
Used by the cdn system to keep legacy css assets with their parent +css file. (css files resolve urls relative to the css file, so the +legacy system can't be used if the css file itself could go out over +the cdn)
True if this is the parent css or html file for an asset's namespace
the file this asset represents
Pass in a valid file_hash if you have one to save it from needing to do it again. +Pass in a valid dmi file path string e.g. "icons/path/to/dmi_file.dmi" to make generating the hash less expensive
Base browse_rsc asset transport
Vars | |
| dont_mutate_filenames | Don't mutate the filename of assets when sending via browse_rsc. +This is to make it easier to debug issues with assets, and allow server operators to bypass issues that make it to production. +If turning this on fixes asset issues, something isn't using SSassets.transport.get_asset_url and the asset isn't marked legacy, fix one of those. |
|---|---|
Procs | |
| Initialize | Initialize - Called when SSassets initializes. |
| Load | Called when the transport is loaded by the config controller, not called on the default transport unless it gets loaded by a config change. |
| get_asset_url | Returns a url for a given asset. +asset_name - Name of the asset. +asset_cache_item - asset cache item datum for the asset, optional, overrides asset_name |
| register_asset | Register a browser asset with the asset cache system. +returns a /datum/asset_cache_item. +mutiple calls to register the same asset under the same asset_name return the same datum. |
| send_assets | Sends a list of browser assets to a client +client - a client or mob +asset_list - A list of asset filenames to be sent to the client. Can optionally be assoicated with the asset's asset_cache_item datum. +Returns TRUE if any assets were sent. |
| send_assets_slow | Precache files without clogging up the browse() queue, used for passively sending files on connection start. |
| validate_config | Check the config is valid to load this transport +Returns TRUE or FALSE |
Don't mutate the filename of assets when sending via browse_rsc. +This is to make it easier to debug issues with assets, and allow server operators to bypass issues that make it to production. +If turning this on fixes asset issues, something isn't using SSassets.transport.get_asset_url and the asset isn't marked legacy, fix one of those.
Initialize - Called when SSassets initializes.
Called when the transport is loaded by the config controller, not called on the default transport unless it gets loaded by a config change.
Returns a url for a given asset. +asset_name - Name of the asset. +asset_cache_item - asset cache item datum for the asset, optional, overrides asset_name
Register a browser asset with the asset cache system. +returns a /datum/asset_cache_item. +mutiple calls to register the same asset under the same asset_name return the same datum.
+Arguments:
+Sends a list of browser assets to a client +client - a client or mob +asset_list - A list of asset filenames to be sent to the client. Can optionally be assoicated with the asset's asset_cache_item datum. +Returns TRUE if any assets were sent.
Precache files without clogging up the browse() queue, used for passively sending files on connection start.
Check the config is valid to load this transport +Returns TRUE or FALSE
CDN Webroot asset transport.
Procs | |
| get_asset_url | Returns a url for a given asset. +asset_name - Name of the asset. +asset_cache_item - asset cache item datum for the asset, optional, overrides asset_name |
|---|---|
| load_existing_assets | Processes thru any assets that were registered before we were loaded as a transport. |
| register_asset | Register a browser asset with the asset cache system +We also save it to the CDN webroot at this step instead of waiting for send_assets() +asset_name - the identifier of the asset +asset - the actual asset file or an asset_cache_item datum. |
| save_asset_to_webroot | Saves the asset to the webroot taking into account namespaces and hashes. |
| send_assets | webroot asset sending - does nothing unless passed legacy assets |
| send_assets_slow | webroot slow asset sending - does nothing. |
Returns a url for a given asset. +asset_name - Name of the asset. +asset_cache_item - asset cache item datum for the asset, optional, overrides asset_name
Processes thru any assets that were registered before we were loaded as a transport.
Register a browser asset with the asset cache system +We also save it to the CDN webroot at this step instead of waiting for send_assets() +asset_name - the identifier of the asset +asset - the actual asset file or an asset_cache_item datum.
Saves the asset to the webroot taking into account namespaces and hashes.
webroot asset sending - does nothing unless passed legacy assets
webroot slow asset sending - does nothing.
Vars | |
| hidden | Signs that should never be accessed by players via the selection menu. |
|---|---|
| syndicate | Signs that have a syndicate theme. Normally accessed by emagging the sign. |
Signs that should never be accessed by players via the selection menu.
Signs that have a syndicate theme. Normally accessed by emagging the sign.
Specifies a bitfield for smarter debugging
Vars | |
| flags | An associative list of the readable flag and its true value |
|---|---|
| variable | The variable name that contains the bitfield |
An associative list of the readable flag and its true value
The variable name that contains the bitfield
Vars | |
| has_behind | If true, adds an underlay (in addition to the regular overlay!) to the character sprite, with the state "[icon_state]_BEHIND". |
|---|---|
If true, adds an underlay (in addition to the regular overlay!) to the character sprite, with the state "[icon_state]_BEHIND".
Vars | |
| atom_uid | UID of the host atom |
|---|---|
| content | HTML content of the browser datum |
| head_content | Header HTML content of the browser datum |
| include_default_stylesheet | Should default stylesheets be loaded |
| scripts | Assoc list of script files for use by the datum |
| stylesheets | Assoc list of stylesheets for use by the datum |
| window_id | window_id is used as the window name for browse and onclose calls |
| window_options | Various options to control elements such as titlebar buttons for the window |
UID of the host atom
HTML content of the browser datum
Header HTML content of the browser datum
Should default stylesheets be loaded
Assoc list of script files for use by the datum
Assoc list of stylesheets for use by the datum
window_id is used as the window name for browse and onclose calls
Various options to control elements such as titlebar buttons for the window
Vars | |
| tilter | The thing we're tilting over |
|---|---|
The thing we're tilting over
Datum used to cache the SQL DB books locally in order to achieve a performance gain.
Procs | |
| LoadFromRow | helper proc to turn our returned query rows into a cachedbook datum |
|---|---|
helper proc to turn our returned query rows into a cachedbook datum
like normal callbacks but they also record their creation time for measurement purposes
Vars | |
| creation_time | the tick this callback datum was created in. used for testing latency |
|---|---|
the tick this callback datum was created in. used for testing latency
Procs | |
| remove_candidate | Attempts to remove a signed-up mob from a poll. |
|---|---|
| sign_up | Attempts to sign a (controlled) mob up |
| time_left | Returns the time left for a poll |
| trim_candidates | Deletes any candidates who may have disconnected from the list |
Attempts to remove a signed-up mob from a poll.
+Arguments:
+Attempts to sign a (controlled) mob up
+Will fail if the mob is already signed up or the poll's timer ran out. +Does not check for eligibility +Arguments:
+Returns the time left for a poll
Deletes any candidates who may have disconnected from the list
Vars | |
| name | The name of the category |
|---|---|
| priority | The number used to determine category position in changeling evolution menu UI |
The name of the category
The number used to determine category position in changeling evolution menu UI
Vars | |
| body_accessory | The body accessory name of the mob (e.g. wings, tail). |
|---|---|
| custom_emotes | Custom emote text ("name" = "emote text") |
| cyborg_brain_type | If a spawned cyborg should have an MMI, a positronic, or a robobrain. MMI by default |
| from_db | Is this character from the DB? |
| slot_number | Character slot number, used for saves and stuff. |
| valid_save | Is this character valid to be picked? This is necessary to avoid someone getting a bald human called "Character 30" |
Procs | |
| load | Load in and process the database's information on the player's character save. +The order of indices here is the relative order from get_query() in 20-load-characters.dm. |
The body accessory name of the mob (e.g. wings, tail).
Custom emote text ("name" = "emote text")
If a spawned cyborg should have an MMI, a positronic, or a robobrain. MMI by default
Is this character from the DB?
Character slot number, used for saves and stuff.
Is this character valid to be picked? This is necessary to avoid someone getting a bald human called "Character 30"
Load in and process the database's information on the player's character save. +The order of indices here is the relative order from get_query() in 20-load-characters.dm.
Stores information about a chat payload
Vars | |
| content | Message we are sending |
|---|---|
| resends | Resend count |
| sequence | Sequence number of this payload |
Procs | |
| get_content_as_html | Returns an HTML-encoded message from our contents. |
| into_message | Converts the chat payload into a JSON string |
Message we are sending
Resend count
Sequence number of this payload
Returns an HTML-encoded message from our contents.
Converts the chat payload into a JSON string
Datum for generating a message overlay on the map
Vars | |
| animate_lifespan | Our animation lifespan, how long this message will last |
|---|---|
| animate_start | When we started animating the message |
| approx_lines | Contains the approximate amount of lines for height decay |
| current_z_idx | The current index used for adjusting the layer of each sequential chat message such that recent messages will overlay older ones |
| message | The visual element of the chat messsage |
| message_loc | The location in which the message is appearing |
| owned_by | The client who heard this message |
Procs | |
| New | Constructs a chat message overlay |
| colorize_string | Gets a color for a name, will return the same color for a given string consistently within a round.atom |
| finish_image_generation | finishes the image generation after the MeasureText() call in generate_image(). +necessary because after that call the proc can resume at the end of the tick and cause overtime. |
| generate_image | Generates a chat message image representation |
| get_current_alpha | Returns the current alpha of the message based on the time spent |
| on_parent_qdel | Calls qdel on the chatmessage when its parent is deleted, used to register qdel signal |
| sanitize_color | Ensures a colour is bright enough for the system |
Our animation lifespan, how long this message will last
When we started animating the message
Contains the approximate amount of lines for height decay
The current index used for adjusting the layer of each sequential chat message such that recent messages will overlay older ones
The visual element of the chat messsage
The location in which the message is appearing
The client who heard this message
Constructs a chat message overlay
+Arguments:
+Gets a color for a name, will return the same color for a given string consistently within a round.atom
+Note that this proc aims to produce pastel-ish colors using the HSL colorspace. These seem to be favorable for displaying on the map.
+Arguments:
+finishes the image generation after the MeasureText() call in generate_image(). +necessary because after that call the proc can resume at the end of the tick and cause overtime.
Generates a chat message image representation
+Arguments:
+Returns the current alpha of the message based on the time spent
Calls qdel on the chatmessage when its parent is deleted, used to register qdel signal
Ensures a colour is bright enough for the system
+This proc is used to brighten parts of a colour up if its too dark, and looks bad
+Arguments:
+Vars | |
| production_icon | FontAwesome icon name |
|---|---|
Procs | |
| configure_item | public |
FontAwesome icon name
public
+Configures the icon of the specified container P.
+required data Data persistent through invocations in the same loop. +required R The reagents used to make the item P. +required P The container to configure.
Vars | |
| required_container | The container required for the reaction to happen. +Leave this null if you want the reaction to happen anywhere. |
|---|---|
| required_other | Extra requirements for the reaction to happen. |
| required_reagents | A list of IDs of the required reagents. |
| result_amount | This is the amount of the resulting reagent this recipe will produce. +It's recommended you set this to the total volume of all required reagents. |
The container required for the reaction to happen. +Leave this null if you want the reaction to happen anywhere.
Extra requirements for the reaction to happen.
A list of IDs of the required reagents.
+Each ID also needs an associated value that gives us the minimum +required amount / of that reagent. The handle_reaction proc can detect +mutiples of the same recipes / so for most cases you want to set the +required amount to 1.
This is the amount of the resulting reagent this recipe will produce. +It's recommended you set this to the total volume of all required reagents.
Vars | |
| amt_req_cures | The amount of reagents to pick from get_possible_cures() |
|---|---|
| cure_level | The cure level of the reagent, level 4 cure requires level 3 cure, which requires level 2 cure, etc |
| required_symptom | A virus symptom required to complete this chemical reaction |
The amount of reagents to pick from get_possible_cures()
The cure level of the reagent, level 4 cure requires level 3 cure, which requires level 2 cure, etc
A virus symptom required to complete this chemical reaction
Datum which is intended to be stored by a client's click_intercept variable.
+Used to override normal clicking behavior when clicking on an object.
+While active, a mob's ClickOn proc will redirect to the InterceptClickOn() proc instead.
Vars | |
| buttons | Any atom/movable/screen/buttons the client is meant to receive when assigned this click intercept datum. |
|---|---|
| holder | A reference to the client which is assigned this click intercept datum. |
Procs | |
| InterceptClickOn | Called in various mob's ClickOn procs, which happens when they click on an object in the world. |
| create_buttons | Base proc, intended to be overriden. Code that adds datum specific buttons to the list of buttons, should go here. |
| quit | Called when you want to cancel a client's click intercept and return to normal clicking. |
Any atom/movable/screen/buttons the client is meant to receive when assigned this click intercept datum.
A reference to the client which is assigned this click intercept datum.
Called in various mob's ClickOn procs, which happens when they click on an object in the world.
If the mob's client.click_intercept variable is set to something other than null, calls the InterceptClickOn proc for that click intercept datum. Aka, this proc.
Arguments:
+params arguemnt passed from the ClickOn proc.Base proc, intended to be overriden. Code that adds datum specific buttons to the list of buttons, should go here.
Called when you want to cancel a client's click intercept and return to normal clicking.
While a mob has this intercept, left clicking on a carbon mob will attempt to offer their currently held item to that mob.
Vars | |
| item_offered | If the intercept user has succesfully offered the item to another player. |
|---|---|
If the intercept user has succesfully offered the item to another player.
The holder class for all client data processing
+This framework is designed for loading in client data from the database. +Login processors have their own queries, which will be put into one async batch and +executed at the same time, to reduce the time it takes for a client to login. +Login processors can also be given priorities to have things fire in specific orders +EG: Load their preferences before their job bans, etc etc
+When creating these, please name the files with the priority at the start, and the typepath after +EG: 10-load_preferences.dm +This makes it easier to track stuff down -AA07
+Also if you have used other languages before with "interface" types (Java, C# (Microsoft Java), etc), +treat this class as one of those. [get_query(client/C)] and [process_result(datum/db_query/Q, client/C)] MUST be overriden
Vars | |
| priority | The login priority. A lower priority will fire first |
|---|---|
Procs | |
| get_query | Query Getter |
| process_result | Result Processor |
The login priority. A lower priority will fire first
Query Getter
+Gets the DB query for this login processor
+Takes the client as an arg instead of just the ckey incase we need more data (IP, CID, etc). +Returns a DB query datum.
+Arguments:
+Result Processor
+Takes the (now executed) query and the client and parses the required data out +Note: This can be a no-op if you want to just update the DB, just return on the override
+Arguments:
+A datum to store the information gained by scanning a patient OR the fixes to be made to their body.
Vars | |
| genetic_info | The patient's DNA |
|---|---|
| limbs | The patient's external organs (limbs) and their data, stored as an associated list of lists. +List format: limb = list(brute, burn, status, missing, name, max damage) |
| mindUID | A reference to the patient's mind. |
| name | The patient's name. |
| organs | The patient's internal organs and their data, stored as an associated list of lists. +List format: organ = list(damage, status, missing, name, max damage, organ tag) |
The patient's DNA
The patient's external organs (limbs) and their data, stored as an associated list of lists. +List format: limb = list(brute, burn, status, missing, name, max damage)
A reference to the patient's mind.
The patient's name.
The patient's internal organs and their data, stored as an associated list of lists. +List format: organ = list(damage, status, missing, name, max damage, organ tag)
Code Revision Datum
+Allows the server code to be aware of the Git environment it is running in, and lets commit hash be viewed
Vars | |
| commit_date | Date that this commit was made |
|---|---|
| commit_hash | Current commit hash the server is running |
| origin_commit | Origin commit (Only set if running TGS, and will only be different if the server is running testmerges) |
| testmerges | List of testmerges (If applicable) |
Procs | |
| get_testmerge_chatmessage | Testmerge Chat Message Helper |
| log_info | Code Revision Logging Helper |
Date that this commit was made
Current commit hash the server is running
Origin commit (Only set if running TGS, and will only be different if the server is running testmerges)
List of testmerges (If applicable)
Testmerge Chat Message Helper
+Formats testmerged PRs into a nice message +Arguments:
+Code Revision Logging Helper
+Small proc to simplify logging all this stuff
The component datum
+A component should be a single standalone unit +of functionality, that works by receiving signals from it's parent +object to provide some single functionality (i.e a slippery component) +that makes the object it's attached to cause people to slip over. +Useful when you want shared behaviour independent of type inheritance
Vars | |
| can_transfer | Only set to true if you are able to properly transfer this component |
|---|---|
| dupe_mode | Defines how duplicate existing components are handled when added to a datum |
| dupe_type | The type to check for duplication |
| parent | The datum this components belongs to |
Procs | |
| Destroy | Properly removes the component from parent and cleans up references |
| InheritComponent | Called on a component when a component of the same type was added to the same parent |
| Initialize | Called during component creation with the same arguments as in new excluding parent. |
| New | Create a new component. |
| PostTransfer | Callback Just after a component is transferred |
| PreTransfer | Callback Just before this component is transferred |
| RegisterWithParent | Register the component with the parent object |
| RemoveComponent | Removes the component from parent, ends up with a null parent |
| UnregisterFromParent | Unregister from our parent object |
| _GetInverseTypeList | Internal proc to create a list of our type and all parent types |
| _JoinParent | Internal proc to handle behaviour of components when joining a parent |
| _RemoveFromParent | Internal proc to handle behaviour when being removed from a parent |
| ui_host | Return the object that is the host of any UI's that this component has |
Only set to true if you are able to properly transfer this component
+At a minimum RegisterWithParent and UnregisterFromParent should be used
+Make sure you also implement PostTransfer for any post transfer handling
Defines how duplicate existing components are handled when added to a datum
+See COMPONENT_DUPE_* definitions for available options
The type to check for duplication
+null means exact match on type (default)
Any other type means that and all subtypes
The datum this components belongs to
Properly removes the component from parent and cleans up references
Arguments:
+Called on a component when a component of the same type was added to the same parent
+See /datum/component/var/dupe_mode
+C's type will always be the same of the called component
Called during component creation with the same arguments as in new excluding parent.
+Do not call qdel(src) from this function, return COMPONENT_INCOMPATIBLE instead
Create a new component.
+Additional arguments are passed to Initialize()
+Arguments:
+Callback Just after a component is transferred
+Use this to do any special setup you need to do after being moved to a new object
+Do not call qdel(src) from this function, return COMPONENT_INCOMPATIBLE instead
Callback Just before this component is transferred
+Use this to do any special cleanup you might need to do before being deregged from an object
Register the component with the parent object
+Use this proc to register with your parent object
+Overridable proc that's called when added to a new parent
Removes the component from parent, ends up with a null parent
Unregister from our parent object
+Use this proc to unregister from your parent object
+Overridable proc that's called when removed from a parent
Internal proc to create a list of our type and all parent types
Internal proc to handle behaviour of components when joining a parent
Internal proc to handle behaviour when being removed from a parent
Return the object that is the host of any UI's that this component has
Vars | |
| allow_akimbo | Should dual wielding be allowed? |
|---|---|
| autofire_shot_delay | Time between individual shots. |
| current_windup_reduction | the reduction to shot delay for windup |
| mouse_status | This seems hacky but there can be two MouseDown() without a MouseUp() in between if the user holds click and uses alt+tab, printscreen or similar. |
| timerid | Timer for tracking the spindown reset timings |
| windup_autofire | windup autofire vars +Whether the delay between shots increases over time, simulating a spooling weapon |
| windup_autofire_cap | How high of a reduction that current_windup_reduction can reach |
| windup_autofire_reduction_multiplier | the percentage of autfire_shot_delay that is added to current_windup_reduction |
| windup_spindown | How long it takes for weapons that have spooled-up to reset back to the original firing speed |
Procs | |
| windup_reset | Reset for our windup, resetting everything back to initial values after a variable set amount of time (determined by var/windup_spindown). |
Should dual wielding be allowed?
Time between individual shots.
the reduction to shot delay for windup
This seems hacky but there can be two MouseDown() without a MouseUp() in between if the user holds click and uses alt+tab, printscreen or similar.
Timer for tracking the spindown reset timings
windup autofire vars +Whether the delay between shots increases over time, simulating a spooling weapon
How high of a reduction that current_windup_reduction can reach
the percentage of autfire_shot_delay that is added to current_windup_reduction
How long it takes for weapons that have spooled-up to reset back to the original firing speed
Reset for our windup, resetting everything back to initial values after a variable set amount of time (determined by var/windup_spindown).
If an object is given the boomerang component, it should be thrown back to the thrower after either hitting it's target, or landing on the thrown tile. +Thrown objects should be thrown back to the original thrower with this component, a number of tiles defined by boomerang_throw_range.
Vars | |
| boomerang_throw_range | How far should the boomerang try to travel to return to the thrower? |
|---|---|
| last_boomerang_throw | This cooldown prevents our 2 throwing signals from firing too often based on how we implement those signals within thrown impacts. |
| thrower_easy_catch_enabled | If this boomerang is thrown, does it re-enable the throwers throw mode? |
Procs | |
| aerodynamic_swing | Proc that triggers when the thrown boomerang has been fully thrown, rethrowing the boomerang back to the thrower, and producing visible feedback. |
| prepare_throw | Proc'd before the first thrown is performed in order to gather information regarding each throw as well as handle throw_mode as necessary. |
| return_hit_throw | Proc that triggers when the thrown boomerang hits an object. |
| return_missed_throw | Proc that triggers when the thrown boomerang does not hit a target. |
How far should the boomerang try to travel to return to the thrower?
This cooldown prevents our 2 throwing signals from firing too often based on how we implement those signals within thrown impacts.
If this boomerang is thrown, does it re-enable the throwers throw mode?
Proc that triggers when the thrown boomerang has been fully thrown, rethrowing the boomerang back to the thrower, and producing visible feedback.
+Proc'd before the first thrown is performed in order to gather information regarding each throw as well as handle throw_mode as necessary.
+Proc that triggers when the thrown boomerang hits an object.
+Proc that triggers when the thrown boomerang does not hit a target.
+Attaches to a hostile simplemob and plays that music while they have a target.
Vars | |
| boss_track | The music track we will play to players. |
|---|---|
| music_callbacks | List of callback timers, used to clear out mobs listening to boss music after track_duration. |
| players_listening_uids | List of all mobs listening to the boss music currently. Cleared on Destroy or after track_duration. |
| track_duration | How long the track is, used to clear players out when the music is supposed to end. |
Procs | |
| clear_target | Removes old_target from the list of players listening, and stops their music if it is still playing.
+This allows them to have music played again if they re-enter combat with this fauna. |
| on_mob_death | Called when a mob listening to boss music dies- ends their music early. |
| on_target_found | Handles giving the boss music to a new target the fauna has received. +Keeps track of them to not repeatedly overwrite its own track. |
The music track we will play to players.
List of callback timers, used to clear out mobs listening to boss music after track_duration.
List of all mobs listening to the boss music currently. Cleared on Destroy or after track_duration.
How long the track is, used to clear players out when the music is supposed to end.
Removes old_target from the list of players listening, and stops their music if it is still playing.
+This allows them to have music played again if they re-enter combat with this fauna.
Called when a mob listening to boss music dies- ends their music early.
Handles giving the boss music to a new target the fauna has received. +Keeps track of them to not repeatedly overwrite its own track.
Vars | |
| flags | Shoebypassing, walking interaction, silence |
|---|---|
| max_damage | Maximum damage when crossed |
| min_damage | Minimum damage when crossed |
| probability | Probability of stunning and doing daamge |
| weaken_duration | Duration of weaken when crossed |
Shoebypassing, walking interaction, silence
Maximum damage when crossed
Minimum damage when crossed
Probability of stunning and doing daamge
Duration of weaken when crossed
Component that allows for highlighting of words or phrases in chat based on regular expressions.
+Hooks into /mob/proc/combine_message to wrap every regex match in the message +between tags with the provided span class. This modifies the output that +is sent to the parent's chat window.
+Removal of this component should be done by calling [GetComponents(/datum/component/codeword_hearing)] +on the parent and then iterating through all components calling [delete_if_from_source(source)].
Vars | |
| replace_regex | Regex for matching words or phrases you want highlighted. |
|---|---|
| source | The source of this component. Used to identify the source in delete_if_from_source since this component is COMPONENT_DUPE_ALLOWED. |
| span_class | The to use for highlighting matches. |
Procs | |
| delete_if_from_source | Since a parent can have multiple of these components on them simultaneously, this allows a datum to delete components from a specific source. |
Regex for matching words or phrases you want highlighted.
The source of this component. Used to identify the source in delete_if_from_source since this component is COMPONENT_DUPE_ALLOWED.
The to use for highlighting matches.
Since a parent can have multiple of these components on them simultaneously, this allows a datum to delete components from a specific source.
This component behaves similar to connect_loc_behalf, but working off clients and mobs instead of loc +To be clear, we hook into a signal on a tracked client's mob +We retain the ability to react to that signal on a seperate listener, which makes this quite powerful
Vars | |
| connections | An assoc list of signal -> procpath to register to the mob our client "owns" |
|---|---|
| tracked | The master client we're working with |
| tracked_mob | The mob we're currently tracking |
An assoc list of signal -> procpath to register to the mob our client "owns"
The master client we're working with
The mob we're currently tracking
A component for tracking and manipulating bodies held inside constructs/shades +Will drop the body/brain when the parent dies or is deleted.
Vars | |
| held_body | A reference to either a mob, or a brain organ that is held inside our parent. Will drop when parent dies/is deleted |
|---|---|
A reference to either a mob, or a brain organ that is held inside our parent. Will drop when parent dies/is deleted
Mapping component which adds examine text to a corpse that is removed on revival (in case for some reason someone revives your space ruin mob) +For immersive environmental story telling
Vars | |
| description_text | What do we display on examine? |
|---|---|
| naive_description | What do we display if examined by a clown? |
What do we display on examine?
What do we display if examined by a clown?
Deadchat Plays Things - The Componenting
+Allows deadchat to control stuff and things by typing commands into chat. +These commands will then trigger callbacks to execute procs!
Vars | |
| ckey_to_cooldown | Assoc list of ckey:value pairings. In DEADCHAT_DEMOCRACY_MODE, value is the player's vote. In DEADCHAT_ANARCHY_MODE, value is world.time when their cooldown expires. |
|---|---|
| deadchat_mode | A bitfield containing the mode which this component uses (DEADCHAT_DEMOCRACY_MODE or DEADCHAT_ANARCHY_MODE) and other settings) |
| generated_point_of_interest | Set to true if a point of interest was created for an object, and needs to be removed if deadchat control is removed. Needed for preventing objects from having two points of interest. |
| input_cooldown | In DEADCHAT_DEMOCRACY_MODE, this is how long players have to vote on an input. In DEADCHAT_ANARCHY_MODE, this is how long between inputs for each unique player. |
| inputs | Assoc list of key-chat command string, value-callback pairs. list("right" = CALLBACK(GLOBAL_PROC, GLOBAL_PROC_REF(_step), src, EAST)) |
| on_removal | Callback invoked when this component is Destroy()ed to allow the parent to return to a non-deadchat controlled state. |
| orbiters | List of everything orbitting this component's parent. |
| timerid | The id for the DEADCHAT_DEMOCRACY_MODE looping vote timer. |
Procs | |
| _step | Dummy to call since we can't proc reference builtins |
| end_cooldown | Removes the ghost from the ckey_to_cooldown list and lets them know they are free to submit a command for the parent again. |
| on_examine | Informs any examiners to the inputs available as part of deadchat control, as well as the current operating mode and cooldowns. |
| waive_automute | Prevents messages used to control the parent from counting towards the automute threshold for repeated identical messages. |
Assoc list of ckey:value pairings. In DEADCHAT_DEMOCRACY_MODE, value is the player's vote. In DEADCHAT_ANARCHY_MODE, value is world.time when their cooldown expires.
A bitfield containing the mode which this component uses (DEADCHAT_DEMOCRACY_MODE or DEADCHAT_ANARCHY_MODE) and other settings)
Set to true if a point of interest was created for an object, and needs to be removed if deadchat control is removed. Needed for preventing objects from having two points of interest.
In DEADCHAT_DEMOCRACY_MODE, this is how long players have to vote on an input. In DEADCHAT_ANARCHY_MODE, this is how long between inputs for each unique player.
Assoc list of key-chat command string, value-callback pairs. list("right" = CALLBACK(GLOBAL_PROC, GLOBAL_PROC_REF(_step), src, EAST))
Callback invoked when this component is Destroy()ed to allow the parent to return to a non-deadchat controlled state.
List of everything orbitting this component's parent.
The id for the DEADCHAT_DEMOCRACY_MODE looping vote timer.
Dummy to call since we can't proc reference builtins
Removes the ghost from the ckey_to_cooldown list and lets them know they are free to submit a command for the parent again.
Informs any examiners to the inputs available as part of deadchat control, as well as the current operating mode and cooldowns.
Prevents messages used to control the parent from counting towards the automute threshold for repeated identical messages.
+Arguments:
+Procs | |
| Initialize | Deadchat Moves Things |
|---|---|
Deadchat Moves Things
+A special variant of the deadchat_control component that comes pre-baked with all the hottest inputs for a spicy +singularity or vomit goose.
Procs | |
| Initialize | Deadchat Moves Things |
|---|---|
Deadchat Moves Things
+A special variant of the deadchat_control component that comes pre-baked with basic inputs for moving humans around, +with special behavior that has them resist while moving.
Procs | |
| Initialize | Deadchat Moves Things |
|---|---|
Deadchat Moves Things
+A special variant of the deadchat_control component that comes pre-baked with all the hottest inputs for spicy +immovable rod.
Vars | |
| debris | Icon state of debris when impacted by a projectile |
|---|---|
| debris_amount | Amount of debris particles |
| debris_scale | Scale of particle debris |
| debris_velocity | Velocity of debris particles |
Icon state of debris when impacted by a projectile
Amount of debris particles
Scale of particle debris
Velocity of debris particles
A component for an item that attempts to defibrillate a mob when activated.
Vars | |
| actual_unit_uid | uid to an item that should be making noise and handling things that our direct parent shouldn't be concerned with. |
|---|---|
| busy | If the defib is actively performing a defib cycle |
| combat | If it should penetrate space suits |
| cooldown | Cooldown length for this defib in deciseconds |
| emag_proof | If true, this cannot be emagged. |
| emp_proof | If true, EMPs will have no effect. |
| heart_attack_chance | If combat is true, this determines whether or not it should always cause a heart attack. |
| on_cooldown | Whether or not we're currently on cooldown |
| robotic | If this is being used by a borg or not, with necessary safeties applied if so. |
| safety | Whether the safeties are enabled or not |
| speed_multiplier | How fast the defib should work. |
Procs | |
| Initialize | Create a new defibrillation component. |
| defibrillate | Perform a defibrillation. |
| fibrillate | Inflict stamina loss (and possibly inflict cardiac arrest) on someone. |
| get_effect_target | Get the "parent" that effects (emags, EMPs) should be applied onto. |
| trigger_defib | Start the defibrillation process when triggered by a signal. |
uid to an item that should be making noise and handling things that our direct parent shouldn't be concerned with.
If the defib is actively performing a defib cycle
If it should penetrate space suits
Cooldown length for this defib in deciseconds
If true, this cannot be emagged.
If true, EMPs will have no effect.
If combat is true, this determines whether or not it should always cause a heart attack.
Whether or not we're currently on cooldown
If this is being used by a borg or not, with necessary safeties applied if so.
Whether the safeties are enabled or not
How fast the defib should work.
Create a new defibrillation component.
+Arguments:
+Perform a defibrillation.
Inflict stamina loss (and possibly inflict cardiac arrest) on someone.
+Arguments:
+Get the "parent" that effects (emags, EMPs) should be applied onto.
Start the defibrillation process when triggered by a signal.
Vars | |
| stored_blocker | Stores either the mutable_appearance or a list of them |
|---|---|
Procs | |
| update_generic_block | Updates the generic blocker when the icon_state is changed |
Stores either the mutable_appearance or a list of them
Updates the generic blocker when the icon_state is changed
Footstep component. Plays footsteps at parents location when it is appropriate.
Vars | |
| e_range | e_range stands for extra range - aka how far the sound can be heard. This is added to the base value and ignored if there isn't a base value. |
|---|---|
| footstep_sounds | This can be a list OR a soundfile OR null. Determines whatever sound gets played. |
| footstep_type | footstep_type is a define which determines what kind of sounds should get chosen. |
| sound_vary | Whether or not to add variation to the sounds played |
| steps | How many steps the parent has taken since the last time a footstep was played. |
| volume | volume determines the extra volume of the footstep. This is multiplied by the base volume, should there be one. |
Procs | |
| play_simplestep_machine | Prepares a footstep for machine walking |
| prepare_step | Prepares a footstep. Determines if it should get played. Returns the turf it should get played on. Note that it is always a /turf/simulated/floor (eventually /turf/open) |
e_range stands for extra range - aka how far the sound can be heard. This is added to the base value and ignored if there isn't a base value.
This can be a list OR a soundfile OR null. Determines whatever sound gets played.
footstep_type is a define which determines what kind of sounds should get chosen.
Whether or not to add variation to the sounds played
How many steps the parent has taken since the last time a footstep was played.
volume determines the extra volume of the footstep. This is multiplied by the base volume, should there be one.
Prepares a footstep for machine walking
Prepares a footstep. Determines if it should get played. Returns the turf it should get played on. Note that it is always a /turf/simulated/floor (eventually /turf/open)
The label component.
+This component is used to manage labels applied by the hand labeler.
+Atoms can only have one instance of this component, and therefore only one label at a time. +This is to avoid having names like "Backpack (label1) (label2) (label3)". This is annoying and abnoxious to read.
+When a player clicks the atom with a hand labeler to apply a label, this component gets applied to it. +If the labeler is off, the component will be removed from it, and the label will be removed from its name.
Vars | |
| label_name | The name of the label the player is applying to the parent. |
|---|---|
Procs | |
| Examine | This proc will trigger when someone examines the parent.
+It will attach the text found in the body of the proc to the examine_list and display it to the player examining the parent. |
| InheritComponent | This proc will fire after the parent is hit by a hand labeler which is trying to apply another label. +Since the parent already has a label, it will remove the old one from the parent's name, and apply the new one. |
| OnAttackby | This proc will trigger when any object is used to attack the parent. |
| apply_label | Applies a label to the name of the parent in the format of: "parent_name (label)" |
| remove_label | Removes the label from the parent's name |
The name of the label the player is applying to the parent.
This proc will trigger when someone examines the parent.
+It will attach the text found in the body of the proc to the examine_list and display it to the player examining the parent.
Arguments:
+This proc will fire after the parent is hit by a hand labeler which is trying to apply another label. +Since the parent already has a label, it will remove the old one from the parent's name, and apply the new one.
This proc will trigger when any object is used to attack the parent.
+If the attacking object is not a hand labeler, it will return. +If the attacking object is a hand labeler it will restore the name of the parent to what it was before this component was added to it, and the component will be deleted.
+Arguments:
+Applies a label to the name of the parent in the format of: "parent_name (label)"
Removes the label from the parent's name
A verson of the label component specific to labelling goal items.
Procs | |
| Examine | Adds detailed information to the examine text. |
|---|---|
| apply_label | Applies a static label to the parent's name. +We do this instead of using label_name so it's easier to identify goal objects at a glance. |
| remove_label | Removes the label from the parent's name |
Adds detailed information to the examine text.
Applies a static label to the parent's name. +We do this instead of using label_name so it's easier to identify goal objects at a glance.
Removes the label from the parent's name
Vars | |
| orbit_data | Cached transforms from before the orbiter started orbiting, to be restored on stopping their orbit |
|---|---|
| orbiter_list | List of observers orbiting the parent |
Procs | |
| InheritComponent | See atom/movable/proc/orbit for parameter definitions |
| Initialize | See atom/movable/proc/orbit for parameter definitions |
| begin_orbit | See atom/movable/proc/orbit for parameter definitions |
| end_orbit | End the orbit and clean up our transformation. +If this removes the last atom orbiting us, then qdel ourselves. +Howver, if refreshing == TRUE, src will not be qdeleted if this leaves us with 0 orbiters. |
| get_cached_transform | Get cached transform of the given orbiter. |
| get_orbit_params | Get the given orbiter's orbit parameters bitfield |
| get_orbiter_layer | Get the layer the given orbiter was on before they started orbiting |
| handle_parent_move | The actual implementation function of the move react. +if you're trying to call this from a signal, call parent_move_react instead. +This implementation is separate so the orbited atom's old location and new location can be passed in separately. |
| is_in_hierarchy | Returns TRUE if atom_to_find is transitively a parent of src. |
| on_intermediate_move | Called when an intermediate (somewhere between the topmost and the orbited) atom moves. +This atom will now become the leader. |
| on_remove_child | Callback fired when an item is removed from a tracked atom. +Removes all orbit-related signals up its hierarchy and moves orbiters to the current child. +As this will never be called by a turf, this should not conflict with parent_move_react. |
| orbiter_move_react | Called when the orbiter themselves moves. |
| parent_move_react | Signal handler for COMSIG_MOVABLE_MOVED. Special wrapper to handle the arguments that come from the signal. +If you want to call this directly, just call handle_parent_move. |
| register_signals | Register signals up the hierarchy, adding them to each parent (and their parent, and so on) up to the turf they're on. +The last atom in the hierarchy (the one whose .loc is the turf) becomes the leader, the atom ghosts will follow. +Registers on_intermediate_move for every non-leader atom so that if they move (removing them from the hierarchy), they will be set as the new leader. +Also registers on_remove_child to remove signals up the hierarchy when a child gets removed. +start: the first atom to register signals on. If start isn't inside of anything (or if its .loc is a turf), then it will become the leader. +Returns the new "leader", the atom that ghosts will follow. |
| remove_signals | Remove all orbit-related signals in the object hierarchy above start. |
| store_orbit_data | orbit data helper functions +Store a collection of data for an orbiter. +orbiter: orbiter atom itself. The orbiter's transform and layer at this point will be captured and cached. +orbit_flags: bitfield consisting of flags describing the orbit. |
Cached transforms from before the orbiter started orbiting, to be restored on stopping their orbit
List of observers orbiting the parent
See atom/movable/proc/orbit for parameter definitions
See atom/movable/proc/orbit for parameter definitions
See atom/movable/proc/orbit for parameter definitions
End the orbit and clean up our transformation. +If this removes the last atom orbiting us, then qdel ourselves. +Howver, if refreshing == TRUE, src will not be qdeleted if this leaves us with 0 orbiters.
Get cached transform of the given orbiter.
Get the given orbiter's orbit parameters bitfield
Get the layer the given orbiter was on before they started orbiting
The actual implementation function of the move react. +if you're trying to call this from a signal, call parent_move_react instead. +This implementation is separate so the orbited atom's old location and new location can be passed in separately.
Returns TRUE if atom_to_find is transitively a parent of src.
Called when an intermediate (somewhere between the topmost and the orbited) atom moves. +This atom will now become the leader.
Callback fired when an item is removed from a tracked atom. +Removes all orbit-related signals up its hierarchy and moves orbiters to the current child. +As this will never be called by a turf, this should not conflict with parent_move_react.
Called when the orbiter themselves moves.
Signal handler for COMSIG_MOVABLE_MOVED. Special wrapper to handle the arguments that come from the signal. +If you want to call this directly, just call handle_parent_move.
Register signals up the hierarchy, adding them to each parent (and their parent, and so on) up to the turf they're on. +The last atom in the hierarchy (the one whose .loc is the turf) becomes the leader, the atom ghosts will follow. +Registers on_intermediate_move for every non-leader atom so that if they move (removing them from the hierarchy), they will be set as the new leader. +Also registers on_remove_child to remove signals up the hierarchy when a child gets removed. +start: the first atom to register signals on. If start isn't inside of anything (or if its .loc is a turf), then it will become the leader. +Returns the new "leader", the atom that ghosts will follow.
Remove all orbit-related signals in the object hierarchy above start.
orbit data helper functions +Store a collection of data for an orbiter. +orbiter: orbiter atom itself. The orbiter's transform and layer at this point will be captured and cached. +orbit_flags: bitfield consisting of flags describing the orbit.
Vars | |
| examine_text | Text to be shown to users who examine the parent. Will list which type of attacks it can parry. |
|---|---|
| no_parry_sound | Do we wish to mute the parry sound? |
| parry_cooldown | the time between parry attempts |
| parry_time_out_time | the max time since time_parried that the shield is still considered "active" |
| parryable_attack_types | the attack types that are considered for parrying |
| stamina_coefficient | stamina_coefficient * damage * time_since_time_parried = stamina damage taken per non perfect parry |
| stamina_constant | the flat amount of damage the shield user takes per non-perfect parry |
| time_parried | the world.time we last parried at |
Text to be shown to users who examine the parent. Will list which type of attacks it can parry.
Do we wish to mute the parry sound?
the time between parry attempts
the max time since time_parried that the shield is still considered "active"
the attack types that are considered for parrying
stamina_coefficient * damage * time_since_time_parried = stamina damage taken per non perfect parry
the flat amount of damage the shield user takes per non-perfect parry
the world.time we last parried at
Attaching this component to an atom means that the atom will be able to detect mobs or objects moving within a specified radius of it.
+The component creates several /obj/effect/abstract/proximity_checker objects, which follow the parent AKA hasprox_receiver around, always making sure it's at the center.
+When something crosses one of these proximiy checkers, the hasprox_receiver will have the HasProximity() proc called on it, with the crossing mob/obj as the argument.
Vars | |
| always_active | Should the parent always detect proximity and update the field on movement, even if it's not on a turf? |
|---|---|
| field_checker_type | The type of checker object that should be used for the main field. |
| hasprox_receiver | The primary atom the component is attached to and that will be receiving HasProximity() calls. Same as the parent. |
| nested_receiver_locs | A list which contains references to movable atoms which the hasprox_receiver has moved into.
+Used to handle complex situations where the receiver is nested several layers deep into an object.
+For example: inside of a box, that's inside of a bag, which is worn on a human. In this situation there are 3 locations we need to listen to for movement. |
| proximity_checkers | A list of currently created /obj/effect/abstract/proximity_checker in use with this component. |
| radius | The radius of the field, in tiles. |
Procs | |
| clear_nested_locs | Removes and unregisters signals from all objects currently in the nested_receiver_locs list. |
| create_prox_checkers | Called in Initialize(). Generates a set of proximity checker objects around the parent. |
| create_single_prox_checker | Creates a single proximity checker object, at the given location and of the given type. Adds it to the proximity checkers list. |
| map_nested_locs | Registers signals to any nested locations the hasprox_receiver is in, excluding turfs, so they can be monitored for movement. |
| move_prox_checkers | Relays basic directional movement from the hasprox_receiver or host, to all objects in the proximity_checkers list. |
| on_disposal_enter | Called when the receiver or an atom in the nested_receiver_locs list moves into a disposals holder object. |
| on_disposal_exit | Called when the receiver or an atom in the nested_receiver_locs list moves out of a disposals holder object. |
| on_nested_loc_move | Called when an atom in nested_receiver_locs list moves, if one exists. |
| on_receiver_move | Called when the hasprox_receiver moves. |
| recenter_prox_checkers | Re-centers all of the proximity_checkers around the parent's current location. |
| set_radius | Specifies a new radius for the field. Creates or deletes proximity_checkers accordingly. |
| toggle_checkers | Update all of the component's proximity checker's to either become active or not active. |
Should the parent always detect proximity and update the field on movement, even if it's not on a turf?
The type of checker object that should be used for the main field.
The primary atom the component is attached to and that will be receiving HasProximity() calls. Same as the parent.
A list which contains references to movable atoms which the hasprox_receiver has moved into.
+Used to handle complex situations where the receiver is nested several layers deep into an object.
+For example: inside of a box, that's inside of a bag, which is worn on a human. In this situation there are 3 locations we need to listen to for movement.
A list of currently created /obj/effect/abstract/proximity_checker in use with this component.
The radius of the field, in tiles.
Removes and unregisters signals from all objects currently in the nested_receiver_locs list.
Called in Initialize(). Generates a set of proximity checker objects around the parent.
Creates a single proximity checker object, at the given location and of the given type. Adds it to the proximity checkers list.
+Arguments:
+Registers signals to any nested locations the hasprox_receiver is in, excluding turfs, so they can be monitored for movement.
Relays basic directional movement from the hasprox_receiver or host, to all objects in the proximity_checkers list.
Arguments:
+Called when the receiver or an atom in the nested_receiver_locs list moves into a disposals holder object.
This proc receives arguments, but they aren't needed.
Called when the receiver or an atom in the nested_receiver_locs list moves out of a disposals holder object.
This proc receives arguments, but they aren't needed.
Called when an atom in nested_receiver_locs list moves, if one exists.
Arguments:
+nested_receiver_locsmoved_atom just moved frommoved_atom just moved inCalled when the hasprox_receiver moves.
Arguments:
+hasprox_receiverRe-centers all of the proximity_checkers around the parent's current location.
Specifies a new radius for the field. Creates or deletes proximity_checkers accordingly.
+This proc can have a high cost due to the news and qdels of the proximity checkers, depending on the number of calls you need to make to it.
Arguments:
+new_radius - the new value that proximity_radius should be set to.
Update all of the component's proximity checker's to either become active or not active.
+Arguments:
+active variableVars | |
| hl3_release_date | the half-life measured in ticks |
|---|---|
the half-life measured in ticks
A component that allows players to use the item to zoom out. Mainly intended for firearms, but now works with other items too.
Vars | |
| allow_middle_click | Do we let the user scope and click on the middle of their screen? |
|---|---|
| item_action_type | if not null, an item action will be added. Redundant if the mode is ZOOM_METHOD_RIGHT_CLICK or ZOOM_METHOD_WIELD. |
| movement_cancels_scope | Do we have the scope cancel on move? |
| range_modifier | How far the view can be moved from the player. At 1, it can be moved by the player's view distance; other values scale linearly. |
| time_to_scope | Time to scope up, if you want the scope to take time to boot up. Used by the LWAP |
| tracker | Fullscreen object we use for tracking. |
| tracker_owner_ckey | The owner of the tracker's ckey. For comparing with the current owner mob, in case the client has left it (e.g. ghosted). |
| zoom_method | The method which we zoom in and out |
Procs | |
| get_target | We find and return the best target to hit on a given turf. |
| stop_zooming | We stop zooming, canceling processing, resetting stuff back to normal and deleting our tracker. |
| zoom | We start zooming by adding our tracker overlay and starting our processing. |
Do we let the user scope and click on the middle of their screen?
if not null, an item action will be added. Redundant if the mode is ZOOM_METHOD_RIGHT_CLICK or ZOOM_METHOD_WIELD.
Do we have the scope cancel on move?
How far the view can be moved from the player. At 1, it can be moved by the player's view distance; other values scale linearly.
Time to scope up, if you want the scope to take time to boot up. Used by the LWAP
Fullscreen object we use for tracking.
The owner of the tracker's ckey. For comparing with the current owner mob, in case the client has left it (e.g. ghosted).
The method which we zoom in and out
We find and return the best target to hit on a given turf.
+Arguments:
+We stop zooming, canceling processing, resetting stuff back to normal and deleting our tracker.
+Arguments:
+We start zooming by adding our tracker overlay and starting our processing.
+Arguments:
+The shielded component causes the parent item to nullify a certain number of attacks against the wearer, see: shielded vests.
Vars | |
| charge_add_cd | The cooldown tracking when we last replenished a charge |
|---|---|
| charge_increment_delay | Once we go unhit long enough to recharge, we replenish charges this often. The floor is effectively 1 second, AKA how often SSdcs processes |
| charge_recovery | How many charges we recover on each charge increment |
| current_charges | How many charges we currently have |
| lose_multiple_charges | Should the shield lose charges equal to the damage dealt by a hit? |
| max_charges | How many charges we can have max, and how many we start with |
| on_hit_effects | A callback for the sparks/message that play when a charge is used, see /datum/component/shielded/proc/default_run_hit_callback |
| recently_hit_cd | The cooldown tracking when we were last hit |
| recharge_path | The item we use for recharging |
| recharge_start_delay | How long we have to avoid being hit to replenish charges. If set to 0, we never recharge lost charges |
| shield | The visual effect |
| shield_icon | What icon is used when someone has a functional shield up |
| shield_icon_file | What .dmi we're pulling the shield icon from |
| shield_inhand | Do we still shield if we're being held in-hand? If FALSE, it needs to be equipped to a slot to work |
| show_charge_as_alpha | Should the shield's alpha change to show its remaining charge |
| wearer | The person currently wearing us |
Procs | |
| actually_run_hit_callback | The wrapper to invoke the on_hit callback, so we don't have to worry about blocking in the signal handler |
| default_run_hit_callback | Default on_hit proc, since cult robes are stupid and have different descriptions/sparks |
| lost_wearer | Either we've been dropped or our wearer has been QDEL'd. Either way, they're no longer our problem |
| on_equipped | Check if we've been equipped to a valid slot to shield |
| on_hit_react | This proc fires when we're hit, and is responsible for checking if we're charged, then deducting one + returning that we're blocking if so. +It then runs the callback in /datum/component/shielded/var/on_hit_effects which handles the messages/sparks (so the visuals) |
| on_update_overlays | Used to draw the shield overlay on the wearer |
The cooldown tracking when we last replenished a charge
Once we go unhit long enough to recharge, we replenish charges this often. The floor is effectively 1 second, AKA how often SSdcs processes
How many charges we recover on each charge increment
How many charges we currently have
Should the shield lose charges equal to the damage dealt by a hit?
How many charges we can have max, and how many we start with
A callback for the sparks/message that play when a charge is used, see /datum/component/shielded/proc/default_run_hit_callback
The cooldown tracking when we were last hit
The item we use for recharging
How long we have to avoid being hit to replenish charges. If set to 0, we never recharge lost charges
The visual effect
What icon is used when someone has a functional shield up
What .dmi we're pulling the shield icon from
Do we still shield if we're being held in-hand? If FALSE, it needs to be equipped to a slot to work
Should the shield's alpha change to show its remaining charge
The person currently wearing us
The wrapper to invoke the on_hit callback, so we don't have to worry about blocking in the signal handler
Default on_hit proc, since cult robes are stupid and have different descriptions/sparks
Either we've been dropped or our wearer has been QDEL'd. Either way, they're no longer our problem
Check if we've been equipped to a valid slot to shield
This proc fires when we're hit, and is responsible for checking if we're charged, then deducting one + returning that we're blocking if so. +It then runs the callback in /datum/component/shielded/var/on_hit_effects which handles the messages/sparks (so the visuals)
Used to draw the shield overlay on the wearer
This is a component that can be applied to any movable atom (mob or obj).
+While the atom has this component, any human mob that walks over it will have a chance to slip. +Duration, tiles moved, and so on, depend on what variables are passed in when the component is added.
Vars | |
| description | Text that gets displayed in the slip proc, i.e. "user slips on [description]" |
|---|---|
| horizontal_required | TRUE the player will only slip if the mob this datum is attached to is horizontal |
| knockdown | The amount of knockdown to apply after slip. |
| slip_always | FALSE if you want no slip shoes to make you immune to the slip |
| slip_chance | The chance that walking over the parent will slip you. |
| slip_tiles | The amount of tiles someone will be moved after slip. |
| slip_verb | The verb that players will see when someone slips on the parent. In the form of "You [slip_verb]ped on". |
| walking_is_safe | TRUE If this slip can be avoided by walking. |
Procs | |
| Slip | Called whenever the parent receives either the MOVABLE_CROSSED signal or the ATOM_ENTERED signal. |
Text that gets displayed in the slip proc, i.e. "user slips on [description]"
TRUE the player will only slip if the mob this datum is attached to is horizontal
The amount of knockdown to apply after slip.
FALSE if you want no slip shoes to make you immune to the slip
The chance that walking over the parent will slip you.
The amount of tiles someone will be moved after slip.
The verb that players will see when someone slips on the parent. In the form of "You [slip_verb]ped on".
TRUE If this slip can be avoided by walking.
Called whenever the parent receives either the MOVABLE_CROSSED signal or the ATOM_ENTERED signal.
Calls the victim's slip() proc with the component's variables as arguments.
+Additionally calls the parent's after_slip() proc on the victim.
Vars | |
| sound_extra_range | extra-range for this component's sound |
|---|---|
| sound_falloff_distance | when sounds start falling off for the squeak |
| sound_falloff_exponent | sound exponent for squeak. Defaults to 10 as squeaking is loud and annoying enough. |
extra-range for this component's sound
when sounds start falling off for the squeak
sound exponent for squeak. Defaults to 10 as squeaking is loud and annoying enough.
Vars | |
| attached_to | The atom we are stickied to |
|---|---|
| drop_on_attached_destroy | Do we drop on attached_to's destroy? If not, we qdel |
| overlay | Our priority overlay put on top of attached_to |
The atom we are stickied to
Do we drop on attached_to's destroy? If not, we qdel
Our priority overlay put on top of attached_to
Allows an item to start (or prematurely stop) a surgical operation.
Vars | |
| can_cancel | If true, can be used with a cautery in the off-hand to cancel a surgery. |
|---|---|
| can_cancel_before_first | If true, the initial step will be cancellable by just using the tool again. Should be FALSE for any tool that actually has a first surgery step. |
| can_start_on_stander | If true, can start surgery on someone while they're standing up. +Seeing as how we really don't support this (yet), it's much nicer to selectively enable this if we want it. |
| forced_surgery | If present, this surgery TYPE will be attempted when the item is used. +Useful for things like limb reattachments that don't need a scalpel. |
| valid_starting_types | Bitfield for the types of surgeries that this can start. +Note that in cases where organs are missing, this will be ignored. +Also, note that for anything sharp, SURGERY_INITIATOR_ORGANIC should be set as well. |
Procs | |
| Initialize | Create a new surgery initiating component. |
| attempt_cancel_surgery | Does the surgery de-initiation. |
| can_start_surgery | We haven't even started yet. Any surgery can be cancelled at this point. |
| do_initiate_surgery_moment | Meat and potatoes of starting surgery. |
| initiate_surgery_moment | Does the surgery initiation. |
| on_parent_sharpness_change | Keep tabs on the attached item's sharpness. +This component gets added in atoms when they're made sharp as well. |
| show_starting_message | Handle to allow for easily overriding the message shown |
If true, can be used with a cautery in the off-hand to cancel a surgery.
If true, the initial step will be cancellable by just using the tool again. Should be FALSE for any tool that actually has a first surgery step.
If true, can start surgery on someone while they're standing up. +Seeing as how we really don't support this (yet), it's much nicer to selectively enable this if we want it.
If present, this surgery TYPE will be attempted when the item is used. +Useful for things like limb reattachments that don't need a scalpel.
Bitfield for the types of surgeries that this can start. +Note that in cases where organs are missing, this will be ignored. +Also, note that for anything sharp, SURGERY_INITIATOR_ORGANIC should be set as well.
Create a new surgery initiating component.
+Arguments:
+Does the surgery de-initiation.
We haven't even started yet. Any surgery can be cancelled at this point.
Meat and potatoes of starting surgery.
Does the surgery initiation.
Keep tabs on the attached item's sharpness. +This component gets added in atoms when they're made sharp as well.
Handle to allow for easily overriding the message shown
A component that should be attached to things that have been tilted over, and can be righted. +This can optionally block normal attack_hand interactions
Vars | |
| block_interactions | Whether we should block any interactions with it |
|---|---|
| rotated_angle | The angle by which we rotated as a result of tilting. Should help us avoid cases where something gets tilted until it's upright. |
| untilt_duration | How long it should take to untilt |
Procs | |
| untilt | Untilt a tilted object. |
Whether we should block any interactions with it
The angle by which we rotated as a result of tilting. Should help us avoid cases where something gets tilted until it's upright.
How long it should take to untilt
Untilt a tilted object.
Two Handed Component
+When applied to an item it will make it two handed
Vars | |
| attacksound | Play sound on attack when wielded |
|---|---|
| force_multiplier | The multiplier applied to force when wielded, does not work with force_wielded, and force_unwielded |
| force_unwielded | The force of the item when unweilded |
| force_wielded | The force of the item when weilded |
| icon_wielded | The icon that will be used when wielded |
| offhand_item | Reference to the offhand created for the item |
| only_sharp_when_wielded | Whether or not the object is only sharp when wielded. If it's never sharp, ignore this. |
| require_twohands | Does it have to be held in both hands |
| sharpened_increase | The amount of increase recived from sharpening the item |
| unwield_callback | A callback on the parent to be called when the item is unwielded |
| unwieldsound | Play sound when unwielded |
| wield_callback | A callback on the parent to be called when the item is wielded |
| wielded | Are we holding the two handed item properly |
| wieldsound | Play sound when wielded |
Procs | |
| Initialize | Two Handed component |
| on_attack | on_attack triggers on attack with the parent item |
| on_attack_self | Triggered on attack self of the item containing the component |
| on_destroy | Triggered on destroy of the component's offhand |
| on_drop | Triggered on drop of item containing the component |
| on_equip | Triggered on equip of the item containing the component |
| on_moved | on_moved Triggers on item moved |
| on_sharpen | on_sharpen Triggers on usage of a sharpening stone on the item |
| on_swapping_hands | on_swap_hands Triggers on swapping hands, blocks swap if the other hand is busy |
| on_update_icon | on_update_icon triggers on call to update parent items icon |
| unwield | Unwield the two handed item |
| wield | Wield the two handed item in both hands |
Play sound on attack when wielded
The multiplier applied to force when wielded, does not work with force_wielded, and force_unwielded
The force of the item when unweilded
The force of the item when weilded
The icon that will be used when wielded
Reference to the offhand created for the item
Whether or not the object is only sharp when wielded. If it's never sharp, ignore this.
Does it have to be held in both hands
The amount of increase recived from sharpening the item
A callback on the parent to be called when the item is unwielded
Play sound when unwielded
A callback on the parent to be called when the item is wielded
Are we holding the two handed item properly
Play sound when wielded
Two Handed component
+vars:
+on_attack triggers on attack with the parent item
Triggered on attack self of the item containing the component
Triggered on destroy of the component's offhand
Triggered on drop of item containing the component
Triggered on equip of the item containing the component
on_moved Triggers on item moved
on_sharpen Triggers on usage of a sharpening stone on the item
on_swap_hands Triggers on swapping hands, blocks swap if the other hand is busy
on_update_icon triggers on call to update parent items icon
+Updates the icon using icon_wielded if set
Unwield the two handed item
+vars:
+Wield the two handed item in both hands
+vars:
+Vars | |
| protection_state | See __config_defines.dm |
|---|---|
See __config_defines.dm
Config holder for all admin related things
Vars | |
| allow_admin_ooc_colour | Do we want to allow admins to set their own OOC colour? |
|---|---|
| ckey_rank_map | Assoc list of admin ckeys and their ranks. key: ckey | value: rank name |
| common_cid_map | Assoc list of CIDs which shouldnt be banned due to mass collisions |
| enable_localhost_autoadmin | Do we want to auto enable admin rights if you connect from localhost? |
| rank_colour_map | Assoc list of admin ranks and their colours. key: rank | value: rank colour |
| rank_rights_map | Assoc list of admin ranks and their stuff. key: rank name string | value: list of rights |
| use_database_admins | Do we want to load admins from the database? |
Do we want to allow admins to set their own OOC colour?
Assoc list of admin ckeys and their ranks. key: ckey | value: rank name
Assoc list of CIDs which shouldnt be banned due to mass collisions
Do we want to auto enable admin rights if you connect from localhost?
Assoc list of admin ranks and their colours. key: rank | value: rank colour
Assoc list of admin ranks and their stuff. key: rank name string | value: list of rights
Do we want to load admins from the database?
Config holder for all AFK related things
Vars | |
| auto_cryo_minutes | Minutes before someone is auto moved to cryo |
|---|---|
| auto_despawn_minutes | Minutes before someone is auto despawned |
| ssd_auto_cryo_minutes | Time before SSD people are auto cryo'd |
| warning_minutes | Minutes before someone gets an AFK warning |
Minutes before someone is auto moved to cryo
Minutes before someone is auto despawned
Time before SSD people are auto cryo'd
Minutes before someone gets an AFK warning
Vars | |
| asset_cdn_url | URL the asset_cdn_webroot can be accessed from.
+For best results the webserver powering this should return a long cache validity time,
+as all assets sent via this transport use hash based urls
+if you want to test this locally, you simpily run the localhost-asset-webroot-server.py python3 script
+to host assets stored in data/asset-store/ via http://localhost:58715/ |
|---|---|
| asset_cdn_webroot | Local folder to save assets to. +Assets will be saved in the format of asset.MD5HASH.EXT or in namespaces/hash/ +as ASSET_FILE_NAME or asset.MD5HASH.EXT |
| asset_simple_preload | Whether to make server passively send all browser assets to each client in the background +(instead of waiting for them to be needed) |
| asset_transport | Type of asset transport that will be used for asset delivery. +Available options are "simple" or "webroot". |
URL the asset_cdn_webroot can be accessed from.
+For best results the webserver powering this should return a long cache validity time,
+as all assets sent via this transport use hash based urls
+if you want to test this locally, you simpily run the localhost-asset-webroot-server.py python3 script
+to host assets stored in data/asset-store/ via http://localhost:58715/
Local folder to save assets to. +Assets will be saved in the format of asset.MD5HASH.EXT or in namespaces/hash/ +as ASSET_FILE_NAME or asset.MD5HASH.EXT
Whether to make server passively send all browser assets to each client in the background +(instead of waiting for them to be needed)
Type of asset transport that will be used for asset delivery. +Available options are "simple" or "webroot".
Config holder for all things regarding custom sprites
Vars | |
| ai_core_ckeys | List of ckeys that have custom AI core skins |
|---|---|
| ai_hologram_ckeys | List of ckeys that have custom AI hologram skins |
| cyborg_ckeys | List of ckeys that have custom cyborg skins |
| ipc_screen_map | Assoc of ckeys that have custom pAI screens. Key: ckey | value: list of icon states |
| pai_holoform_ckeys | List of ckeys that have custom pAI holoforms |
List of ckeys that have custom AI core skins
List of ckeys that have custom AI hologram skins
List of ckeys that have custom cyborg skins
Assoc of ckeys that have custom pAI screens. Key: ckey | value: list of icon states
List of ckeys that have custom pAI holoforms
Config holder for all database related things
Vars | |
| address | Address of the SQL server |
|---|---|
| async_query_timeout | Time in seconds for async queries to time out |
| async_thread_limit | Thread limit for async queries |
| db | Database name |
| enabled | SQL enabled or not |
| password | SQL password |
| port | Port of the SQL server |
| username | SQL usename |
| version | What SQL version are we on |
Address of the SQL server
Time in seconds for async queries to time out
Thread limit for async queries
Database name
SQL enabled or not
SQL password
Port of the SQL server
SQL usename
What SQL version are we on
Config holder for all things relating to discord webhooks
Vars | |
| admin_role_id | Admin role to ping if no admins are online. Disables if empty string |
|---|---|
| admin_webhook_urls | List of all URLs for the mentor webhooks |
| forward_all_ahelps | Do we want to forward all ahelps or just ones sent with no active admins |
| main_webhook_urls | List of all URLs for the main webhooks |
| mentor_role_id | Mentor role to ping if no mentors are online. Disables if empty string |
| mentor_webhook_urls | List of all URLs for the admin webhooks |
| webhooks_enabled | Are webhooks enabled at all |
Admin role to ping if no admins are online. Disables if empty string
List of all URLs for the mentor webhooks
Do we want to forward all ahelps or just ones sent with no active admins
List of all URLs for the main webhooks
Mentor role to ping if no mentors are online. Disables if empty string
List of all URLs for the admin webhooks
Are webhooks enabled at all
Config holder for all stuff relating to ingame random events
Vars | |
| delay_lower_bound | Assoc list of lower bounds of event delays. key: severity | value: delay (deciseconds) |
|---|---|
| delay_upper_bound | Assoc list of lower bounds of event delays. key: severity | value: delay (deciseconds) |
| enable_random_events | Do we want to enable random events at all |
| expected_round_length | Expected time of a round in deciseconds |
| first_run_times | Assoc list of when the first event in a group can run. key: severity | value: assoc list with upper and low bounds (key: "upper"/"lower" | value: time in deciseconds) |
Assoc list of lower bounds of event delays. key: severity | value: delay (deciseconds)
Assoc list of lower bounds of event delays. key: severity | value: delay (deciseconds)
Do we want to enable random events at all
Expected time of a round in deciseconds
Assoc list of when the first event in a group can run. key: severity | value: assoc list with upper and low bounds (key: "upper"/"lower" | value: time in deciseconds)
Config holder for everything regarding gamemodes
Vars | |
| add_random_station_traits | Should we generate random station traits at game start? |
|---|---|
| antag_account_age_restriction | Should antags be restricted based on account age? |
| disable_certain_round_early_end | Rounds such as rev, wizard and malf end instantly when the antag has won. Enable the setting below to not do that. |
| enable_gamemode_player_limit | Enable player limits on gamemodes? Disabling can be useful for testing |
| gamemode_names | Assoc list of gamemode names (key: config-tag | value: mode name) |
| gamemodes | List of all gamemodes (value: config-tag) |
| prevent_mindshield_antags | Prevent mindshield roles getting antagonist status |
| probabilities | Assoc list of gamemode probabilities (key: config-tag | value: probability) |
| traitor_objectives_amount | Amount of objectives traitors should get. Does not include escape or hijack. |
| traitor_scaling | Scale amount of traitors with population |
| votable_modes | List of all gamemodes that can be voted for, (value: config-tag) |
Should we generate random station traits at game start?
Should antags be restricted based on account age?
Rounds such as rev, wizard and malf end instantly when the antag has won. Enable the setting below to not do that.
Enable player limits on gamemodes? Disabling can be useful for testing
Assoc list of gamemode names (key: config-tag | value: mode name)
List of all gamemodes (value: config-tag)
Prevent mindshield roles getting antagonist status
Assoc list of gamemode probabilities (key: config-tag | value: probability)
Amount of objectives traitors should get. Does not include escape or hijack.
Scale amount of traitors with population
List of all gamemodes that can be voted for, (value: config-tag)
Config holder for all general/misc things
Vars | |
| allow_antag_hud | Allow players to use AntagHUD? |
|---|---|
| allow_character_metadata | Allow character OOC notes |
| allow_holidays | Announce holidays (christmas, halloween, etc etc) |
| auto_disable_ooc | Auto disable OOC on roundstart? |
| base_loadout_points | Amount of loadout points non-donors should get |
| bomb_cap | Bomb cap (Devastation) Other values will be calculated around this |
| breakable_bones | Do we want to allow bones to break? |
| byond_account_age_threshold | BYOND account age threshold for first join alerts |
| cryo_penalty_period | Respawnability loss penalty for eary cryoing (minutes) |
| developer_express_start | Auto start the game if on a local test server |
| disable_ambient_noise | Disable ambient sound and white noise |
| disable_cid_warning_popup | Disable a popup if 2 users are on the same CID? |
| disable_lobby_music | Disable lobby music? |
| enable_auto_mute | Enable auto muting in all chat channels |
| enable_auto_profiler | Enable automatic profiling to profile.json |
| enable_cloning | Enable/disable cloning |
| enable_night_shifts | Enable night-shift lighting? |
| enable_ooc_emoji | Enable OOC emojis? |
| enable_revival_pod_plants | Enable/disable revival pod plants |
| enabled_cid_randomiser_buster | Enable CID randomiser buster? |
| forbid_singulo_possession | Forbid admins from posessing and flying the singulo round |
| ghost_interaction | Allow ghosts to spin chairs round |
| guest_ban | Ban all Guest BYOND accounts |
| lobby_time | Time in seconds for the pregame lobby. Measured in seconds |
| max_client_cid_history | Max CIDs a client can have history of before a warning is thrown |
| minimum_client_build | Minimum client build. Keep above 1421 due to exploits |
| monkey_cube_cap | Cap for monkey cube monkey spawns |
| popup_admin_pm | Force open a PM window when replied to? This is very annoying |
| random_ai_lawset | Enable random AI lawsets from the default=TRUE pool |
| randomise_shift_time | Randomise shift time instead of it always being 12:00? |
| reactionary_explosions | Enable to make explosions react to obstacles instead of ignoring them |
| respawn_enabled | Enable respawns by default? |
| restart_timeout | Default timeout for world reboot. Measured in seconds |
| restrict_antag_hud_rejoin | Forbid players from rejoining if they use AntagHUD? |
| revival_brain_life | Time for a brain to keep its spark of life (deciseconds) |
| roundstart_observer_period | Observers count as roundstart if they join from the main menu before this time (in minutes). Set to 0 to allow only-pregame start observers. |
| server_features | Server features in a newline |
| server_name | Server name for the BYOND hub |
| server_tag_line | Tagline for the hub entry |
| ssd_warning | Show a warning to players to make them accept touching an SSD |
| starlight | Enable/disable starlight to light up space |
| start_now_confirmation | Give a confirm button for the "Start Now" verb |
Allow players to use AntagHUD?
Allow character OOC notes
Announce holidays (christmas, halloween, etc etc)
Auto disable OOC on roundstart?
Amount of loadout points non-donors should get
Bomb cap (Devastation) Other values will be calculated around this
Do we want to allow bones to break?
BYOND account age threshold for first join alerts
Respawnability loss penalty for eary cryoing (minutes)
Auto start the game if on a local test server
Disable ambient sound and white noise
Disable a popup if 2 users are on the same CID?
Disable lobby music?
Enable auto muting in all chat channels
Enable automatic profiling to profile.json
Enable/disable cloning
Enable night-shift lighting?
Enable OOC emojis?
Enable/disable revival pod plants
Enable CID randomiser buster?
Forbid admins from posessing and flying the singulo round
Allow ghosts to spin chairs round
Ban all Guest BYOND accounts
Time in seconds for the pregame lobby. Measured in seconds
Max CIDs a client can have history of before a warning is thrown
Minimum client build. Keep above 1421 due to exploits
Cap for monkey cube monkey spawns
Force open a PM window when replied to? This is very annoying
Enable random AI lawsets from the default=TRUE pool
Randomise shift time instead of it always being 12:00?
Enable to make explosions react to obstacles instead of ignoring them
Enable respawns by default?
Default timeout for world reboot. Measured in seconds
Forbid players from rejoining if they use AntagHUD?
Time for a brain to keep its spark of life (deciseconds)
Observers count as roundstart if they join from the main menu before this time (in minutes). Set to 0 to allow only-pregame start observers.
Server features in a newline
Server name for the BYOND hub
Tagline for the hub entry
Show a warning to players to make them accept touching an SSD
Enable/disable starlight to light up space
Give a confirm button for the "Start Now" verb
Config holder for all things relating to IPIntel
Vars | |
| bad_rating | 0-1 float for percentage threshold to kick people out |
|---|---|
| contact_email | IPIntel contact email. Required. |
| details_url | Details URL for more info on an IP, including ASN. IP is tacked straight on the end. |
| enabled | Is IPIntel enabled |
| hours_save_bad | How many hours to save bad matches for. Cached due to rate limits |
| hours_save_good | How many hours to save good matches for. Cached due to rate limits |
| ipintel_domain | IPIntel Domain. Do not prefix with a protocol |
| playtime_ignore_threshold | Do not proxy-check players with more hours than the below threshold |
| whitelist_mode | Are we in whitelist mode (Auto-kick people who are on proxies/VPNs) |
0-1 float for percentage threshold to kick people out
IPIntel contact email. Required.
Details URL for more info on an IP, including ASN. IP is tacked straight on the end.
Is IPIntel enabled
How many hours to save bad matches for. Cached due to rate limits
How many hours to save good matches for. Cached due to rate limits
IPIntel Domain. Do not prefix with a protocol
Do not proxy-check players with more hours than the below threshold
Are we in whitelist mode (Auto-kick people who are on proxies/VPNs)
Config holder for all job related things
Vars | |
| allow_ai | Allow non-admins to play as AI |
|---|---|
| assistant_limit | Limit amount of assistants? |
| assistant_maint_access | Grant assistants maint access |
| assistant_security_ratio | If yes to above, ratio of assistants per security officer (IE: 4:1) |
| enable_exp_admin_bypass | Allow admins to bypass EXP restrictions |
| enable_exp_restrictions | Lockout jobs based on EXP |
| enable_exp_tracking | Enable EXP logging and tracking |
| enable_job_amount_overrides | Enable loading of job overrides from the config |
| guest_job_ban | Prevent guests from playing high profile roles |
| highpop_job_map | Map of job:amount for highpop. key: Job | value: amount |
| lowpop_job_map | Map of job:amount for lowpop. key: Job | value: amount |
| restrict_jobs_on_account_age | Do we want to restrict jobs based on account age |
| restrict_jobs_on_account_age_admin_bypass | Allow admins to bypass age-based job restrictions |
Allow non-admins to play as AI
Limit amount of assistants?
Grant assistants maint access
If yes to above, ratio of assistants per security officer (IE: 4:1)
Allow admins to bypass EXP restrictions
Lockout jobs based on EXP
Enable EXP logging and tracking
Enable loading of job overrides from the config
Prevent guests from playing high profile roles
Map of job:amount for highpop. key: Job | value: amount
Map of job:amount for lowpop. key: Job | value: amount
Do we want to restrict jobs based on account age
Allow admins to bypass age-based job restrictions
Config holder for all things regarding logging
Vars | |
| access_logging | Log client access (login/logout) |
|---|---|
| admin_logging | Log admin actions |
| admin_warning_logging | Log admin warning messages |
| adminchat_logging | Log asay messages |
| attack_logging | Enable logging of attacks between players |
| debug_logging | Log debug messages |
| emote_logging | Enable logging of emotes |
| game_logging | Log game events (roundstart, results, a lot of other things) |
| href_logging | Log hrefs |
| ooc_logging | Log OOC messages |
| pda_logging | Enable logging of PDA messages |
| runtime_logging | Enable runtime logging |
| say_logging | Log ingame say messages |
| vote_logging | Enable logging of votes and their results |
| whisper_logging | Enable logging of whipers |
| world_logging | Enable world.log output logging |
Log client access (login/logout)
Log admin actions
Log admin warning messages
Log asay messages
Enable logging of attacks between players
Log debug messages
Enable logging of emotes
Log game events (roundstart, results, a lot of other things)
Log hrefs
Log OOC messages
Enable logging of PDA messages
Enable runtime logging
Log ingame say messages
Enable logging of votes and their results
Enable logging of whipers
Enable world.log output logging
Config holder for all things regarding the MC
Vars | |
| base_tickrate | Base MC tick rate |
|---|---|
| highpop_disable_threshold | MC Highpop disable threshold |
| highpop_enable_threshold | MC Highpop enable threshold |
| highpop_tickrate | Highpop MC tickrate |
| ticklag | Server ticklag |
| world_init_tick_limit | Tick limit % during world Init |
Base MC tick rate
MC Highpop disable threshold
MC Highpop enable threshold
Highpop MC tickrate
Server ticklag
Tick limit % during world Init
Config holder for stuff relating to metrics management
Vars | |
| enable_metrics | Are metrics enabled or disabled |
|---|---|
| metrics_api_token | Endpoint authorisation API key |
| metrics_endpoint | Endpoint to send metrics to, including protocol |
Are metrics enabled or disabled
Endpoint authorisation API key
Endpoint to send metrics to, including protocol
Config holder for values relating to mob movement speeds
Vars | |
| alien_delay | Move delay for xenomorphs |
|---|---|
| animal_delay | Move delay for other simple animals |
| base_run_speed | Base run speed before modifiers |
| base_walk_speed | Base walk speed before modifiers |
| crawling_speed_reduction | crawling speed modifier |
| human_delay | Move delay for humanoids |
| robot_delay | Move delay for cyborgs |
| slime_delay | Move delay for slimes (xenobio, not slimepeople) |
Move delay for xenomorphs
Move delay for other simple animals
Base run speed before modifiers
Base walk speed before modifiers
crawling speed modifier
Move delay for humanoids
Move delay for cyborgs
Move delay for slimes (xenobio, not slimepeople)
Config holder for all overflow-server related things
Vars | |
| overflow_server_location | Location of the overflow server |
|---|---|
| overflow_whitelist | List of ckeys who will never be routed to the overflow server |
| reroute_cap | Amount of players before reroute server is used. 0 to disable. |
Location of the overflow server
List of ckeys who will never be routed to the overflow server
Amount of players before reroute server is used. 0 to disable.
Config holder for all redis related things
Vars | |
| connstring | Redis connection string. Includes passphrase if needed. |
|---|---|
| enabled | Redis enabled or not |
Redis connection string. Includes passphrase if needed.
Redis enabled or not
Config holder for all things regarding space ruins and lavaland ruins
Vars | |
| active_lava_ruins | List of all active lavaland ruins |
|---|---|
| active_space_ruins | List of all active space ruins |
| enable_lavaland | Whether to load the lavaland Z-level |
| enable_space_ruins | Enable or disable all ruins, including lavaland ruins and lavaland tendrils. |
| extra_levels_max | Maximum number of extra zlevels to fill with ruins |
| extra_levels_min | Minimum number of extra zlevels to fill with ruins |
| lavaland_ruin_budget | Budget for lavaland ruins |
List of all active lavaland ruins
List of all active space ruins
Whether to load the lavaland Z-level
Enable or disable all ruins, including lavaland ruins and lavaland tendrils.
Maximum number of extra zlevels to fill with ruins
Minimum number of extra zlevels to fill with ruins
Budget for lavaland ruins
Config holder for stuff relating to server backend management and secrets
Vars | |
| api_host | Internal API host |
|---|---|
| api_key | Internal API key |
| enable_multi_instance_support | Do we want to enable instancing stuff at all? |
| external_tos_handler | Are we using an external handler for TOS |
| instance_id | Server instance ID |
| internal_ip | Server internal IP |
| is_production | Is this server a production server (Has higher security and requires 2FA) |
| override_map | Map datum of the map to use, overriding the defaults, and data/next_map.txt |
| region_map | Assoc list of region names and their server IPs. Used for geo-routing. |
| shutdown_on_reboot | Do we want the server to kill on reboot instead of keeping the same DD session |
| shutdown_shell_command | If above is true, you can run a shell command |
| toast_on_init_complete | Send a system toast on init completion? |
| topic_ip_ratelimit_bypass | List of IP addresses which bypass world topic rate limiting |
| topic_key | Password for authorising world/Topic requests |
Internal API host
Internal API key
Do we want to enable instancing stuff at all?
Are we using an external handler for TOS
Server instance ID
Server internal IP
Is this server a production server (Has higher security and requires 2FA)
Map datum of the map to use, overriding the defaults, and data/next_map.txt
Assoc list of region names and their server IPs. Used for geo-routing.
Do we want the server to kill on reboot instead of keeping the same DD session
If above is true, you can run a shell command
Send a system toast on init completion?
List of IP addresses which bypass world topic rate limiting
Password for authorising world/Topic requests
Config holder for all the server URLs
Vars | |
| banappeals_url | URL for the server ban appeals forum |
|---|---|
| centcom_ban_db_url | URL for the CentCom Ban DB API |
| discord_forum_url | URL for a discord invite going via the forums |
| discord_url | URL for a direct discord invite |
| donations_url | URL for server donations |
| exploit_url | URL for the server exploit report locaion |
| forum_link_url | URL for linking ingame accounts and forum accounts. Token is appended to end |
| forum_playerinfo_url | URL for pulling player info on webtools |
| forum_url | URL for the server forums |
| github_url | URL for the server github repository |
| round_stats_url | URL for the stats page |
| rsc_urls | List of URLs for the server RSC data |
| rules_url | URL for the server rules |
| server_url | Server URL for auto-reconnecting people at end round |
| wiki_url | URL for the server wiki |
URL for the server ban appeals forum
URL for the CentCom Ban DB API
URL for a discord invite going via the forums
URL for a direct discord invite
URL for server donations
URL for the server exploit report locaion
URL for linking ingame accounts and forum accounts. Token is appended to end
URL for pulling player info on webtools
URL for the server forums
URL for the server github repository
URL for the stats page
List of URLs for the server RSC data
URL for the server rules
Server URL for auto-reconnecting people at end round
URL for the server wiki
Config holder for stuff relating to the ingame vote system
Vars | |
| autotransfer_initial_time | Time before the first shuttle vote (deciseconds) |
|---|---|
| autotransfer_interval_time | Time between subsequent shuttle votes if the first one is not successful (deciseconds) |
| disable_default_vote | Default to players not voting |
| enable_map_voting | Enable map voting? |
| map_vote_day_types | Dictionary of day number (string) to vote string |
| non_repeating_maps | If TRUE, you will not be able to vote for the current map |
| prevent_dead_voting | Prevent dead players from voting |
| vote_time | How long will a vote last for in deciseconds |
Time before the first shuttle vote (deciseconds)
Time between subsequent shuttle votes if the first one is not successful (deciseconds)
Default to players not voting
Enable map voting?
Dictionary of day number (string) to vote string
If TRUE, you will not be able to vote for the current map
Prevent dead players from voting
How long will a vote last for in deciseconds
Vars | |
| taskpath | Path of job objective completed. |
|---|---|
Path of job objective completed.
Procs | |
| custom_action | Construction datums |
|---|---|
Construction datums
Describes and manages the contracts and rewards for a single contractor.
Vars | |
| completed_contracts | The number of completed contracts. |
|---|---|
| contractor_uplink | The contractor uplink associated to this hub. |
| contracts | The contracts offered by the hub. |
| current_contract | The current contract in progress. |
| dead_penalty | TC reward multiplier if the target was extracted DEAD. Should be a penalty so between 0 and 1. +The final amount is rounded up. |
| difficulty_tc_thresholds | Completing every contract at a given difficulty will always result in a sum of TC greater or equal than the difficulty's threshold. +Structure: EXTRACTION_DIFFICULTY_(EASY|MEDIUM|HARD) => number |
| num_contracts | The number of contracts to generate initially. |
| owner | The contractor associated to this hub. |
| page | Current UI page index. |
| purchases | List of purchases that can be done for Rep. |
| rep | Amount of Contractor Rep available for spending. |
| rep_per_completion | How much Contractor Rep to earn per contract completion. |
| reward_tc_available | Amount of telecrystals available for redeeming. |
| reward_tc_paid_out | Total amount of paid out telecrystals since the start. |
| targets | List of targets from each contract in /datum/contractor_hub/var/contracts. +Used to make sure two contracts from the same hub don't have the same target. |
| tc_variation | Maximum variation a single contract's TC reward can have upon generation. +In other words: final_reward = CEILING((tc_threshold / num_contracts) * (1 - (rand(0, 100) / 100) * tc_variation), 1) |
Procs | |
| calculate_tc_reward | Generates an amount of TC to be used as a contract reward for the given difficulty. |
| claim_tc | Gives any unclaimed TC to the given mob. |
| first_login | Called when the loading animation completes for the first time. |
| generate_contracts | Regenerates a list of contracts for the contractor to take up. |
| is_user_authorized | Returns whether the given mob is allowed to connect to the uplink. |
| on_completion | Called when a /datum/syndicate_contract has been completed. |
The number of completed contracts.
The contractor uplink associated to this hub.
The contracts offered by the hub.
The current contract in progress.
TC reward multiplier if the target was extracted DEAD. Should be a penalty so between 0 and 1. +The final amount is rounded up.
Completing every contract at a given difficulty will always result in a sum of TC greater or equal than the difficulty's threshold. +Structure: EXTRACTION_DIFFICULTY_(EASY|MEDIUM|HARD) => number
The number of contracts to generate initially.
The contractor associated to this hub.
Current UI page index.
List of purchases that can be done for Rep.
Amount of Contractor Rep available for spending.
How much Contractor Rep to earn per contract completion.
Amount of telecrystals available for redeeming.
Total amount of paid out telecrystals since the start.
List of targets from each contract in /datum/contractor_hub/var/contracts. +Used to make sure two contracts from the same hub don't have the same target.
Maximum variation a single contract's TC reward can have upon generation. +In other words: final_reward = CEILING((tc_threshold / num_contracts) * (1 - (rand(0, 100) / 100) * tc_variation), 1)
Generates an amount of TC to be used as a contract reward for the given difficulty.
+Arguments:
+Gives any unclaimed TC to the given mob.
+Arguments:
+Called when the loading animation completes for the first time.
Regenerates a list of contracts for the contractor to take up.
Returns whether the given mob is allowed to connect to the uplink.
+Arguments:
+Called when a /datum/syndicate_contract has been completed.
+Arguments:
+Procs | |
| log_startup_progress | Standardized method for tracking startup times. |
|---|---|
Standardized method for tracking startup times.
Vars | |
| 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 |
| 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 |
| 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 |
| blurb_witnesses | List of ckeys that have seen a blurb of a given key. |
| 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 |
| deep_inventory_state | tgui state: contained_state |
| default_state | tgui state: default_state |
| dna_activity_bounds | DNA 2: The Spaghetti Strikes Back |
| 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)////// |
| 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 |
| huds | GLOBAL HUD LIST |
| human_adjacent_state | tgui state: human_adjacent_state |
| inventory_state | tgui state: inventory_state |
| 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) |
| not_incapacitated_state | tgui state: not_incapacitated_state |
| not_incapacitated_turf_state | tgui state: not_incapacitated_turf_state |
| notcontained_state | tgui state: notcontained_state |
| observer_state | tgui state: observer_state |
| ooc_enabled | Is OOC currently enabled? |
| physical_obscured_state | tgui state: physical_obscured_state |
| physical_state | tgui state: physical_state |
| 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 |
| 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 |
| strippable_state | tgui state: strippable_state |
| 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 |
| ui_modals | ui modals |
| 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 |
| 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 |
How many procs have been called
List to handle proc call spam prevention
Who is currently calling procs
Last proc called
Last target to have a proc called on it
UID of the admin who last called
Global list of all PDAs in the world
ACID
Active security roles
Associative list of people who are muted via admin mutes
Stores objective names as list keys, and their corresponding typepaths as list values.
tgui state: admin_state
+Checks that the user is an admin, end-of-story.
Global list that contains all existing newscasters in the world.
Stores a reference to every objective which currently exists.
tgui state: always_state
+Always grants the user UI_INTERACTIVE. Period.
List of ckeys that have seen a blurb of a given key.
Global list for descriptors
Only roles that are command of departments, for revolution and similar stuff
All roles that are within the command category
Global configuration datum holder for all the config sections
tgui state: conscious_state
+Only checks if the user is conscious.
tgui state: contained_state
+Checks that the user is inside the src_object.
+tgui state: deep_inventory_state
+Checks that the src_object is in the user's deep +(backpack, box, toolbox, etc) inventory.
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 2: The Spaghetti Strikes Back
+@author N3X15 nexisentertainment@gmail.com
Assoc list. Key = type of the mutation, value = the mutation
Is OOC currently enabled for dead people?
Is deadchat currently enabled?
A globaly cached version of EM_MASK_MATRIX for quick access.
Allow new players to enter the game?
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.
The current game year
Stores an instance of /datum/ui_module/ghost_hud_panel so that ghosts can use this to open their HUD panel.
Global list of all active gravity generators. Keyed by the Z level
tgui state: hands_state
+Checks that the src_object is in the user's hands.
GLOBAL HUD LIST
tgui state: human_adjacent_state
+In addition to default checks, only allows interaction for a +human adjacent user.
tgui state: inventory_state
+Checks that the src_object is in the user's top-level (hand, ear, pocket, belt, etc) inventory.
Join MOTD for the server
Join TOS for the server
Library Catalog global is for storing a library catalog datum that will track book, category, and report lists for the library
Is LOOC currently enabled?
List of looping sounds
Marker Beacons
Global list of all /datum/mod_theme
Amount of time (in minutes) that must pass between a player dying as a mouse and repawning as a mouse
Multiverse Blade
The feed network singleton. Contains all channels (which contain all stories).
The next UID to be used (Increments by 1 for each UID)
tgui state: not_incapacitated_state
+Checks that the user isn't incapacitated
tgui state: not_incapacitated_turf_state
+Checks that the user isn't incapacitated and that their loc is a turf
tgui state: notcontained_state
+Checks that the user is not inside src_object, and then makes the +default checks.
tgui state: observer_state
+Checks that the user is an observer/ghost.
Is OOC currently enabled?
tgui state: physical_obscured_state
+Short-circuits the default state to only check physical distance, being in view doesn't matter
tgui state: physical_state
+Short-circuits the default state to only check physical distance.
Roles that include any semblence of security, mostly for jobbans
Stores a list of the cached seed icons. Used in the seed extractor and the gene modder
tgui state: self_state
+Only checks that the user and src_object are the same.
Will our restart be slower?
Counter for the current amount of smoke
Counter for the current amount of sparks
tgui state: strippable_state
+Checks if user can strip the mob src_object
Global list for all telecomms machines in the world
Log of TGS stuff that can be viewed ingame
List of possible crits from things tipping over
value -> trait name, generated on use from trait_by_type global
tgui login
+Allows the handling of logins using IDs within tgui.
+Two key procs:
+How to use (DM side):
+How to use (JS side): Use the
ui modals
+Allows creation of modals within tgui.
Log of all UIDs created in the round. Assoc list with type as key and amount as value
tgui state: viewer_state
+State for only viewing, regardless of distance. Different from observer_state, which grants interactivity exclusively if an observer/admin.
List of wire colors for each object type of that round. One for airlocks, one for vendors, etc.
List of all world topic handler datums. Populated inside makeDatumRefLists()
List of all world topic spam prevention handlers. See code/modules/world_topic/_spam_prevention_handler.dm
Vars | |
| current_runlevel | For scheduling different subsystems for different stages of the round |
|---|---|
| current_ticklimit | Current tick limit, assigned before running a subsystem. Used by CHECK_TICK as well so that the procs subsystems call can obey that SS's tick limits |
| initializations_finished_with_no_players_logged_in | Did inits finish with no one logged in |
| iteration | How many times have we ran |
| last_init_info | Last reported init info |
| last_run | world.time of last fire, for tracking lag outside of the mc |
| last_type_processed | The type of the last subsystem to be fire()'d. |
| make_runtime | Set this to 1 to debug the MC with a detailed stack trace. Do not set on a production server. |
| map_loading | Are we loading in a new map? |
| processing | Are we processing (higher values increase the processing delay by n ticks) |
| queue_head | Start of queue linked list |
| queue_priority_count | Running total so that we don't have to loop thru the queue each run to split up the tick |
| queue_priority_count_bg | Same, but for background subsystems |
| queue_tail | End of queue linked list (used for appending to the list) |
| random_seed | Random seed generated for randomness if entropy is required |
| skip_ticks | Only run ticker subsystems for the next n ticks. |
| sleep_delta | How long is the MC sleeping between runs, read only (set by Loop() based off of anti-tick-contention heuristics) |
| sleep_offline_after_initializations | Do we want to sleep until players log in? |
| ss_in_init_order | Cache for the loading screen - cleared after |
| subsystems | List of subsystems to fire(). |
Procs | |
| RunQueue | RunQueue - Run thru the queue of subsystems to run, running them while balancing out their allocated tick precentage +Returns 0 if runtimed, a negitive number for logic errors, and a positive number if the operation completed without errors |
For scheduling different subsystems for different stages of the round
Current tick limit, assigned before running a subsystem. Used by CHECK_TICK as well so that the procs subsystems call can obey that SS's tick limits
Did inits finish with no one logged in
How many times have we ran
Last reported init info
world.time of last fire, for tracking lag outside of the mc
The type of the last subsystem to be fire()'d.
Set this to 1 to debug the MC with a detailed stack trace. Do not set on a production server.
Are we loading in a new map?
Are we processing (higher values increase the processing delay by n ticks)
Start of queue linked list
Running total so that we don't have to loop thru the queue each run to split up the tick
Same, but for background subsystems
End of queue linked list (used for appending to the list)
Random seed generated for randomness if entropy is required
Only run ticker subsystems for the next n ticks.
How long is the MC sleeping between runs, read only (set by Loop() based off of anti-tick-contention heuristics)
Do we want to sleep until players log in?
Cache for the loading screen - cleared after
List of subsystems to fire().
RunQueue - Run thru the queue of subsystems to run, running them while balancing out their allocated tick precentage +Returns 0 if runtimed, a negitive number for logic errors, and a positive number if the operation completed without errors
Defines a subsystem to be managed by the Master Controller
+Simply define a child of this subsystem, using the [SUBSYSTEM_DEF] macro, and the MC will handle registration. +Changing the name is required
Vars | |
| can_fire | Set to 0 to prevent fire() calls, mostly for admin use or subsystems that may be resumed later +use the [SS_NO_FIRE] flag instead for systems that never fire to keep it from even being added to list that is checked every tick |
|---|---|
| cost | Running average of the amount of milliseconds it takes the subsystem to complete a run (including all resumes but not the time spent paused) |
| cpu_display | Tab to display in under the MC subtabs |
| failure_strikes | How many times we suspect a subsystem type has crashed the MC, 3 strikes and you're out! |
| fire_sleep_count | Amount of times the subsystem has slept during fire() |
| flags | [Subsystem Flags][SS_NO_INIT] to control binary behavior. Flags must be set at compile time or before preinit finishes to take full effect. (You can also restart the mc to force them to process again) |
| init_order | Order of initialization. Higher numbers are initialized first, lower numbers later. Use or create defines such as [INIT_ORDER_DEFAULT] so we can see the order in one file. |
| initialized | This var is set to TRUE after the subsystem has been initialized. |
| last_fire | Last world.time the subsystem completed a run (as in wasn't paused by [MC_TICK_CHECK]) |
| name | Name of the subsystem - you must change this |
| next_fire | Scheduled world.time for next fire() |
| offline_implications | What are the implications of this SS being offlined? |
| paused_tick_usage | Tracks how much of a tick the subsystem has consumed in the current run |
| paused_ticks | Tracks how many fires the subsystem has consecutively paused on in the current run |
| postponed_fires | How many fires have we been requested to postpone |
| priority | Priority Weight: When mutiple subsystems need to run in the same tick, higher priority subsystems will be given a higher share of the tick before MC_TICK_CHECK triggers a sleep, higher priority subsystems also run before lower priority subsystems |
| queue_next | Next subsystem in the queue of subsystems to run this tick |
| queue_prev | Previous subsystem in the queue of subsystems to run this tick |
| queued_priority | Priority at the time the subsystem entered the queue. Needed to avoid changes in priority (by admins and the like) from breaking things. |
| queued_time | Time the subsystem entered the queue, (for timing and priority reasons) |
| runlevels | Bitmap of what game states can this subsystem fire at. See [RUNLEVELS_DEFAULT] for more details. |
| ss_id | SS ID - Again, change this but keep it snake_case |
| state | Tracks the current execution state of the subsystem. Used to handle subsystems that sleep in fire so the mc doesn't run them again while they are sleeping |
| tick_allocation_avg | How much of a tick (in percents of a tick) do we get allocated by the mc on avg. |
| tick_allocation_last | How much of a tick (in percents of a tick) were we allocated last fire. |
| tick_overrun | Running average of the amount of tick usage (in percents of a game tick) the subsystem has spent past its allocated time without pausing |
| tick_usage | Running average of the amount of tick usage in percents of a tick it takes the subsystem to complete a run |
| ticks | Tracks how many fires the subsystem takes to complete a run on average. |
| times_fired | Tracks the amount of completed runs for the subsystem |
| wait | Time to wait (in deciseconds) between each call to fire(). Must be a positive integer. |
Procs | |
| PreInit | datum/controller/subsystem/New() |
| enqueue | Queue it to run. +(we loop thru a linked list until we get to the end or find the right point) +(this lets us sort our run order correctly without having to re-sort the entire already sorted list) |
| fire | previously, this would have been named 'process()' but that name is used everywhere for different things! +fire() seems more suitable. This is the procedure that gets called every 'wait' deciseconds. +Sleeping in here prevents future fires until returned. |
| get_cost | Returns what to display as the ms cost for this subsystem. |
| get_metrics | Returns the metrics for the subsystem. |
| ignite | This is used so the mc knows when the subsystem sleeps. do not override. |
| postpone | Causes the next "cycle" fires to be missed. Effect is accumulative but can reset by calling update_nextfire(reset_time = TRUE) |
| update_nextfire | |
Set to 0 to prevent fire() calls, mostly for admin use or subsystems that may be resumed later +use the [SS_NO_FIRE] flag instead for systems that never fire to keep it from even being added to list that is checked every tick
Running average of the amount of milliseconds it takes the subsystem to complete a run (including all resumes but not the time spent paused)
Tab to display in under the MC subtabs
How many times we suspect a subsystem type has crashed the MC, 3 strikes and you're out!
Amount of times the subsystem has slept during fire()
[Subsystem Flags][SS_NO_INIT] to control binary behavior. Flags must be set at compile time or before preinit finishes to take full effect. (You can also restart the mc to force them to process again)
Order of initialization. Higher numbers are initialized first, lower numbers later. Use or create defines such as [INIT_ORDER_DEFAULT] so we can see the order in one file.
This var is set to TRUE after the subsystem has been initialized.
Last world.time the subsystem completed a run (as in wasn't paused by [MC_TICK_CHECK])
Name of the subsystem - you must change this
Scheduled world.time for next fire()
What are the implications of this SS being offlined?
Tracks how much of a tick the subsystem has consumed in the current run
Tracks how many fires the subsystem has consecutively paused on in the current run
How many fires have we been requested to postpone
Priority Weight: When mutiple subsystems need to run in the same tick, higher priority subsystems will be given a higher share of the tick before MC_TICK_CHECK triggers a sleep, higher priority subsystems also run before lower priority subsystems
Next subsystem in the queue of subsystems to run this tick
Previous subsystem in the queue of subsystems to run this tick
Priority at the time the subsystem entered the queue. Needed to avoid changes in priority (by admins and the like) from breaking things.
Time the subsystem entered the queue, (for timing and priority reasons)
Bitmap of what game states can this subsystem fire at. See [RUNLEVELS_DEFAULT] for more details.
SS ID - Again, change this but keep it snake_case
Tracks the current execution state of the subsystem. Used to handle subsystems that sleep in fire so the mc doesn't run them again while they are sleeping
How much of a tick (in percents of a tick) do we get allocated by the mc on avg.
How much of a tick (in percents of a tick) were we allocated last fire.
Running average of the amount of tick usage (in percents of a game tick) the subsystem has spent past its allocated time without pausing
Running average of the amount of tick usage in percents of a tick it takes the subsystem to complete a run
Tracks how many fires the subsystem takes to complete a run on average.
Tracks the amount of completed runs for the subsystem
Time to wait (in deciseconds) between each call to fire(). Must be a positive integer.
datum/controller/subsystem/New()
Queue it to run. +(we loop thru a linked list until we get to the end or find the right point) +(this lets us sort our run order correctly without having to re-sort the entire already sorted list)
previously, this would have been named 'process()' but that name is used everywhere for different things! +fire() seems more suitable. This is the procedure that gets called every 'wait' deciseconds. +Sleeping in here prevents future fires until returned.
Returns what to display as the ms cost for this subsystem.
Returns the metrics for the subsystem.
+This can be overriden on subtypes for variables that could affect tick usage +Example: ATs on SSair
This is used so the mc knows when the subsystem sleeps. do not override.
Causes the next "cycle" fires to be missed. Effect is accumulative but can reset by calling update_nextfire(reset_time = TRUE)
Vars | |
| added_bound_mixtures | The number of bound mixtures that were added during this processing cycle. |
|---|---|
| atmos_machinery | The set of active atmos machinery. Length shown in SS Info as AM. |
| bound_mixtures | The set of current bound mixtures. Shown in SS Info as BM:x+y, where x is the length at the start of the most recent processing, and y is the number of mixtures that have been added during processing. |
| cost_atmos_machinery | The cost of a pass through atmos machinery, shown in SS Info's C block as AM. |
| cost_bound_mixtures | The cost of a pass through bound gas mixtures, shown in SS Info's C block as BM. |
| cost_full | How long we took for a full pass through the subsystem. Custom-tracked version of cost. |
| cost_hotspots | The cost of a pass through hotspots, shown in SS Info's C block as HS. |
| cost_interesting_tiles | The cost of a pass through interesting tiles, shown in SS Info's C block as IT. |
| cost_milla_tick | The cost of a MILLA tick in ms, shown in SS Info's C block as MT. |
| cost_pipenets | The cost of a pass through pipenets, shown in SS Info's C block as PN. |
| cost_pipenets_to_build | The cost of a pass through building pipenets, shown in SS Info's C block as DPN. |
| currentpart | Which step we're currently on, used to let us resume if our time budget elapses. |
| currentrun | An arbitrary list of stuff currently being processed. |
| healthy | Is MILLA (and hence SSair) reliably healthy? |
| hotspots | The set of current active hotspots. Length shown in SS Info as HS. |
| icon_manager | Pipe overlay/underlay icon manager |
| in_milla_safe_code | Are we currently running in a MILLA-safe context, i.e. is is_synchronous guaranteed to be TRUE. Nothing outside of this file should change this. |
| interesting_tile_count | The length of the most recent interesting tiles list, shown in SS Info as IT. |
| is_synchronous | Is MILLA currently in synchronous mode? TRUE if data is fresh and changes can be made, FALSE if data is from last tick and changes cannot be made (because this tick is still processing). |
| last_bound_mixtures | The number of bound mixtures we saw when we last stopped processing them. |
| last_unhealthy | When was MILLA last seen unhealthy? |
| machinery_to_construct | A list of atmos machinery to set up in Initialize. |
| milla_tick_start | When did we start the last MILLA tick? |
| original_bound_mixtures | The original length of bound_mixtures. |
| pipenets | The set of active pipenets. Length shown in SS Info as PN. |
| pipenets_to_build | The set of pipenets that need to be built. Length shown in SS Info as PTB. |
| time_slept | How long we spent sleeping while waiting for MILLA to finish the last tick, shown in SS Info's C block as ZZZ. |
| waiting_for_sync | A list of callbacks waiting for MILLA to finish its tick and enter synchronous mode. |
Procs | |
| synchronize | Similar to addtimer, but triggers once MILLA enters synchronous mode. |
The number of bound mixtures that were added during this processing cycle.
The set of active atmos machinery. Length shown in SS Info as AM.
The set of current bound mixtures. Shown in SS Info as BM:x+y, where x is the length at the start of the most recent processing, and y is the number of mixtures that have been added during processing.
The cost of a pass through atmos machinery, shown in SS Info's C block as AM.
The cost of a pass through bound gas mixtures, shown in SS Info's C block as BM.
How long we took for a full pass through the subsystem. Custom-tracked version of cost.
The cost of a pass through hotspots, shown in SS Info's C block as HS.
The cost of a pass through interesting tiles, shown in SS Info's C block as IT.
The cost of a MILLA tick in ms, shown in SS Info's C block as MT.
The cost of a pass through pipenets, shown in SS Info's C block as PN.
The cost of a pass through building pipenets, shown in SS Info's C block as DPN.
Which step we're currently on, used to let us resume if our time budget elapses.
An arbitrary list of stuff currently being processed.
Is MILLA (and hence SSair) reliably healthy?
The set of current active hotspots. Length shown in SS Info as HS.
Pipe overlay/underlay icon manager
Are we currently running in a MILLA-safe context, i.e. is is_synchronous guaranteed to be TRUE. Nothing outside of this file should change this.
The length of the most recent interesting tiles list, shown in SS Info as IT.
Is MILLA currently in synchronous mode? TRUE if data is fresh and changes can be made, FALSE if data is from last tick and changes cannot be made (because this tick is still processing).
The number of bound mixtures we saw when we last stopped processing them.
When was MILLA last seen unhealthy?
A list of atmos machinery to set up in Initialize.
When did we start the last MILLA tick?
The original length of bound_mixtures.
The set of active pipenets. Length shown in SS Info as PN.
The set of pipenets that need to be built. Length shown in SS Info as PTB.
How long we spent sleeping while waiting for MILLA to finish the last tick, shown in SS Info's C block as ZZZ.
A list of callbacks waiting for MILLA to finish its tick and enter synchronous mode.
Similar to addtimer, but triggers once MILLA enters synchronous mode.
Vars | |
| ambience_listening_clients | Assoc list of listening client - next ambience time |
|---|---|
Assoc list of listening client - next ambience time
Vars | |
| cache | Contains /datum/asset_cache_item |
|---|---|
Contains /datum/asset_cache_item
Vars | |
| feedback | List of all recorded feedback |
|---|---|
| research_levels | List of highest tech levels attained that isn't lost lost by destruction of RD computers |
| sealed | Is it time to stop tracking stats? |
| versions | Associative list of any feedback variables that have had their format changed since creation and their current version, remember to update this |
Procs | |
| LogBroadcast | Radio broadcast logging helper |
| ReportDeath | Death reporting proc |
| Seal | Blackbox Sealer |
| Shutdown | Shutdown Helper |
| find_feedback_datum | Helper to find and return a feeedback datum |
| log_research | Research level broadcast logging helper |
| record_feedback | Main feedback recording proc |
| record_feedback_recurse_list | Recursive list recorder |
List of all recorded feedback
List of highest tech levels attained that isn't lost lost by destruction of RD computers
Is it time to stop tracking stats?
Associative list of any feedback variables that have had their format changed since creation and their current version, remember to update this
Radio broadcast logging helper
+Called during [/proc/broadcast_message()] to log a message to the blackbox. +Translates the specific frequency to a name
+Arguments:
+Death reporting proc
+Called when humans and cyborgs die, and logs death info to the death table
Arguments:
+Blackbox Sealer
+Seals the blackbox, preventing new data from being stored. This is to avoid data being bloated during end round grief
Shutdown Helper
+Dumps all feedback stats to the DB. Doesnt get much simpler than that.
Helper to find and return a feeedback datum
+Pass in a feedback datum key and key_type to do a lookup. +It will create the feedback datum if it doesnt exist
+Arguments:
+Research level broadcast logging helper
+This is called on R&D updates for a safe way of logging tech levels if an R&D console is destroyed
+Arguments:
+Main feedback recording proc
+This is the bulk of this subsystem and is in charge of creating and using the variables. +See .github/USING_FEEDBACK_DATA.md for instructions +Note that feedback is not recorded to the DB during this function. That happens at round end.
+Arguments:
+Recursive list recorder
+Used by the above proc for nested tallies
+Arguments:
+Vars | |
| client_to_payloads | Associates a ckey with a list of messages to send to them. |
|---|---|
| client_to_reliability_history | Associates a ckey with an associative list of their last CHAT_RELIABILITY_HISTORY_SIZE messages. |
| client_to_sequence_number | Associates a ckey with their next sequence number. |
Associates a ckey with a list of messages to send to them.
Associates a ckey with an associative list of their last CHAT_RELIABILITY_HISTORY_SIZE messages.
Associates a ckey with their next sequence number.
Vars | |
| lists_to_clean | A list of global lists we want the subsystem to clean. |
|---|---|
A list of global lists we want the subsystem to clean.
Vars | |
| active_queries | List of currenty processing queries |
|---|---|
| connection | Connection handle. This is an arbitrary handle returned from rust_g. |
| failed_connection_timeout | Timeout of failed connections |
| failed_connections | Amount of failed connections |
| last_error | Last error to occur |
| schema_valid | Is the DB schema valid |
| total_errors | SQL errors that have occured mid round |
Procs | |
| CheckSchemaVersion | Schema Version Checker |
| Connect | Connection Creator |
| Disconnect | Disconnection Handler |
| ErrorMsg | Error Message Helper |
| IsConnected | IsConnected Helper |
| MassExecute | Handler to allow many queries to be executed en masse |
| NewQuery | New Query Invoker |
| ReportError | Error Reporting Helper |
| SetRoundEnd | Round End Time Setter |
| SetRoundID | Round ID Setter |
| SetRoundStart | Round End Time Setter |
| Shutdown | Shutdown Handler |
List of currenty processing queries
Connection handle. This is an arbitrary handle returned from rust_g.
Timeout of failed connections
Amount of failed connections
Last error to occur
Is the DB schema valid
SQL errors that have occured mid round
Schema Version Checker
+Basically verifies that the DB schema in the config is the same as the version the game is expecting. +If it is a valid version, the DB will then connect.
Connection Creator
+This proc basically does a few sanity checks before connecting, then attempts to make a connection +When connecting, RUST_G will initialize a thread pool for queries to use to run asynchronously
Disconnection Handler
+Tells the DLL to clean up any open connections. +This will also reset the failed connection counter
Error Message Helper
+Returns the last error that the subsystem encountered. +Will always report "Database disabled by configuration" if the DB is disabled.
IsConnected Helper
+Short helper to check if the DB is connected or not. +Does a few sanity checks, then asks the DLL if we are properly connected
Handler to allow many queries to be executed en masse
+Feed this proc a list of queries and it will execute them all at once, by the power of async magic!
+Arguments:
+New Query Invoker
+Checks to make sure this query isnt being invoked by admin fuckery, then returns a new /datum/db_query
+Arguments:
+Error Reporting Helper
+Pretty much just sets last_error to the error argument
Arguments:
+last_error toRound End Time Setter
+Called during SSticker.declare_completion() +Sets the time that the round ended in the DB, as well as some other params
Round ID Setter
+Called during world/New() at the earliest point +Declares a round ID in the database and assigns it to a global. Also ensures that server address and ports are set
Round End Time Setter
+Called during SSticker.setup() +Sets the time that the round started in the DB
Shutdown Handler
+Called during world/Reboot() as part of the MC shutdown +Finalises a round in the DB before disconnecting.
Vars | |
| processing | List of clients currently processing |
|---|---|
List of clients currently processing
Vars | |
| account_counter | Total amount of account created during the round, neccesary for generating unique account ids |
|---|---|
| cargo_account | ///CARGO VARIABLES///// +the department account tethered to this supply console, we keep a ref here for shuttle operations |
| centcom_message | Remarks from Centcom on how well you checked the last order. |
| credits_per_design | credits gained per research design sold |
| credits_per_easy_reagent_goal | credits gained for each secondary goal completed +These get split in 3, one part for Cargo, one for the department, +and one part for the person who requested the goal. |
| credits_per_intel | credits gained per intel sold |
| credits_per_manifest | credits gained per slip returned |
| credits_per_mech | credits gained per working mech sold |
| credits_per_plasma | credits gained per plasma sold |
| credits_per_salvage | points gained per salvage sold |
| credits_per_virology_goal | points gained per virology goal |
| current_10_minute_spending | amount of money spent in this 15 minute slot during the round |
| delivery_list | Crates that will be on next shuttle |
| discovered_plants | Typepaths for unusual plants we've already sent CentComm, associated with their potencies |
| economy_data | list of vars that will be tracked throughout the round (a new entry for each key list will be added every 15 minutes) |
| fine_for_loose_cargo | credits lost for sending unsecured cargo |
| fine_for_messy_shuttle | credits lost for sending a messy shuttle |
| fine_for_selling_trash | credits lost for sending unwanted items |
| money_account_databases | List of all money account databases existing in the round |
| next_data_check | time to next stats check |
| next_mail_delay | Time until the next mail shipment |
| next_paycheck_delay | ///Paycheck Variables///// +time to next payday |
| ordernum | Current Order number |
| pack_price_modifier | The modifier on crate prices to multiple the price by. |
| payday_count | total paydays this round |
| request_list | Requested crates, waiting for approval by department heads |
| shopping_list | Approved Crates, waiting to be delivered |
| space_credits_created | The amount of space credits that have been created out of thin air, does not include credits created at round-start |
| space_credits_destroyed | The amount of space credits that have been irreversibly deleted/removed from the round |
| supply_packs | Full list of all available supply packs to purchase |
| total_credit_transfers | The amount of transfers (that are worth more than a few credits) that have been accepted during the round |
| total_space_cash | The absolute total amount of space cash (not to be confused with credits) in the round, does not count space credits in money accounts |
| total_space_credits | The absolute total amount of space credits in various economy systems, does not count space cash |
| total_vendor_transactions | the amount of venor purchases during the round |
Procs | |
| fire | create main station accounts |
| generate_supply_order | Supply Stuff |
| payday | Paycheck Stuff |
Total amount of account created during the round, neccesary for generating unique account ids
///CARGO VARIABLES///// +the department account tethered to this supply console, we keep a ref here for shuttle operations
Remarks from Centcom on how well you checked the last order.
credits gained per research design sold
credits gained for each secondary goal completed +These get split in 3, one part for Cargo, one for the department, +and one part for the person who requested the goal.
credits gained per intel sold
credits gained per slip returned
credits gained per working mech sold
credits gained per plasma sold
points gained per salvage sold
points gained per virology goal
amount of money spent in this 15 minute slot during the round
Crates that will be on next shuttle
Typepaths for unusual plants we've already sent CentComm, associated with their potencies
list of vars that will be tracked throughout the round (a new entry for each key list will be added every 15 minutes)
credits lost for sending unsecured cargo
credits lost for sending a messy shuttle
credits lost for sending unwanted items
List of all money account databases existing in the round
time to next stats check
Time until the next mail shipment
///Paycheck Variables///// +time to next payday
Current Order number
The modifier on crate prices to multiple the price by.
total paydays this round
Requested crates, waiting for approval by department heads
Approved Crates, waiting to be delivered
The amount of space credits that have been created out of thin air, does not include credits created at round-start
The amount of space credits that have been irreversibly deleted/removed from the round
Full list of all available supply packs to purchase
The amount of transfers (that are worth more than a few credits) that have been accepted during the round
The absolute total amount of space cash (not to be confused with credits) in the round, does not count space credits in money accounts
The absolute total amount of space credits in various economy systems, does not count space cash
the amount of venor purchases during the round
create main station accounts
Supply Stuff
Paycheck Stuff
Vars | |
| currently_polling | List of polls currently ongoing, to be checked on next fire() |
|---|---|
| next_poll_to_finish | The poll that's closest to finishing |
| polls_active | Whether there are active polls or not |
| total_polls | Number of polls performed since the start |
Procs | |
| is_eligible | Returns whether an observer is eligible to be an event mob |
| poll_candidates | Polls for candidates with a question and a preview of the role |
| polling_finished | Called by the subsystem when a poll's timer runs out |
List of polls currently ongoing, to be checked on next fire()
The poll that's closest to finishing
Whether there are active polls or not
Number of polls performed since the start
Returns whether an observer is eligible to be an event mob
+Arguments:
+Polls for candidates with a question and a preview of the role
+This proc replaces /proc/pollCandidates. +Should NEVER be used in a proc that has waitfor set to FALSE/0 (due to #define UNTIL) +Arguments:
+Called by the subsystem when a poll's timer runs out
+Can be called manually to finish a poll prematurely +Arguments:
+Vars | |
| last_heartbeat | Last time we got a heartbeat from TGS |
|---|---|
| warning_tripped | Has a warning been sent this round? |
Last time we got a heartbeat from TGS
Has a warning been sent this round?
Vars | |
| active_async_requests | List of all async HTTP requests in the processing chain |
|---|---|
| logging_enabled | Variable to define if logging is enabled or not. Disabled by default since we know the requests the server is making. Enable with VV if you need to debug requests |
| total_requests | Total requests the SS has processed in a round |
Procs | |
| create_async_request | Async request creator |
| make_blocking_request | Blocking request creator |
List of all async HTTP requests in the processing chain
Variable to define if logging is enabled or not. Disabled by default since we know the requests the server is making. Enable with VV if you need to debug requests
Total requests the SS has processed in a round
Async request creator
+Generates an async request, and adds it to the subsystem's processing list +These should be used as they do not lock the entire DD process up as they execute inside their own thread pool inside RUSTG
Blocking request creator
+Generates a blocking request, executes it, logs the info then cleanly returns the response +Exists as a proof of concept, and should never be used
Vars | |
| processing | List of clients whose input to process in loop. |
|---|---|
List of clients whose input to process in loop.
Vars | |
| drunken_spawning | Do we spawn people drunkenly due to the party last night? |
|---|---|
| failed_head_antag_roll | A list of minds that have failed to roll antagonist. Cleared when job selection finishes. |
| late_arrivals_spawning | Do we spawn everyone at shuttle due to late arivals? |
| station_departments | list of station departments and their associated roles and economy payments |
Procs | |
| CheckHeadPositions | This proc is called at the start of the level loop of DivideOccupations() and will cause head jobs to be checked before any other jobs of the same level |
| DivideOccupations | Proc DivideOccupations +fills var "assigned_role" for all ready players. +This proc must not have any side effect besides of modifying "assigned_role". |
| FillHeadPosition | This proc is called before the level loop of DivideOccupations() and will try to select a head, ignoring ALL non-head preferences for every level until it locates a head or runs out of levels to check |
Do we spawn people drunkenly due to the party last night?
A list of minds that have failed to roll antagonist. Cleared when job selection finishes.
Do we spawn everyone at shuttle due to late arivals?
list of station departments and their associated roles and economy payments
This proc is called at the start of the level loop of DivideOccupations() and will cause head jobs to be checked before any other jobs of the same level
Proc DivideOccupations +fills var "assigned_role" for all ready players. +This proc must not have any side effect besides of modifying "assigned_role".
This proc is called before the level loop of DivideOccupations() and will try to select a head, ignoring ALL non-head preferences for every level until it locates a head or runs out of levels to check
Vars | |
| bridge_spawners | List of all bridge spawners to process |
|---|---|
| maze_generators | List of all maze generators to process |
List of all bridge spawners to process
List of all maze generators to process
Vars | |
| powernets | All regional powernets (/datum/regional_powernet) in the world |
|---|---|
All regional powernets (/datum/regional_powernet) in the world
Vars | |
| cave_theme | What primary cave theme we have picked for cave generation today. |
|---|---|
| environments | A mapping of environment names to MILLA environment IDs. |
| existing_station_areas | List of areas that exist on the station this shift |
| ghostteleportlocs | List of all areas that can be accessed via IC and OOC means |
| lavaland_theme | What do we have as the lavaland theme today? |
| map_datum | What map datum are we using |
| next_map | What map will be used next round |
| teleportlocs | List of all areas that can be accessed via IC means |
What primary cave theme we have picked for cave generation today.
A mapping of environment names to MILLA environment IDs.
List of areas that exist on the station this shift
List of all areas that can be accessed via IC and OOC means
What do we have as the lavaland theme today?
What map datum are we using
What map will be used next round
List of all areas that can be accessed via IC means
Vars | |
| world_init_time | The real time of day the server started. Used to calculate time drift |
|---|---|
The real time of day the server started. Used to calculate time drift
Vars | |
| xenobiology_mobs | The amount of Xenobiology mobs (and their offspring) that exist in the world. Used for mob capping. Excludes Slimes |
|---|---|
The amount of Xenobiology mobs (and their offspring) that exist in the world. Used for mob capping. Excludes Slimes
Vars | |
| data_saved | Set to true after a the end of the round to prevent griefing being saved |
|---|---|
| registered_atoms | List of atoms registered into the subsystem for persistent data storage. Can be anything at all |
Procs | |
| register | Proc to register an atom with SSpersistent_data |
Set to true after a the end of the round to prevent griefing being saved
List of atoms registered into the subsystem for persistent data storage. Can be anything at all
Proc to register an atom with SSpersistent_data
+This will add any provided atom to the list of registered atoms, and add it to the Initialization queue +If the system has already initialized, it calls persistent_load() at that moment
+Arguments:
+Vars | |
| current_run | List used each time SS fires to track which clients have been processed so far |
|---|---|
List used each time SS fires to track which clients have been processed so far
Procs | |
| GetIdFromArguments | Generates an id for bespoke elements when given the argument list +Generating the id here is a bit complex because we need to support named arguments +Named arguments can appear in any order and we need them to appear after ordered arguments +We assume that no one will pass in a named argument with a value of null |
|---|---|
Generates an id for bespoke elements when given the argument list +Generating the id here is a bit complex because we need to support named arguments +Named arguments can appear in any order and we need them to appear after ordered arguments +We assume that no one will pass in a named argument with a value of null
Vars | |
| current_instrument_channels | Current number of channels allocated for instruments |
|---|---|
| instrument_data | List of all instrument data, associative id = datum |
| max_instrument_channels | Maximum instrument channels total instruments are allowed to use. This is so you don't have instruments deadlocking all sound channels. |
| musician_hearcheck_mindelay | Deciseconds between hearchecks. Too high and instruments seem to lag when people are moving around in terms of who can hear it. Too low and the server lags from this. |
| musician_maxlinechars | Max characters per line in songs |
| musician_maxlines | Max lines in songs |
| songs | List of all song datums. |
| synthesizer_instrument_ids | Single cached list for synthesizer instrument ids, so you don't have to have a new list with every synthesizer. |
Procs | |
| get_instrument | Returns the instrument datum at the given ID or path |
| initialize_instrument_data | Initializes all instrument datums |
| on_song_del | Called when a datum/song is deleted |
| on_song_new | Called when a datum/song is created |
| reserve_instrument_channel | Reserves a sound channel for a given instrument datum |
Current number of channels allocated for instruments
List of all instrument data, associative id = datum
Maximum instrument channels total instruments are allowed to use. This is so you don't have instruments deadlocking all sound channels.
Deciseconds between hearchecks. Too high and instruments seem to lag when people are moving around in terms of who can hear it. Too low and the server lags from this.
Max characters per line in songs
Max lines in songs
List of all song datums.
Single cached list for synthesizer instrument ids, so you don't have to have a new list with every synthesizer.
Returns the instrument datum at the given ID or path
+Arguments:
+Initializes all instrument datums
Called when a datum/song is deleted
+Arguments:
+Called when a datum/song is created
+Arguments:
+Reserves a sound channel for a given instrument datum
+Arguments:
+Vars | |
| global_iterations_per_move | Maximum iterations a move can perform. |
|---|---|
| global_max_tick_moves | Maximum moves a projectile can make per tick. |
| global_pixel_speed | How many pixels one iteration can move a projectile. |
Maximum iterations a move can perform.
Maximum moves a projectile can make per tick.
How many pixels one iteration can move a projectile.
Vars | |
| all_radiations | Lazy list of all radioactive components |
|---|---|
Lazy list of all radioactive components
Vars | |
| selectable_traits_by_types | Assoc list of trait type || assoc list of traits with weighted value. Used for picking traits from a specific category. |
|---|---|
| station_traits | A list of currently active station traits |
Procs | |
| SetupTraits | Rolls for the amount of traits and adds them to the traits list |
| pick_traits | Picks traits of a specific category (e.g. bad or good) and a specified amount, then initializes them and adds them to the list of traits. |
| setup_trait | Creates a given trait of a specific type, while also removing any blacklisted ones from the future pool. |
Assoc list of trait type || assoc list of traits with weighted value. Used for picking traits from a specific category.
A list of currently active station traits
Rolls for the amount of traits and adds them to the traits list
Picks traits of a specific category (e.g. bad or good) and a specified amount, then initializes them and adds them to the list of traits.
Creates a given trait of a specific type, while also removing any blacklisted ones from the future pool.
Vars | |
| mfetch_cost | Time it took to fetch map profile data (ms) |
|---|---|
| mwrite_cost | Time it took to write the map file (ms) |
| nfetch_cost | Time it took to fetch normal profile data (ms) |
| nwrite_cost | Time it took to write the normal file (ms) |
| send_encode_cost | Time it took to encode the data for redis (ms) |
| send_ffi_cost | Time it took to send the stuff down FFI for redis (ms) |
Time it took to fetch map profile data (ms)
Time it took to write the map file (ms)
Time it took to fetch normal profile data (ms)
Time it took to write the normal file (ms)
Time it took to encode the data for redis (ms)
Time it took to send the stuff down FFI for redis (ms)
Vars | |
| last_letin_time | Last world.time we let a ckey in. 3 second delay between each letin to avoid a mass bubble |
|---|---|
| persist_queue | Whether to persist these settings over multiple rounds |
| queue_bypass_list | List of ckeys allowed to bypass queue this round |
| queue_enabled | Whether the queue is enabled or not |
| queue_threshold | Threshold of players to queue new people |
Last world.time we let a ckey in. 3 second delay between each letin to avoid a mass bubble
Whether to persist these settings over multiple rounds
List of ckeys allowed to bypass queue this round
Whether the queue is enabled or not
Threshold of players to queue new people
Vars | |
| connected | Are we connected |
|---|---|
| queue | Message queue (If messages are sent before the SS has init'd) |
| subbed_channels | Amount of subscribed channels on the redis server |
Are we connected
Message queue (If messages are sent before the SS has init'd)
Amount of subscribed channels on the redis server
Vars | |
| available_levels | A list of initialised security level datums |
|---|---|
| current_security_level | Currently set security level |
| security_level_set_timer_id | Option reference of a timer id of the latest set security level. Only set when security level is changed to one with set_delay > 0 |
Procs | |
| announce_security_level | Handles announcements of the newly set security level |
| do_set_level | Actually sets the security level after the announcement |
| get_colored_current_security_level_name | Returns security level name formatted with it's color |
| get_current_level_as_number | Returns the current security level as a number +In case the subsystem hasn't finished initializing yet, returns default security level |
| get_current_level_as_text | Returns the current security level as text |
| number_level_to_text | Converts a number security level to a text |
| pre_set_level | Do things before the actual security level set, like executing security level specific pre change behavior |
| set_level | Sets a new security level as our current level |
| text_level_to_number | Converts a text security level to a number |
A list of initialised security level datums
Currently set security level
Option reference of a timer id of the latest set security level. Only set when security level is changed to one with set_delay > 0
Handles announcements of the newly set security level
+Arguments:
+Actually sets the security level after the announcement
+Sends COMSIG_SECURITY_LEVEL_CHANGED in the end
Arguments:
+Returns security level name formatted with it's color
Returns the current security level as a number +In case the subsystem hasn't finished initializing yet, returns default security level
Returns the current security level as text
Converts a number security level to a text
+Arguments:
+Do things before the actual security level set, like executing security level specific pre change behavior
+Arguments:
+Sets a new security level as our current level
+This is how everything should change the security level
+Arguments:
+Converts a text security level to a number
+Arguments:
+Vars | |
| custom_escape_shuttle_loading | Whether or not a custom shuttle is currently loading at centcomm. |
|---|---|
| custom_shuttle_ordered | Whether or not a custom shuttle has been ordered. |
| emergency_locked_in | Have we locked in the emergency shuttle, to prevent people from breaking things / wasting player money? |
| hostile_environments | Things blocking escape shuttle from leaving. |
| loading_shuttle_at_preview_template | Whether or not a shuttle is currently being loaded at the template landmark, if it exists. |
| refuel_delay | Default refuel delay |
| supply_shuttle_turfs | Supply shuttle turfs to make mail be put down faster |
Procs | |
| replace_shuttle | Create a new shuttle and replace the emergency shuttle with it. +if loaded shuttle is passed in, a new one will not be loaded. |
Whether or not a custom shuttle is currently loading at centcomm.
Whether or not a custom shuttle has been ordered.
Have we locked in the emergency shuttle, to prevent people from breaking things / wasting player money?
Things blocking escape shuttle from leaving.
Whether or not a shuttle is currently being loaded at the template landmark, if it exists.
Default refuel delay
Supply shuttle turfs to make mail be put down faster
Create a new shuttle and replace the emergency shuttle with it. +if loaded shuttle is passed in, a new one will not be loaded.
Vars | |
| channel_list | List of all channels as numbers |
|---|---|
| channel_random_low | lower iteration position - Incremented and looped to get "random" sound channels for normal sounds. The channel at this index is returned when asking for a random channel. |
| channel_reserve_high | higher reserve position - decremented and incremented to reserve sound channels, anything above this is reserved. The channel at this index is the highest unreserved channel. |
| random_channels_min | Amount of channels to reserve for random usage rather than reservations being allowed to reserve all channels. Also a nice safeguard for when someone screws up. |
| reserved_channels | Associative list of all reserved channels associated to their position. "[channel_number]" = index as number |
| using_channels | Assoc list, "[channel]" = either the datum using it or TRUE for an unsafe-reserved (datumless reservation) channel |
| using_channels_by_datum | Assoc list datum = list(channel1, channel2, ...) for what channels something reserved. |
Procs | |
| available_channels_left | How many channels we have left |
| free_channel | Frees a channel and updates the datastructure. Private proc. |
| free_datum_channels | Frees all the channels a datum is using |
| free_datumless_channels | Frees all datumless channels |
| free_sound_channel | Removes a channel from using list |
| random_available_channel | Random available channel, returns number |
| random_available_channel_text | Random available channel, returns text |
| reserve_channel | Reserves a channel and updates the datastructure. Private proc. |
| reserve_sound_channel | Reserves a channel for a datum. Automatic cleanup only when the datum is deleted. |
| reserve_sound_channel_datumless | NO AUTOMATIC CLEANUP - If you use this, you better manually free it later! |
| setup_available_channels | Sets up all available sound channels |
List of all channels as numbers
lower iteration position - Incremented and looped to get "random" sound channels for normal sounds. The channel at this index is returned when asking for a random channel.
higher reserve position - decremented and incremented to reserve sound channels, anything above this is reserved. The channel at this index is the highest unreserved channel.
Amount of channels to reserve for random usage rather than reservations being allowed to reserve all channels. Also a nice safeguard for when someone screws up.
Associative list of all reserved channels associated to their position. "[channel_number]" = index as number
Assoc list, "[channel]" = either the datum using it or TRUE for an unsafe-reserved (datumless reservation) channel
Assoc list datum = list(channel1, channel2, ...) for what channels something reserved.
How many channels we have left
Frees a channel and updates the datastructure. Private proc.
Frees all the channels a datum is using
+Arguments:
+Frees all datumless channels
Removes a channel from using list
+Arguments:
+Random available channel, returns number
Random available channel, returns text
Reserves a channel and updates the datastructure. Private proc.
Reserves a channel for a datum. Automatic cleanup only when the datum is deleted.
+Returns an integer for channel +Arguments:
+NO AUTOMATIC CLEANUP - If you use this, you better manually free it later!
+Returns an integer for channel
Sets up all available sound channels
Vars | |
| default_wait | How many subsystem fires between most tab updates |
|---|---|
| mc_wait | How many subsystem fires between updates of the MC tab |
| num_fires | How many full runs this subsystem has completed. used for variable rate refreshes. |
| status_wait | How many subsystem fires between updates of the status tab |
Procs | |
| immediate_send_stat_data | immediately update the active statpanel tab of the target client |
| refresh_client_obj_view | Set the atoms we're meant to display |
| return_object_images | Returns all our ready object tab images +Returns a list in the form list(list(object_name, object_ref, loaded_image), ...) |
How many subsystem fires between most tab updates
How many subsystem fires between updates of the MC tab
How many full runs this subsystem has completed. used for variable rate refreshes.
How many subsystem fires between updates of the status tab
immediately update the active statpanel tab of the target client
Set the atoms we're meant to display
Returns all our ready object tab images +Returns a list in the form list(list(object_name, object_ref, loaded_image), ...)
Vars | |
| basehtml | The HTML base used for all UIs. |
|---|---|
| current_run | A list of UIs scheduled to process |
| open_uis | A list of open UIs |
| open_uis_by_src | A list of open UIs, grouped by src_object. |
Procs | |
| close_all_uis | public |
| close_uis | public |
| close_user_uis | public |
| force_close_all_windows | public |
| force_close_window | public |
| get_open_ui | public |
| on_close | private |
| on_logout | private |
| on_open | private |
| on_transfer | private |
| request_pooled_window | public |
| try_update_ui | public |
| update_uis | public |
| update_user_uis | public |
The HTML base used for all UIs.
A list of UIs scheduled to process
A list of open UIs
A list of open UIs, grouped by src_object.
public
+Close all UIs regardless of their attachment to src_object.
+return int The number of UIs closed.
public
+Close all UIs attached to src_object.
+required src_object datum The object/datum which owns the UIs.
+return int The number of UIs closed.
public
+Close all UIs belonging to a user.
+required user mob The mob who opened/is using the UI. +optional src_object datum If provided, only close UIs belonging this src_object.
+return int The number of UIs closed.
public
+Force closes all tgui windows.
+required user mob
public
+Force closes the tgui window by window_id.
+required user mob +required window_id string
public
+Get a open UI given a user and src_object.
+required user mob The mob who opened/is using the UI. +required src_object datum The object/datum which owns the UI.
+return datum/tgui The found UI.
private
+Remove a UI from the list of open UIs.
+required ui datum/tgui The UI to be removed.
+return bool If the UI was removed or not.
private
+Handle client logout, by closing all their UIs.
+required user mob The mob which logged out.
+return int The number of UIs closed.
private
+Add a UI to the list of open UIs.
+required ui datum/tgui The UI to be added.
private
+Handle clients switching mobs, by transferring their UIs.
+required user source The client's original mob. +required user target The client's new mob.
+return bool If the UIs were transferred.
public
+Requests a usable tgui window from the pool. +Returns null if pool was exhausted.
+required user mob +return datum/tgui
public
+Try to find an instance of a UI, and push an update to it.
+required user mob The mob who opened/is using the UI. +required src_object datum The object/datum which owns the UI. +optional ui datum/tgui The UI to be updated, if it exists. +optional force_open bool If the UI should be re-opened instead of updated.
+return datum/tgui The found UI.
public
+Update all UIs attached to src_object.
+required src_object datum The object/datum which owns the UIs.
+return int The number of UIs updated.
public
+Update all UIs belonging to a user.
+required user mob The mob who opened/is using the UI. +optional src_object datum If provided, only update UIs belonging this src_object.
+return int The number of UIs updated.
Vars | |
| impact_sounds | How many throw impact sounds have happened this tick. |
|---|---|
| impact_sounds_cap | How many throw impact sounds we allow per tick. |
| last_impact_sounds | How many sounds there were last tick. |
| skipped_sounds | How many sounds we've skipped due to hitting the per-tick cap. |
How many throw impact sounds have happened this tick.
How many throw impact sounds we allow per tick.
How many sounds there were last tick.
How many sounds we've skipped due to hitting the per-tick cap.
Vars | |
| Bible_deity_name | Name of the bible deity |
|---|---|
| Bible_icon_state | icon_state the chaplain has chosen for his bible |
| Bible_item_state | item_state the chaplain has chosen for his bible |
| Bible_name | Name of the bible |
| cinematic | Used for station explosion cinematic |
| cult_data | Cult static info, used for things like sprites. Someone should refactor the sprites out of it someday and just use SEPERATE ICONS DEPNDING ON THE TYPE OF CULT... like a sane person |
| current_state | Current status of the game. See code__DEFINES\game.dm |
| delay_end | If set to TRUE, the round will not restart on it's own |
| end_state | Server end state (Did we end properly or reboot or nuke or what) |
| flagged_antag_rollers | List of ckeys who had antag rolling issues flagged |
| force_ending | Do we want to force-end as soon as we can |
| force_start | Do we want to force-start as soon as we can |
| hide_mode | Leave here at FALSE ! setup() will take care of it when needed for Secret mode -walter0o |
| login_music | The current pick of lobby music played in the lobby |
| minds | List of all minds in the game. Used for objective tracking |
| mode | Our current game mode |
| mode_result | Gamemode result (For things like cult or nukies which can end multiple ways) |
| next_autotransfer | Holder for inital autotransfer vote timer |
| pregame_timeleft | This is used for calculations for the statpanel |
| random_players | If set to nonzero, ALL players who latejoin or declare-ready join will have random appearances/genders |
| real_reboot_time | Time the real reboot kicks in |
| round_end_announced | Spam Prevention. Announce round end only once. |
| round_start_time | Time the game should start, relative to world.time |
| score | Datum used to generate the end of round scoreboard. |
| selected_tip | What will be the tip of the round? |
| ticker_going | Is the ticker currently processing? If FALSE, roundstart is delayed |
| time_game_started | Time that the round started |
| tipped | Did we broadcast the tip of the round yet? |
| triai | Global holder for triple AI mode |
Procs | |
| event_blackbox | This proc is for recording biohazard events, and blackboxing if they lived, died, or ended the round. This currently applies to: Terror spiders, Xenomorphs, and Blob. |
Name of the bible deity
icon_state the chaplain has chosen for his bible
item_state the chaplain has chosen for his bible
Name of the bible
Used for station explosion cinematic
Cult static info, used for things like sprites. Someone should refactor the sprites out of it someday and just use SEPERATE ICONS DEPNDING ON THE TYPE OF CULT... like a sane person
Current status of the game. See code__DEFINES\game.dm
If set to TRUE, the round will not restart on it's own
Server end state (Did we end properly or reboot or nuke or what)
List of ckeys who had antag rolling issues flagged
Do we want to force-end as soon as we can
Do we want to force-start as soon as we can
Leave here at FALSE ! setup() will take care of it when needed for Secret mode -walter0o
The current pick of lobby music played in the lobby
List of all minds in the game. Used for objective tracking
Our current game mode
Gamemode result (For things like cult or nukies which can end multiple ways)
Holder for inital autotransfer vote timer
This is used for calculations for the statpanel
If set to nonzero, ALL players who latejoin or declare-ready join will have random appearances/genders
Time the real reboot kicks in
Spam Prevention. Announce round end only once.
Time the game should start, relative to world.time
Datum used to generate the end of round scoreboard.
What will be the tip of the round?
Is the ticker currently processing? If FALSE, roundstart is delayed
Time that the round started
Did we broadcast the tip of the round yet?
Global holder for triple AI mode
This proc is for recording biohazard events, and blackboxing if they lived, died, or ended the round. This currently applies to: Terror spiders, Xenomorphs, and Blob.
Vars | |
| anchor_link_extra | Text that will be added to the anchor link |
|---|---|
| db_save_id | DB ID for these tickets to be logged with |
| open_detail_uis | Who has what tickets open? Maps client -> open ticket number. |
| other_ticket_name | The name of the other ticket type to convert to |
| other_ticket_permission | Which permission to look for when seeing if there is staff available for the other ticket type |
Procs | |
| makeUrlMessage | Will add the URLs usable by staff to the message and return it +Arguments: +C - The client who send the message +msg - The raw message +ticketNum - Which ticket number the ticket has |
| message_staff | Sends a message to the designated staff +Arguments: +msg - The message being send +alt - If an alternative prefix should be used or not. Defaults to TICKET_STAFF_MESSAGE_PREFIX +important - If the message is important. If TRUE it will ignore the CHAT_NO_TICKETLOGS preferences, +send a sound and flash the window. Defaults to FALSE |
| newHelpRequest | Will either make a new ticket using the given text or will add the text to an existing ticket. +Staff will get a message +Arguments: +C - The client who requests help +text - The text the client send |
Text that will be added to the anchor link
DB ID for these tickets to be logged with
Who has what tickets open? Maps client -> open ticket number.
The name of the other ticket type to convert to
Which permission to look for when seeing if there is staff available for the other ticket type
Will add the URLs usable by staff to the message and return it +Arguments: +C - The client who send the message +msg - The raw message +ticketNum - Which ticket number the ticket has
Sends a message to the designated staff +Arguments: +msg - The message being send +alt - If an alternative prefix should be used or not. Defaults to TICKET_STAFF_MESSAGE_PREFIX +important - If the message is important. If TRUE it will ignore the CHAT_NO_TICKETLOGS preferences, +send a sound and flash the window. Defaults to FALSE
Will either make a new ticket using the given text or will add the text to an existing ticket. +Staff will get a message +Arguments: +C - The client who requests help +text - The text the client send
Vars | |
| bucket_auto_reset | Boolean operator controlling if the timer SS will automatically reset buckets if it fails to invoke callbacks for an extended period of time |
|---|---|
| bucket_count | How many timers are in the buckets |
| bucket_list | List of buckets, each bucket holds every timer that has to run that byond tick |
| bucket_reset_count | How many times bucket was reset |
| bucket_resolution | world.tick_lag the bucket was designed for |
| clienttime_timers | Special timers that run in real-time, not BYOND time; these are more expensive to run and maintain |
| hashes | A hashlist dictionary used for storing unique timers |
| head_offset | world.time of the first entry in the bucket list, effectively the 'start time' of the current buckets |
| last_invoke_tick | Contains the last time that a timer's callback was invoked, or the last tick the SS fired if no timers are being processed |
| last_invoke_warning | Contains the last time that a warning was issued for not invoking callbacks |
| next_clienttime_timer_index | Keeps track of the next index to work on for client timers |
| practical_offset | Index of the wrap around pivot for buckets. buckets before this are later running buckets wrapped around from the end of the bucket list. |
| second_queue | Queue used for storing timers that do not fit into the current buckets |
| timer_id_dict | List of all active timers associated to their timer ID (for easy lookup) |
Procs | |
| get_timer_debug_string | Generates a string with details about the timed event for debugging purposes |
| reset_buckets | Destroys the existing buckets and creates new buckets from the existing timed events |
Boolean operator controlling if the timer SS will automatically reset buckets if it fails to invoke callbacks for an extended period of time
How many timers are in the buckets
List of buckets, each bucket holds every timer that has to run that byond tick
How many times bucket was reset
world.tick_lag the bucket was designed for
Special timers that run in real-time, not BYOND time; these are more expensive to run and maintain
A hashlist dictionary used for storing unique timers
world.time of the first entry in the bucket list, effectively the 'start time' of the current buckets
Contains the last time that a timer's callback was invoked, or the last tick the SS fired if no timers are being processed
Contains the last time that a warning was issued for not invoking callbacks
Keeps track of the next index to work on for client timers
Index of the wrap around pivot for buckets. buckets before this are later running buckets wrapped around from the end of the bucket list.
Queue used for storing timers that do not fit into the current buckets
List of all active timers associated to their timer ID (for easy lookup)
Generates a string with details about the timed event for debugging purposes
Destroys the existing buckets and creates new buckets from the existing timed events
Vars | |
| FOR_ADMINS_IF_VERBS_FUCKED_immediately_execute_all_verbs | if this is true all verbs immediately execute and dont queue. in case the mc is fucked or something |
|---|---|
| always_queue | always queue if possible. overides can_queue_admin_verbs but not FOR_ADMINS_IF_VERBS_FUCKED_immediately_execute_all_verbs |
| can_queue_admin_verbs | if TRUE we treat usr's with holders just like usr's without holders. otherwise they always execute immediately |
| message_admins_on_queue | if TRUE this will... message admins every time a verb is queued to this subsystem for the next tick with stats. +for obvious reasons dont make this be TRUE on the code level this is for admins to turn on |
| verb_queue | list of callbacks to procs called from verbs or verblike procs that were executed when the server was overloaded and had to delay to the next tick. +this list is ran through every tick, and the subsystem does not yield until this queue is finished. |
| verbs_executed_per_second | running average of how many verb callbacks are executed every second. used for the stat entry |
Procs | |
| can_queue_verb | subsystem-specific check for whether a callback can be queued. +intended so that subsystem subtypes can verify whether |
| queue_verb | queue a callback for the given proc, so that it is invoked in the next tick. +intended to only work with verbs or verblike procs called directly from client input, use as part of TRY_QUEUE_VERB() |
| run_verb_queue | runs through all of this subsystems queue of verb callbacks. +goes through the entire verb queue without yielding. +used so you can flush the queue outside of fire() without interfering with anything else subtype subsystems might do in fire(). |
if this is true all verbs immediately execute and dont queue. in case the mc is fucked or something
always queue if possible. overides can_queue_admin_verbs but not FOR_ADMINS_IF_VERBS_FUCKED_immediately_execute_all_verbs
if TRUE we treat usr's with holders just like usr's without holders. otherwise they always execute immediately
if TRUE this will... message admins every time a verb is queued to this subsystem for the next tick with stats. +for obvious reasons dont make this be TRUE on the code level this is for admins to turn on
list of callbacks to procs called from verbs or verblike procs that were executed when the server was overloaded and had to delay to the next tick. +this list is ran through every tick, and the subsystem does not yield until this queue is finished.
running average of how many verb callbacks are executed every second. used for the stat entry
subsystem-specific check for whether a callback can be queued. +intended so that subsystem subtypes can verify whether
+subtypes may include additional arguments here if they need them! you just need to include them properly +in TRY_QUEUE_VERB() and co.
queue a callback for the given proc, so that it is invoked in the next tick. +intended to only work with verbs or verblike procs called directly from client input, use as part of TRY_QUEUE_VERB()
+returns TRUE if the queuing was successful, FALSE otherwise.
runs through all of this subsystems queue of verb callbacks. +goes through the entire verb queue without yielding. +used so you can flush the queue outside of fire() without interfering with anything else subtype subsystems might do in fire().
Vars | |
| active_vote | Active vote, if any |
|---|---|
Active vote, if any
Vars | |
| alert_admins_on_craft | Will this recipe send an admin message when it's completed. |
|---|---|
| always_available | Is this recipe always available, or does it need to be learned first. |
| blacklist | Type paths of items explicitly not allowed as an ingredient. |
| category | What category it's shown under in the crafting UI. |
| name | In-game display name. |
| parts | Type paths of items that will be placed inside the result. |
| pathtools | Type paths of items needed but not consumed. |
| reqs | Type paths of items consumed associated with how many are needed. |
| result | Type paths of item(s) resulting from this craft. |
| subcategory | What subcategory it's shown under in the crafting UI. (e.g 'Ammo' under 'Weapons') |
| time | Crafting time in deciseconds. |
| tools | Tool behaviours of items needed but not consumed. |
Will this recipe send an admin message when it's completed.
Is this recipe always available, or does it need to be learned first.
Type paths of items explicitly not allowed as an ingredient.
What category it's shown under in the crafting UI.
In-game display name.
Type paths of items that will be placed inside the result.
Type paths of items needed but not consumed.
Type paths of items consumed associated with how many are needed.
Type paths of item(s) resulting from this craft.
What subcategory it's shown under in the crafting UI. (e.g 'Ammo' under 'Weapons')
Crafting time in deciseconds.
Tool behaviours of items needed but not consumed.
Holder for CUIs
+This datum is a holder that is essentially a "model" of the customuseritems
+database table, and is used for giving people their CUIs on spawn.
+It is instanced as part of the client data loading framework on the client.
Vars | |
| all_characters_allowed | Can this be used on all characters? |
|---|---|
| all_jobs_allowed | Are all jobs allowed? |
| allowed_jobs | List of allowed jobs |
| characer_name | Name of the character that can have this item. |
| item_desc_override | Custom item description override |
| item_name_override | Custom item name override |
| object_typepath | Custom item typepath |
| raw_job_mask | Raw job mask |
Procs | |
| parse_info | CUI Info Parser |
Can this be used on all characters?
Are all jobs allowed?
List of allowed jobs
Name of the character that can have this item.
Custom item description override
Custom item name override
Custom item typepath
Raw job mask
CUI Info Parser
+Parses all the raw info into usable stuff, and also does validity checks +Returns TRUE if its a valid item, and FALSE if not
+Arguments:
+Vars | |
| account_database | money account database this PDA is connected to |
|---|---|
| last_transaction | world time of last transaction, used for cooldowns (to protect against transfer spams or accidental double clicks) |
| user_account | the money account tethered to this program |
Procs | |
| input_account_pin | attempted new security level is NOT an available option, likely user spoofing values |
money account database this PDA is connected to
world time of last transaction, used for cooldowns (to protect against transfer spams or accidental double clicks)
the money account tethered to this program
attempted new security level is NOT an available option, likely user spoofing values
Datum used to hold information about a product in a vending machine
Vars | |
| amount | How many of this product we currently have |
|---|---|
| max_amount | How many we can store at maximum |
| price | Price to buy one |
| product_path | Typepath of the product that is created when this record "sells" |
How many of this product we currently have
How many we can store at maximum
Price to buy one
Typepath of the product that is created when this record "sells"
Datum based handler for all database queries
+Holds information regarding inputs, status, and outputs
Vars | |
| affected | How many rows were affected by the query |
|---|---|
| arguments | An associative list of parameters to be substituted into the statement |
| connection | The connection being used with this query |
| in_progress | Is the query currently in progress |
| item | List of data values populated by NextRow() |
| last_activity | What was our last activity |
| last_activity_time | When was our last activity |
| last_error | What was our last error, if any |
| last_insert_id | ID of the last inserted row |
| next_row_to_take | Counter of the next row to take |
| rows | List of all rows returned |
| sql | The SQL statement being executed with :parameter placeholders |
Procs | |
| Activity | Activity Update Handler |
| Execute | Main Execution Handler |
| NextRow | Proc to get the next row in a DB query |
| run_query | Actual Query Runner |
| warn_execute | Wrapped for warning on execution |
How many rows were affected by the query
An associative list of parameters to be substituted into the statement
The connection being used with this query
Is the query currently in progress
List of data values populated by NextRow()
What was our last activity
When was our last activity
What was our last error, if any
ID of the last inserted row
Counter of the next row to take
List of all rows returned
The SQL statement being executed with :parameter placeholders
Activity Update Handler
+Sets the last activity text to the argument input, as well as updating the activity time
+Arguments:
+Main Execution Handler
+Invoked by [warn_execute()] +This handles query error logging, as well as invoking the actual runner +Arguments:
+Proc to get the next row in a DB query
+Cycles item to the next row in the DB query, if multiple were fetched
Actual Query Runner
+This does the main query with the database and the rust calls themselves
+Arguments:
+Wrapped for warning on execution
+You should use this proc when running the SQL statement. It will auto inform the user and the online admins if a query fails
+Arguments:
+Vars | |
| can_approve_crates | Can this department member approve crates for the department? |
|---|---|
| member_account | This department members money account |
| name | Name of the department member |
| role | Occupation of the department member |
Can this department member approve crates for the department?
This department members money account
Name of the department member
Occupation of the department member
Design Datums
+All the data for building stuff. +Datum for object designs, used in construction
Vars | |
| requires_whitelist | Determines whether or not we get to get a design blueprint from a disk |
|---|---|
Determines whether or not we get to get a design blueprint from a disk
Holder datum for discord embeds
+Used in /datum/discord_webhook_payload and serves as a code-first means to add an embed. +See https://discord.com/developers/docs/resources/channel#embed-object
Vars | |
| embed_colour | Colour of the strip on the side of the embed. Must be in hexadecimal WITHOUT leading hash |
|---|---|
| embed_content | Content of the embed |
| embed_timestamp | Timestamp the embed was sent at. Must be in 8601 format. Will be autoset on /New() |
| embed_title | Title of the embed |
| fields | List of all fields in the embed |
Procs | |
| serialize2list | Embed Serializer |
Colour of the strip on the side of the embed. Must be in hexadecimal WITHOUT leading hash
Content of the embed
Timestamp the embed was sent at. Must be in 8601 format. Will be autoset on /New()
Title of the embed
List of all fields in the embed
Embed Serializer
+Converts the DM embed object into JSON for a POST request. +Not called serialize() because thats a proc at the /datum level already
Holder datum for discord embed fields
+Used in /datum/discord_embed and serves as a code-first means to add fields to an embed +See https://discord.com/developers/docs/resources/channel#embed-object-embed-field-structure
Vars | |
| field_content | Content of the field |
|---|---|
| field_name | Name of the field |
| inline | Inline flag |
Content of the field
Name of the field
Inline flag
Vars | |
| last_administration_ping | Last time the administrator ping was dropped. This ensures administrators cannot be mass pinged if a large chunk of ahelps go off at once (IE: tesloose) |
|---|---|
| last_mentor_ping | Last time the mentor ping was dropped. This ensures mentors cannot be mass pinged if a large chunk of mhelps go off at once. |
Last time the administrator ping was dropped. This ensures administrators cannot be mass pinged if a large chunk of ahelps go off at once (IE: tesloose)
Last time the mentor ping was dropped. This ensures mentors cannot be mass pinged if a large chunk of mhelps go off at once.
Holder datum for discord webhook POST send data
+Holds all information that a webhook would need, +as well as a method to serialize the entire thing into JSON. +See https://discord.com/developers/docs/resources/webhook#execute-webhook-jsonform-params
Vars | |
| embeds | List of all embed objects in the message |
|---|---|
| webhook_content | Content of the webhook message |
| webhook_name | Name the webhook user should post as |
Procs | |
| serialize2json | Webhook Serializer |
List of all embed objects in the message
Content of the webhook message
Name the webhook user should post as
Webhook Serializer
+Converts the DM webhook object into JSON for a POST request. +Not called serialize() because thats a proc at the /datum level already
Vars | |
| allow_dead | Allow the virus to infect and process while the affected_mob is dead |
|---|---|
| discovered | If TRUE, this virus will show up on medical HUDs. Automatically set when it reaches mid-stage. |
| discovery_threshold | The fraction of stages the virus must at least be at to show up on medical HUDs. Rounded up. |
| medical_name | Used for identification of viruses in the Medical Records Virus Database |
Allow the virus to infect and process while the affected_mob is dead
If TRUE, this virus will show up on medical HUDs. Automatically set when it reaches mid-stage.
The fraction of stages the virus must at least be at to show up on medical HUDs. Rounded up.
Used for identification of viruses in the Medical Records Virus Database
Vars | |
| magic_fashion | A mapping of num2text(SLOT_HUD_XYZ) -> item path |
|---|---|
A mapping of num2text(SLOT_HUD_XYZ) -> item path
Vars | |
| cure_stage | How far this particular virus is in being cured (0-4) |
|---|---|
| stage_timer | Cooldown until the virus can advance to the next stage |
How far this particular virus is in being cured (0-4)
Cooldown until the virus can advance to the next stage
Procs | |
| load_map | Construct the model map and control the loading process |
|---|---|
| parse_grid | Fill a given tile with its area/turf/objects/mobs +Variable model is one full map line (e.g /turf/simulated/wall{icon_state = "rock"},/area/mine/dangerous/explored) |
| parse_value | Tries to parse the given value_text. Will fallback on the value_text as a string if it fails |
Construct the model map and control the loading process
+WORKING :
+If measureOnly is set, then no atoms will be created, and all this will do
+is return the bounds after parsing the file
If you need to freeze init while you're working, you can use the spacial allocator's +"add_dirt" and "remove_dirt" which will put initializations on hold until you say +the word. This is important for loading large maps such as the cyberiad, where +atmos will attempt to start before it's ready, causing runtimes galore if init is +allowed to romp unchecked.
Fill a given tile with its area/turf/objects/mobs +Variable model is one full map line (e.g /turf/simulated/wall{icon_state = "rock"},/area/mine/dangerous/explored)
+WORKING :
+Read the model string, member by member (delimiter is ',')
+Get the path of the atom and store it into a list
+a) Check if the member has variables (text within '{' and '}')
+b) Construct an associative list with found variables, if any (the atom index in members is the same as its variables in members_attributes)
+Instanciates the atom with its variables
+Tries to parse the given value_text. Will fallback on the value_text as a string if it fails
Vars | |
| number | The number of objects the effect system will spawn |
|---|---|
The number of objects the effect system will spawn
A holder for simple behaviour that can be attached to many different types
+Only one element of each type is instanced during game init. +Otherwise acts basically like a lightweight component.
Vars | |
| element_flags | Option flags for element behaviour |
|---|---|
| id_arg_index | The index of the first attach argument to consider for duplicate elements |
Procs | |
| Attach | Activates the functionality defined by the element on the given target datum |
| Detach | Deactivates the functionality defines by the element on the given datum |
Option flags for element behaviour
The index of the first attach argument to consider for duplicate elements
+Is only used when flags contains ELEMENT_BESPOKE
+This is infinity so you must explicitly set this
Activates the functionality defined by the element on the given target datum
Deactivates the functionality defines by the element on the given datum
Apply this to a turf (usually a wall) and it will be destroyed instantly by any explosion. +Most walls can already be destroyed by explosions so this is largely for usually indestructible ones. +For applying it in a map editor, use /obj/effect/mapping_helpers/bombable_wall
Procs | |
| detonate | If we get blowed up, move to the next turf |
|---|---|
| on_examined | Show a little extra on examine |
| turf_changed | If this turf becomes something else we either just went off or regardless don't want this any more |
If we get blowed up, move to the next turf
Show a little extra on examine
If this turf becomes something else we either just went off or regardless don't want this any more
When attached to something, will make that thing shatter into shards on throw impact or z level falling
Vars | |
| number_of_shards | How many shards total are made when the thing we're attached to shatters |
|---|---|
| shard_type | What type of item is spawned as a 'shard' once the shattering happens |
| shattering_sound | What sound plays when the thing we're attached to shatters |
Procs | |
| on_throw_impact | Tells the parent to shatter if we are thrown and impact something |
| shatter | Handles the actual shattering part, throwing shards of whatever is defined on the component everywhere |
How many shards total are made when the thing we're attached to shatters
What type of item is spawned as a 'shard' once the shattering happens
What sound plays when the thing we're attached to shatters
Tells the parent to shatter if we are thrown and impact something
Handles the actual shattering part, throwing shards of whatever is defined on the component everywhere
squish.dm
+It's an element that squishes things. After the duration passes, it reverses the transformation it squished with, taking into account if they are a different orientation than they started (read: rotationally-fluid)
+Normal squishes apply vertically, as if the target is being squished from above, but you can set reverse to TRUE if you want to squish them from the sides, like if they pancake into a wall from the East or West
An element for atoms that, when dragged and dropped onto a mob, opens a strip panel.
Vars | |
| items | An assoc list of keys to /datum/strippable_item |
|---|---|
| strip_menus | An existing strip menus |
An assoc list of keys to /datum/strippable_item
An existing strip menus
Most of the text that's not someone talking is based off of this.
Vars | |
| age_based | Whether or not to adjust the frequency of the emote sound based on age. |
|---|---|
| audio_cooldown | How long is the cooldown on the audio of the emote, if it has one? |
| bypass_unintentional_cooldown | If true, an emote will completely bypass any cooldown when called unintentionally. Necessary for things like deathgasp. |
| cooldown | The cooldown between the uses of the emote. |
| emote_target_type | If our target behavior isn't to ignore, what should we look for with targets? |
| emote_type | Whether the emote is visible or audible. |
| hands_use_check | Checks if the mob can use its hands before performing the emote. |
| key | What calls the emote. |
| key_third_person | This will also call the emote. |
| max_stat_allowed | How unconscious/dead can you be while still being able to use this emote intentionally? +If this is set to DEFAULT_STAT_ALLOWED, it'll behave as if it isn't set. |
| max_unintentional_stat_allowed | Same as above, how unconscious/dead do you need to be to have this emote forced out of you? +If this is set to DEFAULT_STAT_ALLOWED, it'll behave as if it isn't set. |
| message | Message displayed when emote is used. |
| message_AI | Message displayed if the user is an AI. |
| message_alien | Message displayed if the user is a grown alien. |
| message_larva | Message displayed if the user is an alien larva. |
| message_mime | Message displayed if the user is a mime. |
| message_monkey | Message displayed if the user is a monkey. |
| message_observer | Message to display if the user is a spooky observer ghost. |
| message_param | Message with %t at the end to allow adding params to the message, like for mobs doing an emote relatively to something else. +Set this to EMOTE_PARAM_USE_POSTFIX to just use the postfix. |
| message_postfix | Message postfix with %t used when we don't want to use message_param for our targeting. Used for things like message_monkey or message_mime. +Punctuation from the message will be stripped when this is applied, so make sure it's punctuated as well. |
| message_robot | Message displayed if the user is a robot. |
| message_simple | Message to display if the user is a simple_animal. |
| mob_type_allowed_typecache | Types that are allowed to use that emote. |
| mob_type_blacklist_typecache | Types that are NOT allowed to use that emote. |
| mob_type_ignore_stat_typecache | Types that can use this emote regardless of their state. |
| muzzle_ignore | If the emote type is EMOTE_MOUTH but should still bypass a muzzle. |
| muzzled_noises | Sounds emitted when the user is muzzled. Generally used like "[user] makes a pick(muzzled_noises) noise!" |
| only_forced_audio | If true, this emote will only make a sound effect when called unintentionally. |
| only_unintentional | Whether or not the emote can even be called at all if it's not intentional |
| param_desc | Description appended to the emote name describing what the target should be, like for help commands. |
| sound | Sound to play when emote is called. If you want to adjust this dynamically, see get_sound(). |
| species_type_blacklist_typecache | Species types which the emote will be exclusively not available to. Should be subclasses of /datum/species |
| species_type_whitelist_typecache | Species types which the emote will be exclusively available to. Should be subclasses of /datum/species |
| stat_allowed | How conscious do you need to be to use this emote intentionally? |
| target_behavior | If we get a target, how do we want to treat it? |
| unintentional_audio_cooldown | If the emote is triggered unintentionally, how long would that cooldown be? |
| unintentional_stat_allowed | How conscious do you need to be to have this emote forced out of you? |
| vary | Whether or not to vary the sound of the emote. |
| volume | How loud is the audio emote? |
Procs | |
| act_on_target | Perform an action on the target of an emote, if one was found. |
| can_run_emote | Check to see if the user is allowed to run the emote. |
| can_vocalize_emotes | Return whether a user should be able to vocalize emotes or not, due to a mask or inability to speak. +If this returns false, any mouth emotes will be replaced with muzzled noises. |
| check_cooldown | Check whether or not an emote can be used due to a cooldown. +This applies to per-emote cooldowns, preventing individual emotes from being used (intentionally) too frequently. +This also checks audio cooldowns, so that intentional uses of audio emotes across the mob are time-constrained. |
| find_target | Find a target for the emote based on the message parameter fragment passed in. |
| get_sound | To get the sound that the emote plays, for special sound interactions depending on the mob. |
| get_volume | Get the volume of the audio emote to play. |
| play_sound_effect | Play the sound effect in an emote. +If you want to change the way the playsound call works, override this. +Note! If you want age_based to work, you need to force vary to TRUE. |
| replace_pronoun | Replace pronouns in the inputed string with the user's proper pronouns. |
| reset_emote | Reset the emote back to its original state. +Necessary if you've made modifications to the emote itself over the course of its +execution, as emotes are singletons, and changes would be reflected on every usage of the emote. |
| run_emote | Handles the modifications and execution of emotes. |
| runechat_emote | Send an emote to runechat for all (listening) users in the vicinity. |
| select_message_type | Selects the message type to override the message with. |
| select_param | Replaces the %t in the message in message_param by params. |
| should_play_sound | Check to see if the user should play a sound when performing the emote. |
| try_run_emote | Try to run an emote, checking can_run_emote once before executing the emote itself. |
Whether or not to adjust the frequency of the emote sound based on age.
How long is the cooldown on the audio of the emote, if it has one?
If true, an emote will completely bypass any cooldown when called unintentionally. Necessary for things like deathgasp.
The cooldown between the uses of the emote.
If our target behavior isn't to ignore, what should we look for with targets?
Whether the emote is visible or audible.
Checks if the mob can use its hands before performing the emote.
What calls the emote.
This will also call the emote.
How unconscious/dead can you be while still being able to use this emote intentionally? +If this is set to DEFAULT_STAT_ALLOWED, it'll behave as if it isn't set.
Same as above, how unconscious/dead do you need to be to have this emote forced out of you? +If this is set to DEFAULT_STAT_ALLOWED, it'll behave as if it isn't set.
Message displayed when emote is used.
Message displayed if the user is an AI.
Message displayed if the user is a grown alien.
Message displayed if the user is an alien larva.
Message displayed if the user is a mime.
Message displayed if the user is a monkey.
Message to display if the user is a spooky observer ghost.
Message with %t at the end to allow adding params to the message, like for mobs doing an emote relatively to something else. +Set this to EMOTE_PARAM_USE_POSTFIX to just use the postfix.
Message postfix with %t used when we don't want to use message_param for our targeting. Used for things like message_monkey or message_mime. +Punctuation from the message will be stripped when this is applied, so make sure it's punctuated as well.
Message displayed if the user is a robot.
Message to display if the user is a simple_animal.
Types that are allowed to use that emote.
Types that are NOT allowed to use that emote.
Types that can use this emote regardless of their state.
If the emote type is EMOTE_MOUTH but should still bypass a muzzle.
Sounds emitted when the user is muzzled. Generally used like "[user] makes a pick(muzzled_noises) noise!"
If true, this emote will only make a sound effect when called unintentionally.
Whether or not the emote can even be called at all if it's not intentional
Description appended to the emote name describing what the target should be, like for help commands.
Sound to play when emote is called. If you want to adjust this dynamically, see get_sound().
Species types which the emote will be exclusively not available to. Should be subclasses of /datum/species
Species types which the emote will be exclusively available to. Should be subclasses of /datum/species
How conscious do you need to be to use this emote intentionally?
If we get a target, how do we want to treat it?
If the emote is triggered unintentionally, how long would that cooldown be?
How conscious do you need to be to have this emote forced out of you?
Whether or not to vary the sound of the emote.
How loud is the audio emote?
Perform an action on the target of an emote, if one was found.
+This gets called in select_param if a valid object target was found, and should let you interact with the +object being targeted while it's still in scope.
+Check to see if the user is allowed to run the emote.
+Arguments:
+Returns a bool about whether or not the user can run the emote.
Return whether a user should be able to vocalize emotes or not, due to a mask or inability to speak. +If this returns false, any mouth emotes will be replaced with muzzled noises.
Check whether or not an emote can be used due to a cooldown. +This applies to per-emote cooldowns, preventing individual emotes from being used (intentionally) too frequently. +This also checks audio cooldowns, so that intentional uses of audio emotes across the mob are time-constrained.
+Arguments:
+Returns FALSE if the cooldown is not over, TRUE if the cooldown is over.
Find a target for the emote based on the message parameter fragment passed in.
+Returns a matched target, or null if a specific match couldn't be made.
To get the sound that the emote plays, for special sound interactions depending on the mob.
+Arguments:
+Returns the sound that will be made while sending the emote.
Get the volume of the audio emote to play.
+Override this if you want to dynamically change the volume of an emote.
+Arguments:
+Returns the volume level for an emote's audio component.
Play the sound effect in an emote. +If you want to change the way the playsound call works, override this. +Note! If you want age_based to work, you need to force vary to TRUE.
+Replace pronouns in the inputed string with the user's proper pronouns.
+Specifically replaces they/them/their pronouns with the user's pronouns, as well as %s (like theirs)
+Arguments:
+Returns the modified msg string.
Reset the emote back to its original state. +Necessary if you've made modifications to the emote itself over the course of its +execution, as emotes are singletons, and changes would be reflected on every usage of the emote.
Handles the modifications and execution of emotes.
+In general, what this does:
+You most likely want to use try_run_emote() anywhere you would otherwise call this directly, +as that will incorporate can_run_emote() checking as well.
+Arguments:
+Returns TRUE if it was able to run the emote, FALSE otherwise.
Send an emote to runechat for all (listening) users in the vicinity.
+Selects the message type to override the message with.
+Arguments:
+Returns the new message, or msg directly, if no change was needed.
Replaces the %t in the message in message_param by params.
+The behavior of this proc is particularly dependent on target_behavior and emote_target_type.
+If target_behavior is EMOTE_TARGET_BHVR_RAW, we ignore any sort of target searching.
+Otherwise, we try to find a target in view to call this emote on based on emote_target_type.
If you want to call something on the target object itself while it's still in scope, override act_on_target().
+Arguments:
+Returns the modified string, or null if the given parameter is invalid. May also return EMOTE_ACT_STOP_EXECUTION if acting on the target should stop emote execution.
Check to see if the user should play a sound when performing the emote.
+Arguments:
+Returns a bool about whether or not the user should play a sound when performing the emote.
Try to run an emote, checking can_run_emote once before executing the emote itself.
+Returns TRUE if the emote was able to be run (or failed successfully), or FALSE if the emote is unusable.
Emotes usable by brains, but only while they're in MMIs.
Vars | |
| self_message | The message that will be displayed to themselves, since brains can't really see their own emotes |
|---|---|
The message that will be displayed to themselves, since brains can't really see their own emotes
Vars | |
| species_custom_messages | Custom messages that should be applied based on species +Should be an associative list of species name: message |
|---|---|
| species_custom_mime_messages | Custom messages applied to mimes of a particular species |
Custom messages that should be applied based on species +Should be an associative list of species name: message
Custom messages applied to mimes of a particular species
Vars | |
| action_name | title override, used for the re-use message. |
|---|---|
| status | Status effect to apply when this emote is used. Should be a subtype |
title override, used for the re-use message.
Status effect to apply when this emote is used. Should be a subtype
Vars | |
| move | If the user used parameters, the move that will be made. |
|---|---|
If the user used parameters, the move that will be made.
Vars | |
| mood | Apply mood of the emote. Set this to MOOD_RESET to cause the emote to reset the mood back to default. |
|---|---|
Apply mood of the emote. Set this to MOOD_RESET to cause the emote to reset the mood back to default.
Vars | |
| applied_traits | If the spellblade has traits, has it applied them? |
|---|---|
| cooldown | stores the world.time after which it can be used again, the initial(cooldown) is the cooldown between activations. |
| desc | used for wizards/cultists examining the runes on the blade |
| name | used for blackbox logging |
| power | used for damage values |
| ranged | whether the enchant procs despite not being in proximity |
If the spellblade has traits, has it applied them?
stores the world.time after which it can be used again, the initial(cooldown) is the cooldown between activations.
used for wizards/cultists examining the runes on the blade
used for blackbox logging
used for damage values
whether the enchant procs despite not being in proximity
NOTE: Times are measured in master controller ticks!
Vars | |
| activeFor | How long the event has existed. You don't need to change this. |
|---|---|
| announceWhen | When in the lifetime to call announce(). |
| endWhen | When in the lifetime the event should end. |
| endedAt | When this event ended. |
| impact_area | The area the event will hit |
| isRunning | If this event is currently running. You should not change this. |
| name | The human-readable name of the event |
| noAutoEnd | Does the event end automatically after endWhen passes? |
| severity | Severity. Lower means less severe, higher means more severe. Does not have to be supported. Is set on New(). |
| startWhen | When in the lifetime to call start(). |
| startedAt | When this event started. |
Procs | |
| announce | Called when the tick is equal to the announceWhen variable. |
| end | Called on or after the tick is equal or more than endWhen |
| fake_announce | Override this to make a custom fake announcement that differs from the normal announcement. +Used for false alarms. +If this proc returns TRUE, the regular Announce() won't be called. |
| kill | Called when start(), announce() and end() has all been called. |
| lastProcessAt | Returns the latest point of event processing. |
| process | Do not override this proc, instead use the appropiate procs. |
| setup | Called first before processing. |
| start | Called when the tick is equal to the startWhen variable. |
| tick | Called on or after the tick counter is equal to startWhen. |
How long the event has existed. You don't need to change this.
When in the lifetime to call announce().
When in the lifetime the event should end.
When this event ended.
The area the event will hit
If this event is currently running. You should not change this.
The human-readable name of the event
Does the event end automatically after endWhen passes?
Severity. Lower means less severe, higher means more severe. Does not have to be supported. Is set on New().
When in the lifetime to call start().
When this event started.
Called when the tick is equal to the announceWhen variable.
+Allows you to announce before starting or vice versa. +Only called once. +Ensure no sleep is called. Use INVOKE_ASYNC to call procs which do.
Called on or after the tick is equal or more than endWhen
+You can include code related to the event ending. +Do not place spawn() in here, instead use tick() to check for +the activeFor variable. +For example: if(activeFor == myOwnVariable + 30) doStuff() +Only called once. +Ensure no sleep is called. Use INVOKE_ASYNC to call procs which do.
Override this to make a custom fake announcement that differs from the normal announcement. +Used for false alarms. +If this proc returns TRUE, the regular Announce() won't be called.
Called when start(), announce() and end() has all been called.
Returns the latest point of event processing.
Do not override this proc, instead use the appropiate procs.
+This proc will handle the calls to the appropiate procs. +Ensure none of the code paths have a sleep in them. Use INVOKE_ASYNC to call procs which do.
Called first before processing.
+Allows you to setup your event, such as randomly +setting the startWhen and or announceWhen variables. +Only called once.
Called when the tick is equal to the startWhen variable.
+Allows you to start before announcing or vice versa. +Only called once. +Ensure no sleep is called. Use INVOKE_ASYNC to call procs which do.
Called on or after the tick counter is equal to startWhen.
+You can include code related to your event or add your own +time stamped events. +Called more than once. +Ensure no sleep is called. Use INVOKE_ASYNC to call procs which do.
Vars | |
| announce_sound | Sound effect used |
|---|---|
| prefix_message | The prefix message for the anomaly annoucement. |
Sound effect used
The prefix message for the anomaly annoucement.
Vars | |
| blacklisted_jobs | Jobs that are not allowed to be picked for the bureaucratic error |
|---|---|
| uncommon_jobs | Jobs that pass an additional 40% chance per roll to be picked for the bureaucratic error |
Jobs that are not allowed to be picked for the bureaucratic error
Jobs that pass an additional 40% chance per roll to be picked for the bureaucratic error
Vars | |
| chosen_disease | The type of disease that patient zero will be infected with. |
|---|---|
The type of disease that patient zero will be infected with.
Vars | |
| spawn_area_type | The area we'll be spawning things in |
|---|---|
| spawn_areas | All possible areas for spawning, matched with their pretty names |
| vermin | Which kind of vermin we'll be spawning (one of the three defines) |
| vermstring | Pretty name for the vermin we're spawning |
The area we'll be spawning things in
All possible areas for spawning, matched with their pretty names
Which kind of vermin we'll be spawning (one of the three defines)
Pretty name for the vermin we're spawning
Dimensional tear event.
+On triggering, nearby machines and lights flicker. After a few seconds, +nearby machines and lights break. A /obj/effect/tear appears, spawning up +to 10 random hell mobs including a guaranteed tear hellhound, then disappears.
Vars | |
| enabled | Whether or not the event is available for random selection at all. |
|---|---|
| max_weight | The maximum weight that this event will have. |
| min_weight | The minimum weight that this event will have. Only used if non-zero. |
| one_shot | If true, then the event will not be re-added to the list of available events |
| role_weights | A list of roles that add weight to the event |
| severity | the current severity of this event |
| weight | The base weight of this event. A zero means it may never fire, but see get_weight() |
| weight_mod | A modifier applied to all event weights (role and base), respects min and max |
Whether or not the event is available for random selection at all.
The maximum weight that this event will have.
The minimum weight that this event will have. Only used if non-zero.
If true, then the event will not be re-added to the list of available events
A list of roles that add weight to the event
the current severity of this event
The base weight of this event. A zero means it may never fire, but see get_weight()
A modifier applied to all event weights (role and base), respects min and max
Describes a single feed channel. Owns a list of /datum/feed_message.
Vars | |
| admin_locked | Whether the channel is admin-locked. |
|---|---|
| author | The author of the channel. |
| author_ckey | The author's ckey |
| backup_author | The fallback author name to display if the channel is censored. |
| censored | Whether the channel is censored or not. |
| channel_name | The name of the channel. |
| description | The description of the channel. |
| frozen | Whether the channel is frozen or not. |
| icon | The channel's icon. |
| is_public | Whether the channel is public or not. |
| messages | Lazy list. Contains all /datum/feed_message pertaining to the channel. |
Procs | |
| add_message | Adds a new story to the channel and network singleton. |
| can_modify | Returns whether the given user can edit or delete this channel. |
| can_publish | Returns whether the given user can publish new stories to this channel. |
| clear | Clears the channel's information. |
| get_announce_text | Returns the text to be said by newscasters when announcing new news from a channel. |
Whether the channel is admin-locked.
The author of the channel.
The author's ckey
The fallback author name to display if the channel is censored.
Whether the channel is censored or not.
The name of the channel.
The description of the channel.
Whether the channel is frozen or not.
The channel's icon.
Whether the channel is public or not.
Lazy list. Contains all /datum/feed_message pertaining to the channel.
Adds a new story to the channel and network singleton.
+Arguments:
+Returns whether the given user can edit or delete this channel.
+Arguments:
+Returns whether the given user can publish new stories to this channel.
+Arguments:
+Clears the channel's information.
+Discards all owned stories.
Returns the text to be said by newscasters when announcing new news from a channel.
+Arguments:
+Describes a single feed story. Always owned by a /datum/feed_channel.
Vars | |
| admin_locked | Whether the story is admin-locked. |
|---|---|
| author | The author of the story. |
| author_ckey | The author's ckey (admins are watching you post WGW in the newscaster) |
| body | The textual contents of the story. |
| censor_flags | Flags that dictate the story should be censored. |
| img | The story's icon. |
| publish_time | The world.time at which the story was published. |
| title | The title of the story. |
| view_count | The number of views the story has. |
Procs | |
| clear | Clears the story's information. |
Whether the story is admin-locked.
The author of the story.
The author's ckey (admins are watching you post WGW in the newscaster)
The textual contents of the story.
Flags that dictate the story should be censored.
The story's icon.
The world.time at which the story was published.
The title of the story.
The number of views the story has.
Clears the story's information.
+Does not delete it from the owning channel.
Singleton that contains all informations related to newscasters (channels, stories).
Vars | |
| channels | Contains all of the feed channels created during the round. |
|---|---|
| stories | Contains all of the feed stories created during the round. |
| wanted_issue | The current wanted issue. |
Procs | |
| get_channel_by_author | Returns the /datum/feed_channel with the given author, or null if not found. |
| get_channel_by_idx | Returns the /datum/feed_channel at the given index, or null if not found. |
| get_channel_by_name | Returns the /datum/feed_channel with the given name, or null if not found. |
Contains all of the feed channels created during the round.
Contains all of the feed stories created during the round.
The current wanted issue.
Returns the /datum/feed_channel with the given author, or null if not found.
+Arguments:
+Returns the /datum/feed_channel at the given index, or null if not found.
+Arguments:
+Returns the /datum/feed_channel with the given name, or null if not found.
+Arguments:
+Datum to hold feedback data, which gets logged at round end
+Holds all the information being logged
Vars | |
| bookid | book id of the book this flag is attached to |
|---|---|
| category_id | the id of the report category |
| reporter | The ckey of the player who reported it |
book id of the book this flag is attached to
the id of the report category
The ckey of the player who reported it
Procs | |
| process_food | WHO NAME A PARAMETER FOR A PROC "what" holy hell |
|---|---|
WHO NAME A PARAMETER FOR A PROC "what" holy hell
Procs | |
| process_food | END OBJECT RECIPIES |
|---|---|
END OBJECT RECIPIES
Vars | |
| abductees | A list which contains the minds of all abductees |
|---|---|
| abductor_teams | How many abductor teams do we have |
| abductors | A list which contains the minds of all abductors |
| apprentices | A list of all minds that are wizard apprentices |
| changelings | A list of all minds which have the changeling antag datum |
| cult_team | The cult team datum |
| ert | A list of all the minds that have the ERT special role |
| greyshirts | A list of all the greyshirt minds |
| head_revolutionaries | A list of all the minds of head revolutionaries |
| implanted | An associative list with mindslave minds as keys and their master's minds as values. |
| rev_team | The revololution team datum |
| revolutionaries | A list of all the minds of revolutionaries |
| single_antag_positions | Each item in this list can only be rolled once on average. |
| superheroes | A list of all the minds with the superhero special role |
| supervillains | A list of all the minds with the supervillain special role |
| syndicates | A list of all the nuclear operatives' minds |
| tdm_gamemode | This var is solely to track gamemodes to track suicides/cryoing/etc and doesnt declare this a "free for all" gamemode. This is for data tracking purposes only. |
| traitors | A list of all minds which have the traitor antag datum. |
| vampire_enthralled | A list of all minds which are thralled by a vampire |
| vampires | A list of all minds which have the vampire antag datum |
| wizards | A list of all minds which have the wizard special role |
| zombie_infected | A list of all minds that are infected with the zombie virus, but aren't zombies yet |
| zombies | A list of all minds that are zombies |
Procs | |
| can_start | can_start() +Checks to see if the game can be setup and ran with the current number of players or whatnot. |
| get_end_of_round_antagonist_statistics | Gets the value of all end of round stats through auto_declare and returns them |
| post_setup | post_setup() +Everyone should now be on the station and have their normal gear. This is the place to give the special roles extra things |
| pre_setup | pre_setup() +Attempts to select players for special roles the mode might have. |
| process | process() +Called by the gameticker |
A list which contains the minds of all abductees
How many abductor teams do we have
A list which contains the minds of all abductors
A list of all minds that are wizard apprentices
A list of all minds which have the changeling antag datum
The cult team datum
A list of all the minds that have the ERT special role
A list of all the greyshirt minds
A list of all the minds of head revolutionaries
An associative list with mindslave minds as keys and their master's minds as values.
The revololution team datum
A list of all the minds of revolutionaries
Each item in this list can only be rolled once on average.
A list of all the minds with the superhero special role
A list of all the minds with the supervillain special role
A list of all the nuclear operatives' minds
This var is solely to track gamemodes to track suicides/cryoing/etc and doesnt declare this a "free for all" gamemode. This is for data tracking purposes only.
A list of all minds which have the traitor antag datum.
A list of all minds which are thralled by a vampire
A list of all minds which have the vampire antag datum
A list of all minds which have the wizard special role
A list of all minds that are infected with the zombie virus, but aren't zombies yet
A list of all minds that are zombies
can_start() +Checks to see if the game can be setup and ran with the current number of players or whatnot.
Gets the value of all end of round stats through auto_declare and returns them
post_setup() +Everyone should now be on the station and have their normal gear. This is the place to give the special roles extra things
pre_setup() +Attempts to select players for special roles the mode might have.
process() +Called by the gameticker
Vars | |
| changeling_amount | The total number of changelings allowed to be picked. |
|---|---|
| pre_changelings | A list containing references to the minds of soon-to-be changelings. This is seperate to avoid duplicate entries in the changelings list. |
The total number of changelings allowed to be picked.
A list containing references to the minds of soon-to-be changelings. This is seperate to avoid duplicate entries in the changelings list.
Vars | |
| pre_traitors | A list containing references to the minds of soon-to-be traitors. This is seperate to avoid duplicate entries in the traitors list. |
|---|---|
| traitor_scaling_coeff | How much the amount of players get divided by to determine the number of traitors. |
| traitors_possible | Hard limit on traitors if scaling is turned off. |
A list containing references to the minds of soon-to-be traitors. This is seperate to avoid duplicate entries in the traitors list.
How much the amount of players get divided by to determine the number of traitors.
Hard limit on traitors if scaling is turned off.
Vars | |
| pre_changelings | A list containing references to the minds of soon-to-be changelings. This is seperate to avoid duplicate entries in the changelings list. |
|---|---|
A list containing references to the minds of soon-to-be changelings. This is seperate to avoid duplicate entries in the changelings list.
Vars | |
| pre_vampires | list of minds of soon to be vampires |
|---|---|
list of minds of soon to be vampires
Vars | |
| have_we_populated_magivends | Tracks a one-time restock of all magivends once we get a second wizard |
|---|---|
Tracks a one-time restock of all magivends once we get a second wizard
Vars | |
| fuel_burnt | How much fuel this gas mixture burnt last reaction. |
|---|---|
| innate_heat_capacity | Heat capacity intrinsic to the container of this gas mixture. |
| synchronized | Is this mixture currently synchronized with MILLA? Always true for non-bound mixtures. |
| volume | The volume this gas mixture fills. |
| waiting_for_sync | Tracks the callbacks from synchronize() that haven't run yet. |
Procs | |
| archive | Update archived versions of variables. Returns: TRUE in all cases |
| boolean_remove | Only removes the gas if we have more than the amount |
| copy_from_turf | Copies all gas info from the turf into the gas list along with temperature +Returns: TRUE if we are mutable, FALSE otherwise |
| get_breath_partial_pressure | Takes the amount of the gas you want to PP as an argument +So I don't have to do some hacky switches/defines/magic strings +eg: +Tox_PP = get_partial_pressure(gas_mixture.toxins) +O2_PP = get_partial_pressure(gas_mixture.oxygen) |
| get_true_breath_pressure | inverse |
| heat_capacity | joules per kelvin |
| merge | Merges all air from giver into self. Deletes giver. Returns: TRUE if we are mutable, FALSE otherwise |
| mimic | Don't make calculations if there is no difference. |
| react | Performs various reactions such as combustion or fusion (LOL) +Returns: TRUE if any reaction took place; FALSE otherwise |
| remove | Proportionally removes amount of gas from the gas_mixture. +Returns: gas_mixture with the gases removed |
| remove_ratio | Proportionally removes amount of gas from the gas_mixture. +Returns: gas_mixture with the gases removed |
| return_pressure | Calculate pressure in kilopascals |
| return_volume | Calculate volume in liters |
| set_dirty | Marks this gas mixture as changed from MILLA. Does nothing on non-bound mixtures. |
| share | Performs air sharing calculations between two gas_mixtures assuming only 1 boundary length +Returns: amount of gas exchanged (+ if sharer received) |
| temperature_share | Performs temperature sharing calculations (via conduction) between two gas_mixtures assuming only 1 boundary length +Returns: new temperature of the sharer |
| thermal_energy | Calculate thermal energy in joules |
| total_moles | Calculate moles |
How much fuel this gas mixture burnt last reaction.
Heat capacity intrinsic to the container of this gas mixture.
Is this mixture currently synchronized with MILLA? Always true for non-bound mixtures.
The volume this gas mixture fills.
Tracks the callbacks from synchronize() that haven't run yet.
Update archived versions of variables. Returns: TRUE in all cases
Only removes the gas if we have more than the amount
Copies all gas info from the turf into the gas list along with temperature +Returns: TRUE if we are mutable, FALSE otherwise
Takes the amount of the gas you want to PP as an argument +So I don't have to do some hacky switches/defines/magic strings +eg: +Tox_PP = get_partial_pressure(gas_mixture.toxins) +O2_PP = get_partial_pressure(gas_mixture.oxygen)
inverse
joules per kelvin
Merges all air from giver into self. Deletes giver. Returns: TRUE if we are mutable, FALSE otherwise
Don't make calculations if there is no difference.
Performs various reactions such as combustion or fusion (LOL) +Returns: TRUE if any reaction took place; FALSE otherwise
Proportionally removes amount of gas from the gas_mixture. +Returns: gas_mixture with the gases removed
Proportionally removes amount of gas from the gas_mixture. +Returns: gas_mixture with the gases removed
Calculate pressure in kilopascals
Calculate volume in liters
Marks this gas mixture as changed from MILLA. Does nothing on non-bound mixtures.
Performs air sharing calculations between two gas_mixtures assuming only 1 boundary length +Returns: amount of gas exchanged (+ if sharer received)
Performs temperature sharing calculations (via conduction) between two gas_mixtures assuming only 1 boundary length +Returns: new temperature of the sharer
Calculate thermal energy in joules
Calculate moles
Mathematical proofs: +get_breath_partial_pressure(gas_pp) --> gas_pp/total_moles()breath_pp = pp +get_true_breath_pressure(pp) --> gas_pp = pp/breath_pptotal_moles()
+10/205 = 2.5 +10 = 2.5/520
Vars | |
| allowed_roles | List of job roles which can spawn with the item. |
|---|---|
| cost | Loadout points cost to select the item listing. |
| description | Description of the item listing. If left blank will default to the description of the pathed item. |
| display_name | Displayed name of the item listing. |
| donator_tier | Patreon donator tier needed to select this item listing. |
| gear_tweaks | List of datums which will alter the item after it has been spawned. (NYI) |
| main_typepath | Set on empty category datums to skip them being added to the list. (/datum/gear/accessory, /datum/gear/suit/coat/job, etc.) |
| path | Typepath of the item. |
| slot | Slot to equip the item to. |
| sort_category | Loadout category of the item listing. |
| subtype_selection_cost | Does selecting a second item with the same main_typepath cost loadout points. |
List of job roles which can spawn with the item.
Loadout points cost to select the item listing.
Description of the item listing. If left blank will default to the description of the pathed item.
Displayed name of the item listing.
Patreon donator tier needed to select this item listing.
List of datums which will alter the item after it has been spawned. (NYI)
Set on empty category datums to skip them being added to the list. (/datum/gear/accessory, /datum/gear/suit/coat/job, etc.)
Typepath of the item.
Slot to equip the item to.
Loadout category of the item listing.
Does selecting a second item with the same main_typepath cost loadout points.
Holder datum for ingame HTTP requests
+Holds information regarding to methods used, URL, and response, +as well as job IDs and progress tracking for async requests
Vars | |
| _raw_response | The raw response, which will be decoeded into a /datum/http_response |
|---|---|
| body | Body of the request being sent |
| cb | Callback for executing after async requests. Will be called with an argument of /datum/http_response as first argument |
| headers | Request headers being sent |
| id | The ID of the request (Only set if it is an async request) |
| in_progress | Is the request in progress? (Only set if it is an async request) |
| method | HTTP method used |
| output_file | If present, response body will be saved to this file. |
| url | URL that the request is being sent to |
Procs | |
| begin_async | Async execution starter |
| build_options | Options builder |
| execute_blocking | Blocking executor |
| into_response | Response deserializer |
| is_complete | Async completion checker |
| prepare | Preparation handler |
The raw response, which will be decoeded into a /datum/http_response
Body of the request being sent
Callback for executing after async requests. Will be called with an argument of /datum/http_response as first argument
Request headers being sent
The ID of the request (Only set if it is an async request)
Is the request in progress? (Only set if it is an async request)
HTTP method used
If present, response body will be saved to this file.
URL that the request is being sent to
Async execution starter
+Tells the request to start executing inside its own thread inside RUSTG +Preferred over blocking, but also requires SShttp to be active +As such, you cannot use this for events which may happen at roundstart (EG: IPIntel, BYOND account tracking, etc)
Options builder
+Builds options for if we want to download files with SShttp
Blocking executor
+Remains as a proof of concept to show it works, but should NEVER be used to do FFI halting the entire DD process up +Async rqeuests are much preferred, but also require the subsystem to be firing for them to be answered
Response deserializer
+Takes a HTTP request object, and converts it into a /datum/http_response +The entire thing is wrapped in try/catch to ensure it doesnt break on invalid requests +Can be called on async and blocking requests
Async completion checker
+Checks if an async request has been complete +Has safety checks built in to compensate if you call this on blocking requests, +or async requests which have already finished
Preparation handler
+Call this with relevant parameters to form the request you want to make
+Arguments:
+Holder datum for HTTP responses
+Created from calling [/datum/http_request/proc/into_response()] +Contains vars about the result of the response
Vars | |
| body | The body of the response from the server |
|---|---|
| error | Raw response if we errored |
| errored | Has the request errored |
| headers | Associative list of headers sent from the server |
| status_code | The HTTP status code of the response |
The body of the response from the server
Raw response if we errored
Has the request errored
Associative list of headers sent from the server
The HTTP status code of the response
Vars | |
| floating_actions | A list of action buttons which aren't owned by any action group, and are just floating somewhere on the hud. |
|---|---|
| hotkey_ui_hidden | This is to hide the buttons that can be used via hotkeys. (hotkeybuttons list of buttons) |
| hotkeybuttons | the buttons that can be used via hotkeys |
| hud_shown | Used for the HUD toggle (F12) |
| hud_version | Current displayed version of the HUD |
| inv_slots | atom/movable/screen/inventory objects, ordered by their slot ID. |
| inventory_shown | Whether or not their toggleable inventory (generally their contents on the left) is expanded |
| listed_actions | action group for expanded actions, the normal action set |
| palette_actions | the groups of actions, such as palette (previously normal) actions |
| plane_master_controllers | Assoc list of controller groups, associated with key string group name with value of the plane master controller ref |
| screentip_text | UI for screentips that appear when you mouse over things |
| toggleable_inventory | the screen objects which can be hidden (your human items on the left) |
Procs | |
| build_action_groups | Generates and fills new action groups with our mob's current actions |
| generate_landings | Generates visual landings for all groups that the button is not a memeber of |
| get_action_buttons_icons | This is a silly proc used in hud code code to determine what icon and icon state we should be using +for hud elements (such as action buttons) that don't have their own icon and icon state set. |
| hide_action | Removes the passed in action from its current position on the screen |
| hide_landings | Clears all currently visible landings |
| show_hud | Shows this hud's hud to some mob |
| view_audit_buttons | Ensures all of our buttons are properly within the bounds of our client's view, moves them if they're not |
A list of action buttons which aren't owned by any action group, and are just floating somewhere on the hud.
This is to hide the buttons that can be used via hotkeys. (hotkeybuttons list of buttons)
the buttons that can be used via hotkeys
Used for the HUD toggle (F12)
Current displayed version of the HUD
atom/movable/screen/inventory objects, ordered by their slot ID.
Whether or not their toggleable inventory (generally their contents on the left) is expanded
action group for expanded actions, the normal action set
the groups of actions, such as palette (previously normal) actions
Assoc list of controller groups, associated with key string group name with value of the plane master controller ref
UI for screentips that appear when you mouse over things
the screen objects which can be hidden (your human items on the left)
Generates and fills new action groups with our mob's current actions
Generates visual landings for all groups that the button is not a memeber of
This is a silly proc used in hud code code to determine what icon and icon state we should be using +for hud elements (such as action buttons) that don't have their own icon and icon state set.
+It returns a list, which is pretty much just a struct of info
Removes the passed in action from its current position on the screen
Clears all currently visible landings
Shows this hud's hud to some mob
+Arguments
+Ensures all of our buttons are properly within the bounds of our client's view, moves them if they're not
Vars | |
| desired_move_dir | Bitflags of the direction the client wishes to move. Updated instantaneously. |
|---|---|
| desired_move_dir_add | Bitflags of the buffered direction the client wishes to move. Reset on client/Move(). |
| desired_move_dir_sub | Bitflags of the buffered direction the client wishes not to move. Reset on client/Move(). |
| key_combos_held | Associative list of currently held key combos. |
| keys_held | Associative list of currently held keys. Format: keys_held[key], associated value is world.time where key was pressed. |
| move_lock | Whether the movement should be locked in place. |
Bitflags of the direction the client wishes to move. Updated instantaneously.
Bitflags of the buffered direction the client wishes to move. Reset on client/Move().
Bitflags of the buffered direction the client wishes not to move. Reset on client/Move().
Associative list of currently held key combos.
Associative list of currently held keys. Format: keys_held[key], associated value is world.time where key was pressed.
Whether the movement should be locked in place.
Instrument datums hold the data for any given instrument, as well as data on how to play it and what bounds there are to playing it.
+The datums themselves are kept in SSinstruments in a list by their unique ID. The reason it uses ID instead of typepath is to support the runtime creation of instruments. +Since songs cache them while playing, there isn't realistic issues regarding performance from accessing.
Vars | |
| HIGHEST_KEY | Don't touch this |
|---|---|
| LOWEST_KEY | Don't touch this x2 |
| abstract_type | Used for categorization subtypes |
| admin_only | Oh no - For truly troll instruments. |
| category | Category |
| id | Uniquely identifies this instrument so runtime changes are possible as opposed to paths. If this is unset, things will use path instead. |
| instrument_flags | See __DEFINES/flags/instruments.dm |
| legacy_instrument_ext | For legacy instruments, our file extension |
| legacy_instrument_path | For legacy instruments, the path to our notes |
| name | Name of the instrument |
| real_samples | Write here however many samples, follow this syntax: "%note num%"='%sample file%' eg. "27"='synthesizer/e2.ogg'. Key must never be lower than 0 and higher than 127 |
| samples | assoc list key = /datum/instrument_key. do not fill this yourself! |
| songs_using | What songs are using us |
| volume_multiplier | Volume multiplier. Synthesized instruments are quite loud and I don't like to cut off potential detail via editing. (someone correct me if this isn't a thing) |
Procs | |
| Initialize | Initializes the instrument, calculating its samples if necessary. |
| calculate_samples | For synthesized instruments, this is how the instrument generates the "keys" that a /datum/song uses to play notes. +Calculating them on the fly would be unperformant, so we do it during init and keep it all cached in a list. |
| is_ready | Checks if this instrument is ready to play. |
Don't touch this
Don't touch this x2
Used for categorization subtypes
Oh no - For truly troll instruments.
Category
Uniquely identifies this instrument so runtime changes are possible as opposed to paths. If this is unset, things will use path instead.
See __DEFINES/flags/instruments.dm
For legacy instruments, our file extension
For legacy instruments, the path to our notes
Name of the instrument
Write here however many samples, follow this syntax: "%note num%"='%sample file%' eg. "27"='synthesizer/e2.ogg'. Key must never be lower than 0 and higher than 127
assoc list key = /datum/instrument_key. do not fill this yourself!
What songs are using us
Volume multiplier. Synthesized instruments are quite loud and I don't like to cut off potential detail via editing. (someone correct me if this isn't a thing)
Initializes the instrument, calculating its samples if necessary.
For synthesized instruments, this is how the instrument generates the "keys" that a /datum/song uses to play notes. +Calculating them on the fly would be unperformant, so we do it during init and keep it all cached in a list.
Checks if this instrument is ready to play.
Instrument key datums contain everything needed to know how to play a specific +note of an instrument.*
Vars | |
| deviation | Deviation up/down from the pivot point that uses its sample. Used to calculate frequency. |
|---|---|
| frequency | The frequency to play the sample to get our desired note. |
| key | The numerical key of what this is, from 1 to 127 on a standard piano keyboard. |
| sample | The actual sample file that will be loaded when playing. |
Procs | |
| calculate | Calculates and stores our deviation. |
Deviation up/down from the pivot point that uses its sample. Used to calculate frequency.
The frequency to play the sample to get our desired note.
The numerical key of what this is, from 1 to 127 on a standard piano keyboard.
The actual sample file that will be loaded when playing.
Calculates and stores our deviation.
Vars | |
| cache | Whether this was loaded from the cache or not |
|---|---|
| cachedate | The date it was cached |
| cacheminutesago | How many minutes ago it was cached |
| cacherealtime | The real time it was cached |
| intel | The current rating, 0-1 float. |
| ip | The IP being checked |
Whether this was loaded from the cache or not
The date it was cached
How many minutes ago it was cached
The real time it was cached
The current rating, 0-1 float.
The IP being checked
Procs | |
| get_ip_intel | Get IP intel |
|---|---|
| ip_intel_query | Performs the remote IPintel lookup |
| ipintel_badip_check | IP Rating Checker |
| ipintel_handle_error | Error handler |
| ipintel_is_banned | IPIntel Ban Checker |
| log_ipintel | Logs an IPintel error |
| vpn_whitelist_add | VPN whitelist adder |
| vpn_whitelist_check | VPN whitelist checker |
| vpn_whitelist_panel | VPN whitelist panel |
| vpn_whitelist_remove | VPN whitelist remover |
Get IP intel
+Performs a lookup of the rating for an IP provided
+Arguments:
+Performs the remote IPintel lookup
+Arguments:
+IP Rating Checker
+Checks if a provided IP passes the config threshold for denial
+Arguments:
+Error handler
+Handles an IP intel error, also throttling the susbystem if required
+Arguments:
+IPIntel Ban Checker
+Checks if a user is banned due to IPintel. It will check configuration, DB, whitelist checks, and more
+Arguments:
+Logs an IPintel error
+Pretty self explanatory. Logs errors regarding ipintel.
+Arguments:
+VPN whitelist adder
+Adds a ckey to the VPN whitelist. Asks the admin to also provide a link to their request.
+Arguments:
+VPN whitelist checker
+Checks if a ckey is whitelisted to be using a VPN against the DB
+Arguments:
+VPN whitelist panel
+Doesnt actually open a panel, this is just a verb to handle the rest of the whitelist operations
+Arguments:
+VPN whitelist remover
+Removes a ckey from the VPN whitelist. Pretty simple.
+Arguments:
+Vars | |
| access | Job access. A list of constants from access_defines.dm. |
|---|---|
| blacklisted_disabilities | Cannot pick this job if the character has these disabilities |
| department_account_access | Can this role access its department money account? |
| department_flag | Department(s) Bitflag, used for Databse entries - DO NOT JUST EDIT THESE |
| department_head | list of the names of departments heads (as strings) |
| flag | Job Bitflag, used for Database entries - DO NOT JUST EDIT THESE |
| has_bank_account | Does this job get a bank account? |
| important_information | Text which is shown to someone in BIG BOLG RED when they spawn. Use for critically important stuff that could make/break a round |
| job_banned_gamemode | Boolean detailing if this job has been banned because of a gamemode restriction i.e. The revolution has won, no more command |
| job_department_flags | Flags for identifying by department, because we need other shit that isnt for the database |
| job_departments | List of the department(s) this job is a part of |
| missing_limbs_allowed | If this job could have any amputated limbs |
| required_objectives | Job Objectives that crew with this job will have a roundstart |
Procs | |
| barred_by_disability | Returns true if the character has a disability the selected job doesn't allow |
| barred_by_missing_limbs | Returns true if the character has amputated limbs when their selected job doesn't allow it |
Job access. A list of constants from access_defines.dm.
Cannot pick this job if the character has these disabilities
Can this role access its department money account?
Department(s) Bitflag, used for Databse entries - DO NOT JUST EDIT THESE
list of the names of departments heads (as strings)
Job Bitflag, used for Database entries - DO NOT JUST EDIT THESE
Does this job get a bank account?
Text which is shown to someone in BIG BOLG RED when they spawn. Use for critically important stuff that could make/break a round
Boolean detailing if this job has been banned because of a gamemode restriction i.e. The revolution has won, no more command
Flags for identifying by department, because we need other shit that isnt for the database
List of the department(s) this job is a part of
If this job could have any amputated limbs
Job Objectives that crew with this job will have a roundstart
Returns true if the character has a disability the selected job doesn't allow
Returns true if the character has amputated limbs when their selected job doesn't allow it
Vars | |
| a_ckey | Admin who did it |
|---|---|
| bantime | Time of ban |
| bantype | Type of ban |
| duration | Duration (if temp) |
| expiration_time | Expiry time (if temp) |
| job | Job banned itself |
| reason | Reason for ban |
Admin who did it
Time of ban
Type of ban
Duration (if temp)
Expiry time (if temp)
Job banned itself
Reason for ban
Holder for job bans
Vars | |
| job_bans | Assoc list of job banned:ban holder |
|---|---|
Assoc list of job banned:ban holder
Vars | |
| completed | Has this objective been completed? |
|---|---|
| completion_payment | how many credits are awarded upon completion of job objective |
| description | short description of what the objective entails, should include how to complete the objective if not immediately clear |
| gives_payout | does this objective give out monetary rewards upon completion? |
| objective_name | Fluff name of the objective |
| owner | Who owns the objective |
| owner_account | Which money account this objective is tied to, makes life easier during payout (signficantly) |
| payout_given | Has the owner been rewarded yet? |
Has this objective been completed?
how many credits are awarded upon completion of job objective
short description of what the objective entails, should include how to complete the objective if not immediately clear
does this objective give out monetary rewards upon completion?
Fluff name of the objective
Who owns the objective
Which money account this objective is tied to, makes life easier during payout (signficantly)
Has the owner been rewarded yet?
The JPS Node datum represents a turf that we find interesting enough to add to the open list and possibly search for new tiles from
Vars | |
| diagonal_move_mult | Multiplier for making diagonals more expensive |
|---|---|
| f_value | The A* node weight (f_value = number_of_tiles + heuristic) |
| heuristic | The A* node heuristic (a rough estimate of how far we are from the goal.) |
| jumps | How many steps it took to get here from the last node |
| node_goal | Nodes store the endgoal so they can process their heuristic without a reference to the pathfind datum |
| number_tiles | How many steps it's taken to get here from the start |
| previous_node | The node we just came from |
| tile | The turf associated with this node |
Multiplier for making diagonals more expensive
The A* node weight (f_value = number_of_tiles + heuristic)
The A* node heuristic (a rough estimate of how far we are from the goal.)
How many steps it took to get here from the last node
Nodes store the endgoal so they can process their heuristic without a reference to the pathfind datum
How many steps it's taken to get here from the start
The node we just came from
The turf associated with this node
Vars | |
| category | The UI category to belong to. |
|---|---|
| keys | The default key(s) assigned to the keybind. |
| name | The user-facing name. |
Procs | |
| can_use | Returns whether the keybinding can be pressed by the client's current mob. |
| down | Called when the client presses the keybind. |
| should_start_looping | Called on keybind press to determine looping behaviour. +If TRUE is returned, the client will be added to SSinput's processing loop. Use VERY sparingly. |
| should_stop_looping | Called on keybind release to determine looping behaviour. +If TRUE is returned, the client will be removed from SSinput's processing loop. |
| up | Called when the client releases the keybind. |
The UI category to belong to.
The default key(s) assigned to the keybind.
The user-facing name.
Returns whether the keybinding can be pressed by the client's current mob.
+Arguments:
+Called when the client presses the keybind.
+Arguments:
+Called on keybind press to determine looping behaviour. +If TRUE is returned, the client will be added to SSinput's processing loop. Use VERY sparingly.
+Arguments:
+Called on keybind release to determine looping behaviour. +If TRUE is returned, the client will be removed from SSinput's processing loop.
+Arguments:
+Called when the client releases the keybind.
+Arguments:
+Vars | |
| rights | The rights to use with [/proc/check_rights] if any |
|---|---|
The rights to use with [/proc/check_rights] if any
Vars | |
| intent | The intent to switch to. |
|---|---|
The intent to switch to.
Vars | |
| prev_intent | The previous intent before holding. |
|---|---|
The previous intent before holding.
Vars | |
| mute_category | Used to map muted categories to channels |
|---|---|
| required_rights | Used to store special rights if required by a keybind, such as R_ADMIN |
Used to map muted categories to channels
Used to store special rights if required by a keybind, such as R_ADMIN
Vars | |
| dir | The direction to face towards. |
|---|---|
The direction to face towards.
Vars | |
| move_dir | The direction to move to when held. |
|---|---|
The direction to move to when held.
Vars | |
| module_number | The module number. |
|---|---|
The module number.
Vars | |
| join_override | Do we want to override the word-join character for scrambled text? If null, defaults to " " or ". " |
|---|---|
Do we want to override the word-join character for scrambled text? If null, defaults to " " or ". "
Vars | |
| name | Name of lavaland theme |
|---|---|
| planet_icon_state | Icon state of planet present on background of station Z-level |
| primary_turf_type | Typepath of turf the /turf/simulated/floor/lava/mapping_lava will be changed to on Late Initialization |
Procs | |
| setup | This proc should do all theme specific thing. +Now it only generates rivers, but it can do all stuff you desire. |
Name of lavaland theme
Icon state of planet present on background of station Z-level
Typepath of turf the /turf/simulated/floor/lava/mapping_lava will be changed to on Late Initialization
This proc should do all theme specific thing. +Now it only generates rivers, but it can do all stuff you desire.
Vars | |
| books | List of all programmatic books, automatically generated upon New() |
|---|---|
| categories | List of all book categories, automatically generated upon New() |
| flagged_books | Lists of all reported books in the current round |
| report_types | List of all report categories, automatically generated upon New() |
Procs | |
| get_book_category_by_id | External proc that Returns a book library_category datum that matches the provided cat_id |
| get_programmatic_book_by_id | External proc that Returns a report programmaticbook datum that matches the provided bookid |
| get_report_category_by_id | External proc that Returns a report library_category datum that matches the provided cat_id |
List of all programmatic books, automatically generated upon New()
List of all book categories, automatically generated upon New()
Lists of all reported books in the current round
List of all report categories, automatically generated upon New()
External proc that Returns a book library_category datum that matches the provided cat_id
External proc that Returns a report programmaticbook datum that matches the provided bookid
External proc that Returns a report library_category datum that matches the provided cat_id
Manages all power related mechanics for a single /area +Machines in areas will directly register to this datum in order to receive power
+Machine/Turf/Item -> Local Powernet -> APC -> Terminal -> Wirenet
+Non-machines cannot register to the local powernet and should instead listen for power change signals
Vars | |
| active_consumption | The amount of total power consumed consumed in only this cycle |
|---|---|
| environment_consumption | The amount of power consumed by environment in this power cycle |
| environment_powered | Is the environment power channel on? |
| equipment_consumption | The amount of power consumed by equipment in this power cycle |
| equipment_powered | Is the equipment power channel on? |
| lighting_consumption | The amount of power consumed by lighting in this power cycle |
| lighting_powered | Is the lighting power channel on? |
| passive_consumption | The amount of the total power consumed passively in power cycles (i.e, each cycle), does not include power channels that are off |
| passive_environment_consumption | The amount of power consumed by environment in every power cycle |
| passive_equipment_consumption | The amount of power consumed by equipment in every power cycle |
| passive_lighting_consumption | The amount of power consumed by lighting in every power cycle |
| power_flags | Bit Flags indicating special behaviour on this powernet, always powered, never powered, etc |
| powernet_apc | The APC associated with this powernet |
| powernet_area | The area this local powernet is attached to |
| registered_machines | All machines registered to this local powernet, strictly typed to machines, everything else needs to register power change signals |
Procs | |
| adjust_static_power | Adjust static power for a specified channel, does not check to see if channel has power flowing into it |
| get_channel_usage | returns active + passive power of a channel, if the channel is not powered it returns 0 watts |
| handle_flicker | Handles flicker operations for apc processing, will flicker machines and lights in the powernet's area by random chance |
| has_power | checks to see if the given channel in this local powernet has power |
| power_change | |
| register_machine | tethers a machine to this local powernet |
| set_power_channel | sets a power channel on or off and adjusts total power usage accordingly |
| unregister_machine | untethers a machine to this local powernet |
| use_active_power | Add active power usage to the given channel, returns FALSE is channel cannot be found or the channel does not have power to give |
The amount of total power consumed consumed in only this cycle
The amount of power consumed by environment in this power cycle
Is the environment power channel on?
The amount of power consumed by equipment in this power cycle
Is the equipment power channel on?
The amount of power consumed by lighting in this power cycle
Is the lighting power channel on?
The amount of the total power consumed passively in power cycles (i.e, each cycle), does not include power channels that are off
The amount of power consumed by environment in every power cycle
The amount of power consumed by equipment in every power cycle
The amount of power consumed by lighting in every power cycle
Bit Flags indicating special behaviour on this powernet, always powered, never powered, etc
The APC associated with this powernet
The area this local powernet is attached to
All machines registered to this local powernet, strictly typed to machines, everything else needs to register power change signals
Adjust static power for a specified channel, does not check to see if channel has power flowing into it
returns active + passive power of a channel, if the channel is not powered it returns 0 watts
Handles flicker operations for apc processing, will flicker machines and lights in the powernet's area by random chance
checks to see if the given channel in this local powernet has power
Called when the area power status changes
+calls power change on all machines in the area, and sends the COMSIG_POWERNET_POWER_CHANGE signal.
tethers a machine to this local powernet
sets a power channel on or off and adjusts total power usage accordingly
untethers a machine to this local powernet
Add active power usage to the given channel, returns FALSE is channel cannot be found or the channel does not have power to give
Procs | |
| get_earliest_log_index | |
|---|---|
| get_latest_log_index | |
Vars | |
| area_sound | If this sound is based off of an area |
|---|---|
| channel | Channel of the audio, random otherwise |
If this sound is based off of an area
Channel of the audio, random otherwise
Looping sounds that decrease volume by a specified % each loop until it reaches a specified total % volume.
Vars | |
| decrease_by_amount | How much, as a % of original, to decrease the volume by each loop |
|---|---|
| decrease_to_amount | What volume level, as a % of original, to eventually decrease to |
How much, as a % of original, to decrease the volume by each loop
What volume level, as a % of original, to eventually decrease to
Map Datum
+Datum which holds all of the information for maps ingame +This is used for showing map information, as well as map loading
Vars | |
| fluff_name | Name of the map to be shown in the statpanel |
|---|---|
| map_path | Path to the map file |
| min_players_random | Minimum amount of players required for this map to be eligible in random map picks. |
| technical_name | Name to be used when using the map from a technical standpoint. Used in TGUI Nanomaps among other things. |
| voteable | Is this map voteable? |
| webmap_url | URL to the maps webmap |
Name of the map to be shown in the statpanel
Path to the map file
Minimum amount of players required for this map to be eligible in random map picks.
Name to be used when using the map from a technical standpoint. Used in TGUI Nanomaps among other things.
Is this map voteable?
URL to the maps webmap
Vars | |
| ci_exclude | Do we exclude this from CI checks? If so, set this to the templates pathtype itself to avoid it getting passed down |
|---|---|
Do we exclude this from CI checks? If so, set this to the templates pathtype itself to avoid it getting passed down
Vars | |
| base | The permanent style. |
|---|---|
| block_chance | Chance to block melee attacks using items while on throw mode. |
| can_horizontally_grab | Whether or not you can grab someone while horizontal with this Martial Art |
| can_parry | If the martial art allows parrying. |
| combo_timer | Stores the timer_id for the combo timeout timer |
| combos | What combos can the user do? List of combo types. |
| current_combos | What combos are currently (possibly) being performed. |
| deflection_chance | Chance to deflect projectiles while on throw mode. |
| has_explaination_verb | If the martial art has it's own explaination verb. |
| in_stance | If the user is preparing a martial arts stance. |
| no_baton | Set to TRUE to prevent users of this style from using stun batons (and stunprods) |
| no_baton_reason | Message displayed when someone uses a baton when its forbidden by a martial art |
| no_guns | Set to TRUE to prevent users of this style from using guns (sleeping carp, highlander). They can still pick them up, but not fire them. |
| no_guns_message | Message to tell the style user if they try and use a gun while no_guns = TRUE (DISHONORABRU!) |
| reroute_deflection | Can it reflect projectiles in a random direction? |
| weight | The priority of which martial art is picked from all the ones someone knows, the higher the number, the higher the priority. |
Procs | |
| get_highest_weight | Returns the martial art with the highest weight from all the ones someone knows. |
The permanent style.
Chance to block melee attacks using items while on throw mode.
Whether or not you can grab someone while horizontal with this Martial Art
If the martial art allows parrying.
Stores the timer_id for the combo timeout timer
What combos can the user do? List of combo types.
What combos are currently (possibly) being performed.
Chance to deflect projectiles while on throw mode.
If the martial art has it's own explaination verb.
If the user is preparing a martial arts stance.
Set to TRUE to prevent users of this style from using stun batons (and stunprods)
Message displayed when someone uses a baton when its forbidden by a martial art
Set to TRUE to prevent users of this style from using guns (sleeping carp, highlander). They can still pick them up, but not fire them.
Message to tell the style user if they try and use a gun while no_guns = TRUE (DISHONORABRU!)
Can it reflect projectiles in a random direction?
The priority of which martial art is picked from all the ones someone knows, the higher the number, the higher the priority.
Returns the martial art with the highest weight from all the ones someone knows.
Vars | |
| is_emped | Are we EMP'ed? |
|---|---|
| punch_damage | How much damage should our punches deal |
Are we EMP'ed?
How much damage should our punches deal
Vars | |
| combo_text_override | How to do the combo. If null it'll auto generate it from the steps |
|---|---|
| combos_require_same_target | If you require to do the combo's on the same target |
| current_combo_target | Who is the target the combo is being executed on |
| current_step_index | What index to check |
| explaination_text | What does it do |
| name | Name used to explain the combo |
| steps | Which steps need to be performed |
How to do the combo. If null it'll auto generate it from the steps
If you require to do the combo's on the same target
Who is the target the combo is being executed on
What index to check
What does it do
Name used to explain the combo
Which steps need to be performed
Create a subclass of this and implement on_run to manipulate tile air safely.
Procs | |
| add_turf_air | Add air to a turf. Only use from on_run. |
|---|---|
| get_turf_air | Fetch the air for a turf. Only use from on_run. |
| invoke_async | Call this to make the subclass run when it's safe to do so. Args will be passed to on_run. |
| on_run | All subclasses should implement this. |
| private_unsafe_invoke | Do not call this yourself. This is what is called to run your code from a safe context. |
| set_turf_air | Completely replace the air for a turf. Only use from on_run. |
| soft_assert_safe | Used internally to check that we're running safely, but without breaking things worse if we aren't. |
Add air to a turf. Only use from on_run.
Fetch the air for a turf. Only use from on_run.
Call this to make the subclass run when it's safe to do so. Args will be passed to on_run.
All subclasses should implement this.
Do not call this yourself. This is what is called to run your code from a safe context.
Completely replace the air for a turf. Only use from on_run.
Used internally to check that we're running safely, but without breaking things worse if we aren't.
Procs | |
| on_run | Burns the air affected by this hotspot. A hotspot is effectively a gas fire that might not cover the entire tile yet. This proc makes that "partial fire" burn, altering the tile as a whole, and potentially setting the entire tile on fire. |
|---|---|
Burns the air affected by this hotspot. A hotspot is effectively a gas fire that might not cover the entire tile yet. This proc makes that "partial fire" burn, altering the tile as a whole, and potentially setting the entire tile on fire.
Vars | |
| appearance | How does the form look like? |
|---|---|
| examine_text | What is the examine text paired with this form |
| name | What the name of the form is |
How does the form look like?
What is the examine text paired with this form
What the name of the form is
Vars | |
| antag_datums | A list of all the antagonist datums that the player is (does not include undatumized antags) |
|---|---|
| has_been_rev | Tracks if this mind has been a rev or not |
| job_objectives | a list of objectives that a player with this job could complete for space credit rewards |
| kudos_received_from | List of people who we've received kudos from. |
| original_mob_UID | The original mob's UID. Used for example to see if a silicon with antag status is actually malf. Or just an antag put in a borg |
| original_mob_name | The original mob's name. Used in Dchat messages |
| teams | A lazy list of all teams the player is part of but doesnt have an antag role for, (i.e. a custom admin team) |
Procs | |
| Topic | Impanted |
| add_antag_datum | Create and/or add the datum_type_or_instance antag datum to the src mind. |
| add_mind_objective | Add an objective to the mind |
| get_all_objectives | Gets every objective this mind owns, including all of those from any antag datums they have, and returns them as a list. |
| get_hijack_speed | This proc sets the hijack speed for a mob. If greater than zero, they can hijack. Outputs in seconds. |
| has_antag_datum | Returns an antag datum instance if the src mind has the specified datum_type. Returns null otherwise. |
| has_objectives | A quicker version of get_all_objectives() but only for seeing if they have any objectives at all |
| memory_edit_nuclear | Enthralled |
| remove_all_antag_datums | Removes all antag datums from the src mind. |
| remove_antag_datum | Remove the specified datum_type antag datum from the src mind. |
| remove_mind_objective | Completely remove the given objective from the mind, and include antagdatums/teams if remove_from_everything is true |
A list of all the antagonist datums that the player is (does not include undatumized antags)
Tracks if this mind has been a rev or not
a list of objectives that a player with this job could complete for space credit rewards
List of people who we've received kudos from.
The original mob's UID. Used for example to see if a silicon with antag status is actually malf. Or just an antag put in a borg
The original mob's name. Used in Dchat messages
A lazy list of all teams the player is part of but doesnt have an antag role for, (i.e. a custom admin team)
Impanted
+REVOLUTION
+WIZARD
+CHANGELING
+VAMPIRE
+NUCLEAR
+Abductors
+Zombies
+TRAITOR
+CULT
+SILICON
Create and/or add the datum_type_or_instance antag datum to the src mind.
Arguments:
+Add an objective to the mind
Gets every objective this mind owns, including all of those from any antag datums they have, and returns them as a list.
This proc sets the hijack speed for a mob. If greater than zero, they can hijack. Outputs in seconds.
Returns an antag datum instance if the src mind has the specified datum_type. Returns null otherwise.
Arguments:
+datum_type as valid. FALSE if only the exact same type should be considered.A quicker version of get_all_objectives() but only for seeing if they have any objectives at all
Enthralled
Removes all antag datums from the src mind.
+Use this over doing QDEL_LIST_CONTENTS(antag_datums).
Remove the specified datum_type antag datum from the src mind.
Arguments:
+Completely remove the given objective from the mind, and include antagdatums/teams if remove_from_everything is true
MODsuit theme, instanced once and then used by MODsuits to grab various statistics.
Vars | |
| allowed_suit_storage | Allowed items in the chestplate's suit storage. |
|---|---|
| armor_type_1 | Armor shared across the MOD parts. |
| armor_type_2 | the actual armor object placed in a datum as I am tired and I just want this to work |
| atom_flags | Atom flags shared across the MOD parts. |
| charge_drain | How much battery power the MOD uses by just being on |
| complexity_max | How much modules can the MOD carry without malfunctioning. |
| default_skin | Default skin of the MOD. |
| desc | Description added to the MOD. |
| extended_desc | Extended description on examine_more |
| inbuilt_modules | List of inbuilt modules. These are different from the pre-equipped suits, you should mainly use these for unremovable modules with 0 complexity. |
| max_heat_protection_temperature | Max heat protection shared across the MOD parts. |
| min_cold_protection_temperature | Max cold protection shared across the MOD parts. |
| name | Theme name for the MOD. |
| resistance_flags | Resistance flags shared across the MOD parts. |
| siemens_coefficient | Siemens shared across the MOD parts. |
| skins | List of skins with their appropriate clothing flags. |
| slot_flags | The slot this mod theme fits on |
| slowdown_active | Slowdown of the MOD when active. |
| slowdown_inactive | Slowdown of the MOD when not active. |
| ui_theme | Theme used by the MOD TGUI. |
Allowed items in the chestplate's suit storage.
Armor shared across the MOD parts.
the actual armor object placed in a datum as I am tired and I just want this to work
Atom flags shared across the MOD parts.
How much battery power the MOD uses by just being on
How much modules can the MOD carry without malfunctioning.
Default skin of the MOD.
Description added to the MOD.
Extended description on examine_more
List of inbuilt modules. These are different from the pre-equipped suits, you should mainly use these for unremovable modules with 0 complexity.
Max heat protection shared across the MOD parts.
Max cold protection shared across the MOD parts.
Theme name for the MOD.
Resistance flags shared across the MOD parts.
Siemens shared across the MOD parts.
List of skins with their appropriate clothing flags.
The slot this mod theme fits on
Slowdown of the MOD when active.
Slowdown of the MOD when not active.
Theme used by the MOD TGUI.
Vars | |
| account_log | Tracking log of all actions on the account, for IC usage & can have entries deleted |
|---|---|
| account_name | Full name of the account, set at creation of the account |
| account_number | Unique Account Number Identifier for the account -Username |
| account_pin | 4 digit pin password for accessing the money account -Password |
| account_type | Type of account this is |
| associated_nanobank_programs | The nanobank programs associated with this account, used for notifying crew members through PDA, this is a lazy list |
| credit_balance | How many space credits are in the account |
| database_holder | reference to parent account database, only used for GC |
| hidden_account_log | Tracking log of all actions on the account, used for admin logging and debugging |
| pay_check_bonuses | pay bonuses for the next pay period for this account, this is a lazy list |
| pay_check_deductions | pay deductions for the next pay period for this account, this is a lazy list |
| payday_amount | the amount this account receives every payday |
| security_level | Level of security on the money account |
| suspended | Bool - Is this account locked out from being used completely? |
| transfer_requests | The requests made to this money_account used for ATM and NanoBank credit transfers, this is a lazy list |
Procs | |
| deposit_credits | set proc for depositing money, changing credit_balance should always be done through procs |
| set_credits | sets the credit balance to specified value, changing credit_balance should always be done through procs |
Tracking log of all actions on the account, for IC usage & can have entries deleted
Full name of the account, set at creation of the account
Unique Account Number Identifier for the account -Username
4 digit pin password for accessing the money account -Password
Type of account this is
The nanobank programs associated with this account, used for notifying crew members through PDA, this is a lazy list
How many space credits are in the account
reference to parent account database, only used for GC
Tracking log of all actions on the account, used for admin logging and debugging
pay bonuses for the next pay period for this account, this is a lazy list
pay deductions for the next pay period for this account, this is a lazy list
the amount this account receives every payday
Level of security on the money account
Bool - Is this account locked out from being used completely?
The requests made to this money_account used for ATM and NanoBank credit transfers, this is a lazy list
set proc for depositing money, changing credit_balance should always be done through procs
sets the credit balance to specified value, changing credit_balance should always be done through procs
Vars | |
| database_logs | list of actions taken on the money account database, such as creating/deleting accounts |
|---|---|
| hidden_database_logs | Tracking log of all actions on the account databse, used for admin logging and debugging |
| online | Will the database permit actions on it? Useful for random events |
| user_accounts | list of money account datums for individual users |
Procs | |
| find_user_account | takes in an account_numb and returns either an account if it locates one or null if it finds none |
list of actions taken on the money account database, such as creating/deleting accounts
Tracking log of all actions on the account databse, used for admin logging and debugging
Will the database permit actions on it? Useful for random events
list of money account datums for individual users
takes in an account_numb and returns either an account if it locates one or null if it finds none
Vars | |
| department_accounts | list of money accounts for each department on station |
|---|---|
list of money accounts for each department on station
A datum to handle the busywork of registering signals to handle in depth tracking of a movable
Vars | |
| listener | Listener is whatever callback that will increase the tracking of the movable, usually on stepped. |
|---|---|
Procs | |
| move_react | Reacts to any movement that would cause a change in coordinates of the tracked movable atom +This works by detecting movement of either the tracked object, or anything it is inside, recursively |
| track | Sets up tracking of the given movable atom |
| untrack | Stops tracking |
Listener is whatever callback that will increase the tracking of the movable, usually on stepped.
Reacts to any movement that would cause a change in coordinates of the tracked movable atom +This works by detecting movement of either the tracked object, or anything it is inside, recursively
Sets up tracking of the given movable atom
Stops tracking
Vars | |
| activation_messages | Possible activation messages |
|---|---|
| block | What gene activates this? Set in initialize()! |
| deactivation_messages | Possible deactivation messages |
| desc | Description of the gene |
| instability | Chance of the gene to cause adverse effects when active |
| name | Display name |
| traits_to_add | Trait to give, if any |
Possible activation messages
What gene activates this? Set in initialize()!
Possible deactivation messages
Description of the gene
Chance of the gene to cause adverse effects when active
Display name
Trait to give, if any
Vars | |
| all_jobs | Associative list of all jobs and their department color classes |
|---|---|
| cc_jobs | List of CentComm jobs |
| ert_jobs | List of ERT jobs |
| heads | List of Command jobs |
| tsf_jobs | List of SolGov Marine jobs |
Associative list of all jobs and their department color classes
List of CentComm jobs
List of ERT jobs
List of Command jobs
List of SolGov Marine jobs
Datum that holds and tracks info about a client's object window +Really only exists because I want to be able to do logic with signals +And need a safe place to do the registration
Vars | |
| actively_tracking | Are we currently tracking a turf? |
|---|---|
| atoms_to_images | list of atom -> image string for objects we have had in the right click tab +this is our caching |
| atoms_to_imagify | list of atoms to turn into images for the object tab |
| atoms_to_show | list of atoms to show to our client via the object tab, at least currently |
| max_index | The maximum index currently sent to the client. |
| min_index | The minimum index currently sent to the client. |
| parent | Our owner client |
Procs | |
| process | Takes a client, attempts to generate object images for it +We will update the client with any improvements we make when we're done |
| viewing_atom_deleted | Clears any cached object window stuff +We use hard refs cause we'd need a signal for this anyway. Cleaner this way |
Are we currently tracking a turf?
list of atom -> image string for objects we have had in the right click tab +this is our caching
list of atoms to turn into images for the object tab
list of atoms to show to our client via the object tab, at least currently
The maximum index currently sent to the client.
The minimum index currently sent to the client.
Our owner client
Takes a client, attempts to generate object images for it +We will update the client with any improvements we make when we're done
Clears any cached object window stuff +We use hard refs cause we'd need a signal for this anyway. Cleaner this way
Vars | |
| completed | If the objective has been completed. |
|---|---|
| explanation_text | What the owner is supposed to do to complete the objective. |
| martyr_compatible | If the objective is compatible with martyr objective, i.e. if you can still do it while dead. |
| name | Proper name of the objective. Not player facing, only shown to admins when adding objectives. +Leave as null (or override to null) if you don't want admins to see that objective as a viable one to add (such as the mindslave objective). |
| needs_target | If the objective should have find_target() called for it. |
| owner | Owner of the objective.
+Note that it's fine to set this directly, but when needing to check completion of the objective or otherwise check conditions on the owner of the objective,
+always use get_owners(), and check against ALL the owners. get_owners() accounts for objectives that may be team based and therefore have multiple owners. |
| target | The target of the objective. |
| target_amount | If they are focused on a particular number. Steal objectives have their own counter. |
| team | The team the objective belongs to, if any. |
Procs | |
| establish_signals | This is for objectives that need to register signals, so place them in here. |
| get_owners | Get all owners of the objective, including ones from the objective's team, if it has one. |
| on_target_cryo | Called when the objective's target goes to cryo. |
| post_target_cryo | Called a tick after when the objective's target goes to cryo. |
| update_explanation_text | This is for objectives that have reason to update their text, such as target changes. |
If the objective has been completed.
What the owner is supposed to do to complete the objective.
If the objective is compatible with martyr objective, i.e. if you can still do it while dead.
Proper name of the objective. Not player facing, only shown to admins when adding objectives. +Leave as null (or override to null) if you don't want admins to see that objective as a viable one to add (such as the mindslave objective).
If the objective should have find_target() called for it.
Owner of the objective.
+Note that it's fine to set this directly, but when needing to check completion of the objective or otherwise check conditions on the owner of the objective,
+always use get_owners(), and check against ALL the owners. get_owners() accounts for objectives that may be team based and therefore have multiple owners.
The target of the objective.
If they are focused on a particular number. Steal objectives have their own counter.
The team the objective belongs to, if any.
This is for objectives that need to register signals, so place them in here.
Get all owners of the objective, including ones from the objective's team, if it has one.
+Use this over directly referencing owner in most cases.
Called when the objective's target goes to cryo.
Called a tick after when the objective's target goes to cryo.
This is for objectives that have reason to update their text, such as target changes.
Describes the target to kidnap and the extraction area of a /datum/syndicate_contract.
Vars | |
| candidate_zones | Associated lazy list of areas the contractor can pick from and extract the kidnapee there. +Structure: EXTRACTION_DIFFICULTY_(EASY|MEDIUM|HARD) => /area |
|---|---|
| chosen_difficulty | The contract's difficulty. Determines the reward on completion. |
| extraction_zone | The designated area where the kidnapee must be extracted to complete the objective. |
| forbidden_jobs | Jobs that cannot be the kidnapping target. |
| name_fixer | Name fixer regex because area names have rogue characters sometimes. |
| owning_contract | The owning /datum/syndicatce_contract. |
| possible_zone_names | Static whitelist of area names that can be used as an extraction zone, structured by difficulty. +An area's difficulty should be measured in how crowded it generally is, how out of the way it is and so on. +Outdoor or invalid areas are filtered out. +Structure: EXTRACTION_DIFFICULTY_(EASY|MEDIUM|HARD) => list() |
| possible_zones | Static list that is basically /datum/objective/contract/var/possible_zone_names but with area names replaced by /area objects if available. |
| target_blacklist | List of people who cannot be selected as contract target. |
Procs | |
| can_start_extraction_process | Returns whether the extraction process can be started. |
| choose_difficulty | Updates the objective's information with the given difficulty. |
| pick_candidate_zone | Assigns a randomly selected zone to the contract's selectable zone at the given difficulty. |
Associated lazy list of areas the contractor can pick from and extract the kidnapee there. +Structure: EXTRACTION_DIFFICULTY_(EASY|MEDIUM|HARD) => /area
The contract's difficulty. Determines the reward on completion.
The designated area where the kidnapee must be extracted to complete the objective.
Jobs that cannot be the kidnapping target.
Name fixer regex because area names have rogue characters sometimes.
The owning /datum/syndicatce_contract.
Static whitelist of area names that can be used as an extraction zone, structured by difficulty. +An area's difficulty should be measured in how crowded it generally is, how out of the way it is and so on. +Outdoor or invalid areas are filtered out. +Structure: EXTRACTION_DIFFICULTY_(EASY|MEDIUM|HARD) => list()
Static list that is basically /datum/objective/contract/var/possible_zone_names but with area names replaced by /area objects if available.
List of people who cannot be selected as contract target.
Returns whether the extraction process can be started.
+Arguments:
+Updates the objective's information with the given difficulty.
+Arguments:
+Assigns a randomly selected zone to the contract's selectable zone at the given difficulty.
+Arguments:
+Vars | |
| has_assassinate_objective | If the objective has an assassinate objective tied to it. |
|---|---|
| target_real_name | Stored because the target's [mob/var/real_name] can change over the course of the round. |
If the objective has an assassinate objective tied to it.
Stored because the target's [mob/var/real_name] can change over the course of the round.
Vars | |
| abductor_team_number | Which abductor team number does this belong to. |
|---|---|
Which abductor team number does this belong to.
Vars | |
| amount | Amount of power we need to drain, ranges from 500 KW to 5 MW |
|---|---|
Amount of power we need to drain, ranges from 500 KW to 5 MW
Vars | |
| amount | Amount of APCs we need to hijack, can be 15, 20, or 25 |
|---|---|
Amount of APCs we need to hijack, can be 15, 20, or 25
An objective holder for minds, antag datums, and teams.
Vars | |
| assigned_targets | A list of strings which contain targets of the antagonist's objectives. Used to prevent duplicate objectives. |
|---|---|
| objective_owner | Who do we belong to [mind, antagonist, team] |
| objectives | Our list of current objectives |
| on_add_callback | A callback invoked when a new objective is added. This is required because sometimes objectives are added directly without going through objective_owner. Not currently used. |
| on_remove_callback | A callback invoked when a new objective is added. This is required because sometimes objectives are removed directly without going through objective_owner (EX: replace_objective(), clear()). Not currently used. |
Procs | |
| add_objective | Add an objective. |
| clear | Clear all objectives of a certain type |
| get_objectives | Get all of the objectives we own |
| handle_objective | Handles the searching of targets for objectives that need it. |
| has_objectives | Do we have any objectives |
| remove_objective | Remove an objective and deletes it. You should never need to transfer an objective. |
| replace_objective | Replace old_objective with new_objective |
| set_callbacks | Sets the callbacks, not on new because that can be irreliable for subtypes. |
A list of strings which contain targets of the antagonist's objectives. Used to prevent duplicate objectives.
Who do we belong to [mind, antagonist, team]
Our list of current objectives
A callback invoked when a new objective is added. This is required because sometimes objectives are added directly without going through objective_owner. Not currently used.
A callback invoked when a new objective is added. This is required because sometimes objectives are removed directly without going through objective_owner (EX: replace_objective(), clear()). Not currently used.
Add an objective.
+Clear all objectives of a certain type
+Get all of the objectives we own
Handles the searching of targets for objectives that need it.
Do we have any objectives
Remove an objective and deletes it. You should never need to transfer an objective.
Replace old_objective with new_objective
Sets the callbacks, not on new because that can be irreliable for subtypes.
Procs | |
| on_insert | Called when the linked organ is inserted. |
|---|---|
| on_remove | Called when the linked organ is removed. |
| on_replace | Called when another organ is removed, and this organ datum takes its place in the organ_owner. |
| on_successful_emp | Only called when the organ is robotic AND is not emp proof. Return true to override default functions |
Called when the linked organ is inserted.
Called when the linked organ is removed.
Called when another organ is removed, and this organ datum takes its place in the organ_owner.
Only called when the organ is robotic AND is not emp proof. Return true to override default functions
Procs | |
| check_breath | LUNG ATMOS CODE, VENTURE FURTHER IF YOU DARE!!! |
|---|---|
| on_successful_emp | Lung atmos code ends here. Thank god... |
LUNG ATMOS CODE, VENTURE FURTHER IF YOU DARE!!!
Lung atmos code ends here. Thank god...
Vars | |
| toggle_helmet | Should the toggle helmet proc be called on the helmet during equip |
|---|---|
Should the toggle helmet proc be called on the helmet during equip
Vars | |
| description | pAI's description |
|---|---|
| ooc_comments | pAI's OOC comments |
| owner | Client that owns the pAI |
| pai_name | pAI's name |
| role | pAI's role |
pAI's description
pAI's OOC comments
Client that owns the pAI
pAI's name
pAI's role
Datum module for pAI software
+Very similar to the PDA app datum, this determines what UI sub-template to use, +as well as the RAM cost, and if it is toggle software (not a UI app)
Vars | |
| default | Do we have this software installed by default |
|---|---|
| id | ID for the software. This must be unique |
| name | Name for the software. This is used as the button text when buying or opening/toggling the software |
| pai_holder | pAI which holds this software |
| ram_cost | RAM cost; pAIs start with 100 RAM, spending it on programs |
| template_file | Template for the TGUI file |
| toggle_software | Whether this software is a toggle or not |
| ui_icon | Icon for inside the UI |
Procs | |
| New | New handler |
| get_app_data | Handler for the app's UI data |
| get_holding_mob | Helper proc so that pAIs can get the mob holding them |
| is_active | Helper for checking if a toggle is enabled or not |
| toggle | Handler for toggling toggle apps on and off |
| ui_act | ui_act sanity check helper |
Do we have this software installed by default
ID for the software. This must be unique
Name for the software. This is used as the button text when buying or opening/toggling the software
pAI which holds this software
RAM cost; pAIs start with 100 RAM, spending it on programs
Template for the TGUI file
Whether this software is a toggle or not
Icon for inside the UI
New handler
+Ensures that the pai_holder var is set to the pAI itself +Arguments:
+Handler for the app's UI data
+This returns the list of the current app's data for the UI +This will then be injected as a variable on the TGUI data called "app_data"
+Arguments:
+Helper proc so that pAIs can get the mob holding them
+This needs to exist because pAIs have many different locs +(Held card, mob itself, in pocket, etc)
+Arguments:
+Helper for checking if a toggle is enabled or not
+Returns TRUE if the toggle software is active, FALSE if not
+Its like this instead of a simple is_toggled var because some toggles override eachother and this is easier
Arguments:
+Handler for toggling toggle apps on and off
+This is invoked whenever you toggle a toggleable function +Put your toggleable work in here
+Arguments:
+ui_act sanity check helper
+Basically checks the existing href exploit stuff, as well as making sure the user using the UI is the pAI itself
Vars | |
| scanner | Integrated PDA atmos scan module to reduce duplicated code |
|---|---|
Integrated PDA atmos scan module to reduce duplicated code
Vars | |
| cable | The cable being plugged into a door |
|---|---|
| hackdoor | The door being hacked |
| hacking | Are we hacking? |
| progress | Progress on hacking the door |
Procs | |
| cleanup_hack | Door jack cleanup proc |
| hackloop | Door jack hack loop |
The cable being plugged into a door
The door being hacked
Are we hacking?
Progress on hacking the door
Door jack cleanup proc
+Self-contained proc for cleaning up failed hack attempts
Door jack hack loop
+Self-contained proc for handling the hacking of a door. +Invoked asyncly, but will only allow one instance at a time
Vars | |
| integrated_records | Integrated medical records module to reduce duplicated code |
|---|---|
Integrated medical records module to reduce duplicated code
Vars | |
| integrated_records | Integrated security records module to reduce duplicated code |
|---|---|
Integrated security records module to reduce duplicated code
Contains variables for updating holder, as well as procs for choosing a colour and painting an atom.
The parent_painter argument is REQUIRED when spawning this in order to link the datum to an /obj/item/painter.
Vars | |
| holder | The parent /obj/item/painter which this datum is linked to. |
|---|---|
| module_desc | Desc of the holder when using this module. |
| module_name | Name of the holder when using this module. |
| module_state | Icon and Item state of the holder when using this module. |
| paint_setting | The current colour or icon state setting. |
Procs | |
| paint_atom | Contains code to apply the paint_setting variable onto the target atom. |
| pick_color | Contains code to choose a new colour or icon state for the paint_setting variable. |
The parent /obj/item/painter which this datum is linked to.
Desc of the holder when using this module.
Name of the holder when using this module.
Icon and Item state of the holder when using this module.
The current colour or icon state setting.
Contains code to apply the paint_setting variable onto the target atom.
Called by afterattack() on the holder object.
Contains code to choose a new colour or icon state for the paint_setting variable.
Called by attack_self() on the holder object.
The datum used to handle the JPS pathfinding, completely self-contained
Vars | |
| avoid | A specific turf we're avoiding, like if a mulebot is being blocked by someone t-posing in a doorway we're trying to get through |
|---|---|
| caller | The thing that we're actually trying to path for |
| diagonal_safety | Ensures diagonal moves won't use invalid midstep turfs by splitting them into two orthogonal moves if necessary |
| end | The turf we're trying to path to (note that this won't track a moving target) |
| id | An ID card representing what access we have and what doors we can open. Its location relative to the pathing atom is irrelevant |
| max_distance | I don't know what this does vs , but they limit how far we can search before giving up on a path |
| mintargetdist | How far away we have to get to the end target before we can call it quits |
| open | The open list/stack we pop nodes out from (TODO: make this a normal list and macro-ize the heap operations to reduce proc overhead) |
| path | The list we compile at the end if successful to pass back |
| simulated_only | Space is big and empty, if this is TRUE then we ignore pathing through unsimulated tiles |
| sources | An assoc list that serves as the closed list & tracks what turfs came from where. Key is the turf, and the value is what turf it came from |
| start | The turf where we started at |
Procs | |
| diag_scan_spec | For performing diagonal scans from a given starting turf. |
| lateral_scan_spec | For performing lateral scans from a given starting turf. |
| search | search() is the proc you call to kick off and handle the actual pathfinding, and kills the pathfind datum instance when it's done. |
| unwind_path | Called when we've hit the goal with the node that represents the last tile, then sets the path var to that path so it can be returned by datum/pathfind/proc/search |
A specific turf we're avoiding, like if a mulebot is being blocked by someone t-posing in a doorway we're trying to get through
The thing that we're actually trying to path for
Ensures diagonal moves won't use invalid midstep turfs by splitting them into two orthogonal moves if necessary
The turf we're trying to path to (note that this won't track a moving target)
An ID card representing what access we have and what doors we can open. Its location relative to the pathing atom is irrelevant
I don't know what this does vs , but they limit how far we can search before giving up on a path
How far away we have to get to the end target before we can call it quits
The open list/stack we pop nodes out from (TODO: make this a normal list and macro-ize the heap operations to reduce proc overhead)
The list we compile at the end if successful to pass back
Space is big and empty, if this is TRUE then we ignore pathing through unsimulated tiles
An assoc list that serves as the closed list & tracks what turfs came from where. Key is the turf, and the value is what turf it came from
The turf where we started at
For performing diagonal scans from a given starting turf.
+Unlike lateral scans, these only are called from the main search loop, so we don't need to worry about returning anything, +though we do need to handle the return values of our lateral subscans of course.
+Arguments:
+For performing lateral scans from a given starting turf.
+These scans are called from both the main search loop, as well as subscans for diagonal scans, and they treat finding interesting turfs slightly differently. +If we're doing a normal lateral scan, we already have a parent node supplied, so we just create the new node and immediately insert it into the heap, ezpz. +If we're part of a subscan, we still need for the diagonal scan to generate a parent node, so we return a node datum with just the turf and let the diag scan +proc handle transferring the values and inserting them into the heap.
+Arguments:
+search() is the proc you call to kick off and handle the actual pathfinding, and kills the pathfind datum instance when it's done.
+If a valid path was found, it's returned as a list. If invalid or cross-z-level params are entered, or if there's no valid path found, we +return null, which /proc/get_path_to translates to an empty list (notable for simple bots, who need empty lists)
Called when we've hit the goal with the node that represents the last tile, then sets the path var to that path so it can be returned by datum/pathfind/proc/search
A generalized datum for pathfinding, and moving to a target.
Vars | |
| consider_movement_delay | Do we consider movement delay? Disable for non-mobs |
|---|---|
| last_movement_delay | Requires consider_movement_delay = TRUE, saves the last movement delay to prevent diagonal weirdness |
| max_tries | max amount of tries before resetting path to null |
| move_speed | How many 2-tick delays per move (5 = 1 second) |
| move_ticks | A counter for move_speed via modulo |
| on_set_path_null | Callback invoked on failure |
| on_success | Callback invoked on success |
| owner | Can be a simplemob bot, a drone, or even a pathfinding modsuit module (currently only implemented for drones) |
| owner_move_delay | The delay called as part of Move() |
| path | List of turfs through which a mod 'steps' to reach the waypoint |
| target | The target turf we are after |
| tries | How many times have we tried to move? |
Procs | |
| generalized_step | Take our next step in our pathfinding algorithm |
| process | Using fast process, see if we should take the next step yet |
| start | Start moving towards our target, returns false if the path does not lead to the target |
Do we consider movement delay? Disable for non-mobs
Requires consider_movement_delay = TRUE, saves the last movement delay to prevent diagonal weirdness
max amount of tries before resetting path to null
How many 2-tick delays per move (5 = 1 second)
A counter for move_speed via modulo
Callback invoked on failure
Callback invoked on success
Can be a simplemob bot, a drone, or even a pathfinding modsuit module (currently only implemented for drones)
The delay called as part of Move()
List of turfs through which a mod 'steps' to reach the waypoint
The target turf we are after
How many times have we tried to move?
Take our next step in our pathfinding algorithm
Using fast process, see if we should take the next step yet
Start moving towards our target, returns false if the path does not lead to the target
Datum that stores several modifiers in a way that isn't cleared by changing species
Vars | |
| armor | internal armor datum |
|---|---|
| bleed_mod | % bleeding modifier |
| brain_mod | % of brain damage taken from all sources |
| brute_mod | % of brute damage taken from all sources |
| burn_mod | % of burn damage taken from all sources |
| clone_mod | % of clone damage taken from all sources |
| cold_mod | % of burn damage taken from cold (stacks with burn_mod) |
| damage_resistance | %damage reduction from all sources |
| heat_mod | % of burn damage taken from heat (stacks with burn_mod) |
| hunger_mod | % of hunger rate taken per tick. |
| melee_bonus | Bonus damage added to melee attacks. NOTE: this is additive rather than multiplicative, trying to multiply this will break things. |
| oxy_mod | % of oxygen damage taken from all sources |
| pressure_mod | % of brute damage taken from low or high pressure (stacks with brute_mod) |
| siemens_coeff | resistance to shocks |
| stamina_mod | % of stamina damage taken from all sources |
| stun_mod | % stun modifier |
| tox_mod | % of toxin damage taken from all sources |
internal armor datum
% bleeding modifier
% of brain damage taken from all sources
% of brute damage taken from all sources
% of burn damage taken from all sources
% of clone damage taken from all sources
% of burn damage taken from cold (stacks with burn_mod)
%damage reduction from all sources
% of burn damage taken from heat (stacks with burn_mod)
% of hunger rate taken per tick.
Bonus damage added to melee attacks. NOTE: this is additive rather than multiplicative, trying to multiply this will break things.
% of oxygen damage taken from all sources
% of brute damage taken from low or high pressure (stacks with brute_mod)
resistance to shocks
% of stamina damage taken from all sources
% stun modifier
% of toxin damage taken from all sources
Pipe types for transit tubes.
Vars | |
| construction_type | The type of the object that results from dispensing this datum from the RPD. |
|---|---|
The type of the object that results from dispensing this datum from the RPD.
Vars | |
| dangerous | Used to determine if the trait should be logged when the holder is used |
|---|---|
Used to determine if the trait should be logged when the holder is used
A precise point on the map in absolute pixel locations based on world.icon_size. Pixels are FROM THE EDGE OF THE MAP!
Procs | |
| New | First argument can also be a /datum/position or /atom. |
|---|---|
First argument can also be a /datum/position or /atom.
Vars | |
| mpx | Calculated x movement amounts to prevent having to do trig every step. |
|---|---|
| mpy | Calculated y movement amounts to prevent having to do trig every step. |
| speed | Pixels per iteration |
Procs | |
| set_angle | Calculations use "byond angle" where north is 0 instead of 90, and south is 180 instead of 270. |
| set_location | Same effect as initiliaze_location, but without setting the starting_x/y/z |
Calculated x movement amounts to prevent having to do trig every step.
Calculated y movement amounts to prevent having to do trig every step.
Pixels per iteration
Calculations use "byond angle" where north is 0 instead of 90, and south is 180 instead of 270.
Same effect as initiliaze_location, but without setting the starting_x/y/z
Vars | |
| blackbox_message | Message for the blackbox, legacy verbs so we can't just use the name |
|---|---|
| description | Description of what the pref setting does |
| disable_message | Message to display when this toggle is disabled |
| enable_message | Message to display when this toggle is enabled |
| name | Name of the preference toggle. Don't set this if you don't want it to appear in game |
| preftoggle_bitflag | Bitflag this datum will set to |
| preftoggle_category | Category of the toggle |
| preftoggle_toggle | What toggles to set this to? |
| rights_required | Rights required to be able to use this pref option |
Message for the blackbox, legacy verbs so we can't just use the name
Description of what the pref setting does
Message to display when this toggle is disabled
Message to display when this toggle is enabled
Name of the preference toggle. Don't set this if you don't want it to appear in game
Bitflag this datum will set to
Category of the toggle
What toggles to set this to?
Rights required to be able to use this pref option
Vars | |
| _2fa_status | 2FA status |
|---|---|
| active_character | The current active character |
| admin_sound_ckey_ignore | List of admin ckeys this player wont hear sounds from |
| character_saves | List of all character saves we have. This is indexed based on the slot number |
| characters_loaded | Have we loaded characters already? |
| colourblind_mode | Colourblind mode |
| ghost_darkness_level | How dark things are if client is a ghost, 0-255 |
| keybindings | Active keybinds (currently useable by the mob/client) |
| keybindings_overrides | Keybinding overrides ("name" => ["key"...]) |
| screentip_color | Color of screentips at top of screen |
| screentip_mode | Screentip Mode, in pixels. 8 is small, 15 is mega big, 0 is off. |
| server_region | Player's region override for routing optimisation |
| successful_load | Did we load successfully? |
| viewrange | View range preference for this client |
| volume_mixer | Volume mixer, indexed by channel as TEXT (numerical indexes will not work). Volume goes from 0 to 100. |
| volume_mixer_saving | The volume mixer save timer handle. Used to debounce the DB call to save, to avoid spamming. |
Procs | |
| build_loadout | Rebuilds the loadout_gear list of the [active_character], and returns the total end cost. |
| deserialize_volume_mixer | Returns a volume mixer list from text, usually from the DB. |
| get_channel_volume | Returns a volume multiplier for the given channel, from 0 to 1 (default). |
| save_volume_mixer | Saves [/datum/preferences/proc/volume_mixer] for the current client. |
| serialize_volume_mixer | Returns a DB-friendly version of a volume mixer list. |
| set_channel_volume | Changes a channel's volume then queues it for DB save. |
2FA status
The current active character
List of admin ckeys this player wont hear sounds from
List of all character saves we have. This is indexed based on the slot number
Have we loaded characters already?
Colourblind mode
How dark things are if client is a ghost, 0-255
Active keybinds (currently useable by the mob/client)
Keybinding overrides ("name" => ["key"...])
Color of screentips at top of screen
Screentip Mode, in pixels. 8 is small, 15 is mega big, 0 is off.
Player's region override for routing optimisation
Did we load successfully?
View range preference for this client
Volume mixer, indexed by channel as TEXT (numerical indexes will not work). Volume goes from 0 to 100.
The volume mixer save timer handle. Used to debounce the DB call to save, to avoid spamming.
Rebuilds the loadout_gear list of the [active_character], and returns the total end cost.
Caches and cuts the existing [/datum/character_save/var/loadout_gear] list and remakes it, checking the subtype_selection_cost and overall cost validity of each item.
If the item's /datum/gear/var/subtype_selection_cost is FALSE, any future items with the same /datum/gear/var/main_typepath will have their cost skipped.
+If adding the item will take the total cost over the maximum, it won't be added to the list.
Arguments:
+loadout_gear list.Returns a volume mixer list from text, usually from the DB.
+Failure to deserialize will return the current value.
+Arguments
+Returns a volume multiplier for the given channel, from 0 to 1 (default).
+Arguments:
+Saves [/datum/preferences/proc/volume_mixer] for the current client.
Returns a DB-friendly version of a volume mixer list.
+Arguments
+Changes a channel's volume then queues it for DB save.
+Arguments:
+Vars | |
| reference_average | Average amount of references that the hard deleted item holds when hard deleted |
|---|---|
Average amount of references that the hard deleted item holds when hard deleted
Vars | |
| __dirs | The directions to the side of the wave, stored for easy looping |
|---|---|
| can_contaminate | Whether or not this radiation wave can create contaminated objects |
| intensity | How strong it was originaly |
| master_turf | The center of the wave |
| move_dir | The direction of movement |
| range_modifier | Higher than 1 makes it drop off faster, 0.5 makes it drop off half etc |
| remaining_contam | How much contaminated material it still has |
| source | The thing that spawned this radiation wave |
| steps | How far we've moved |
The directions to the side of the wave, stored for easy looping
Whether or not this radiation wave can create contaminated objects
How strong it was originaly
The center of the wave
The direction of movement
Higher than 1 makes it drop off faster, 0.5 makes it drop off half etc
How much contaminated material it still has
The thing that spawned this radiation wave
How far we've moved
A generic action for an RCD.
Vars | |
| cost | How much compressed matter this action costs. |
|---|---|
| delay | How long this action takes. |
| end_effect_type | The effect (if any) to create when the action completes. |
| mode | The mode the RCD must be in. |
| start_effect_type | The effect (if any) to create when the action starts. |
| start_message | The message (if any) to send the user when the action starts. |
Procs | |
| act | Perform the act. You should usually override this. |
| can_act | Test to see if the act is possible. You should usually override this. |
| try_act | Attempt the action. This should not need to be overridden. |
How much compressed matter this action costs.
How long this action takes.
The effect (if any) to create when the action completes.
The mode the RCD must be in.
The effect (if any) to create when the action starts.
The message (if any) to send the user when the action starts.
Perform the act. You should usually override this.
Test to see if the act is possible. You should usually override this.
Attempt the action. This should not need to be overridden.
Vars | |
| addiction_decay_rate | how quickly the addiction threshold var decays |
|---|---|
| allowed_overdose_process | If this variable is true, chemicals will continue to process in mobs when overdosed. |
| color | The color of the agent outside of containers. |
| holder | A reference to the holder the chemical is 'in'. |
Procs | |
| reaction_mob | React with a mob. |
| reaction_obj | React with an object. |
| reaction_turf | React with a turf. |
how quickly the addiction threshold var decays
If this variable is true, chemicals will continue to process in mobs when overdosed.
The color of the agent outside of containers.
A reference to the holder the chemical is 'in'.
React with a mob.
+The method var can be either REAGENT_TOUCH or REAGENT_INGEST. Some
+reagents transfer on touch, others don't; dependent on if they penetrate the
+skin or not. You'll want to put stuff like acid-facemelting in here. Should
+only ever be called, directly, on living mobs.
React with an object.
React with a turf.
+You'll want to put stuff like extra slippery floors for lube or something in here.
Vars | |
| tenacity | how much do we edit the stun and stamina mods? lower is more resistance |
|---|---|
how much do we edit the stun and stamina mods? lower is more resistance
Vars | |
| changeling_chemical_tracker | Keeps track of how many chemicals we are delaying the changeling by. |
|---|---|
Procs | |
| dodge_bullets | Tries to dodge incoming bullets if we aren't disabled for any reasons |
| no_hud_cheese | So. If a person changes up their hud settings (Changing their ui theme), the visual effects for this reagent will break, and they will be able to see easily. This 3 part proc waits for the plane controlers to be setup, and over 2 other procs, rengages the visuals |
| no_hud_cheese_2 | This part of the anticheese sets up the basic visual effects normally setup when the reagent gets into your system. |
| no_hud_cheese_3 | This part sets up the OD visual effects. |
| on_movement | Leaves an afterimage behind the mob when they move |
Keeps track of how many chemicals we are delaying the changeling by.
Tries to dodge incoming bullets if we aren't disabled for any reasons
So. If a person changes up their hud settings (Changing their ui theme), the visual effects for this reagent will break, and they will be able to see easily. This 3 part proc waits for the plane controlers to be setup, and over 2 other procs, rengages the visuals
This part of the anticheese sets up the basic visual effects normally setup when the reagent gets into your system.
This part sets up the OD visual effects.
Leaves an afterimage behind the mob when they move
Vars | |
| tenacity | modifier to the stun time of the mob taking the drug |
|---|---|
modifier to the stun time of the mob taking the drug
Vars | |
| reagent_after_burning | What this becomes after burning. |
|---|---|
What this becomes after burning.
The holder is the datum that holds a list of all reagents +currently in the object.
+By default, all atom have an empty reagents var. If you want to use +an object for the chemistry system you'll need to add something like this in +its new proc:
+// Create a new datum, 100 is the maximum_volume of the new holder datum.
+var/datum/reagents/R = new/datum/reagents(100)
+reagents = R // Assign the new datum to the objects reagents var
+R.my_atom = src // set the holders my_atom to src so that we know where we are.
+This can also be done by calling a convenience proc e.g. +/atom/proc/create_reagents(max_volume)
Vars | |
| maximum_volume | This is the maximum volume of the holder. |
|---|---|
| my_atom | This is the atom the holder is 'in'. Useful if you need to find the location. (i.e. for explosions) |
| reagent_list | All contained reagents. More specifically, references to the reagent datums. |
| total_volume | The total volume of all reagents in this holder. |
Procs | |
| add_reagent | Attempts to add X of the matching reagent to the holder. |
| clear_reagents | Remove all reagents from the holder. |
| del_reagent | Completely remove the reagent with the matching ID. |
| get_master_reagent_id | Get the id of the reagent there is the most of in this holder |
| get_reagent_amount | Returns the amount of the matching reagent inside the holder. |
| handle_reactions | Check all recipes and, on a match, uses them. |
| has_reagent | Return whether the holder contains the reagent. |
| isolate_reagent | Remove all reagents but the specified one. |
| metabolize | Called by /mob/living/proc/Life. You shouldn't have to use this one directly. |
| overdose_list | Returns a list of all the chemical IDs in the reagent holder that are overdosing. |
| reaction | Calls the appropriate reaction procs of the reagents. |
| remove_any | Removes reagents from the holder until the passed amount is matched. |
| remove_reagent | The exact opposite of the add_reagent proc. |
| trans_id_to | Same as /datum/reagents/proc/trans_to but only for a specific reagent in +the reagent list. If the specified amount is greater than what is available, +it will use the amount of the reagent that is available. If no reagent +exists, returns null. |
| trans_to | Equally transfer the contents of the holder to another objects holder. |
| update_total | Update the total volume of the holder (the volume of all reagents added together). |
This is the maximum volume of the holder.
This is the atom the holder is 'in'. Useful if you need to find the location. (i.e. for explosions)
All contained reagents. More specifically, references to the reagent datums.
The total volume of all reagents in this holder.
Attempts to add X of the matching reagent to the holder.
+You won't use this much. Mostly in new procs for pre-filled objects.
Remove all reagents from the holder.
Completely remove the reagent with the matching ID.
Get the id of the reagent there is the most of in this holder
Returns the amount of the matching reagent inside the holder.
+Returns FALSE if the reagent is missing.
Check all recipes and, on a match, uses them.
+It will also call the recipe's on_reaction proc (for explosions or w/e). +Currently, this proc is automatically called by /datum/reagents/proc/trans_to. +Modified from the original to preserve reagent data across reactions +(originally for xenoarchaeology).
Return whether the holder contains the reagent.
+If you pass it an amount it will additionally check if the amount is matched.
Remove all reagents but the specified one.
Called by /mob/living/proc/Life. You shouldn't have to use this one directly.
Returns a list of all the chemical IDs in the reagent holder that are overdosing.
Calls the appropriate reaction procs of the reagents.
+I.e. if A is an object, it will call the reagent's reaction_obj +proc. The method var is used for reaction on mobs. It simply tells +us if the mob TOUCHed the reagent or if it INGESTed the reagent.
+Since the volume can be checked in a reagents proc, you might want to +use the volume_modifier var to modifiy the passed value without actually +changing the volume of the reagents.
+If you're not sure if you need to use this the answer is very most likely 'No'.
+You'll want to use this proc whenever an atom first comes in contact +with the reagents of a holder. (in the 'splash' part of a beaker i.e.)
Removes reagents from the holder until the passed amount is matched.
+It'll try to remove some of ALL reagents contained.
The exact opposite of the add_reagent proc.
+Modified from original to return the reagent's data, in order to preserve +reagent data across reactions (originally for xenoarchaeology).
Same as /datum/reagents/proc/trans_to but only for a specific reagent in +the reagent list. If the specified amount is greater than what is available, +it will use the amount of the reagent that is available. If no reagent +exists, returns null.
Equally transfer the contents of the holder to another objects holder.
+You need to pass it the object (not the holder) you want to transfer to and +the amount you want to transfer. Its return value is the actual amount +transfered (if one of the objects is full/empty).
+If preserve_data = FALSE, the reagents data will be lost. Useful if you use
+data for some strange stuff and don't want it to be transferred.
Update the total volume of the holder (the volume of all reagents added together).
Vars | |
| editors | Indexed by target.UID |
|---|---|
Indexed by target.UID
Vars | |
| duplicate | Whether or not an upgraded kitchen machine will create more products using the same amount of ingredients |
|---|---|
Procs | |
| check_items_assoc_list | Similarly to the function above, this checks for items, except instead of being passed a reagent holder, we're passed +[type_path] = amount as num. +Returns INGREDIENT_CHECK_EXACT if we have the precise amount thats requested. +Returns INGREDIENT_CHECK_FAILURE if we do not have enough. +Returns INGREDIENT_CHECK_SURPLUS if we have MORE than requested. |
| check_reagents_assoc_list | Similarly to the function above, this checks for reagents, except instead of being passed a reagent holder, we're passed +[reagent_id] = amount as num. +Returns INGREDIENT_CHECK_EXACT if we have the precise amount thats requested. +Returns INGREDIENT_CHECK_FAILURE if we do not have enough. +Returns INGREDIENT_CHECK_SURPLUS if we have MORE than requested. |
Whether or not an upgraded kitchen machine will create more products using the same amount of ingredients
Similarly to the function above, this checks for items, except instead of being passed a reagent holder, we're passed +[type_path] = amount as num. +Returns INGREDIENT_CHECK_EXACT if we have the precise amount thats requested. +Returns INGREDIENT_CHECK_FAILURE if we do not have enough. +Returns INGREDIENT_CHECK_SURPLUS if we have MORE than requested.
Similarly to the function above, this checks for reagents, except instead of being passed a reagent holder, we're passed +[reagent_id] = amount as num. +Returns INGREDIENT_CHECK_EXACT if we have the precise amount thats requested. +Returns INGREDIENT_CHECK_FAILURE if we do not have enough. +Returns INGREDIENT_CHECK_SURPLUS if we have MORE than requested.
Callback datum for subscribed redis channel handling
+This datum is used for easily assigning callbacks for SSredis to use
+when a message is receievd on a channel. Define a channel on the channel
+var and SSredis will automatically register subtypes of /datum/redis_callback
Vars | |
| channel | Channel for this callback to listen on |
|---|---|
Procs | |
| on_message | Message handler callback |
Channel for this callback to listen on
Message handler callback
+This callback is ran when a message is received on the assigned channel. +Make sure you override it on subtypes or it wont work.
+Arguments:
+Holder datum for redis messages
+This datum is used for caching messages that SSredis tries to +publish before it has connected. It is not used for any subscribed +channel handling.
Vars | |
| channel | Destination channel for this message |
|---|---|
| message | Message for that channel |
Destination channel for this message
Message for that channel
Vars | |
| available_power | the current available power in the powernet |
|---|---|
| cables | A list of All cables & junctions in this powernet |
| excess_power | excess power on the powernet (typically avail-load) |
| nodes | All Power Machines that are connected to this powernet |
| number | The Powernet Unique ID Number |
| power_demand | the current load on the powernet, increased by each machine at processing |
| queued_power_demand | load applied to powernet between power ticks. |
| queued_power_production | what available power was gathered last tick, then becomes... |
| smoothed_available_power | the available power as it appears on the power console (gradually updated) |
| smoothed_demand | the load as it appears on the power console (gradually updated) |
Procs | |
| add_cable | add a cable to the current powernet |
| add_machine | add a power machine to the current powernet |
| calculate_power_balance | Returns the non-clamped difference between available power on the net and the demanded power, i.g. consumption vs. supply |
| calculate_surplus | Returns the clamped difference between available power on the net and the demanded power, i.g. the surplus power available |
| remove_cable | remove a cable from the current powernet, if the powernet is empty after, delete it |
| remove_machine | remove a power machine from the current powernet, if the powernet is then empty, delete it |
the current available power in the powernet
A list of All cables & junctions in this powernet
excess power on the powernet (typically avail-load)
All Power Machines that are connected to this powernet
The Powernet Unique ID Number
the current load on the powernet, increased by each machine at processing
load applied to powernet between power ticks.
what available power was gathered last tick, then becomes...
the available power as it appears on the power console (gradually updated)
the load as it appears on the power console (gradually updated)
add a cable to the current powernet
add a power machine to the current powernet
Returns the non-clamped difference between available power on the net and the demanded power, i.g. consumption vs. supply
Returns the clamped difference between available power on the net and the demanded power, i.g. the surplus power available
remove a cable from the current powernet, if the powernet is empty after, delete it
remove a power machine from the current powernet, if the powernet is then empty, delete it
Describes something that can be purchased with Contractor Rep.
Vars | |
| cost | The price in Contractor Rep of the purchase. |
|---|---|
| description | The description of the purchase. |
| name | The display name of the purchase. |
| stock | How many times the purchase can be made. +-1 means infinite stock. |
Procs | |
| buy | Attempts to perform the purchase. |
| on_buy | Called when the purchase was made successfully. |
The price in Contractor Rep of the purchase.
The description of the purchase.
The display name of the purchase.
How many times the purchase can be made. +-1 means infinite stock.
Attempts to perform the purchase.
+Returns TRUE or FALSE depending on whether the purchase succeeded.
+Arguments:
+Called when the purchase was made successfully.
+Arguments:
+Vars | |
| cooldown | How long a contractor must wait before calling another blackout, in deciseconds. |
|---|---|
| next_blackout | Static cooldown variable for blackouts. |
How long a contractor must wait before calling another blackout, in deciseconds.
Static cooldown variable for blackouts.
Describes an item that can be purchased with Contractor Rep.
Vars | |
| item_type | The typepath of the item to instantiate and give to the buyer on purchase. |
|---|---|
The typepath of the item to instantiate and give to the buyer on purchase.
Master Types
+Includes all the helper procs and basic tech processing. +Holder for all the existing, archived, and known tech. Individual to console.
Vars | |
| blacklisted_designs | List of designs that have been blacklisted by the server controller |
|---|---|
| unblacklisted_designs | Used during the rnd sync system, to ensure that blacklists are reverted, then cleared. |
List of designs that have been blacklisted by the server controller
Used during the rnd sync system, to ensure that blacklists are reverted, then cleared.
Vars | |
| silent | Whether the ERT announcement should be hidden from the station |
|---|---|
Whether the ERT announcement should be hidden from the station
A cost counter for resumable, repeating processes.
Procs | |
| record_progress | Updates the counter based on the time spent making progress and whether we finished the task. |
|---|---|
| to_string | Gets a display string for this cost counter. |
Updates the counter based on the time spent making progress and whether we finished the task.
Gets a display string for this cost counter.
A straightforward system for making "rivers", paths made up of a specific +turf type that are generated in a random path on a z-level.
Vars | |
| river_turf_type | The base type that makes up the river. |
|---|---|
| shoreline_turf_type | The turf used when a spread of the tile stops. |
| spread_prob | The initial probability that a river tile will spread to adjacent tiles. |
| spread_prob_loss | The amount reduced from spread_prob on every spread iteration to cause falloff. |
| target_z | The z-level to generate the river on. There is theoretically nothing stopping +this from being used across z-levels, but we're keeping things simple. |
| whitelist_area_type | The area that the spawner is allowed to spread or detour to. |
| whitelist_turf_type | The type that the spawner is allowed to spread or detour to. |
Procs | |
| generate | Generate a river between the bounds specified by (min_x, min_y) and
+(max_x, max_y). |
The base type that makes up the river.
The turf used when a spread of the tile stops.
The initial probability that a river tile will spread to adjacent tiles.
The amount reduced from spread_prob on every spread iteration to cause falloff.
The z-level to generate the river on. There is theoretically nothing stopping +this from being used across z-levels, but we're keeping things simple.
The area that the spawner is allowed to spread or detour to.
The type that the spawner is allowed to spread or detour to.
Generate a river between the bounds specified by (min_x, min_y) and
+(max_x, max_y).
nodes is the number of unique points in those bounds the river will
+connect to. Note that nodes says little about the resultant size of the
+river due to its ability to detour far away from the direct path between them.
# The robot_energy_storage datum
+Used to handle robot stack items, such as metal, wood, nanopaste, etc.
+To make things simple, the default `cost` of using 1 item from a borg stack, is 1.
+So then for example, when we have a `max_energy` of 50, the borg can use 50 of that item before it runs out.
+
+The `recharge_rate` will be affected by the charge rate of a borg recharger, depending on the level of parts. By default it is 1.
+This amount will be given every 2 seconds. So at round start, rechargers will give 1 energy back every 2 seconds, to each stack the borg has.
+Vars | |
| amount | Current amount of materials. |
|---|---|
| max_amount | The max amount of materials the stack can hold at once. |
| name | The name of the storage. |
| statpanel_name | The name that will be displayed in the status panel. |
Procs | |
| add_charge | Called whenever the cyborg is recharging and gains charge on its stack, or when clicking on other same-type stacks in the world. |
| use_charge | Called whenever the cyborg uses one of its stacks. Subtract the amount used from this datum's amount variable. |
Current amount of materials.
The max amount of materials the stack can hold at once.
The name of the storage.
The name that will be displayed in the status panel.
Called whenever the cyborg is recharging and gains charge on its stack, or when clicking on other same-type stacks in the world.
+Arguments:
+energy var.Called whenever the cyborg uses one of its stacks. Subtract the amount used from this datum's amount variable.
Arguments:
+amount var.Vars | |
| recharge_rate | The amount of energy the stack will regain while charging. |
|---|---|
The amount of energy the stack will regain while charging.
This datum is an alternative to the energy storages, instead being recharged in different ways
Vars | |
| add_to_storage | Does this get added to the autorefill from the ORM |
|---|---|
| stack | What stacktype do we originally have |
Does this get added to the autorefill from the ORM
What stacktype do we originally have
Vars | |
| all_arrested | Did the crew catch all of the antags alive? |
|---|---|
| crewscore | Overall combined score for the whole round. |
| damaged_health | How damaged was the most injured person on the shuttle? |
| damaged_job | What was the job of the most injured person on the shuttle? |
| damaged_key | What was the ckey of the most injured person on the shuttle? |
| damaged_name | What was the name of the most injured person on the shuttle? |
| dead_ai | If the AI is dead, big points penalty. |
| disc_secure | Is the NAD safe and secure? |
| mess_bonus | If there are no messes on the station anywhere, huge bonus. |
| nuked | Was the station blown into little bits? |
| nuked_penalty | Points penalty for being blown to little bits. |
| power_bonus | If all APCs on the station are running optimally, big bonus. |
| richest_cash | How much money did the richest person on the shuttle have? |
| richest_job | What was the job of the richest person on the shuttle? |
| richest_key | What was the ckey of the richest person on the shuttle? |
| richest_name | What was the name of the richest person on the shuttle? |
| score_arrested | How many antagonists are alive in the brig? (Nuke ops & Revolution) |
| score_clown_abuse | How many times was the clown punched, struck, or otherwise maligned? |
| score_dead_command | How many command members died? (Revolution) |
| score_dead_crew | How many people /didn't/ get out alive? |
| score_disease | How many rampant, uncured diseases are on board the station? |
| score_escapees | How many people got out alive? |
| score_events_endured | How many random events did the station survive? |
| score_food_eaten | How much noms were had by the crew? |
| score_greentext | Were the antagonists successful? |
| score_meals | How many meals were made? |
| score_mess | How much blood, puke, stains etc went uncleaned? |
| score_ops_killed | How many operatives were killed? (Nuke ops & Revolution) |
| score_ore_mined | How much ore has been mined on the mining z level? |
| score_power_loss | How many APCs have poor charge? |
| score_research_done | How much research was done by science? |
| score_things_harvested | How many harvests have hydroponics done? |
| score_things_shipped | How many useful items have cargo shipped out? |
Procs | |
| get_score_container_worth | A recursive function to properly determine the cash on the wealthiest escapee |
| get_score_person_worth | A function to determine the cash plus the account balance of the wealthiest escapee |
Did the crew catch all of the antags alive?
Overall combined score for the whole round.
How damaged was the most injured person on the shuttle?
What was the job of the most injured person on the shuttle?
What was the ckey of the most injured person on the shuttle?
What was the name of the most injured person on the shuttle?
If the AI is dead, big points penalty.
Is the NAD safe and secure?
If there are no messes on the station anywhere, huge bonus.
Was the station blown into little bits?
Points penalty for being blown to little bits.
If all APCs on the station are running optimally, big bonus.
How much money did the richest person on the shuttle have?
What was the job of the richest person on the shuttle?
What was the ckey of the richest person on the shuttle?
What was the name of the richest person on the shuttle?
How many antagonists are alive in the brig? (Nuke ops & Revolution)
How many times was the clown punched, struck, or otherwise maligned?
How many command members died? (Revolution)
How many people /didn't/ get out alive?
How many rampant, uncured diseases are on board the station?
How many people got out alive?
How many random events did the station survive?
How much noms were had by the crew?
Were the antagonists successful?
How many meals were made?
How much blood, puke, stains etc went uncleaned?
How many operatives were killed? (Nuke ops & Revolution)
How much ore has been mined on the mining z level?
How many APCs have poor charge?
How much research was done by science?
How many harvests have hydroponics done?
How many useful items have cargo shipped out?
A recursive function to properly determine the cash on the wealthiest escapee
A function to determine the cash plus the account balance of the wealthiest escapee
Security levels
+These are used by the security level subsystem. Each one of these represents a security level that a player can set.
+Base type is abstract
Vars | |
| ai_announcement_sound | The AI announcement sound about code change, that will be played after main sound |
|---|---|
| color | Color of security level |
| elevating_to_announcement_text | Our announcement when elevating to this level |
| elevating_to_announcement_title | Our announcement title when elevating to this level |
| elevating_to_sound | The sound that we will play when elevated to this security level |
| lowering_to_announcement_text | Our announcement when lowering to this level |
| lowering_to_announcement_title | Our announcement title when lowering to this level |
| lowering_to_sound | The sound that we will play when lowered to this security level |
| name | The name of this security level. |
| number_level | The numerical level of this security level, see defines for more information. |
| set_delay | The delay, after which the security level will be set |
| status_display_data | The status display data that will be posted to all status displays on security level set |
| status_display_mode | The status display that will be posted to all status displays on security level set |
Procs | |
| pre_change | Should contain actions that must be completed before actual security level set |
The AI announcement sound about code change, that will be played after main sound
Color of security level
Our announcement when elevating to this level
Our announcement title when elevating to this level
The sound that we will play when elevated to this security level
Our announcement when lowering to this level
Our announcement title when lowering to this level
The sound that we will play when lowered to this security level
The name of this security level.
The numerical level of this security level, see defines for more information.
The delay, after which the security level will be set
The status display data that will be posted to all status displays on security level set
The status display that will be posted to all status displays on security level set
Should contain actions that must be completed before actual security level set
BLUE
+Caution advised
DELTA
+Station self-destruiction mechanism has been engaged
Epsilon
+Station is not longer under the Central Command and to be destroyed by Death Squad (Or maybe not)
Gamma
+Station major hostile threats
GREEN
+No threats
RED
+Hostile threats
Datum to handle both sending and receiving of server commands
+This datum is an extension of the redis callback and is designed for tighter integration with the BYOND servers. +This list is registered and managed by SSintancing, not SSredis. +NOTE: These commands are "fire and forget". If you need specific data from each server, use world/Topic still
Vars | |
| command_args | Associative list of command args |
|---|---|
| command_name | The command name (must be unique) |
| ignoreself | Does the sending server want to ignore this command? This is almost always yes unless you are doing testing stuff |
| source | The source BYOND server for this message |
Associative list of command args
The command name (must be unique)
Does the sending server want to ignore this command? This is almost always yes unless you are doing testing stuff
The source BYOND server for this message
Represents a base configuration datum. Has everything else bundled into it
Vars | |
| admin | Holder for the admin configuration datum |
|---|---|
| afk | Holder for the AFK configuration datum |
| asset_cache | Holder for the asset cache configuration datum |
| custom_sprites | Holder for the custom sprites configuration datum |
| database | Holder for the DB configuration datum |
| discord | Holder for the Discord configuration datum |
| event | Holder for the Event configuration datum |
| gamemode | Holder for the gamemode configuration datum |
| general | Holder for the general configuration datum |
| ipintel | Holder for the IPIntel configuration datum |
| jobs | Holder for the job configuration datum |
| logging | Holder for the logging configuration datum |
| mc | Holder for the MC configuration datum |
| metrics | Holder for the metrics configuration datum |
| movement | Holder for the movement configuration datum |
| overflow | Holder for the overflow configuration datum |
| raw_data | Raw data. Stored here to avoid passing data between procs constantly |
| redis | Holder for the redis configuration datum |
| ruins | Holder for the ruins configuration datum |
| system | Holder for the system configuration datum |
| url | Holder for the URL configuration datum |
| vote | Holder for the voting configuration datum |
Holder for the admin configuration datum
Holder for the AFK configuration datum
Holder for the asset cache configuration datum
Holder for the custom sprites configuration datum
Holder for the DB configuration datum
Holder for the Discord configuration datum
Holder for the Event configuration datum
Holder for the gamemode configuration datum
Holder for the general configuration datum
Holder for the IPIntel configuration datum
Holder for the job configuration datum
Holder for the logging configuration datum
Holder for the MC configuration datum
Holder for the metrics configuration datum
Holder for the movement configuration datum
Holder for the overflow configuration datum
Raw data. Stored here to avoid passing data between procs constantly
Holder for the redis configuration datum
Holder for the ruins configuration datum
Holder for the system configuration datum
Holder for the URL configuration datum
Holder for the voting configuration datum
These are the actual backend behind instruments. +They attach to an atom and provide the editor + playback functionality.
Vars | |
| allowed_instrument_ids | What instruments our built in picker can use. The picker won't show unless this is longer than one. |
|---|---|
| cached_exponential_dropoff | Do not directly set, use update_sustain() |
| cached_legacy_dir | Cached legacy dir for legacy instruments |
| cached_legacy_ext | Cached legacy ext for legacy instruments |
| cached_linear_dropoff | /////// DO NOT DIRECTLY SET THESE! +Do not directly set, use update_sustain() |
| cached_samples | Cached list of samples, referenced directly from the instrument for synthesized instruments |
| channels_idle | List of channels that aren't being used, as text. This is to prevent unnecessary freeing and reallocations from SSsounds/SSinstruments. |
| channels_playing | Channel as text = current volume percentage but it's 0 to 100 instead of 0 to 1. |
| compiled_chords | Playing variables +Build by compile_chords() +Must be rebuilt on instrument switch. +Compilation happens when we start playing and is cleared after we finish playing. +Format: list of chord lists, with chordlists having (key1, key2, key3, tempodiv) |
| current_chord | Current chord we're on. |
| debug_mode | If this is enabled, some things won't be strictly cleared when they usually are (liked compiled_chords on play stop) |
| delay_by | Amount of delay to wait before playing the next chord |
| editing | Are we currently editing? |
| elapsed_delay | Current section of a long chord we're on, so we don't need to make a billion chords, one for every unit ticklag. |
| full_sustain_held_note | Should we not decay our last played note? |
| hearing_mobs | The list of mobs that can hear us |
| help | Is the help screen open? |
| instrument_range | How far we can be heard |
| last_channel_played | Last channel to play. text. |
| last_hearcheck | Last world.time we checked for who can hear us |
| legacy | Are we operating in legacy mode (so if the instrument is a legacy instrument) |
| lines | Our song lines |
| max_repeats | Maximum times we can repeat |
| max_sound_channels | Max sound channels to occupy |
| max_volume | Max volume |
| min_volume | Min volume - This is so someone doesn't decide it's funny to set it to 0 and play invisible songs. |
| name | Name of the song |
| note_shift | ////////// !!FUN!! - Only works in synthesized mode! ///////////////// +Note numbers to shift. |
| octave_min | DO NOT TOUCH THESE |
| parent | The atom we're attached to/playing from |
| playing | Are we currently playing? |
| repeat | Repeats left |
| sustain_dropoff_volume | When a note is considered dead if it is below this in volume |
| sustain_exponential_dropoff | Exponential sustain dropoff rate per decisecond |
| sustain_linear_duration | Total duration of linear sustain for 100 volume note to get to SUSTAIN_DROPOFF |
| sustain_mode | The kind of sustain we're using |
| tempo | delay between notes in deciseconds |
| user_playing | Person playing us |
| using_instrument | ///////// Cached instrument variables ///////////// +Instrument we are currently using |
| using_sound_channels | Current channels, so we can save a length() call. |
| volume | Our volume |
Procs | |
| compile_chords | Compiles chords. |
| compile_legacy | Compiles our lines into "chords" with filenames for legacy playback. This makes there have to be a bit of lag at the beginning of the song, but repeats will not have to parse it again, and overall playback won't be impacted by as much lag. |
| compile_synthesized | Compiles our lines into "chords" with numbers. This makes there have to be a bit of lag at the beginning of the song, but repeats will not have to parse it again, and overall playback won't be impacted by as much lag. |
| do_hearcheck | Checks and stores which mobs can hear us. Terminates sounds for mobs that leave our range. |
| get_bpm | Gets our beats per minute based on our tempo. |
| parse_song | Parses a song the user has input into lines and stores them. |
| play_chord | Plays a chord. |
| playkey_legacy | Proc to play a legacy note. Just plays the sound to hearing mobs (and does hearcheck if necessary), no fancy channel/sustain/management. |
| playkey_synth | Plays a specific numerical key from our instrument to anyone who can hear us. +Does a hearing check if enough time has passed. |
| pop_channel | Pops a channel we have reserved so we don't have to release and re-request them from SSsounds every time we play a note. This is faster. |
| process_decay | Decays our channels and updates their volumes to mobs who can hear us. |
| process_song | Processes our song. |
| sanitize_tempo | Sanitizes tempo to a value that makes sense and fits the current world.tick_lag. |
| set_bpm | Sets our tempo from a beats-per-minute, sanitizing it to a valid number first. |
| set_dropoff_volume | Setter for setting how low the volume has to get before a note is considered "dead" and dropped |
| set_exponential_drop_rate | Setter for setting exponential falloff factor. |
| set_instrument | Sets our instrument, caching anything necessary for faster accessing. Accepts an ID, typepath, or instantiated instrument datum. |
| set_linear_falloff_duration | Setter for setting linear falloff duration. |
| set_volume | Setter for setting output volume. |
| should_stop_playing | Checks if we should halt playback. |
| start_playing | Attempts to start playing our song. |
| stop_playing | Stops playing, terminating all sounds if in synthesized mode. Clears hearing_mobs. |
| tempodiv_to_delay | Converts a tempodiv to ticks to elapse before playing the next chord, taking into account our tempo. |
| terminate_all_sounds | Stops all sounds we are "responsible" for. Only works in synthesized mode. |
| terminate_sound_mob | Stops all sounds we are responsible for in a given person. Only works in synthesized mode. |
| update_sustain | Updates our cached linear/exponential falloff stuff, saving calculations down the line. |
What instruments our built in picker can use. The picker won't show unless this is longer than one.
Do not directly set, use update_sustain()
Cached legacy dir for legacy instruments
Cached legacy ext for legacy instruments
/////// DO NOT DIRECTLY SET THESE! +Do not directly set, use update_sustain()
Cached list of samples, referenced directly from the instrument for synthesized instruments
List of channels that aren't being used, as text. This is to prevent unnecessary freeing and reallocations from SSsounds/SSinstruments.
Channel as text = current volume percentage but it's 0 to 100 instead of 0 to 1.
Playing variables +Build by compile_chords() +Must be rebuilt on instrument switch. +Compilation happens when we start playing and is cleared after we finish playing. +Format: list of chord lists, with chordlists having (key1, key2, key3, tempodiv)
Current chord we're on.
If this is enabled, some things won't be strictly cleared when they usually are (liked compiled_chords on play stop)
Amount of delay to wait before playing the next chord
Are we currently editing?
Current section of a long chord we're on, so we don't need to make a billion chords, one for every unit ticklag.
Should we not decay our last played note?
The list of mobs that can hear us
Is the help screen open?
How far we can be heard
Last channel to play. text.
Last world.time we checked for who can hear us
Are we operating in legacy mode (so if the instrument is a legacy instrument)
Our song lines
Maximum times we can repeat
Max sound channels to occupy
Max volume
Min volume - This is so someone doesn't decide it's funny to set it to 0 and play invisible songs.
Name of the song
////////// !!FUN!! - Only works in synthesized mode! ///////////////// +Note numbers to shift.
DO NOT TOUCH THESE
The atom we're attached to/playing from
Are we currently playing?
Repeats left
When a note is considered dead if it is below this in volume
Exponential sustain dropoff rate per decisecond
Total duration of linear sustain for 100 volume note to get to SUSTAIN_DROPOFF
The kind of sustain we're using
delay between notes in deciseconds
Person playing us
///////// Cached instrument variables ///////////// +Instrument we are currently using
Current channels, so we can save a length() call.
Our volume
Compiles chords.
Compiles our lines into "chords" with filenames for legacy playback. This makes there have to be a bit of lag at the beginning of the song, but repeats will not have to parse it again, and overall playback won't be impacted by as much lag.
Compiles our lines into "chords" with numbers. This makes there have to be a bit of lag at the beginning of the song, but repeats will not have to parse it again, and overall playback won't be impacted by as much lag.
Checks and stores which mobs can hear us. Terminates sounds for mobs that leave our range.
Gets our beats per minute based on our tempo.
Parses a song the user has input into lines and stores them.
Plays a chord.
Proc to play a legacy note. Just plays the sound to hearing mobs (and does hearcheck if necessary), no fancy channel/sustain/management.
+Arguments:
+Plays a specific numerical key from our instrument to anyone who can hear us. +Does a hearing check if enough time has passed.
Pops a channel we have reserved so we don't have to release and re-request them from SSsounds every time we play a note. This is faster.
Decays our channels and updates their volumes to mobs who can hear us.
+Arguments:
+Processes our song.
Sanitizes tempo to a value that makes sense and fits the current world.tick_lag.
Sets our tempo from a beats-per-minute, sanitizing it to a valid number first.
Setter for setting how low the volume has to get before a note is considered "dead" and dropped
Setter for setting exponential falloff factor.
Sets our instrument, caching anything necessary for faster accessing. Accepts an ID, typepath, or instantiated instrument datum.
Setter for setting linear falloff duration.
Setter for setting output volume.
Checks if we should halt playback.
Attempts to start playing our song.
Stops playing, terminating all sounds if in synthesized mode. Clears hearing_mobs.
Converts a tempodiv to ticks to elapse before playing the next chord, taking into account our tempo.
Stops all sounds we are "responsible" for. Only works in synthesized mode.
Stops all sounds we are responsible for in a given person. Only works in synthesized mode.
Updates our cached linear/exponential falloff stuff, saving calculations down the line.
Procs | |
| gallopRight | Like gallopLeft, except that if the range contains an element equal to +key, gallopRight returns the index after the rightmost equal element. |
|---|---|
Like gallopLeft, except that if the range contains an element equal to +key, gallopRight returns the index after the rightmost equal element.
+@param key the key whose insertion point to search for +@param a the array in which to search +@param base the index of the first element in the range +@param len the length of the range; must be > 0 +@param hint the index at which to begin the search, 0 <= hint < n. +The closer hint is to the result, the faster this method will run. +@param c the comparator used to order the range, and to search +@return the int k, 0 <= k <= n such that a[b + k - 1] <= key < a[b + k]
Vars | |
| armor | Additional armour value for the species. |
|---|---|
| article_override | Article to use when referring to an individual of the species, if pronunciation is different from expected. +Because it's unathi's turn to be special snowflakes. |
| default_bodyacc | Name of default body accessory if any. |
| inherent_biotypes | bitfield of biotypes the mob belongs to. |
| inherent_traits | Generic traits tied to having the species. |
| max_age | Maximum age this species can have |
| min_age | Minimum age this species can have |
| name | Species name |
| name_plural | Pluralized name (since "[name]s" is not always valid) |
| optional_body_accessory | Whether the presence of a body accessory on this species is optional or not. |
| special_step_sounds | Sounds to override barefeet walking |
| sprite_sheet_name | The corresponding key for spritesheets |
| tail | Name of tail image in species effects icon file. |
| wing | like tail but wings |
Procs | |
| create_organs | Handles creation of mob organs. |
| get_species_runechat_color | Species-specific runechat colour handler |
Additional armour value for the species.
Article to use when referring to an individual of the species, if pronunciation is different from expected. +Because it's unathi's turn to be special snowflakes.
Name of default body accessory if any.
bitfield of biotypes the mob belongs to.
Generic traits tied to having the species.
Maximum age this species can have
Minimum age this species can have
Species name
Pluralized name (since "[name]s" is not always valid)
Whether the presence of a body accessory on this species is optional or not.
Sounds to override barefeet walking
The corresponding key for spritesheets
Name of tail image in species effects icon file.
like tail but wings
Handles creation of mob organs.
+Arguments:
+Species-specific runechat colour handler
+Checks the species datum flags and returns the appropriate colour +Can be overridden on subtypes to short-circuit these checks (Example: Grey colour is eye colour) +Arguments:
+The OG skellybones, quite OP. As of this comment, only available through ash-drake loot (2023-03-07)
Vars | |
| milk_fracture_repair_probability | How likely (in %) are we to heal a fracture? |
|---|---|
| milk_heal_amount | How much brute and burn does milk heal per handle_reagents() |
How likely (in %) are we to heal a fracture?
How much brute and burn does milk heal per handle_reagents()
Vars | |
| base_cooldown | recharge time in deciseconds |
|---|---|
| cooldown_handler | handles a given spells cooldowns. tracks the time until its off cooldown, |
| create_attack_logs | does this spell generate attack logs? |
| create_custom_logs | If this spell creates custom logs using the write_custom_logs() proc. Will ignore create_attack_logs |
| custom_handler | Which spell_handler is used in addition to the normal spells behaviour, can be null. Set this in create_new_handler if needed |
| holy_area_cancast | Whether or not the spell functions in a holy place |
| selection_activated_message | The message displayed when a click based spell gets activated |
| selection_deactivated_message | The message displayed when a click based spell gets deactivated |
| smoke_type | Determines if the spell has smoke, and if so what effect the smoke has. See spell defines. |
| spell_handlers | List with the handler datums per spell type. Key = src.type, value = the handler datum created by create_new_handler() |
| targeting | Which targeting system is used. Set this in create_new_targeting |
| targeting_datums | List with the targeting datums per spell type. Key = src.type, value = the targeting datum created by create_new_targeting() |
Procs | |
| cast | The proc where the actual spell gets cast. |
| choose_targets | Will try to choose targets using the targeting variable and perform the spell if it can +Do not override this! Override create_new_targeting instead |
| create_new_cooldown | Creates and returns the spells cooldown handler, defaults to the standard recharge handler. +Override this if you wish to use a different method of cooldown |
| create_new_handler | Creates and returns the handler datum for this spell type. +Override this if you want a custom spell handler. +Should return a value of type /datum/spell_handler or NONE |
| create_new_targeting | Creates and returns the targeting datum for this spell type. Override this! +Should return a value of type /datum/spell_targeting |
| on_mind_transfer | This proc is ran when a mind is transfered to a new mob. Tells it if the action should be transfered on return true, and tells it not to remove it on false |
| on_purchase_upgrade | Lets the spell have a special effect applied to it when upgraded. By default, does nothing. |
| perform | Handles all the code for performing a spell once the targets are known |
| should_remove_click_intercept | Called in try_perform before removing the click interceptor. useful to override if you have a spell that requires more than 1 click |
| spend_spell_cost | Will spend the cost of using this spell once. Will update the action button's icon if there is any |
| try_perform | Will try and perform the spell using the given targets and user. Will spend one charge of the spell |
| valid_target | Allows for spell specific target validation. Will be used by the spell_targeting datums |
| write_custom_logs | Will write additional logs if create_custom_logs is TRUE and the caster has a ckey. Override this |
recharge time in deciseconds
handles a given spells cooldowns. tracks the time until its off cooldown,
does this spell generate attack logs?
If this spell creates custom logs using the write_custom_logs() proc. Will ignore create_attack_logs
Which spell_handler is used in addition to the normal spells behaviour, can be null. Set this in create_new_handler if needed
Whether or not the spell functions in a holy place
The message displayed when a click based spell gets activated
The message displayed when a click based spell gets deactivated
Determines if the spell has smoke, and if so what effect the smoke has. See spell defines.
List with the handler datums per spell type. Key = src.type, value = the handler datum created by create_new_handler()
Which targeting system is used. Set this in create_new_targeting
List with the targeting datums per spell type. Key = src.type, value = the targeting datum created by create_new_targeting()
The proc where the actual spell gets cast.
+Arguments:
+Will try to choose targets using the targeting variable and perform the spell if it can +Do not override this! Override create_new_targeting instead
+Arguments:
+Creates and returns the spells cooldown handler, defaults to the standard recharge handler. +Override this if you wish to use a different method of cooldown
Creates and returns the handler datum for this spell type. +Override this if you want a custom spell handler. +Should return a value of type /datum/spell_handler or NONE
Creates and returns the targeting datum for this spell type. Override this! +Should return a value of type /datum/spell_targeting
This proc is ran when a mind is transfered to a new mob. Tells it if the action should be transfered on return true, and tells it not to remove it on false
Lets the spell have a special effect applied to it when upgraded. By default, does nothing.
Handles all the code for performing a spell once the targets are known
+Arguments:
+Called in try_perform before removing the click interceptor. useful to override if you have a spell that requires more than 1 click
Will spend the cost of using this spell once. Will update the action button's icon if there is any
+Arguments:
+Will try and perform the spell using the given targets and user. Will spend one charge of the spell
+Arguments:
+Allows for spell specific target validation. Will be used by the spell_targeting datums
+Arguments:
+Will write additional logs if create_custom_logs is TRUE and the caster has a ckey. Override this
+Arguments:
+Vars | |
| roll_over_cooldown | How long does it take for the ability to cool down, on top of [roll_over_time]? |
|---|---|
| roll_over_time | How long does it take us to roll? |
How long does it take for the ability to cool down, on top of [roll_over_time]?
How long does it take us to roll?
Vars | |
| create_custom_logs | Every alien spell creates only logs, no attack messages on someone placing weeds, but you DO get attack messages on neurotoxin and corrosive acid |
|---|---|
| plasma_cost | How much plasma it costs to use this |
Procs | |
| New | Every single alien spell uses a "spell name + plasmacost" format |
Every alien spell creates only logs, no attack messages on someone placing weeds, but you DO get attack messages on neurotoxin and corrosive acid
How much plasma it costs to use this
Every single alien spell uses a "spell name + plasmacost" format
Vars | |
| aoe_range | How far does it effect |
|---|---|
How far does it effect
Vars | |
| cast_amount | How much essence it costs to use |
|---|---|
| locked | If it's locked and needs to be unlocked before use |
| reveal | How long it reveals the revenant in deciseconds |
| stun | How long it stuns the revenant in deciseconds |
| unlock_amount | How much essence it costs to unlock |
How much essence it costs to use
If it's locked and needs to be unlocked before use
How long it reveals the revenant in deciseconds
How long it stuns the revenant in deciseconds
How much essence it costs to unlock
Makes objects be haunted and then throws them at conscious people to do damage, spooky!
Vars | |
| attack_timers | A list of all attack timers started by this spell being cast |
|---|---|
| max_targets | The maximum number of objects to haunt |
Procs | |
| attack | Handles finding a valid target and throwing us at it |
| make_spooky | Handles making an object haunted and setting it up to attack |
| set_outline | Sets the glow on the haunted object, scales up based on throwforce |
| stop_timers | Stop all attack timers cast by the previous spell use |
A list of all attack timers started by this spell being cast
The maximum number of objects to haunt
Handles finding a valid target and throwing us at it
Handles making an object haunted and setting it up to attack
Sets the glow on the haunted object, scales up based on throwforce
Stop all attack timers cast by the previous spell use
A click-based spell template which starts charging up once you click the action button/verb. Click again on something to activate the actual spell
Vars | |
| charge_sound | The sound charging up your power will make. Be sure to include a channel when creating the sound |
|---|---|
| charge_up_overlay | The overlay used to show that you are charging. Create this in the New of the spell |
| max_charge_time | How long you can charge for |
| start_charging_text | The text shown when you start charging |
| stop_charging_fail_text | The text shown when you are over the charge limit and thus can't stop. |
| stop_charging_text | The text shown when you successfully stop charging |
The sound charging up your power will make. Be sure to include a channel when creating the sound
The overlay used to show that you are charging. Create this in the New of the spell
How long you can charge for
The text shown when you start charging
The text shown when you are over the charge limit and thus can't stop.
The text shown when you successfully stop charging
A spell template that adds bounces to the charge_up spell template. The spell will bounce between targets once released. +Don't override cast and instead override apply_bounce_effect and the other procs
Procs | |
| apply_bounce_effect | The proc called when a bounce hits a target. Override this to add an effect +The user itself is never hit |
|---|---|
| create_beam | Called when a bounce travels from one mob to another |
| get_bounce_amount | How much bounces should there be in total? |
| get_bounce_energy | How much energy should each bounce have? |
The proc called when a bounce hits a target. Override this to add an effect +The user itself is never hit
+Arguments:
+Called when a bounce travels from one mob to another
+Arguments:
+How much bounces should there be in total?
How much energy should each bounce have?
Vars | |
| recent_hacking | How many times have we successfully hacked in the last minute? Increases burn damage by 3 for each value above 0. |
|---|---|
How many times have we successfully hacked in the last minute? Increases burn damage by 3 for each value above 0.
Vars | |
| available_forms | Which forms the user can become |
|---|---|
| max_forms | How many forms the user can remember |
| next_override_index | Which index will be overriden next when the user wants to remember another form |
| perfect_disguise | If a message is shown when somebody examines the user from close range |
| selected_form | Which form is currently selected |
Which forms the user can become
How many forms the user can remember
Which index will be overriden next when the user wants to remember another form
If a message is shown when somebody examines the user from close range
Which form is currently selected
Vars | |
| hunger_cost | How much food it costs the morph to use this |
|---|---|
How much food it costs the morph to use this
Vars | |
| proj_type | The projectile we spawn. Make sure to override this |
|---|---|
The projectile we spawn. Make sure to override this
Vars | |
| duration | The duration of the scramble |
|---|---|
| effects | A lazylist of all scramble effects this spell has created. |
| ready | Whether we're ready to cast again yet or not. In the event someone lowers their cooldown with charge. |
| scramble_radius | The radius of the scramble around the caster. Increased by 3 * spell_level |
Procs | |
| clean_turfs | Callback which cleans up our effects list after the duration expires. |
The duration of the scramble
A lazylist of all scramble effects this spell has created.
Whether we're ready to cast again yet or not. In the event someone lowers their cooldown with charge.
The radius of the scramble around the caster. Increased by 3 * spell_level
Callback which cleans up our effects list after the duration expires.
Vars | |
| blacklisted_summons | List of objects which will result in the spell stopping with the recursion search |
|---|---|
List of objects which will result in the spell stopping with the recursion search
Vars | |
| base_cooldown | Extremely fast cooldown, only present so the cooldown system doesn't explode |
|---|---|
| create_custom_logs | Every alien spell creates only logs, no attack messages on someone placing weeds, but you DO get attack messages on neurotoxin and corrosive acid |
| on_remove_message | We want a special on remove message, so we got this variable to do so |
| plasma_cost | How much plasma it costs to use this |
Extremely fast cooldown, only present so the cooldown system doesn't explode
Every alien spell creates only logs, no attack messages on someone placing weeds, but you DO get attack messages on neurotoxin and corrosive acid
We want a special on remove message, so we got this variable to do so
How much plasma it costs to use this
Vars | |
| include_light_turfs | Whether the spell can teleport to light locations |
|---|---|
Whether the spell can teleport to light locations
Vars | |
| required_blood | How much blood this ability costs to use |
|---|---|
How much blood this ability costs to use
Vars | |
| all_temp_walls | Holds a reference to all arena walls so we can qdel them easily with dispel() |
|---|---|
| timer | Holds a reference to the timer until either the spell runs out or we recast it |
Holds a reference to all arena walls so we can qdel them easily with dispel()
Holds a reference to the timer until either the spell runs out or we recast it
Vars | |
| making_anchor | Are we making an anchor? |
|---|---|
| timer | Holds a reference to the timer until the caster fake recalls |
Are we making an anchor?
Holds a reference to the timer until the caster fake recalls
Vars | |
| recharge_duration | the amount of time that must pass before a spell can be used again |
|---|---|
| recharge_time | the world.time the spell will be available again |
| spell_parent | holds a ref to the spell |
| starts_off_cooldown | does it start off cooldown? |
the amount of time that must pass before a spell can be used again
the world.time the spell will be available again
holds a ref to the spell
does it start off cooldown?
Vars | |
| charge_duration | the cooldown between uses of charges |
|---|---|
| charge_time | the time at which a spell charge can be used |
| current_charges | the number of charges we currently have |
| max_charges | the max number of charges a spell can have |
the cooldown between uses of charges
the time at which a spell charge can be used
the number of charges we currently have
the max number of charges a spell can have
Vars | |
| plasma_cost | Amount of plasma required to use this ability |
|---|---|
Amount of plasma required to use this ability
Vars | |
| hunger_cost | How much food it costs the morph to use this |
|---|---|
How much food it costs the morph to use this
Vars | |
| deduct_blood_on_cast | If the blood cost should be handled by this handler. Or if the spell will handle it itself |
|---|---|
If the blood cost should be handled by this handler. Or if the spell will handle it itself
The base class for the targeting systems spells use.
+To create a new targeting datum you just inherit from this base type and override the /datum/spell_targeting/proc/choose_targets proc. +Override the /datum/spell_targeting/proc/valid_target proc for more complex validations. +More complex behaviour like auto targeting and click based activation is possible.
Vars | |
| allowed_type | Which type the targets have to be |
|---|---|
| include_user | If it includes user. Not always used in all spell_targeting objects |
| max_targets | How many targets are allowed. INFINITY is used to target unlimited targets |
| range | The range of the spell; outer radius for aoe spells |
| selection_type | Can be SPELL_SELECTION_RANGE or SPELL_SELECTION_VIEW |
| try_auto_target | Whether or not the spell will try to auto target first before setting up the intercept click |
| use_intercept_click | Whether or not the targeting is done by intercepting a click or not |
| use_obstacle_check | If the spell should do an obstacle check from the user to the target. Windows, for example, will block the spell if this is true. |
| use_turf_of_user | Whether or not the spell should use the turf of the user as starting point |
Procs | |
| InterceptClickOn | Called when the parent spell intercepts the click |
| attempt_auto_target | Will attempt to auto target the spell. Only works with 1 target currently |
| choose_targets | Called when choosing the targets for the parent spell |
| obstacle_check | Checks if the path from the source to the target is free. +Mobs won't block the path. But any dense object (other than tables) will. |
| valid_target | Checks whether or not the given target is valid. Calls spell.valid_target as well |
Which type the targets have to be
If it includes user. Not always used in all spell_targeting objects
How many targets are allowed. INFINITY is used to target unlimited targets
The range of the spell; outer radius for aoe spells
Can be SPELL_SELECTION_RANGE or SPELL_SELECTION_VIEW
Whether or not the spell will try to auto target first before setting up the intercept click
Whether or not the targeting is done by intercepting a click or not
If the spell should do an obstacle check from the user to the target. Windows, for example, will block the spell if this is true.
Whether or not the spell should use the turf of the user as starting point
Called when the parent spell intercepts the click
+Arguments:
+Will attempt to auto target the spell. Only works with 1 target currently
Called when choosing the targets for the parent spell
+Arguments:
+Checks if the path from the source to the target is free. +Mobs won't block the path. But any dense object (other than tables) will.
+Arguments:
+Checks whether or not the given target is valid. Calls spell.valid_target as well
+Arguments:
+An area of effect based spell targeting system. Will return all targets in the given range
Vars | |
| inner_radius | The radius of turfs not being affected. -1 is inactive |
|---|---|
The radius of turfs not being affected. -1 is inactive
A click based spell targeting system. The clicked atom will be used to determine who/what to target
Vars | |
| click_radius | How big the radius around the clicked atom is to find clicked_atom suitable target. -1 is only the selected atom is considered |
|---|---|
How big the radius around the clicked atom is to find clicked_atom suitable target. -1 is only the selected atom is considered
Gets a list of turfs around the center atom to scramble.
+Returns an assoc list of turf to turf. These pairs are what turfs are +swapped between one another when the cast is done.
A spell targeting system which is able to select 1 to many targets in range/view of the caster. Has a random mode, distance from user based mode or a user input mode.
Vars | |
| can_hit_target_more_than_once | Only important if max_targets > 1, affects if the spell can be cast multiple times at one person from one cast |
|---|---|
| random_target | Chooses random viable target instead of asking the caster |
| target_priority | Who to target when too many targets are found. Only matters when max_targets = 1 |
Only important if max_targets > 1, affects if the spell can be cast multiple times at one person from one cast
Chooses random viable target instead of asking the caster
Who to target when too many targets are found. Only matters when max_targets = 1
END VG HAIRSTYLES//
+START POLARIS HAIRSTYLES
//END POLARIS HAIRSTYLES///
+Ume hairstyles
Vars | |
| cult_structure | Resulting atom is a cult structure |
|---|---|
| max_res_amount | Maximum amount of atoms made |
| on_floor | Requires a floor underneath to make |
| on_floor_or_lattice | Requires a floor OR lattice underneath to make |
| one_per_turf | Only one resulting atom is allowed per turf |
| req_amount | Required stack amount to make |
| res_amount | Amount of atoms made |
| result_type | Resulting typepath of crafted atom |
| time | Time to make |
| title | Visible title of recipe |
| window_checks | Requires a valid window location to make |
Procs | |
| do_build | Creates the atom defined by the recipe. Should always return the object it creates or FALSE. This proc assumes that the construction is already possible; for checking whether a recipe can be built before construction, use try_build() |
| post_build | What should be done after the object is built? obj/item/stack/O might not actually be a stack, but this proc needs access to merge() to work, which is on obj/item/stack, so declare it as obj/item/stack anyways. |
| try_build | Returns TRUE if the recipe can be built, otherwise returns FALSE. This proc is only meant as a series of tests to check if construction is possible; the actual creation of the resulting atom should be handled in do_build() |
Resulting atom is a cult structure
Maximum amount of atoms made
Requires a floor underneath to make
Requires a floor OR lattice underneath to make
Only one resulting atom is allowed per turf
Required stack amount to make
Amount of atoms made
Resulting typepath of crafted atom
Time to make
Visible title of recipe
Requires a valid window location to make
Creates the atom defined by the recipe. Should always return the object it creates or FALSE. This proc assumes that the construction is already possible; for checking whether a recipe can be built before construction, use try_build()
What should be done after the object is built? obj/item/stack/O might not actually be a stack, but this proc needs access to merge() to work, which is on obj/item/stack, so declare it as obj/item/stack anyways.
Returns TRUE if the recipe can be built, otherwise returns FALSE. This proc is only meant as a series of tests to check if construction is possible; the actual creation of the resulting atom should be handled in do_build()
Vars | |
| account_access | The access need to get into this department account, this is a one req access list, used especialy for supply computer |
|---|---|
| account_base_pay | The amount this department will be payed every payday at a minimum (unless deducted otherwise) |
| account_starting_balance | The amount this departments will get endowed with a roundstart in their money account |
| auto_approval_cap | If there is auto approval, is it capped? |
| crate_auto_approve | Will this department's account auto approve crates? |
| department_account | The money account tied to this department |
| department_name | name of department, used to determine department money account names as well |
| department_roles | A list of occupation names in this department |
| head_of_staff | The occupation name of the person in charge of this department officially |
Procs | |
| has_account_access | checks to see if the crew members has the right access or is whitelisted on the department account |
The access need to get into this department account, this is a one req access list, used especialy for supply computer
The amount this department will be payed every payday at a minimum (unless deducted otherwise)
The amount this departments will get endowed with a roundstart in their money account
If there is auto approval, is it capped?
Will this department's account auto approve crates?
The money account tied to this department
name of department, used to determine department money account names as well
A list of occupation names in this department
The occupation name of the person in charge of this department officially
checks to see if the crew members has the right access or is whitelisted on the department account
Vars | |
| abstract | Abstract goals can't be used directly. |
|---|---|
| admin_desc | Admin-only shor description of the goal. |
| department | Assigned department. Should match the values used for requests consoles. |
| personal_account | The money account of the person who requested the goal. |
| progress | Progress type of this goal. |
| progress_type | Type path of the progress tracker used. |
| requester_name | The person who requested the goal. |
| should_send_crate | Should we (still) send a personal crate on the next shipment? |
| tracker | Tracker that manages the goal progress, permanent and temporary. |
Abstract goals can't be used directly.
Admin-only shor description of the goal.
Assigned department. Should match the values used for requests consoles.
The money account of the person who requested the goal.
Progress type of this goal.
Type path of the progress tracker used.
The person who requested the goal.
Should we (still) send a personal crate on the next shipment?
Tracker that manages the goal progress, permanent and temporary.
Vars | |
| amount_per | How many of each food type are needed. |
|---|---|
| different_types | How many different types of food are needed. |
How many of each food type are needed.
How many different types of food are needed.
Vars | |
| door | Amount of airlocks |
|---|---|
| floor | Amount of floors |
| grille | Amount of grilles (without windows) |
| mach | Amount of machines |
| r_wall | Amount of reinforced walles |
| wall | Amount of regular walls |
| window | Amount of full windows |
Amount of airlocks
Amount of floors
Amount of grilles (without windows)
Amount of machines
Amount of reinforced walles
Amount of regular walls
Amount of full windows
Base class of station traits. These are used to influence rounds in one way or the other by influencing the levers of the station.
Vars | |
| blacklist | What traits are incompatible with this one? |
|---|---|
| can_revert | Whether or not this trait can be reverted by an admin |
| dynamic_threat_id | The ID that we look for in dynamic.json. Not synced with 'name' because I can already see this go wrong |
| force | Whether this trait is always enabled; generally used for debugging |
| name | Name of the trait |
| report_message | What message to show in the centcom report? |
| show_in_report | Does this trait show in the centcom report? |
| trait_flags | Extra flags for station traits such as it being abstract, planetary or space only |
| trait_processes | Whether or not this trait uses process() |
| trait_to_give | What code-trait does this station trait give? gives none if null |
| trait_type | The type of this trait. Used to classify how this trait influences the station |
| weight | Chance relative to other traits of its type to be picked |
Procs | |
| get_report | type of info the centcom report has on this trait, if any. |
| on_round_start | Proc ran when round starts. Use this for roundstart effects. |
| revert | Will attempt to revert the station trait, used by admins. |
What traits are incompatible with this one?
Whether or not this trait can be reverted by an admin
The ID that we look for in dynamic.json. Not synced with 'name' because I can already see this go wrong
Whether this trait is always enabled; generally used for debugging
Name of the trait
What message to show in the centcom report?
Does this trait show in the centcom report?
Extra flags for station traits such as it being abstract, planetary or space only
Whether or not this trait uses process()
What code-trait does this station trait give? gives none if null
The type of this trait. Used to classify how this trait influences the station
Chance relative to other traits of its type to be picked
type of info the centcom report has on this trait, if any.
Proc ran when round starts. Use this for roundstart effects.
Will attempt to revert the station trait, used by admins.
NOTE: THIS MAKES EMP MUCH MORE EXPENSIVE.
Vars | |
| job_to_cybernetic | List of all job types with the cybernetics they should receive. |
|---|---|
List of all job types with the cybernetics they should receive.
Vars | |
| disable_is_one_shot | Do we want to turn off is one shot? |
|---|---|
| event_names | The names of the event we modify. |
| event_severity | The severity of the event we modify. |
| weight_multiplier | Multiplier applied to the weight of the event. may want to apply to scaling as well |
Do we want to turn off is one shot?
The names of the event we modify.
The severity of the event we modify.
Multiplier applied to the weight of the event. may want to apply to scaling as well
Procs | |
| before_remove | Called before being removed; returning FALSE will cancel removal |
|---|---|
Called before being removed; returning FALSE will cancel removal
Vars | |
| chariot | If this is the chariot subtype, which grants pacifism while the effect is active. |
|---|---|
If this is the chariot subtype, which grants pacifism while the effect is active.
Vars | |
| coward_checking | Are we starting the process to check if the person has still gotten out of range of bubble / crossed zlvls. |
|---|---|
| damage | The damage the status effect does per tick. |
Are we starting the process to check if the person has still gotten out of range of bubble / crossed zlvls.
The damage the status effect does per tick.
Status effect that gives the target miscellanous debuffs while throwing a status alert and causing them to smoke from the damage they're incurring. +Purposebuilt for cursed slot machines.
Vars | |
| branded_hand | The hand we are branded to. |
|---|---|
| curse_count | The amount of times we have been "applied" to the target. |
| damage_chance | Raw probability we have to deal damage this tick. |
| max_curse_count | The max number of curses a target can incur with this status effect. |
| monologuing | Are we currently in the process of sending a monologue? |
Procs | |
| check_curses | Checks the number of curses we have and returns information back to the slot machine. max_curse_amount is set by the slot machine itself. |
| clear_curses | Cleans ourselves up and removes our curses. Meant to be done in a "positive" way, when the curse is broken. Directly use qdel otherwise. |
| handle_after_effects | Makes a nice lorey message about the curse level we're at. I think it's nice |
| on_death | If our owner dies without getting gibbed, we gib them, because fuck you baltamore |
| on_stat_changed | If our owner's stat changes, rapidly surge the damage chance. |
| update_curse_count | Handles the debuffs of this status effect and incrementing the number of curses we have. |
The hand we are branded to.
The amount of times we have been "applied" to the target.
Raw probability we have to deal damage this tick.
The max number of curses a target can incur with this status effect.
Are we currently in the process of sending a monologue?
Checks the number of curses we have and returns information back to the slot machine. max_curse_amount is set by the slot machine itself.
Cleans ourselves up and removes our curses. Meant to be done in a "positive" way, when the curse is broken. Directly use qdel otherwise.
Makes a nice lorey message about the curse level we're at. I think it's nice
If our owner dies without getting gibbed, we gib them, because fuck you baltamore
If our owner's stat changes, rapidly surge the damage chance.
Handles the debuffs of this status effect and incrementing the number of curses we have.
Vars | |
| current_fake_disease | Which disease we are going to fake? |
|---|---|
| fake_emote | Fake virus emotes with three stages |
| fake_msg | Fake virus messages by with three stages |
| msg_stage | So you dont get the most intense messages immediately |
Which disease we are going to fake?
Fake virus emotes with three stages
Fake virus messages by with three stages
So you dont get the most intense messages immediately
Vars | |
| active_instances | a list of integers, one for each remaining instance of fleshmend. |
|---|---|
| freezing | This diminishes the healing of fleshmend if the user is cold when it is activated |
| tolerance | This diminishes the healing of fleshmend the higher it is. |
a list of integers, one for each remaining instance of fleshmend.
This diminishes the healing of fleshmend if the user is cold when it is activated
This diminishes the healing of fleshmend the higher it is.
Vars | |
| critical_success | Message displayed when wizards perform this together |
|---|---|
| item_path | Item to be shown in the pop-up balloon. |
| request | Message displayed when this status effect is applied. |
| sound_effect | Sound effect played when this emote is completed. |
| success | Message displayed when normal people perform this together |
Procs | |
| wiz_cleanup | So we don't leave folks with god-mode |
Message displayed when wizards perform this together
Item to be shown in the pop-up balloon.
Message displayed when this status effect is applied.
Sound effect played when this emote is completed.
Message displayed when normal people perform this together
So we don't leave folks with god-mode
Vars | |
| move | The move that you'll be making. |
|---|---|
The move that you'll be making.
Vars | |
| heal_points | How many points the rod has to heal with, maxes at 50, or whatever heal_points_max is set to. |
|---|---|
| max_heal_points | Max heal points for the rod to spend on healing people |
How many points the rod has to heal with, maxes at 50, or whatever heal_points_max is set to.
Max heal points for the rod to spend on healing people
Vars | |
| toolbox | Attached His Grace toolbox |
|---|---|
Attached His Grace toolbox
Vars | |
| voluntary | Whether we decided to take a nap on our own. +As opposed to being hard knocked out with N2O or similar. |
|---|---|
Whether we decided to take a nap on our own. +As opposed to being hard knocked out with N2O or similar.
A status effect that can have a certain amount of "bonus" duration added, which extends the duration every tick, +although there is a maximum amount of bonus time that can be active at any given time.
Vars | |
| bonus_time | How much extra time has been added |
|---|---|
| bonus_time_per_tick | How much extra time to apply per tick |
| max_bonus_time | How much maximum bonus time can be active at once |
How much extra time has been added
How much extra time to apply per tick
How much maximum bonus time can be active at once
Vars | |
| locks | The number of people the gun has locked on to. Caps at 10 for sanity. |
|---|---|
The number of people the gun has locked on to. Caps at 10 for sanity.
Vars | |
| devil | If this is true, the status effect will try to apply the debuff to others, rather than the user |
|---|---|
If this is true, the status effect will try to apply the debuff to others, rather than the user
Vars | |
| cling | A reference to the changeling's changeling antag datum. |
|---|---|
A reference to the changeling's changeling antag datum.
A status effect that works off a (possibly decimal) counter before expiring, rather than a specified world.time. +This allows for a more precise tweaking of status durations at runtime (e.g. paralysis).
Vars | |
| strength | How much strength left before expiring? time in deciseconds. |
|---|---|
Procs | |
| calc_decay | Returns how much strength should be adjusted per tick. |
How much strength left before expiring? time in deciseconds.
Returns how much strength should be adjusted per tick.
Procs | |
| hallucinate | Spawns an hallucination for the mob. |
|---|---|
Spawns an hallucination for the mob.
+Arguments:
+A representation of the stripping UI
Vars | |
| base64_cache | Associated list of "[icon][icon_state]" = base64 representation of icon. Used for PERFORMANCE. |
|---|---|
| interactions | A lazy list of user mobs to a list of strip menu keys that they're interacting with |
| owner | The owner who has the element /datum/element/strippable |
| strippable | The strippable element itself |
Associated list of "[icon][icon_state]" = base64 representation of icon. Used for PERFORMANCE.
A lazy list of user mobs to a list of strip menu keys that they're interacting with
The owner who has the element /datum/element/strippable
The strippable element itself
A representation of an item that can be stripped down
Vars | |
| key | The STRIPPABLE_ITEM_* key |
|---|---|
Procs | |
| alternate_action | Performs an alternative action on this strippable_item.
+has_alternate_action needs to be TRUE.
+Returns FALSE if blocked by signal, TRUE otherwise. |
| finish_equip | The proc that places the item on the source. This should not yield. |
| finish_unequip | The proc that unequips the item from the source. This should not yield. |
| get_alternate_actions | Returns the ID of this item's strippable action.
+Return null if there is no alternate action.
+Any return value of this must be in StripMenu. |
| get_body_action | Actions that can happen to that body part, regardless if there is an item or not. As long as it is not obscured |
| get_item | Gets the item from the given source. |
| get_obscuring | Returns a STRIPPABLE_OBSCURING_* define to report on whether or not this is obscured. |
| in_thief_mode | Returns whether the user is in "thief mode" where stripping/equipping is silent and stealing from pockets moves stuff to your hands |
| should_show | Returns whether or not this item should show. |
| start_equip | Start the equipping process. This is the proc you should yield in. +Returns TRUE/FALSE depending on if it is allowed. |
| start_unequip | Start the unequipping process. This is the proc you should yield in. +Returns TRUE/FALSE depending on if it is allowed. |
| try_equip | Tries to equip the item onto the given source. +Returns TRUE/FALSE depending on if it is allowed. +This should be used for checking if an item CAN be equipped. +It should not perform the equipping itself. |
| try_unequip | Tries to unequip the item from the given source. +Returns TRUE/FALSE depending on if it is allowed. +This should be used for checking if it CAN be unequipped. +It should not perform the unequipping itself. |
The STRIPPABLE_ITEM_* key
Performs an alternative action on this strippable_item.
+has_alternate_action needs to be TRUE.
+Returns FALSE if blocked by signal, TRUE otherwise.
The proc that places the item on the source. This should not yield.
The proc that unequips the item from the source. This should not yield.
Returns the ID of this item's strippable action.
+Return null if there is no alternate action.
+Any return value of this must be in StripMenu.
Actions that can happen to that body part, regardless if there is an item or not. As long as it is not obscured
Gets the item from the given source.
Returns a STRIPPABLE_OBSCURING_* define to report on whether or not this is obscured.
Returns whether the user is in "thief mode" where stripping/equipping is silent and stealing from pockets moves stuff to your hands
Returns whether or not this item should show.
Start the equipping process. This is the proc you should yield in. +Returns TRUE/FALSE depending on if it is allowed.
Start the unequipping process. This is the proc you should yield in. +Returns TRUE/FALSE depending on if it is allowed.
Tries to equip the item onto the given source. +Returns TRUE/FALSE depending on if it is allowed. +This should be used for checking if an item CAN be equipped. +It should not perform the equipping itself.
Tries to unequip the item from the given source. +Returns TRUE/FALSE depending on if it is allowed. +This should be used for checking if it CAN be unequipped. +It should not perform the unequipping itself.
A strippable item for a hand
Vars | |
| which_hand | Which hand? |
|---|---|
Which hand?
A preset for equipping items onto mob slots
Vars | |
| item_slot | The SLOT_FLAG_* to equip to. |
|---|---|
Procs | |
| get_equip_delay | Returns the delay of equipping this item to a mob |
The SLOT_FLAG_* to equip to.
Returns the delay of equipping this item to a mob
Vars | |
| pocket_side | Which pocket we're referencing. Used for visible text. |
|---|---|
Which pocket we're referencing. Used for visible text.
Vars | |
| threat_level | Probability of the event not running, higher tiers being rarer |
|---|---|
Probability of the event not running, higher tiers being rarer
Vars | |
| comment | Reason/purpose for order given by orderer |
|---|---|
| object | The supply pack this order is for |
| ordered_by_department | The station department datum of the person's department who ordered the supply order |
| orderedby | The person who ordered the supply order |
| orderedbyRank | The occupation/assignment of the person who ordered the supply order |
| orderedbyaccount | The account tied to this order, important for personal orders |
| ordernum | The orders ID number |
| requires_cargo_approval | does this order need to be approve by carg? |
| requires_head_approval | does this order need to be approve by the department head? |
Reason/purpose for order given by orderer
The supply pack this order is for
The station department datum of the person's department who ordered the supply order
The person who ordered the supply order
The occupation/assignment of the person who ordered the supply order
The account tied to this order, important for personal orders
The orders ID number
does this order need to be approve by carg?
does this order need to be approve by the department head?
Vars | |
| access | If the container is lockable, the access to require for it. |
|---|---|
| amount | The number of crates that get generated by this pack. |
| announce_beacons | Particular beacons that we'll notify the relevant department when we reach |
| are_you_sure_you_want_to_be_banned | If this variable is filled, this grants the user a special TGUI confirmation prompt about ordering this shuttle, before they can place the order. Similar to bag of holding. |
| cmag_hidden | If TRUE, this pack is only visible on a cmagged supply console. |
| containername | The name to give the container itself. |
| containertype | The type of container that the contents will arrive in. |
| contains | OBJ: What is inside the crate |
| contains_special | STRING: What is inside the crate |
| contraband | If TRUE, this pack is only visible on a hacked supply console. |
| cost | The cost of this pack. |
| department_restrictions | Determines which departments do not need QM approval to order this supply pack |
| group | The pack group this should appear in. |
| hidden | If TRUE, this pack is only visible on an emagged supply console. |
| manifest | The manifest contents for this order. |
| name | The name of this supply pack. |
| order_type | Path of the type of order that should be generated from this order |
| singleton | If true, this pack can only be ordered in units of 1. |
| singleton_group_id | Identifier indicating the specific "set" of singletons that this belongs to. +Only one item in this set can be in the shopping cart at once. |
| special | A special pack that should not appear unless certain circumstances are fulfilled (event, station goals, admin packs) |
| special_enabled | If this pack is special, whether it should be visible or not. |
| ui_manifest | List of names for being done in TGUI |
Procs | |
| can_order | Define a special condition as to whether or not this crate can currently be ordered. |
| create_order | Create a supply order for this pack. |
| on_order_confirm | Called right when an order for this pack is confirmed. |
If the container is lockable, the access to require for it.
The number of crates that get generated by this pack.
Particular beacons that we'll notify the relevant department when we reach
If this variable is filled, this grants the user a special TGUI confirmation prompt about ordering this shuttle, before they can place the order. Similar to bag of holding.
If TRUE, this pack is only visible on a cmagged supply console.
The name to give the container itself.
The type of container that the contents will arrive in.
OBJ: What is inside the crate
STRING: What is inside the crate
If TRUE, this pack is only visible on a hacked supply console.
The cost of this pack.
Determines which departments do not need QM approval to order this supply pack
The pack group this should appear in.
If TRUE, this pack is only visible on an emagged supply console.
The manifest contents for this order.
The name of this supply pack.
Path of the type of order that should be generated from this order
If true, this pack can only be ordered in units of 1.
Identifier indicating the specific "set" of singletons that this belongs to. +Only one item in this set can be in the shopping cart at once.
A special pack that should not appear unless certain circumstances are fulfilled (event, station goals, admin packs)
If this pack is special, whether it should be visible or not.
List of names for being done in TGUI
Define a special condition as to whether or not this crate can currently be ordered.
Create a supply order for this pack.
Called right when an order for this pack is confirmed.
A "supply pack" that allows for purchasing a custom shuttle.
Vars | |
| speed_factor | The base speed multiplier to apply to the shuttle. 2 means it arrives twice as fast. |
|---|---|
| template | The shuttle that this pack corresponds to ordering. +If given on init, will fill out the pack automagically. |
The base speed multiplier to apply to the shuttle. 2 means it arrives twice as fast.
The shuttle that this pack corresponds to ordering. +If given on init, will fill out the pack automagically.
Datum Surgery Helpers
Vars | |
| abstract | Whether or not this should be a selectable surgery at all |
|---|---|
| can_cancel | Whether this surgery can be stopped after the first step with a cautery |
| cancel_on_organ_change | Whether this surgery should be cancelled when an organ change happens. (removed if requires bodypart, or added if doesn't require bodypart) |
| desc | Description of the surgery |
| ignore_clothes | Whether you need to remove clothes to perform the surgery |
| location | Location of the surgery |
| lying_required | Does the victim (patient) need to be lying down? |
| name | Name of the surgery |
| organ_to_manipulate | Body part the surgery is currently being performed on. Useful for checking to see if the organ desired is still in the body after the surgery has begun. |
| possible_locs | Body locations this surgery can be performed on |
| replaced_by | Don't show this surgery if this type exists. Set to /datum/surgery if you want to hide a "base" surgery. |
| requires_bodypart | Surgery is only available if the target bodypart is present (or if it's missing) |
| requires_organic_bodypart | Whether we can perform the surgery on a robotic limb |
| requires_real_bodypart | Some surgeries might work on limbs that don't really exist (like chainsaw arms or flashlight eyes) |
| self_operable | Can the surgery be performed on yourself? |
| speed_modifier | Surgery step speed modifier |
| step_in_progress | If we're currently performing a step |
| step_number | How far along we are in a surgery being performed. |
| steps | Surgical steps that go into performing this procedure |
| target | Target of the surgery |
| target_mobtypes | Mobs on which this can be performed |
Procs | |
| can_start | Whether or not we can start this surgery. +If this returns FALSE, this surgery won't show up in the list. |
| get_surgery_next_step | Get the next step in the current surgery, or null if we're on the last one. |
| get_surgery_step | Get the current surgery step we're on |
| handle_organ_state_change | Handle an organ's insertion or removal mid-surgery. +If cancel_on_organ_change is true, then this will cancel the surgery in certain cases. |
| is_organ_compatible | Get whether the target organ is compatible with the current surgery. |
| next_step | Try to perform the next step in the current operation. +This gets called in the attack chain, and as such returning FALSE in here means that the target +will be hit with whatever's in your hand. |
Whether or not this should be a selectable surgery at all
Whether this surgery can be stopped after the first step with a cautery
Whether this surgery should be cancelled when an organ change happens. (removed if requires bodypart, or added if doesn't require bodypart)
Description of the surgery
Whether you need to remove clothes to perform the surgery
Location of the surgery
Does the victim (patient) need to be lying down?
Name of the surgery
Body part the surgery is currently being performed on. Useful for checking to see if the organ desired is still in the body after the surgery has begun.
Body locations this surgery can be performed on
Don't show this surgery if this type exists. Set to /datum/surgery if you want to hide a "base" surgery.
Surgery is only available if the target bodypart is present (or if it's missing)
Whether we can perform the surgery on a robotic limb
Some surgeries might work on limbs that don't really exist (like chainsaw arms or flashlight eyes)
Can the surgery be performed on yourself?
Surgery step speed modifier
If we're currently performing a step
How far along we are in a surgery being performed.
Surgical steps that go into performing this procedure
Target of the surgery
Mobs on which this can be performed
Whether or not we can start this surgery. +If this returns FALSE, this surgery won't show up in the list.
Get the next step in the current surgery, or null if we're on the last one.
Get the current surgery step we're on
Handle an organ's insertion or removal mid-surgery. +If cancel_on_organ_change is true, then this will cancel the surgery in certain cases.
Get whether the target organ is compatible with the current surgery.
Try to perform the next step in the current operation. +This gets called in the attack chain, and as such returning FALSE in here means that the target +will be hit with whatever's in your hand.
+The return is passed to the attack chain, so return TRUE to stop any sort of afterattack.
Vars | |
| accept_any_item | Does the surgery step accept any item? If true, ignores implements. Compatible with accept_hand. |
|---|---|
| accept_hand | does the surgery step require an open hand? If true, ignores implements. Compatible with accept_any_item. |
| allowed_tools | Type path of tools that can be used to complete this step. Format is path = probability of success.
+If the tool has a specific surgery tooltype, you can use that as a key as well. |
| blood_level | How much blood this step can get on surgeon. See SURGERY_BLOODSPREAD_* defines |
| can_infect | Whether this surgery step can cause an infection. |
| chems_needed | List of chems needed in the mob to complete the step. Even on success, this step will have no effect if the required chems aren't in the mob. |
| implement_type | The current type of implement from allowed_tools in use. This has to be stored, as the typepath of the tool might not match the list type (such as if we're using tool behavior) |
| repeatable | Is this step repeatable by using the same tool again after it's finished? +Make sure it isn't the last step, or it's used in a cancellable surgery. Otherwise, you might get stuck in a loop! |
| require_all_chems | Do we require any of the needed chems, or all of them? |
| silicons_ignore_prob | Whether silicons ignore any probabilities (and are therefore "perfect" surgeons) |
| time | duration of the step |
| times_repeated | How many times this step has been automatically repeated. |
Procs | |
| can_repeat | Determines whether or not this surgery step can repeat if its end/fail steps returned SURGERY_STEP_RETRY. |
| chem_check | Check that the target contains the chems we expect them to. |
| deal_pain | Try to inflict pain during a surgery, a surgeon's dream come true. +This will wake up the user if they're voluntarily sleeping. |
| end_step | Finish a surgery step, performing anything that runs on the tail-end of a successful surgery. +This runs if the surgery step passes the probability check, and therefore is a success. |
| fail_step | Play out the failure state of a surgery step. +This runs if the surgery step fails the probability check, the right chems weren't present, or if the user deliberately failed the surgery. |
| get_step_information | Get the action that will be performed during this surgery step, in context of the surgery it is a part of. |
| initiate | Initiate and really perform the surgery itself. +This includes the main do-after and the checking of probabilities for successful surgeries. +If try_to_fail is TRUE, then this surgery will be deliberately failed out of. |
| is_valid_tool | Whether or not the tool being used is usable for the surgery. +Checks both the tool itself as well as any tool behaviors defined in allowed_tools. +Arguments: |
| slowdown_immune | Check for mobs that would be immune to surgery slowdowns/speedups. |
| tool_check | Get whether the tool should be usable in its current state. Useful for checks to see if a welder is on, for example. |
| try_op | Try to perform an operation on a user. +Arguments: |
Does the surgery step accept any item? If true, ignores implements. Compatible with accept_hand.
does the surgery step require an open hand? If true, ignores implements. Compatible with accept_any_item.
Type path of tools that can be used to complete this step. Format is path = probability of success.
+If the tool has a specific surgery tooltype, you can use that as a key as well.
How much blood this step can get on surgeon. See SURGERY_BLOODSPREAD_* defines
Whether this surgery step can cause an infection.
List of chems needed in the mob to complete the step. Even on success, this step will have no effect if the required chems aren't in the mob.
The current type of implement from allowed_tools in use. This has to be stored, as the typepath of the tool might not match the list type (such as if we're using tool behavior)
Is this step repeatable by using the same tool again after it's finished? +Make sure it isn't the last step, or it's used in a cancellable surgery. Otherwise, you might get stuck in a loop!
Do we require any of the needed chems, or all of them?
Whether silicons ignore any probabilities (and are therefore "perfect" surgeons)
duration of the step
How many times this step has been automatically repeated.
Determines whether or not this surgery step can repeat if its end/fail steps returned SURGERY_STEP_RETRY.
+Arguments:
+If this returns TRUE, the step will automatically retry. If not, the user will have to manually start the step again.
Check that the target contains the chems we expect them to.
Try to inflict pain during a surgery, a surgeon's dream come true. +This will wake up the user if they're voluntarily sleeping.
+Returns the success rate that the user's amount of pain would deal, while also handling extra pain behavior.
Finish a surgery step, performing anything that runs on the tail-end of a successful surgery. +This runs if the surgery step passes the probability check, and therefore is a success.
+Should return SURGERY_STEP_CONTINUE to advance the surgery, though may return SURGERY_STEP_INCOMPLETE to keep the surgery step from advancing.
Play out the failure state of a surgery step. +This runs if the surgery step fails the probability check, the right chems weren't present, or if the user deliberately failed the surgery.
+Should return SURGERY_STEP_INCOMPLETE to prevent the surgery step from advancing, though may return SURGERY_STEP_CONTINUE to advance to the next step regardless.
Get the action that will be performed during this surgery step, in context of the surgery it is a part of.
+Initiate and really perform the surgery itself. +This includes the main do-after and the checking of probabilities for successful surgeries. +If try_to_fail is TRUE, then this surgery will be deliberately failed out of.
+Returns TRUE if the surgery should proceed to the next step, or FALSE otherwise.
Whether or not the tool being used is usable for the surgery. +Checks both the tool itself as well as any tool behaviors defined in allowed_tools. +Arguments:
+Check for mobs that would be immune to surgery slowdowns/speedups.
Get whether the tool should be usable in its current state. Useful for checks to see if a welder is on, for example.
+Arguments:
+Try to perform an operation on a user. +Arguments:
+Procs | |
| get_organ_list | Get an internal list of organs for a zone (or an external organ). |
|---|---|
Get an internal list of organs for a zone (or an external organ).
+Helper function since we end up calling this a ton to work with carbons
Here's the special sauce: a surgery step that can pretend to be a few different surgery steps. +These proxy steps will, depending on the tool that's used, either continue to the next surgery step, or temporarily spin off a new surgery +by adding new steps to the current surgery.
Vars | |
| branches | Optional surgery TYPES that we can branch out to +Note that these must not share any starting tools. |
|---|---|
| branches_init | Initialized versions of types specified in branches. +Don't fill this yourself, instead fill branches with surgery TYPES. |
| insert_self_after | Whether or not we should add ourselves as a step after we run a branch. This doesn't apply to failures, those will always add ourselves after. |
| overriding_tools | These tools are just...special cases. +If we're using one of these tools and there's a tool conflict with the original surgery, +just ignore any branches and continue with the original surgery. |
Procs | |
| try_next_step | Test the next step, but don't fully commit to it unless it completes successfully. +If the next step doesn't fully complete (such as being interrupted or failing), we'll insert ourselves again to bring us back +to the "base" state. +If it does, we'll add the subsequent steps to the surgery and continue down the expected branch. If you complete the surgery step, it +means you've committed to what comes next. +Part of the motivation behind this is that I don't want to mutate a surgery retroactively. We can insert, but we shouldn't be changing anything +behind us. |
Optional surgery TYPES that we can branch out to +Note that these must not share any starting tools.
Initialized versions of types specified in branches. +Don't fill this yourself, instead fill branches with surgery TYPES.
Whether or not we should add ourselves as a step after we run a branch. This doesn't apply to failures, those will always add ourselves after.
These tools are just...special cases. +If we're using one of these tools and there's a tool conflict with the original surgery, +just ignore any branches and continue with the original surgery.
Test the next step, but don't fully commit to it unless it completes successfully. +If the next step doesn't fully complete (such as being interrupted or failing), we'll insert ourselves again to bring us back +to the "base" state. +If it does, we'll add the subsequent steps to the surgery and continue down the expected branch. If you complete the surgery step, it +means you've committed to what comes next. +Part of the motivation behind this is that I don't want to mutate a surgery retroactively. We can insert, but we shouldn't be changing anything +behind us.
+Arguments:
+Describes a contract that can be completed by a Contractor.
Vars | |
| chosen_difficulty | The selected difficulty. |
|---|---|
| completed_time | Formatted station time at which the contract was completed, if applicable. |
| contract | The /datum/objective/contract associated to this contract. |
| credits_base | The base credits reward upon completion. Multiplied by the two lower bounds below. |
| dead_extraction | Whether the contract was completed with the victim being dead on extraction. |
| extraction_cooldown | Cooldown before making another extraction request in deciseconds. |
| extraction_deadline | The world.time at which the current extraction fulton will vanish and another extraction can be requested. |
| extraction_flare | The flare indicating the extraction point. |
| extraction_portal | The extraction portal. |
| extraction_timer_handle | Deadline reached timer handle. Deletes the portal and tells the agent to call extraction again. |
| fail_reason | Visual reason as to why the contract failed, if applicable. |
| fluff_message | Fluff message explaining why the kidnapee is the target. |
| nt_am_board_resigned | Whether the additional fluff story from any contractor completing all of their contracts was made already or not. |
| owning_hub | The owning contractor hub. |
| portal_duration | How long an extraction portal remains before going away. Should be less than /datum/syndicate_contract/var/extraction_cooldown. |
| prison_time | How long a target remains in the Syndicate jail. |
| prisoner_timer_handle | Prisoner jail timer handle. On completion, returns the prisoner back to station. |
| reward_credits | Amount of credits the contractor will receive upon completion. |
| reward_tc | Amount of telecrystals the contract will receive upon completion, depending on the chosen difficulty. +Structure: EXTRACTION_DIFFICULTY_(EASY|MEDIUM|HARD) => number |
| status | Current contract status. |
| target_name | Name of the target to display on the UI. |
| target_photo | The target's photo to display on the UI. |
| temp_objs | Temporary objects that are available to the kidnapee during their time in jail. These are deleted when the victim is returned. |
| victim_belongings | The kidnapee's belongings. Set upon extraction by the contractor. |
Procs | |
| clean_up | Cleans up the contract. |
| complete | Marks the contract as completed and gives the rewards to the contractor. |
| deadline_reached | Called when the extraction window closes. |
| default_damage | Default damage if no injury is possible. |
| fail | Marks the contract as failed and stops it. |
| generate | Fills the contract with valid data to be used. |
| handle_target_experience | Handles the target's experience from extraction. |
| handle_target_return | Handles the target's return to station. |
| initiate | Begins the contract if possible. |
| injure_target | Handles the target's injury/interrogation at the Syndicate Jail. |
| invalidate | Marks the contract as invalid and effectively cancels it for later use. |
| notify_completion | Notifies the uplink's holder that a contract has been completed. |
| open_extraction_portal | Opens the extraction portal. |
| start_extraction_process | Initiates the extraction process if conditions are met. |
| target_received | Called when a contract target has been extracted through the portal. |
The selected difficulty.
Formatted station time at which the contract was completed, if applicable.
The /datum/objective/contract associated to this contract.
The base credits reward upon completion. Multiplied by the two lower bounds below.
Whether the contract was completed with the victim being dead on extraction.
Cooldown before making another extraction request in deciseconds.
The world.time at which the current extraction fulton will vanish and another extraction can be requested.
The flare indicating the extraction point.
The extraction portal.
Deadline reached timer handle. Deletes the portal and tells the agent to call extraction again.
Visual reason as to why the contract failed, if applicable.
Fluff message explaining why the kidnapee is the target.
Whether the additional fluff story from any contractor completing all of their contracts was made already or not.
The owning contractor hub.
How long an extraction portal remains before going away. Should be less than /datum/syndicate_contract/var/extraction_cooldown.
How long a target remains in the Syndicate jail.
Prisoner jail timer handle. On completion, returns the prisoner back to station.
Amount of credits the contractor will receive upon completion.
Amount of telecrystals the contract will receive upon completion, depending on the chosen difficulty. +Structure: EXTRACTION_DIFFICULTY_(EASY|MEDIUM|HARD) => number
Current contract status.
Name of the target to display on the UI.
The target's photo to display on the UI.
Temporary objects that are available to the kidnapee during their time in jail. These are deleted when the victim is returned.
The kidnapee's belongings. Set upon extraction by the contractor.
Cleans up the contract.
Marks the contract as completed and gives the rewards to the contractor.
+Arguments:
+Called when the extraction window closes.
Default damage if no injury is possible.
+Arguments:
+Marks the contract as failed and stops it.
+Arguments:
+Fills the contract with valid data to be used.
Handles the target's experience from extraction.
+Arguments:
+Handles the target's return to station.
+Arguments:
+Begins the contract if possible.
+Arguments:
+Handles the target's injury/interrogation at the Syndicate Jail.
+Arguments:
+Marks the contract as invalid and effectively cancels it for later use.
Notifies the uplink's holder that a contract has been completed.
+Arguments:
+Opens the extraction portal.
+Arguments:
+Initiates the extraction process if conditions are met.
+Arguments:
+Called when a contract target has been extracted through the portal.
+Arguments:
+Vars | |
| card_icon | What icon is used for the card? |
|---|---|
| desc | Desc used for the card description of the card |
| name | Name used for the card |
| reversed | Are we reversed? Used for the card back. |
What icon is used for the card?
Desc used for the card description of the card
Name used for the card
Are we reversed? Used for the card back.
Datum which holds all the data for a message being sent
+This used to be a single associative list with just keys and values +It had no typepath or presence checking, and was absolutely awful to work with +This fixes that
Vars | |
| connection | Origin of the signal |
|---|---|
| data | The signal data (See defines/radio.dm) |
| follow_target | Follow target for AI use |
| freq | What frequency the message is sent on |
| message_pieces | Pieces of the message |
| needs_tcomms | Did the signal come from a device that requires tcomms to function |
| pass | Should this signal be re-broadcasted (Can be modified by NTTC, defaults to TRUE) |
| pre_modify_name | sender_name before modify_message modifies it, because it introduces html tags. |
| radio | The radio it was sent from |
| reject | Is this signal meant to be rejected |
| sender | Who sent it |
| sender_job | What job are they |
| sender_name | Who sent the message |
| sender_rank | What rank are they (this is used for formatting) |
| source_level | Source Z-level |
| verbage | Verbage used |
| vmask | Was it sent with a voice changer |
| vname | Voice name if the person doesnt have a name (diona, alien, etc) |
| zlevels | List of all channels this can be sent or received on |
Procs | |
| Destroy | Destructor for the TCM datum. |
Origin of the signal
The signal data (See defines/radio.dm)
Follow target for AI use
What frequency the message is sent on
Pieces of the message
Did the signal come from a device that requires tcomms to function
Should this signal be re-broadcasted (Can be modified by NTTC, defaults to TRUE)
sender_name before modify_message modifies it, because it introduces html tags.
The radio it was sent from
Is this signal meant to be rejected
Who sent it
What job are they
Who sent the message
What rank are they (this is used for formatting)
Source Z-level
Verbage used
Was it sent with a voice changer
Voice name if the person doesnt have a name (diona, alien, etc)
List of all channels this can be sent or received on
Destructor for the TCM datum.
+This needs to happen like this so that things dont keep references held in place
Datum used by team antagonists to track it's members and objectives the team needs to complete.
Vars | |
| antag_datum_type | Type of antag datum members of this team have. Also given to new members added by admins. |
|---|---|
| blackbox_save_name | The name to save objective successes under in the blackboxes. Saves nothing if blank. |
| members | A list of minds who belong to this team. |
| name | The name of the team. |
| objective_holder | A list of objectives which all team members share. |
Procs | |
| add_member | Adds new_member to this team. |
| add_team_objective | Adds a team objective to each member's matching antag datum. |
| admin_add_member | Adds a new member to this team from a list of players in the round. |
| admin_add_objective | Allows admins to add a team objective. +Minimize overriding this proc please. |
| admin_announce_objectives | Allows admins to announce objectives to all team members. |
| admin_communicate | Allows admins to send a message to all members of this team. |
| admin_remove_member | Allows admins to remove a team member. |
| admin_remove_objective | Allows admins to remove a team objective. |
| admin_rename_team | Allows admins to rename the team. |
| get_admin_commands | A list of team-specific admin commands for this team. Should be in the form of "command" = CALLBACK(x, PROC_REF(some_proc)). |
| get_admin_priority_objectives | Returns an associated list of priority objectives for admins to add to the team, this is like
+Must return in the form objective name = objective_path. |
| get_antag_datum_from_member | Return an antag datum from a member which is linked with this team. |
| get_target_excludes | Special overrides for teams for target exclusion from objectives. |
| handle_adding_admin_objective | Overridable logic for handling how the adding of objectives works works +Can return an objective datum, or a boolean. +Returns a boolean if its already added to the team objectives in a custom way |
| handle_adding_member | An internal proc to allow teams to handle custom parts of adding a member.
+This should ONLY be called by add_member() to ensure proper order of operations. |
| handle_removing_member | An internal proc for teams to remove a member. |
| on_round_end | Displays the roundend stats for teams |
| remove_member | Removes member from this team.
+This is an interface proc, to prevent handle_removing_member from being called multiple times. |
| remove_team_objective | Remove a team objective from each member's matching antag datum. |
Type of antag datum members of this team have. Also given to new members added by admins.
The name to save objective successes under in the blackboxes. Saves nothing if blank.
A list of minds who belong to this team.
The name of the team.
A list of objectives which all team members share.
Adds new_member to this team.
This is an interface proc, to prevent handle_removing_member from being called multiple times.
+It is better if this is only called from add_antag_datum(), but it is not required.
Adds a team objective to each member's matching antag datum.
Adds a new member to this team from a list of players in the round.
Allows admins to add a team objective. +Minimize overriding this proc please.
Allows admins to announce objectives to all team members.
Allows admins to send a message to all members of this team.
Allows admins to remove a team member.
Allows admins to remove a team objective.
Allows admins to rename the team.
A list of team-specific admin commands for this team. Should be in the form of "command" = CALLBACK(x, PROC_REF(some_proc)).
Returns an associated list of priority objectives for admins to add to the team, this is like
+Must return in the form objective name = objective_path.
Return an antag datum from a member which is linked with this team.
Special overrides for teams for target exclusion from objectives.
Overridable logic for handling how the adding of objectives works works +Can return an objective datum, or a boolean. +Returns a boolean if its already added to the team objectives in a custom way
An internal proc to allow teams to handle custom parts of adding a member.
+This should ONLY be called by add_member() to ensure proper order of operations.
An internal proc for teams to remove a member.
Displays the roundend stats for teams
Removes member from this team.
+This is an interface proc, to prevent handle_removing_member from being called multiple times.
Remove a team objective from each member's matching antag datum.
Vars | |
| ascend_number | How many crew need to be converted to ascend |
|---|---|
| ascend_percent | Used for the CentComm announcement at ascension |
| cult_ascendant | Does the cult have halos |
| cult_risen | Does the cult have glowing eyes |
| cult_status | Variable used for tracking the progress of the cult's sacrifices & god summonings |
| is_in_transition | Boolean that prevents all_members_timer from being called multiple times |
| mirror_shields_active | Are cultist mirror shields active yet? |
| obj_summon | God summon objective added when ready_to_summon() is called |
| rise_number | How many crew need to be converted to rise |
Procs | |
| all_members_timer | This is a magic fuckin proc that takes a proc_ref, and calls it on all the human cultists. +Created so that we don't make 1000 timers, and I'm too lazy to make a proc for all of these. +Used in callbacks for some magic bullshit. |
| cult_body_transfer | Makes sure that the signal stays on the correct body when a cultist changes bodies |
| cult_threshold_check | Decides at the start of the round how many conversions are needed to rise/ascend. |
| current_sac_objective | Return the current sacrifice objective datum, if any |
| get_admin_commands | ADMIN STUFF DOWN YONDER |
| get_cultists | Returns the current number of cultists and constructs. |
How many crew need to be converted to ascend
Used for the CentComm announcement at ascension
Does the cult have halos
Does the cult have glowing eyes
Variable used for tracking the progress of the cult's sacrifices & god summonings
Boolean that prevents all_members_timer from being called multiple times
Are cultist mirror shields active yet?
God summon objective added when ready_to_summon() is called
How many crew need to be converted to rise
This is a magic fuckin proc that takes a proc_ref, and calls it on all the human cultists. +Created so that we don't make 1000 timers, and I'm too lazy to make a proc for all of these. +Used in callbacks for some magic bullshit.
Makes sure that the signal stays on the correct body when a cultist changes bodies
Decides at the start of the round how many conversions are needed to rise/ascend.
+The number is decided by (Percentage * (Players - Cultists)), so for example at 110 players it would be 11 conversions for rise. (0.1 * (110 - 4)) +These values change based on population because 20 cultists are MUCH more powerful if there's only 50 players, compared to 120.
+Below 100 players, CULT_RISEN_LOW and CULT_ASCENDANT_LOW are used. +Above 100 players, CULT_RISEN_HIGH and CULT_ASCENDANT_HIGH are used.
Return the current sacrifice objective datum, if any
ADMIN STUFF DOWN YONDER
Returns the current number of cultists and constructs.
+Returns the number of cultists and constructs in a list ([1] = Cultists, [2] = Constructs), or as one combined number.
+Procs | |
| need_another_headrev | |
|---|---|
How many Headrevs given security + command (excluding the clamp)
+ Security
+ 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
+ ------------------------------------------------------------------
+ 0 | -3 -2 -2 -2 -1 -1 -1 0 0 0 1 1 1 2 2 2 3
+ 1 | -2 -1 -1 -1 0 0 0 1 1 1 2 2 2 3 3 3 4
+ 2 | -1 0 0 0 1 1 1 2 2 2 3 3 3 4 4 4 5
+ 4 | 1 2 2 2 3 3 3 4 4 4 5 5 5 6 6 6 7
+ 5 | 2 3 3 3 4 4 4 5 5 5 6 6 6 7 7 7 8
+ 6 | 3 4 4 4 5 5 5 6 6 6 7 7 7 8 8 8 9
+ 7 | 4 5 5 5 6 6 6 7 7 7 8 8 8 9 9 9 10
+ Technology Datums
+Includes all the various technoliges and what they make. +Datum of individual technologies.
Represents a connected chat channel.
Vars | |
| connection_name | Name of the chat connection. This is the IRC server address or the Discord guild. |
|---|---|
| custom_tag | Tag string associated with the channel in TGS. |
| embeds_supported | [TRUE]/[FALSE] if the channel supports embeds. |
| friendly_name | User friendly name of the channel. |
| id | TGS internal channel ID. |
| is_admin_channel | [TRUE]/[FALSE] based on if the server operator has marked this channel for game admins only. |
| is_private_channel | [TRUE]/[FALSE] if the channel is a private message channel for a /datum/tgs_chat_user. |
Name of the chat connection. This is the IRC server address or the Discord guild.
Tag string associated with the channel in TGS.
[TRUE]/[FALSE] if the channel supports embeds.
User friendly name of the channel.
TGS internal channel ID.
[TRUE]/[FALSE] based on if the server operator has marked this channel for game admins only.
[TRUE]/[FALSE] if the channel is a private message channel for a /datum/tgs_chat_user.
User definable chat command.
Vars | |
| admin_only | If this command should be available to game administrators only. |
|---|---|
| help_text | The help text displayed for this command. |
| ignore_type | A subtype of /datum/tgs_chat_command that is ignored when enumerating available commands. Use this to create shared base /datums for commands. |
| name | The string to trigger this command on a chat bot. e.g @bot name ... or !tgs name .... |
Procs | |
| Run | Process command activation. Should return a /datum/tgs_message_content to respond to the issuer with. |
If this command should be available to game administrators only.
The help text displayed for this command.
A subtype of /datum/tgs_chat_command that is ignored when enumerating available commands. Use this to create shared base /datums for commands.
The string to trigger this command on a chat bot. e.g @bot name ... or !tgs name ....
Process command activation. Should return a /datum/tgs_message_content to respond to the issuer with.
+sender - The /datum/tgs_chat_user who issued the command. +params - The trimmed string following the command `/datum/tgs_chat_command/var/name].
See https://discord.com/developers/docs/resources/channel#embed-object-embed-footer-structure for details.
Vars | |
| text | Must be set in New(). |
|---|---|
Must be set in New().
Common datum for similar discord embed medias.
Vars | |
| url | Must be set in New(). |
|---|---|
Must be set in New().
User definable chat embed. Currently mirrors Discord chat embeds. See https://discord.com/developers/docs/resources/channel#embed-object-embed-structure for details.
Vars | |
| colour | Colour must be #AARRGGBB or #RRGGBB hex string. |
|---|---|
| image | See https://discord.com/developers/docs/resources/channel#embed-object-embed-image-structure for details. |
| thumbnail | See https://discord.com/developers/docs/resources/channel#embed-object-embed-thumbnail-structure for details. |
| timestamp | Timestamp must be encoded as: time2text(world.timeofday, "YYYY-MM-DD hh:mm:ss"). Use the active timezone. |
| video | See https://discord.com/developers/docs/resources/channel#embed-object-embed-image-structure for details. |
Colour must be #AARRGGBB or #RRGGBB hex string.
See https://discord.com/developers/docs/resources/channel#embed-object-embed-image-structure for details.
See https://discord.com/developers/docs/resources/channel#embed-object-embed-thumbnail-structure for details.
Timestamp must be encoded as: time2text(world.timeofday, "YYYY-MM-DD hh:mm:ss"). Use the active timezone.
See https://discord.com/developers/docs/resources/channel#embed-object-embed-image-structure for details.
Vars | |
| channel | The /datum/tgs_chat_channel the user was from. |
|---|---|
| friendly_name | The user's display name. |
| id | TGS internal user ID. |
| mention | The string to use to ping this user in a message. |
The /datum/tgs_chat_channel the user was from.
The user's display name.
TGS internal user ID.
The string to use to ping this user in a message.
User definable handler for TGS events.
Vars | |
| receive_health_checks | If the handler receieves TGS_EVENT_HEALTH_CHECK events. |
|---|---|
Procs | |
| HandleEvent | User definable callback for handling TGS events. |
If the handler receieves TGS_EVENT_HEALTH_CHECK events.
User definable callback for handling TGS events.
+event_code - One of the TGS_EVENT_ defines. Extra parameters will be documented in each.
User definable chat message.
Vars | |
| embed | The /datum/tgs_chat_embed to embed in the message. Not supported on all chat providers. |
|---|---|
| text | The tring content of the message. Must be provided in New(). |
The /datum/tgs_chat_embed to embed in the message. Not supported on all chat providers.
The tring content of the message. Must be provided in New().
Represents git revision information.
Vars | |
| commit | Full SHA of the commit. |
|---|---|
| origin_commit | Full sha of last known remote commit. This may be null if the TGS repository is not currently tracking a remote branch. |
| timestamp | ISO 8601 timestamp of when the commit was created. |
Full SHA of the commit.
Full sha of last known remote commit. This may be null if the TGS repository is not currently tracking a remote branch.
ISO 8601 timestamp of when the commit was created.
Represents a merge of a GitHub pull request.
Vars | |
| author | The Username of the test merge source's author. |
|---|---|
| body | The test merge source's body when it was merged. |
| comment | Optional comment left by the TGS user who initiated the merge. |
| head_commit | The SHA of the test merge when that was merged. |
| number | The test merge number. |
| title | The test merge source's title when it was merged. |
| url | An http URL to the test merge source. |
The Username of the test merge source's author.
The test merge source's body when it was merged.
Optional comment left by the TGS user who initiated the merge.
The SHA of the test merge when that was merged.
The test merge number.
The test merge source's title when it was merged.
An http URL to the test merge source.
Represents a version.
Vars | |
| deprecated_patch | Legacy version number. Generally null. |
|---|---|
| deprefixed_parameter | String value minus prefix. |
| minor | The minor version number. null for wildcards. |
| patch | The patch version number. null for wildcards. |
| raw_parameter | Unparsed string value. |
| suite | The suite/major version number. |
Legacy version number. Generally null.
String value minus prefix.
The minor version number. null for wildcards.
The patch version number. null for wildcards.
Unparsed string value.
The suite/major version number.
Copyright (c) 2020 Aleksej Komarov +SPDX-License-Identifier: MIT
+tgui datum (represents a UI).
Vars | |
| asset_data | Asset data to be sent with every update |
|---|---|
| autoupdate | Update the UI every MC tick. |
| closing | Stops further updates when close() was called. |
| initialized | If the UI has been initialized yet. |
| interface | The interface (template) to be used for this UI. |
| opened_at | Time of opening the window. |
| refresh_cooldown | Rate limit client refreshes to prevent DoS. |
| refreshing | Timed refreshing state |
| src_object | The object which owns the UI. |
| state | Topic state used to determine status/interactability. |
| status | The status/visibility of the UI. |
| title | The title of te UI. |
| user | The mob who opened/is using the UI. |
| window | The window_id for browse() and onclose(). |
| window_key | Key that is used for remembering the window geometry. |
| window_size | Deprecated: Window size. |
Procs | |
| New | public |
| close | public |
| get_payload | private |
| on_message | private |
| open | public |
| process | private |
| process_status | private |
| send_asset | public |
| send_full_update | public |
| send_update | public |
| set_autoupdate | public |
| set_state | public |
Asset data to be sent with every update
Update the UI every MC tick.
Stops further updates when close() was called.
If the UI has been initialized yet.
The interface (template) to be used for this UI.
Time of opening the window.
Rate limit client refreshes to prevent DoS.
Timed refreshing state
The object which owns the UI.
Topic state used to determine status/interactability.
The status/visibility of the UI.
The title of te UI.
The mob who opened/is using the UI.
The window_id for browse() and onclose().
Key that is used for remembering the window geometry.
Deprecated: Window size.
public
+Create a new UI.
+required user mob The mob who opened/is using the UI. +required src_object datum The object or datum which owns the UI. +required interface string The interface used to render the UI. +optional title string The title of the UI. +optional ui_x int Deprecated: Window width. +optional ui_y int Deprecated: Window height.
+return datum/tgui The requested UI.
public
+Close the UI.
+optional can_be_suspended bool
private
+Package the data to send to the UI, as JSON.
+return list
private
+Callback for handling incoming tgui messages.
public
+Open this UI (and initialize it with data).
private
+Run an update cycle for this UI. Called internally by SStgui +every second or so.
private
+Updates the status, and returns TRUE if status has changed.
public
+Makes an asset available to use in tgui.
+required asset datum/asset
public
+Send a full update to the client (includes static data).
+optional custom_data list Custom data to send instead of ui_data. +optional force bool Send an update even if UI is not interactive.
public
+Send a partial update to the client (excludes static data).
+optional custom_data list Custom data to send instead of ui_data. +optional force bool Send an update even if UI is not interactive.
public
+Enable/disable auto-updating of the UI.
+required value bool Enable/disable auto-updating.
public
+Replace current ui.state with a new one.
+required state datum/ui_state/state Next state
Datum used for instantiating and using a TGUI-controlled modal that prompts the user with +a message and has buttons for responses.
Vars | |
| autofocus | The bool that controls if this modal should grab window focus |
|---|---|
| buttons | The list of buttons (responses) provided on the TGUI window |
| choice | The button that the user has pressed, null if no selection has been made |
| closed | Boolean field describing if the tgui_alert was closed by the user. |
| deletion_timer | The attached timer that handles this objects timeout deletion |
| message | The textual body of the TGUI window |
| start_time | The time at which the tgui_alert was created, for displaying timeout progress. |
| state | The TGUI UI state that will be returned in ui_state(). Default: always_state |
| timeout | The lifespan of the tgui_alert, after which the window will close and delete itself. |
| title | The title of the TGUI window |
Procs | |
| wait | Waits for a user's response to the tgui_alert's prompt before returning. Returns early if +the window was closed by the user. |
The bool that controls if this modal should grab window focus
The list of buttons (responses) provided on the TGUI window
The button that the user has pressed, null if no selection has been made
Boolean field describing if the tgui_alert was closed by the user.
The attached timer that handles this objects timeout deletion
The textual body of the TGUI window
The time at which the tgui_alert was created, for displaying timeout progress.
The TGUI UI state that will be returned in ui_state(). Default: always_state
The lifespan of the tgui_alert, after which the window will close and delete itself.
The title of the TGUI window
Waits for a user's response to the tgui_alert's prompt before returning. Returns early if +the window was closed by the user.
Datum used for instantiating and using a TGUI-controlled number input that prompts the user with +a message and has an input for number entry.
Vars | |
| closed | Boolean field describing if the tgui_input_number was closed by the user. |
|---|---|
| default | The default (or current) value, shown as a default. Users can press reset with this. |
| deletion_timer | The attached timer that handles this objects timeout deletion |
| entry | The entry that the user has return_typed in. |
| max_value | The maximum value that can be entered. |
| message | The prompt's body, if any, of the TGUI window. |
| min_value | The minimum value that can be entered. |
| round_value | Whether the submitted number is rounded down into an integer. |
| start_time | The time at which the number input was created, for displaying timeout progress. |
| state | The TGUI UI state that will be returned in ui_state(). Default: always_state |
| timeout | The lifespan of the number input, after which the window will close and delete itself. |
| title | The title of the TGUI window |
Procs | |
| Destroy | Checks for empty numbers - bank accounts, etc. +Sanity check |
| wait | Waits for a user's response to the tgui_input_number's prompt before returning. Returns early if +the window was closed by the user. |
Boolean field describing if the tgui_input_number was closed by the user.
The default (or current) value, shown as a default. Users can press reset with this.
The attached timer that handles this objects timeout deletion
The entry that the user has return_typed in.
The maximum value that can be entered.
The prompt's body, if any, of the TGUI window.
The minimum value that can be entered.
Whether the submitted number is rounded down into an integer.
The time at which the number input was created, for displaying timeout progress.
The TGUI UI state that will be returned in ui_state(). Default: always_state
The lifespan of the number input, after which the window will close and delete itself.
The title of the TGUI window
Checks for empty numbers - bank accounts, etc. +Sanity check
Waits for a user's response to the tgui_input_number's prompt before returning. Returns early if +the window was closed by the user.
tgui_input_text
+Datum used for instantiating and using a TGUI-controlled text input that prompts the user with +a message and has an input for text entry.
Vars | |
| closed | Boolean field describing if the tgui_input_text was closed by the user. |
|---|---|
| default | The default (or current) value, shown as a default. |
| deletion_timer | The attached timer that handles this objects timeout deletion |
| encode | Whether the input should be stripped using html_encode |
| entry | The entry that the user has return_typed in. |
| max_length | The maximum length for text entry |
| message | The prompt's body, if any, of the TGUI window. |
| multiline | Multiline input for larger input boxes. |
| start_time | The time at which the text input was created, for displaying timeout progress. |
| state | The TGUI UI state that will be returned in ui_state(). Default: always_state |
| timeout | The lifespan of the text input, after which the window will close and delete itself. |
| title | The title of the TGUI window |
Procs | |
| set_entry | Sets the return value for the tgui text proc. +If html encoding is enabled, the text will be encoded. +This can sometimes result in a string that is longer than the max length. +If the string is longer than the max length, it will be clipped. |
| wait | Waits for a user's response to the tgui_input_text's prompt before returning. Returns early if +the window was closed by the user. |
Boolean field describing if the tgui_input_text was closed by the user.
The default (or current) value, shown as a default.
The attached timer that handles this objects timeout deletion
Whether the input should be stripped using html_encode
The entry that the user has return_typed in.
The maximum length for text entry
The prompt's body, if any, of the TGUI window.
Multiline input for larger input boxes.
The time at which the text input was created, for displaying timeout progress.
The TGUI UI state that will be returned in ui_state(). Default: always_state
The lifespan of the text input, after which the window will close and delete itself.
The title of the TGUI window
Sets the return value for the tgui text proc. +If html encoding is enabled, the text will be encoded. +This can sometimes result in a string that is longer than the max length. +If the string is longer than the max length, it will be clipped.
Waits for a user's response to the tgui_input_text's prompt before returning. Returns early if +the window was closed by the user.
Client does NOT have tgui_input on: Returns regular input
+Datum used for instantiating and using a TGUI-controlled list input that prompts the user with +a message and shows a list of selectable options
Vars | |
| choice | The button that the user has pressed, null if no selection has been made |
|---|---|
| closed | Boolean field describing if the tgui_list_input was closed by the user. |
| default | The default button to be selected |
| deletion_timer | The attached timer that handles this objects timeout deletion |
| invalid | Whether the tgui list input is invalid or not (i.e. due to all list entries being null) |
| items | The list of items (responses) provided on the TGUI window |
| items_map | Buttons (strings specifically) mapped to the actual value (e.g. a mob or a verb) |
| message | The textual body of the TGUI window |
| start_time | The time at which the tgui_list_input was created, for displaying timeout progress. |
| state | The TGUI UI state that will be returned in ui_state(). Default: always_state |
| timeout | The lifespan of the tgui_list_input, after which the window will close and delete itself. |
| title | The title of the TGUI window |
Procs | |
| wait | Waits for a user's response to the tgui_list_input's prompt before returning. Returns early if +the window was closed by the user. |
The button that the user has pressed, null if no selection has been made
Boolean field describing if the tgui_list_input was closed by the user.
The default button to be selected
The attached timer that handles this objects timeout deletion
Whether the tgui list input is invalid or not (i.e. due to all list entries being null)
The list of items (responses) provided on the TGUI window
Buttons (strings specifically) mapped to the actual value (e.g. a mob or a verb)
The textual body of the TGUI window
The time at which the tgui_list_input was created, for displaying timeout progress.
The TGUI UI state that will be returned in ui_state(). Default: always_state
The lifespan of the tgui_list_input, after which the window will close and delete itself.
The title of the TGUI window
Waits for a user's response to the tgui_list_input's prompt before returning. Returns early if +the window was closed by the user.
Copyright (c) 2020 Aleksej Komarov +SPDX-License-Identifier: MIT
+tgui_panel datum +Hosts tgchat and other nice features.
Vars | |
| telemetry_analyzed_at | Time of telemetry analysis completion |
|---|---|
| telemetry_connections | List of previous client connections |
| telemetry_requested_at | Time of telemetry request |
Procs | |
| analyze_telemetry | private |
| initialize | public |
| is_ready | public |
| on_initialize_timed_out | private |
| on_message | private |
| play_music | public |
| request_telemetry | private |
| send_roundrestart | public |
| stop_music | public |
Time of telemetry analysis completion
List of previous client connections
Time of telemetry request
private
+Analyzes a telemetry packet.
+Is currently only useful for detecting ban evasion attempts.
public
+Initializes tgui panel.
public
+TRUE if panel is initialized and ready to receive messages.
private
+Called when initialization has timed out.
private
+Callback for handling incoming tgui messages.
public
+Sends music data to the browser.
+Optional settings:
+required url string Must be an https URL. +optional extra_data list Optional settings.
private
+Requests some telemetry from the client.
public
+Sends a round restart notification.
public
+Stops playing music through the browser.
The tgui say modal. This initializes an input window which hides until +the user presses one of the speech hotkeys. Once something is entered, it will +delegate the speech to the proper channel.
Vars | |
| client | The user who opened the window |
|---|---|
| window | The modal window |
| window_open | Boolean for whether the tgui_say was opened by the user. |
Procs | |
| New | Creates the new input window to exist in the background. |
| close | Closes the window serverside. Closes any open chat bubbles +regardless of preference. |
| delegate_speech | Delegates the speech to the proper channel. |
| handle_entry | Handles text entry and forced speech. |
| initialize | After a brief period, injects the scripts into +the window to listen for open commands. |
| load | Ensures nothing funny is going on window load. +Minimizes the window, sets max length, closes all +typing and thinking indicators. This is triggered +as soon as the window sends the "ready" message. |
| on_message | The equivalent of ui_act, this waits on messages from the window +and delegates actions. |
| open | Sets the window as "opened" server side, though it is already +visible to the user. We do this to set local vars & +start typing (if enabled and in an IC channel). |
| start_thinking | Sets the mob as "thinking" - with indicator |
| start_typing | Handles the user typing. After a brief period of inactivity, +signals the client mob to revert to the "thinking" icon. |
| stop_thinking | Special exemptions +Removes typing/thinking indicators and flags the mob as not thinking |
| stop_typing | Callback to remove the typing indicator after a brief period of inactivity. +If the user was typing IC, the thinking indicator is shown. |
The user who opened the window
The modal window
Boolean for whether the tgui_say was opened by the user.
Creates the new input window to exist in the background.
Closes the window serverside. Closes any open chat bubbles +regardless of preference.
Delegates the speech to the proper channel.
+Arguments: +entry - the text to broadcast +channel - the channel to broadcast in +Returns: +boolean - on success or failure
Handles text entry and forced speech.
+Arguments: +payload - a string list containing entry & channel +Returns: +boolean - success or failure
After a brief period, injects the scripts into +the window to listen for open commands.
Ensures nothing funny is going on window load. +Minimizes the window, sets max length, closes all +typing and thinking indicators. This is triggered +as soon as the window sends the "ready" message.
The equivalent of ui_act, this waits on messages from the window +and delegates actions.
Sets the window as "opened" server side, though it is already +visible to the user. We do this to set local vars & +start typing (if enabled and in an IC channel).
+Arguments: +payload - A list containing the channel the window was opened in.
Sets the mob as "thinking" - with indicator
Handles the user typing. After a brief period of inactivity, +signals the client mob to revert to the "thinking" icon.
Special exemptions +Removes typing/thinking indicators and flags the mob as not thinking
Callback to remove the typing indicator after a brief period of inactivity. +If the user was typing IC, the thinking indicator is shown.
Copyright (c) 2020 Aleksej Komarov +SPDX-License-Identifier: MIT
Procs | |
| New | public |
|---|---|
| acquire_lock | public |
| can_be_suspended | public |
| close | public |
| flush_message_queue | private |
| initialize | public |
| is_ready | public |
| on_message | private |
| reinitialize | public |
| release_lock | public |
| replace_html | public |
| send_asset | public |
| send_message | public |
| send_raw_message | public |
| subscribe | public |
| unsubscribe | public |
public
+Create a new tgui window.
+required client /client +required id string A unique window identifier.
public
+Acquire the window lock. Pool will not be able to provide this window +to other UIs for the duration of the lock.
+Can be given an optional tgui datum, which will be automatically +subscribed to incoming messages via the on_message proc.
+optional ui /datum/tgui
public
+Checks if the window can be sanely suspended.
+return bool
public
+Close the UI.
+optional can_be_suspended bool
private
+Sends queued messages if the queue wasn't empty.
public
+Initializes the window with a fresh page. Puts window into the "loading" +state. You can begin sending messages right after initializing. Messages +will be put into the queue until the window finishes loading.
+optional strict_mode bool - Enables strict error handling and BSOD. +optional fancy bool - If TRUE and if this is NOT a panel, will hide the window titlebar. +optional assets list - List of assets to load during initialization. +optional inline_html string - Custom HTML to inject. +optional inline_js string - Custom JS to inject. +optional inline_css string - Custom CSS to inject.
public
+Checks if the window is ready to receive data.
+return bool
private
+Callback for handling incoming tgui messages.
public
+Reinitializes the panel with previous data used for initialization.
public
+Release the window lock.
public
+Replaces the inline HTML content.
+required inline_html string HTML to inject
public
+Makes an asset available to use in tgui.
+required asset datum/asset
+return bool - TRUE if any assets had to be sent to the client
public
+Sends a message to tgui window.
+required type string Message type +required payload list Message payload +optional force bool Send regardless of the ready status.
public
+Sends a raw payload to tgui window.
+required message string JSON+urlencoded blob to send. +optional force bool Send regardless of the ready status.
public
+Subscribes the datum to consume window messages on a specified proc.
+Note, that this supports only one subscriber, because code for that +is simpler and therefore faster. If necessary, this can be rewritten +to support multiple subscribers.
public
+Unsubscribes the datum. Do not forget to call this when cleaning up.
.
Vars | |
| job_possession | If a steal objective has forbidden jobs, and the forbidden jobs would not be in the possession of this item, set this to false |
|---|---|
| special_equipment | Do we have a special item we give to somewhen when they get this objective? |
If a steal objective has forbidden jobs, and the forbidden jobs would not be in the possession of this item, set this to false
Do we have a special item we give to somewhen when they get this objective?
Vars | |
| block_movement | Will thrownthing datum actually block movement? this might be FALSE with some circumstances even if var/should_block_movement is TRUE. This variable change automatically during the throw |
|---|---|
| dodgeable | When this variable is false, non dense mobs will be hit by a thrown item. useful for things that you dont want to be cheesed by crawling, EG. gravitational anomalies |
| should_block_movement | Can a thrown mob move themselves to stop the throw? |
Will thrownthing datum actually block movement? this might be FALSE with some circumstances even if var/should_block_movement is TRUE. This variable change automatically during the throw
When this variable is false, non dense mobs will be hit by a thrown item. useful for things that you dont want to be cheesed by crawling, EG. gravitational anomalies
Can a thrown mob move themselves to stop the throw?
Vars | |
| adminwho_data | List of adminwho data |
|---|---|
| client_ckey | ckey of the client who opened the ticket. |
| first_raw_response | The first raw response. Used for ticket conversions |
| ingame_time_opened | Ingame time the ticket was opened |
| lastResponseTime | When the staff last responded. |
| lastStaffResponse | Last staff member who responded. |
| locationSent | The location the player was when they sent the ticket. |
| mobControlled | The mob the player was controlling when they sent the ticket. |
| real_time_opened | Real time the ticket was opened. |
| staffAssigned | Staff member who has assigned themselves to this ticket. |
| staff_ckey | Staff member ckey who took it |
| staff_take_time | The time the staff member took the ticket |
| ticketCooldown | Cooldown before allowing the user to open another ticket. |
| ticketNum | Ticket number. |
| ticketState | State of the ticket, open, closed, resolved etc. |
| ticket_converted | Has the ticket been converted to another type? (Mhelp to Ahelp, etc.) |
| ticket_responses | Content of the staff help. |
| timeUntilStale | When the ticket goes stale. |
| title | The initial message from the user. |
List of adminwho data
ckey of the client who opened the ticket.
The first raw response. Used for ticket conversions
Ingame time the ticket was opened
When the staff last responded.
Last staff member who responded.
The location the player was when they sent the ticket.
The mob the player was controlling when they sent the ticket.
Real time the ticket was opened.
Staff member who has assigned themselves to this ticket.
Staff member ckey who took it
The time the staff member took the ticket
Cooldown before allowing the user to open another ticket.
Ticket number.
State of the ticket, open, closed, resolved etc.
Has the ticket been converted to another type? (Mhelp to Ahelp, etc.)
Content of the staff help.
When the ticket goes stale.
The initial message from the user.
Vars | |
| response_text | Text of this response |
|---|---|
| response_time | The time of the response |
| response_user | Who made the response |
Text of this response
The time of the response
Who made the response
Framework for custom vendor crits.
Vars | |
| fall_towards_mob | If we should be thrown against the mob or not. |
|---|---|
| harmless | If it'll deal damage or not |
| name | Name of a crit. Only crits with a name will be options. |
| valid_typecache | Typecache of valid types |
| valid_types_whitelist | List of types which we should be valid for |
Procs | |
| is_valid | Return whether or not the crit selected is valid. |
| tip_crit_effect | Perform the tip crit effect on a victim. +Arguments: |
If we should be thrown against the mob or not.
If it'll deal damage or not
Name of a crit. Only crits with a name will be options.
Typecache of valid types
List of types which we should be valid for
Return whether or not the crit selected is valid.
Perform the tip crit effect on a victim. +Arguments:
+This is the actual timer, it contains the callback and necessary data to maintain +the timer.
+See the documentation for the timer subsystem for an explanation of the buckets referenced +below in next and prev
Vars | |
| bucket_joined | Boolean indicating if timer joined into bucket |
|---|---|
| bucket_pos | Initial bucket position |
| callBack | The callback to invoke after the timer completes |
| flags | Flags associated with the timer, see _DEFINES/subsystems.dm |
| hash | Unique hash generated when TIMER_UNIQUE flag is present |
| id | ID used for timers when the TIMER_STOPPABLE flag is present |
| name | An informative name generated for the timer as its representation in strings, useful for debugging |
| next | Next timed event in the bucket |
| prev | Previous timed event in the bucket |
| source | The source of the timedevent, whatever called addtimer |
| spent | Time at which the timer was invoked or destroyed |
| timeToRun | The time at which the callback should be invoked at |
| wait | The length of the timer |
Procs | |
| bucketEject | Removes this timed event from any relevant buckets, or the secondary queue |
| bucketJoin | Attempts to add this timed event to a bucket, will enter the secondary queue +if there are no appropriate buckets at this time. |
| getTimerInfo | Returns debug information about timer |
| getcallingtype | Returns a string of the type of the callback for this timer |
Boolean indicating if timer joined into bucket
Initial bucket position
The callback to invoke after the timer completes
Flags associated with the timer, see _DEFINES/subsystems.dm
Unique hash generated when TIMER_UNIQUE flag is present
ID used for timers when the TIMER_STOPPABLE flag is present
An informative name generated for the timer as its representation in strings, useful for debugging
Next timed event in the bucket
Previous timed event in the bucket
The source of the timedevent, whatever called addtimer
Time at which the timer was invoked or destroyed
The time at which the callback should be invoked at
The length of the timer
Removes this timed event from any relevant buckets, or the secondary queue
Attempts to add this timed event to a bucket, will enter the secondary queue +if there are no appropriate buckets at this time.
+Secondary queueing of timed events will occur when the timespan covered by the existing +buckets is exceeded by the time at which this timed event is scheduled to be invoked. +If the timed event is tracking client time, it will be added to a special bucket.
Returns debug information about timer
Returns a string of the type of the callback for this timer
Vars | |
| dock_site | What specific station the traders came from |
|---|---|
| trader_location | Where the traders originate from |
| trader_major_special | What big ticket faction gear do they start with |
| trader_minor_special | What standard faction gear do they start with |
| trader_outfit | What outfit do the traders spawn with |
| trader_species | What species the traders consist of |
| trader_type | What faction the trader is |
What specific station the traders came from
Where the traders originate from
What big ticket faction gear do they start with
What standard faction gear do they start with
What outfit do the traders spawn with
What species the traders consist of
What faction the trader is
Vars | |
| account | the account this log is attached to, used for money db level logging |
|---|---|
| amount | If money is utilized/changed during this transaction, how much |
| is_deposit | Whether or not this added or money from the account |
| purpose | What this transaction is doing |
| time | when the transaction occurred |
| transactor | Who performed the action |
the account this log is attached to, used for money db level logging
If money is utilized/changed during this transaction, how much
Whether or not this added or money from the account
What this transaction is doing
when the transaction occurred
Who performed the action
Vars | |
| amount | how much money is being request |
|---|---|
| purpose | reason for transfer request |
| requesting_account | the money account that is requesting money |
| time | when the money was requested |
how much money is being request
reason for transfer request
the money account that is requesting money
when the money was requested
Modal datum (contains base information for a modal)
Procs | |
| on_answer | Called when a modal receives an answer |
|---|---|
| preprocess_answer | Called when it's time to pre-process the answer before using it |
| to_data | Creates a list that describes a modal visually to be passed to JS |
Called when a modal receives an answer
+Arguments:
+Called when it's time to pre-process the answer before using it
+Arguments:
+Creates a list that describes a modal visually to be passed to JS
Bento modal - Similar to choice, it displays the choices in a grid of images
+The returned answer is the index of the choice.
Vars | |
| target_datum | The datum we are modifying. This will almost always be an atom, but clients have colours too |
|---|---|
The datum we are modifying. This will almost always be an atom, but clients have colours too
Vars | |
| ignore_sensors | If true, we'll see everyone, regardless of their suit sensors. |
|---|---|
If true, we'll see everyone, regardless of their suit sensors.
Vars | |
| emoji_list | Store the list of potential emojis here. |
|---|---|
Store the list of potential emojis here.
Vars | |
| cyborg_security | The below is a toggle for if sec cyborgs are enabled or not |
|---|---|
The below is a toggle for if sec cyborgs are enabled or not
Allows ghosts to view a TGUI window which contains toggles for all HUD types available to them.
Vars | |
| hud_type_lookup | Associative list to get the appropriate hud type based on the string passed from TGUI. |
|---|---|
Associative list to get the appropriate hud type based on the string passed from TGUI.
Vars | |
| cached_books | Where we will store our cachedbook datums |
|---|---|
| page_state | TGUI page we are currently on |
| reports | list of assoc lists detailing each invidual reports, can contain multiple reports for same book |
| selected_ckey | Ckey's books we are viewing |
| view_book | information for the book we are opening in browserui |
| view_book_page | browserui helper variable for turning pages in book |
Where we will store our cachedbook datums
TGUI page we are currently on
list of assoc lists detailing each invidual reports, can contain multiple reports for same book
Ckey's books we are viewing
information for the book we are opening in browserui
browserui helper variable for turning pages in book
Vars | |
| owner | The robot who can use this UI to diagnose themselves. |
|---|---|
The robot who can use this UI to diagnose themselves.
Procs | |
| can_use_topic | private |
|---|---|
private
+Checks if a user can use src_object's UI, and returns the state. +Can call a mob proc, which allows overrides for each mob.
+required src_object datum The object/datum which owns the UI. +required user mob The mob who opened/is using the UI.
+return UI_state The state of the UI.
Vars | |
| abstract | Is what we're spawning abstract? |
|---|---|
| can_discount | Can this be sold at a discount? |
| category | What category is the item listed under |
| cost | How many TC does this cost? |
| desc | Description of the item in the uplink |
| excludefrom | Empty list does nothing. Place the name of uplink type you don't want this item to be available in here. |
| hijack_only | Can this item be purchased only during hijackings? |
| item | What is spawned when we purchase this? |
| job | Is this job locked? |
| limited_stock | Can you only buy so many? -1 allows for infinite purchases |
| name | Name of the item in the uplink |
| reference | Used for discounts. Any unique string will do. |
| refund_amount | specified refund amount in case there needs to be a TC penalty for refunds. |
| refund_path | Alternative path for refunds, in case the item purchased isn't what is actually refunded (ie: holoparasites). |
| refundable | Can you refund this in the uplink? |
| species | This makes an item on the uplink only show up to the specified species |
| surplus | Chance of being included in the surplus crate (when pick() selects it) |
| uplinktypes | Empty list means it is in all the uplink types. Otherwise place the uplink type here. |
| uses_special_spawn | Our special little snowflakes that have to be spawned in a different way than normal, like a surplus crate spawning a crate or contractor kits |
Is what we're spawning abstract?
Can this be sold at a discount?
What category is the item listed under
How many TC does this cost?
Description of the item in the uplink
Empty list does nothing. Place the name of uplink type you don't want this item to be available in here.
Can this item be purchased only during hijackings?
What is spawned when we purchase this?
Is this job locked?
Can you only buy so many? -1 allows for infinite purchases
Name of the item in the uplink
Used for discounts. Any unique string will do.
specified refund amount in case there needs to be a TC penalty for refunds.
Alternative path for refunds, in case the item purchased isn't what is actually refunded (ie: holoparasites).
Can you refund this in the uplink?
This makes an item on the uplink only show up to the specified species
Chance of being included in the surplus crate (when pick() selects it)
Empty list means it is in all the uplink types. Otherwise place the uplink type here.
Our special little snowflakes that have to be spawned in a different way than normal, like a surplus crate spawning a crate or contractor kits
Vars | |
| species | A fresh start, but a start with nothing. Hard to use as well |
|---|---|
A fresh start, but a start with nothing. Hard to use as well
Vars | |
| full_power_override | If true, lets the vampire have access to their full power abilities without meeting the blood requirement, or needing a certain number of drained humans. |
|---|---|
| fully_powered_abilities | A list of the powers a vampire unlocks when it reaches full power. |
| improved_rejuv_healing | Whether or not a vampire heals more based on damage taken. |
| name | The subclass' name. Used for blackbox logging. |
| standard_powers | A list of powers that a vampire unlocks. The value of the list entry is equal to the blood total required for the vampire to unlock it. |
| thrall_cap | maximun number of thralls a vampire may have at a time. incremented as they grow stronger, up to a cap at full power. |
If true, lets the vampire have access to their full power abilities without meeting the blood requirement, or needing a certain number of drained humans.
A list of the powers a vampire unlocks when it reaches full power.
Whether or not a vampire heals more based on damage taken.
The subclass' name. Used for blackbox logging.
A list of powers that a vampire unlocks. The value of the list entry is equal to the blood total required for the vampire to unlock it.
maximun number of thralls a vampire may have at a time. incremented as they grow stronger, up to a cap at full power.
Vars | |
| delivered_amount | The amount of units currently already delivered |
|---|---|
| delivery_goal | The amount of units of the required virus that must be delivered for the completion of this goal |
The amount of units currently already delivered
The amount of units of the required virus that must be delivered for the completion of this goal
Vars | |
| choices | Choices available in the vote |
|---|---|
| initiator | Person who started the vote |
| is_custom | Was this vote custom started? |
| question | The question being asked |
| show_counts | Do we want to show the vote counts as it goes |
| started_time | world.time the vote started at |
| vote_result_type | Vote result type. This determines how a winner is picked |
| vote_type_text | Vote type text, for showing in UIs and stuff |
Choices available in the vote
Person who started the vote
Was this vote custom started?
The question being asked
Do we want to show the vote counts as it goes
world.time the vote started at
Vote result type. This determines how a winner is picked
Vote type text, for showing in UIs and stuff
Vars | |
| semi_protected_areas | Areas which are "semi-protected". Mobs inside these areas take reduced burn damage from the solar flare. |
|---|---|
Areas which are "semi-protected". Mobs inside these areas take reduced burn damage from the solar flare.
Vars | |
| assemblies | An associative list of signalers attached to the wires. The wire color is the key, and the signaler object reference is the value. |
|---|---|
| colors | An associative list with the wire color as the key, and the wire define as the value. |
| cut_wires | A list of all cut wires. The same values that can go into wires will get added and removed from this list. |
| holder | The atom the wires belong too. For example: an airlock. |
| holder_type | The holder type; used to make sure that the holder is the correct type. |
| labelled | TRUE if the wires are labelled for every user |
| proper_name | The display name for the TGUI window. For example, given the var is "APC"... +When the TGUI window is opened, "wires" will be appended to it's title, and it would become "APC wires". |
| randomize | TRUE if the wires will be different every time a new wire datum is created. |
| wire_count | The total number of wires that our holder atom has. |
| wires | A list of all wires. For a list of valid wires defines that can go here, see code/__DEFINES/wires.dm |
Procs | |
| Interact | Proc called when the user attempts to interact with wires UI. |
| add_duds | Adds in dud wires, which do nothing when cut/pulsed. |
| attach_assembly | Proc called when a mob tries to attach a signaler to a wire. |
| cut | Cut or mend a wire. Calls on_cut(). |
| cut_all | Cuts all wires. |
| cut_color | Cut the wire which corresponds with the passed in color. |
| cut_random | Cuts a random wire. |
| detach_assembly | Proc called when a mob tries to detach a signaler from a wire. |
| emp_pulse | Use this proc if you want wires to be pulsed on EMP |
| get_attached | Gets the signaler attached to the given wire color, if there is one. |
| get_status | Base proc, intended to be overwritten. Put wire information you'll see at the botton of the TGUI window here, such as "The red light is blinking". |
| get_wire | Gets the wire associated with the color passed in. |
| get_wire_name | Get the name of the wire passed in. +If wires can't be read, may either return something scrambled or nothing at all. +A null return here means that there should be no name displayed at all. |
| interactable | Base proc, intended to be overriden. Wire datum specific checks you want to run before the TGUI is shown to the user should go here. |
| is_all_cut | Determines if all of the wires are cut. Returns TRUE they're all cut, FALSE otherwise. |
| is_attached | Checks if the given wire has a signaler on it. |
| is_color_cut | Determines if the wire associated with the passed in color, is cut or not. Returns TRUE if it's cut, FALSE otherwise. |
| is_cut | Determines if the passed in wire is cut or not. Returns TRUE if it's cut, FALSE otherwise. |
| is_dud | Determines if the passed in wire is a dud or not. Returns TRUE if the wire is a dud, FALSE otherwise. |
| is_dud_color | Returns TRUE if the wire that corresponds to the passed in color is a dud. FALSE otherwise. |
| on_cut | Proc called when any wire is cut. |
| on_pulse | Proc called when any wire is pulsed. |
| pulse | Pulses the given wire. Calls on_pulse(). |
| pulse_assembly | Proc called when an attached signaler receives a signal. |
| pulse_color | Pulses the wire associated with the given color. |
| randomize | Randomly generates a new set of wires. and corresponding colors from the given pool. Assigns the information as an associative list, to colors. |
| repair | Repairs all cut wires. |
| shuffle_wires | Clears the colors list, and randomizes it to a new set of color-to-wire relations. |
| ui_host | Users will be interacting with our holder object and not the wire datum directly, therefore we need to return the holder. |
An associative list of signalers attached to the wires. The wire color is the key, and the signaler object reference is the value.
An associative list with the wire color as the key, and the wire define as the value.
A list of all cut wires. The same values that can go into wires will get added and removed from this list.
The atom the wires belong too. For example: an airlock.
The holder type; used to make sure that the holder is the correct type.
TRUE if the wires are labelled for every user
The display name for the TGUI window. For example, given the var is "APC"... +When the TGUI window is opened, "wires" will be appended to it's title, and it would become "APC wires".
TRUE if the wires will be different every time a new wire datum is created.
The total number of wires that our holder atom has.
A list of all wires. For a list of valid wires defines that can go here, see code/__DEFINES/wires.dm
Proc called when the user attempts to interact with wires UI.
+Checks if the user exists, is a mob, the wires are attached to something (holder) and makes sure interactable(user) returns TRUE.
+If all the checks succeed, open the TGUI interface for the user.
Arugments:
+Adds in dud wires, which do nothing when cut/pulsed.
+Arguments:
+Proc called when a mob tries to attach a signaler to a wire.
+Makes sure that S is actually a signaler and that something is not already attached to the wire.
+Adds the signaler to the assemblies list as a value, with the color as a the key.
Arguments:
+Cut or mend a wire. Calls on_cut().
Arugments:
+WIRE_ELECTRIFY.Cuts all wires.
Cut the wire which corresponds with the passed in color.
+Arugments:
+Cuts a random wire.
Proc called when a mob tries to detach a signaler from a wire.
+First checks if there is a signaler on the wire. If so, removes the signaler, and clears it from assemblies list.
Arguments:
+Use this proc if you want wires to be pulsed on EMP
Gets the signaler attached to the given wire color, if there is one.
+Arguments:
+Base proc, intended to be overwritten. Put wire information you'll see at the botton of the TGUI window here, such as "The red light is blinking".
Gets the wire associated with the color passed in.
+Arugments:
+Get the name of the wire passed in. +If wires can't be read, may either return something scrambled or nothing at all. +A null return here means that there should be no name displayed at all.
+Arguments:
+Base proc, intended to be overriden. Wire datum specific checks you want to run before the TGUI is shown to the user should go here.
Determines if all of the wires are cut. Returns TRUE they're all cut, FALSE otherwise.
Checks if the given wire has a signaler on it.
+Arguments:
+Determines if the wire associated with the passed in color, is cut or not. Returns TRUE if it's cut, FALSE otherwise.
+Arugments:
+Determines if the passed in wire is cut or not. Returns TRUE if it's cut, FALSE otherwise.
+Arugments:
+WIRE_ELECTRIFY.Determines if the passed in wire is a dud or not. Returns TRUE if the wire is a dud, FALSE otherwise.
+Arugments:
+WIRE_ELECTRIFY.Returns TRUE if the wire that corresponds to the passed in color is a dud. FALSE otherwise.
+Arugments:
+Proc called when any wire is cut.
+Base proc, intended to be overriden. +Place an behavior you want to happen when certain wires are cut, into this proc.
+Arugments:
+Proc called when any wire is pulsed.
+Base proc, intended to be overriden. +Place behavior you want to happen when certain wires are pulsed, into this proc.
+Arugments:
+Pulses the given wire. Calls on_pulse().
Arugments:
+WIRE_ELECTRIFY.Proc called when an attached signaler receives a signal.
+Searches through the assemblies list for the wire that the signaler is attached to. Pulses the wire when it's found.
Arugments:
+Pulses the wire associated with the given color.
+Arugments:
+Randomly generates a new set of wires. and corresponding colors from the given pool. Assigns the information as an associative list, to colors.
In the colors list, the name of the color is the key, and the wire is the value.
+For example: colors["red"] = WIRE_ELECTRIFY. This will look like list("red" = WIRE_ELECTRIFY) internally.
Repairs all cut wires.
Clears the colors list, and randomizes it to a new set of color-to-wire relations.
Users will be interacting with our holder object and not the wire datum directly, therefore we need to return the holder.
Vars | |
| requires_commskey | Set this to TRUE if the topic handler needs an authorised comms key |
|---|---|
| topic_key | Key which invokes this topic |
Procs | |
| execute | Actually executes the user's topic |
| invoke | Invokes the world/Topic handler |
Set this to TRUE if the topic handler needs an authorised comms key
Key which invokes this topic
Actually executes the user's topic
+Override this to do your work in subtypes of this topic
+Arguments:
+Invokes the world/Topic handler
+This includes sanity checking for if the key is required, as well as other sanity checks +DO NOT OVERRIDE +Arguments:
+Vars | |
| ip | IP. Used purely for select purposes. |
|---|---|
| last_request | Time of last request |
| locked_out | Is this IP currently locked out |
| strikes | Amount of strikes. [WORLD_TOPIC_STRIKES_THRESHOLD] strikes is a lockout of [WORLD_TOPIC_LOCKOUT_TIME] |
| unlock_time | Unlock time |
Procs | |
| check_lockout | Lockout handler |
IP. Used purely for select purposes.
Time of last request
Is this IP currently locked out
Amount of strikes. [WORLD_TOPIC_STRIKES_THRESHOLD] strikes is a lockout of [WORLD_TOPIC_LOCKOUT_TIME]
Unlock time
Lockout handler
+Updates strikes and timers of the most recent client to topic the server +including any relevant detail
Procs | |
| increase_max_zlevel_to | SPACE ALLOCATION |
|---|---|
SPACE ALLOCATION
Vars | |
| Failsafe | Failsafe |
|---|---|
| Master | StonedMC |
| SSambience | The subsystem used to play ambience to users every now and then, makes them real excited. |
| SSchat | Copyright (c) 2020 Aleksej Komarov +SPDX-License-Identifier: MIT |
| SScleanup | |
| SSpersistent_data | |
| SStgui | tgui subsystem |
| SStimer | |
| SSverb_manager | SSverb_manager, a subsystem that runs every tick and runs through its entire queue without yielding like SSinput. +this exists because of how the byond tick works and where user inputted verbs are put within it. |
Procs | |
| HTTPGet | HTTP Get (Powered by RUSTG) |
| HeapPathWeightCompare | TODO: Macro this to reduce proc overhead |
| MakeAPICall | Internal API Caller |
| RoundDiagBar | Diagnostic HUDs! |
| _queue_verb | queue a callback for the given verb/verblike proc and any given arguments to the specified verb subsystem, so that they process in the next tick. +intended to only work with verbs or verblike procs called directly from client input, use as part of TRY_QUEUE_VERB() and co. |
| add_attack_logs | Creates attack (old and new) logs for the user and defense logs for the target. +Will message admins depending on the custom_level, user and target. |
| add_verb | handles adding verbs and updating the stat panel browser |
| 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. |
| announce_merge_conflict_marker | We REALLY do not want un-addressed merge conflicts in maps for an +inexhaustible list of reasons. This should help ensure that this will not be +missed in case linters fail to catch it for any reason what-so-ever. |
| atmos_scan | Outputs a message to the user describing the target's gasmixes. +Used in chat-based gas scans. |
| avoid_assoc_duplicate_keys | takes an input_key, as text, and the list of keys already used, outputting a replacement key in the format of "[input_key] ([number_of_duplicates])" if it finds a duplicate +use this for lists of things that might have the same name, like mobs or objects, that you plan on giving to a player as input |
| bang | Creates a flashing effect that blinds and deafens mobs within range |
| broadcast_message | Message Broadcast Proc |
| check_active_security_force | |
| check_rights_all | Requires the holder to have all the rights specified |
| client2rankcolour | Proc to generate a "rank colour" from a client |
| compare_list | compare two lists, returns TRUE if they are the same |
| costly_icon2asset | Costlier version of icon2asset() that uses getFlatIcon() to account for overlays, underlays, etc. Use with extreme moderation, ESPECIALLY on mobs. |
| create_shrapnel | Creates an explosion of shrapnel at a turf. |
| create_strippable_list | Creates an assoc list of keys to /datum/strippable_item |
| cut_relative_direction | Takes a screen_loc string and cut out any directions like NORTH or SOUTH |
| delete_all_SS_and_recreate_master | Delete all existing SS to basically start over |
| deltimer | Delete a timer |
| do_teleport | Will teleport the given atom to the given destination using the other parameters |
| emissive_appearance | Produces a mutable appearance glued to the EMISSIVE_PLANE dyed to be the EMISSIVE_COLOR. Order of application matters: Default generated blockers are overlays, and will block its own emissive underlays. If you want an object to be both a blocker, and have their own emissive, it has to be an overlay instead. Grayscale lightmasks are visible in the BYOND right-click and Examine pane, unless they're covered up by another overlay. |
| emissive_blocker | Produces a mutable appearance glued to the EMISSIVE_PLANE dyed to be the EM_BLOCK_COLOR. |
| emoji_parse | Turns :ai: into an emoji in text. |
| empulse | Will cause an EMP on the given epicenter. +This proc can sleep depending on the affected objects. So assume it sleeps! |
| finish_unequip_mob | A utility function for /datum/strippable_items to finish unequipping an item from a mob. |
| fire_flash_log | Flashfire is a proc used to log fire causing chemical reactions. |
| format_si_suffix | Formats num with an SI prefix. |
| generate_and_hash_rsc_file | Generates a filename for a given asset. +Like generate_asset_name(), except returns the rsc reference and the rsc file hash as well as the asset name (sans extension) +Used so that certain asset files dont have to be hashed twice |
| get_admin_objective_targets | Allows admins to safely pick from SSticker.minds for objectives |
| get_all_linked_levels_zpos | Proc to get a list of all the linked-together Z-Levels |
| get_allowed_instrument_ids | Get all non admin_only instruments as a list of text ids. |
| get_antag_type_strings_list | A proc that return an array of capitalized strings containing name of the antag types they are |
| get_antag_type_truncated_plaintext_string | A proc that return a string containing all the singled out antags . Empty string if not antag |
| get_atoms_of_type | Returns a list of atoms in a location of a given type. Can be refined to look for pixel-shift. |
| get_bbox_of_atoms | Get a bounding box of a list of atoms. |
| get_channel_name | Returns the clean name of an audio channel. |
| get_chemscan_results | HEALTH ANALYZER |
| get_departments_from_job | matches a string job name to their department(s) and returns it as a list |
| get_dummy_savefile | Gets a dummy savefile for usage in icon generation. +Savefiles generated from this proc will be empty. |
| get_edge_target_turf | Returns the turf located at the map edge in the specified direction relative to target_atom used for mass driver |
| get_icon_dmi_path | Given an icon object, dmi file path, or atom/image/mutable_appearance, attempts to find and return an associated dmi file path. +A weird quirk about dm is that /icon objects represent both compile-time or dynamic icons in the rsc, +But stringifying rsc references returns a dmi file path +ONLY if that icon represents a completely unchanged dmi file from when the game was compiled. +So if the given object is associated with an icon that was in the rsc when the game was compiled, this returns a path. otherwise it returns "" |
| get_line | Get a list of turfs in a line from starting_atom to ending_atom. |
| get_living_players | This proc returns every player with a client who is not a ghost or a new_player |
| get_path_to | This file contains the stuff you need for using JPS (Jump Point Search) pathing, an alternative to A* that skips +over large numbers of uninteresting tiles resulting in much quicker pathfinding solutions. |
| get_rad_contents | A special GetAllContents that doesn't search past things with rad insulation +Components which return COMPONENT_BLOCK_RADIATION prevent further searching into that object's contents. The object itself will get returned still. +The ignore list makes those objects never return at all |
| get_ranged_target_turf | |
| get_ranged_target_turf_direct | Get ranged target turf, but with direct targets as opposed to directions |
| get_safe_species | Returns a list of names of non-blacklisted or hazardous species. |
| get_unrestricted_random_reagent_id | Returns a random reagent ID, with real non blacklisted balance boosting action! |
| get_valid_screen_location | Returns a valid location to place a screen object without overflowing the viewport |
| get_valid_vent_spawns | Returns a list of vents that can be used as a potential spawn if they meet the criteria set by the arguments |
| goonchem_vortex | Throws or pulls objects to/from a chem reaction |
| icon2asset | The dmi file path we attempt to return if the given object argument is associated with a stringifiable icon +If successful, this looks like "icons/path/to/dmi_file.dmi" +generate an asset for the given icon or the icon of the given appearance for [thing], and send it to any clients in target. +Arguments: |
| icon2base64 | Converts an icon to base64. Operates by putting the icon in the iconCache savefile, +exporting it as text, and then parsing the base64 from that. +(This relies on byond automatically storing icons in savefiles as base64) |
| icon_exists | Checks if the given iconstate exists in the given file, caching the result. Setting no_sprite to TRUE will print a stack trace ONCE. |
| is_bad_connection | Connection checker |
| is_color_dark | Given a color in the format of "#RRGGBB", will return if the color is dark. |
| is_special_character | ADMIN HELPER PROCS +A proc that return whether the mob is a "Special Character" aka Antagonist |
| is_type_in_UID_list | If the list L contains a datum UID who's type matches D's type, returns the UID of that datum in the list. Otherwise returns null. |
| is_valid_dmi_file | given a text string, returns whether it is a valid dmi icons folder path |
| locateUID | Locates a datum based off of the UID |
| makeDatumRefLists | Initial Building |
| make_associative | A proc for turning a list into an associative list. |
| md5asfile | Save file as an external file then md5 it. +Used because md5ing files stored in the rsc sometimes gives incorrect md5 results. |
| md5filepath | Returns the md5 of a file at a given path. |
| message_adminTicket | Sends a message to the staff able to see admin tickets +Arguments: +msg - The message being send +important - If the message is important. If TRUE it will ignore the CHAT_NO_TICKETLOGS preferences, +send a sound and flash the window. Defaults to FALSE |
| message_mentorTicket | Sends a message to the staff able to see mentor tickets +Arguments: +msg - The message being send +important - If the message is important. If TRUE it will ignore the CHAT_NO_TICKETLOGS preferences, +send a sound and flash the window. Defaults to FALSE |
| message_to_html | Message-related procs |
| offset_to_screen_loc | Takes a list in the form (x_offset, y_offset) +And converts it to a screen loc string +Accepts an optional view string/size to force the screen_loc around, so it can't go out of scope |
| parse_caught_click_modifiers | Returns a turf based on text inputs, original turf and viewing client |
| phase_filter | This filter proc makes a visual effect where the object is split into fragments, with vertical lines cut out of them. It will appear as 2 seperate things are made of the one object that was cut out |
| pick_multiple_unique | Picks multiple unique elements from the suplied list. +If the given list has a length less than the amount given then it will return a list with an equal amount |
| pick_unique_lawset | returns a random non starting / kill crew lawset if the station has a unique ai lawset |
| pickweight | Picks an element based on its weight. +L - The input list |
| propagate_network | remove the old powernet and replace it with a new one throughout the network. |
| radial_menu_helper | Similar to show_radial_menu, but choices is a list of atoms, for which icons will be automatically generated. +Supports multiple items of the same name, 2 soaps will become soap (1) and soap (2) to the user. +Otherwise, has the exact same arguments as show_radial_menu |
| random_body_accessory | Returns a random body accessory for a given species name. Can be null based on is_optional argument. |
| 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 |
| remove_verb | handles removing verb and sending it to browser to update, use this for removing verbs |
| round_health | rounds value to limited symbols after the period for organ damage and other values |
| rustg_get_version | Gets the version of rust_g |
| rustg_redis_disconnect_rq | Disconnects from a previously connected redis server |
| rustg_unix_timestamp | Returns the timestamp as a string |
| safe_get_ckey | Safe ckey getter |
| sanitize_for_ic | sanitize() with a pre-set list of characters to remove from IC speech. |
| screen_loc_to_offset | Takes a screen loc string in the format +"+-left-offset:+-pixel,+-bottom-offset:+-pixel" +Where the :pixel is optional, and returns +A list in the format (x_offset, y_offset) +We require context to get info out of screen locs that contain relative info, so NORTH, SOUTH, etc |
| seconds_to_clock | Take a value in seconds and makes it display like a clock. Hours are stripped. (mm:ss) |
| seconds_to_full_clock | Take a value in seconds and makes it display like a clock (h:mm:ss) |
| seedify | Convert a grown object into seeds. |
| setup_mod_themes | Global proc that sets up all MOD themes as singletons in a list and returns it. |
| shake_camera | Shake the camera of the person viewing the mob SO REAL! |
| show_blurb | Shows a ticker reading out the given text on a client's screen. |
| spread_germs_by_incision | Spread germs directly from a tool. |
| spread_germs_to_organ | Spread some nasty germs to an organ. |
| start_unequip_mob | A utility function for /datum/strippable_items to start unequipping an item from a mob. |
| start_watch | Returns "watch handle" (really just a timestamp :V) |
| stop_watch | Returns number of seconds elapsed. +@param wh number The "Watch Handle" from start_watch(). (timestamp) |
| strip_html_tags | Strips HTML tags (and only tags) from the input. +The result may still include HTML entities, like ' for ' |
| tgui_Topic | Middleware for /client/Topic. |
| tgui_alert | Creates a TGUI alert window and returns the user's response. |
| tgui_input_list | Creates a TGUI input list window and returns the user's response. |
| tgui_input_number | Creates a TGUI window with a number input. Returns the user's response as num | null. |
| tgui_input_text | Creates a TGUI window with a text input. Returns the user's response. |
| 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. +trailing_newline, confidential, and handle_whitespace currently have no effect, please fix this in the future or remove the arguments to lower cache! |
| trim_length | Returns a string that does not exceed max_length characters in size |
| type_list_to_counted_assoc_list | This proc takes a list of types, and returns them in the format below. +[type] = amount of type in list. +Useful for recipes. |
| view_to_pixels | Takes a string or num view, and converts it to pixel width/height in a list(pixel_width, pixel_height) |
| wiki_link | Creates a hyperlink for a specified wiki article. |
Failsafe
+Pretty much pokes the MC to make sure it's still alive.
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
The subsystem used to play ambience to users every now and then, makes them real excited.
Copyright (c) 2020 Aleksej Komarov +SPDX-License-Identifier: MIT
For now, all it does is periodically clean the supplied global lists of any null values they may contain.
+Why is this important?
+Sometimes, these lists can gain nulls due to errors.
+For example, when a dead player trasitions from the dead_mob_list to the alive_mob_list, a null value may get stuck in the dead mob list.
+This can cause issues when other code tries to do things with the values in the list, but are instead met with null values.
+These problems are incredibly hard to track down and fix, so this subsystem is a solution to that.
Provides a centralised handler for persistent data reading and writing. +The subsystem does not do any actual spawning itself, as this focuses on objects and mobs +Should anything that is turf persistence related added in, that can be chucked into this SS +Its quite a simple subsystem. For now, anyways.
tgui subsystem
+Contains all tgui state and subsystem code.
+Copyright (c) 2020 Aleksej Komarov +SPDX-License-Identifier: MIT
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.
SSverb_manager, a subsystem that runs every tick and runs through its entire queue without yielding like SSinput. +this exists because of how the byond tick works and where user inputted verbs are put within it.
+see TICK_ORDER.md for more info on how the byond tick is structured.
+The way the MC allots its time is via TICK_LIMIT_RUNNING, it simply subtracts the cost of SendMaps (MAPTICK_LAST_INTERNAL_TICK_USAGE) +plus TICK_BYOND_RESERVE from the tick and uses up to that amount of time (minus the percentage of the tick used by the time it executes subsystems) +on subsystems running cool things like atmospherics or Life or SSInput or whatever.
+Without this subsystem, verbs are likely to cause overtime if the MC uses all of the time it has alloted for itself in the tick, and SendMaps +uses as much as its expected to, and an expensive verb ends up executing that tick. This is because the MC is completely blind to the cost of +verbs, it can't account for it at all. The only chance for verbs to not cause overtime in a tick where the MC used as much of the tick +as it alloted itself and where SendMaps costed as much as it was expected to is if the verb(s) take less than TICK_BYOND_RESERVE percent of +the tick, which isnt much. Not to mention if SendMaps takes more than 30% of the tick and the MC forces itself to take at least 70% of the +normal tick duration which causes ticks to naturally overrun even in the absence of verbs.
+With this subsystem, the MC can account for the cost of verbs and thus stop major overruns of ticks. This means that the most important subsystems +like SSinput can start at the same time they were supposed to, leading to a smoother experience for the player since ticks arent riddled with +minor hangs over and over again.
HTTP Get (Powered by RUSTG)
+This proc should be used as a replacement for [world.Export()] due to an underlying issue with it. +See: https://www.byond.com/forum/post/2772166 +The one thing you will need to be aware of is that this no longer wraps the response inside a "file", so anything that relies on a file2text() unwrap will need tweaking. +RUST HTTP also has better support for HTTPS as well as weird quirks with modern webservers. +Returns an assoc list that follows the standard [world.Export()] format (https://secure.byond.com/docs/ref/index.html#/world/proc/Export), with the above exception
+Arguments:
+TODO: Macro this to reduce proc overhead
Internal API Caller
+Makes calls to the internal Paradise API and returns a /datum/http_response.
+Arguments:
+Diagnostic HUDs!
queue a callback for the given verb/verblike proc and any given arguments to the specified verb subsystem, so that they process in the next tick. +intended to only work with verbs or verblike procs called directly from client input, use as part of TRY_QUEUE_VERB() and co.
+returns TRUE if the queuing was successful, FALSE otherwise.
Creates attack (old and new) logs for the user and defense logs for the target. +Will message admins depending on the custom_level, user and target.
+custom_level will determine the log level set. Unless the target is SSD and there is a user doing it +If custom_level is not set then the log level will be determined using the user and the target.
+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:
+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:
+We REALLY do not want un-addressed merge conflicts in maps for an +inexhaustible list of reasons. This should help ensure that this will not be +missed in case linters fail to catch it for any reason what-so-ever.
Outputs a message to the user describing the target's gasmixes. +Used in chat-based gas scans.
takes an input_key, as text, and the list of keys already used, outputting a replacement key in the format of "[input_key] ([number_of_duplicates])" if it finds a duplicate +use this for lists of things that might have the same name, like mobs or objects, that you plan on giving to a player as input
Creates a flashing effect that blinds and deafens mobs within range
+Arguments:
+Message Broadcast Proc
+This big fat disaster is responsible for sending the message out to all headsets and radios on the station +It is absolutely disgusting, but used to take about 20 arguments before I slimmed it down to just one +Arguments:
+Requires the holder to have all the rights specified
+rights_required = R_ADMIN|R_EVENT means they must have both flags, or it will return false
Proc to generate a "rank colour" from a client
+This takes the client and looks at various factors in order, such as patreon status, staff rank, and more +Arguments:
+compare two lists, returns TRUE if they are the same
Costlier version of icon2asset() that uses getFlatIcon() to account for overlays, underlays, etc. Use with extreme moderation, ESPECIALLY on mobs.
Creates an explosion of shrapnel at a turf.
+Creates an assoc list of keys to /datum/strippable_item
Takes a screen_loc string and cut out any directions like NORTH or SOUTH
Delete all existing SS to basically start over
Delete a timer
+Arguments:
+Will teleport the given atom to the given destination using the other parameters
+Arguments:
+Produces a mutable appearance glued to the EMISSIVE_PLANE dyed to be the EMISSIVE_COLOR. Order of application matters: Default generated blockers are overlays, and will block its own emissive underlays. If you want an object to be both a blocker, and have their own emissive, it has to be an overlay instead. Grayscale lightmasks are visible in the BYOND right-click and Examine pane, unless they're covered up by another overlay.
Produces a mutable appearance glued to the EMISSIVE_PLANE dyed to be the EM_BLOCK_COLOR.
Turns :ai: into an emoji in text.
Will cause an EMP on the given epicenter. +This proc can sleep depending on the affected objects. So assume it sleeps!
+epicenter - The center of the EMP. Can be an atom, as long as the given atom is on a turf (in)directly +heavy_range - The max distance from the epicenter where objects will be get heavy EMPed +light_range - The max distance from the epicenter where objects will get light EMPed +log - Whether or not this action should be logged or not. Will use the cause if provided +cause - The cause of the EMP. Used for the logging
A utility function for /datum/strippable_items to finish unequipping an item from a mob.
Flashfire is a proc used to log fire causing chemical reactions.
+Call this whenever you have a chemical reaction that makes fire flashes. +Arguments:
+Formats num with an SI prefix.
+Returns a string formatted with a multiple of num and an SI prefix corresponding to an exponent of 10. +Only considers exponents that are multiples of 3 (deca, deci, hecto, and centi are not included). +A unit is not included in the string, the prefix is placed after the number with no spacing added anywhere. +Listing of prefixes: https://en.wikipedia.org/wiki/Metric_prefix#List_of_SI_prefixes
Generates a filename for a given asset. +Like generate_asset_name(), except returns the rsc reference and the rsc file hash as well as the asset name (sans extension) +Used so that certain asset files dont have to be hashed twice
Allows admins to safely pick from SSticker.minds for objectives
+Proc to get a list of all the linked-together Z-Levels
+Returns a list of zlevel numbers which can be accessed from travelling space naturally
Get all non admin_only instruments as a list of text ids.
A proc that return an array of capitalized strings containing name of the antag types they are
+Arguments:
+A proc that return a string containing all the singled out antags . Empty string if not antag
+Usually, you'd return a FALSE, but since this is consumed by javascript you're in +for a world of hurt if you pass a byond FALSE which get converted into a fucking string anyway and pass for TRUE in check. Fuck. +It always append "(May be other antag)" +Arguments:
+Returns a list of atoms in a location of a given type. Can be refined to look for pixel-shift.
+Arguments:
+Get a bounding box of a list of atoms.
+Arguments:
+Returns: list(x1, y1, x2, y2)
Returns the clean name of an audio channel.
+Arguments:
+HEALTH ANALYZER
matches a string job name to their department(s) and returns it as a list
Gets a dummy savefile for usage in icon generation. +Savefiles generated from this proc will be empty.
Returns the turf located at the map edge in the specified direction relative to target_atom used for mass driver
Given an icon object, dmi file path, or atom/image/mutable_appearance, attempts to find and return an associated dmi file path. +A weird quirk about dm is that /icon objects represent both compile-time or dynamic icons in the rsc, +But stringifying rsc references returns a dmi file path +ONLY if that icon represents a completely unchanged dmi file from when the game was compiled. +So if the given object is associated with an icon that was in the rsc when the game was compiled, this returns a path. otherwise it returns ""
Get a list of turfs in a line from starting_atom to ending_atom.
Uses the ultra-fast Bresenham Line-Drawing Algorithm.
This proc returns every player with a client who is not a ghost or a new_player
This file contains the stuff you need for using JPS (Jump Point Search) pathing, an alternative to A* that skips +over large numbers of uninteresting tiles resulting in much quicker pathfinding solutions.
+This is the proc you use whenever you want to have pathfinding more complex than "try stepping towards the thing". +If no path was found, returns an empty list, which is important for bots like medibots who expect an empty list rather than nothing.
+Arguments:
+A special GetAllContents that doesn't search past things with rad insulation +Components which return COMPONENT_BLOCK_RADIATION prevent further searching into that object's contents. The object itself will get returned still. +The ignore list makes those objects never return at all
Get ranged target turf, but with direct targets as opposed to directions
+Starts at atom starting_atom and gets the exact angle between starting_atom and target +Moves from starting_atom with that angle, Range amount of times, until it stops, bound to map size +Arguments:
+Returns a list of names of non-blacklisted or hazardous species.
Returns a random reagent ID, with real non blacklisted balance boosting action!
Returns a valid location to place a screen object without overflowing the viewport
+Returns a screen loc representing the valid location
Returns a list of vents that can be used as a potential spawn if they meet the criteria set by the arguments
+Will not include parent-less vents to the returned list. +Arguments:
+Throws or pulls objects to/from a chem reaction
+Scales the amount of objects thrown with the volume, unless ignore_volume is TRUE
+Arguments:
+The dmi file path we attempt to return if the given object argument is associated with a stringifiable icon +If successful, this looks like "icons/path/to/dmi_file.dmi" +generate an asset for the given icon or the icon of the given appearance for [thing], and send it to any clients in target. +Arguments:
+Converts an icon to base64. Operates by putting the icon in the iconCache savefile, +exporting it as text, and then parsing the base64 from that. +(This relies on byond automatically storing icons in savefiles as base64)
Checks if the given iconstate exists in the given file, caching the result. Setting no_sprite to TRUE will print a stack trace ONCE.
Connection checker
+Checks the connection frequency against the intended frequency for the message +NOTE: I barely know what on earth this does, but it works and it scares me +Arguments:
+Given a color in the format of "#RRGGBB", will return if the color is dark.
ADMIN HELPER PROCS +A proc that return whether the mob is a "Special Character" aka Antagonist
+Arguments:
+If the list L contains a datum UID who's type matches D's type, returns the UID of that datum in the list. Otherwise returns null.
given a text string, returns whether it is a valid dmi icons folder path
Locates a datum based off of the UID
+Replacement for locate() which takes a UID instead of a ref +Returns the datum, if found
Initial Building
A proc for turning a list into an associative list.
+A simple proc for turning all things in a list into an associative list, instead +Each item in the list will have an associative value of TRUE
+Arguments:
+Save file as an external file then md5 it. +Used because md5ing files stored in the rsc sometimes gives incorrect md5 results.
Returns the md5 of a file at a given path.
Sends a message to the staff able to see admin tickets +Arguments: +msg - The message being send +important - If the message is important. If TRUE it will ignore the CHAT_NO_TICKETLOGS preferences, +send a sound and flash the window. Defaults to FALSE
Sends a message to the staff able to see mentor tickets +Arguments: +msg - The message being send +important - If the message is important. If TRUE it will ignore the CHAT_NO_TICKETLOGS preferences, +send a sound and flash the window. Defaults to FALSE
Message-related procs
+Message format (/list):
+code/__DEFINES/chat.dmCopyright (c) 2020 Aleksej Komarov +SPDX-License-Identifier: MIT
Takes a list in the form (x_offset, y_offset) +And converts it to a screen loc string +Accepts an optional view string/size to force the screen_loc around, so it can't go out of scope
Returns a turf based on text inputs, original turf and viewing client
This filter proc makes a visual effect where the object is split into fragments, with vertical lines cut out of them. It will appear as 2 seperate things are made of the one object that was cut out
Picks multiple unique elements from the suplied list. +If the given list has a length less than the amount given then it will return a list with an equal amount
+Arguments:
+returns a random non starting / kill crew lawset if the station has a unique ai lawset
Picks an element based on its weight. +L - The input list
+example: list("a" = 1, "b" = 2) will pick "b" 2/3s of the time
remove the old powernet and replace it with a new one throughout the network.
Similar to show_radial_menu, but choices is a list of atoms, for which icons will be automatically generated. +Supports multiple items of the same name, 2 soaps will become soap (1) and soap (2) to the user. +Otherwise, has the exact same arguments as show_radial_menu
Returns a random body accessory for a given species name. Can be null based on is_optional argument.
+Arguments:
+Recreate all SSs which will still cause data survive due to Recover(), the new Master will then find and take them from global.vars
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:
+rounds value to limited symbols after the period for organ damage and other values
Gets the version of rust_g
Disconnects from a previously connected redis server
Returns the timestamp as a string
Safe ckey getter
+Should be used whenever broadcasting public information about a mob, +as this proc will make a best effort to hide the users ckey if they request it. +It will first check the mob for a client, then use the mobs last ckey as a directory lookup. +If a client cant be found to check preferences on, it will just show as DC'd. +This proc should only be used for public facing stuff, not administration related things.
+Arguments:
+sanitize() with a pre-set list of characters to remove from IC speech.
Takes a screen loc string in the format +"+-left-offset:+-pixel,+-bottom-offset:+-pixel" +Where the :pixel is optional, and returns +A list in the format (x_offset, y_offset) +We require context to get info out of screen locs that contain relative info, so NORTH, SOUTH, etc
Take a value in seconds and makes it display like a clock. Hours are stripped. (mm:ss)
Take a value in seconds and makes it display like a clock (h:mm:ss)
Convert a grown object into seeds.
Global proc that sets up all MOD themes as singletons in a list and returns it.
Shake the camera of the person viewing the mob SO REAL!
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 = colour of the text. +blurb_key = a key used for specific blurb types so they are not shown repeatedly. +ignore_key = used to skip key checks. +text_limit = limit in characters of the message.
Spread germs directly from a tool.
+Spread some nasty germs to an organ.
+A utility function for /datum/strippable_items to start unequipping an item from a mob.
Returns "watch handle" (really just a timestamp :V)
Returns number of seconds elapsed. +@param wh number The "Watch Handle" from start_watch(). (timestamp)
Strips HTML tags (and only tags) from the input. +The result may still include HTML entities, like ' for '
Middleware for /client/Topic.
+return bool If TRUE, prevents propagation of the topic call.
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:
+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:
+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:
+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:
+Sends the message to the recipient (target).
+Recommended way to write to_chat calls:
+to_chat(client, "You have found <strong>[object]</strong>", MESSAGE_TYPE_INFO,
+Always remember to close spans! +TARGET: Refers to the target of the to_chat message. Valid targets include clients, mobs, and the static world controller +HTML: The Message to be sent to the TARGET. Converted to a string if not already one in this function +TYPE: The chat tab that this message will be sent to, a list of all valid types can be found in chat.dm +TEXT: Unused +AVOID_HIGHLIGHTING: Unused +trailing_newline, confidential, and handle_whitespace currently have no effect, please fix this in the future or remove the arguments to lower cache!
Circumvents the message queue and sends the message to the recipient (target) as soon as possible. +trailing_newline, confidential, and handle_whitespace currently have no effect, please fix this in the future or remove the arguments to lower cache!
Returns a string that does not exceed max_length characters in size
This proc takes a list of types, and returns them in the format below. +[type] = amount of type in list. +Useful for recipes.
Takes a string or num view, and converts it to pixel width/height in a list(pixel_width, pixel_height)
Creates a hyperlink for a specified wiki article.
blah.css with asset blah.png will get loaded as namespaces/a3d..14f/f12..d3c.css and namespaces/a3d..14f/blah.png. allowing the css file to load blah.png by a relative url rather then compute the generated url with get_url_mappings().
+The namespace folder's name will change if any of the assets change. (excluding parent assets)click_intercept variable.
+Used to override normal clicking behavior when clicking on an object.
+While active, a mob's ClickOn proc will redirect to the InterceptClickOn() proc instead.New() proc.
+When the living mob that has this datum middle-clicks or alt-clicks on something, the callback will be invoked.on_run to manipulate tile air safely.holder, as well as procs for choosing a colour and painting an atom.HasProximity() on the object which is listening for proximity (hasprox_receiver).Vars | |
| active_mutations | List of the active mutation types |
|---|---|
| alerts | lazy list. contains /atom/movable/screen/alert only, On /mob so clientless mobs will throw alerts properly |
| audio_emote_cd_status | Cooldown on audio effects from emotes. |
| audio_emote_unintentional_cd_status | Cooldown on audio effects from unintentional emotes. |
| blood_state | Weirdly named, effects how blood transfers onto objects |
| bloody_feet | Assoc list for tracking how "bloody" a mobs feet are, used for creating bloody foot/shoeprints on turfs when moving |
| bloody_hands | Makes items bloody if you touch them |
| buckled | movable atoms buckled to this mob |
| buckling | movable atom we are buckled to |
| emote_cooldown_override | Override for cooldowns on non-audio emotes. Should be a number in deciseconds. |
| emotes_used | Tracks last uses of emotes for cooldown purposes |
| feet_blood_DNA | Basically a lazy list, copies the DNA of blood you step in |
| feet_blood_color | affects the blood color of your feet, color taken from the blood you step in |
| hand | True for left hand active, otherwise for right hand active |
| health_hud_override | Overrides the health HUD element state if set. |
| hud_type | The type of HUD that this mob uses. Not to |
| hud_used | The instantiated version of the mob's hud. |
| input_focus | The datum receiving keyboard input. parent mob by default. |
| last_movement_dir | The direction they last moved |
| last_typed | Last thing we typed in to the typing indicator, probably does not need to exist |
| last_typed_time | Last time we typed something in to the typing popup |
| memory | other mobs we wont move when we're grab pulled. Not empty only when being grab pulled |
| next_click | This is mainly modified by click code, to modify click delays elsewhere, use next_move and changeNext_move(), Controls the click delay. Changed with |
| next_click_adjust | Unused |
| next_click_modifier | Unused |
| next_move_adjust | Unused, used to adjust our next move on a linar skill world.time + (how_many_deciseconds + Next move adjust) = Next move |
| next_move_modifier | Value to multiply action delays by, actually used world.time + (how_many_deciseconds * Next move Adjust) = Next move |
| observers | List of observers currently observing us. |
| open_uis | Tracks the open UIs that a mob has, used in TGUI for various things, such as updating UIs |
| runechat_msg_location | A soft reference to the location where this mob's runechat message will appear. Uses UID(). |
| s_active | Active storage container |
| screens | Used for some screen objects |
| sound_environment_override | Override for sound_environments. If this is set the user will always hear a specific type of reverb (Instead of the area defined reverb) |
| speaks_ooc | Does this mob speak OOC? +Controls whether they can say some symbols. |
| suiciding | Is our mob currently suiciding? Used for suicide code along with many different revival checks |
| tgui_open_uis | global |
| thinking | Affects if you have a thinking indicator |
| typing | Affects if you have a typing indicator |
| zone_selected | The zone this mob is currently targeting |
Procs | |
| ForceContractDisease | Forces the mob to contract a virus. If the mob can have viruses. Ignores clothing and other protection +Returns TRUE if it succeeds. False if it doesn't |
| Process_Spacemove | Process_Spacemove +Called by /client/Move() +For moving in space +Return 1 for movement 0 for none |
| adjust_nutrition | Adjust the nutrition of a mob |
| become_mouse | Returns true if the player successfully becomes a mouse |
| buckle_mob | Buckle to another mob |
| can_buckle | can the mob be buckled to something by default? |
| can_resist | Can this mob resist (default FALSE) |
| can_unbuckle | can the mob be unbuckled from something by default? |
| can_use_audio_emote | Helper proc to determine if a mob can use emotes that make sound or not. |
| can_use_clickbinds | Can this mob use keybinded click actions? (Altclick, Ctrlclick, ect) |
| create_chat_message | Creates a message overlay at a defined location for a given speaker |
| custom_emote | Perform a custom emote. |
| emote | Send an emote. |
| flash_screen_color | Flash up a color as an overlay on a player's screen, then fade back to normal. |
| get_mob_buckling_height | returns the height in pixel the mob should have when buckled to another mob. |
| get_telepathic_targets | Returns an assoc list which contains the mobs in range and their "visible" name. +Mobs out of view but in range will be listed as unknown. Else they will have their visible name |
| ghost_can_reenter | Checks if a mob's ghost can reenter their body or not. Used to check for DNR or AntagHUD. |
| hide_other_mob_action_buttons | Hide another mob's action buttons from this mob |
| is_holding | Check if an item is in one of our hands |
| manual_emote | Allows the intrepid coder to send a basic emote +Takes text as input, sends it out to those who need to know after some light parsing +If you need something more complex, make it into a datum emote +Arguments: |
| on_observing_action_granted | Signal proc for COMSIG_MOB_GRANTED_ACTION - If we're viewing another mob's action buttons, +we need to update with any newly added buttons granted to the mob. |
| on_observing_action_removed | Signal proc for COMSIG_MOB_REMOVED_ACTION - If we're viewing another mob's action buttons, +we need to update with any removed buttons from the mob. |
| pointed | Point at an atom |
| post_buckle_mob | Call back post buckle to a mob to offset your visual height |
| post_unbuckle_mob | Call back post unbuckle from a mob, (reset your visual height here) |
| run_mode | proc version to finish /mob/verb/mode() execution. used in case the proc needs to be queued for the tick after its first called |
| run_pointed | possibly delayed verb that finishes the pointing process starting in [/mob/verb/pointed()]. +either called immediately or in the tick after pointed() was called, as per the [DEFAULT_QUEUE_OR_CALL_VERB()] macro |
| run_quick_equip | proc extender of [/mob/verb/quick_equip] used to make the verb queuable if the server is overloaded |
| say_understands | Checks if the mob can understand the other speaker |
| set_invisible | Proc to PROPERLY set mob invisibility, huds gotta get set too! |
| set_nutrition | Force set the mob nutrition |
| set_thinking_indicator | Toggles the floating thought bubble above a players head. |
| set_typing_indicator | Toggles the floating chat bubble above a players head. |
| shared_ui_interaction | public |
| show_other_mob_action_buttons | Show (most) of the another mob's action buttons to this mob |
| show_rads | Show an overlay of radiation levels on radioactive objects. |
| shuttleRotate | Turf rotate procs |
| special_get_hands_check | Specal proc for special mobs that use "hands" in weird ways |
| start_audio_emote_cooldown | Start the cooldown for an emote that plays audio. |
| throw_alert | Proc to create or update an alert. Returns the alert if the alert is new or updated, 0 if it was thrown already. +Each mob may only have one alert per category. |
| update_runechat_msg_location | Updates the mob's runechat maptext display location. |
| usable_emote_keys | Get a list of all emote keys usable by the current mob. |
List of the active mutation types
lazy list. contains /atom/movable/screen/alert only, On /mob so clientless mobs will throw alerts properly
Cooldown on audio effects from emotes.
Cooldown on audio effects from unintentional emotes.
Weirdly named, effects how blood transfers onto objects
Assoc list for tracking how "bloody" a mobs feet are, used for creating bloody foot/shoeprints on turfs when moving
Makes items bloody if you touch them
movable atoms buckled to this mob
movable atom we are buckled to
Override for cooldowns on non-audio emotes. Should be a number in deciseconds.
Tracks last uses of emotes for cooldown purposes
Basically a lazy list, copies the DNA of blood you step in
affects the blood color of your feet, color taken from the blood you step in
True for left hand active, otherwise for right hand active
Overrides the health HUD element state if set.
The type of HUD that this mob uses. Not to
The instantiated version of the mob's hud.
The datum receiving keyboard input. parent mob by default.
The direction they last moved
Last thing we typed in to the typing indicator, probably does not need to exist
Last time we typed something in to the typing popup
other mobs we wont move when we're grab pulled. Not empty only when being grab pulled
This is mainly modified by click code, to modify click delays elsewhere, use next_move and changeNext_move(), Controls the click delay. Changed with
Unused
Unused
Unused, used to adjust our next move on a linar skill world.time + (how_many_deciseconds + Next move adjust) = Next move
Value to multiply action delays by, actually used world.time + (how_many_deciseconds * Next move Adjust) = Next move
List of observers currently observing us.
Tracks the open UIs that a mob has, used in TGUI for various things, such as updating UIs
A soft reference to the location where this mob's runechat message will appear. Uses UID().
Active storage container
Used for some screen objects
Override for sound_environments. If this is set the user will always hear a specific type of reverb (Instead of the area defined reverb)
Does this mob speak OOC? +Controls whether they can say some symbols.
Is our mob currently suiciding? Used for suicide code along with many different revival checks
global
+Tracks open UIs for a user.
Affects if you have a thinking indicator
Affects if you have a typing indicator
The zone this mob is currently targeting
Forces the mob to contract a virus. If the mob can have viruses. Ignores clothing and other protection +Returns TRUE if it succeeds. False if it doesn't
+Arguments:
+Process_Spacemove +Called by /client/Move() +For moving in space +Return 1 for movement 0 for none
Adjust the nutrition of a mob
Returns true if the player successfully becomes a mouse
Buckle to another mob
+You can buckle on mobs if you're next to them since most are dense
+Turns you to face the other mob too
can the mob be buckled to something by default?
Can this mob resist (default FALSE)
can the mob be unbuckled from something by default?
Helper proc to determine if a mob can use emotes that make sound or not.
Can this mob use keybinded click actions? (Altclick, Ctrlclick, ect)
Creates a message overlay at a defined location for a given speaker
+Arguments:
+Perform a custom emote.
+Send an emote.
+Flash up a color as an overlay on a player's screen, then fade back to normal.
+Arguments:
+returns the height in pixel the mob should have when buckled to another mob.
Returns an assoc list which contains the mobs in range and their "visible" name. +Mobs out of view but in range will be listed as unknown. Else they will have their visible name
Checks if a mob's ghost can reenter their body or not. Used to check for DNR or AntagHUD.
+Returns FALSE if there is a ghost, and it can't reenter the body. Returns TRUE otherwise.
Hide another mob's action buttons from this mob
+Used for observers viewing another mob's screen
Check if an item is in one of our hands
Allows the intrepid coder to send a basic emote +Takes text as input, sends it out to those who need to know after some light parsing +If you need something more complex, make it into a datum emote +Arguments:
+Returns TRUE if it was able to run the emote, FALSE otherwise.
Signal proc for COMSIG_MOB_GRANTED_ACTION - If we're viewing another mob's action buttons, +we need to update with any newly added buttons granted to the mob.
Signal proc for COMSIG_MOB_REMOVED_ACTION - If we're viewing another mob's action buttons, +we need to update with any removed buttons from the mob.
Point at an atom
+mob verbs are faster than object verbs. See +this byond forum post +for why this isn't atom/verb/pointed()
+note: ghosts can point, this is intended
+visible_message will handle invisibility properly
+overridden here and in /mob/dead/observer for different point span classes and sanity checks
Call back post buckle to a mob to offset your visual height
Call back post unbuckle from a mob, (reset your visual height here)
proc version to finish /mob/verb/mode() execution. used in case the proc needs to be queued for the tick after its first called
possibly delayed verb that finishes the pointing process starting in [/mob/verb/pointed()]. +either called immediately or in the tick after pointed() was called, as per the [DEFAULT_QUEUE_OR_CALL_VERB()] macro
proc extender of [/mob/verb/quick_equip] used to make the verb queuable if the server is overloaded
Checks if the mob can understand the other speaker
+If it return FALSE, then the message will have some letters replaced with stars from the heard message
Proc to PROPERLY set mob invisibility, huds gotta get set too!
Force set the mob nutrition
Toggles the floating thought bubble above a players head.
+Arguments:
+Toggles the floating chat bubble above a players head.
+Arguments:
+public
+Standard interaction/sanity checks. Different mob types may have overrides.
+return UI_state The state of the UI.
Show (most) of the another mob's action buttons to this mob
+Used for observers viewing another mob's screen
Show an overlay of radiation levels on radioactive objects.
Turf rotate procs
+Mob rotate procs
Specal proc for special mobs that use "hands" in weird ways
Start the cooldown for an emote that plays audio.
+Arguments:
+Proc to create or update an alert. Returns the alert if the alert is new or updated, 0 if it was thrown already. +Each mob may only have one alert per category.
+Arguments:
+Updates the mob's runechat maptext display location.
+By default, we set this to the src mob's UID().
Get a list of all emote keys usable by the current mob.
+Vars | |
| allowed_area | Area that the xenobio camera eye is allowed to travel |
|---|---|
Area that the xenobio camera eye is allowed to travel
Vars | |
| alive_runechat_color | The "color" their runechat would have had |
|---|---|
| data_hud_seen | Defines from __DEFINES/hud.dm go here based on which huds the ghost has activated. |
| gas_scan | toggle for ghost gas analyzer |
| mob_observed | UID of the mob which we are currently observing |
| plant_analyzer | toggle for ghost plant analyzer |
Procs | |
| check_ahud_rejoin_eligibility | Check if a player has antag-hudded, and if so, if they can rejoin. +Returns TRUE if the player can rejoin, and FALSE if the player is ineligible to rejoin. +If allow_roundstart_observers is FALSE (TRUE by default), then any observers who were able to ahud due to joining roundstart will be excluded as well. |
| cleanup_observe | Clean up observing |
| toggle_all_huds_off | Toggles off all HUDs for the ghost player. |
| toggle_all_huds_on | Toggles on all HUDs for the ghost player. |
The "color" their runechat would have had
Defines from __DEFINES/hud.dm go here based on which huds the ghost has activated.
toggle for ghost gas analyzer
UID of the mob which we are currently observing
toggle for ghost plant analyzer
Check if a player has antag-hudded, and if so, if they can rejoin. +Returns TRUE if the player can rejoin, and FALSE if the player is ineligible to rejoin. +If allow_roundstart_observers is FALSE (TRUE by default), then any observers who were able to ahud due to joining roundstart will be excluded as well.
Clean up observing
Toggles off all HUDs for the ghost player.
Toggles on all HUDs for the ghost player.
+Enables antag HUD only if the ghost belongs to an admin.
+Arguments:
+src does not have a client at this point.Vars | |
| admin_prev_sleeping | Used for keeping track of previous sleeping value with admin freeze. |
|---|---|
| advanced_bullet_dodge_chance | This variable is the chance for a mob to automatically dodge a bullet. Useful for admins, and applied to some mobs by default, such as the malfunctioning drone mobs. |
| flags_2 | Flag to enable these making trees semi-transparent if behind them |
| forced_look | This can either be a numerical direction or a soft object reference (UID). It makes the mob always face towards the selected thing. |
| frozen | Used for preventing attacks on admin-frozen mobs. |
| holder_type | the type of holder that will be created when a mob gets scooped up |
| incorporeal_move | Allows mobs to move through dense areas without restriction. For instance, in space or out of holder objects. |
| last_taste_text | Stores a var of the last tast message we got. used so we don't spam people messages while they eat |
| last_taste_time | Stores a var of the last world time we tasted something. used so we don't spam people messages while they eat |
| last_words | Famous last words -- if succumbing, what the user's last words were |
| lying_angle | Number of degrees of rotation of a mob. 0 means no rotation, up-side facing NORTH. 90 means up-side rotated to face EAST, and so on. |
| resting | if a mob is choosing to lay down |
| stamina_regen_block_modifier | A multiplier for the ammount of time it takes for someone to regenerate stamina damage. |
Procs | |
| AdjustConfused | Sets confusion to current amount + given, clamped between lower and higher bounds. |
| AdjustDizzy | Sets dizziness to current amount + given, clamped between lower and higher bounds. |
| AdjustDrowsy | Sets drowsiness to current amount + given, clamped between lower and higher bounds. |
| AdjustDrunk | Sets drunkenness to current amount + given, clamped between lower and higher bounds. |
| AdjustSleeping | used for admin freezing. |
| Confused | Sets confusion if it's higher than current. |
| Dizzy | Sets dizziness if it's higher than current. |
| Drowsy | Sets drowsiness if it's higher than current. |
| Drunk | Sets drunkenness if it's higher than current. |
| IsFrozen | FROZEN |
| SetConfused | Sets confusion if it's higher than zero. |
| SetDizzy | Sets dizziness if it's higher than zero. |
| SetDrowsy | Sets drowsiness if it's higher than zero. |
| SetDrunk | Sets drunkenness if it's higher than zero. |
| add_stun_absorption | STUN ABSORPTION |
| admin_Freeze | mob freeze procs |
| advanced_bullet_dodge | Tries to dodge incoming bullets if we aren't disabled for any reasons. Advised to overide with advanced effects, this is as basic example admins can apply. |
| apply_status_effect | Applies a given status effect to this mob, returning the effect if it was successful or null otherwise |
| can_run_surgery | Check to see if a surgical operation proposed on ourselves is valid or not. We are the target of the surgery |
| clear_forced_look | Clears the mob's direction lock if enabled. |
| electrocute_act | As the name suggests, this should be called to apply electric shocks. |
| get_confusion | Returns current amount of confusion, 0 if none. |
| get_dizziness | Returns current amount of dizziness, 0 if none. |
| get_drowsiness | Returns current amount of drowsiness, 0 if none. |
| get_drunkenness | Returns current amount of drunkenness, 0 if none. |
| grant_guardian_actions | Grants all existing /datum/action/guardian type actions to the src mob. |
| handle_fire | Burns a mob and slowly puts the fires out. Returns TRUE if the mob is on fire |
| has_status_effect | Returns the effect if the mob calling the proc owns the given status effect, or null otherwise |
| has_status_effect_list | Returns a list of effects with matching IDs that the mod owns; use for effects there can be multiple of |
| has_status_effect_type | Returns the effect if the mob calling the proc owns the given status effect, but checks by type. |
| on_fakedeath_trait_gain | Called when [TRAIT_FAKEDEATH] is added to the mob. |
| on_fakedeath_trait_loss | Called when [TRAIT_FAKEDEATH] is removed from the mob. |
| on_floored_trait_gain | Called when TRAIT_FLOORED is added to the mob. |
| on_floored_trait_loss | Called when TRAIT_FLOORED is removed from the mob. |
| on_forced_standing_trait_gain | Called when [TRAIT_FORCED_STANDING] is added to the mob. |
| on_forced_standing_trait_loss | Called when [TRAIT_FORCED_STANDING] is removed from the mob. |
| on_handsblocked_trait_gain | Called when TRAIT_HANDS_BLOCKED is added to the mob. |
| on_handsblocked_trait_loss | Called when TRAIT_HANDS_BLOCKED is removed from the mob. |
| on_immobilized_trait_gain | Called when TRAIT_IMMOBILIZED is added to the mob. |
| on_immobilized_trait_loss | Called when TRAIT_IMMOBILIZED is removed from the mob. |
| on_knockedout_trait_gain | Called when TRAIT_KNOCKEDOUT is added to the mob. |
| on_knockedout_trait_loss | Called when TRAIT_KNOCKEDOUT is removed from the mob. |
| on_pull_blocked_trait_gain | Called when TRAIT_CANNOT_PULL is added to the mob. |
| on_pull_blocked_trait_loss | Called when TRAIT_CANNOT_PULL is removed from the mob. |
| on_restrained_trait_gain | Called when TRAIT_RESTRAINED is added to the mob. |
| on_restrained_trait_loss | Called when TRAIT_RESTRAINED is removed from the mob. |
| on_ui_blocked_trait_gain | Called when TRAIT_UI_BLOCKED is added to the mob. |
| on_ui_blocked_trait_loss | Called when TRAIT_UI_BLOCKED is removed from the mob. |
| register_init_signals | Called on /mob/living/Initialize(mapload), for the mob to register to relevant signals. |
| remove_guardian_actions | Removes all /datum/action/guardian type actions from the src mob. |
| remove_status_effect | Removes all of a given status effect from this mob, returning TRUE if at least one was removed |
| run_resist | proc extender of [/mob/living/verb/resist] meant to make the process queable if the server is overloaded when the verb is called |
| set_forced_look | Sets the mob's direction lock towards a given atom. |
| set_lying_angle | Changes the inclination angle of a mob, used by humans and others to differentiate between standing up and prone positions. |
| shared_living_ui_distance | public |
| transfer_blood_to | BLOOD TRANSFERS |
Used for keeping track of previous sleeping value with admin freeze.
This variable is the chance for a mob to automatically dodge a bullet. Useful for admins, and applied to some mobs by default, such as the malfunctioning drone mobs.
Flag to enable these making trees semi-transparent if behind them
This can either be a numerical direction or a soft object reference (UID). It makes the mob always face towards the selected thing.
Used for preventing attacks on admin-frozen mobs.
the type of holder that will be created when a mob gets scooped up
Allows mobs to move through dense areas without restriction. For instance, in space or out of holder objects.
Stores a var of the last tast message we got. used so we don't spam people messages while they eat
Stores a var of the last world time we tasted something. used so we don't spam people messages while they eat
Famous last words -- if succumbing, what the user's last words were
Number of degrees of rotation of a mob. 0 means no rotation, up-side facing NORTH. 90 means up-side rotated to face EAST, and so on.
if a mob is choosing to lay down
A multiplier for the ammount of time it takes for someone to regenerate stamina damage.
Sets confusion to current amount + given, clamped between lower and higher bounds.
+Arguments:
+Sets dizziness to current amount + given, clamped between lower and higher bounds.
+Arguments:
+Sets drowsiness to current amount + given, clamped between lower and higher bounds.
+Arguments:
+Sets drunkenness to current amount + given, clamped between lower and higher bounds.
+Arguments:
+used for admin freezing.
Sets confusion if it's higher than current.
Sets dizziness if it's higher than current.
Sets drowsiness if it's higher than current.
Sets drunkenness if it's higher than current.
FROZEN
Sets confusion if it's higher than zero.
Sets dizziness if it's higher than zero.
Sets drowsiness if it's higher than zero.
Sets drunkenness if it's higher than zero.
STUN ABSORPTION
mob freeze procs
Tries to dodge incoming bullets if we aren't disabled for any reasons. Advised to overide with advanced effects, this is as basic example admins can apply.
Applies a given status effect to this mob, returning the effect if it was successful or null otherwise
Check to see if a surgical operation proposed on ourselves is valid or not. We are the target of the surgery
Clears the mob's direction lock if enabled.
+Arguments:
+As the name suggests, this should be called to apply electric shocks.
Returns current amount of confusion, 0 if none.
Returns current amount of dizziness, 0 if none.
Returns current amount of drowsiness, 0 if none.
Returns current amount of drunkenness, 0 if none.
Grants all existing /datum/action/guardian type actions to the src mob.
Called whenever the host gains their gauardian.
Burns a mob and slowly puts the fires out. Returns TRUE if the mob is on fire
Returns the effect if the mob calling the proc owns the given status effect, or null otherwise
Returns a list of effects with matching IDs that the mod owns; use for effects there can be multiple of
Returns the effect if the mob calling the proc owns the given status effect, but checks by type.
Called when [TRAIT_FAKEDEATH] is added to the mob.
Called when [TRAIT_FAKEDEATH] is removed from the mob.
Called when TRAIT_FLOORED is added to the mob.
Called when TRAIT_FLOORED is removed from the mob.
Called when [TRAIT_FORCED_STANDING] is added to the mob.
Called when [TRAIT_FORCED_STANDING] is removed from the mob.
Called when TRAIT_HANDS_BLOCKED is added to the mob.
Called when TRAIT_HANDS_BLOCKED is removed from the mob.
Called when TRAIT_IMMOBILIZED is added to the mob.
Called when TRAIT_IMMOBILIZED is removed from the mob.
Called when TRAIT_KNOCKEDOUT is added to the mob.
Called when TRAIT_KNOCKEDOUT is removed from the mob.
Called when TRAIT_CANNOT_PULL is added to the mob.
Called when TRAIT_CANNOT_PULL is removed from the mob.
Called when TRAIT_RESTRAINED is added to the mob.
Called when TRAIT_RESTRAINED is removed from the mob.
Called when TRAIT_UI_BLOCKED is added to the mob.
Called when TRAIT_UI_BLOCKED is removed from the mob.
Called on /mob/living/Initialize(mapload), for the mob to register to relevant signals.
Removes all /datum/action/guardian type actions from the src mob.
Called whenever the host loses their guardian.
Removes all of a given status effect from this mob, returning TRUE if at least one was removed
proc extender of [/mob/living/verb/resist] meant to make the process queable if the server is overloaded when the verb is called
Sets the mob's direction lock towards a given atom.
+Arguments:
+Changes the inclination angle of a mob, used by humans and others to differentiate between standing up and prone positions.
+In BYOND-angles 0 is NORTH, 90 is EAST, 180 is SOUTH and 270 is WEST. +This usually means that 0 is standing up, 90 and 270 are horizontal positions to right and left respectively, and 180 is upside-down. +Mobs that do now follow these conventions due to unusual sprites should require a special handling or redefinition of this proc, due to the density and layer changes. +The return of this proc is the previous value of the modified lying_angle if a change was successful (might include zero), or null if no change was made.
public
+Distance versus interaction check.
+required src_object atom/movable The object which owns the UI.
+return UI_state The state of the UI.
BLOOD TRANSFERS
Vars | |
| co2overloadtime | Used to track how much CO2 is in our system. Too much CO2 means you get stunned and die |
|---|---|
| dreaming | How many dream messages we have left to send |
| handcuffed | Whether or not the mob is handcuffed, restraints/handcuffs/ required for var/cuffed_state |
| head | The object stored on the head of the mob. Strangly not on the Human level |
| internal_organ_datums | An associated list of strings that associate it with the organ datum, e.g. [ORGAN_DATUM_HEART] = /datum/organ/heart |
| last_pain_message | Stores the last pain message we got. used to prevent chatspam from pain |
| legcuffed | Same as handcuffs but for legs. Bear traps use this. |
| life_tick | The amount of life ticks that have processed on this mob. |
| next_pain_time | Stores the last time we sent a pain message. used to prevent chatspam from pain |
| nightmare | How many nightmare messages we have left to send |
| pose | Active emote/pose. Similar to flavor text |
| pulse | Current pulse of this mob. Updated by handle_pulse on life |
| wear_suit | The object stored on the exosuit slot of the mob. Strangly not on the Human level |
| wetlevel | Tracks how wet the mob is. Only used for examining the mob |
Procs | |
| can_breathe_helmet | Returns TRUE if an air tank compatible helmet is equipped. |
| can_breathe_internals | Returns TRUE if an air tank compatible mask or breathing tube is equipped. |
| can_breathe_mask | Returns TRUE if an air tank compatible mask is equipped. |
| can_breathe_tube | Returns TRUE if a breathing tube is equipped. |
| can_feel_pain | Whether or not a mob can feel pain. |
| dream | DREAMS |
| electrocute_act | Adds to the parent by also adding functionality to propagate shocks through pulling and doing some fluff effects. |
| examine_damage_flavor | Add specific damage flavor here. |
| examine_extra_damage_flavor | Add any extra info which should be within the "damage" block, the big warning span. |
| examine_extra_general_flavor | Add some last information in before HUDs get put through. |
| examine_handle_individual_limb | Special handlers for processing limbs go here, based on limb names in examine_visible_clothing. |
| examine_start_damage_block | Add whatever you want to start the damage block with here. |
| examine_visible_clothing | Get the message parts, in order, for a proper examine. +Message parts should be as follows: |
| examine_what_am_i | Identify what this mob in particular is. |
| has_virus | Whether a virus worthy displaying on the HUD is present. |
| is_in_crit | Medical HUD! Basic mode needs suit sensors on. +Whether the carbon mob is currently in crit. |
| pat_out | Handles patting out a fire on someone. |
| secondary_shock | Called slightly after electrocute act to reduce jittering and apply a secondary knockdown. |
| toggle_give | Toggles the /datum/click_intercept/give on or off for the src mob. |
| update_suit_sensors | HOOKS |
Used to track how much CO2 is in our system. Too much CO2 means you get stunned and die
How many dream messages we have left to send
Whether or not the mob is handcuffed, restraints/handcuffs/ required for var/cuffed_state
The object stored on the head of the mob. Strangly not on the Human level
An associated list of strings that associate it with the organ datum, e.g. [ORGAN_DATUM_HEART] = /datum/organ/heart
Stores the last pain message we got. used to prevent chatspam from pain
Same as handcuffs but for legs. Bear traps use this.
The amount of life ticks that have processed on this mob.
Stores the last time we sent a pain message. used to prevent chatspam from pain
How many nightmare messages we have left to send
Active emote/pose. Similar to flavor text
Current pulse of this mob. Updated by handle_pulse on life
The object stored on the exosuit slot of the mob. Strangly not on the Human level
Tracks how wet the mob is. Only used for examining the mob
Returns TRUE if an air tank compatible helmet is equipped.
Returns TRUE if an air tank compatible mask or breathing tube is equipped.
Returns TRUE if an air tank compatible mask is equipped.
Returns TRUE if a breathing tube is equipped.
Whether or not a mob can feel pain.
+Returns TRUE if the mob can feel pain, FALSE otherwise
DREAMS
Adds to the parent by also adding functionality to propagate shocks through pulling and doing some fluff effects.
Add specific damage flavor here.
Add any extra info which should be within the "damage" block, the big warning span.
Add some last information in before HUDs get put through.
Special handlers for processing limbs go here, based on limb names in examine_visible_clothing.
Add whatever you want to start the damage block with here.
Get the message parts, in order, for a proper examine. +Message parts should be as follows:
+Arguments represent whether to skip a certain slot when handling the message.
Identify what this mob in particular is.
Whether a virus worthy displaying on the HUD is present.
Medical HUD! Basic mode needs suit sensors on. +Whether the carbon mob is currently in crit.
Handles patting out a fire on someone.
+Removes 0.5 fire stacks per pat, with a 30% chance of the user burning their hand if they don't have adequate heat resistance. +Arguments:
+Called slightly after electrocute act to reduce jittering and apply a secondary knockdown.
Toggles the /datum/click_intercept/give on or off for the src mob.
HOOKS
Procs | |
| get_caste_organs | returns the list of type paths of the organs that we need to insert into +this particular xeno upon its creation |
|---|---|
returns the list of type paths of the organs that we need to insert into +this particular xeno upon its creation
Vars | |
| on_leap_cooldown | Are we on leap cooldown? |
|---|---|
Are we on leap cooldown?
Vars | |
| body_type | The body type associated with the body |
|---|---|
| bodyparts_by_name | map organ names to organs |
| height | Players' height (more fluff) |
| physique | Players physique (even MORE fluff) |
| previous_damage_appearance | Stores what the body last looked like. Prevents updating the body when we don't need to |
| receiving_cpr_from | UID of the person who is giving this mob CPR. |
| tail | Name of tail image in species effects icon file. |
| wing | Same as tail but wing |
Procs | |
| Robotize | For transforming humans into robots (cyborgs). |
| add_comment | Helper function to add a "comment" to a data record. Used for medical or security records. |
| adjustBrainLoss | sums up all the damage of all the limbs |
| check_eye_prot | check_eye_prot() +Returns a number between -1 to 2 |
| check_vital_organs | Returns true if all the mob's vital organs are functional, otherwise returns false |
| electrocute_act | Calculates the siemens coeff based on clothing and species, can also restart hearts. |
| get_cpr_timer_adjustment | Get the amount of time that this round of CPR should add to the death timer |
| get_runechat_color | Helper to get the mobs runechat colour span |
| handle_fire | FIRE CODE |
| mind_checks | Handles any adjustments to the mob after a mind transfer. |
| regrow_external_limb_if_missing | Regrows a given external limb if it is missing. Does not add internal organs back in. +Returns whether or not it regrew the limb |
| sec_hud_set_ID | Security HUDs! Basic mode shows only the job. |
| set_species | Change a mob's species. |
| setup_dna | Sets up DNA and species. |
| setup_other | Sets up other variables and components that may be needed for gameplay. |
| tintcheck | tintcheck() +Checks eye covering items for visually impairing tinting, such as welding masks +Checked in life.dm. 0 & 1 = no impairment, 2 = welding mask overlay, 3 = You can see jack, but you can't see shit. |
| update_hair | Generates overlays for the hair layer. |
The body type associated with the body
map organ names to organs
Players' height (more fluff)
Players physique (even MORE fluff)
Stores what the body last looked like. Prevents updating the body when we don't need to
UID of the person who is giving this mob CPR.
Name of tail image in species effects icon file.
Same as tail but wing
For transforming humans into robots (cyborgs).
+Arguments:
+Helper function to add a "comment" to a data record. Used for medical or security records.
sums up all the damage of all the limbs
check_eye_prot() +Returns a number between -1 to 2
Returns true if all the mob's vital organs are functional, otherwise returns false
Calculates the siemens coeff based on clothing and species, can also restart hearts.
Get the amount of time that this round of CPR should add to the death timer
Helper to get the mobs runechat colour span
+Basically just a quick redirect to the DNA handler that gets the species-specific colour handler
FIRE CODE
Handles any adjustments to the mob after a mind transfer.
Regrows a given external limb if it is missing. Does not add internal organs back in. +Returns whether or not it regrew the limb
+Arguments:
+Security HUDs! Basic mode shows only the job.
Change a mob's species.
+Arguments:
+Sets up DNA and species.
+Arguments:
+Sets up other variables and components that may be needed for gameplay.
tintcheck() +Checks eye covering items for visually impairing tinting, such as welding masks +Checked in life.dm. 0 & 1 = no impairment, 2 = welding mask overlay, 3 = You can see jack, but you can't see shit.
Generates overlays for the hair layer.
Vars | |
| return_timer | Stores the timer ID of the timer that happens in Life() to prevent multiple of the same timer happening. |
|---|---|
Stores the timer ID of the timer that happens in Life() to prevent multiple of the same timer happening.
Vars | |
| is_centered | For cyborgs with wide "heads", when false causes the hat icon to be stretched. |
|---|---|
Procs | |
| can_hear | EAR DAMAGE |
| place_on_head | Attempts to put an item on a silicon's head. |
| remove_from_head | Attempts to remove any hats a silicon is wearing. |
| run_armor | returns the damage value of the attack after processing the silicons's various armor protections |
| subsystem_atmos_control | Atmos Control |
| subsystem_crew_monitor | Crew Monitor |
| subsystem_law_manager | Law Manager |
| subsystem_power_monitor | Power Monitor |
For cyborgs with wide "heads", when false causes the hat icon to be stretched.
EAR DAMAGE
Attempts to put an item on a silicon's head.
+Arguments:
+Attempts to remove any hats a silicon is wearing.
+Arguments:
+returns the damage value of the attack after processing the silicons's various armor protections
Atmos Control
Crew Monitor
Law Manager
Power Monitor
Vars | |
| ai_announcement_string_menu | The cached AI annoucement help menu. |
|---|---|
| allow_teleporter | If true, this AI core can use the teleporter. |
| announce_arrivals | If our AI doesn't want to be the arrivals announcer, this gets set to FALSE. |
| cracked_camera | Set to true if the AI cracks it's camera by using the malf ability |
| purchased_modules | List of modules the AI has purchased malf upgrades for. |
| turrets_upgraded | Whether or not the AI has upgraded their turrets |
Procs | |
| remove_malf_abilities | Removes all malfunction-related /datum/action's from the target AI. |
The cached AI annoucement help menu.
If true, this AI core can use the teleporter.
If our AI doesn't want to be the arrivals announcer, this gets set to FALSE.
Set to true if the AI cracks it's camera by using the malf ability
List of modules the AI has purchased malf upgrades for.
Whether or not the AI has upgraded their turrets
Removes all malfunction-related /datum/action's from the target AI.
Vars | |
| active_software | Currently active software |
|---|---|
| installed_software | List of all installed software |
| integ_signaler | Integrated remote signaler for signalling |
Currently active software
List of all installed software
Integrated remote signaler for signalling
Vars | |
| allow_rename | Can a robot rename itself with the Namepick verb? |
|---|---|
| base_icon | The default skin of some special robots. |
| braintype | Determines if the robot is referred to as an "Android", "Robot", or "Cyborg" based on the type of brain inside. |
| brute_mod | Incoming brute damage is multiplied by this number. |
| burn_mod | Incoming burn damage is multiplied by this number. |
| can_lock_cover | If set to TRUE, a robot can re-lock its own cover. |
| components | Components are basically robot organs. |
| custom_eye_names | Robot skins with multiple variants for different modules. They require special handling to make their eyes display. |
| custom_panel | Does the robot have a non-default sprite for an open service panel? |
| custom_panel_names | Robot skins with non-default sprites for an open service panel. |
| damage_protection | All incoming damage has this number subtracted from it. |
| ear_protection | Is the robot protected from the audio component of flashbangs? Prevents inflicting confusion. |
| emagged | Has the robot been emagged? |
| emp_protection | Is the robot immune to EMPs? |
| eye_protection | Is the robot protected from the visual portion of flashbangs and flashes(1)? Are they protected from laser pointer (2)? |
| floorbuffer | Does the robot clean dirt under it when it moves onto a tile? |
| has_advanced_reagent_vision | If set to TRUE, the robot can see the types and precice quantities of reagents in transparent containers, the % amount of different reagents in opaque containers, and can identify different blood types. |
| has_camera | Determines if a robot acts as a mobile security camera that can be observed through security consoles or by an AI. |
| ident | Used when generating the number in default robot names. |
| ionpulse | Does the robot have ion thrusters installed? |
| ionpulse_on | Are the robot's ion thrusters activated? |
| is_emaggable | Can the robot be emagged? |
| lamp_intensity | Luminosity of the headlamp. 0 is off. Higher settings than the minimum require power. Increments in steps of 2. |
| lamp_max | Maximum brightness of a robot's headlamp. Set as a var for easy adjusting. |
| lamp_recharging | Flag for if the headlamp is on cooldown after being forcibly disabled (e.g. by a shadow deamon). |
| last_camera_update | When the camera moved signal was sent last. Avoid overdoing it. |
| lawupdate | Determines if the robot tries to sync its laws to a connected AI. |
| lockcharge | Used when locking down a robot to preserve cell charge. |
| locked | Is the robot's cover locked? |
| low_power_mode | Has the robot's power cell run out of charge? |
| mail_destination | Integer used to determine self-mailing location, used only by drones and saboteur robots. |
| mmi | Used for deconstruction to remember what the robot was constructed out of. |
| modtype | What specialisation the robot has. |
| modules_break | If set to TRUE, the robot's 3 module slots will progressively become unusable as they take damage. |
| opened | Is the robot's maintenance panel open? |
| pdahide | If set to TRUE, the robot will be hidden on the PDA messenger list. |
| req_access | Used for robot access checks. |
| req_one_access | Determines the ID access needed to unlock the robot's cover. |
| robot_suit | Used for deconstruction to remember what the robot was constructed out of. |
| scrambledcodes | If set to TRUE, a robot will not be visible on the robotics control console. |
| speed | Speed modifier. Positive numbers reduce speed, negative numbers increase it. |
| tracking_entities | The number of known entities currently accessing the internal camera. |
| weapons_unlock | Setting to TRUE unlocks a borg's Safety Override modules. |
Procs | |
| get_module_sprites | Returns an associative list of possible borg sprites based on the selected_module. |
| get_module_types | Returns a list of choosable module types, associated with the module icon for the radial menu. |
| initialize_module | Sets up the module items and sprites for the cyborg module chosen in pick_module(). |
| observer_screen_update | Updates the observers's screens with cyborg itemss. +Arguments |
| on_drop_hotkey_press | Used in robot.dm when the user presses "Q" by default. |
| robot_module_hat_offset | Sets the offset for a cyborg's hats based on their module icon. +Borgs are grouped by similar sprites (Eg. all the Noble borgs are all the same sprite but recoloured.) |
| set_mail_tag | Set Mail Tag |
| spill_upgrades | Take the borg's upgrades and spill them on the floor |
Can a robot rename itself with the Namepick verb?
The default skin of some special robots.
Determines if the robot is referred to as an "Android", "Robot", or "Cyborg" based on the type of brain inside.
Incoming brute damage is multiplied by this number.
Incoming burn damage is multiplied by this number.
If set to TRUE, a robot can re-lock its own cover.
Components are basically robot organs.
Robot skins with multiple variants for different modules. They require special handling to make their eyes display.
Does the robot have a non-default sprite for an open service panel?
Robot skins with non-default sprites for an open service panel.
All incoming damage has this number subtracted from it.
Is the robot protected from the audio component of flashbangs? Prevents inflicting confusion.
Has the robot been emagged?
Is the robot immune to EMPs?
Is the robot protected from the visual portion of flashbangs and flashes(1)? Are they protected from laser pointer (2)?
Does the robot clean dirt under it when it moves onto a tile?
If set to TRUE, the robot can see the types and precice quantities of reagents in transparent containers, the % amount of different reagents in opaque containers, and can identify different blood types.
Determines if a robot acts as a mobile security camera that can be observed through security consoles or by an AI.
Used when generating the number in default robot names.
Does the robot have ion thrusters installed?
Are the robot's ion thrusters activated?
Can the robot be emagged?
Luminosity of the headlamp. 0 is off. Higher settings than the minimum require power. Increments in steps of 2.
Maximum brightness of a robot's headlamp. Set as a var for easy adjusting.
Flag for if the headlamp is on cooldown after being forcibly disabled (e.g. by a shadow deamon).
When the camera moved signal was sent last. Avoid overdoing it.
Determines if the robot tries to sync its laws to a connected AI.
Used when locking down a robot to preserve cell charge.
Is the robot's cover locked?
Has the robot's power cell run out of charge?
Integer used to determine self-mailing location, used only by drones and saboteur robots.
Used for deconstruction to remember what the robot was constructed out of.
What specialisation the robot has.
If set to TRUE, the robot's 3 module slots will progressively become unusable as they take damage.
Is the robot's maintenance panel open?
If set to TRUE, the robot will be hidden on the PDA messenger list.
Used for robot access checks.
Determines the ID access needed to unlock the robot's cover.
Used for deconstruction to remember what the robot was constructed out of.
If set to TRUE, a robot will not be visible on the robotics control console.
Speed modifier. Positive numbers reduce speed, negative numbers increase it.
The number of known entities currently accessing the internal camera.
Setting to TRUE unlocks a borg's Safety Override modules.
Returns an associative list of possible borg sprites based on the selected_module.
Key: Sprite name | Value: Sprite icon
+Arguments:
+Returns a list of choosable module types, associated with the module icon for the radial menu.
+Key: Module name | Value: Module 'icon'
+By default this returns the Engineering, Janitor, Medical, Mining, and Service modules. +If there are any [/mob/living/silicon/robot/var/force_modules] set, then they are returned instead. +If the MMI has a xenomorph brain in it ([/obj/item/mmi/var/alien]), then only the "Hunter" and standard modules is returned.
Sets up the module items and sprites for the cyborg module chosen in pick_module().
Arguments:
+icon and icon_state variables to the player.Updates the observers's screens with cyborg itemss. +Arguments
+Used in robot.dm when the user presses "Q" by default.
Sets the offset for a cyborg's hats based on their module icon. +Borgs are grouped by similar sprites (Eg. all the Noble borgs are all the same sprite but recoloured.)
+Arguments:
+icon_state for which the offset needs to be calculated.Set Mail Tag
Take the borg's upgrades and spill them on the floor
Vars | |
| sync_cooldown | Cooldown for law syncs |
|---|---|
Cooldown for law syncs
Vars | |
| AIStatus | The Status of our AI, can be set to AI_ON (On, usual processing), AI_IDLE (Will not process, but will return to AI_ON if an enemy comes near), AI_OFF (Off, Not processing ever) |
|---|---|
| admin_prev_health | Health of the mob before being admin-frozen, restored afterwards |
| animal_species | Sorry, no spider+corgi buttbabies. |
| armour_penetration_flat | Flat armour reduction, occurs after percentage armour penetration. |
| armour_penetration_percentage | Percentage armour reduction, happens before flat armour reduction. |
| atmos_requirements | Atmos effect - Yes, you can make creatures that require plasma or co2 to survive. N2O is a trace gas and handled separately, hence why it isn't here. It'd be hard to add it. Hard and me don't mix (Yes, yes make all the dick jokes you want with that.) - Errorage |
| can_be_on_fire | If the mob can catch fire |
| can_collar | Can add collar to mob or not, use the set_can_collar if you want to change this on runtime |
| can_crawl | Can this simple mob crawl or not? If FALSE, it won't get immobilized by crawling |
| can_have_ai | Once we have become sentient, we can never go back |
| childtype | Hot simple_animal baby making vars |
| cold_damage_per_tick | Same as heat_damage_per_tick, only if the bodytemperature it's lower than minbodytemp |
| collar_type | If the mob has collar sprites, define them. |
| damage_coeff | 1 for full damage , 0 for none , -1 for 1:1 heal from that source |
| death_sound | The sound played on death |
| del_on_death | Causes mob to be deleted on death, useful for mobs that spawn lootable corpses |
| emote_hear | Hearable emotes |
| emote_see | Unlike speak_emote, the list of things in this variable only show by themselves with no spoken text. IE: Ian barks, Ian yaps |
| environment_smash | Set to 1 to allow breaking of crates,lockers,racks,tables; 2 for walls; 3 for Rwalls |
| fire_damage | Damage the mob will take if it is on fire |
| flip_on_death | Flip the sprite upside down on death. Mostly here for things lacking custom dead sprites. |
| footstep_type | What kind of footstep this mob should have. Null if it shouldn't have any. |
| force_threshold | Minimum force required to deal any damage |
| friendly | If the mob does no damage with it's attack |
| gold_core_spawnable | If the mob can be spawned with a gold slime core. HOSTILE_SPAWN are spawned with plasma, FRIENDLY_SPAWN are spawned with blood |
| healable | Healable by medical stacks? Defaults to yes. |
| heat_damage_per_tick | Amount of damage applied if animal's body temperature is higher than maxbodytemp |
| icon_gib | We only try to show a gibbing animation if this exists. |
| loot | List of things spawned at mob's loc when it dies |
| master_commander | Holding var for determining who own/controls a sentient simple animal (for sentience potions). |
| melee_damage_lower | LETTING SIMPLE ANIMALS ATTACK? WHAT COULD GO WRONG. Defaults to zero so Ian can still be cuddly |
| melee_damage_type | Damage type of a simple mob's melee attack, should it do damage. |
| my_z | I don't want to confuse this with client registered_z |
| obj_damage | How much damage this simple animal does to objects, if any |
| pass_door_while_hidden | Allows a mob to pass unbolted doors while hidden |
| sentience_type | Sentience type, for slime potions |
| shouldwakeup | Convenience var for forcibly waking up an idling AI on next check. |
| speed | Higher speed is slower, negative speed is faster |
| stop_automated_movement | Use this to temporarely stop random movement or to if you write special movement code for animals. |
| stop_automated_movement_when_pulled | When set to TRUE this stops the animal from moving when someone is pulling it. |
| unique_pet | If the mob can be renamed |
| unsuitable_atmos_damage | This damage is taken when atmos doesn't fit all the requirements above |
| wander | Does the mob wander around when idle? |
| xenobiology_spawned | Was this mob spawned by xenobiology magic? Used for mobcapping. |
Procs | |
| handle_atom_del | We need to clear the reference to where we're walking to properly GC |
The Status of our AI, can be set to AI_ON (On, usual processing), AI_IDLE (Will not process, but will return to AI_ON if an enemy comes near), AI_OFF (Off, Not processing ever)
Health of the mob before being admin-frozen, restored afterwards
Sorry, no spider+corgi buttbabies.
Flat armour reduction, occurs after percentage armour penetration.
Percentage armour reduction, happens before flat armour reduction.
Atmos effect - Yes, you can make creatures that require plasma or co2 to survive. N2O is a trace gas and handled separately, hence why it isn't here. It'd be hard to add it. Hard and me don't mix (Yes, yes make all the dick jokes you want with that.) - Errorage
If the mob can catch fire
Can add collar to mob or not, use the set_can_collar if you want to change this on runtime
Can this simple mob crawl or not? If FALSE, it won't get immobilized by crawling
Once we have become sentient, we can never go back
Hot simple_animal baby making vars
Same as heat_damage_per_tick, only if the bodytemperature it's lower than minbodytemp
If the mob has collar sprites, define them.
1 for full damage , 0 for none , -1 for 1:1 heal from that source
The sound played on death
Causes mob to be deleted on death, useful for mobs that spawn lootable corpses
Hearable emotes
Unlike speak_emote, the list of things in this variable only show by themselves with no spoken text. IE: Ian barks, Ian yaps
Set to 1 to allow breaking of crates,lockers,racks,tables; 2 for walls; 3 for Rwalls
Damage the mob will take if it is on fire
Flip the sprite upside down on death. Mostly here for things lacking custom dead sprites.
What kind of footstep this mob should have. Null if it shouldn't have any.
Minimum force required to deal any damage
If the mob does no damage with it's attack
If the mob can be spawned with a gold slime core. HOSTILE_SPAWN are spawned with plasma, FRIENDLY_SPAWN are spawned with blood
Healable by medical stacks? Defaults to yes.
Amount of damage applied if animal's body temperature is higher than maxbodytemp
We only try to show a gibbing animation if this exists.
List of things spawned at mob's loc when it dies
Holding var for determining who own/controls a sentient simple animal (for sentience potions).
LETTING SIMPLE ANIMALS ATTACK? WHAT COULD GO WRONG. Defaults to zero so Ian can still be cuddly
Damage type of a simple mob's melee attack, should it do damage.
I don't want to confuse this with client registered_z
How much damage this simple animal does to objects, if any
Allows a mob to pass unbolted doors while hidden
Sentience type, for slime potions
Convenience var for forcibly waking up an idling AI on next check.
Higher speed is slower, negative speed is faster
Use this to temporarely stop random movement or to if you write special movement code for animals.
When set to TRUE this stops the animal from moving when someone is pulling it.
If the mob can be renamed
This damage is taken when atmos doesn't fit all the requirements above
Does the mob wander around when idle?
Was this mob spawned by xenobiology magic? Used for mobcapping.
We need to clear the reference to where we're walking to properly GC
Vars | |
| Radio | The bot's radio, for speaking to people. |
|---|---|
| access_card | The ID card that the bot "holds" |
| ai_waypoint | The end point of a bot's path, or the target location. |
| auto_patrol | Set to make bot automatically patrol |
| awaiting_beacon | Count of pticks awaiting a beacon response |
| base_speed | The speed at which the bot moves, or the number of times it moves per process() tick. |
| blockcount | Number of times retried a blocked path |
| bot_filter | The radio filter the bot uses to identify itself on the network. |
| bot_name | storing bot_name prior to pai and restoring it. MULEBOT uses this for suffix system |
| bot_purpose | Bot Purpose under Show Laws |
| bot_type | Type of bot, one of the *_BOT defines. |
| calling_ai | Links a bot to the AI calling it. |
| control_freq | Bot control frequency |
| data_hud_type | The type of data HUD the bot uses. Diagnostic by default. |
| declare_message | What the bot will display to the HUD user. |
| destination | Destination description tag |
| frustration | Used by some bots for tracking failures to reach their target. |
| hacked | Used to differentiate between being hacked by silicons and emagged by humans. |
| hijacked | Is currently hijacked by a pulse demon? |
| ignore_job | List of jobs claimed by bot |
| ignore_list | List of unreachable targets for an ignore-list enabled bot to ignore. |
| ignore_list_cleanup_timer | This ticks up every automated action, at 300 we clean the ignore list |
| last_target_location | Storing last chased target known location |
| lost_target | Will be true if we lost target we were chasing |
| mode | Standardizes the vars that indicate the bot is busy with its function. |
| model | The type of bot it is. |
| nearest_beacon | The nearest beacon's tag |
| nearest_beacon_loc | The nearest beacon's location |
| new_destination | Pending new destination (waiting for beacon response) |
| next_destination | The next destination in the patrol route |
| open | Maint panel |
| path | List of turfs through which a bot 'steps' to reach the waypoint |
| patrol_target | This is turf to navigate to (location of beacon) |
| radio_channel | The bot's default radio channel |
| radio_config | Which channels can the bot listen to |
| remote_disabled | If enabled, the AI cannot Remotely control a bot. It can still control it through cameras. |
| req_access | List of access values you can have to access the bot. Consider this as req_one_access |
| summon_target | The turf of a user summoning a bot. |
| text_dehack | Text shown when resetting a bots hacked status to normal. |
| text_dehack_fail | Shown when a silicon tries to reset a bot emagged with the emag item, which cannot be reset. |
| text_hack | Custom text returned to a silicon upon hacking a bot. |
| tries | Number of times the bot tried and failed to move. |
The bot's radio, for speaking to people.
The ID card that the bot "holds"
The end point of a bot's path, or the target location.
Set to make bot automatically patrol
Count of pticks awaiting a beacon response
The speed at which the bot moves, or the number of times it moves per process() tick.
Number of times retried a blocked path
The radio filter the bot uses to identify itself on the network.
storing bot_name prior to pai and restoring it. MULEBOT uses this for suffix system
Bot Purpose under Show Laws
Type of bot, one of the *_BOT defines.
Links a bot to the AI calling it.
Bot control frequency
The type of data HUD the bot uses. Diagnostic by default.
What the bot will display to the HUD user.
Destination description tag
Used by some bots for tracking failures to reach their target.
Used to differentiate between being hacked by silicons and emagged by humans.
Is currently hijacked by a pulse demon?
List of jobs claimed by bot
List of unreachable targets for an ignore-list enabled bot to ignore.
This ticks up every automated action, at 300 we clean the ignore list
Storing last chased target known location
Will be true if we lost target we were chasing
Standardizes the vars that indicate the bot is busy with its function.
The type of bot it is.
The nearest beacon's tag
The nearest beacon's location
Pending new destination (waiting for beacon response)
The next destination in the patrol route
Maint panel
List of turfs through which a bot 'steps' to reach the waypoint
This is turf to navigate to (location of beacon)
The bot's default radio channel
Which channels can the bot listen to
If enabled, the AI cannot Remotely control a bot. It can still control it through cameras.
List of access values you can have to access the bot. Consider this as req_one_access
The turf of a user summoning a bot.
Text shown when resetting a bots hacked status to normal.
Shown when a silicon tries to reset a bot emagged with the emag item, which cannot be reset.
Custom text returned to a silicon upon hacking a bot.
Number of times the bot tried and failed to move.
Vars | |
| amount | Tiles in inventory |
|---|---|
| autotile | Fix the floor and include a tile. |
| eat_tiles | Add floor tiles to inventory |
| make_tiles | Convert metal into floor tiles (drops on floor) |
| nagged | Prevents the Floorbot nagging more than once per refill. |
| process_type | Determines what to do when process_scan() receives a target. See process_scan() for details. |
| replace_tiles | Add tiles to existing floor |
Tiles in inventory
Fix the floor and include a tile.
Add floor tiles to inventory
Convert metal into floor tiles (drops on floor)
Prevents the Floorbot nagging more than once per refill.
Determines what to do when process_scan() receives a target. See process_scan() for details.
Add tiles to existing floor
Vars | |
| next_move_time | world.time of next move |
|---|---|
| step_delay | Delay in deciseconds between each step |
world.time of next move
Delay in deciseconds between each step
Procs | |
| decompose | Made so severe anxiety does not overload the SSmob while keeping it's effect |
|---|---|
Made so severe anxiety does not overload the SSmob while keeping it's effect
Vars | |
| apc_being_hijacked | Reference to the APC currently being hijacked. |
|---|---|
| apc_images | Images of APCs currently being shown on the client. |
| bot_movedelay | Delay tracker for movement inside bots. |
| cable_images | Images of cables currently being shown on the client. |
| can_exit_cable | Controls whether the demon can move outside of cables. Toggled by a spell. |
| charge | Current quantity of power the demon currently holds, spent while purchasing, upgrading or using spells or upgrades. Use adjust_charge to modify this. |
| charge_drained | Book keeping for objective win conditions. |
| controlling_area | Area being controlled, should be maintained as long as the demon does not move outside a container (APC, object, robot, bot). |
| current_bot | Inhabited bot, only maintained while inside the bot. |
| current_cable | Inhabited cable, only maintained while on top of the cable. |
| current_power | Inhabited power source, maintained while inside, or while inside its area if it is an APC. |
| current_robot | Inhabited cyborg, only maintained while inside the cyborg. |
| current_weapon | Inhabited item, only items which can be used in rechargers can be hijacked. Only maintained while inside the item. |
| do_drain | Controls whether the demon will drain power from sources. Toggled by a spell. |
| emp_debounce | Tracking to prevent multiple EMPs in the same tick from instakilling a demon. |
| glow_color | The color of light the demon emits. The range of the light is proportional to charge. |
| health_loss_rate | Amount of health lost per Life tick when the power requirement was not met. |
| health_regen_rate | Amount of health regenerated per Life tick when the power requirement was met. |
| hijack_time | The time it takes to hijack APCs and cyborgs. |
| hijacked_apcs | List of all previously hijacked APCs. |
| hijacked_robots | A cyborg that has already been hijacked can be re-entered instantly. |
| hurt_sounds | List of sounds that is picked from when the demon dies or is EMP'd. |
| inside_cable_speed | Speed used while moving inside cables. |
| max_drain_rate | Maximum value for power_drain_rate based on upgrades. |
| maxcharge | Maximum quantity of power the demon can hold at once. |
| outside_cable_speed | Speed used while moving outside cables. Can be upgraded. |
| power_drain_rate | Amount of power (in watts) to drain from power sources every Life tick. |
| power_per_regen | Amount of power (in watts) required to regenerate health. |
| regen_lock | Lock health regeneration while this is not 0, decreases by 1 every Life tick. |
| speech_sounds | List of sounds that is picked from when the demon speaks. |
Reference to the APC currently being hijacked.
Images of APCs currently being shown on the client.
Delay tracker for movement inside bots.
Images of cables currently being shown on the client.
Controls whether the demon can move outside of cables. Toggled by a spell.
Current quantity of power the demon currently holds, spent while purchasing, upgrading or using spells or upgrades. Use adjust_charge to modify this.
Book keeping for objective win conditions.
Area being controlled, should be maintained as long as the demon does not move outside a container (APC, object, robot, bot).
Inhabited bot, only maintained while inside the bot.
Inhabited cable, only maintained while on top of the cable.
Inhabited power source, maintained while inside, or while inside its area if it is an APC.
Inhabited cyborg, only maintained while inside the cyborg.
Inhabited item, only items which can be used in rechargers can be hijacked. Only maintained while inside the item.
Controls whether the demon will drain power from sources. Toggled by a spell.
Tracking to prevent multiple EMPs in the same tick from instakilling a demon.
The color of light the demon emits. The range of the light is proportional to charge.
Amount of health lost per Life tick when the power requirement was not met.
Amount of health regenerated per Life tick when the power requirement was met.
The time it takes to hijack APCs and cyborgs.
List of all previously hijacked APCs.
A cyborg that has already been hijacked can be re-entered instantly.
List of sounds that is picked from when the demon dies or is EMP'd.
Speed used while moving inside cables.
Maximum value for power_drain_rate based on upgrades.
Maximum quantity of power the demon can hold at once.
Speed used while moving outside cables. Can be upgraded.
Amount of power (in watts) to drain from power sources every Life tick.
Amount of power (in watts) required to regenerate health.
Lock health regeneration while this is not 0, decreases by 1 every Life tick.
List of sounds that is picked from when the demon speaks.
Procs | |
| AICanContinue | AI Status |
|---|---|
| ListTargets | HOSTILE MOB TARGETTING AND AGGRESSION |
| aggro_fast | Shortcut proc to allow initiating combat slightly faster than waiting for normal processing. |
| death | END HOSTILE MOB TARGETTING AND AGGRESSION |
AI Status
HOSTILE MOB TARGETTING AND AGGRESSION
Shortcut proc to allow initiating combat slightly faster than waiting for normal processing.
END HOSTILE MOB TARGETTING AND AGGRESSION
A stronger, faster variation of the goliath. Has the ability to spawn baby goliaths, which it can later detonate at will. +When it's health is below half, tendrils will spawn randomly around it. When it is below a quarter of health, this effect is doubled. +It's attacks are as follows:
+A slow-moving projectile user with a few tricks up it's sleeve. Less unga-bunga than Colossus, with more cleverness in it's fighting style. +As it's health gets lower, the amount of projectiles fired per-attack increases. +It's attacks are as follows:
+A towering skeleton, embodying the power of Legion. +As it's health gets lower, the head does more damage. +It's attacks are as follows:
+Vars | |
| charging | Whether or not the legionnaire is currently charging, used to deny movement input if he is |
|---|---|
Whether or not the legionnaire is currently charging, used to deny movement input if he is
A box with a similar design to the Hierophant which trades large, single attacks for more frequent smaller ones. +As it's health gets lower, the time between it's attacks decrease. +It's attacks are as follows:
+Vars | |
| held_body | The body/brain of the player inside this construct, transferred over from the soulstone. |
|---|---|
| holy | Is this a holy/purified construct? |
| playstyle_string | Message to send to the construct when they are created, containing information about their role. |
The body/brain of the player inside this construct, transferred over from the soulstone.
Is this a holy/purified construct?
Message to send to the construct when they are created, containing information about their role.
Juggernaut
Procs | |
| update_health_hud | ui stuff |
|---|---|
ui stuff
Vars | |
| carriable_cache | Typecache of all the types we can pick up and carry |
|---|---|
| crate_limit | The max number of crates we can carry |
| crates_in_hand | A lazylist of all crates we are carrying |
| dismember_chance | Chance to dismember while unconcious |
| is_bipedal | Is the gorilla stood up or not? |
| stamina_damage | Amount of stamina lost on a successful hit |
| throw_onhit | Chance of doing the throw or stamina damage, along with the flat damage amount |
Procs | |
| drop_all_crates | Drops all the crates in our crate list. |
| drop_random_crate | Drops one random crates from our crate list. |
| get_target_bodyparts | Returns null when the target is not an unconscious carbon mob; a list of limbs (possibly empty) otherwise. |
Typecache of all the types we can pick up and carry
The max number of crates we can carry
A lazylist of all crates we are carrying
Chance to dismember while unconcious
Is the gorilla stood up or not?
Amount of stamina lost on a successful hit
Chance of doing the throw or stamina damage, along with the flat damage amount
Drops all the crates in our crate list.
Drops one random crates from our crate list.
Returns null when the target is not an unconscious carbon mob; a list of limbs (possibly empty) otherwise.
Vars | |
| access_card | The ID card that the gorilla is currently wearing. |
|---|---|
The ID card that the gorilla is currently wearing.
Vars | |
| stealthy_deploying | If true, it will not make a message on host when hit, or make an effect when deploying or recalling |
|---|---|
If true, it will not make a message on host when hit, or make an effect when deploying or recalling
Vars | |
| linda_flags | Linda flag for the expelled gas because we need to use special flags for it that are not readable in game well. |
|---|---|
| moles_of_gas | Moles of gas being expelled. |
| possible_gases | Possible gases to expel, with how much moles they create. |
Linda flag for the expelled gas because we need to use special flags for it that are not readable in game well.
Moles of gas being expelled.
Possible gases to expel, with how much moles they create.
Vars | |
| connected_shields | The shields the guardian has, and brings with it as it moves |
|---|---|
The shields the guardian has, and brings with it as it moves
Procs | |
| advanced_bullet_dodge | We overide the basic effect, as malfunctioning drones are in space, and use jets to dodge. Also lets us do cool effects. |
|---|---|
We overide the basic effect, as malfunctioning drones are in space, and use jets to dodge. Also lets us do cool effects.
Vars | |
| enraged | Has someone enabled hard mode? |
|---|---|
| enraged_loot | Path of the hardmode loot disk, if applicable. |
Procs | |
| enrage | This proc is called by the HRD-MDE grenade to enrage the megafauna. This should increase the megafaunas attack speed if possible, give it new moves, or disable weak moves. This should be reverseable, and reverses on zlvl change. |
Has someone enabled hard mode?
Path of the hardmode loot disk, if applicable.
This proc is called by the HRD-MDE grenade to enrage the megafauna. This should increase the megafaunas attack speed if possible, give it new moves, or disable weak moves. This should be reverseable, and reverses on zlvl change.
Vars | |
| TR | Legs and the connector for the legs |
|---|---|
Legs and the connector for the legs
Vars | |
| enraged_healing | Enraged healing recived |
|---|---|
| second_life | Is it on its enraged exclusive second life? |
| second_life_portal | Does it have a portal to the funny second life arena created? |
Enraged healing recived
Is it on its enraged exclusive second life?
Does it have a portal to the funny second life arena created?
Vars | |
| final_available | Have we used our final attack yet? |
|---|---|
Have we used our final attack yet?
Vars | |
| colour_shifting | If the hiero has changed colour, stop the rays animation. |
|---|---|
If the hiero has changed colour, stop the rays animation.
Vars | |
| orig_vendor | The vendor we were turned from. |
|---|---|
The vendor we were turned from.
Vars | |
| ambush_damage | How much damage a successful ambush attack does |
|---|---|
| ambush_prepared | If the morph is ready to perform an ambush |
| ambush_spell | The ambush action used by the morph |
| ambush_weaken | How much weaken a successful ambush attack applies |
| gathered_food | How much the morph has gathered in terms of food. Used to reproduce and such |
| mimic_spell | The spell the morph uses to morph |
| morphed | If the morph is disguised or not |
| pass_airlock_spell | The spell the morph uses to pass through airlocks |
Procs | |
| add_food | Adds the given amount of food to the gathered food and updates the actions. +Does not include a check to see if it goes below 0 or not |
How much damage a successful ambush attack does
If the morph is ready to perform an ambush
The ambush action used by the morph
How much weaken a successful ambush attack applies
How much the morph has gathered in terms of food. Used to reproduce and such
The spell the morph uses to morph
If the morph is disguised or not
The spell the morph uses to pass through airlocks
Adds the given amount of food to the gathered food and updates the actions. +Does not include a check to see if it goes below 0 or not
Child of giant_spider because this should do everything the spider does and more
Vars | |
| current_order | Handles the spider's behavior |
|---|---|
| gibbed | To check and gib the spider when dead, then remove only one of the counter for the changeling owner |
| owner_UID | References to the owner changeling |
Handles the spider's behavior
To check and gib the spider when dead, then remove only one of the counter for the changeling owner
References to the owner changeling
Vars | |
| loudspeaker | Does this terror speak loudly on the terror hivemind? |
|---|---|
Does this terror speak loudly on the terror hivemind?
Vars | |
| has_tail | Lizards start with a tail |
|---|---|
Lizards start with a tail
Procs | |
| try_grab_item | Attempts to pick up an adjacent item |
|---|---|
Attempts to pick up an adjacent item
+Arguments:
+Vars | |
| final_bites | Number of times the corpse has been bitten |
|---|---|
Number of times the corpse has been bitten
Vars | |
| inventory_back | Currently worn item on the back slot |
|---|---|
| inventory_head | Currently worn item on the head slot |
| strippable_inventory_slots | Item slots that are available for this corgi to equip stuff into |
Procs | |
| drop_hat | Deadchat plays command that drops the current hat off Ian. |
| find_new_hat | Deadchat plays command that picks a new hat for Ian. |
Currently worn item on the back slot
Currently worn item on the head slot
Item slots that are available for this corgi to equip stuff into
Deadchat plays command that drops the current hat off Ian.
Deadchat plays command that picks a new hat for Ian.
Vars | |
| escape_chance | The probability % of us escaping if stuffed into a bag/toolbox/etc |
|---|---|
| possessed_item | What is the actual item we are "possessing" |
The probability % of us escaping if stuffed into a bag/toolbox/etc
What is the actual item we are "possessing"
Vars | |
| drained_mobs | contains a list of UIDs of mobs who have been drained. cannot drain the same mob twice. |
|---|---|
| draining | If the revenant is draining someone. |
| essence | The resource of revenants. Max health is equal to three times this amount |
| essence_accumulated | How much essence the revenant has stolen |
| essence_drained | How much essence the revenant has drained. |
| essence_regen_amount | How much essence regenerates |
| essence_regen_cap | The regeneration cap of essence (go figure); regenerates every Life() tick up to this amount. |
| essence_regenerating | If the revenant regenerates essence or not; 1 for yes, 0 for no |
| icon_drain | The revant's icon while draining mobs |
| icon_idle | The revenant's idle icon |
| icon_reveal | The revenant's revealed icon |
| icon_stun | The revenant's stunned icon |
| inhibited | If the revenant's abilities are blocked by a chaplain's power. |
| perfectsouls | How many perfect, regen-cap increasing souls the revenant has. |
| revealed | If the revenant can take damage from normal sources. |
| unreveal_time | How long the revenant is revealed for, is about 2 seconds times this var. |
| unstun_time | How long the revenant is stunned for, is about 2 seconds times this var. |
Procs | |
| ClickOn | Harvest |
contains a list of UIDs of mobs who have been drained. cannot drain the same mob twice.
If the revenant is draining someone.
The resource of revenants. Max health is equal to three times this amount
How much essence the revenant has stolen
How much essence the revenant has drained.
How much essence regenerates
The regeneration cap of essence (go figure); regenerates every Life() tick up to this amount.
If the revenant regenerates essence or not; 1 for yes, 0 for no
The revant's icon while draining mobs
The revenant's idle icon
The revenant's revealed icon
The revenant's stunned icon
If the revenant's abilities are blocked by a chaplain's power.
How many perfect, regen-cap increasing souls the revenant has.
If the revenant can take damage from normal sources.
How long the revenant is revealed for, is about 2 seconds times this var.
How long the revenant is stunned for, is about 2 seconds times this var.
Harvest
Vars | |
| AIproc | Determines if the AI loop is activated |
|---|---|
| Atkcool | Attack cooldown |
| Discipline | If a slime has been hit with a freeze gun, or wrestled/attacked off a human, they become disciplined and don't attack anymore for a while |
| SStun | Stun variable |
| Tempstun | Temporary temperature stuns |
| colour | TIME FOR SUBSPECIES |
| effectmod | CORE-CROSSING CODE |
Determines if the AI loop is activated
Attack cooldown
If a slime has been hit with a freeze gun, or wrestled/attacked off a human, they become disciplined and don't attack anymore for a while
Stun variable
Temporary temperature stuns
TIME FOR SUBSPECIES
CORE-CROSSING CODE
Vars | |
| damage_deflection | Damage under this value will be completely ignored |
|---|---|
| emagged | Is it emagged or not? |
Procs | |
| GetExplosionBlock | returns how much the object blocks an explosion. Used by subtypes. |
| acid_act | the obj's reaction when touched by acid |
| acid_melt | called when the obj is destroyed by acid. |
| acid_processing | the proc called by the acid subsystem to process the acid that's on the obj |
| bitmask_smooth | Object override to prevent unanchored objects from smoothing |
| burn | called when the obj is destroyed by fire |
| extinguish | Called when the obj is no longer on fire. |
| fire_act | FIRE |
| hulk_damage | Called to get the damage that hulks will deal to the obj. |
| modify_max_integrity | changes max_integrity while retaining current health percentage, returns TRUE if the obj got broken. |
| obj_destruction | what happens when the obj's integrity reaches zero. |
| play_attack_sound | the sound played when the obj is damaged. |
| run_obj_armor | returns the damage value of the attack after processing the obj's various armor protections |
| set_sharpness | Set whether the item should be sharp or not |
| ui_login_act | Call this from a proc that is called in ui_act() to process login actions |
| ui_login_attackby | Convenience function to perform login actions when +the source object is hit by specific items. |
| ui_login_data | Appends login state data. |
| ui_login_eject | Attempts to eject the inserted ID. |
| ui_login_get | Returns (or creates) the login state for the source object. |
| ui_login_insert | Attempts to insert an object as an ID. |
| ui_login_login | Attempts to log in with the given login type. |
| ui_login_logout | Attempts to log out. |
| ui_login_on_login | Called on successful login. |
| ui_login_on_logout | Called on successful logout. |
| zap_act | Called when the obj is hit by a tesla bolt. |
| zap_buckle_check | Only tesla coils, vehicles, and grounding rods currently call this because mobs are already targeted over all other objects, but this might be useful for more things later. |
Damage under this value will be completely ignored
Is it emagged or not?
returns how much the object blocks an explosion. Used by subtypes.
the obj's reaction when touched by acid
called when the obj is destroyed by acid.
the proc called by the acid subsystem to process the acid that's on the obj
Object override to prevent unanchored objects from smoothing
called when the obj is destroyed by fire
Called when the obj is no longer on fire.
FIRE
Called to get the damage that hulks will deal to the obj.
changes max_integrity while retaining current health percentage, returns TRUE if the obj got broken.
what happens when the obj's integrity reaches zero.
the sound played when the obj is damaged.
returns the damage value of the attack after processing the obj's various armor protections
Set whether the item should be sharp or not
Call this from a proc that is called in ui_act() to process login actions
+Arguments:
+Convenience function to perform login actions when +the source object is hit by specific items.
+Arguments:
+Appends login state data.
+Arguments:
+Attempts to eject the inserted ID.
+Arguments:
+Returns (or creates) the login state for the source object.
+Arguments:
+Attempts to insert an object as an ID.
+Arguments:
+Attempts to log in with the given login type.
+Arguments:
+Attempts to log out.
+Arguments:
+Called on successful login.
+Arguments:
+Called on successful logout.
+Arguments:
+Called when the obj is hit by a tesla bolt.
Only tesla coils, vehicles, and grounding rods currently call this because mobs are already targeted over all other objects, but this might be useful for more things later.
Vars | |
| filled_airlock | The door/airlock this fluff panel is attached to |
|---|---|
Procs | |
| CanPass | Multi-tile airlocks (using a filler panel) have special handling for movables with PASS_FLAG_GLASS |
| pair_airlock | Multi-tile airlocks pair with a filler panel, if one goes so does the other. |
The door/airlock this fluff panel is attached to
Multi-tile airlocks (using a filler panel) have special handling for movables with PASS_FLAG_GLASS
Multi-tile airlocks pair with a filler panel, if one goes so does the other.
Vars | |
| lance_docking | Is this a shuttle that completely destroys whatever dares to get in it's way? |
|---|---|
| lockeddown | If this variable is true, shuttle is on lockdown, and other requests can not be processed |
| shuttle_speed_factor | The speed factor for this shuttle. Higher means faster. |
| uses_lockdown | Does this shuttle use the lockdown system? |
Is this a shuttle that completely destroys whatever dares to get in it's way?
If this variable is true, shuttle is on lockdown, and other requests can not be processed
The speed factor for this shuttle. Higher means faster.
Does this shuttle use the lockdown system?
Vars | |
| hijack_status | State of the emergency shuttles hijack status. |
|---|---|
State of the emergency shuttles hijack status.
An abstract object which is basically just a bag that the chasm puts people inside
Procs | |
| on_revive | Called if something comes back to life inside the pit. Expected sources are badmins and changelings. +Ethereals should take enough damage to be smashed and not revive. +Arguments +escapee - Lucky guy who just came back to life at the bottom of a hole. |
|---|---|
Called if something comes back to life inside the pit. Expected sources are badmins and changelings. +Ethereals should take enough damage to be smashed and not revive. +Arguments +escapee - Lucky guy who just came back to life at the bottom of a hole.
These effects can be added to anything to hold particles, which is useful because Byond only allows a single particle per atom
Vars | |
| holding_parent | The mob that is holding our item |
|---|---|
| last_attached_location_type | typepath of the last location we're in, if it's different when moved then we need to update vis contents |
| parent | The main item we're attached to at the moment, particle holders hold particles for something |
Procs | |
| on_move | signal called when parent is moved |
| on_qdel | signal called when parent is deleted |
| update_visual_contents | logic proc for particle holders, aka where they move. +subtypes of particle holders can override this for particles that should always be turf level or do special things when repositioning. +this base subtype has some logic for items, as the loc of items becomes mobs very often hiding the particles |
The mob that is holding our item
typepath of the last location we're in, if it's different when moved then we need to update vis contents
The main item we're attached to at the moment, particle holders hold particles for something
signal called when parent is moved
signal called when parent is deleted
logic proc for particle holders, aka where they move. +subtypes of particle holders can override this for particles that should always be turf level or do special things when repositioning. +this base subtype has some logic for items, as the loc of items becomes mobs very often hiding the particles
Inteded for use with the proximity checker component /datum/component/proximity_monitor.
+Whenever a movable atom crosses this object, it calls HasProximity() on the object which is listening for proximity (hasprox_receiver).
Because these objects try to make the smallest footprint possible, when these objects move they should use direct loc setting only, and not forceMove!
+The overhead for forceMove is very unnecessary, because for example turfs and areas don't need to know when these have entered or exited them, etc.
+These are invisible objects who's sole purpose is to simply inform the receiver that something has moved within X tiles of the it.
Vars | |
| active | Whether or not the proximity checker is listening for things crossing it. |
|---|---|
| monitor | The component that this object is in use with, and that will receive HasProximity() calls. |
Procs | |
| Crossed | Called when something crossed over the proximity_checker. Notifies the hasprox_receiver it has proximity with something. |
Whether or not the proximity checker is listening for things crossing it.
The component that this object is in use with, and that will receive HasProximity() calls.
Called when something crossed over the proximity_checker. Notifies the hasprox_receiver it has proximity with something.
Arguments:
+AM used to be atVars | |
| drops_core | Do we drop a core when we're neutralized? |
|---|---|
| lifespan | Time in deciseconds before the anomaly triggers |
Do we drop a core when we're neutralized?
Time in deciseconds before the anomaly triggers
Vars | |
| fully_active | Used by supermatter anomalies. If fully active, behaves like normal. Otherwise, will not teleport people, to keep them being telefragged into the SM |
|---|---|
| mass_teleporting | Do we teleport everything around us to a beacon when despawning? |
| mob_range | What is the range we will grab mobs to teleport from |
| other_range | What is the range we will grab objects to teleport from |
| supermatter_spawned | Do we have a smaller mob and object grab range, and 4 seconds of mercy? |
Used by supermatter anomalies. If fully active, behaves like normal. Otherwise, will not teleport people, to keep them being telefragged into the SM
Do we teleport everything around us to a beacon when despawning?
What is the range we will grab mobs to teleport from
What is the range we will grab objects to teleport from
Do we have a smaller mob and object grab range, and 4 seconds of mercy?
Procs | |
| get_value | Get the value from our atom |
|---|---|
Get the value from our atom
Vars | |
| cant_teleport | Used to prevent an infinite loop in the space tiime continuum |
|---|---|
| linked_dist | A flags which save people from being thrown about |
Used to prevent an infinite loop in the space tiime continuum
A flags which save people from being thrown about
Vars | |
| bloodiness | 0-100, amount of blood in this decal, used for making footprints and affecting the alpha of bloody footprints |
|---|---|
| gravity_check | for blood n vomit in zero G --- IN GRAVITY=TRUE; NO GRAVITY=FALSE |
| mergeable_decal | when another of the same type is made on the same tile will they merge --- YES=TRUE; NO=FLASE |
| plane | prevents Ambient Occlusion effects around it ; Set to GAME_PLANE in Initialize() if on a wall |
| random_icon_states | when Initialized() its icon_state will be chosen from this list |
0-100, amount of blood in this decal, used for making footprints and affecting the alpha of bloody footprints
for blood n vomit in zero G --- IN GRAVITY=TRUE; NO GRAVITY=FALSE
when another of the same type is made on the same tile will they merge --- YES=TRUE; NO=FLASE
prevents Ambient Occlusion effects around it ; Set to GAME_PLANE in Initialize() if on a wall
when Initialized() its icon_state will be chosen from this list
Vars | |
| target | The turf that the tar is sitting on |
|---|---|
The turf that the tar is sitting on
Procs | |
| gib_dna | Assigns DNA and blood colour to mob gibs. |
|---|---|
| spawn_gibs | Spawns the gibs (and sparks if applicable) from the gib spawner. |
Assigns DNA and blood colour to mob gibs.
+Returns FALSE if there was no DNA data to transfer to the gibs, and TRUE if there was. +Arguments:
+Spawns the gibs (and sparks if applicable) from the gib spawner.
+Arguments:
+Vars | |
| shield_orientation | Is the guardians shield the left or right shield? |
|---|---|
Is the guardians shield the left or right shield?
Base object for hallucinations. Contains basic behaviour to display an icon only to the target.
Vars | |
| duration | Duration in deciseconds. Can also be a list with the form [lower bound, upper bound] for a random duration. |
|---|---|
| hallucination_icon | Hallucination icon. |
| hallucination_icon_state | Hallucination icon state. |
| hallucination_layer | Hallucination layer. |
| hallucination_override | Hallucination override. |
| images | Lazy list of images created as part of the hallucination. Cleared on destruction. |
| target | The mob that sees this hallucination. |
Procs | |
| add_icon | Adds an image to the hallucination. Cleared on destruction. |
| clear_icon | Clears an image from the hallucination. |
| clear_icon_in | Clears an image from the hallucination after a delay. |
| clear_icons | Clears all images from the hallucination. |
| play_sound_in | Plays a sound to the target only. |
Duration in deciseconds. Can also be a list with the form [lower bound, upper bound] for a random duration.
Hallucination icon.
Hallucination icon state.
Hallucination layer.
Hallucination override.
Lazy list of images created as part of the hallucination. Cleared on destruction.
The mob that sees this hallucination.
Adds an image to the hallucination. Cleared on destruction.
+Arguments:
+Clears an image from the hallucination.
+Arguments:
+Clears an image from the hallucination after a delay.
+Arguments:
+Clears all images from the hallucination.
Plays a sound to the target only.
+Arguments:
+Sends an abductor agent after the target. On knockdown, spawns an abductor scientist next to the target. Nothing else happens.
Vars | |
| agent | The abductor agent hallucination. |
|---|---|
| scientist | The abductor scientist image handle. |
Procs | |
| do_spawn_scientist | Timer called to actually spawn the scientist. |
| spawn_scientist | Called when the fake abductor scientist should spawn. |
The abductor agent hallucination.
The abductor scientist image handle.
Timer called to actually spawn the scientist.
+Arguments:
+Called when the fake abductor scientist should spawn.
An imaginary attacker spawns close to the target and attacks them to stamcrit.
Vars | |
| fake_attacker | The attacker hallucination. |
|---|---|
The attacker hallucination.
Plays a random sound.
Vars | |
| sounds | Associative list of sounds that may be played. Value corresponds to the volume. |
|---|---|
Associative list of sounds that may be played. Value corresponds to the volume.
Visually bolts a random number of airlocks around the target.
Vars | |
| bolt_amount | The maximum amount of airlocks to fake bolt. |
|---|---|
| bolt_duration | The duration of fake bolt in deciseconds. |
| bolted | Lazy list of fake bolted airlocks. Key is airlock, value is bolt overlay. |
Procs | |
| do_bolt | Called in a timer to fake bolt the given airlock. |
| do_unbolt | Called in a timer to fake unbolt the given airlock. |
The maximum amount of airlocks to fake bolt.
The duration of fake bolt in deciseconds.
Lazy list of fake bolted airlocks. Key is airlock, value is bolt overlay.
Called in a timer to fake bolt the given airlock.
+Arguments:
+Called in a timer to fake unbolt the given airlock.
+Arguments:
+A generic hallucination that chases the target.
Vars | |
| think_interval | Interval between two thinks in deciseconds. Shouldn't be too low to prevent lag. |
|---|---|
| think_timer | Think timer handle. |
Procs | |
| chase | Called every Think when we are not close enough to the target. |
| think | Called at regular intervals to determine what to do. |
| within_range | Called every Think when we are close enough to the target. |
Interval between two thinks in deciseconds. Shouldn't be too low to prevent lag.
Think timer handle.
Called every Think when we are not close enough to the target.
Called at regular intervals to determine what to do.
Called every Think when we are close enough to the target.
A generic hallucination based on the Chaser that attacks if close enough.
Vars | |
| attack_chance | Chance to attack per Think spent in range. |
|---|---|
| damage | Stamina damage to heal on hit. |
| should_attack_weakened | Whether to attack if the target is knocked down. |
Procs | |
| attack | Called every Think when we are attacking the target. |
| attack_effects | Called to handle the visual and audio effects of an attack. |
| on_knockdown | Called when one of our attacks put the target in stamina crit. |
Chance to attack per Think spent in range.
Stamina damage to heal on hit.
Whether to attack if the target is knocked down.
Called every Think when we are attacking the target.
+Arguments:
+Called to handle the visual and audio effects of an attack.
Called when one of our attacks put the target in stamina crit.
Vars | |
| owning_hallucination | The hallucination that spawned us. |
|---|---|
The hallucination that spawned us.
Vars | |
| attack_sound | The attack sound to play. Can be a file or text (passed to [/proc/get_sfx]). |
|---|---|
| attack_verb | The attack verb to display. |
The attack sound to play. Can be a file or text (passed to [/proc/get_sfx]).
The attack verb to display.
Displays fake chasms around the target that if crossed, cause them to trip.
Vars | |
| max_amount | Maximum number of chasms to create. |
|---|---|
| min_amount | Minimum number of chasms to create. |
Maximum number of chasms to create.
Minimum number of chasms to create.
Changes the appearance of all humans around the target.
Procs | |
| get_image | Returns the image to use as override to the target's appearance. |
|---|---|
Returns the image to use as override to the target's appearance.
Displays a random alert on the target's HUD.
Vars | |
| alert_category | The alert category that was affected(arc) as part of this hallucination. |
|---|---|
| alerts | The possible alerts to be displayed. Key is alert type, value is alert category. |
| severities | Alert severities. Only needed for some alerts such as temperature or pressure. Key is alert category, value is severity. |
The alert category that was affected(arc) as part of this hallucination.
The possible alerts to be displayed. Key is alert type, value is alert category.
Alert severities. Only needed for some alerts such as temperature or pressure. Key is alert category, value is severity.
Sends a random danger message to the target's chat.
Vars | |
| messages | List of messages that may be displayed. |
|---|---|
List of messages that may be displayed.
Displays a random fake item around the target. If it's on the floor and they try to pick it up, they will trip and fall.
Vars | |
| items | Static list of items this hallucination can be. |
|---|---|
Static list of items this hallucination can be.
Displays a random fake weapon wielded by a human around the target.
Vars | |
| default_icon | The default LEFT-HAND icon file for weapons. Static. |
|---|---|
| right_hand_icons | Static list of RIGHT-HAND counterpart for any LEFT-HAND icon files used above. |
| weapons | Static list of weapons this hallucination can be. Key is icon state, value is LEFT-HAND icon file. |
| wielder | The mob wielding the fake weapon. |
The default LEFT-HAND icon file for weapons. Static.
Static list of RIGHT-HAND counterpart for any LEFT-HAND icon files used above.
Static list of weapons this hallucination can be. Key is icon state, value is LEFT-HAND icon file.
The mob wielding the fake weapon.
A random number of fake husks around the target.
Vars | |
| num_base | The base number of husks to create. |
|---|---|
| variation | The husk number variation, both negative and positive. |
The base number of husks to create.
The husk number variation, both negative and positive.
A progressive hallucination that begins with intermittent explosions, before displaying an energy ball that shocks the target.
Vars | |
| length_phase_1 | Length of phase 1 in deciseconds. |
|---|---|
| length_phase_2 | Length of phase 2 in deciseconds. |
| length_phase_3 | Length of phase 3 in deciseconds. |
Procs | |
| phase_1 | First phase of the hallucination: intermittent, far-away explosion sounds. |
| phase_2 | Second phase of the hallucination: closer explosions and zap sounds from a random direction. |
| phase_3 | Third and final phase of the hallucination: an energy ball that approaches the target before shocking it. |
| phase_3_inner | Called during phase 3 to approach the energy ball towards the target. |
Length of phase 1 in deciseconds.
Length of phase 2 in deciseconds.
Length of phase 3 in deciseconds.
First phase of the hallucination: intermittent, far-away explosion sounds.
Second phase of the hallucination: closer explosions and zap sounds from a random direction.
Third and final phase of the hallucination: an energy ball that approaches the target before shocking it.
Called during phase 3 to approach the energy ball towards the target.
+Arguments:
+A fake plasma flood emanating from a nearby vent.
Vars | |
| expand_delay | The delay at which the plasma flood expands in deciseconds. Shouldn't be too low to prevent lag. |
|---|---|
| expand_queue | List of turfs that need expanding from. |
| expand_timer | Expand timer handle. |
| processed | Associative list of turfs that have already been processed. |
Procs | |
| create_plasma | Creates a fake plasma overlay on the given turf. |
| expand | Called regularly in a timer to process the plasma flooding. |
The delay at which the plasma flood expands in deciseconds. Shouldn't be too low to prevent lag.
List of turfs that need expanding from.
Expand timer handle.
Associative list of turfs that have already been processed.
Creates a fake plasma overlay on the given turf.
+Arguments:
+Called regularly in a timer to process the plasma flooding.
Changes the target's appearance to something else temporarily.
Procs | |
| get_image | Returns the image to use as override to the target's appearance. |
|---|---|
Returns the image to use as override to the target's appearance.
Causes the target to hear a fake message from a random mob around them.
Vars | |
| messages | List of messages that may be heard. |
|---|---|
List of messages that may be heard.
A generic hallucination that causes the target to trip if they cross it.
Vars | |
| stun | Stun to add when crossed. |
|---|---|
| trip_chance | Chance to trip when crossing. |
| weaken | Weaken to add when crossed. |
Procs | |
| on_crossed | Called when the target crosses this hallucination. |
Stun to add when crossed.
Chance to trip when crossing.
Weaken to add when crossed.
Called when the target crosses this hallucination.
An imaginary alien hunter pounces towards the target.
Vars | |
| num_pounces | Maximum number of times the alien will pounce. |
|---|---|
| pounce_interval | How often to pounce in deciseconds. |
| xeno | The xeno hallucination reference. |
Maximum number of times the alien will pounce.
How often to pounce in deciseconds.
The xeno hallucination reference.
Procs | |
| leap_to | Throws the xeno towards the given loc. |
|---|---|
| reset_icon | Resets the xeno's icon to a resting state. |
Throws the xeno towards the given loc.
+Arguments:
+Resets the xeno's icon to a resting state.
Procs | |
| walk_in_direction | Rod will walk towards edge turf in the specified direction. |
|---|---|
Rod will walk towards edge turf in the specified direction.
+Arguments:
+Vars | |
| exit | The target that we're gonna aim for between start and end |
|---|---|
The target that we're gonna aim for between start and end
Mob spawners, spawns a mob and deletes the landmark
Vars | |
| mobtype | The mob we use for the spawner |
|---|---|
The mob we use for the spawner
Vars | |
| connected | Whether the turf of this landmark has already been linked to others during river generation. |
|---|---|
Whether the turf of this landmark has already been linked to others during river generation.
Vars | |
| helper_modules | List of all helper modules being used in this maze |
|---|---|
| loot_modules | List of all loot modules being used in this maze |
| mheight | Maze height |
| mwidth | Maze width |
| potential_loot_spots | Potential loot spots |
| turf_list | List of turfs to iterate in total |
| working_stack | "Stack" structure to be used while iterating |
List of all helper modules being used in this maze
List of all loot modules being used in this maze
Maze height
Maze width
Potential loot spots
List of turfs to iterate in total
"Stack" structure to be used while iterating
Vars | |
| floor_material | Material to make the floor out of |
|---|---|
| open_spots | List of open spots (speeds up calculations) |
| wall_material | Material to make the walls out of |
Material to make the floor out of
List of open spots (speeds up calculations)
Material to make the walls out of
Procs | |
| helper_run | Helper handler proc |
|---|---|
Helper handler proc
+This exists as an overridable method so you can do custom helper logic. +An example of this is removing all windows on a tile.
+Arguments:
+Vars | |
| spawn_probability | Probability for this to spawn in a dead end at all. 0-100%. I dont recommend using values higher than 10 |
|---|---|
Procs | |
| spawn_loot | Loot spawner proc |
Probability for this to spawn in a dead end at all. 0-100%. I dont recommend using values higher than 10
Loot spawner proc
+This exists as an overridable method so you can do more than just spawn objects. +An example of this is spawning a specific mob based on a condition.
+Arguments:
+these mob spawn subtypes trigger immediately (New or Initialize) and are not player controlled... since they're dead, you know?
Vars | |
| corpse_description | what environmental storytelling script should this corpse have |
|---|---|
| naive_corpse_description | optionally different text to display if the target is a clown |
| spawn_when | when this mob spawn should auto trigger. |
what environmental storytelling script should this corpse have
optionally different text to display if the target is a clown
when this mob spawn should auto trigger.
Vars | |
| dna_scrambled | Should we fully dna-scramble these humans? |
|---|---|
Should we fully dna-scramble these humans?
Vars | |
| create_sparks | Whether or not portal use will cause sparks |
|---|---|
| creation_mob_ckey | The ckey of the mob which was responsible for the creation of the portal. For example, the mob who used a wormhole jaunter. |
| creation_obj_data | The UID and name of the object that created this portal. For example, a wormhole jaunter. |
| effect_cooldown | The time after which the effects should play again. Too many effects can lag the server |
| precision | How close to the portal you will teleport. FALSE = on the portal, TRUE = adjacent |
Whether or not portal use will cause sparks
The ckey of the mob which was responsible for the creation of the portal. For example, the mob who used a wormhole jaunter.
The UID and name of the object that created this portal. For example, a wormhole jaunter.
The time after which the effects should play again. Too many effects can lag the server
How close to the portal you will teleport. FALSE = on the portal, TRUE = adjacent
Used to extract contract targets and send them to the Syndicate jail for a few minutes.
Vars | |
| contract | The contract associated with this portal. |
|---|---|
| contractor_mind | The mind of the contractor. Used to tell them they shouldn't be taking the portal. |
| target_mind | The mind of the kidnapping target. Prevents non-targets from taking the portal. |
The contract associated with this portal.
The mind of the contractor. Used to tell them they shouldn't be taking the portal.
The mind of the kidnapping target. Prevents non-targets from taking the portal.
Vars | |
| inactive | If this is TRUE, you will not be able to teleport with that portal |
|---|---|
| unstable_time | After you touch the portal, it will be unstable with high bad teleport chance, this variable contains time when it will be fine again |
If this is TRUE, you will not be able to teleport with that portal
After you touch the portal, it will be unstable with high bad teleport chance, this variable contains time when it will be fine again
Vars | |
| allow_excess_invokers | If nearby cultists will also chant when invoked |
|---|---|
| construct_invoke | If constructs can invoke it |
| cultist_desc | Description that cultists see |
| cultist_name | Name that cultists see |
| desc | Description that non-cultists see |
| invocation | What is said by cultists when the rune is invoked |
| invoke_damage | How much damage cultists take when invoking it (This includes constructs) |
| keyword | The actual keyword for the rune |
| name | Name non-cultists see |
| req_cultists | The amount of cultists required around the rune to invoke it. If only 1, any cultist can invoke it. |
| req_keyword | If the rune requires a keyword (e.g. Teleport runes) |
| rune_blood_color | The color of the rune. (Based on species blood color) |
| rune_in_use | Used for some runes, this is for when you want a rune to not be usable when in use. |
| scribe_damage | How much damage you take from drawing the rune |
| scribe_delay | How long the rune takes to create (Currently only different for the Nar'Sie rune) |
Procs | |
| teleport_effect | Spawns the phase in/out effects for a cult teleport. |
If nearby cultists will also chant when invoked
If constructs can invoke it
Description that cultists see
Name that cultists see
Description that non-cultists see
What is said by cultists when the rune is invoked
How much damage cultists take when invoking it (This includes constructs)
The actual keyword for the rune
Name non-cultists see
The amount of cultists required around the rune to invoke it. If only 1, any cultist can invoke it.
If the rune requires a keyword (e.g. Teleport runes)
The color of the rune. (Based on species blood color)
Used for some runes, this is for when you want a rune to not be usable when in use.
How much damage you take from drawing the rune
How long the rune takes to create (Currently only different for the Nar'Sie rune)
Spawns the phase in/out effects for a cult teleport.
+Arguments:
+When invoked deals up to 30 burn damage to nearby non-cultists and sets them on fire.
+On activation the rune charges for six seconds, changing colour, glowing, and giving out a warning to all nearby mobs. +After the charging period the rune burns any non-cultists in view and sets them on fire. After another short wait it does the same again with slightly higher damage. +If the cultists channeling the rune move away or are stunned at any point, the rune is deleted. So it can be countered pretty easily with flashbangs.
Vars | |
| B | The barrier summoned by the rune when invoked. Tracked as a variable to prevent refreshing the barrier's integrity. shieldgen.dm |
|---|---|
The barrier summoned by the rune when invoked. Tracked as a variable to prevent refreshing the barrier's integrity. shieldgen.dm
Procs | |
| synchronize_variables | Used when we want to pass vars from a spawner to a spawned object |
|---|---|
Used when we want to pass vars from a spawner to a spawned object
+a - The spawned object we want to pass a var to
Can be used to group spawners together so you ensure a certain amount of things are spawned but can be spawned on multiple locations.
+How to use: +Either place the base grouped_spawner in the map and define the group_id to +determine which spawners belong to one another. +Or make a child instance of the grouped_spawner and define the values there.
+When using the base version be sure to define both total_amount and max_per_spawner on +at least one of the spawners of the group. +A mismatch between instances of the same group between these values will lead to a runtime. +So either leave it empty for the rest or have the rest have the same values
Vars | |
| chosen_spawners | Which spawners are chosen to spawn the objects |
|---|---|
| group_id | The id of the group this spawner belongs to. If left empty it'll use the type as id. Define this for map instances if you want to link different spawners up or want to use the base version. |
| max_per_spawner | How many will spawn maximum per spawner. Set this in the map edit tool or in a child instance to set it for all the other instances. |
| max_per_spawner_for_spawners | The list which holds the max_per_spawner values for each spawner group |
| path_to_spawn | Which path will be used to spawn. |
| spawner_groups | The assoc list of grouped spawners. Key = group_id, value = list of spawners with that key |
| total_amount | How many will spawn. Set this in the map edit tool or in a child instance to set it for all the other instances. |
| total_amount_for_spawners | The list which holds the total_amount values for each spawner group |
Procs | |
| get_spawn_values | Sets the spawn values to the values of the first defined instance of this group_id |
| save_spawn_values | Saves the spawn values. Will only pick the first defined version of this group_id |
Which spawners are chosen to spawn the objects
The id of the group this spawner belongs to. If left empty it'll use the type as id. Define this for map instances if you want to link different spawners up or want to use the base version.
How many will spawn maximum per spawner. Set this in the map edit tool or in a child instance to set it for all the other instances.
The list which holds the max_per_spawner values for each spawner group
Which path will be used to spawn.
The assoc list of grouped spawners. Key = group_id, value = list of spawners with that key
How many will spawn. Set this in the map edit tool or in a child instance to set it for all the other instances.
The list which holds the total_amount values for each spawner group
Sets the spawn values to the values of the first defined instance of this group_id
Saves the spawn values. Will only pick the first defined version of this group_id
Procs | |
| Initialize | CONTRABAND STUFF |
|---|---|
CONTRABAND STUFF
Vars | |
| remaining_tiles | The number of tiles to spread to. Each new chosen tile receives this +value decremented by one, ensuring the maximum size of the mess is limited +by the original spawner's value. |
|---|---|
The number of tiles to spread to. Each new chosen tile receives this +value decremented by one, ensuring the maximum size of the mess is limited +by the original spawner's value.
Vars | |
| id | Used to link electrochromic windows to buttons |
|---|---|
Used to link electrochromic windows to buttons
The portal used in the /datum/event/tear midround.
Vars | |
| leader | What the leader of the dimensional tear will be |
|---|---|
What the leader of the dimensional tear will be
Vars | |
| matrix_end | The color matrix it should be by the time it despawns |
|---|---|
| matrix_start | The color matrix it should be at spawn |
The color matrix it should be by the time it despawns
The color matrix it should be at spawn
Vars | |
| explosion_smoke | Explosion smoke particle holder |
|---|---|
| smoke_wave | Smoke wave particle holder |
| sparks | Sparks particle holder |
Procs | |
| generate_particles | Generate the particles |
Explosion smoke particle holder
Smoke wave particle holder
Sparks particle holder
Generate the particles
A visual effect that will be shown only to a particular user for a period of time.
Vars | |
| displayed_image | The image to show to the user |
|---|---|
| image_icon | The icon to pull the image from |
| image_icon_state | The real icon state to be applied to the image |
| image_layer | The layer to apply the image to |
| image_plane | The plane to apply the image to |
| source_UID | The UID of the person who the image is being displayed to |
Procs | |
| add_mind | Add the image to the user's screen |
| remove_mind | Remove the image from the user's screen |
The image to show to the user
The icon to pull the image from
The real icon state to be applied to the image
The layer to apply the image to
The plane to apply the image to
The UID of the person who the image is being displayed to
Add the image to the user's screen
Remove the image from the user's screen
Vars | |
| modsuit_image | The image shown to modsuit users |
|---|---|
| real_icon_state | The icon state applied to the image created for this ping. |
| source_UID | The person in the modsuit at the moment, really just used to remove this from their screen |
Procs | |
| add_mind | Add the image to the modsuit wearer's screen |
| remove_mind | Remove the image from the modsuit wearer's screen |
The image shown to modsuit users
The icon state applied to the image created for this ping.
The person in the modsuit at the moment, really just used to remove this from their screen
Add the image to the modsuit wearer's screen
Remove the image from the modsuit wearer's screen
Orbiting visual which shoots at mining mobs
Vars | |
| fire_delay | Time between taking potshots at goliaths |
|---|---|
| on_death_multiplier | How much faster do we shoot when avenging our parent? |
| parent | Who are we following? |
| projectile_sound | Sound to make when we shoot |
| projectile_type | Type of projectile we fire |
| shot_cooldown | Time taken between shots |
| target_faction | Types of mobs to attack |
| tracker | Datum which keeps us hanging out with our parent |
Procs | |
| follow | Set ourselves up to track and orbit around a guy |
| on_parent_deleted | Called if the guy we're tracking is deleted somehow |
| on_parent_died | We must guard this corpse |
| on_parent_moved | Follow our parent |
| on_parent_revived | Exit hyperactive mode |
| orbit_animation | Do our orbiting animation |
| shoot_at | Take a shot |
Time between taking potshots at goliaths
How much faster do we shoot when avenging our parent?
Who are we following?
Sound to make when we shoot
Type of projectile we fire
Time taken between shots
Types of mobs to attack
Datum which keeps us hanging out with our parent
Set ourselves up to track and orbit around a guy
Called if the guy we're tracking is deleted somehow
We must guard this corpse
Follow our parent
Exit hyperactive mode
Do our orbiting animation
Take a shot
Vars | |
| armour_penetration_flat | Flat armour reduction, occurs after percentage armour penetration. |
|---|---|
| armour_penetration_percentage | Percentage armour reduction, happens before flat armour reduction. |
| attack_effect_override | Allows you to override the attack animation with an attack effect |
| drop_sound | Sound uses when dropping the item, or when its thrown. |
| equip_sound | Sound used when equipping the item into a valid slot |
| hit_reaction_chance | Used to give a reaction chance on hit that is not a block. If less than 0, will remove the block message, allowing overides. |
| hitsound | Sound played when you hit something with the item |
| in_storage | Is this item inside a storage object? |
| item_state | The icon state used to display the item in your inventory. If null then the icon_state value itself will be used |
| mob_throw_hit_sound | Used when yate into a mob |
| outline_filter | Holder var for the item outline filter, null when no outline filter on the item. |
| pickup_sound | Sound uses when picking the item up (into your hands) |
| reach | In tiles, how far this weapon can reach; 1 for adjacent, which is default |
| stealthy_audio | Whether or not we use stealthy audio levels for this item's attack sounds |
| thrownby | UID of a /mob |
| usesound | Played when the item is used, for example tools |
Procs | |
| can_enter_storage | Called to check if this item can be put into a storage item. |
| cyborg_recharge | Called on cyborg items that need special charging behavior. Override as needed for specific items. |
| dropped | Called when a mob drops an item. |
| get_job_name | Used in secHUD icon generation |
| is_robot_module | Checks whether this item is a module of the robot it is located in. |
| use_tool | Called when a mob tries to use the item as a tool. +Handles most checks. |
Flat armour reduction, occurs after percentage armour penetration.
Percentage armour reduction, happens before flat armour reduction.
Allows you to override the attack animation with an attack effect
Sound uses when dropping the item, or when its thrown.
Sound used when equipping the item into a valid slot
Used to give a reaction chance on hit that is not a block. If less than 0, will remove the block message, allowing overides.
Sound played when you hit something with the item
Is this item inside a storage object?
The icon state used to display the item in your inventory. If null then the icon_state value itself will be used
Used when yate into a mob
Holder var for the item outline filter, null when no outline filter on the item.
Sound uses when picking the item up (into your hands)
In tiles, how far this weapon can reach; 1 for adjacent, which is default
Whether or not we use stealthy audio levels for this item's attack sounds
UID of a /mob
Played when the item is used, for example tools
Called to check if this item can be put into a storage item.
+Return FALSE if src can't be inserted, and TRUE if it can.
+Arguments:
src is being inserted into.Called on cyborg items that need special charging behavior. Override as needed for specific items.
Called when a mob drops an item.
Used in secHUD icon generation
Checks whether this item is a module of the robot it is located in.
Called when a mob tries to use the item as a tool. +Handles most checks.
Procs | |
| handle_unique_ai | what this module should do if it is mapload spawning on a unique AI station trait round. |
|---|---|
what this module should do if it is mapload spawning on a unique AI station trait round.
Vars | |
| door_accesses_list | An associative list containing all station accesses. Includes their name and access number. |
|---|---|
| is_installed | Is this electronic installed in a door? |
| max_brain_damage | Maximum brain damage a mob can have until it can't use the electronics |
| one_access | Is the door access using req_one_access (TRUE) or req_access (FALSE) |
| selected_accesses | List of accesses currently set |
| unres_access_from | Which direction has unrestricted access to the airlock (e.g. medbay doors from the inside) |
An associative list containing all station accesses. Includes their name and access number.
Is this electronic installed in a door?
Maximum brain damage a mob can have until it can't use the electronics
Is the door access using req_one_access (TRUE) or req_access (FALSE)
List of accesses currently set
Which direction has unrestricted access to the airlock (e.g. medbay doors from the inside)
Vars | |
| being_loaded | A var to check if the mag is being loaded |
|---|---|
| double_loaded | There are two reloading processes ongoing so cancel them |
A var to check if the mag is being loaded
There are two reloading processes ongoing so cancel them
Vars | |
| muzzle_flash_color | What color the flash has. If null then the flash won't cause lighting |
|---|---|
| muzzle_flash_effect | What type of muzzle flash effect will be shown. If null then no effect and flash of light will be shown |
| muzzle_flash_range | What range the muzzle flash has |
| muzzle_flash_strength | How strong the flash is |
What color the flash has. If null then the flash won't cause lighting
What type of muzzle flash effect will be shown. If null then no effect and flash of light will be shown
What range the muzzle flash has
How strong the flash is
Vars | |
| random_link_number | This number is randomly generated when the arc revolver is made. This ensures the beams only link to beams from the gun, one lower or higher than the number on the boosted object. |
|---|---|
This number is randomly generated when the arc revolver is made. This ensures the beams only link to beams from the gun, one lower or higher than the number on the boosted object.
Procs | |
| activate | What the device does when turned on |
|---|---|
| attach_assembly | Called when an assembly is attacked by another |
| holder_movement | Called when the holder is moved |
| interact | Called when attack_self is called |
| process_cooldown | Called to constantly step down the countdown/cooldown |
| pulse | Called when this device attempts to act on another device, var/radio determines if it was sent via radio or direct |
| pulsed | Called when another assembly acts on this one, var/radio will determine where it came from for wire calcs |
| toggle_secure | Happens when the assembly is (un)secured |
What the device does when turned on
Called when an assembly is attacked by another
Called when the holder is moved
Called when attack_self is called
Called to constantly step down the countdown/cooldown
Called when this device attempts to act on another device, var/radio determines if it was sent via radio or direct
Called when another assembly acts on this one, var/radio will determine where it came from for wire calcs
Happens when the assembly is (un)secured
Vars | |
| alarm_health | The health amount on which to activate |
|---|---|
| scanning | Are we scanning our user's health? |
| user_health | Our user's health |
The health amount on which to activate
Are we scanning our user's health?
Our user's health
Vars | |
| code | Signal code |
|---|---|
| frequency | Signal freqency itself |
| receiving | Are we set to receieve a signal? |
Procs | |
| signal | Called from activate(), actually invokes the signal on other signallers in the world |
Signal code
Signal freqency itself
Are we set to receieve a signal?
Called from activate(), actually invokes the signal on other signallers in the world
Vars | |
| computer | Associated Library Computer, needed to perform actions |
|---|---|
Associated Library Computer, needed to perform actions
Vars | |
| restricts_access | Restricts the sign to bar access if TRUE |
|---|---|
Restricts the sign to bar access if TRUE
Vars | |
| on_throwing_cooldown | Is this item on cooldown from being thrown |
|---|---|
| recharge_ticks | How many SSobj ticks have passed (Roughly 2 seconds of in game time), used to see when to recharge a use on this item |
| times_used | How many times the mind batter has been used |
Is this item on cooldown from being thrown
How many SSobj ticks have passed (Roughly 2 seconds of in game time), used to see when to recharge a use on this item
How many times the mind batter has been used
Vars | |
| dribbleable | Whether attack_self will move ("dribble") it to the other hand |
|---|---|
Whether attack_self will move ("dribble") it to the other hand
Code for implants that can be inserted into a person and have some sort of passive or triggered action.
Vars | |
| activated | How the implant is activated. |
|---|---|
| allow_multiple | Whether multiple implants of this same type can be inserted into someone. |
| has_triggered_on_death | Whether this implant has already triggered on death or not, to prevent it firing multiple times. |
| imp_in | Who the implant is inside of. |
| implant_data | the implant_fluff datum attached to this implant, purely cosmetic "lore" information |
| implant_state | which implant overlay should be used for implant cases. This should point to a state in bio_chips.dmi |
| implanted | Whether the implant is implanted. Null if it's never been inserted, TRUE if it's currently inside someone, or FALSE if it's been removed. |
| trigger_causes | What type of action will trigger this emote. Bitfield of IMPLANT_EMOTE_* defines. |
| trigger_emotes | List of emote keys that activate this implant when used. |
| uses | Amount of times that the implant can be triggered by the user. If the implant can't be used, it can't be inserted. |
Procs | |
| can_implant | Check that we can actually implant this before implanting it |
| implant | Try to implant ourselves into a mob. |
| removed | Clean up when an implant is removed. |
| set_trigger | Set the emote that will trigger the implant. |
How the implant is activated.
Whether multiple implants of this same type can be inserted into someone.
Whether this implant has already triggered on death or not, to prevent it firing multiple times.
Who the implant is inside of.
the implant_fluff datum attached to this implant, purely cosmetic "lore" information
which implant overlay should be used for implant cases. This should point to a state in bio_chips.dmi
Whether the implant is implanted. Null if it's never been inserted, TRUE if it's currently inside someone, or FALSE if it's been removed.
What type of action will trigger this emote. Bitfield of IMPLANT_EMOTE_* defines.
List of emote keys that activate this implant when used.
Amount of times that the implant can be triggered by the user. If the implant can't be used, it can't be inserted.
Check that we can actually implant this before implanting it
+Returns +TRUE - I could care less, implant it, maybe don't. I don't care. +FALSE - Don't implant!
Try to implant ourselves into a mob.
+Returns +1 if the implant injects successfully +-1 if the implant fails to inject +0 if there's no room for the implant.
Clean up when an implant is removed.
+Set the emote that will trigger the implant.
+Procs | |
| self_destruct | Gib the implantee and delete their destructible contents. |
|---|---|
Gib the implantee and delete their destructible contents.
Vars | |
| jet_icon | The jet icon we apply to the MOD. |
|---|---|
| module | The pathfinder module we are linked to. |
| path | List of turfs through which a mod 'steps' to reach the waypoint |
| target | The target turf we are after |
| tries | How many times have we tried to move? |
The jet icon we apply to the MOD.
The pathfinder module we are linked to.
List of turfs through which a mod 'steps' to reach the waypoint
The target turf we are after
How many times have we tried to move?
Vars | |
| mindslave_UID | The UID of the mindslave's mind. Stored to solve GC race conditions and ensure we can remove their mindslave status even when they're deleted or gibbed. |
|---|---|
The UID of the mindslave's mind. Stored to solve GC race conditions and ensure we can remove their mindslave status even when they're deleted or gibbed.
Vars | |
| let_people_choose | If a person can choose what the card produces. No cost if they can choose. |
|---|---|
If a person can choose what the card produces. No cost if they can choose.
Game Object which stores pages of text usually written by players, has other editable information such as the book's +title, author, summary, and categories. Has other values that are generated when books are acquired through the library +computer.
+Like other User Interfaces that heavily rely on player input, using newer tools such as TGUI presents sanitization issues +so books will remain using BrowserUI until further notice.
Vars | |
| author | Who wrote the book, can be changed by pen or PC |
|---|---|
| book_bgcolor | The background color of the book, useful for themed programmatic books, must be in #FFFFFF hex color format |
| book_height | Book UI Popup Height |
| book_width | Book UI Popup Width |
| brain_damage_cooldown | Cooldown for brain damage loss when reading |
| carved | Indicates whether or not a books pages have been carved out |
| categories | Book Categories - used for differentiating types of books, set by players upon upload, viewable upon examining book |
| copyright | Prevents book from being uploaded - For all printed books |
| current_page | What page is the book currently opened to? Page 0 - Intro Page | Page 1-5 - Content Pages |
| libraryid | Book's id within the library system, unique to each book object, should not be declared manually |
| pages | Content Pages of the books, this variable is a list of strings containting the HTML + Text of each page |
| protected | Prevents book contents from being edited |
| rating | Book Rating - Assigned by library computer based on how many/how players have rated this book |
| store | Item that is stored inside the book |
| summary | Short summary of the contents of the book, can be changed by pen or PC |
| title | Title & Real name of the book |
Procs | |
| can_read | Internal Checker Proc |
| clear_stored_item | needed for proper GC'ing |
| edit_book | Edit Book Proc |
| read_book | Read Book Proc |
| show_content | Show Content Proc |
Who wrote the book, can be changed by pen or PC
The background color of the book, useful for themed programmatic books, must be in #FFFFFF hex color format
Book UI Popup Height
Book UI Popup Width
Cooldown for brain damage loss when reading
Indicates whether or not a books pages have been carved out
Book Categories - used for differentiating types of books, set by players upon upload, viewable upon examining book
Prevents book from being uploaded - For all printed books
What page is the book currently opened to? Page 0 - Intro Page | Page 1-5 - Content Pages
Book's id within the library system, unique to each book object, should not be declared manually
Content Pages of the books, this variable is a list of strings containting the HTML + Text of each page
Prevents book contents from being edited
Book Rating - Assigned by library computer based on how many/how players have rated this book
Item that is stored inside the book
Short summary of the contents of the book, can be changed by pen or PC
Title & Real name of the book
Internal Checker Proc
+Gives free pass to observers to read, ensures that all other mobs attempting to read book are A) literated and +B) are within range to actually read the book.
needed for proper GC'ing
Edit Book Proc
+This is where a lot of the magic happens, upon interacting with the book with a pen, this proc will open up options +for the player to edit the book. Most importantly, this is where we account for player stupidity and maliciousness +any input must strip/reject bad text and HTML from user input, additionally we account for players trying to screw +with the Database. This will also limit the max characters players can upload at one time to prevent spamming.
Read Book Proc
+Checks if players is able to read book and that book is readable before calling the neccesary procs to open up UI
Show Content Proc
+Builds the browserUI html to show to the player then open up the User interface. It first build the header navigation +buttons and then builds the rest of the UI based on what page the player is turned to.
Books that teach things.
+(Intrinsic actions like bar flinging, spells like fireball or smoke, or martial arts)
Vars | |
| book_sounds | The sounds played as the user's reading the book. |
|---|---|
| pages_to_mastery | Controls how long a mob must keep the book in his hand to actually successfully learn |
| reading | Sanity, whether it's currently being read |
| reading_time | The time it takes to read the book |
| remarks | Flavor messages displayed to mobs reading the granter |
| uses | The amount of uses on the granter. |
Procs | |
| can_learn | Checks if the user can learn whatever this granter... grants |
| on_reading_finished | Called when the reading is completely finished. This is where the actual granting should happen. |
| on_reading_start | Called when the user starts to read the granter. |
| on_reading_stopped | Called when the reading is interrupted without finishing. |
| recoil | Effects that occur whenever the book is read when it has no uses left. |
| turn_page | The actual "turning over of the page" flavor bit that happens while someone is reading the granter. |
The sounds played as the user's reading the book.
Controls how long a mob must keep the book in his hand to actually successfully learn
Sanity, whether it's currently being read
The time it takes to read the book
Flavor messages displayed to mobs reading the granter
The amount of uses on the granter.
Checks if the user can learn whatever this granter... grants
Called when the reading is completely finished. This is where the actual granting should happen.
Called when the user starts to read the granter.
Called when the reading is interrupted without finishing.
Effects that occur whenever the book is read when it has no uses left.
The actual "turning over of the page" flavor bit that happens while someone is reading the granter.
Vars | |
| action_name | The name of the action, formatted in a more text-friendly way. |
|---|---|
| granted_action | The typepath of action that is given |
The name of the action, formatted in a more text-friendly way.
The typepath of action that is given
Vars | |
| crafting_recipe_types | A list of all recipe types we grant on learn |
|---|---|
A list of all recipe types we grant on learn
Vars | |
| granted_spell | The typepath of spell that is given |
|---|---|
| spell_name | The name of the spell, formatted in a more text-friendly way |
The typepath of spell that is given
The name of the spell, formatted in a more text-friendly way
These are "programmatic books," that is books that are hard-coded into the game. Just for the sake of maintainability, keep +information subject to change (as in likely to change SOON) out of the non-wiki manuals as they require PRs to change +and it is not an author's responsbility to update manuals if they change a mechanic/recipe/feature referenced in one of them +Don't worry about adding them to the library, as long as they're one of these types it is automatically added.
+Longer Guides should really be a '/obj/item/book/manual/wiki' type book and be tethered to a wiki page, this is because wiki pages +outside of SOP & Space Law can be very easily changed and do not require going through the Pull Request process. The benefits of +these are that they can be illustrated, filled with tables, and changed without affecting the codebase.
+However, contributors should avoid making every book/page tethered to a wiki page for a few reasons:
+These are programmatic books that source its pages / "content" straight from the wiki +That means that this content can ONLY be changed by editing the wiki +Space Law and SOP Manuals can only be edited by Wiki Admins
+These are automated well enough that as long as the link to the wiki is set correctly in the config and the article name is correct +these will display (mostly) CSS stripped wiki pages in them.
Vars | |
| wiki_article_title | The Article title of the wiki page being opened in the |
|---|---|