List of all turfs currently inside this area. Acts as a filtered bersion of area.contents
+For faster lookup (area.contents is actually a filtered loop over world)
+Semi fragile, but it prevents stupid so I think it's worth it
Contained turfs is a MASSIVE list, so rather then adding/removing from it each time we have a problem turf
+We should instead store a list of turfs to REMOVE from it, then hook into a getter for it
+There is a risk of this and contained_turfs leaking, so a subsystem will run it down to 0 incrementally if it gets too large
List of all turfs currently inside this area. Acts as a filtered bersion of area.contents
+For faster lookup (area.contents is actually a filtered loop over world)
+Semi fragile, but it prevents stupid so I think it's worth it
Contained turfs is a MASSIVE list, so rather then adding/removing from it each time we have a problem turf
+We should instead store a list of turfs to REMOVE from it, then hook into a getter for it
+There is a risk of this and contained_turfs leaking, so a subsystem will run it down to 0 incrementally if it gets too large
Proc Details
AllowDrop
+
+
Causes a runtime error
Destroy
+
+
Destroy an area and clean it up
+
Removes the area from GLOB.areas_by_type and also stops it processing on SSobj
+
This is despite the fact that no code appears to put it on SSobj, but
+who am I to argue with old coders
Entered
+
+
Call back when an atom enters an area
+
Sends signals COMSIG_AREA_ENTERED and COMSIG_ENTER_AREA (to a list of atoms)
+
If the area has ambience, then it plays some ambience music to the ambience channel
Exited
+
+
Called when an atom exits an area
+
Sends signals COMSIG_AREA_EXITED and COMSIG_EXIT_AREA (to a list of atoms)
LateInitialize
+
+
Sets machine power levels in the area
New
+
+
Called when an area loads
+
Adds the item to the GLOB.areas_by_type list based on area type
PlaceOnTopReact
+
+
A hook so areas can modify the incoming args (of what??)
addStaticPower
+
+
Add a static amount of power load to an area
+
Possible channels
+*AREA_USAGE_STATIC_EQUIP
+*AREA_USAGE_STATIC_LIGHT
+*AREA_USAGE_STATIC_ENVIRON
adjust_spook_level
+
+
Adjusts the spook level and sends out a signal
burglaralert
+
+
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
cannonize_contained_turfs
+
+
Ensures that the contained_turfs list properly represents the turfs actually inside us
clear_usage
+
+
Clear all non-static power usage in area
+
Clears all power used for the dynamic equipment, light and environment channels
close_and_lock_door
+
+
Close and lock a door passed into this proc
+
Does this need to exist on area? probably not
communicate_fire_alert
+
+
Called by airalarms and firealarms to communicate the status of the area to relevant machines
create_area_lighting_objects
+
+
regenerates lighting objects for turfs in this area, primary use is VV changes
drop_location
+
+
Causes a runtime error
has_contained_turfs
+
+
Returns TRUE if we have contained turfs, FALSE otherwise
on_joining_game
+
+
Called when a living mob that spawned here, joining the round, receives the player client.
play_ambience
+
+
Attempts to play an ambient sound to a mob, returning the cooldown in deciseconds
power_change
+
+
Called when the area power status changes
+
Updates the area icon, calls power change on all machinees in the area, and sends the COMSIG_AREA_POWER_CHANGE signal.
powered
+
+
Returns int 1 or 0 if the area has power for the given channel
+
evalutes a mixture of variables mappers can set, requires_power, always_unpowered and then
+per channel power_equip, power_light, power_environ
reg_in_areas_in_z
+
+
Register this area as belonging to a z level
+
Ensures the item is added to the SSmapping.areas_in_z list for this z
removeStaticPower
+
+
Remove a static amount of power load to an area
+
Possible channels
+*AREA_USAGE_STATIC_EQUIP
+*AREA_USAGE_STATIC_LIGHT
+*AREA_USAGE_STATIC_ENVIRON
remove_area_lighting_objects
+
+
Removes lighting objects from turfs in this area if we have them, primary use is VV changes
setup
+
+
Setup an area (with the given name)
+
Sets the area name, sets all status var's to false and adds the area to the sorted area list
update_areasize
+
+
Set the area size of the area
+
This is the number of open turfs in the area contents, or FALSE if the outdoors var is set
update_beauty
+
+
Divides total beauty in the room by roomsize to allow us to get an average beauty per tile.
use_power
+
+
Add a power value amount to the stored used_x variables
Some sounds (like the space jam) are terrible when on loop. We use this varaible to add it to other AI areas, but override it to keep it from the AI's core.
Some sounds (like the space jam) are terrible when on loop. We use this varaible to add it to other AI areas, but override it to keep it from the AI's core.
+
+
+
diff --git a/area/station/maintenance.html b/area/station/maintenance.html
new file mode 100644
index 000000000000..8bc3a27944b1
--- /dev/null
+++ b/area/station/maintenance.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /area/station/maintenance - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
AI controller that controls this atom. type on init, then turned into an instance during runtime.
+Note: If you are for some reason giving this to a non-mob, it needs to create it's own in Initialize()
The custom materials this atom is made of, used by a lot of things like furniture, walls, and floors (if I finish the functionality, that is.)
+The list referenced by this var can be shared by multiple objects and should not be directly modified. Instead, use set_custom_materials.
all of this atom's HUD (med/sec, etc) images. Associative list of the form: list(hud category = hud image or images for that category).
+most of the time hud category is associated with a single image, sometimes its associated with a list of images.
+not every hud in this list is actually used. for ones available for others to see, look at active_hud_list.
Any light sources that are "inside" of us, for example, if src here was a mob that's carrying a flashlight, that flashlight's light source would be part of this list.
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.
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.
This is what you use to start a beam. Example: origin.Beam(target, args). Store the return of this proc if you don't set maxdist or time, you need it to delete the beam.
Before anything else, defer these calls to a per-mobtype handler. This allows us to
+remove istype() spaghetti code, but requires the addition of other handler procs to simplify it.
Creates a "Type-B" contextual screentip interaction.
+When a user hovers over this, this proc will be called in order
+to provide context for contextual screentips.
+You must call register_context() in order for this to be registered.
+A screentip context list is a list that has context keys (SCREENTIP_CONTEXT_*, from __DEFINES/screentips.dm)
+that map to the action as text.
+If you mutate the list in this signal, you must return CONTEXTUAL_SCREENTIP_SET.
+source can, in all cases, be replaced with src, and only exists because this proc directly connects to a signal.
A cut-out proc for /atom/proc/bullet_act so living mobs can have their own armor behavior checks without causing issues with needing their own on_hit call
Retrieves the atom's current damage as a percentage where 100% is 100.
+If use_raw_values is TRUE, uses the raw var values instead of the get_* proc results.
Fired whenever this atom is the most recent to be hovered over in the tick.
+Preferred over MouseEntered if you do not need information such as the position of the mouse.
+Especially because this is deferred over a tick, do not trust that client is not null.
Create a "Type-B" contextual screentip interaction, registering to add_context().
+This will run add_context() when the atom is hovered over by an item for context.
+add_context() will not be called unless this is run.
+This is not necessary for Type-B interactions, as you can just apply the flag and register to the signal yourself.
Handles updates to greyscale value updates.
+The colors argument can be either a list or the full color string.
+Child procs should call parent last so the update happens after all changes.
Updates whatever openspace objects may be mimicking us. On turfs this queues an openturf update on the above openturf, on movables this updates their bound movable (if present). Meaningless on any type other than /turf or /atom/movable (incl. children).
AI controller that controls this atom. type on init, then turned into an instance during runtime.
+Note: If you are for some reason giving this to a non-mob, it needs to create it's own in Initialize()
The custom materials this atom is made of, used by a lot of things like furniture, walls, and floors (if I finish the functionality, that is.)
+The list referenced by this var can be shared by multiple objects and should not be directly modified. Instead, use set_custom_materials.
all of this atom's HUD (med/sec, etc) images. Associative list of the form: list(hud category = hud image or images for that category).
+most of the time hud category is associated with a single image, sometimes its associated with a list of images.
+not every hud in this list is actually used. for ones available for others to see, look at active_hud_list.
Any light sources that are "inside" of us, for example, if src here was a mob that's carrying a flashlight, that flashlight's light source would be part of this list.
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.
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.
any atom that uses integrity and can be damaged must set this to true, otherwise the integrity procs will throw an error
Proc Details
AllowDrop
+
+
Are you allowed to drop this atom
AltClickNoInteract
+
+
Use this instead of /mob/proc/AltClickOn where you only want turf content listing without additional atom alt-click interaction
Beam
+
+
This is what you use to start a beam. Example: origin.Beam(target, args). Store the return of this proc if you don't set maxdist or time, you need it to delete the beam.
+
Unless you're making a custom beam effect (see the beam_type argument), you won't actually have to mess with any other procs. Make sure you store the return of this Proc, you'll need it
+to kill the beam.
+Arguments:
+BeamTarget: Where you're beaming from. Where do you get origin? You didn't read the docs, fuck you.
+icon_state: What the beam's icon_state is. The datum effect isn't the ebeam object, it doesn't hold any icon and isn't type dependent.
+icon: What the beam's icon file is. Don't change this, man. All beam icons should be in beam.dmi anyways.
+maxdistance: how far the beam will go before stopping itself. Used mainly for two things: preventing lag if the beam may go in that direction and setting a range to abilities that use beams.
+beam_type: The type of your custom beam. This is for adding other wacky stuff for your beam only. Most likely, you won't (and shouldn't) change it.
CanAStarPass
+
+
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:
+
+
to_dir - What direction we're trying to move in, relevant for things like directional windows that only block movement in certain directions
+
pass_info - Datum that stores info about the thing that's trying to pass us
+
+
IMPORTANT NOTE: /turf/proc/LinkBlockedWithAccess assumes that overrides of CanAStarPass will always return true if density is FALSE
+If this is NOT you, ensure you edit your can_astar_pass variable. Check __DEFINES/path.dm
CanAllowThrough
+
+
Returns true or false to allow the mover to move through src
CanMoveOnto
+
+
A version of CanPass() that accounts for vertical movement.
CanPass
+
+
Whether the mover object can avoid being blocked by this atom, while arriving from (or leaving through) the border_dir.
CheckParts
+
+
Ensure a list of atoms/reagents exists inside this atom
+
Goes throught he list of passed in parts, if they're reagents, adds them to our reagent holder
+creating the reagent holder if it exists.
+
If the part is a moveable atom and the previous location of the item was a mob/living,
+it calls the inventory handler transferItemToLoc for that mob/living and transfers the part
+to this atom
+
Otherwise it simply forceMoves the atom into this atom
Click
+
+
Before anything else, defer these calls to a per-mobtype handler. This allows us to
+remove istype() spaghetti code, but requires the addition of other handler procs to simplify it.
+
Alternately, you could hardcode every mob's variation in a flat /mob/proc/ClickOn proc; however,
+that's a lot of code duplication and is hard to maintain.
+
Note that this proc can be overridden, and is in the case of screen objects.
Destroy
+
+
Top level of the destroy chain for most atoms
+
Cleans up the following:
+
+
Removes alternate apperances from huds that see them
returns how much the object blocks an explosion. Used by subtypes.
GetMergeGroup
+
+
Gets a merger datum representing the connected blob of objects in the allowed_types argument
HasProximity
+
+
Is this atom within 1 tile of another atom
Initialize
+
+
The primary method that objects are setup in SS13 with
+
we don't use New as we have better control over when this is called and we can choose
+to delay calls or hook other logic in and so forth
+
During roundstart map parsing, atoms are queued for intialization in the base atom/New(),
+After the map has loaded, then Initalize is called on all atoms one by one. NB: this
+is also true for loading map templates as well, so they don't Initalize until all objects
+in the map file are parsed and present in the world
+
If you're creating an object at any point after SSInit has run then this proc will be
+immediately be called from New.
+
mapload: This parameter is true if the atom being loaded is either being intialized during
+the Atom subsystem intialization, or if the atom is being loaded from the map template.
+If the item is being created at runtime any time after the Atom subsystem is intialized then
+it's false.
+
The mapload argument occupies the same position as loc when Initialize() is called by New().
+loc will no longer be needed after it passed New(), and thus it is being overwritten
+with mapload at the end of atom/New() before this proc (atom/Initialize()) is called.
+
You must always call the parent of this proc, otherwise failures will occur as the item
+will not be seen as initalized (this can lead to all sorts of strange behaviour, like
+the item being completely unclickable)
+
You must not sleep in this proc, or any subprocs
+
Any parameters from new are passed through (excluding loc), naturally if you're loading from a map
+there are no other arguments
Is the atom obscured by a PREVENT_CLICK_UNDER_1 object above it
LateInitialize
+
+
Late Intialization, for code that should run after all atoms have run Intialization
+
To have your LateIntialize proc be called, your atoms Initalization
+proc must return the hint
+INITIALIZE_HINT_LATELOAD otherwise you will never be called.
+
useful for doing things like finding other machines using INSTANCES_OF() because you can guarantee
+that all atoms will actually exist in the "WORLD" at this time and that all their Intialization
+code has been run
New
+
+
Called when an atom is created in byond (built in engine proc)
+
Not a lot happens here in SS13 code, as we offload most of the work to the
+Intialization proc, mostly we run the preloader
+if the preloader is being used and then call InitAtom of which the ultimate
+result is that the Intialize proc is called.
Shake
+
+
Perform a shake on an atom, resets its position afterwards
ShowProcessingGui
+
+
Creates the radial and processes the selected option
Topic
+
+
Passes Stat Browser Panel clicks to the game and calls client click on an atom
_Click
+
+
stupid workaround for byond not recognizing the /atom/Click typepath for the queued click callbacks
Adds an instance of colour_type to the atom's atom_colours list
add_blood_DNA
+
+
Returns TRUE if new blood dna was added.
add_context
+
+
Creates a "Type-B" contextual screentip interaction.
+When a user hovers over this, this proc will be called in order
+to provide context for contextual screentips.
+You must call register_context() in order for this to be registered.
+A screentip context list is a list that has context keys (SCREENTIP_CONTEXT_*, from __DEFINES/screentips.dm)
+that map to the action as text.
+If you mutate the list in this signal, you must return CONTEXTUAL_SCREENTIP_SET.
+source can, in all cases, be replaced with src, and only exists because this proc directly connects to a signal.
add_fiber_list
+
+
Add a list of fibers
add_fibers
+
+
Adds the fibers of M to our fiber list.
add_fingerprint
+
+
Adds the fingerprint of M to our fingerprint list. Ignoregloves will ignore any gloves they may be wearing.
add_fingerprint_list
+
+
Add a list of fingerprints
add_gunshot_residue
+
+
Add a list of residues
add_mob_blood
+
+
to add blood from a mob onto something, and transfer their dna info
airflow_hit_act
+
+
Called when "flying" calls airflow_hit() on src
alt_click_on_secondary
+
+
The base proc of when something is right clicked on when alt is held - generally use alt_click_secondary instead
alt_click_secondary
+
+
The base proc of when something is right clicked on when alt is held
analyzer_act
+
+
Called on an object when a tool with analyzer capabilities is used to left click an object
analyzer_act_secondary
+
+
Called on an object when a tool with analyzer capabilities is used to right click an object
assume_air
+
+
Take air from the passed in gas mixture datum
atmos_expose
+
+
This is your process() proc
atom_break
+
+
Called after the atom takes damage and integrity is below integrity_failure level
atom_destruction
+
+
what happens when the atom's integrity reaches zero.
atom_fix
+
+
Called when integrity is repaired above the breaking point having been broken before
attack_ai_secondary
+
+
What happens when the AI holds right-click on an item. Returns a SECONDARY_ATTACK_* value.
+
Arguments:
+
+
user The mob holding the right click
+
modifiers The list of the custom click modifiers
+
attack_drone
+
+
Defaults to attack_hand or attack_hand_secondary. Override it when you don't want drones to do same stuff as humans.
attack_grab
+
+
Interaction handler for being clicked on with a grab. This is called regardless of user intent.
+
Parameters:
+
+
grab - The grab item being used.
+
click_params - List of click parameters.
+
+
Returns boolean to indicate whether the attack call was handled or not. If FALSE, the next use_* proc in the
+resolve chain will be called.
attack_hand
+
+
Return TRUE to cancel other attack hand effects that respect it. Modifiers is the assoc list for click info such as if it was a right click.
attack_hand_secondary
+
+
When the user uses their hand on an item while holding right-click
+Returns a SECONDARY_ATTACK_* value.
attack_hulk
+
+
This atom has been hit by a hulkified mob in hulk mode (user)
attack_paw
+
+
Attacked by monkey
attack_robot_secondary
+
+
What happens when the cyborg without active module holds right-click on an item. Returns a SECONDARY_ATTACK_* value.
+
Arguments:
+
+
user The mob holding the right click
+
modifiers The list of the custom click modifiers
+
attack_self_tk
+
+
Telekinesis item attack_self act.
+
+
This is similar to item attack_self, but applies to anything that you can grab with a telekinetic grab.
+
It is used for manipulating things at range, for example, opening and closing closets..
+
Defined at the /atom level but only used at the /obj/item one.
+
Returns COMPONENT_CANCEL_ATTACK_CHAIN when it performs any action, to further acts on the attack chain.
+
attack_tk
+
+
Telekinesis attack act, happens when the TK user clicks on a non-adjacent target in range.
+
+
By default, emulates the user's unarmed attack.
+
Called indirectly by the COMSIG_MOB_ATTACK_RANGED signal.
+
Returns COMPONENT_CANCEL_ATTACK_CHAIN when it performs any action, to further acts on the attack chain.
+
attackby
+
+
Called on an object being hit by an item
+
Arguments:
+
+
obj/item/attacking_item - The item hitting this atom
@params
+hitting_projectile - projectile
+def_zone - zone hit
+piercing_hit - is this hit piercing or normal?
calculate_adjacencies
+
+
Scans all adjacent turfs to find targets to smooth with.
check_eye
+
+
Check if this atoms eye is still alive (probably)
check_projectile_armor
+
+
A cut-out proc for /atom/proc/bullet_act so living mobs can have their own armor behavior checks without causing issues with needing their own on_hit call
clone_storage
+
+
A quick and easy way to /clone/ a storage datum for an atom (does not copy over contents, only the datum details)
connect_to_shuttle
+
+
Connect this atom to a shuttle
container_resist_act
+
+
Called when something resists while this atom is its loc
contains
+
+
Returns true if the src countain the atom target
contents_explosion
+
+
Handle what happens when your contents are exploded by a bomb
create_forensics
+
+
Creates our forensics datum
create_reagents
+
+
Convenience proc to create a reagents holder for an atom
+
Arguments:
+
+
max_vol - maximum volume of holder
+
flags - flags to pass to the holder
+
create_storage
+
+
A quick and easy way to create a storage datum for an atom
crowbar_act
+
+
Called on an object when a tool with crowbar capabilities is used to left click an object
crowbar_act_secondary
+
+
Called on an object when a tool with crowbar capabilities is used to right click an object
cut_overlays
+
+
Tracks the current index into build_overlays so that we can preserve ordering.
Called when a mob examines (shift click or verb) this atom twice (or more) within EXAMINE_MORE_WINDOW (default 1 second)
+
This is where you can put extra information on something that may be superfluous or not important in critical gameplay
+moments, while allowing people to manually double-examine to take a closer look
Calls expose_atom() for every reagent in the reagent list.
+
+
+
Arguments:
+
+
+
+
reagents: The list of reagents the atom is being exposed to.
+
+
+
+
+
source: The reagent holder the reagents are being sourced from.
+
+
+
+
+
methods: How the atom is being exposed to the reagents. Bitflags.
+
+
+
+
+
volume_modifier: Volume multiplier.
+
+
+
+
+
show_message: Whether to display anything to mobs when they are exposed.
+
+
+
+
+
exposed_temperature: The temperature of the reagent during exposure
+
+
+
find_all_cells_containing
+
+
debug proc for checking if a movable is in multiple cells when it shouldnt be (ie always unless multitile entering is implemented)
find_type_in_direction
+
+
Scans direction to find targets to smooth with.
get_all_contents
+
+
Returns the src and all recursive contents as a list.
get_all_contents_ignoring
+
+
Like get_all_contents_type, but uses a typecache list as argument
get_all_contents_type
+
+
identical to get_all_contents but returns a list of atoms of the type passed in the argument.
get_all_orbiters
+
+
Recursive getter method to return a list of all ghosts orbitting this atom
+
This will work fine without manually passing arguments.
+
+
processed - The list of atoms we've already convered
+
source - Is this the atom for who we're counting up all the orbiters?
+
ignored_stealthed_admins - If TRUE, don't count admins who are stealthmoded and orbiting this
+
get_antag_info
+
+
Returns a list of antagonist-related information about this object.
get_controls_info
+
+
Returns a list of controls information about this object.
get_custom_material_amount
+
+
Gets the total amount of materials in this atom.
get_dumping_location
+
+
If someone's trying to dump items onto our atom, where should they be dumped to?
+
Return a loc to place objects, or null to stop dumping.
get_examine_name
+
+
Get the name of this object for examine
+
You can override what is returned from this proc by registering to listen for the
+COMSIG_ATOM_GET_EXAMINE_NAME signal
get_examine_string
+
+
Generate the full examine string of this atom (including icon for goonchat)
get_hud_pixel_y
+
+
Returns a pixel_y value to use for hud code
get_id_examine_strings
+
+
Returns an extended list of examine strings for any contained ID cards.
+
Arguments:
+
+
user - The user who is doing the examining.
+
get_integrity
+
+
This mostly exists to keep atom_integrity private. Might be useful in the future.
get_integrity_percentage
+
+
Retrieves the atom's current damage as a percentage where 100% is 100.
+If use_raw_values is TRUE, uses the raw var values instead of the get_* proc results.
get_lore_info
+
+
Returns a list of lore information about this object.
get_master_material
+
+
Gets the most common material in the object.
get_material_composition
+
+
Returns the material composition of the atom.
+
Used when recycling items, specifically to turn alloys back into their component mats.
+
Exists because I'd need to add a way to un-alloy alloys or otherwise deal
+with people converting the entire stations material supply into alloys.
+
Arguments:
+
+
flags: A set of flags determining how exactly the materials are broken down.
+
get_mechanics_info
+
+
Returns a list of mechanics information for this object.
get_name_chaser
+
+
Used to insert text after the name but before the description in examine()
get_remote_view_fullscreens
+
+
the vision impairment to give to the mob whose perspective is set to that atom
+
(e.g. an unfocused camera giving you an impaired vision when looking through it)
handle_atom_del
+
+
This proc is called when an atom in our contents has it's Destroy called
micro-optimized to hell because this proc is very hot, being called several times per movement every movement.
+
HEY JACKASS, LISTEN
+IF YOU ADD SOMETHING TO THIS PROC, MAKE SURE /mob/living ACCOUNTS FOR IT
+Living mobs treat gravity in an event based manner. We've decomposed this proc into different checks
+for them to use. If you add more to it, make sure you do that, or things will behave strangely
+
Gravity situations:
+
+
No gravity if you're not in a turf
+
No gravity if this atom is in is a space turf
+
Gravity if the area it's in always has gravity
+
Gravity if there's a gravity generator on the z level
+
Gravity if the Z level has an SSMappingTrait for ZTRAIT_GRAVITY
+
otherwise no gravity
+
has_material_category
+
+
Fetches a list of all of the materials this object has with the desired material category.
+
Arguments:
+
+
category: The category to check for
+
any_flags: Any bitflags that must be present for the category
+
all_flags: All bitflags that must be present for the category
+
no_flags: Any bitflags that must not be present for the category
+
mat_amount: The minimum amount of materials that must be present
+
has_material_type
+
+
Fetches a list of all of the materials this object has of the desired type. Returns null if there is no valid materials of the type
+
Arguments:
+
+
mat_type: The type of material we are checking for
+
exact: Whether to search for the exact material type
+
mat_amount: The minimum required amount of material
+
hear_location
+
+
What atom is actually "Hearing".
hitby
+
+
React to being hit by a thrown object
+
Default behaviour is to call hitby_react on ourselves after 2 seconds if we are dense
+and under normal gravity.
+
Im not sure why this the case, maybe to prevent lots of hitby's if the thrown object is
+deleted shortly after hitting something (during explosions or other massive events that
+throw lots of items around - singularity being a notable example)
hitby_react
+
+
We have have actually hit the passed in atom
+
Default behaviour is to move back from the item that hit us
hulk_damage
+
+
Called to get the damage that hulks will deal to the atom.
in_contents_of
+
+
Return true if we're inside the passed in atom
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
isinspace
+
+
Is this atom in space
log_message
+
+
Generic logging helper
+
reads the type of the log
+and writes it to the respective log file
+unless log_globally is FALSE
+Arguments:
+
+
message - The message being logged
+
message_type - the type of log the message is(ATTACK, SAY, etc)
+
color - color of the log text
+
log_globally - boolean checking whether or not we write this log to the log file
+
log_talk
+
+
Helper for logging chat messages or other logs with arbitrary inputs(e.g. announcements)
+
This proc compiles a log string by prefixing the tag to the message
+and suffixing what it was forced_by if anything
+if the message lacks a tag and suffix then it is logged on its own
+Arguments:
+
+
message - The message being logged
+
message_type - the type of log the message is(ATTACK, SAY, etc)
+
tag - tag that indicates the type of text(announcement, telepathy, etc)
+
log_globally - boolean checking whether or not we write this log to the log file
+
forced_by - source that forced the dialogue if any
+
log_touch
+
+
For admins. Logs when mobs players with this thing.
lose_atmos_sensitivity
+
+
removes temperature sensitivity
makeHologram
+
+
Makes this atom look like a "hologram"
+So transparent, blue and with a scanline
mat_update_desc
+
+
This proc is called when a material updates an object's description
mech_melee_attack
+
+ Mech melee attack
+
Called when a mech melees a target with fists
+Handles damaging the target & associated effects
+return value is number of damage dealt
+Arguments:
+
+
mecha_attacker: Mech attacking this target
+
user: mob that initiated the attack from inside the mech as a controller
+
modify_max_integrity
+
+
changes max_integrity while retaining current health percentage, returns TRUE if the atom got broken.
multitool_act
+
+
Called on an object when a tool with multitool capabilities is used to left click an object
multitool_act_secondary
+
+
Called on an object when a tool with multitool capabilities is used to right click an object
multitool_check_buffer
+
+
Check if the multitool has an item in it's data buffer
Atom level proc for space ninja's glove interactions.
+
Proc which only occurs when space ninja uses his gloves on an atom.
+Does nothing by default, but effects will vary.
+Arguments:
+
+
ninja_suit - The offending space ninja's suit.
+
ninja - The human mob wearing the suit.
+
ninja_gloves - The offending space ninja's gloves.
+
onAwayMission
+
+
Is the atom in an away mission
+
Must be in the away mission z-level to return TRUE
+
Also used in gamemode code for win conditions
onCentCom
+
+
Is this atom currently located on centcom
+
Specifically, is it on the z level and within the centcom areas
+
You can also be in a shuttleshuttle during endgame transit
+
Used in gamemode to identify mobs who have escaped and for some other areas of the code
+who don't want atoms where they shouldn't be
onSyndieBase
+
+
Is the atom in any of the centcom syndicate areas
+
Either in the syndie base on centcom, or any of their shuttles
+
Also used in gamemode code for win conditions
on_log
+
+
Called when the atom log's in or out
+
Default behaviour is to call on_log on the location this atom is in
on_mouse_enter
+
+
Fired whenever this atom is the most recent to be hovered over in the tick.
+Preferred over MouseEntered if you do not need information such as the position of the mouse.
+Especially because this is deferred over a tick, do not trust that client is not null.
play_attack_sound
+
+
the sound played when the atom is damaged.
prepare_huds
+
+
Prepare the huds for this atom
+
Goes through hud_possible list and adds the images to the hud_list variable (if not already cached)
Create a "Type-B" contextual screentip interaction, registering to add_context().
+This will run add_context() when the atom is hovered over by an item for context.
+add_context() will not be called unless this is run.
+This is not necessary for Type-B interactions, as you can just apply the flag and register to the signal yourself.
relaydrive
+
+
A special case of relaymove() in which the person relaying the move may be "driving" this atom
+
This is a special case for vehicles and ridden animals where the relayed movement may be handled
+by the riding component attached to this atom. Returns TRUE as long as there's nothing blocking
+the movement, or FALSE if the signal gets a reply that specifically blocks the movement
relaymove
+
+
An atom we are buckled or is contained within us has tried to move
+
Default behaviour is to send a warning that the user can't move while buckled as long
+as the buckle_message_cooldown has expired (50 ticks)
remove_air
+
+
Remove air from this atom
remove_atom_colour
+
+
Removes an instance of colour_type from the atom's atom_colours list
repair_damage
+
+
Proc for recovering atom_integrity. Returns the amount repaired by
replace_smooth_overlays
+
+
Internal: Takes icon states as text to replace smoothing corner overlays
reset_plane_and_layer
+
+
Reset plane and layer values to their defaults.
returnArmor
+
+
Retreive an atom's armor, creating it if it doesn't exist
return_air
+
+
Return the current air environment in this atom
return_analyzable_air
+
+
Return the air if we can analyze it
return_breathable_air
+
+
Return air that a contained mob will be breathing.
return_temperature
+
+
Return atom temperature
run_atom_armor
+
+
returns the damage value of the attack after processing the atom's various armor protections
runechat_prefs_check
+
+
Returns the client runechat visible messages preference according to the message type.
rust_heretic_act
+
+
Causes effects when the atom gets hit by a rust effect from heretics
+
Override this if you want custom behaviour in whatever gets hit by the rust
screwdriver_act
+
+
Called on an object when a tool with screwdriver capabilities is used to left click an object
screwdriver_act_secondary
+
+
Called on an object when a tool with screwdriver capabilities is used to right click an object
setArmor
+
+
Setter for armor
setClosed
+
+
Used to set something as 'closed' if it's being used as a supplypod
+
Override this if you want an atom to be usable as a supplypod.
setDir
+
+
Hook for running code when a dir change occurs
+
Not recommended to use, listen for the COMSIG_ATOM_DIR_CHANGE signal instead (sent by this proc)
setOpened
+
+
Used to set something as 'open' if it's being used as a supplypod
+
Override this if you want an atom to be usable as a supplypod.
set_base_pixel_x
+
+
Setter for the base_pixel_x variable to append behavior related to its changing.
set_base_pixel_y
+
+
Setter for the base_pixel_y variable to append behavior related to its changing.
set_custom_materials
+
+
Sets the custom materials for an item.
set_density
+
+
Setter for the density variable to append behavior related to its changing.
set_greyscale
+
+
Handles updates to greyscale value updates.
+The colors argument can be either a list or the full color string.
+Child procs should call parent last so the update happens after all changes.
set_hud_image_active
+
+
set every hud image in the given category active so other people with the given hud can see it.
+Arguments:
+
+
hud_category - the index in our active_hud_list corresponding to an image now being shown.
+
update_huds - if FALSE we will just put the hud_category into active_hud_list without actually updating the atom_hud datums subscribed to it
+
exclusive_hud - if given a reference to an atom_hud, will just update that hud instead of all global ones attached to that category.
+This is because some atom_hud subtypes arent supposed to work via global categories, updating normally would affect all of these which we dont want.
+
set_hud_image_inactive
+
+
sets every hud image in the given category inactive so no one can see it
set_hud_image_vars
+
+
Update the icon_state of an atom hud image.
set_light_color
+
+
Setter for the light color of this atom.
set_light_curve
+
+
Setter for this atom's light falloff curve.
set_light_flags
+
+
Setter for the light flags of this atom.
set_light_on
+
+
Setter for whether or not this atom's light is on.
set_light_power
+
+
Setter for the light power of this atom.
set_light_range
+
+
Setter for the light range of this atom.
set_opacity
+
+
Updates the atom's opacity value.
+
This exists to act as a hook for associated behavior.
+It notifies (potentially) affected light sources so they can update (if needed).
set_smoothed_icon_state
+
+
Changes the icon state based on the new junction bitmask. Returns the old junction value.
The essential proc to call when an atom must receive damage of any kind.
tool_act
+
+
Tool behavior procedure. Redirects to tool-specific procs by default.
+
You can override it to catch all tool interactions, for use in complex deconstruction procs.
+
Must return parent proc ..() in the end if overridden
transfer_mob_blood_dna
+
+
to add a mob's dna info into an object's blood_dna list.
unsafe_return_air
+
+
Return the current air environment in this atom. If this atom is a turf, it will not automatically update the zone.
update_above
+
+
Updates whatever openspace objects may be mimicking us. On turfs this queues an openturf update on the above openturf, on movables this updates their bound movable (if present). Meaningless on any type other than /turf or /atom/movable (incl. children).
update_appearance
+
+
Updates the appearence of the icon
+
Mostly delegates to update_name, update_desc, and update_icon
+
Arguments:
+
+
updates: A set of bitflags dictating what should be updated. Defaults to [ALL]
+
update_atom_colour
+
+
Resets the atom's color to null, and then sets it to the highest priority colour available
update_desc
+
+
Updates the description of the atom
update_greyscale
+
+
Checks if this atom uses the GAGS system and if so updates the icon
update_icon
+
+
Updates the icon of the atom
update_icon_state
+
+
Updates the icon state of the atom
update_integrity
+
+
Handles the integrity of an atom changing. This must be called instead of changing integrity directly.
update_light
+
+
Will update the light (duh).
+Creates or destroys it if needed, makes it update values, makes sure it's got the correct source turf...
update_name
+
+
Updates the name of the atom
update_overlays
+
+
Updates the overlays of the atom
update_remote_sight
+
+
the sight changes to give to the mob whose perspective is set to that atom
+
(e.g. A mob with nightvision loses its nightvision while looking through a normal camera)
visible_message
+
+
Generate a visible message from this atom
+
Show a message to all player mobs who sees this atom
+
Show a message to the src mob (if the src is a mob)
+
Use for atoms performing visible actions
+
message is output to anyone who can see, e.g. "[src] does something!"
+
Vars:
+
+
self_message (optional) is what the src mob sees e.g. "You do something!"
+
blind_message (optional) is what blind people will hear e.g. "You hear something!"
+
vision_distance (optional) define how many tiles away the message can be seen.
+
ignored_mob (optional) doesn't show any message to a given mob if TRUE.
+
separation (otional) is what goes between the name of the person and the message, defaults to " ". PARIAH ADDITION
+
vv_edit_var
+
+
call back when a var is edited on this atom
+
Can be used to implement special handling of vars
+
At the atom level, if you edit a var named "color" it will add the atom colour with
+admin level priority to the atom colours list
+
Also, if GLOB.Debug2 is FALSE, it sets the ADMIN_SPAWNED_1 flag on flags_1, which signifies
+the object has been admin edited
vv_get_dropdown
+
+
Return the markup to for the dropdown list for the VV panel for this atom
+
Override in subtypes to add custom VV handling in the VV panel
wash
+
+
Wash this atom
+
This will clean it off any temporary stuff like blood. Override this in your item to add custom cleaning behavior.
+Returns true if any washing was necessary and thus performed
+Arguments:
+
+
clean_types: any of the CLEAN_ constants
+
welder_act
+
+
Called on an object when a tool with welder capabilities is used to left click an object
welder_act_secondary
+
+
Called on an object when a tool with welder capabilities is used to right click an object
wirecutter_act
+
+
Called on an object when a tool with wirecutter capabilities is used to left click an object
wirecutter_act_secondary
+
+
Called on an object when a tool with wirecutter capabilities is used to right click an object
wrench_act
+
+
Called on an object when a tool with wrench capabilities is used to left click an object
wrench_act_secondary
+
+
Called on an object when a tool with wrench capabilities is used to right click an object
zap_act
+
+
Respond to an electric bolt action on our item
+
Default behaviour is to return, we define here to allow for cleaner code later on
zas_canpass
+
+
Checks whether or not ZAS can occupy this atom's turf. Invoked by the ATMOS_CANPASS_TURF macro.
zas_update_loc
+
+
Tells ZAS to mark the tile the atom is in to update.
contains every client mob corresponding to every client eye in this container. lazily updated by SSparallax and is sparse:
+only the last container of a client eye has this list assuming no movement since SSparallax's last fire
an associative lazylist of relevant nested contents by "channel", the list is of the form: list(channel = list(important nested contents of that type))
+each channel has a specific purpose and is meant to replace potentially expensive nested contents iteration.
+do NOT add channels to this for little reason as it can add considerable memory usage.
In case you have multiple types, you automatically use the most useful one.
+IE: Skating on ice, flippers on water, flying over chasm/space, etc.
+I reccomend you use the movetype_handler system and not modify this directly, especially for living mobs.
Whether this atom should have its dir automatically changed when it moves. Setting this to FALSE allows for things such as directional windows to retain dir on moving without snowflake code all of the place.
String representing the spatial grid groups we want to be held in.
+acts as a key to the list of spatial grid contents types we exist in via SSspatial_grid.spatial_grid_categories.
+We do it like this to prevent people trying to mutate them and to save memory on holding the lists ourselves
Called whenever an object moves and by mobs when they attempt to move themselves through space
+And when an object or action applies a force on src, see newtonian_move
Uncross() is a default BYOND proc that is called when something is going
+to exit this atom's turf. It is prefered over Uncrossed when you want to
+deny that movement, such as in the case of border objects, objects that allow
+you to walk through them in any direction except the one they block
+(think side windows).
default byond proc that is normally called on everything inside the previous turf
+a movable was in after moving to its current turf
+this is wasteful since the vast majority of objects do not use Uncrossed
+use connect_loc to register to COMSIG_ATOM_EXITED instead
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()FALS
We get our awareness updated by the important recursive contents stuff, here we remove our membership
+allows this movable to know when it has "entered" another area no matter how many movable atoms its stuffed into, uses important_recursive_contents
Copies all languages into the supplied atom/language holder. Source should be overridden when you
+do not want the language overwritten by later atom updates or want to avoid blocked languages.
removes the area sensitive channel from the important_recursive_contents list of this and all nested locs containing us if there are no more source of the trait left
removes the hearing sensitivity channel from the important_recursive_contents list of this and all nested locs containing us if there are no more sources of the trait left
+since RECURSIVE_CONTENTS_HEARING_SENSITIVE is also a spatial grid content type, removes us from the spatial grid if the trait is removed
Only moves the object if it's under no gravity
+Accepts the direction to move, if the push should be instant, and an optional parameter to fine tune the start delay
called when this atom is removed from a storage item, which is passed on as S. The loc variable is already set to the new destination before this is called.
Checks if the pulling and pulledby should be stopped because they're out of reach.
+If z_allowed is TRUE, the z level of the pulling will be ignored.This is to allow things to be dragged up and down stairs.
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"
+but they pass both isicon() and isfile() checks. theyre the easiest case since stringifying them gives us the path we want
Empties out the atom specific languages and updates them according to the current atoms language holder.
+As a side effect, it also creates missing language holders in the process.
contains every client mob corresponding to every client eye in this container. lazily updated by SSparallax and is sparse:
+only the last container of a client eye has this list assuming no movement since SSparallax's last fire
an associative lazylist of relevant nested contents by "channel", the list is of the form: list(channel = list(important nested contents of that type))
+each channel has a specific purpose and is meant to replace potentially expensive nested contents iteration.
+do NOT add channels to this for little reason as it can add considerable memory usage.
In case you have multiple types, you automatically use the most useful one.
+IE: Skating on ice, flippers on water, flying over chasm/space, etc.
+I reccomend you use the movetype_handler system and not modify this directly, especially for living mobs.
Whether this atom should have its dir automatically changed when it moves. Setting this to FALSE allows for things such as directional windows to retain dir on moving without snowflake code all of the place.
String representing the spatial grid groups we want to be held in.
+acts as a key to the list of spatial grid contents types we exist in via SSspatial_grid.spatial_grid_categories.
+We do it like this to prevent people trying to mutate them and to save memory on holding the lists ourselves
Movable-level Z-Mimic flags. This uses ZMM_* flags, not ZM_* flags.
Proc Details
CanPassThrough
+
+
Returns true or false to allow src to move through the blocker, mover has final say
CanReach
+
+
A backwards depth-limited breadth-first-search to see if the target is
+logically "in" anything adjacent to us.
Crossed
+
+
default byond proc that is deprecated for us in lieu of signals. do not call
Moved
+
+
Called after a successful Move(). By this point, we've already moved.
+Arguments:
+
+
old_loc is the location prior to the move. Can be null to indicate nullspace.
+
movement_dir is the direction the movement took place. Can be NONE if it was some sort of teleport.
+
The forced flag indicates whether this was a forced move, which skips many checks of regular movement.
+
The old_locs is an optional argument, in case the moved movable was present in multiple locations before the movement.
+
momentum_change represents whether this movement is due to a "new" force if TRUE or an already "existing" force if FALSE
+
Process_Spacemove
+
+
Called whenever an object moves and by mobs when they attempt to move themselves through space
+And when an object or action applies a force on src, see newtonian_move
+
Return FALSE to have src start/keep drifting in a no-grav area and TRUE to stop/not start drifting
+
Mobs should return 1 if they should be able to move of their own volition, see /client/proc/Move
+
Arguments:
+
+
movement_dir - 0 when stopping or any dir when trying to move
+
continuous_move - If this check is coming from something in the context of already drifting
+
Uncross
+
+
Uncross() is a default BYOND proc that is called when something is going
+to exit this atom's turf. It is prefered over Uncrossed when you want to
+deny that movement, such as in the case of border objects, objects that allow
+you to walk through them in any direction except the one they block
+(think side windows).
+
While being seemingly harmless, most everything doesn't actually want to
+use this, meaning that we are wasting proc calls for every single atom
+on a turf, every single time something exits it, when basically nothing
+cares.
+
This overhead caused real problems on Sybil round #159709, where lag
+attributed to Uncross was so bad that the entire master controller
+collapsed and people made Among Us lobbies in OOC.
+
If you want to replicate the old Uncross() behavior, the most apt
+replacement is [/datum/element/connect_loc] while hooking onto
+[COMSIG_ATOM_EXIT].
Uncrossed
+
+
default byond proc that is normally called on everything inside the previous turf
+a movable was in after moving to its current turf
+this is wasteful since the vast majority of objects do not use Uncrossed
+use connect_loc to register to COMSIG_ATOM_EXITED instead
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()FALS
add_blocked_language
+
+
Adds a language to the blocked language list. Use this over remove_language in cases where you will give languages back later.
admin_teleport
+
+
Proc to hook user-enacted teleporting behavior and keep logging of the event.
airflow_hit
+
+
Called when src collides with A during airflow
become_active_storage
+
+
called when this movable becomes the parent of a storage component that is currently being viewed by a player. uses important_recursive_contents
become_area_sensitive
+
+
We get our awareness updated by the important recursive contents stuff, here we remove our membership
+allows this movable to know when it has "entered" another area no matter how many movable atoms its stuffed into, uses important_recursive_contents
become_hearing_sensitive
+
+
allows this movable to hear and adds itself to the important_recursive_contents list of itself and every movable loc its in
become_radio_sensitive
+
+
allows this movable to hear and adds itself to the important_recursive_contents list of itself and every movable loc its in
block_superconductivity
+
+
Currently unused.
buckle_mob
+
+
Set a mob as buckled to src
+
If you want to have a mob buckling another mob to something, or you want a chat message sent, use user_buckle_mob instead.
+Arguments:
+M - The mob to be buckled to src
+force - Set to TRUE to ignore src's can_buckle and M's can_buckle_to
+check_loc - Set to FALSE to allow buckling from adjacent turfs, or TRUE if buckling is only allowed with src and M on the same turf.
+buckle_mob_flags- Used for riding cyborgs and humans if we need to reserve an arm or two on either the rider or the ridden mob.
+ignore_self - If set to TRUE, this will not do a check to see if the user can move into the turf of the mob and will just automatically mount them.
can_speak_language
+
+
Checks if atom can speak the language.
can_step_into
+
+
Tests if src can move from their current loc to an adjacent destination, without doing the move.
can_z_move
+
+
Checks if the destination turf is elegible for z movement from the start turf to a given direction and returns it if so.
+Args:
+
+
direction: the direction to go, UP or DOWN, only relevant if target is null.
+
start: Each destination has a starting point on the other end. This is it. Most of the times the location of the source.
+
z_move_flags: bitflags used for various checks. See __DEFINES/movement.dm.
+
rider: A living mob in control of the movable. Only non-null when a mob is riding a vehicle through z-levels.
+
check_airflow_movable
+
+
Checks to see if airflow can move this movable.
check_zclimb
+
+
Returns an object we can climb onto
compose_message
+
+
+
The core proc behind say as a concept. Terrifyingly horrible. Called twice for no good reason.
+
Arguments:
+
+
+
speaker - Either the mob speaking, or a virtualspeaker if this is a remote message of some kind.
+
+
+
+
+
message_language - The language the message is ICly in. For understanding.
+
+
+
+
+
translated_message - The actual text of the message, after being translated across languages.
+
+
+
+
+
radio_freq - can be either a numeric radio frequency, or an assoc list of span and name, to directly override them.
+
+
+
+
+
face_name - Do we use the "name" of the speaker, or get it's real_name, Used solely for hallucinations.
+
+
+
copy_languages
+
+
Copies all languages into the supplied atom/language holder. Source should be overridden when you
+do not want the language overwritten by later atom updates or want to avoid blocked languages.
deadchat_plays
+
+
Adds the deadchat_plays component to this atom with simple movement commands.
+
Returns the component added.
+Arguments:
+
+
mode - Either ANARCHY_MODE or DEMOCRACY_MODE passed to the deadchat_control component. See /datum/component/deadchat_control for more info.
+
cooldown - The cooldown between command inputs passed to the deadchat_control component. See /datum/component/deadchat_control for more info.
+
forceMoveWithGroup
+
+
forceMove() wrapper to include things like buckled mobs.
free_from_all_grabs
+
+
Frees src from all grabs.
get_all_grab_chain_members
+
+
Get every single member of a grab chain
get_language_holder
+
+
Gets or creates the relevant language holder. For mindless atoms, gets the local one. For atom with mind, gets the mind one.
get_move_group
+
+
Returns a list of movables that should also be affected when calling forceMoveWithGroup()
get_random_spoken_language
+
+
Gets a random spoken language, useful for forced speech and such.
get_random_understood_language
+
+
Gets a random understood language, useful for hallucinations and such.
get_selected_language
+
+
Returns selected language, if it can be spoken, or finds, sets and returns a new selected language if possible.
grant_all_languages
+
+
Grants every language.
grant_language
+
+
Grants the supplied language and sets omnitongue true.
has_buckled_mobs
+
+
Returns TRUE if there are mobs buckled to this atom and FALSE otherwise
has_language
+
+
Checks if atom has the language. If spoken is true, only checks if atom can speak the language.
is_buckle_possible
+
+
Simple helper proc that runs a suite of checks to test whether it is possible or not to buckle the target mob to src.
target - Target mob to check against buckling to src.
+
force - Whether or not the buckle should be forced. If TRUE, ignores src's can_buckle var and target's can_buckle_to
+
check_loc - TRUE if target and src have to be on the same tile, FALSE if they are allowed to just be adjacent
+
is_user_buckle_possible
+
+
Simple helper proc that runs a suite of checks to test whether it is possible or not for user to buckle target mob to src.
+
Returns FALSE if any conditions that should prevent buckling are satisfied. Returns TRUE otherwise.
+Called from /atom/movable/proc/user_buckle_mob.
+Arguments:
+
+
target - Target mob to check against buckling to src.
+
user - The mob who is attempting to buckle the target to src.
+
check_loc - TRUE if target and src have to be on the same tile, FALSE if buckling is allowed from adjacent tiles
+
keybind_face_direction
+
+
A wrapper for setDir that should only be able to fail by living mobs.
+
Called from [/atom/movable/proc/keyLoop], this exists to be overwritten by living mobs with a check to see if we're actually alive enough to change directions
lose_active_storage
+
+
called when this movable's storage component is no longer viewed by any players, unsets important_recursive_contents
lose_area_sensitivity
+
+
removes the area sensitive channel from the important_recursive_contents list of this and all nested locs containing us if there are no more source of the trait left
lose_hearing_sensitivity
+
+
removes the hearing sensitivity channel from the important_recursive_contents list of this and all nested locs containing us if there are no more sources of the trait left
+since RECURSIVE_CONTENTS_HEARING_SENSITIVE is also a spatial grid content type, removes us from the spatial grid if the trait is removed
+
+
trait_source - trait source define or ALL, if ALL, force removes hearing sensitivity. if a trait source define, removes hearing sensitivity only if the trait is removed
+
mouse_buckle_handling
+
+
Does some typechecks and then calls user_buckle_mob
+
Arguments:
+M - The mob being buckled to src
+user - The mob buckling M to src
move_from_pull
+
+
Called when src is being moved to a target turf because another movable (puller) is moving around.
newtonian_move
+
+
Only moves the object if it's under no gravity
+Accepts the direction to move, if the push should be instant, and an optional parameter to fine tune the start delay
onShuttleMove
+
+
Called on atoms to move the atom to the new location
on_changed_z_level
+
+
Called when a movable changes z-levels.
+
Arguments:
+
+
old_z - The previous z-level they were on before.
+
notify_contents - Whether or not to notify the movable's contents that their z-level has changed.
+
on_enter_storage
+
+
called when this atom is added into a storage item, which is passed on as S. The loc variable is already set to the storage item.
on_exit_storage
+
+
called when this atom is removed from a storage item, which is passed on as S. The loc variable is already set to the new destination before this is called.
point_at
+
+
Point at an atom
+
Intended to enable and standardise the pointing animation for all atoms
+
Not intended as a replacement for the mob verb
recheck_grabs
+
+
Checks if the pulling and pulledby should be stopped because they're out of reach.
+If z_allowed is TRUE, the z level of the pulling will be ignored.This is to allow things to be dragged up and down stairs.
recursively_get_all_grabbers
+
+
Gets every grabber of this atom, and every grabber of those grabbers, repeat
relay_container_resist_act
+
+
called when a mob resists while inside a container that is itself inside something.
remove_all_languages
+
+
Removes every language and sets omnitongue false.
remove_blocked_language
+
+
Removes a language from the blocked language list.
remove_language
+
+
Removes a single language.
say_emphasis
+
+
Scans the input sentence for speech emphasis modifiers, notably |italics|, +bold+, and underline -mothblocks
set_anchored
+
+
Sets the anchored var and returns if it was sucessfully changed or not.
set_currently_z_moving
+
+
Sets the currently_z_moving variable to a new value. Used to temporarily disable some Move() side effects.
set_light_range_power_color
+
+
Helper to change several lighting overlay settings.
show_message
+
+
Show a message to this mob (visual or audible)
+This is /atom/movable so mimics can get these and relay them to their parent.
shuttleRotate
+
+
Base /atom/movable proc
throw_at
+
+
If this returns FALSE then callback will not be called.
transformation_animation
+
+
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"
+but they pass both isicon() and isfile() checks. theyre the easiest case since stringifying them gives us the path we want
translate_speech
+
+
Processes a spoken message's language based on if the hearer can understand it.
The mob must actually be buckled to src or else bad things will happen.
+Arguments:
+buckled_mob - The mob to be unbuckled
+force - TRUE if we should ignore buckled_mob.can_buckle_to
update_atom_languages
+
+
Empties out the atom specific languages and updates them according to the current atoms language holder.
+As a side effect, it also creates missing language holders in the process.
update_dynamic_luminosity
+
+
Keeps track of the sources of dynamic luminosity and updates our visibility with the highest.
user_buckle_mob
+
+
Handles a mob buckling another mob to src and sends a visible_message
+
Basically exists to do some checks on the user and then call buckle_mob where the real buckling happens.
+First, checks if the buckle is valid and cancels if it isn't.
+Second, checks if src is on a different turf from the target; if it is, does a do_after and another check for sanity
+Finally, calls /atom/movable/proc/buckle_mob to buckle the target to src then gives chat feedback
+Arguments:
+
+
M - The target mob/living being buckled to src
+
user - The other mob that's buckling M to src
+
check_loc - TRUE if src and M have to be on the same turf, false otherwise
+
user_unbuckle_mob
+
+
Handles a user unbuckling a mob from src and sends a visible_message
+
Basically just calls unbuckle_mob, sets fingerprint, and sends a visible_message
+about the user unbuckling the mob
+Arguments:
+buckled_mob - The mob/living to unbuckle
+user - The mob unbuckling buckled_mob
zFall
+
+
Precipitates a movable (plus whatever buckled to it) to lower z levels if possible and then calls zImpact()
Internal atom that copies an appearance on to the blocker plane
+
Copies an appearance vis render_target and render_source on to the emissive blocking 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.
An overrideable proc used simply to hand over the item when claimed, this is a proc so that high-fives can override them since nothing is actually transferred
Handles assigning most of the variables for the alert that pops up when an item is offered
Proc Details
handle_transfer
+
+
An overrideable proc used simply to hand over the item when claimed, this is a proc so that high-fives can override them since nothing is actually transferred
setup
+
+
Handles assigning most of the variables for the alert that pops up when an item is offered
+
Handles setting the name, description and icon of the alert and tracking the person giving
+and the item being offered, also registers a signal that removes the alert from anyone who moves away from the offerer
+Arguments:
Acts like a plane master, but for plane masters
+Renders other planes onto this plane, through the use of render objects
+Any effects applied onto this plane will act on the unified plane
+IE a bulge filter will apply as if the world was one object
+remember that once planes are unified on a render plate you cant change the layering of them!
Wanted level, affects the hud icon. Level 0 is default, and the level 0 icon is blank, so in case of no families gamemode (and thus no wanted level), this HUD element will never appear.
Wanted level, affects the hud icon. Level 0 is default, and the level 0 icon is blank, so in case of no families gamemode (and thus no wanted level), this HUD element will never appear.
+
+
+
diff --git a/atom/movable/virtualspeaker.html b/atom/movable/virtualspeaker.html
new file mode 100644
index 000000000000..ebed5723433b
--- /dev/null
+++ b/atom/movable/virtualspeaker.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /atom/movable/virtualspeaker - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Internal counter for clients sending external (IRC/Discord) relay messages via ahelp to prevent spamming. Set to a number every time an admin reply is sent, decremented for every client send.
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
dumb workaround because byond doesnt seem to recognize the .proc/Topic() typepath for /datum/proc/Topic() from the client Topic,
+so we cant queue it without this
Blocks until all currently sending browse and browse_rsc 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.
Handles treating drags as clicks if they're within some conditions
+Does some other stuff adjacent to trying to figure out what the user actually "wanted" to click
+Returns TRUE if it caused a click, FALSE otherwise
broadcaster[id_tag] = machine
+listened_to[atmos_chamber_entry] = bool
+TRUE means we have the corresponding id_tag being listened to by an atmos control computer.
+broadcasted_to[id_tag[1]] = bool
+TRUE means we have the corresponding id_tag being broadcasted to by a device, be it meter, sensors, etc.
+How many things dont fit the recognized subtypes.
+How many things have invalid (messes with our delimiter) tags.
+How many things have empty tags, invalids but much worse.
+How many things have duped id_tag.
+How many things are broadcasting without an atmos computer listening
+How many atmos computers are listening to an empty tag.
Redirect proc that makes it easier to call the unlock achievement proc. Achievement type is the typepath to the award, user is the mob getting the award, and value is an optional variable used for leaderboard value increments
Debug verb that spawns human crewmembers
+of each job type, gives them a mind and assigns the role,
+and injects them into the manifest, as if they were a "player".
Internal counter for clients sending external (IRC/Discord) relay messages via ahelp to prevent spamming. Set to a number every time an admin reply is sent, decremented for every client send.
By default in byond if you define a proc on datums, that proc will exist on nearly every single type
+from icons to images to atoms to mobs to objs to turfs to areas, it won't however, appear on client
+
instead by default they act like their own independent type so while you can do istype(icon, /datum)
+and have it return true, you can't do istype(client, /datum), it will always return false.
+
This makes writing oo code hard, when you have to consider this extra special case
+
This line prevents that, and has never appeared to cause any ill effects, while saving us an extra
+pain to think about
+
This line is widely considered black fucking magic, and the fact it works is a puzzle to everyone
+involved, including the current engine developer, lummox
+
If you are a future developer and the engine source is now available and you can explain why this
+is the way it is, please do update this comment
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
The visual delay to use for the current client.Move(), mostly used for making a client based move look like it came from some other slower source
Proc Details
Move
+
+
Move a client in a direction
+
Huge proc, has a lot of functionality
+
Mostly it will despatch to the mob that you are the owner of to actually move
+in the physical realm
+
Things that stop you moving as a mob:
+
+
world time being less than your next move_delay
+
not being in a mob, or that mob not having a loc
+
missing the n and direction parameters
+
being in remote control of an object (calls Moveobject instead)
+
being dead (it ghosts you instead)
+
+
Things that stop you moving as a mob living (why even have OO if you're just shoving it all
+in the parent proc with istype checks right?):
+
+
having incorporeal_move set (calls Process_Incorpmove() instead)
+
being grabbed
+
being buckled (relaymove() is called to the buckled atom instead)
+
having your loc be some other mob (relaymove() is called on that mob instead)
+
Not having MOBILITY_MOVE
+
Failing Process_Spacemove() call
+
+
At this point, if the mob is is confused, then a random direction and target turf will be calculated for you to travel to instead
+
Now the parent call is made (to the byond builtin move), which moves you
+
Some final move delay calculations (doubling if you moved diagonally successfully)
+
if mob throwing is set I believe it's unset at this point via a call to finalize
+
Finally if you're pulling an object and it's dense, you are turned 180 after the move
+(if you ask me, this should be at the top of the move so you don't dance around)
Move_object
+
+
force move the control_object of your client mob
+
Used in admin possession and called from the client Move proc
+ensures the possessed object moves and not the admin mob
+
Has no sanity other than checking density
Process_Incorpmove
+
+
Allows mobs to ignore density and phase through objects
+
Called by client/Move()
+
The behaviour depends on the incorporeal_move value of the mob
+
+
INCORPOREAL_MOVE_BASIC - forceMoved to the next tile with no stop
+
INCORPOREAL_MOVE_SHADOW - the same but leaves a cool effect path
+
INCORPOREAL_MOVE_JAUNT - the same but blocked by holy tiles
+
+
You'll note this is another mob living level proc living at the client level
_Topic
+
+
dumb workaround because byond doesnt seem to recognize the .proc/Topic() typepath for /datum/proc/Topic() from the client Topic,
+so we cant queue it without this
adjust_heart
+
+
Gives someone hearted status for OOC, from behavior commendations
admin_follow
+
+
Attempts to make the client orbit the given object, for administrative purposes.
+If they are not an observer, will try to aghost them.
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.
attempt_auto_fit_viewport
+
+
Attempt to automatically fit the viewport, assuming the user wants it
body_chest
+
+
Hidden verb to target the chest, bound to 5
body_eyes
+
+
Hidden verb to target the eyes, bound to 7
body_groin
+
+
Hidden verb to target the groin, bound to 2
body_l_arm
+
+
Hidden verb to target the left arm, bound to 6
body_l_leg
+
+
Hidden verb to target the left leg, bound to 3
body_mouth
+
+
Hidden verb to target the mouth, bound to 9
body_r_arm
+
+
Hidden verb to target the right arm, bound to 4
body_r_leg
+
+
Hidden verb to target the right leg, bound to 1
body_toggle_head
+
+
Hidden verb to set the target zone of a mob to the head
+
(bound to 8) - repeated presses toggles through head - eyes - mouth
+Hidden verb to target the head, bound to 8
browse_queue_flush
+
+
Blocks until all currently sending browse and browse_rsc 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.
check_atmos_controls
+
+
Checks the atmos monitor, sensors, meters, vents, and injectors, and makes sure they dont overlap or do nothing.
check_can_move
+
+
Checks to see if an external factor is preventing movement, mainly grabbing.
+
Called by client/Move()
check_drag_proximity
+
+
Handles treating drags as clicks if they're within some conditions
+Does some other stuff adjacent to trying to figure out what the user actually "wanted" to click
+Returns TRUE if it caused a click, FALSE otherwise
check_has_body_select
+
+
Validate the client's mob has a valid zone selected
check_panic_bunker
+
+
Checks panic bunker status and applies restricted_mode if necessary. Returns TRUE if the client should be kicked.
check_timer_sources
+
+
A debug verb to check the sources of currently running timers
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.
cmd_admin_create_centcom_report
+
+
Verb to open the create command report window and send command reports.
cmd_change_command_name
+
+
Verb to change the global command name.
create_popup
+
+
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.
debug_spell_requirements
+
+
Debug verb for seeing at a glance what all spells have as set requirements
discord_generate_one_time_token
+
+
Generate a timebound token for discord verification
+
This uses the common word list to generate a three word random token, this token can then be fed to a discord bot that has access
+to the same database, and it can use it to link a ckey to a discord id, with minimal user effort
+
It returns the token to the calling proc, after inserting an entry into the discord_link table of the following form
+
(unique_id, ckey, null, the current time, the one time token generated)
+the null value will be filled out with the discord id by the integrated discord bot when a user verifies
+
+
Notes:
+
+
The token is guaranteed to be unique during it's validity period
+
The validity period is currently set at 4 hours
+
A token may not be unique outside it's validity window (to reduce conflicts)
+
+
Arguments:
+
+
ckey_for a string representing the ckey this token is for
+
+
Returns a string representing the one time token
discord_get_or_generate_one_time_token_for_ckey
+
+
Given a ckey as a string, look up the OTP token attached to that ckey, else generated new one
+
Arguments:
+
+
ckey The ckey as a string
+
+
Returns: OTP token as string
discord_is_link_valid
+
+
Checks if the the given ckey has a valid discord link
+Returns: TRUE if valid, FALSE if invalid or missing
discord_lookup_ckey
+
+
Given a discord id as a string, look up the ckey attached to that account, if any
+
This gets the most recent entry from the discord_link table that is associated with this discord id snowflake
+
Arguments:
+
+
lookup_id The discord id as a string
+
+
Returns: ckey as string
discord_lookup_id
+
+
Given a ckey, look up the discord user id attached to the user, if any
+
This gets the most recent entry from the discord_link table that is associated with the given ckey
+
Arguments:
+
+
lookup_ckey A string representing the ckey to search on
+
drop_item
+
+
If your mob is concious, drop the item in the active hand
+
This is a hidden verb, likely for binding with winset for hotkeys
dsay
+
+
Our current command name to swap back to after sending the report.
+The sound we're going to play on report.
find_discord_link_by_ckey
+
+
Find discord link entry by the passed in user ckey
+
This will look into the discord link table and return the last (most recent) entry that matches the given ckey
+
Arguments:
+
+
ckey the users ckey as a string
+
timebound A boolean flag, that specifies if it should only look for entries within the last 4 hours, false by default
broadcaster[id_tag] = machine
+listened_to[atmos_chamber_entry] = bool
+TRUE means we have the corresponding id_tag being listened to by an atmos control computer.
+broadcasted_to[id_tag[1]] = bool
+TRUE means we have the corresponding id_tag being broadcasted to by a device, be it meter, sensors, etc.
+How many things dont fit the recognized subtypes.
+How many things have invalid (messes with our delimiter) tags.
+How many things have empty tags, invalids but much worse.
+How many things have duped id_tag.
+How many things are broadcasting without an atmos computer listening
+How many atmos computers are listening to an empty tag.
get_award_status
+
+
Redirect proc that makes it easier to get the status of an achievement. Achievement type is the typepath to the award.
get_remaining_days
+
+
Checks if this client has met the days requirement passed in, or if
+they are exempt from it.
+Returns the number of days left, or 0.
give_award
+
+
Redirect proc that makes it easier to call the unlock achievement proc. Achievement type is the typepath to the award, user is the mob getting the award, and value is an optional variable used for leaderboard value increments
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
initialize_menus
+
+
Initializes dropdown menus on client
is_drag_clickable
+
+
Does the logic for checking if a drag counts as a click or not
+Returns true if it does, false otherwise
is_veteran
+
+
Returns whether the client should receive the gamer cloak
keyUp
+
+
Check if the key is short enough to even be a real key
on_stat_panel_message
+
+
Handles incoming messages from the stat-panel TGUI.
only_one
+
+
Gives everyone kilts, berets, claymores, and pinpointers, with the objective to hijack the emergency shuttle.
+Uses highlander controller to do so!
+
Arguments:
+
+
was_delayed: boolean: whether the option to do a "delayed" highlander was pressed before this was called, changes up the logging a bit.
+
ooc
+
+
talking in OOC uses this
open_particle_editor
+
+
opens the particle editor UI for the in_atom object for this client
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.
requests
+
+
Verb for opening the requests manager panel
reset_held_keys
+
+
Manually clears any held keys, in case due to lag or other undefined behavior a key gets stuck.
+
Hardcoded to the ESC key.
send_resources
+
+
Send resources to the client.
+Sends both game resources and browser assets.
set_macros
+
+
Apply client macros. Has a system to prevent infighting bullshit. There's probably a cleaner way to do this but I'm tired.
setup_popup
+
+
Create the popup, and get it ready for generic use by giving
+it a background.
+
Width and height are multiplied by 64 by default.
spawn_debug_full_crew
+
+
Debug verb that spawns human crewmembers
+of each job type, gives them a mind and assigns the role,
+and injects them into the manifest, as if they were a "player".
+
This spawns humans with minds and jobs, but does NOT make them 'players'.
+They're all clientles mobs with minds / jobs.
strip_verbs
+
+
Strip verbs from a client and it's mob.
toggle_walk_run
+
+
Verb to toggle the walk or run status
uiclose
+
+
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.
update_exp_list
+
+
Tallies up the exp for the playtime tracking and adds it to the global update list.
For a client mob of /mob/living, it grabs the exp list from a mob proc call.
+Being dead but still in your body will tally time towards your /mob/living roles instead of ghost roles.
+If /mob/living returns an empty list, uses "Unknown" instead.
+
For anything else, it doesn't update anything.
+
Arguments:
+
+
minutes - The number of minutes to add to the playtime tally.
+
update_special_keybinds
+
+
Updates the keybinds for special keys
+
Handles adding macros for the keys that need it
+And adding movement keys to the clients movement_keys list
+At the time of writing this, communication(OOC, Say, IC) require macros
+Arguments:
+
+
direct_prefs - the preference we're going to get keybinds from
This folder is full of #define statements. They are similar to constants,
+but must come before any code that references them, and they do not take up
+memory the way constants do.
+
The values in this folder are NOT options. They are not for hosts to play with.
+Some of the values are arbitrary and only need to be different from similar constants;
+for example, the genetic mutation numbers in genetics.dm mean nothing, but MUST be distinct.
+
It is wise not to touch them unless you understand what they do, where they're used,
+and most importantly,
+how to undo your changes if you screw it up.
No augments, for monkeys in specific because they will turn into fucking freakazoids https://cdn.discordapp.com/attachments/326831214667235328/791313258912153640/102707682-fa7cad80-4294-11eb-8f13-8c689468aeb0.png
No augments, for monkeys in specific because they will turn into fucking freakazoids https://cdn.discordapp.com/attachments/326831214667235328/791313258912153640/102707682-fa7cad80-4294-11eb-8f13-8c689468aeb0.png
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
Returns true if the MC is initialized and running.
+Optional argument init_stage controls what stage the mc must have initializted to count as initialized. Defaults to INITSTAGE_MAX if not specified.
+
SubSystem flags (Please design any new flags so that the default is off, to make adding flags to subsystems easier)
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
Treat wait as a tick count, not DS, run every wait ticks.
+(also forces it to run first in the tick (unless SS_BACKGROUND))
+(We don't want to be choked out by other subsystems queuing into us)
+(implies all runlevels because of how it works)
+This is designed for basically anything that works as a mini-mc (like SStimer)
keep the subsystem's timing on point by firing early if it fired late last fire because of lag
+ie: if a 20ds subsystem fires say 5 ds late due to lag or what not, its next fire would be in 15ds, not 20ds.
Calculate its next fire after its fired.
+(IE: if a 5ds wait SS takes 2ds to run, its next fire should be 5ds away, not 3ds like it normally would be)
+This flag overrides SS_KEEP_TIMING
This subsystem should not be queued if it has no work
+Populate the [hibernate_checks] list with the names of vars to check before a subsystem is queued.
+If the length() of each var is 0, it will not be queued
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
Returns true if the MC is initialized and running.
+Optional argument init_stage controls what stage the mc must have initializted to count as initialized. Defaults to INITSTAGE_MAX if not specified.
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
This subsystem should not be queued if it has no work
+Populate the [hibernate_checks] list with the names of vars to check before a subsystem is queued.
+If the length() of each var is 0, it will not be queued
keep the subsystem's timing on point by firing early if it fired late last fire because of lag
+ie: if a 20ds subsystem fires say 5 ds late due to lag or what not, its next fire would be in 15ds, not 20ds.
Calculate its next fire after its fired.
+(IE: if a 5ds wait SS takes 2ds to run, its next fire should be 5ds away, not 3ds like it normally would be)
+This flag overrides SS_KEEP_TIMING
Treat wait as a tick count, not DS, run every wait ticks.
+(also forces it to run first in the tick (unless SS_BACKGROUND))
+(We don't want to be choked out by other subsystems queuing into us)
+(implies all runlevels because of how it works)
+This is designed for basically anything that works as a mini-mc (like SStimer)
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, megafauna, storage containers)
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, megafauna, storage containers)
Abstract-ness is a meta-property of a class that is used to indicate
+that the class is intended to be used as a base class for others, and
+should not (or cannot) be instantiated.
+We have no such language concept in DM, and so we provide a datum member
+that can be used to hint at abstractness for circumstances where we would
+like that to be the case, such as base behavior providers.
+TRUE if the current path is abstract. See __DEFINES\abstract.dm for more information.
+Instantiating abstract paths is illegal.
Abstract-ness is a meta-property of a class that is used to indicate
+that the class is intended to be used as a base class for others, and
+should not (or cannot) be instantiated.
+We have no such language concept in DM, and so we provide a datum member
+that can be used to hint at abstractness for circumstances where we would
+like that to be the case, such as base behavior providers.
+TRUE if the current path is abstract. See __DEFINES\abstract.dm for more information.
+Instantiating abstract paths is illegal.
Command staff/secure accesses, think bridge/armoury, AI upload, notably access to modify ID cards themselves. Do not use direct, access via SSid_access.get_flag_access_list(ACCESS_FLAG_COMMAND)
Private head of staff offices, usually only granted to most cards by trimming. Do not use direct, access via SSid_access.get_flag_access_list(ACCESS_FLAG_PRV_COMMAND)
Weird internal Cult access that prevents non-cult from using their doors. Do not use direct, access via SSid_access.get_flag_access_list(ACCESS_FLAG_SPECIAL)
A list of PDA paths that can be painted as well as the regional heads which should be able to paint them.
+If a PDA is not in this list, it cannot be painted using the PDA & ID Painter.
+If a PDA is in this list, it can always be painted with ACCESS_CHANGE_IDS.
+Used to see pda_region in /datum/controller/subsystem/id_access/proc/setup_tgui_lists
All regions that make up the station area. Helper define to quickly designate a region as part of the station or not. Access via SSid_access.station_regions.
Command staff/secure accesses, think bridge/armoury, AI upload, notably access to modify ID cards themselves. Do not use direct, access via SSid_access.get_flag_access_list(ACCESS_FLAG_COMMAND)
Weird internal Cult access that prevents non-cult from using their doors. Do not use direct, access via SSid_access.get_flag_access_list(ACCESS_FLAG_SPECIAL)
A list of PDA paths that can be painted as well as the regional heads which should be able to paint them.
+If a PDA is not in this list, it cannot be painted using the PDA & ID Painter.
+If a PDA is in this list, it can always be painted with ACCESS_CHANGE_IDS.
+Used to see pda_region in /datum/controller/subsystem/id_access/proc/setup_tgui_lists
Private head of staff offices, usually only granted to most cards by trimming. Do not use direct, access via SSid_access.get_flag_access_list(ACCESS_FLAG_PRV_COMMAND)
All regions that make up the station area. Helper define to quickly designate a region as part of the station or not. Access via SSid_access.station_regions.
for /proc/check_asay_links, if there are any actionable refs in the asay message, this index in the return list contains the new message text to be printed
for /proc/check_asay_links, if there are any actionable refs in the asay message, this index in the return list contains the new message text to be printed
Will get within a few tiles of whatever you point at and continually growl/bark. If the target is a living mob who gets too close, the dog will attack them with bites
Will get within a few tiles of whatever you point at and continually growl/bark. If the target is a living mob who gets too close, the dog will attack them with bites
The normal cost of an uplink implant; used for calcuating how many
+TC to charge someone if they get a free implant through choice or
+because they have nothing else that supports an implant.
The normal cost of an uplink implant; used for calcuating how many
+TC to charge someone if they get a free implant through choice or
+because they have nothing else that supports an implant.
The amount of pressure damage someone takes is equal to (pressure / HAZARD_HIGH_PRESSURE)*PRESSURE_DAMAGE_COEFFICIENT, with the maximum of MAX_PRESSURE_DAMAGE
The amount of pressure damage someone takes is equal to (pressure / HAZARD_HIGH_PRESSURE)*PRESSURE_DAMAGE_COEFFICIENT, with the maximum of MAX_PRESSURE_DAMAGE
I feel the need to document what happens here. Basically this is used
+catch rounding errors, and make gas go away in small portions.
+People have raised it to higher levels in the past, do not do this. Consider this number a soft limit
+If you're making gasmixtures that have unexpected behavior related to this value, you're doing something wrong.
Some further context on breakdown. Unlike dismantle, the breakdown ticker doesn't reset itself when a tile is added
+This is because we cannot expect maps to have small spaces, so we need to even ourselves out often
+We do this to avoid equalizing a large space in one tick, with some significant amount of say heat diff
+This way large areas don't suddenly all become cold at once, it acts more like a wave
Ratio of air that must move to/from a tile to reset group processing
+Minimum ratio of air that must move to/from a tile
+Minimum amount of air that has to move before a group processing can be suspended (Round about 10)
+Either this must be active (round about 0.1) //Might need to raise this a tad to better support space leaks. we'll see
+or this (or both, obviously)
+Minimum temperature difference before group processing is suspended
+Minimum temperature difference before the gas temperatures are just set to be equal
+Minimum temperature to continue superconduction once started
+Minimum temperature to start doing superconduction calculations
+a hack for now
+a hack to help make vacuums "cold", sacrificing realism for gameplay
percentage of oxygen in a normal mixture of air
+same but for nitrogen
+O2 standard value (21%)
+N2 standard value (79%)
+liters in a cell
+O2 value for anesthetic canister
Some further context on breakdown. Unlike dismantle, the breakdown ticker doesn't reset itself when a tile is added
+This is because we cannot expect maps to have small spaces, so we need to even ourselves out often
+We do this to avoid equalizing a large space in one tick, with some significant amount of say heat diff
+This way large areas don't suddenly all become cold at once, it acts more like a wave
+
Because of this and the behavior of share(), the breakdown cycles value can be tweaked directly to effect how fast we want gas to move
+number of FULL air controller ticks before an excited group breaks down (averages gas contents across turfs)
Ratio of air that must move to/from a tile to reset group processing
+Minimum ratio of air that must move to/from a tile
+Minimum amount of air that has to move before a group processing can be suspended (Round about 10)
+Either this must be active (round about 0.1) //Might need to raise this a tad to better support space leaks. we'll see
+or this (or both, obviously)
+Minimum temperature difference before group processing is suspended
+Minimum temperature difference before the gas temperatures are just set to be equal
+Minimum temperature to continue superconduction once started
+Minimum temperature to start doing superconduction calculations
+a hack for now
+a hack to help make vacuums "cold", sacrificing realism for gameplay
I feel the need to document what happens here. Basically this is used
+catch rounding errors, and make gas go away in small portions.
+People have raised it to higher levels in the past, do not do this. Consider this number a soft limit
+If you're making gasmixtures that have unexpected behavior related to this value, you're doing something wrong.
+
On an unrelated note this may cause a bug that creates negative gas, related to round(). When it has a second arg it will round up.
+So for instance round(0.5, 1) == 1. I've hardcoded a fix for this into share, by forcing the garbage collect.
+Any other attempts to fix it just killed atmos. I leave this to a greater man then I
+The minimum heat capacity of a gas
percentage of oxygen in a normal mixture of air
+same but for nitrogen
+O2 standard value (21%)
+N2 standard value (79%)
+liters in a cell
+O2 value for anesthetic canister
This is the divisor which handles how much of the temperature difference between the current body temperature and 310.15K (optimal temperature) humans auto-regenerate each tick. The higher the number, the slower the recovery. This is applied each tick, so long as the mob is alive.
Similar to the BODYTEMP_AUTORECOVERY_DIVISOR, but this is the divisor which is applied at the stage that follows autorecovery. This is the divisor which comes into play when the human's loc temperature is lower than their body temperature. Make it lower to lose bodytemp faster.
Similar to the BODYTEMP_AUTORECOVERY_DIVISOR, but this is the divisor which is applied at the stage that follows autorecovery. This is the divisor which comes into play when the human's loc temperature is higher than their body temperature. Make it lower to gain bodytemp faster.
This is the divisor which handles how much of the temperature difference between the current body temperature and 310.15K (optimal temperature) humans auto-regenerate each tick. The higher the number, the slower the recovery. This is applied each tick, so long as the mob is alive.
Similar to the BODYTEMP_AUTORECOVERY_DIVISOR, but this is the divisor which is applied at the stage that follows autorecovery. This is the divisor which comes into play when the human's loc temperature is lower than their body temperature. Make it lower to lose bodytemp faster.
Similar to the BODYTEMP_AUTORECOVERY_DIVISOR, but this is the divisor which is applied at the stage that follows autorecovery. This is the divisor which comes into play when the human's loc temperature is higher than their body temperature. Make it lower to gain bodytemp faster.
liters in a normal breath. note that breaths are taken once every 4 life ticks, which is 8 seconds
+
Addendum for people tweaking this value in the future.
+
Because o2 tank release values/human o2 requirements are very strictly set to the same pressure, small errors can cause breakage
+
This comes from QUANTIZE being used in /datum/gas_mixture.remove(), forming a slight sawtooth pattern of the added/removed gas, centered on the actual pressure
+
Changing BREATH_VOLUME can set us on the lower half of this sawtooth, making humans unable to breath at standard pressure.
+
There's no good way I can come up with to hardcode a fix for this. So if you're going to change this variable
+
graph the functions that describe how it is used/how it interacts with breath code, and pick something on the upper half of the sawtooth
The internal pressure in kPa at which a handheld gas tank begins to take damage.
+The internal pressure in kPa at which a handheld gas tank almost immediately ruptures.
+The internal pressure in kPa at which an gas tank that breaks will cause an explosion.
+Range scaling constant for tank explosions. Calibrated so that a TTV assembled using two 70L tanks will hit the maxcap at at least 160atm.
+Denotes that our tank is overpressurized simply from gas merging.
The internal pressure in kPa at which a handheld gas tank begins to take damage.
+The internal pressure in kPa at which a handheld gas tank almost immediately ruptures.
+The internal pressure in kPa at which an gas tank that breaks will cause an explosion.
+Range scaling constant for tank explosions. Calibrated so that a TTV assembled using two 70L tanks will hit the maxcap at at least 160atm.
+Denotes that our tank is overpressurized simply from gas merging.
The baseline unit for cargo crates. Adjusting this will change the cost of all in-game shuttles, crate export values, bounty rewards, and all supply pack import values, as they use this as their unit of measurement.
The baseline unit for cargo crates. Adjusting this will change the cost of all in-game shuttles, crate export values, bounty rewards, and all supply pack import values, as they use this as their unit of measurement.
Some defines to generalise colours used in lighting.
+
Important note: colors can end up significantly different from the basic html picture, especially when saturated
+Bright but quickly dissipating neon green. rgb(100, 200, 100)
If a carbon is thrown at a speed faster than normal and impacts something solid, they take extra damage for every extra speed up to this number (see [/mob/living/carbon/proc/throw_impact])
Alternate attack defines. Return these at the end of procs like afterattack_secondary.
+Calls the normal attack proc. For example, if returned in afterattack_secondary, will call afterattack.
+Will continue the chain depending on the return value of the non-alternate proc, like with normal attacks.
If a carbon is thrown at a speed faster than normal and impacts something solid, they take extra damage for every extra speed up to this number (see [/mob/living/carbon/proc/throw_impact])
Alternate attack defines. Return these at the end of procs like afterattack_secondary.
+Calls the normal attack proc. For example, if returned in afterattack_secondary, will call afterattack.
+Will continue the chain depending on the return value of the non-alternate proc, like with normal attacks.
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
Causes the detach proc to be called when the host object is being deleted.
+Should only be used if you need to perform cleanup not related to the host object.
+You do not need this if you are only unregistering signals, for instance.
+You would need it if you are doing something like removing the target from a processing list.
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 all detach arguments to be passed to detach instead of only being used to identify the element
+When this is used your Detach proc should have the same signature as your Attach proc
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
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 all detach arguments to be passed to detach instead of only being used to identify the element
+When this is used your Detach proc should have the same signature as your Attach proc
Causes the detach proc to be called when the host object is being deleted.
+Should only be used if you need to perform cleanup not related to the host object.
+You do not need this if you are only unregistering signals, for instance.
+You would need it if you are doing something like removing the target from a processing list.
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
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
tool_act -> pre_attack -> target.attackby (item.attack) -> afterattack
+Ends the attack chain. If sent early might cause posterior attacks not to happen.
tool_act -> pre_attack -> target.attackby (item.attack) -> afterattack
+Ends the attack chain. If sent early might cause posterior attacks not to happen.
from /turf/open/space/Entered(), fired on movement across z-level edges, caught by datum/element/lateral_bound to clean up atoms that shouldn't spaceloop.
from base of atom/movable/Hear(): (proc args list(message, atom/movable/speaker, message_language, raw_message, radio_freq, list/spans, list/message_mods = list()))
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 added to a disposal holder object for disposal movement: (obj/structure/disposalholder/holder, obj/machinery/disposal/source)
from base of atom/movable/Hear(): (proc args list(message, atom/movable/speaker, message_language, raw_message, radio_freq, list/spans, list/message_mods = list()))
from /turf/open/space/Entered(), fired on movement across z-level edges, caught by datum/element/lateral_bound to clean up atoms that shouldn't spaceloop.
from /datum/component/singularity/proc/can_move(), as well as /obj/energy_ball/proc/can_move()
+if a callback returns SINGULARITY_TRY_MOVE_BLOCK, then the singularity will not move to that turf
from /datum/component/singularity/proc/can_move(), as well as /obj/energy_ball/proc/can_move()
+if a callback returns SINGULARITY_TRY_MOVE_BLOCK, then the singularity will not move to that turf
Called when a changeling uses its transform ability (source = carbon), from /datum/action/changeling/transform/sting_action(mob/living/carbon/human/user)
Called when a changeling uses its transform ability (source = carbon), from /datum/action/changeling/transform/sting_action(mob/living/carbon/human/user)
called after an explosion happened : (epicenter, devastation_range, heavy_impact_range, light_impact_range, took, orig_dev_range, orig_heavy_range, orig_light_range)
Global signal sent when the datacore is added to via manifest_inject() (datum/data/record/general, datum/data/record/medical, datum/data/record/security, datum/data/record/locked)
called after an explosion happened : (epicenter, devastation_range, heavy_impact_range, light_impact_range, took, orig_dev_range, orig_heavy_range, orig_light_range)
Global signal sent when the datacore is added to via manifest_inject() (datum/data/record/general, datum/data/record/medical, datum/data/record/security, datum/data/record/locked)
from base of obj/item/attack(): (/mob/living/target, /mob/living/user)
+Called on an object to "clean it", such as removing blood decals/overlays, etc. The clean types bitfield is sent with it. Return TRUE if any cleaning was necessary and thus performed.
from base of obj/item/attack(): (/mob/living/target, /mob/living/user)
+Called on an object to "clean it", such as removing blood decals/overlays, etc. The clean types bitfield is sent with it. Return TRUE if any cleaning was necessary and thus performed.
from /proc/healthscan(): (list/render_strings, mob/user, mode, advanced)
+Consumers are allowed to mutate the scan_results list to add extra information
from /mob/living/*/UnarmedAttack(), before sending COMSIG_LIVING_UNARMED_ATTACK: (mob/living/source, atom/target, proximity, modifiers)
+The only reason this exists is so hulk can fire before Fists of the North Star.
+Note that this is called before /mob/living/proc/can_unarmed_attack is called, so be wary of that.
from /mob/living/*/UnarmedAttack(), before sending COMSIG_LIVING_UNARMED_ATTACK: (mob/living/source, atom/target, proximity, modifiers)
+The only reason this exists is so hulk can fire before Fists of the North Star.
+Note that this is called before /mob/living/proc/can_unarmed_attack is called, so be wary of that.
from /proc/healthscan(): (list/render_strings, mob/user, mode, advanced)
+Consumers are allowed to mutate the scan_results list to add extra information
from base of /obj/projectile/proc/on_hit(), like COMSIG_PROJECTILE_ON_HIT but on the projectile itself and with the hit limb (if any): (atom/movable/firer, atom/target, Angle, hit_limb)
sent from clicking while you have no equipment selected. Sent before cooldown and adjacency checks, so you can use this for infinite range things if you want.
sent from clicking while you have no equipment selected. Sent before cooldown and adjacency checks, so you can use this for infinite range things if you want.
from base of /obj/projectile/proc/on_hit(), like COMSIG_PROJECTILE_ON_HIT but on the projectile itself and with the hit limb (if any): (atom/movable/firer, atom/target, Angle, hit_limb)
From the radiation subsystem, called before a potential irradiation.
+This does not guarantee radiation can reach or will succeed, but merely that there's a radiation source within range.
+(datum/radiation_pulse_information/pulse_information, insulation_to_target)
If this is flipped, then minimum exposure time will not be checked.
+If it is not flipped, and the pulse information has a minimum exposure time, then
+the countdown will begin.
From the radiation subsystem, called before a potential irradiation.
+This does not guarantee radiation can reach or will succeed, but merely that there's a radiation source within range.
+(datum/radiation_pulse_information/pulse_information, insulation_to_target)
If this is flipped, then minimum exposure time will not be checked.
+If it is not flipped, and the pulse information has a minimum exposure time, then
+the countdown will begin.
from base of /datum/reagent/proc/expose_atom: (/mob/living, reac_volume, methods, show_message, touch_protection, /mob/camera/blob) // ovemind arg is only used by blob reagents.
from base of /datum/reagent/proc/expose_atom: (/mob/living, reac_volume, methods, show_message, touch_protection, /mob/camera/blob) // ovemind arg is only used by blob reagents.
(customer, container) venue signal sent when a venue sells an item. source is the thing sold, which can be a datum, so we send container for location checks
(customer, container) venue signal sent when a venue sells an item. source is the thing sold, which can be a datum, so we send container for location checks
A "Type-A" contextual screentip interaction.
+These are used for items that are defined by their behavior. They define their contextual text within themselves,
+not in their targets.
+Examples include syringes (LMB to inject, RMB to draw) and health analyzers (LMB to scan health/wounds, RMB for chems)
+Items can override add_item_context(), and call register_item_context() in order to easily connect to this.
+Called on /obj/item with a mutable screentip context list, the hovered target, and the mob hovering.
+A screentip context list is a list that has context keys (SCREENTIP_CONTEXT_*, from __DEFINES/screentips.dm)
+that map to the action as text.
+If you mutate the list in this signal, you must return CONTEXTUAL_SCREENTIP_SET.
A "Type-B" contextual screentip interaction.
+These are atoms that are defined by what happens to them. These should define contextual text within themselves, and
+not in their operating tools.
+Examples include construction objects (LMB with glass to put in screen for computers).
+Called on /atom with a mutable screentip context list, the item being used, and the mob hovering.
+A screentip context list is a list that has context keys (SCREENTIP_CONTEXT_*, from __DEFINES/screentips.dm)
+that map to the action as text.
+If you mutate the list in this signal, you must return CONTEXTUAL_SCREENTIP_SET.
A "Type-B" contextual screentip interaction.
+These are atoms that are defined by what happens to them. These should define contextual text within themselves, and
+not in their operating tools.
+Examples include construction objects (LMB with glass to put in screen for computers).
+Called on /atom with a mutable screentip context list, the item being used, and the mob hovering.
+A screentip context list is a list that has context keys (SCREENTIP_CONTEXT_*, from __DEFINES/screentips.dm)
+that map to the action as text.
+If you mutate the list in this signal, you must return CONTEXTUAL_SCREENTIP_SET.
A "Type-A" contextual screentip interaction.
+These are used for items that are defined by their behavior. They define their contextual text within themselves,
+not in their targets.
+Examples include syringes (LMB to inject, RMB to draw) and health analyzers (LMB to scan health/wounds, RMB for chems)
+Items can override add_item_context(), and call register_item_context() in order to easily connect to this.
+Called on /obj/item with a mutable screentip context list, the hovered target, and the mob hovering.
+A screentip context list is a list that has context keys (SCREENTIP_CONTEXT_*, from __DEFINES/screentips.dm)
+that map to the action as text.
+If you mutate the list in this signal, you must return CONTEXTUAL_SCREENTIP_SET.
Sent from/datum/action/cooldown/spell/jaunt/bloodcrawl/slaughter_demon/try_enter_jaunt,
+to any unconscious / critical mobs being dragged when the jaunter enters blood:
+(datum/action/cooldown/spell/jaunt/bloodcrawl/crawl, mob/living/jaunter, obj/effect/decal/cleanable/blood)
Sent from/datum/action/cooldown/spell/jaunt/bloodcrawl/slaughter_demon/consume_victim,
+to the victim being consumed by the slaughter demon.
+(datum/action/cooldown/spell/jaunt/bloodcrawl/crawl, mob/living/jaunter)
Sent from /datum/action/cooldown/spell/aoe/knock/cast(), to every nearby turf (for connect loc): (datum/action/cooldown/spell/aoe/knock/spell, mob/living/caster)
Sent from /datum/action/cooldown/spell/aoe/knock/cast(), to every nearby turf (for connect loc): (datum/action/cooldown/spell/aoe/knock/spell, mob/living/caster)
Sent from/datum/action/cooldown/spell/jaunt/bloodcrawl/slaughter_demon/consume_victim,
+to the victim being consumed by the slaughter demon.
+(datum/action/cooldown/spell/jaunt/bloodcrawl/crawl, mob/living/jaunter)
Sent from/datum/action/cooldown/spell/jaunt/bloodcrawl/slaughter_demon/try_enter_jaunt,
+to any unconscious / critical mobs being dragged when the jaunter enters blood:
+(datum/action/cooldown/spell/jaunt/bloodcrawl/crawl, mob/living/jaunter, obj/effect/decal/cleanable/blood)
from base of turf/ChangeTurf(): (path, list/new_baseturfs, flags, list/post_change_callbacks).
+post_change_callbacks is a list that signal handlers can mutate to append /datum/callback objects.
+They will be called with the new turf after the turf has changed.
from base of turf/ChangeTurf(): (path, list/new_baseturfs, flags, list/post_change_callbacks).
+post_change_callbacks is a list that signal handlers can mutate to append /datum/callback objects.
+They will be called with the new turf after the turf has changed.
If this atom has experienced a decal element "init finished" sourced appearance update
+We use this to ensure stacked decals don't double up appearance updates for no rasin
+Flag as an optimization, don't make this a trait without profiling
+Yes I know this is a stupid flag, no you can't take him from me ~LemonInTheDark
If this turf is mimicking, overwrite its appearance instead of using a mimic object. This is faster, but means the turf cannot have its own appearance.
Check this movable's overlays/underlays for explicit plane use and mangle for compatibility with Z-Mimic. If you're using emissive overlays, you probably should be using this flag. Expensive, only use if necessary.
If this atom has experienced a decal element "init finished" sourced appearance update
+We use this to ensure stacked decals don't double up appearance updates for no rasin
+Flag as an optimization, don't make this a trait without profiling
+Yes I know this is a stupid flag, no you can't take him from me ~LemonInTheDark
Check this movable's overlays/underlays for explicit plane use and mangle for compatibility with Z-Mimic. If you're using emissive overlays, you probably should be using this flag. Expensive, only use if necessary.
If this turf is mimicking, overwrite its appearance instead of using a mimic object. This is faster, but means the turf cannot have its own appearance.
The point where gravity is negative enough to pull you upwards.
+That means walking checks for a ceiling instead of a floor, and you can fall "upwards"
The point where gravity is negative enough to pull you upwards.
+That means walking checks for a ceiling instead of a floor, and you can fall "upwards"
+
This should only be possible on multi-z maps because it works like shit on maps that aren't.
The order in which these lists are defined matters. When attempting to add a wildcard access to a card
+and not specifying an explicit wildcard slot in which to include it, the code will iterate over the list
+and stop at the first wildcard flag that can hold the access.
Wildcard slot define for select Syndicate-affiliated cards. Can hold infinite of any Syndicate level wildcard. Syndicate includes all station accesses.
The order in which these lists are defined matters. When attempting to add a wildcard access to a card
+and not specifying an explicit wildcard slot in which to include it, the code will iterate over the list
+and stop at the first wildcard flag that can hold the access.
+
The lower level the access, the earlier in the list it should be so that low level wildcards get
+added to the lowest wildcard flag that can take them.
+
A limit of -1 means infinite slots. The system is designed to reject a wildcard when the slot limit
+explicitly equal 0 for all compatible wildcard slots.
+Wildcard slot define for basic grey cards. Only hold 2 common wildcards.
Wildcard slot define for select Syndicate-affiliated cards. Can hold infinite of any Syndicate level wildcard. Syndicate includes all station accesses.
the client mobs channel of the important_recursive_contents list, everything in here will be a mob with an attached client
+this is given to both a clients mob, and a clients eye, both point to the clients mob
the client mobs channel of the important_recursive_contents list, everything in here will be a mob with an attached client
+this is given to both a clients mob, and a clients eye, both point to the clients mob
MACHINES HAVE THIS BY DEFAULT, SOMEONE SHOULD RUN THROUGH MACHINES AND REMOVE IT FROM THINGS LIKE LIGHT SWITCHES WHEN POSSIBLE!!--------------------------
+This flag determines if a machine set_machine's the user when the user uses it, making updateUsrDialog make the user re-call interact() on it.
+THIS FLAG IS ON ALL MACHINES BY DEFAULT, NEEDS TO BE RE-EVALUATED LATER!!
MACHINES HAVE THIS BY DEFAULT, SOMEONE SHOULD RUN THROUGH MACHINES AND REMOVE IT FROM THINGS LIKE LIGHT SWITCHES WHEN POSSIBLE!!--------------------------
+This flag determines if a machine set_machine's the user when the user uses it, making updateUsrDialog make the user re-call interact() on it.
+THIS FLAG IS ON ALL MACHINES BY DEFAULT, NEEDS TO BE RE-EVALUATED LATER!!
For when you don't want the "breast" effect to be applied (the one that cuts two pixels in the middle of the front of the uniform when facing east or west).
For when you don't want the "breast" effect to be applied (the one that cuts two pixels in the middle of the front of the uniform when facing east or west).
These names are used as keys in many locations in the database
+you cannot change them trivially without breaking job bans and
+role time tracking, if you do this and get it wrong you will die
+and it will hurt the entire time
Value used to round lumcounts, values smaller than 1/129 don't matter (if they do, thanks sinking points), greater values will make lighting less precise, but in turn increase performance, VERY SLIGHTLY.
If the max of the lighting lumcounts of each spectrum drops below this, disable luminosity on the lighting objects.
+Set to zero to disable soft lighting. Luminosity changes then work if it's lit at all.
For lighting alpha, small amounts lead to big changes. even at 128 its hard to figure out what is dark and what is light, at 64 you almost can't even tell.
Uses vis_overlays to leverage caching so that very few new items need to be made for the overlay. For anything that doesn't change outline or opaque area much or at all.
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 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.
Uses vis_overlays to leverage caching so that very few new items need to be made for the overlay. For anything that doesn't change outline or opaque area much or at all.
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 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.
For lighting alpha, small amounts lead to big changes. even at 128 its hard to figure out what is dark and what is light, at 64 you almost can't even tell.
Value used to round lumcounts, values smaller than 1/129 don't matter (if they do, thanks sinking points), greater values will make lighting less precise, but in turn increase performance, VERY SLIGHTLY.
If the max of the lighting lumcounts of each spectrum drops below this, disable luminosity on the lighting objects.
+Set to zero to disable soft lighting. Luminosity changes then work if it's lit at all.
Bitflags for a machine's preferences on when it should start processing. For use with machinery's processing_flags var.
+Indicates the machine will automatically start processing right after it's Initialize() is ran.
Bitflags for a machine's preferences on when it should start processing. For use with machinery's processing_flags var.
+Indicates the machine will automatically start processing right after it's Initialize() is ran.
Whether the spell can only be cast by humans (mob type, not species).
+SPELL_REQUIRES_WIZARD_GARB comes with this flag implied, as carbons and below can't wear clothes.
Whether the spell can only be cast by humans (mob type, not species).
+SPELL_REQUIRES_WIZARD_GARB comes with this flag implied, as carbons and below can't wear clothes.
Converts a probability/second chance to probability/delta_time chance
+For example, if you want an event to happen with a 10% per second chance, but your proc only runs every 5 seconds, do if(prob(100*DT_PROB_RATE(0.1, 5)))
Converts a probability/second chance to probability/delta_time chance
+For example, if you want an event to happen with a 10% per second chance, but your proc only runs every 5 seconds, do if(prob(100*DT_PROB_RATE(0.1, 5)))
These are also memories, but they're examples of what I kinda don't want to be memories. They're stuff that I had to port
+over to this system from the old old and they don't make for good examples
Generic memory info keys. Use these whenever one of these is the case in a story, because we add extra story piece if these exist.
+The location of the memory, add these to have a chance of it being added to the story
Usually used bespokely by specific memory types and not added generically, but its generaly the object used to cause the memory. E.g. a peel to slip, the food that was eaten.
Usually used bespokely by specific memory types and not added generically, but its generaly the object used to cause the memory. E.g. a peel to slip, the food that was eaten.
Generic memory info keys. Use these whenever one of these is the case in a story, because we add extra story piece if these exist.
+The location of the memory, add these to have a chance of it being added to the story
These are also memories, but they're examples of what I kinda don't want to be memories. They're stuff that I had to port
+over to this system from the old old and they don't make for good examples
+
ideally these eventually get moved off this system... though engraving your bank account is so HILARIOUSLY dumb so maybe leave that one
+your memorized bank account
Ice slides only go one tile and don't knock you over, they're intended to cause a "slip chain"
+where you slip on ice until you reach a non-slippable tile (ice puzzles)
Possible value of /atom/movable/buckle_lying. If set to a different (positive-or-zero) value than this, the buckling thing will force a lying angle on the buckled.
Possible value of /atom/movable/buckle_lying. If set to a different (positive-or-zero) value than this, the buckling thing will force a lying angle on the buckled.
Ice slides only go one tile and don't knock you over, they're intended to cause a "slip chain"
+where you slip on ice until you reach a non-slippable tile (ice puzzles)
The maximum for glide_size to be clamped to.
+This shouldn't be higher than the icon size, and generally you shouldn't be changing this, but it's here just in case.
Broken down, here's what this does:
+divides the world icon_size (32) by delay divided by ticklag to get the number of pixels something should be moving each tick.
+The division result is given a min value of 1 to prevent obscenely slow glide sizes from being set
+Then that's multiplied by the global glide size multiplier. 1.25 by default feels pretty close to spot on. This is just to try to get byond to behave.
+The whole result is then clamped to within the range above.
+Not very readable but it works
Returns a bitfield containing flags both present in flags arg and the processing_move_loop_flags move_packet variable.
+Has no use outside of procs called within the movement proc chain.
currently_z_moving defines. Higher numbers mean higher priority.
+This one is for falling down open space from stuff such as deleted tile, pit grate...
possible bitflag return values of [atom/proc/intercept_zImpact] calls
+Stops the movable from falling further and crashing on the ground. Example: stairs.
Runs recheck_grabs() by the end of [/atom/movable/proc/zMove] for every movable that's pulling something. Should be kept enabled unless you know what you are doing.
Returns a bitfield containing flags both present in flags arg and the processing_move_loop_flags move_packet variable.
+Has no use outside of procs called within the movement proc chain.
currently_z_moving defines. Higher numbers mean higher priority.
+This one is for falling down open space from stuff such as deleted tile, pit grate...
Broken down, here's what this does:
+divides the world icon_size (32) by delay divided by ticklag to get the number of pixels something should be moving each tick.
+The division result is given a min value of 1 to prevent obscenely slow glide sizes from being set
+Then that's multiplied by the global glide size multiplier. 1.25 by default feels pretty close to spot on. This is just to try to get byond to behave.
+The whole result is then clamped to within the range above.
+Not very readable but it works
possible bitflag return values of [atom/proc/intercept_zImpact] calls
+Stops the movable from falling further and crashing on the ground. Example: stairs.
The maximum for glide_size to be clamped to.
+This shouldn't be higher than the icon size, and generally you shouldn't be changing this, but it's here just in case.
Runs recheck_grabs() by the end of [/atom/movable/proc/zMove] for every movable that's pulling something. Should be kept enabled unless you know what you are doing.
prevents syringes, parapens and hypos if the external suit or helmet (if targeting head) has this flag.
+Example: space suits, biosuit, bombsuits, thick suits that cover your body.
prevents syringes, parapens and hypos if the external suit or helmet (if targeting head) has this flag.
+Example: space suits, biosuit, bombsuits, thick suits that cover your body.
Automatically connect to a data terminal at lateinit.
+Not having this flag and attempting to interact with
+data_terminals via [/obj/machinery/proc/link_to_jack()] is illegal and will explicitly crash.
Add the machine to [/datum/powernet/var/list/data_nodes]
+You should have a VERY good reason for this to be set on anything not of type /obj/machinery/power
Packet contains data that players should never be able to see DIRECTLY.
+Re-Interpretation is allowed, This is specifically for arbitrary packet capture applications where raw fields are accessible.
+For example, voice signal packets, or stuff that wouldn't make sense to be parsable as raw text.
Packet contains data that players should never be able to see DIRECTLY.
+Re-Interpretation is allowed, This is specifically for arbitrary packet capture applications where raw fields are accessible.
+For example, voice signal packets, or stuff that wouldn't make sense to be parsable as raw text.
Add the machine to [/datum/powernet/var/list/data_nodes]
+You should have a VERY good reason for this to be set on anything not of type /obj/machinery/power
Automatically connect to a data terminal at lateinit.
+Not having this flag and attempting to interact with
+data_terminals via [/obj/machinery/proc/link_to_jack()] is illegal and will explicitly crash.
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
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
Macro that takes a tick usage to target, and proceses until we hit it
+This lets us simulate generic load as we'd like, to make testing for overtime easier
Macro that takes a tick usage to target, and proceses until we hit it
+This lets us simulate generic load as we'd like, to make testing for overtime easier
The caliber used by the Nanotrasen Saber SMG, PP-95 SMG and Type U3 Uzi. Also used as the default caliber for pistols but only the stechkin APS machine pistol doesn't override it.
The caliber used by the Nanotrasen Saber SMG, PP-95 SMG and Type U3 Uzi. Also used as the default caliber for pistols but only the stechkin APS machine pistol doesn't override it.
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.
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.
The prority used to indicate that a reaction should run immediately at the start of a reaction cycle. Currently used by a jumble of decomposition reactions and purgative reactions.
The priority used for reactions that produce a useful or more advanced product. Goes after purgative reactions so that the purgers can be slightly more useful.
The priority used for indicate that a reactions should run immediately before most forms of combustion. Used by two decomposition reactions and steam condensation.
The priority used to indicate that a reactions should run after all other types of reactions. Exclusively used for combustion reactions that produce fire or are freon.
An exponent used to make large volume gas mixtures significantly less likely to release rads. Used to prevent tritfires in distro from irradiating literally the entire station with no warning.
The minimum thermal energy necessary for hydrogen fires to use the HYDROGEN_OXYBURN_MULTIPLIER. Used to prevent overpowered hydrogen/oxygen singletank bombs to moderate success.
The minimum thermal energy necessary for tritium fires to use the TRITIUM_OXYBURN_MULTIPLIER. Used to prevent overpowered tritium/oxygen singletank bombs to moderate success.
The minimum number of moles of trit that must be burnt for a tritium fire reaction to produce a radiation pulse. (0.01 moles trit or 10 moles oxygen to start producing rads.)
A scaling factor for the irradiation chance from energy released. This is the energy release required for everything in range to have a 50% chance of getting irradiated.
The maximum temperature BZ can form at. Deliberately set lower than the minimum burn temperature for most combustible gases in an attempt to prevent long fuse singlecaps.
An exponent used to make large volume gas mixtures significantly less likely to release rads. Used to prevent tritfires in distro from irradiating literally the entire station with no warning.
The maximum temperature BZ can form at. Deliberately set lower than the minimum burn temperature for most combustible gases in an attempt to prevent long fuse singlecaps.
The minimum thermal energy necessary for hydrogen fires to use the HYDROGEN_OXYBURN_MULTIPLIER. Used to prevent overpowered hydrogen/oxygen singletank bombs to moderate success.
The minimum thermal energy necessary for tritium fires to use the TRITIUM_OXYBURN_MULTIPLIER. Used to prevent overpowered tritium/oxygen singletank bombs to moderate success.
The priority used to indicate that a reactions should run after all other types of reactions. Exclusively used for combustion reactions that produce fire or are freon.
The priority used for reactions that produce a useful or more advanced product. Goes after purgative reactions so that the purgers can be slightly more useful.
The priority used for indicate that a reactions should run immediately before most forms of combustion. Used by two decomposition reactions and steam condensation.
The prority used to indicate that a reaction should run immediately at the start of a reaction cycle. Currently used by a jumble of decomposition reactions and purgative reactions.
A scaling factor for the irradiation chance from energy released. This is the energy release required for everything in range to have a 50% chance of getting irradiated.
The minimum number of moles of trit that must be burnt for a tritium fire reaction to produce a radiation pulse. (0.01 moles trit or 10 moles oxygen to start producing rads.)
Used to force reactions to create a specific amount of heat per 1u created. So if thermic_constant = 5, for 1u of reagent produced, the heat will be forced up arbitarily by 5 irresepective of other reagents. If you use this, keep in mind standard thermic_constant values are 100x what it should be with this enabled.
Used to bypass the chem_master transfer block (This is needed for competitive reactions unless you have an end state programmed). More stuff might be added later. When defining this, please add in the comments the associated reactions that it competes with
If a reaction will generate it's impure/inverse reagents in the middle of a reaction, as apposed to being determined on ingestion/on reaction completion
Used to bypass the chem_master transfer block (This is needed for competitive reactions unless you have an end state programmed). More stuff might be added later. When defining this, please add in the comments the associated reactions that it competes with
Used to force reactions to create a specific amount of heat per 1u created. So if thermic_constant = 5, for 1u of reagent produced, the heat will be forced up arbitarily by 5 irresepective of other reagents. If you use this, keep in mind standard thermic_constant values are 100x what it should be with this enabled.
If a reaction will generate it's impure/inverse reagents in the middle of a reaction, as apposed to being determined on ingestion/on reaction completion
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
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
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:
+
+
key - The key for the automaton, to be used with subsequent rustg_acreplace/rustg_acreplace_with_replacements calls
+
patterns - A non-associative list of strings to search for
+
replacements - Default replacements for this automaton, used with rustg_acreplace
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:
+
+
key - The key for the automaton, to be used with subsequent rustg_acreplace/rustg_acreplace_with_replacements calls
+
options - An associative list like list("anchored" = 0, "ascii_case_insensitive" = 0, "match_kind" = "Standard"). The values shown on the example are the defaults, and default values may be omitted. See the identically named methods at https://docs.rs/aho-corasick/latest/aho_corasick/struct.AhoCorasickBuilder.html to see what the options do.
+
patterns - A non-associative list of strings to search for
+
replacements - Default replacements for this automaton, used with rustg_acreplace
changes the cell_(x or y) vars on /datum/spatial_grid_cell to the x or y coordinate on the map for the LOWER LEFT CORNER of the grid cell.
+index is from 1 to SPATIAL_GRID_CELLS_PER_SIDE
changes the cell_(x or y) vars on /datum/spatial_grid_cell to the x or y coordinate on the map for the LOWER LEFT CORNER of the grid cell.
+index is from 1 to SPATIAL_GRID_CELLS_PER_SIDE
call LateInitialize at the end of all atom Initalization
+
The item will be added to the late_loaders list, this is iterated over after
+initalization of subsystems is complete and calls LateInitalize on the atom
+see this file for the LateIntialize proc
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 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.
Define that just has the current in-universe year for use in whatever context you might want to display that in. (For example, 2022 -> 2562 given a 540 year offset)
Define that just has the current in-universe year for use in whatever context you might want to display that in. (For example, 2022 -> 2562 given a 540 year offset)
Their eyes glow an unnatural red colour. Currently used to set special examine text on humans. Does not guarantee the mob's eyes are coloured red, nor that there is any visible glow on their character sprite.
This atom can ignore the "is on a turf" check for simple AI datum attacks, allowing them to attack from bags or lockers as long as any other conditions are met
Trait put on /mob/living/carbon/human. If that mob has a crystal core, also known as an ethereal heart, it will not try to revive them if the mob dies.
Trait granted by /mob/living/carbon/Initialize and
+granted/removed by /obj/item/organ/tongue
+Used for ensuring that carbons without tongues cannot taste anything
+so it is added in Initialize, and then removed when a tongue is inserted
+and readded when a tongue is removed.
Whether or not this item will allow the radiation SS to go through standard
+radiation processing as if this wasn't already irradiated.
+Basically, without this, COMSIG_IN_RANGE_OF_IRRADIATION won't fire once the object is irradiated.
Trait granted by /mob/living/carbon/Initialize and
+granted/removed by /obj/item/organ/tongue
+Used for ensuring that carbons without tongues cannot taste anything
+so it is added in Initialize, and then removed when a tongue is inserted
+and readded when a tongue is removed.
This atom can ignore the "is on a turf" check for simple AI datum attacks, allowing them to attack from bags or lockers as long as any other conditions are met
Whether or not this item will allow the radiation SS to go through standard
+radiation processing as if this wasn't already irradiated.
+Basically, without this, COMSIG_IN_RANGE_OF_IRRADIATION won't fire once the object is irradiated.
Trait put on /mob/living/carbon/human. If that mob has a crystal core, also known as an ethereal heart, it will not try to revive them if the mob dies.
Their eyes glow an unnatural red colour. Currently used to set special examine text on humans. Does not guarantee the mob's eyes are coloured red, nor that there is any visible glow on their character sprite.
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
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.
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.
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
This circuit component has been marked as a component that has instant execution and will show up in the UI as so. This will only cause a visual change.
This circuit component has been marked as a component that has instant execution and will show up in the UI as so. This will only cause a visual change.
the cornerstone of the wound threshold system, your base wound roll for any attack is rand(1, damage^this), after armor reduces said damage. See [/obj/item/bodypart/proc/check_wounding]
If an attack rolls this high with their wound (including mods), we try to outright dismember the limb. Note 250 is high enough that with a perfect max roll of 145 (see max cons'd damage), you'd need +100 in mods to do this
the cornerstone of the wound threshold system, your base wound roll for any attack is rand(1, damage^this), after armor reduces said damage. See [/obj/item/bodypart/proc/check_wounding]
If an attack rolls this high with their wound (including mods), we try to outright dismember the limb. Note 250 is high enough that with a perfect max roll of 145 (see max cons'd damage), you'd need +100 in mods to do this
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)
Binary search sorted insert
+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.
Custom binary search sorted insert utilising comparison procs instead of vars.
+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 plaintext name of a proc on INPUT that takes a single argument to accept a single element from LIST and returns a positive, negative or zero number to perform a comparison.
+COMPTYPE: How should the values be compared? Either COMPARE_KEY or COMPARE_VALUE.
Even more custom binary search sorted insert, using defines instead of vars
+INPUT: Item to be inserted
+LIST: List to insert INPUT into
+TYPECONT: A define setting the var to the typepath of the contents of the list
+COMPARE: The item to compare against, usualy the same as INPUT
+COMPARISON: A define that takes an item to compare as input, and returns their comparable value
+COMPTYPE: How should the list be compared? Either COMPARE_KEY or COMPARE_VALUE.
Like typesof() or subtypesof(), but returns a typecache instead of a list.
+This time it also uses the associated values given by the input list for the values of the subtypes.
Picks a random element from a list based on a weighting system.
+For example, given the following list:
+A = 6, B = 3, C = 1, D = 0
+A would have a 60% chance of being picked,
+B would have a 30% chance of being picked,
+C would have a 10% chance of being picked,
+and D would have a 0% chance of being picked.
+You should only pass integers in.
Takes a list of numbers as input, returns the highest value that is cleanly divides them all
+Note: this implementation is expensive as heck for large numbers, I only use it because most of my usecase
+Is < 10 ints
Move a single element from position from_index within a list, to position to_index
+All elements in the range [1,to_index) before the move will be before the pivot afterwards
+All elements in the range [to_index, L.len+1) before the move will be after the pivot afterwards
+In other words, it's as if the range [from_index,to_index) have been rotated using a <<< operation common to other languages.
+from_index and to_index must be in the range [1,L.len+1]
+This will preserve associations ~Carnie
Move elements [from_index,from_index+len) to [to_index-len, to_index)
+Same as moveElement but for ranges of elements
+This will preserve associations ~Carnie
Move elements from [from_index, from_index+len) to [to_index, to_index+len)
+Move any elements being overwritten by the move to the now-empty elements, preserving order
+Note: if the two ranges overlap, only the destination order will be preserved fully, since some elements will be within both ranges ~Carnie
return first thing in L which has var/varname == value
+this is typecaste as list/L, but you could actually feed it an atom instead.
+completely safe to use
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
Converts a list into a list of assoc lists of the form ("key" = key, "value" = value)
+so that list keys that are themselves lists can be fully json-encoded
Returns a copy of a list where text values (except assoc-keys and string representations of lua-only values) are
+wrapped in quotes and existing quote marks are escaped,
+and nulls are replaced with the string "null"
Binary search sorted insert
+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.
Even more custom binary search sorted insert, using defines instead of vars
+INPUT: Item to be inserted
+LIST: List to insert INPUT into
+TYPECONT: A define setting the var to the typepath of the contents of the list
+COMPARE: The item to compare against, usualy the same as INPUT
+COMPARISON: A define that takes an item to compare as input, and returns their comparable value
+COMPTYPE: How should the list be compared? Either COMPARE_KEY or COMPARE_VALUE.
Custom binary search sorted insert utilising comparison procs instead of vars.
+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 plaintext name of a proc on INPUT that takes a single argument to accept a single element from LIST and returns a positive, negative or zero number to perform a comparison.
+COMPTYPE: How should the values be compared? Either COMPARE_KEY or COMPARE_VALUE.
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)
Writes to a special log file if the log_suspicious_login config flag is set,
+which is intended to contain all logins that failed under suspicious circumstances.
Step-towards method of determining whether one atom can see another. Similar to viewers()
+note: this is a line of sight algorithm, view() does not do any sort of raycasting and cannot be emulated by it accurately
Finds the distance between two atoms, in pixels
+centered = FALSE counts from turf edge to edge
+centered = TRUE counts from turf center to turf center
+of course mathematically this is just adding world.icon_size on again
Check if there is already a wall item on the turf loc
+floor_loc = floor tile in front of the wall
+dir_toward_wall = direction from the floor tile in front of the wall towards the wall
+check_external = truthy if we should be checking against items coming out of the wall, rather than visually on top of the wall.
Compare source's dir, the clockwise dir of source and the anticlockwise dir of source
+To the opposite dir of the dir returned by get_dir(target,source)
+If one of them is a match, then source is facing target
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.
Sends a round tip to a target. If selected_tip is null, a random tip will be sent instead (5% chance of it being silly).
+Tips that starts with the @ character won't be html encoded. That's necessary for any tip containing markup tags,
+just make sure they don't also have html characters like <, > and ' which will be garbled.
returns a GUID like identifier (using a mostly made up record format)
+guids are not on their own suitable for access or security tokens, as most of their bits are predictable.
+(But may make a nice salt to one)
A simpler version of get_flat_human_icon() that uses an existing human as a base to create the icon.
+Does not feature caching yet, since I could not think of a good way to cache them without having a possibility
+of using the cached version when we don't want to, so only use this proc if you just need this flat icon
+generated once and handle the caching yourself if you need to access that icon multiple times, or
+refactor this proc to feature caching of icons.
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
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)
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 ""
Center's an image.
+Requires:
+The Image
+The x dimension of the icon file used in the image
+The y dimension of the icon file used in the image
+eg: center_image(image_to_center, 32,32)
+eg2: center_image(image_to_center, 96,96)
Returns the euclidian square magnitude of a vector of either a list or variadic arguments: VecSquareMag(list(1, 2, 3)) = 14 , VecSquareMag(1, 2, 3) = 14
Converts RGB shorthands into RGBA matrices complete of constants rows (ergo a 20 keys list in byond).
+if return_identity_on_fail is true, stack_trace is called instead of CRASH, and an identity is returned.
Timed action involving at least one mob user and a list of targets. interaction_key is the assoc key under which the do_after is capped under, and the max interaction count is how many of this interaction you can do at once.
Gets the client of the mob, allowing for mocking of the client.
+You only need to use this if you know you're going to be mocking clients somewhere else.
Return a string for the specified body zone. Should be used for parsing non-instantiated bodyparts, otherwise use /obj/item/bodypart/var/plaintext_zone
Version of view() which ignores darkness, because BYOND doesn't have it (I actually suggested it but it was tagged redundant, BUT HEARERS IS A T- /rant).
Gets the client of the mob, allowing for mocking of the client.
+You only need to use this if you know you're going to be mocking clients somewhere else.
NAMEOF: Compile time checked variable name to string conversion
+evaluates to a string equal to "X", but compile errors if X isn't a var on datum.
+datum may be null, but it does need to be a typed var.
NAMEOF: Compile time checked variable name to string conversion
+evaluates to a string equal to "X", but compile errors if X isn't a var on datum.
+datum may be null, but it does need to be a typed var.
These are generally cheaper than looping contents so they go first
+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. Mind that diagonals
+cost the same as cardinal moves currently, so paths may look a bit strange, but should still be optimal.
Uses funny pass by reference bullshit to take the path created by pathfinding, and insert it into a return list
+We'll be able to use this return list to tell a sleeping proc to continue execution
Sends out a pulse of radiation, eminating from the source.
+Radiation is performed by collecting all radiatables within the max range (0 means source only, 1 means adjacent, etc),
+then makes their way towards them. A number, starting at 1, is multiplied
+by the insulation amounts of whatever is in the way (for example, walls lowering it down).
+If this number hits equal or below the threshold, then the target can no longer be irradiated.
+If the number is above the threshold, then the chance is the chance that the target will be irradiated.
+As a consumer, this means that max_range going up usually means you want to lower the threshold too,
+as well as the other way around.
+If max_range is high, but threshold is too high, then it usually won't reach the source at the max range in time.
+If max_range is low, but threshold is too low, then it basically guarantees everyone nearby, even if there's walls
+and such in the way, can be irradiated.
+You can also pass in a minimum exposure time. If this is set, then this radiation pulse
+will not irradiate the source unless they have been around any radioactive source for that
+period of time.
Gets the perceived "danger" of radiation pulse, given the threshold to the target.
+Returns a RADIATION_DANGER_* define, see code/__DEFINES/radiation.dm
Picks a string of symbols to display as the law number for hacked or ion laws
+is at the start to prevent us from changing say modes via get_message_mode()
\ref behaviour got changed in 512 so this is necesary to replicate old behaviour.
+If it ever becomes necesary to get a more performant REF(), this lies here in wait
+#define REF(thing) (thing && istype(thing, /datum) && (thing:datum_flags & DF_USE_TAG) && thing:tag ? "[thing:tag]" : "\ref[thing]")
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
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
Any floor or wall. What makes up the station and the rest of the map.
+If present, a turf above that is copying this turf. Implies a Z-connection and that the turf above is a z-mimic enabled turf.
+If present, the turf below that we are copying. Implies a Z-connection and that this is a z-mimic enabled turf.
+If we're a non-overwrite z-turf, this holds the appearance of the bottom-most Z-turf in the z-stack.
+Object used to multiply color of all OO overlays at once.
+If this is a delegate (non-overwrite) Z-turf with a z-turf above, this is the delegate copy that's copying us.
+If we're at the bottom of the stack, a proxy used to fake a below space turf.
+Cached computed depth, used in analyzer.
returns every hearaing movable in view to the turf of source not taking into account lighting
+useful when you need to maintain always being able to hear something if a sound is emitted from it and you can see it (and youre in range).
+otherwise this is just a more expensive version of get_hearers_in_LOS()
Returns a list of movable atoms that are hearing sensitive in view_radius and line of sight to source
+the majority of the work is passed off to the spatial grid if view_radius > 0
+because view() isnt a raycasting algorithm, this does not hold symmetry to it. something in view might not be hearable with this.
+if you want that use get_hearers_in_view() - however thats significantly more expensive
Returns a list with the names of the areas around a center at a certain distance
+Returns the local area if no distance is indicated
+Returns an empty list if the center is null
returns nothing with an alert instead of the message if it contains something in the ic filter, and sanitizes normally if the name is fine. It returns nothing so it backs out of the input the same way as if you had entered nothing.
Used to get a properly sanitized input, of max_length
+no_trim is self explanatory but it prevents the input from being trimed if you intend to parse newlines or whitespace.
This proc replaces all instances of the "replace" character in "text" with the character in the same position within the "compare" string
+"FFFFFFFFFFFFFFFFF***" and "FFFFFFFFFFFFFFF*****************FFFFFFFFFFFFFFFFFF"
+is "FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF"
Converts a time expressed in deciseconds (like world.time) to the 12-hour time format.
+the format arg is the format passed down to time2text() (e.g. "hh:mm" is hours and minutes but not seconds).
Returns the top-most atom sitting on the turf.
+For example, using this on a disk, which is in a bag, on a mob,
+will return the mob because it's on the turf.
Lets the turf this atom's ICON appears to inhabit
+it takes into account:
+Pixel_x/y
+Matrix x/y
+NOTE: if your atom has non-standard bounds then this proc
+will handle it, but:
+if the bounds are even, then there are an even amount of "middle" turfs, the one to the EAST, NORTH, or BOTH is picked
+this may seem bad, but you're atleast as close to the center of the atom as possible, better than byond's default loc being all the way off)
+if the bounds are odd, the true middle turf of the atom is returned
//////////////////// DEBUGGING & PROFILING
+By using the testing("message") proc you can create debug-feedback for people with this
+uncommented, but not visible in the release version)
+Enables the ability to cache datum vars and retrieve later for debugging which vars changed.
+If this is uncommented, will profile mapload atom initializations
+Enables debug messages for every single reaction step. This is 1 message per 0.5s for a SINGLE reaction.
+Useful for tracking down bugs/asking me for help in the main reaction handiler (equilibrium.dm).
+Requires TESTING to be defined to work
+If defined, we will compile with FULL timer debug info, rather then a limited scope
+Be warned, this increases timer creation cost by 5x
+If this is uncommented, force our verb processing into just the 2% of a tick
+We normally reserve for it
+NEVER run this on live, it's for simulating highpop only
+Uncomment this to force all verbs to run into overtime all of the time
+Essentially negating the reserve 2%
+Requires VERB_STRESS_TEST to be defined
+Uncomment this to enable a set of debugging verbs for client macros
+This ability is given to all clients, and I'm not going to bother vetting how safe this is.
+This will generate a compile warning.
+Uncomment this to wire the ruin budgets to zero. This prevents them spawning.
+Useful for measuring performance of specific systems with more reliability.
+Uncomment this to assert INSTANCES_OF() is running on valid lists.
+Uncomment this to enable debugging tools for map making.
+Set this value to FALSE to test job requirements working.
Force codex SQLite generation and loading despite being a debug server.
+//////////////////// REFERENCE TRACKING
+Used to find the sources of harddels, quite laggy, don't be surpised if it freezes your client for a good while
+Used for doing dry runs of the reference finder, to test for feature completeness
+Slightly slower, higher in memory. Just not optimal
+Requires REFERENCE_TRACKING to be defined
+Run a lookup on things hard deleting by default.
+If this is uncommented, we set up the ref tracker to be used in a live environment
+And to log events to [log_dir]/harddels.log
+//////////////////// UNIT TESTING
+//////////////////// AUTO WIKI
+If this is uncommented, Autowiki will generate edits and shut down the server.
+Prefer the autowiki build target instead.
+//////////////////// ZONE ATMOSPHERIC SYSTEM
+Enables verbose debugging and the debug overlay. NOTE: Debug Overlay does not report MultiZAS information at this time.
+Enables multi-Z air movement. Zones do not merge across Z levels.
//////////////////// DEBUGGING & PROFILING
+By using the testing("message") proc you can create debug-feedback for people with this
+uncommented, but not visible in the release version)
+Enables the ability to cache datum vars and retrieve later for debugging which vars changed.
+If this is uncommented, will profile mapload atom initializations
+Enables debug messages for every single reaction step. This is 1 message per 0.5s for a SINGLE reaction.
+Useful for tracking down bugs/asking me for help in the main reaction handiler (equilibrium.dm).
+Requires TESTING to be defined to work
+If defined, we will compile with FULL timer debug info, rather then a limited scope
+Be warned, this increases timer creation cost by 5x
+If this is uncommented, force our verb processing into just the 2% of a tick
+We normally reserve for it
+NEVER run this on live, it's for simulating highpop only
+Uncomment this to force all verbs to run into overtime all of the time
+Essentially negating the reserve 2%
+Requires VERB_STRESS_TEST to be defined
+Uncomment this to enable a set of debugging verbs for client macros
+This ability is given to all clients, and I'm not going to bother vetting how safe this is.
+This will generate a compile warning.
+Uncomment this to wire the ruin budgets to zero. This prevents them spawning.
+Useful for measuring performance of specific systems with more reliability.
+Uncomment this to assert INSTANCES_OF() is running on valid lists.
+Uncomment this to enable debugging tools for map making.
+Set this value to FALSE to test job requirements working.
Force codex SQLite generation and loading despite being a debug server.
+//////////////////// REFERENCE TRACKING
+Used to find the sources of harddels, quite laggy, don't be surpised if it freezes your client for a good while
+Used for doing dry runs of the reference finder, to test for feature completeness
+Slightly slower, higher in memory. Just not optimal
+Requires REFERENCE_TRACKING to be defined
+Run a lookup on things hard deleting by default.
+If this is uncommented, we set up the ref tracker to be used in a live environment
+And to log events to [log_dir]/harddels.log
+//////////////////// UNIT TESTING
+//////////////////// AUTO WIKI
+If this is uncommented, Autowiki will generate edits and shut down the server.
+Prefer the autowiki build target instead.
+//////////////////// ZONE ATMOSPHERIC SYSTEM
+Enables verbose debugging and the debug overlay. NOTE: Debug Overlay does not report MultiZAS information at this time.
+Enables multi-Z air movement. Zones do not merge across Z levels.
Gets cached recipes for a type. This is a method of optimizating recipe lookup. Ugly but gets the job done.
+also WARNING: This will make it so all recipes whose first step is not type checked will not work, which all recipes that I can think of will be.
+If you wish to remove this and GLOB.slapcraft_firststep_recipe_cache should this cause issues, replace the return with GLOB.slapcraft_recipes
Creates a regular expression to match against the given phobia
+Capture group 2 = the scary word
+Capture group 3 = an optional suffix on the scary word
Distance in pixels that we consider "acceptable" from the initial click to the release
+Note: this does not account for the position of the object, just where it is on the screen
Distance in pixels that we consider "acceptable" from the initial click to the release
+Note: this does not account for the position of the object, just where it is on the screen
This part of the guide will assume that you have read the byond reference entry for rendering at www.byond.com/docs/ref//#/{notes}/renderer
+
When you create an atom, this will always create an internal byond structure called an "appearance". This appearance you will likely be familiar with, as it is exposed through the /atom/var/appearance var. This appearance var holds data on how to render the object, ie what icon/icon_state/color etc it is using. Note that appearance vars will always copy, and do not hold a reference. When you update a var, for example lets pretend we add a filter, the appearance will be updated to include the filter. Note that, however, vis_contents objets are uniquely excluded from appearances. Then, when the filter is updated, the appearance will be recreated, and the atom marked as "dirty". After it has been updated, the SendMaps() function (sometimes also called maptick), which is a internal byond function that iterates over all objects in a clients view and in the clients.mob.contents, checks for "dirty" atoms, then resends any "dirty" appearances to clients as needed and unmarks them as dirty. This function is notoriosly slow, but we can see it's tick usage through the world.map_cpu var. We can also avoid more complex checks checking whether an object is visible on a clients screen by using the TILE_BOUND appearance flag.
+
Finally, we arrive at clientside behavior, where we have two main clientside functions: GetMapIcons, and Render. GetMapIcons is repsonsible for actual rendering calculations on the clientside, such as "Group Icons and Set bounds", which performs clientside calculations for transform matrixes. Note that particles here are handled in a separate thread and are not diplayed in the clientside profiler. Render handles the actual drawing of the screen.
+
For debugging rendering issues its reccomended you do two things:
+A) Talk to someone who has inside knowledge(like lummox) about it, most of this is undocumented and bugs often
+B) Use the undocumented debug printer which reads of data on icons rendering, this is very dense but can be useful in some cases. To use: Right click top tab -> Options & Messages -> Client -> Command -> Enter ".debug profile mapicons" and press Enter -> go to your Byond directory and find BYOND/cfg/mapicons.json . Yes this is one giant one-line json.
+Known internal snowflake
+
The following is an incomplete list of pitfalls that come from byond snowflake that are known, this list is obviously incomplete.
+
+
Transforms are very slow on clientside. This is not usually noticable, but if you start using large amounts of them it will grind you to a halt quickly, regardless of whether its on overlays or objs
+
The darkness plane. The darkness plane has specific variables it needs to render correctly, and these can be found in the plane masters file. it is composed internally of two parts, a black mask over the clients screen, and a non rendering mask that blocks all luminosity=0 turfs and their contents from rendering if the SEE_BLACKNESS flag is set properly. It behaves very oddly, such as forcing itself to ALWAYS render or pre-render on blend_multiply blend mode or refusing to render the black mask properly otherwise. The blocker will always block rendering but the mask can be layered under other objects.
+
render_target/source. Render_target/source will only copy certain rendering instructions, and these are only defined as "etc." in the byond reference. Known non copied appearance vars include: blend_mode, plane, layer, vis_contents, mouse_opacity...
+
Large icons on the screen that peek over the edge will instead of only rendering partly like you would expect will instead stretch the screen while not adgusting the render buffer, which means that you can actively see as tiles and map objects are rendered. You can use this for an easy "offscreen" UI.
+
Numerically large filters on objects of any size will torpedo performance, even though large objects with small filters will perform massively better. (ie blur(size=20) BAD)
+
Texture Atlas: the texture atlas byond uses to render icons is very susceptible to corruption and can regularily replace icons with other icons or just not render at all. This can be exasperated by alt tabbing or pausing the dreamseeker process.
+
The renderer is awful code and lummox said he will try changing a large part of it for 515 so keep an eye on that
+
Byond uses DirectX 9 (Lummox said he wants to update to DirectX 11)
+
Particles are just fancy overlays and are not independent of their owner
+
Maptick items inside mob.contents are cheaper compared to most other movables
+
Displacement filter: The byond "displacement filter" does not, as the name would make you expect, use displacement maps, but instead uses normal maps.
+
+The rendering solution
+
One of the main issues with making pretty effects is how objects can only render to one plane, and how filters can only be applied to single objects. Quite simply it means we cant apply effects to multiple planes at once, and an effect to one plane only by treating it as a single unit:
+
+
A semi-fix to stop from having to apply effects to every single plane is to use the render controllers, to automatically apply filters and colors automatically onto their controlled planes.
+
The solution is thus instead we replace plane masters rendering directly to client with planes that render multiple planes onto them as objects in order to be able to affect multiple planes while treating them as a single object. This is done by relaying the plane using a "render relay" onto a "render plate" which acts as a plane master of plane masters of sorts, and since planes are rendered onto it as single objects any filters we apply to them will render over the planes, treating them as a single unit.
+
+
We can also choose to render these by decreasing the scaling all applied effects (effect_size/number_of_plates_rendered_to) then rendering it onto multiple planes:
+
+
Through these this allows us to treat planes as single objects, and lets us distort them as a single unit, most notably works wonders with the displacement filter. Specifically, here you can displacement_filter a plane onto a plate, which then will treat all the other planes rendered on that plate as a single unit.
+Render plates
+
The rendering system uses two objects to unify planes: render_relay and render_plates. Render relays use render_target/source and the relay_render_to_plane proc to replicate the plane master on the render relay. This render relay is then rendered onto a render_plate, which is a plane master that renders the render_relays onto itself. This plate can then be hierachically rendered with the same process until it reaches the master render_plate, which is the plate that will actually render to the player. These plates naturally in the byond style have quirks. For example, rendering to two plates will double any effects such as color or filters, and as such you need to carefully manage how you render them. Keep in mind as well that when sorting the layers for rendering on a plane that they should not be negative, this is handled automatically in relay_render_to_plane. When debugging note that mouse_opacity can act bizzarly with this method, such as only allowing you to click things that are layered over objects on a certain plane but auomatically setting the mouse_opacity should be handling this. Note that if you decide to manipulate a plane with internal byond objects that you will have to manually extrapolate the vars that are set if you want to render them to another plane (See blackness plane for example), and that this is not documented anywhere.
+
Goodluck and godspeed with coding
+- Just another contributor
Plane master handling byond internal blackness
+vars are set as to replicate behavior when rendering to other planes
+do not touch this unless you know what you are doing
This system works by exploiting BYONDs color matrix filter to use layers to handle emissive blockers.
+
Emissive overlays are pasted with an atom color that converts them to be entirely some specific color.
+Emissive blockers are pasted with an atom color that converts them to be entirely some different color.
+Emissive overlays and emissive blockers are put onto the same plane.
+The layers for the emissive overlays and emissive blockers cause them to mask eachother similar to normal BYOND objects.
+A color matrix filter is applied to the emissive plane to mask out anything that isn't whatever the emissive color is.
+This is then used to alpha mask the lighting plane.
Custom rendering solution to allow for advanced effects
+We (ab)use plane masters and render source/target to cheaply render 2+ planes as 1
+if you want to read more read the _render_readme.md
Start of queue linked list
+End of queue linked list (used for appending to the list)
+Are we loading in a new map?
+for scheduling different subsystems for different stages of the round
Allows us to lazyload asset datums
+Anything inserted here will fully load if directly gotten
+So this just serves to remove the requirement to load assets fully during init
Initializes any assets that need to be loaded ASAP.
+This houses preference menu assets, since they can be loaded at any time,
+most dangerously before the atoms SS initializes.
+Thus, we want it to fail consistently in CI as if it would've if a player
+opened it up early.
In order to debug qdel() failures, there are several tools available.
+To enable these tools, define TESTING in _compile_options.dm.
+
First is a verb called "Find References", which lists every refererence to an object in the world. This allows you to track down any indirect or obfuscated references that you might have missed.
+
Complementing this is another verb, "qdel() then Find References".
+This does exactly what you'd expect; it calls qdel() on the object and then it finds all references remaining.
+This is great, because it means that Destroy() will have been called before it starts to find references,
+so the only references you'll find will be the ones preventing the object from qdel()ing gracefully.
+
If you have a datum or something you are not destroying directly (say via the singulo),
+the next tool is QDEL_HINT_FINDREFERENCE. You can return this in Destroy() (where you would normally return ..()),
+to print a list of references once it enters the GC queue.
+
Finally is a verb, "Show qdel() Log", which shows the deletion log that the garbage subsystem keeps. This is helpful if you are having race conditions or need to review the order of deletions.
+
Note that for any of these tools to work TESTING must be defined.
+By using these methods of finding references, you can make your life far, far easier when dealing with qdel() failures.
Qdel Item: Holds statistics on each type that passes thru qdel
+Holds the type as a string for this type
+Total number of times it's passed thru qdel.
+Total amount of milliseconds spent processing this type's Destroy()
+Times it was queued for soft deletion but failed to soft delete.
+Different from failures because it also includes QDEL_HINT_HARDDEL deletions
+Total amount of milliseconds spent hard deleting this type.
+Highest time spent hard_deleting this in ms.
+Number of times hard deletes took longer than the configured threshold
+Number of times it's not respected force=TRUE
+Number of times it's not even bother to give a qdel hint
+Number of times it's slept in its destroy
+Flags related to this type's trip thru qdel.
+
Lazylist of string metadata about the deleted objects
Subsystem exists so we can separately log init time costs from the costs of general operation
+Hopefully this makes sorting out what causes problems when easier
How material datums work
+Materials are now instanced datums, with an associative list of them being kept in SSmaterials. We only instance the materials once and then re-use these instances for everything.
+
These materials call on_applied() on whatever item they are applied to, common effects are adding components, changing color and changing description. This allows us to differentiate items based on the material they are made out of.area
This isn't actually the same as walk_rand
+Because walk_rand is really more like walk_to_rand
+It appears to pick a spot outside of range, and move towards it, then pick a new spot, etc.
+I can't actually replicate this on our side, because of how bad our pathfinding is, and cause I'm not totally sure I know what it's doing.
+I can just implement a random-walk though
Disposal holders need to move through a chain of pipes
+Rather then through the world. This supports this
+If this ever changes, get rid of this, add drift component like logic to the holder
+And move them to move()
Converts an overlay list into text for debug printing
+Of note: overlays aren't actually mutable appearances, they're just appearances
+Don't have access to that type tho, so this is the best you're gonna get
We get our awareness updated by the important recursive contents stuff, here we remove our membership
+We get our awareness updated by the important recursive contents stuff, here we remove our membership
How many turfs to allow before we start freeing up existing "soft reserved" transit docks
+If we're under load we want to allow for cycling, but if not we want to preserve already generated docks for use
How many turfs to allow before we start freeing up existing "soft reserved" transit docks
+If we're under load we want to allow for cycling, but if not we want to preserve already generated docks for use
used by /datum/controller/subsystem/spatial_grid to cover every z level so that the coordinates of every turf in the world corresponds to one of these in
+the subsystems list of grid cells by z level. each one of these contains content lists holding all atoms meeting a certain criteria that is in our borders.
+these datums shouldnt have significant behavior, they should just hold data. the lists are filled and emptied by the subsystem.
the right or upper side index of a box composed of spatial grid cells with the given center x or y coordinate.
+outputted value cant exceed the number of cells on that axis
the right or upper side index of a box composed of spatial grid cells with the given center x or y coordinate.
+outputted value cant exceed the number of cells on that axis
the next unallocated /mob/oranges_ear that we try to allocate to assigned_atom's turf
+the next atom in atoms_that_need_ears an ear assigned to it
+the turf loc of the current assigned_atom. turfs are used to track oranges_ears already assigned to one location so we dont allocate more than one
+because allocating more than one oranges_ear to a given loc wastes view iterations
+verb_manager subsystem just for handling say's
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
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.
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.
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.
This subsystem strives to make loading large amounts of select objects as smooth at execution as possible
+It preloads a set of types to store, and caches them until requested
+Doesn't catch everything mind, this is intentional. There's many types that expect to either
+A: Not sit in a list for 2 hours, or B: have extra context passed into them, or for their parent to be their location
+You should absolutely not spam this system, it will break things in new and wonderful ways
+S close enough for government work though.
+Fuck you goonstation
Our AI controller system is an attempt at making it possible to create modularized AI that stores its behavior in datums, while keeping state and decision making in a controller. This allows a more versatile way of creating AI that doesn't rely on OOP as much, and doesn't clutter up the Life() code in Mobs.
+AI Controllers
+
A datum that can be added to any atom in the game. Similarly to components, they might only support a given subtype (e.g. /mob/living), but the idea is that theoretically, you could apply a specific AI controller to a big a group of different types as possible and it would still work.
+
These datums handle both the normal movement of mobs, but also their decision making, deciding which actions they will take based on the checks you put into their SelectBehaviors proc.
+
If behaviors are selected, and the AI is in range, it will try to perform them. It runs all the behaviors it currently has in parallel; allowing for it to for example screech at someone while trying to attack them. Aslong as it has behaviors running, it will not try to generate new plans, making it not waste CPU when it already has an active goal.
+
They also hold data for any of the actions they might need to use, such as cooldowns, whether or not they're currently fighting, etcetera this is stored in the blackboard, more information on that below.
+Blackboard
+
The blackboard is an associated list keyed with strings and with values of whatever you want. These store information the mob has such as "Am I attacking someone", "Do I have a weapon". By using an associated list like this, no data needs to be stored on the actions themselves, and you could make actions that work on multiple ai controllers if you so pleased by making the key to use a variable.
+AI Behavior
+
AI behaviors are the actions an AI can take. These can range from "Do an emote" to "Attack this target until he is dead". They are singletons and should contain nothing but static data. Any dynamic data should be stored in the blackboard, to allow different controllers to use the same behaviors.
+Guides:
+
Making Your AI: Quickly runs through how to make an ai controller for anything with a step by step development of one.
A subtree is attached to a controller and is occasionally called by /ai_controller/SelectBehaviors(), this mainly exists to act as a way to subtype and modify SelectBehaviors() without needing to subtype the ai controller itself
Haunted AI tries to not be interacted with, and will attack people who do.
+Cursed AI instead tries to be interacted with, and will attempt to equip itself onto people.
+Added by /datum/element/cursed, and as such will try to remove this element and go dormant when it finds a victim to curse
This is a step by step guide for making an AI Controller for your atom. It teaches the basics of each part of an AI Controller so the target for this guide is someone who doesn't know anything about Controllers and wants to hop in.
+Note on examples used
+
At the moment the quality of ai datums has some dubious code lying all around, and I wanted to show the best examples. So while I walk through this with the basic cow ai as an example, I do swap to other datums involving items, generic instrument planning, and some other stuff to help explain singular concepts. I make it clear later in the guide when I'm getting back to following along with filling out the cow ai, so watch out for that.
+Starting out
+
We're simply starting out with our definition of what we're modifying. Any atom can have an ai controller.
+
/mob/living/basic/cow
+ name = "cow"
+ desc = "Known for their milk, just don't tip them over."
+
+Initial AI Controller Definition
+
Next, we'll want to define the AI Controller. This is the "brain" of the AI. It starts as a type, but is turned into an instance once the object is instanced.
+Object Declaraction
+
For clarity, i've included all the variables we're going to set up but haven't yet as nulls. In reality, some of these are always expected to be something and you should take a look at the base controller for which.
+
/mob/living/basic/cow
+ name = "cow"
+ desc = "Known for their milk, just don't tip them over."
+
+ ai_controller = /datum/ai_controller/basic_controller/cow
+
+/datum/ai_controller/basic_controller/cow
+ blackboard = list()
+
+ ai_traits = null
+ ai_movement = null
+ idle_behavior = null
+ planning_subtrees = list()
+
+
+AI Movement & Idle Behavior
+
AI Movement is a datum that decides how the AI you're making pathfinds. This has to at least be set to dumb movement, it cannot be null. We're making a basic mob, so we're just going to go inbetween complex and simple pathfinding with the basic_avoidance type.
Idle Behavior is very similar, datum that decides what the AI should do when it decides it doesn't need to do anything (No planned behaviors, we'll walk through that later). Cows having some idle movement sounds nice, so we're going to pick that.
AI traits are flags you can set to modify generic idle and movement behavior. In this case, we want farm animals to be able to be coralled, so we're going to add the STOP_MOVING_WHEN_PULLED flag.
The blackboard is the variables of the ai controller. They are set up by the subtrees that use them, or are defaults set by the ai controller that the subtrees read. As we don't have our subtrees set up, we don't know what the blackboard should have! We're going to come back to this.
+Subtrees
+
So we have all the fundamentals of the cow set in stone, but we do not have the actual behaviors that make cows... act like cows! We introduce these through subtrees. They're singletons that ai controllers hold references to that plan out each step of how an AI should act, loading up behaviors.
This subtree takes a blackboard named BB_ITEM_TARGET, the target of the item set by other subtrees, and if that exists alongside a probability to aggro, the subtree queues the behavior to attack that mob.
+
So, neat. When you have a target, queue an attack. This item attack subtree is pretty basic, but a more complicated one may queue different attacks depending on the target. How does this fit into the subtrees?
+
Let's look where it's used, specifically in the subtrees variable:
+
/datum/ai_controller/haunted
+ planning_subtrees = list(
+ ///this applies aggro for picking up the item
+ /datum/ai_planning_subtree/item_ghost_resist,
+ ///this picks targets from the aggro list
+ /datum/ai_planning_subtree/item_target_from_aggro_list,
+ ///this uses the target to attack.
+ /datum/ai_planning_subtree/item_throw_attack,
+ )
+
+
As you can see the subtrees go top to bottom on their processing. SUBTREE_RETURN_FINISH_PLANNING will prematurely end the subtrees, so we can be sure the ai will focus on the behaviors planned so far in a "priority list" kind of way.
+
Let's visualize this in a case where the subtrees should stop prematurely!
+
/datum/ai_controller/haunted
+ planning_subtrees = list(
+ ///someone is currently holding the item,
+ ///preventing it from attacking!
+ ///resist and end planning.
+ /datum/ai_planning_subtree/item_ghost_resist,
+ ///this does not fire this time around
+ /datum/ai_planning_subtree/item_target_from_aggro_list,
+ ///this does not fire this time around
+ /datum/ai_planning_subtree/item_throw_attack,
+ )
+
+Subtree Setup
+
Subtrees also have procs for when the mob first starts using them and when they stop. You can use this to make subtrees "react" to events via signals, and this is where we set defaults for blackboards if necessary (we want lists to be empty, not null!)
Do not set blackboards on the subtree! Subtrees are there to sort and optimize behavior selection, putting logic for setting blackboards is essentially skipping a behavior. I'm putting this here because unfortunately a lot of our current ai datum code has this exact mistake, and I'm hoping we can move on from it!
As you can see we're putting the search behavior... on a behavior! and since the planning subtree passes to other subtrees afterwards, the monkey will still find things to do. The next pass, if the search behavior was successful the action can be completed.
+Behaviors for subtrees
+
Finally, we've reached the final stop on this controller rabbit hole: Behaviors! These are what subtrees are planning, and the AI will do these from first planned all the way to the end, just like it runs through subtrees.
+
As before, let's take a look at a basic example of one:
This behavior makes the ai move to one tile away and finish the action, only finishing the action if the target is dead (success) or out of range (fail). When the action finishes, the follow target is unset by finish_action() regardless of success. Nice!
+
The last important thing to know is that behaviors take the keys from subtree planning as arguments. They do not search for the blackboards they need themselves.
+
BAD:
+
/datum/ai_behavior/play_instrument
+
+/datum/ai_behavior/play_instrument/perform(delta_time, datum/ai_controller/controller)
+ . = ..()
+
+ //bzzt! using blackboard keys directly! let the subtree pass this in!
+ var/datum/song/song = controller.blackboard[BB_SONG_DATUM]
+
+ song.start_playing(controller.pawn)
+ finish_action(controller, TRUE)
+
+
GOOD:
+
/datum/ai_behavior/play_instrument
+
+/datum/ai_behavior/play_instrument/perform(delta_time, datum/ai_controller/controller, song_datum_key)
+ . = ..()
+
+ var/datum/song/song = controller.blackboard[song_datum_key]
+
+ song.start_playing(controller.pawn)
+ finish_action(controller, TRUE) //NOTE: you may forget, but this doesn't end the proc! return after it if you have code later
+
+"Okay, back to what we were doing!"
+
Wow, what a tangent! But it's important to understand subtree planning as it is the core of our AI. We have a subtree for the cows to occasionally make sounds, which can be interrupted by the tipping subtree (since cows can be tipped!) The Blackboard stays empty for our cows, since the tipped subtree does not have any blackboards it needs to read that could change per-ai controller. The Tipping blackboards are handled by the subtree's setup.
And... we're finished! The tip_reaction subtree hooks into signals and runs behaviors when the cow is tipped, the random speech occasionally plans speech, the idle behavior runs when no behaviors are planned, and the cow acts like a cow! We used a mob in this case because everyone knows how a cow works as it's a very simple creature, but AI Controllers work on anything! It's just as valid of a use case to make, say, the staff of animation apply AI Controllers to items.
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 SendSignal() call. Now every component that want's to can also know about this happening.
/datum/component/mycomponent
+ //can_transfer = TRUE // Must have PostTransfer
+ //dupe_mode = COMPONENT_DUPE_ALLOWED // code/__DEFINES/dcs/flags.dm
+ var/myvar
+
+/datum/component/mycomponent/Initialize(myargone, myargtwo)
+ if(myargone)
+ myvar = myargone
+ if(myargtwo)
+ send_to_playing_players(myargtwo)
+
+/datum/component/mycomponent/RegisterWithParent()
+ RegisterSignal(parent, COMSIG_NOT_REAL, PROC_REF(signalproc)) // RegisterSignal can take a signal name by itself,
+ RegisterSignal(parent, list(COMSIG_NOT_REAL_EITHER, COMSIG_ALMOST_REAL), PROC_REF(otherproc)) // or a list of them to assign to the same proc
+
+/datum/component/mycomponent/UnregisterFromParent()
+ UnregisterSignal(parent, COMSIG_NOT_REAL) // UnregisterSignal has similar behavior
+ UnregisterSignal(parent, list( // But you can just include all registered signals in one call
+ COMSIG_NOT_REAL,
+ COMSIG_NOT_REAL_EITHER,
+ COMSIG_ALMOST_REAL,
+ ))
+
+/datum/component/mycomponent/proc/signalproc(datum/source)
+ SIGNAL_HANDLER
+ send_to_playing_players("[source] signaled [src]!")
+
+/*
+/datum/component/mycomponent/InheritComponent(datum/component/mycomponent/old, i_am_original, list/arguments)
+ myvar = old.myvar
+
+ if(i_am_original)
+ send_to_playing_players("No parent should have to bury their child")
+*/
+
+/*
+/datum/component/mycomponent/PreTransfer()
+ send_to_playing_players("Goodbye [parent], I'm getting adopted")
+
+/datum/component/mycomponent/PostTransfer()
+ send_to_playing_players("Hello my new parent, [parent]! It's nice to meet you!")
+*/
+
+/*
+/datum/component/mycomponent/CheckDupeComponent(datum/mycomponent/new, myargone, myargtwo)
+ if(myargone == myvar)
+ return TRUE
+*/
+
Component for atmos-related atoms to be able to record and transmit their reaction_results data
+Use this ONLY for atoms, gasmixtures will be accessed by calling return air on the object.
+Add this component after gasmixes has been initialized.
Applies healing to those in the area.
+Will provide them with an alert while they're in range, as well as
+give them a healing particle.
+Can be applied to those only with a trait conditionally.
Component for clothing items that can pick up blood from decals and spread it around everywhere when walking, such as shoes or suits with integrated shoes.
If an ojvect 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.
This component adds a near-invisible underlay to a movable target to expand the clickable surface of its icon without
+resorting to MOUSE_OPACITY_OPAQUE.
+The underlay ignores the parent's color and alpha and can be offset.
+The name is a portmanteau of "click" and "hitbox", because technically this isn't an hitbox,
+but it helps catch clicks, and I don't want to give it a loooong name like openspace_item_click_handler
This component behaves similar to connect_loc, hooking into a signal on a tracked object's turf
+It has the ability to react to that signal on behalf of a separate listener however
+This has great use, primarily for components, but it carries with it some overhead
+So we do it separately as it needs to hold state which is very likely to lead to bugs if it remains as an element.
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
This component behaves similar to connect_loc_behalf but for all turfs in range, hooking into a signal on each of them.
+Just like connect_loc_behalf, It can react to that signal on behalf of a seperate listener.
+Good for components, though it carries some overhead. Can't be an element as that may lead to bugs.
Manages the loop caused by being on a conveyor belt
+Prevents movement while you're floating, etc
+Takes the direction to move, delay between steps, and time before starting to move as arguments
Component that handles drifting
+Manages a movement loop that actually does the legwork of moving someone
+Alongside dealing with the post movement input blocking required to make things look nice
Component that manages how many eggs to lay, what can be fed to the mob to make them lay more, and what is actually laid.
+Since the only real interaction with the component is an attackby, the nice part is that we're able to make this an atom level proc.
+egg_layer will loudly fail if you do not provide it the arguments, as to encourage explicicy(?)
attach it to any atom/movable that can be buckled to in order to have it shock mobs buckled to it. by default it shocks mobs buckled to parent every shock_loop_time.
+the parent is supposed to define its behavior with arguments in AddComponent
Component specifically for explosion sensetive things, currently only applies to heat based explosions but can later perhaps be used for things that are dangerous to handle carelessly like nitroglycerin.
This component makes it possible to make things edible. What this means is that you can take a bite or force someone to take a bite (in the case of items).
+These items take a specific time to eat, and can do most of the things our original food items could.
+
Behavior that's still missing from this component that original food items had that should either be put into separate components or somewhere else:
+Components:
+Drying component (jerky etc)
+Processable component (Slicing and cooking behavior essentialy, making it go from item A to B when conditions are met.)
+
Misc:
+Something for cakes (You can store things inside)
+
--Food storage component--
+This component lets you slide one item into large foods, such as bread, cheese wheels, or cakes.
+Consuming food storages with an item inside can cause unique interactions, such as eating glass shards.
Forced directional movement, but with a twist
+Let's block pressure and client movements while doing it so we can't be interrupted
+Supports spinning on each move, for lube related reasons
Genetic damage, given by DNA consoles, will start to deal toxin damage
+past a certain threshold, and will go down consistently.
+Adding multiple of this component will increase the total damage.
+Can turn monkeys into gorillas.
This is a relatively simple component that attempts to deter the parent of the component away
+from a specific area or areas. By default it simply applies a penalty where all movement is
+four times slower than usual and any action that would affect your 'next move' has a penalty
+multiplier of 4 attached.
This datum should be used for handling mineral contents of machines and whatever else is supposed to hold minerals and make use of them.
+
Variables:
+amount - raw amount of the mineral this container is holding, calculated by the defined value MINERAL_MATERIAL_AMOUNT=2000.
+max_amount - max raw amount of mineral this container can hold.
+sheet_type - type of the mineral sheet the container handles, used for output.
+parent - object that this container is being used by, used for output.
+MAX_STACK_SIZE - size of a stack of mineral sheets. Constant.
A component that handles linking multiple player's minds
+into one network which allows them to talk directly to one another.
+Like telepathy but for multiple people at once!
A simple component that spawns a mob of the same type and transfers itself to it when parent dies.
+For more complex behaviors, use the COMSIG_ON_MULTIPLE_LIVES_RESPAWN comsig.
A component that stores colors for use by painting-related items like spraycans or palettes
+which can be accessed through a radial menu by right clicking the item while it's held by the user mob.
+Right-clicking a color will open a color input prompt to edit it. Left clicking will instead select it
+and call set_painting_tool_color() on the parent for more specific object behavior.
Begins the countdown before a target can be irradiated.
+Added by the radiation subsystem when a pulse information has a minimum exposure time.
+Will clear itself out after a while.
Allows the parent to act similarly to the Altar of Gods with modularity. Invoke and Sect Selection is done via attacking with a bible. This means you cannot sacrifice Bibles (you shouldn't want to do this anyways although now that I mentioned it you probably will want to).
subtype picker component allows for an item to transform into its subtypes (this is not enforced and you can turn in whatever types, but
+i used this name as it was incredibly accurate for current usage of the behavior)
Abstract item that is held in nullspace and manages reagents. Created by udder component.
+While perhaps reagents created by udder component COULD be managed in the mob, it would be somewhat finnicky and I actually like the abstract udders.
bespoke element that picks an suffix to append onto the icon state from a list given on creation, among some pixel shifting stuff
+basically you will see VARIETY in a batch of simplemobs.
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
+Leaving something at 0 means it's off - has no maximum.
+This damage is taken when atmos doesn't fit all the requirements above.
When attached to a gun and the gun is successfully fired, this element creates a "backblast" of fire and pain, like you'd find in a rocket launcher or recoilless rifle
Beauty element. It makes the indoor area the parent is in prettier or uglier depending on the beauty var value.
+Clean and well decorated areas lead to positive moodlets for passerbies;
+Shabbier, dirtier ones lead to negative moodlets EXCLUSIVE to characters with the snob quirk.
Bespoke element that sends a harrowing message when you first pick up an item, applying a spooky color outline and renaming the item.
+For most items, it will announce when picked up. If the item can be equipped, though, it will only announce when the item is worn.
+Possible improvements for the future: add an option to allow the cursed affix to be a prefix. right now only coded for suffixes
bespoke element (1 per set of specific arguments in existence) that makes crates unable to be sold UNTIL they are opened once (to where this element, and the block, are removed)
+Used for non-cargo orders to not get turned into a quick buck
+
for the future coders or just me: please convert this into a component to allow for more feedback on the crate's status (clicking when unlocked, overlays, etc)
Mobs and items with this element will knock movable targets they hit away from them.
+Guns and turrets will instead fire projectiles with similar effects.
Heals the user (if attached to an item) or the mob itself (if attached to a hostile simple mob)
+by a flat amount whenever a successful attack is performed against another living mob.
An element that enables and disables movetype bitflags whenever the relative traits are added or removed.
+It also handles the +2/-2 pixel y anim loop typical of mobs possessing the FLYING or FLOATING movetypes.
+This element is necessary for the TRAIT_MOVE_ traits to work correctly, so make sure to attach this element
+before adding them to non-living movables.
allow players to easily use items such as iron rods, rcds on open space without
+having to pixelhunt for portions not occupied by object or mob visuals.
Bespoke element that plays a fun message, sends a heart out, and gives a stronger mood bonus when you pet this animal.
+I may have been able to make this work for carbons, but it would have been interjecting on some help mode interactions anyways.
-- Plant backfire element --
+Certain high-danger plants, like death-nettles, will backfire and harm the holder if they're not properly protected.
+If a user is protected with something like leather gloves, they can handle them normally.
+If they're not protected properly, we invoke a callback on the user, harming or inconveniencing them.
Marks the item as being radiation protected.
+Adds the TRAIT_RADIATION_PROTECTED_CLOTHING trait, as well as adding an
+extra bit to the examine descrpition.
This element is used to indicate that a movable atom can be mounted by mobs in order to ride it. The movable is considered mounted when a mob is buckled to it,
+at which point a riding component is created on the movable, and that component handles the actual riding behavior.
Adding this element to an atom will have it automatically render an overlay.
+The overlay can be specified in new as the first paramter; if not set it defaults to rust_overlay's rust_default
Contextual screentips (and when to not use this folder)
+
+
+
+
+
Contextual screentips provide information in the form of text at the top of your screen to inform you of the possibilities of an item. The "contextual" here refers to this being handled entirely through code, what it displays and when is completely up to you.
+The elements (and this folder)
+
This folder provides several useful shortcuts to be able to handle 95% of situations.
+/datum/element/contextual_screentip_bare_hands
+
This element is used to display screentips when the user hovers over the object with nothing in their active hand.
+
It takes parameters in the form of both non-combat mode and, optionally, combat mode.
This will display "LMB: Turn on | RMB: Turn off" when the user hovers over a fire alarm with an empty active hand.
+/datum/element/contextual_screentip_tools
+
This element takes a map of tool behaviors to context lists. These will be displayed when the user hovers over the object with an item that has the tool behavior.
This will display "LMB: Craft bola" when the user hovers over cable restraints with metal in their hand.
+The basic system (and when to not use this folder)
+
The basic system acknowledges the following two interactions:
+Self-defining items (Type A)
+
These are items that are defined by their behavior. These should define their contextual text within themselves, and not in their targets.
+
+
Stun batons (LMB to stun, RMB to harm)
+
Syringes (LMB to inject, RMB to draw)
+
Health analyzers (LMB to scan for health/wounds [another piece of context], RMB to scans for chemicals)
+
+Receiving action defining objects (Type B)
+
These are objects (not necessarily items) that are defined by what happens to them. These should define their contextual text within themselves, and not in their operating tools.
+
+
Tables (RMB with wrench to deconstruct)
+
Construction objects (LMB with glass to put in screen for computers)
+
Carbon copies (RMB to take a copy)
+
+
+
Both of these are supported, and can be hooked to through several means.
+
Note that you must return CONTEXTUAL_SCREENTIP_SET if you change the contextual screentip at all, otherwise you may not see it.
+COMSIG_ITEM_REQUESTING_CONTEXT_FOR_TARGET
+
This signal is registered on items, and receives the hovering object, provided in the form of obj/item/source, list/context, atom/target, mob/living/user.
+/atom/proc/register_item_context(), and /atom/proc/add_item_context()
+
/atom/proc/add_item_context() is a proc intended to be overridden to easily create Type-B interactions (ones where atoms are hovered over by items). It receives the exact same arguments as COMSIG_ITEM_REQUESTING_CONTEXT_FOR_TARGET: obj/item/source, list/context, atom/target, mob/living/user.
+
In order for your add_item_context() method to be run, you must call register_item_context().
+COMSIG_ATOM_REQUESTING_CONTEXT_FROM_ITEM
+
This signal is registered on atoms, and receives what the user is hovering with, provided in the form of atom/source, list/context, obj/item/held_item, mob/living/user.
+/atom/proc/register_context(), and /atom/proc/add_context()
+
/atom/proc/add_context() is a proc intended to be overridden to easily create Type-B interactions (ones where atoms are hovered over by items). It receives the exact same arguments as COMSIG_ATOM_REQUESTING_CONTEXT_FROM_ITEM: atom/source, list/context, obj/item/held_item, mob/living/user.
+
In order for your add_context() method to be run, you must call register_context().
+
+
When using any of these methods, you will receive a mutable context list.
+Context lists
+
Context lists are lists with keys mapping from SCREENTIP_CONTEXT_* to a string. You can find these keys in code/__DEFINES/screentips.dm.
+
The signals and add_context() variants mutate the list directly, while shortcut elements will just have you pass them in directly.
Apply basic contextual screentips when the user hovers over this item with an empty hand.
+A "Type B" interaction.
+This stacks with other contextual screentip elements, though you may want to register the signal/flag manually at that point for performance.
Apply basic contextual screentips when the user hovers over this item with a provided item.
+A "Type B" interaction.
+This stacks with other contextual screentip elements, though you may want to register the signal/flag manually at that point for performance.
Apply basic contextual screentips when the user hovers over this item with an item of the given tool behavior.
+A "Type B" interaction.
+This stacks with other contextual screentip elements, though you may want to register the signal/flag manually at that point for performance.
Non bespoke element (1 in existence) that makes animals fly while living and... not while dead!
+Note: works for carbons and above, but please do something better. humans have wings got dangit!
If you're wanting to add easy recolors for your sprite then this is the system for you. Features include:
+
+
Multiple color layers so your sprite can be generated from more than one color.
+
Mixed greyscale and colored sprite layers; You can choose to only greyscale a part of the sprite or have premade filters applied to layers.
+
Blend modes; Instead of just putting layers of sprites on top of eachother you can use the more advanced blend modes.
+
Reusable configurations; You can reference greyscale sprites from within the configuration of another, allowing you to have a bunch of styles with minimal additional configuration.
+
Bitmasked icons can be generated from bitmasked source files. In order to do this, add "bitmask_config" key to your icon state metadata with an integer value equal to a bitfield of flags from code/__DEFINES/greyscale.dm. The common one that walls and windows use is 7 (first three flags). After this you need to set "bitmask" = true in your layer data to have that layer use a bitmasked variant. You can mix bitmasked layers and non-bitmasked layers.
There are three main parts to GAGS that you'll need to be aware of when adding a new greyscale sprite:
+
+
The json configuration
+
+
All configuration files can be found in code/datums/greyscale/json_configs and is where you control how your icons are combined together along with the colors specified from in code.
+
+
The dmi file
+
+
It contains the sprites that will be used as the basis for the rest of the generation process. You can only have one dmi file specified per configuration but if you want to split up your sprites you can reference other configurations instead.
+
+
The configuration type
+
+
This is simply some pointers in the code linking together your dmi and the json configuration.
+Json Configuration File
+
The json is made up of some metadata and a list of layers used while creating the sprite. Inner lists are processed as their own chunk before being applied elsewhere, this is useful when you start using more advanced blend modes. Most of the time though you're just going to want a list of icons overlaid on top of eachother.
In this example, we start off by creating a sprite specified by a different configuration. The "type" key is required to specify the kind of layer you defining. Once that is done, the next two layers are grouped together, so they will be generated into one sprite before being applied to any sprites outside their group. You can think of it as an order of operations.
+
The first of the two in the inner group is an "icon_state", this means that the icon will be retrieved from the associated dmi file using the "icon_state" key.
+
The last layer is another reference type. Note that you don't need to give colors to every layer if the layer does not need any colors applied to it.
+
"blend_mode" and "color_ids" are special, all layer types have them. The blend mode is what controls how that layer's finished product gets merged together with the rest of the sprite. The color ids control what colors are passed in to the layer.
+
Once it is done generating it will be placed in an icon file with the icon state of "icon_state_name". You can use any name you like here.
+Dmi File
+
There are no special requirements from the dmi file to work with this system. You just need to specify the icon file in code and the icon_state in the json configuration.
+Dm Code
+
While the amount of dm code required to make a greyscale sprite was minimized as much as possible, some small amount is required anyway if you want anything to use it.
However, be extremely careful, as this requires that you put all of the object's flags_1 flags in that statement all over again. It's ugly, I know, but there's no
+better way to do this with BYOND just yet. You can put multiple flags like this (not real flags):
If you're making a new greyscale sprite you sometimes want to be able to see how layers got generated or maybe you're just tweaking some colors. Rather than rebooting the server with every change there is a greyscale modification menu that can be found in the vv dropdown menu for the greyscale object. Here you can change colors, preview the results, and reload everything from their files.
This file contains all the trims associated with station jobs.
+It also contains special prisoner trims and the miner's spare ID trim.
+ID Trims for station jobs.
Proc handling the loading of map configs. Will return the default map config using /proc/load_default_map_config if the loading of said file fails for any reason whatsoever, so we always have a working map for the server to run.
This type is responsible for any map generation behavior that is done in areas, override this to allow for area-specific map generation. This generation is ran by areas in initialize.
Simple datum which is instanced once per type and is used for every object of said material. It has a variety of variables that define behavior. Subtyping from this makes it easier to create your own materials.
little tidbits of past events generated by the player doing things. can be used in engravings, dreams, and changeling succs.
+all of those things are supposed to be taken vaguely (engravings crossround and should not include names, dreams and succs are memory goop)
+and as such the generated text of the memory is vague. also, no references held so hard delling isn't an issue, thank god
Memories are events that happen to spacemen that are stored in their mind. They are then turned into generated stories that spessmen can engrave into walls, tattoo onto limbs, changelings can absorb people and read memories, etc.
+
One thing i'd keep in mind is that stories are not memories. Memories persist and can be turned into stories of different types (engravings, tats) but stories are simply the output strings of memories.
+How to add a memory:
+
Here's a quick step by step guide on adding a memory. It's purposefully been made to be pretty easy! I'm going to be explaining memories with the surgery memory, it's a great example of a memory.
+Add defines and memory text
+
For the define file
+
#define MEMORY_SUCCESSFUL_SURGERY "surgery"
+
this define is used in the proc for adding a memory to someone.
+
#define DETAIL_SURGERY_TYPE "SURGERY_TYPE"
+
this define is going to be the name of the surgery used, it's passed to the memory through the proc. See the next step for a more in-depth explanation.
+
For the memory json
+
Keys are in the memory defines, and are also sent by the memory proc. The only one that is not sent by the specific memory is %MOOD which is replaced by a string of the %PROTAGONIST's moods.
+
+
Note that the memory key consists of the memory define, and then:
+
+
names - name of the story
+
starts - the first sentence of the generated story, it should describe what is happening in the memory
+
moods - comes after starts, should include %MOOD to show how the %PROTAGONIST feels during the memory.
+
+Add proc to store memory
+
Here's an in-codebase example of a memory.
+
surgeon.mind.add_memory(
+ // argument 1
+ MEMORY_SUCCESSFUL_SURGERY,
+ // argument 2
+ list(
+ DETAIL_PROTAGONIST = surgeon,
+ DETAIL_DEUTERAGONIST = target,
+ DETAIL_SURGERY_TYPE = src,
+ ),
+ // argument 3
+ story_value = STORY_VALUE_OKAY,
+ // argument 4, you do not need to include this if there are no flags BUT for the sake of teaching the proc this is included for the example.
+ memory_flags = NONE
+)
+
+
First argument is the memory type, basically what is happening. It is a define equal to the memory json key with all the flavor text.
+
Second argument is the elements in the memory. You will almost always have a PROTAGONIST, or the main character in the memory. The second most important character is is the DEUTERAGONIST. In the case of this memory, the protag is the surgeon and the deuterag is the patient. Makes sense! There are also non generic memory information, which is shown by the DETAIL_SURGERY_TYPE entry. This will send the name of the surgery to the memory, so it has that information when creating a story.
+
Third argument is the story value, or how good of a memory it is. We make really easy memories or roundstart memories like account info worth very little so they show up less often, to offset the fact that they are easy
+
Fourth argument are some memory flags, these can be used to cut story generation out where it doesn't make sense (gibbing not sending moods, roundstart memories not sending location, etc)
+Ways to expand this system in the future:
+
+
Make engraving generic to atoms, not just walls.
+
Tattoos could use overlay sprites on the limb.
+
Tattoos working on simple animals?
+
More wall engraving sprites
+
Maybe implement engravings into fantasy affixes? A certain fellow by the name of fikou has worked on RPG stats, that combined with engraved high quality items would be awesome.
Movable and easily code-modified fields! Allows for custom AOE effects that affect movement
+and anything inside of them, and can do custom turf effects!
+Supports automatic recalculation/reset on movement.
If this is defined, reagent_id will be unused and the defined reagent type will be instead.
+actual instanced version of the reagent
+Where the drug spawned
+If this is defined before pill generation, pill generation will be skipped. This is the type of the pill bottle.
+where the accessory spawned
+If this is null, an accessory won't be spawned.
+how frequently the quirk processes
+ticker for processing
This status effect represents anything that leaves a character unable to perform basic tasks (interrupting do-afters, for example), but doesn't incapacitate them further than that (no stuns etc..)
Stage 2 of being drunk, applied at drunk values between 6 and onward.
+Has all the main side effects of being drunk, scaling up as they get more drunk.
Datumized Storage
+Eliminates the need for custom signals specifically for the storage component, and attaches a storage variable (atom_storage) to every atom.
+If you're looking to create custom storage type behaviors, check ../subtypes
like normal callbacks but they also record their creation time for measurement purposes
+they also require the same usr/user that made the callback to both still exist and to still have a client in order to execute
This threat is split into two separate budgets--round_start_budget and mid_round_budget. For example, a round with 50 threat might be split into a 30 roundstart budget, and a 20 midround budget. The roundstart budget is used to apply antagonists applied on readied players when the roundstarts (/datum/dynamic_ruleset/roundstart). The midround budget is used for two types of rulesets:
+
+
/datum/dynamic_ruleset/midround - Rulesets that apply to either existing alive players, or to ghosts. Think Blob or Space Ninja, which poll ghosts asking if they want to play as these roles.
+
/datum/dynamic_ruleset/latejoin - Rulesets that apply to the next player that joins. Think Syndicate Infiltrator, which converts a player just joining an existing round into traitor.
+
+
This split is done with a similar method, known as the "lorentz distribution", exists to create a bell curve that ensures that while most rounds will have a threat level around ~50, chaotic and tame rounds still exist for variety.
+
The process of creating these numbers occurs in /datum/game_mode/dynamic/proc/generate_threat (for creating the threat level) and /datum/game_mode/dynamic/proc/generate_budgets (for splitting the threat level into budgets).
+Deciding roundstart threats
+
In /datum/game_mode/dynamic/proc/roundstart() (called when no admin chooses the rulesets explicitly), Dynamic uses the available roundstart budget to pick threats. This is done through the following system:
+
+
All roundstart rulesets (remember, /datum/dynamic_ruleset/roundstart) are put into an associative list with their weight as the values (drafted_rules).
+
Until there is either no roundstart budget left, or until there is no ruleset we can choose from with the available threat, a pickweight is done based on the drafted_rules. If the same threat is picked twice, it will "scale up". The meaning of this depends on the ruleset itself, using the scaled_times variable; traitors for instance will create more the higher they scale.
+
+
If a ruleset is chosen with the HIGH_IMPACT_RULESET in its flags, then all other HIGH_IMPACT_RULESETs will be removed from drafted_rules. This is so that only one can ever be chosen.
+
If a ruleset has LONE_RULESET in its flags, then it will be removed from drafted_rules. This is to ensure it will only ever be picked once. An example of this in use is Wizard, to avoid creating multiple wizards.
+
+
+
After all roundstart threats are chosen, /datum/dynamic_ruleset/proc/picking_roundstart_rule is called for each, passing in the ruleset and the number of times it is scaled.
+
+
In this stage, pre_execute is called, which is the function that will determine what players get what antagonists. If this function returns FALSE for whatever reason (in the case of an error), then its threat is refunded.
+
+
+
+
After this process is done, any leftover roundstart threat will be given to the existing midround budget (done in /datum/game_mode/dynamic/pre_setup()).
+Deciding midround threats
+
Latejoin and midround injection cooldowns are set using exponential distribution between
+
+
5 minutes and 25 for latejoin (configurable as latejoin_delay_min and latejoin_delay_max)
+
15 minutes and 35 for midround (configurable as midround_delay_min and midround_delay_max)
+
+
this value is then added to world.time and assigned to the injection cooldown variables.
+
rigged_roundstart is called instead if there are forced rules (an admin set the mode)
Calls rule_process on every rule which is in the current_rules list.
+Every sixty seconds, update_playercounts()
+Midround injection time is checked against world.time to see if an injection should happen.
+If midround injection time is lower than world.time, it updates playercounts again, then tries to inject and generates a new cooldown regardless of whether a rule is picked.
+Latejoin
+
make_antag_chance(newPlayer) -> (For each latespawn rule...)
+-> acceptable(living players, threat_level) -> trim_candidates() -> ready(forced=FALSE)
+**If true, add to drafted rules
+**NOTE that acceptable uses threat_level not threat!
+**NOTE Latejoin timer is ONLY reset if at least one rule was drafted.
+**NOTE the new_player.dm AttemptLateSpawn() calls OnPostSetup for all roles (unless assigned role is MODE)
For latejoin, it simply sets forced_latejoin_rule
+make_antag_chance(newPlayer) -> trim_candidates() -> ready(forced=TRUE) **NOTE no acceptable() call
+
For midround, calls the below proc with forced = TRUE
+picking_specific_rule(ruletype,forced) -> forced OR acceptable(living_players, threat_level) -> trim_candidates() -> ready(forced) -> spend threat -> execute()
+**NOTE specific rule can be called by RS traitor->MR autotraitor w/ forced=FALSE
+**NOTE that due to short circuiting acceptable() need not be called if forced.
+Ruleset
+
acceptable(population,threat) just checks if enough threat_level for population indice.
+**NOTE that we currently only send threat_level as the second arg, not threat.
+ready(forced) checks if enough candidates and calls the map's map_ruleset(dynamic_ruleset) at the parent level
+
trim_candidates() varies significantly according to the ruleset type
+Roundstart: All candidates are new_player mobs. Check them for standard stuff: connected, desire role, not banned, etc.
+**NOTE Roundstart deals with both candidates (trimmed list of valid players) and mode.candidates (everyone readied up). Don't confuse them!
+Latejoin: Only one candidate, the latejoiner. Standard checks.
+Midround: Instead of building a single list candidates, candidates contains four lists: living, dead, observing, and living antags. Standard checks in trim_list(list).
+
Midround - Rulesets have additional types
+/from_ghosts: execute() -> send_applications() -> review_applications() -> finish_setup(mob/newcharacter, index) -> setup_role(role)
+**NOTE: execute() here adds dead players and observers to candidates list
+Configuration and variablesConfiguration
+
Configuration can be done through a config/dynamic.json file. One is provided as example in the codebase. This config file, loaded in /datum/game_mode/dynamic/pre_setup(), directly overrides the values in the codebase, and so is perfect for making some rulesets harder/easier to get, turning them off completely, changing how much they cost, etc.
+
The format of this file is:
+
{
+ "Dynamic": {
+ /* Configuration in here will directly override `/datum/game_mode/dynamic` itself. */
+ /* Keys are variable names, values are their new values. */
+ },
+
+ "Roundstart": {
+ /* Configuration in here will apply to `/datum/dynamic_ruleset/roundstart` instances. */
+ /* Keys are the ruleset names, values are another associative list with keys being variable names and values being new values. */
+ "Wizard": {
+ /* I, a head admin, have died to wizard, and so I made it cost a lot more threat than it does in the codebase. */
+ "cost": 80
+ }
+ },
+
+ "Midround": {
+ /* Same as "Roundstart", but for `/datum/dynamic_ruleset/midround` instead. */
+ },
+
+ "Latejoin": {
+ /* Same as "Roundstart", but for `/datum/dynamic_ruleset/latejoin` instead. */
+ }
+}
+
+
Note: Comments are not possible in this format, and are just in this document for the sake of readability.
+Rulesets
+
Rulesets have the following variables notable to developers and those interested in tuning.
+
+
required_candidates - The number of people that must be willing (in their preferences) to be an antagonist with this ruleset. If the candidates do not meet this requirement, then the ruleset will not bother to be drafted.
+
antag_cap - Judges the amount of antagonists to apply, for both solo and teams. Note that some antagonists (such as traitors, lings, heretics, etc) will add more based on how many times they've been scaled. Written as a linear equation--ceil(x/denominator) + offset, or as a fixed constant. If written as a linear equation, will be in the form of list("denominator" = denominator, "offset" = offset).
+
+
Examples include:
+
+
Traitor: antag_cap = list("denominator" = 24). This means that for every 24 players, 1 traitor will be added (assuming no scaling).
+
Nuclear Emergency: antag_cap = list("denominator" = 18, "offset" = 1). For every 18 players, 1 nuke op will be added. Starts at 1, meaning at 30 players, 3 nuke ops will be created, rather than 2.
+
Revolution: antag_cap = 3. There will always be 3 rev-heads, no matter what.
+
+
+
+
+
minimum_required_age - The minimum age in order to apply for the ruleset.
+
weight - How likely this ruleset is to be picked. A higher weight results in a higher chance of drafting.
+
cost - The initial cost of the ruleset. This cost is taken from either the roundstart or midround budget, depending on the ruleset.
+
scaling_cost - Cost for every additional application of this ruleset.
+
+
Suppose traitors has a cost of 8, and a scaling_cost of 5. This means that buying 1 application of the traitor ruleset costs 8 threat, but buying two costs 13 (8 + 5). Buying it a third time is 18 (8 + 5 + 5), etc.
+
+
+
pop_per_requirement - The range of population each value in requirements represents. By default, this is 6.
+
+
If the value is five the range is 0-4, 5-9, 10-14, 15-19, 20-24, 25-29, 30-34, 35-39, 40-54, 45+.
+
If it is six the range is 0-5, 6-11, 12-17, 18-23, 24-29, 30-35, 36-41, 42-47, 48-53, 54+.
+
If it is seven the range is 0-6, 7-13, 14-20, 21-27, 28-34, 35-41, 42-48, 49-55, 56-62, 63+.
+
+
+
requirements - A list that represents, per population range (see: pop_per_requirement), how much threat is required to consider this ruleset. This is independent of how much it'll actually cost. This uses threat level, not the budget--meaning if a round has 50 threat level, but only 10 points of round start threat, a ruleset with a requirement of 40 can still be picked if it can be bought.
+
+
Suppose wizard has a requirements of list(90,90,70,40,30,20,10,10,10,10). This means that, at 0-5 and 6-11 players, A station must have 90 threat in order for a wizard to be possible. At 12-17, 70 threat is required instead, etc.
+
+
+
restricted_roles - A list of jobs that can't be drafted by this ruleset. For example, cyborgs cannot be changelings, and so are in the restricted_roles.
+
protected_roles - Serves the same purpose of restricted_roles, except it can be turned off through configuration (protect_roles_from_antagonist). For example, security officers shouldn't be made traitor, so they are in Traitor's protected_roles.
+
+
When considering putting a role in protected_roles or restricted_roles, the rule of thumb is if it is technically infeasible to support that job in that role. There's no technical reason a security officer can't be a traitor, and so they are simply in protected_roles. There are technical reasons a cyborg can't be a changeling, so they are in restricted_roles instead.
+
+
+
+Dynamic
+
The "Dynamic" key has the following configurable values:
+
+
pop_per_requirement - The default value of pop_per_requirement for any ruleset that does not explicitly set it. Defaults to 6.
+
latejoin_delay_min, latejoin_delay_max - The time range, in deciseconds (take your seconds, and multiply by 10), for a latejoin to attempt rolling. Once this timer is finished, a new one will be created within the same range.
+
+
Suppose you have a latejoin_delay_min of 600 (60 seconds, 1 minute) and a latejoin_delay_max of 1800 (180 seconds, 3 minutes). Once the round starts, a random number in this range will be picked--let's suppose 1.5 minutes. After 1.5 minutes, Dynamic will decide if a latejoin threat should be created (a probability of /datum/game_mode/dynamic/proc/get_injection_chance()). Regardless of its decision, a new timer will be started within the range of 1 to 3 minutes, repeatedly.
+
+
+
midround_delay_min, midround_delay_max - Same as latejoin_delay_min and latejoin_delay_max, except for midround threats instead of latejoin ones.
+
higher_injection_chance, higher_injection_chance_minimum_threat - Manipulates the injection chance (/datum/game_mode/dynamic/proc/get_injection_chance()). If the current midround budget is above higher_injection_chance_minimum_threat, then this chance will be increased by higher_injection_chance.
+
+
For example: suppose you have a higher_injection_chance_minimum_threat of 70, and a higher_injection_chance of 15. This means that, if when a midround threat is trying to roll, there is 75 midround budget left, then the injection chance will go up 15%.
+
+
+
lower_injection_chance, lower_injection_chance_minimum_threat - The inverse of the higher_injection_chance variables. If the current midround budget is belowlower_injection_chance, then the chance is lowered by lower_injection_chance_minimum_threat.
+
+
For example: suppose you have a lower_injection_chance_minimum_threat of 30, and a lower_injection_chance of 15. This means if there is 20 midround budget left, then the chance will lower by 15%.
+
+
+
threat_curve_centre - A number between -5 and +5. A negative value will give a more peaceful round and a positive value will give a round with higher threat.
+
threat_curve_width - A number between 0.5 and 4. Higher value will favour extreme rounds and lower value rounds closer to the average.
+
roundstart_split_curve_centre - A number between -5 and +5. Equivalent to threat_curve_centre, but for the budget split. A negative value will weigh towards midround rulesets, and a positive value will weight towards roundstart ones.
+
roundstart_split_curve_width - A number between 0.5 and 4. Equivalent to threat_curve_width, but for the budget split. Higher value will favour more variance in splits and lower value rounds closer to the average.
+
random_event_hijack_minimum - The minimum amount of time for antag random events to be hijacked. (See Random Event Hijacking)
+
random_event_hijack_maximum - The maximum amount of time for antag random events to be hijacked. (See Random Event Hijacking)
+
hijacked_random_event_injection_chance - The amount of injection chance to give to Dynamic when a random event is hijacked. (See Random Event Hijacking)
+
max_threat_level - Sets the maximum amount of threat that can be rolled. Defaults to 100. You should only use this to lower the maximum threat, as raising it higher will not do anything.
+
+Random Event "Hijacking"
+
Random events have the potential to be hijacked by Dynamic to keep the pace of midround injections, while also allowing greenshifts to contain some antagonists.
+
/datum/round_event_control/dynamic_should_hijack is a variable to random events to allow Dynamic to hijack them, and defaults to FALSE. This is set to TRUE for random events that spawn antagonists.
+
In /datum/game_mode/dynamic/on_pre_random_event (in dynamic_hijacking.dm), Dynamic hooks to random events. If the dynamic_should_hijack variable is TRUE, the following sequence of events occurs:
+
+
n is a random value between random_event_hijack_minimum and random_event_hijack_maximum. Injection chance, should it need to be raised, is increased by hijacked_random_event_injection_chance.
Probability the AI going malf will be accompanied by an ion storm announcement and some ion laws.
+The probability to replace an existing law with an ion law instead of adding a new ion law.
Data Networks, or: Why the OSI Model is for Pussies
+
+
+
+
+
Important VariablesData
+
These are the basic entries in a signal's data list, which are required for standard network transport.
+
s_addr - Source Address, the ID of the machine that transmitted the packet.
+d_addr - Destination Address, who are we sending this to, PING has special behaviour.
+command - Command, a general purpose field that is usually the 'type' of data being transmitted.
+
Example:
+
{
+ "s_addr":00000001, // We are being sent by device 1
+ "d_addr":00000002, // intended for device 2
+ "command":"do_thing", // and we want them to "do_thing"
+ "other_fields":"Are implimentation specific."
+}
+
Overlay cache. Why isn't this just in /obj/machinery/door/airlock? Because its used just a
+tiny bit in door_assembly.dm Refactored so you don't have to make a null copy of airlock
+to get to the damn thing
+Someone, for the love of god, profile this. Is there a reason to cache mutable_appearance
+if so, why are we JUST doing the airlocks when we can put this in mutable_appearance.dm for
+everything
A combined all in one datum that stores everything about the request, the requester's account, as well as the requestee's account
+All of this is passed to the Request Console UI in order to present in organized way.
///// Attach a trail to any object, that spawns when it moves (like for the jetpack)
+just pass in the object to attach it to in set_up
+Then do start() to start it and stop() to stop it, obviously
+and don't call start() in a loop that will be repeated otherwise it'll get spammed!
objects can only have one particle on them at a time, so we use these abstract effects to hold and display the effects. You know, so multiple particle effects can exist at once.
+also because some objects do not display particles due to how their visuals are built
Random spawners are an organized tool primarily for mapping to enhance replayability. The spawners can create objects, effects, and structures with different tweakable settings to get the desired outcome. You can make a spawner determine direction, rarity, number of items to spawn, pixel spacing between items, and even spread it over a large tile radius. This lets you control the atmosphere of a location. You could for instance spawn different piles of trash in maint or spawn decoration items for a room to give it more randomized flavor. The choice is yours!
+
(note the audience of this README is directed towards mappers who lack knowledge of coding)
+Variables
+
The following variables are defined in code/game/objects/effects/spawners/random/random.dm that control how a spawner works.
+
+
loot - a list of possible items to spawn e.g. list(/obj/item, /obj/structure, /obj/effect)
+
loot_type_path - this combines the subtypes AND type list with the loot list
+
loot_subtype_path - this combines ONLY the subtypes (excludes the loot_subtype_path) with the loot list
+
spawn_loot_count - how many items will be spawned
+
spawn_loot_double - if the same item can be spawned twice from the loot list
+
spawn_loot_split - whether the items should be distributed to offsets 0,1,-1,2,-2,3,-3.. This overrides pixel_x/y on the spawner itself
+
spawn_all_loot - whether the spawner should spawn all the loot in the list (ignores spawn_loot_count)
+
spawn_loot_chance - the chance for the spawner to create loot (ignores spawn_loot_count)
+
spawn_scatter_radius - determines how big of a range (in tiles) we should scatter things in
+
+
These variables are set to the following default values for the base random.dm object that all objects inherit from:
+
/// these three loot values are all empty
+ var/list/loot
+ var/loot_type_path
+ var/loot_subtype_path
+
+ var/spawn_loot_count = 1 // by default one item will be selected from the loot list
+ var/spawn_loot_double = TRUE // by default duplicate items CAN be spawned from the loot list
+ var/spawn_loot_split = FALSE // by default items will NOT spread out on the same tile
+ var/spawn_all_loot = FALSE // by default the spawner will only spawn the number of items set in spawn_loot_count
+ var/spawn_loot_chance = 100 // by default the spawner has a 100% chance to spawn the item(s)
+ var/spawn_scatter_radius = 0 // by default the spawner will spawn the items ONLY on the tile it is on
+
+
However there are some categories that overwrite these default values so pay attention to the folder or category you group your spawner in. For instance the obj/effect/spawner/random/techstorage category overwrites the spawn_all_loot and the spawn_loot_split variables.
This means any spawner you create under the techstorage will also have those variables set to that by default. This can be overridden quite easily just be resetting the variables back to the normal state like so:
+
/obj/effect/spawner/random/techstorage/data_disk
+ name = "data disk spawner"
+ spawn_all_loot = FALSE // now our loot won't all be spawned
+ loot = list(
+ /obj/item/disk/data = 49,
+ /obj/item/disk/nuclear/fake/obvious = 1,
+ )
+
+Template
+
All the random spawners follow the same template format to keep things consistent and unison.
Find the path to different objects and add them to the list but try to be consistent with the types of the object and the spawner. For example a medical spawner shouldn't have a emag in the loot list. (use an antag spawner for that instead!)
+Probability
+
Be aware that the loot list uses a weighted chance formula to determine probability. So if there are no numbers set in the loot list then each object defaults to 1 and has the same probability to be selected. For our above example for the minor_healing spawner each medical item has a 1/3 chance to be spawned. But if we rearranged the values to this:
Then now suture has a 50% chance of being spawned (2/4), mesh has a 25% chance of being spawned (1/4), and gauze also has a 25% chance of being spawned (1/4). If we add another item into the mix then we get the following:
Suture is 40% (2/5), Mesh is 20% (1/5), Gauze is 20% (1/5), and Syringe is 20% (1/5). A weighted list has the advantage of not needing to update every item in the list when adding a new item. If the list was based on a straight percent values, then each new item would require to manually go and edit ALL the items in the list. For big lists that would become very tedious. This is why we use weighted lists to determine probability!
+Style
+
Here are some simple guidelines that you should stick to when making a new spawner:
+If ALL the items have the same chance, we should not set a weighted value to the item
+
Do not put /obj/item/ = 1 unless other items have different spawn chances
/obj/effect/spawner/random/medical/minor_healing
+ name = "minor healing spawner"
+ loot = list(
+ /obj/item/stack/medical/suture,
+ /obj/item/stack/medical/mesh,
+ /obj/item/stack/medical/gauze // if someone adds an item to the list later it will cause an error
+ )
+
+Keep the same tab formatting for the loot list (unless there is only one item)
+
Again, this is just good code organization. If there is only one item, then encase that item in loot = list(item)
x1, y1, x2, y2 - Represents the bounding box for the ID card's non-transparent portion of its various icon_states.
+Used to crop the ID card's transparency away when chaching the icon for better use in tgui chat.
x1, y1, x2, y2 - Represents the bounding box for the ID card's non-transparent portion of its various icon_states.
+Used to crop the ID card's transparency away when chaching the icon for better use in tgui chat.
This is smoke bomb, mezum koman. It is a grenade subtype. All craftmanship is of the highest quality.
+It menaces with spikes of iron. On it is a depiction of an assistant.
+The assistant is bleeding. The assistant has a painful expression. The assistant is dead.
Used to help the staff of the space hotel resist the urge to use the space hotel's incredibly alluring roundstart teleporter to ignore their flavor/greeting text and come to the station.
If we can't create a window out of this type, return FALSE to not affect attack chain.
+Dense turf (most likely closed). Why check types of if you can check .density
+Something we were mounting the window on was deleted, or unanchored
A stack item that's not actually a stack because ORDER MATTERS with a deck of cards!
+The "top" card of the deck will always be the bottom card in the stack for our purposes.
The wirebrush is a tool whose sole purpose is to remove rust from anything that is rusty.
+Because of the inherent nature of hard countering rust heretics it does it very slowly.
This represents the item that comes out of the box and is constantly changing before the box finishes deciding. Can probably be just an /atom or /movable.
Used as a parent type for types that want to allow construction, but do not want to be floors
+I wish I could use components for turfs at scale
+Please do not bloat this. Love you <3
Action speed is now calculated by using modifier datums which are added to mobs. Some of them (nonvariable ones) are globally cached, the variable ones are instanced and changed based on need.
+
This gives us the ability to have multiple sources of actionspeed, reliabily keep them applied and remove them when they should be
+
THey can have unique sources and a bunch of extra fancy flags that control behaviour
+
Previously trying to update action speed was a shot in the dark that usually meant mobs got stuck going faster or slower
+
Actionspeed modification list is a simple key = datum system. Key will be the datum's ID if it is overridden to not be null, or type if it is not.
+
DO NOT override datum IDs unless you are going to have multiple types that must overwrite each other. It's more efficient to use types, ID functionality is only kept for cases where dynamic creation of modifiers need to be done.
+
When update actionspeed is called, the list of items is iterated, according to flags priority and a bunch of conditions
+this spits out a final calculated value which is used as a modifer to last_move + modifier for calculating when a mob
+can next move
Grabs a STATIC MODIFIER datum from cache. YOU MUST NEVER EDIT THESE DATUMS, OR IT WILL AFFECT ANYTHING ELSE USING IT TOO!
+
Used for variable slowdowns like hunger/health loss/etc, works somewhat like the old list-based modification adds. Returns the modifier datum if successful
+How this SHOULD work is:
+1. Ensures type_id_datum one way or another refers to a /variable datum. This makes sure it can't be cached. This includes if it's already in the modification list.
+2. Instantiate a new datum if type_id_datum isn't already instantiated + in the list, using the type. Obviously, wouldn't work for ID only.
+3. Add the datum if necessary using the regular add proc
+4. If any of the rest of the args are not null (see: multiplicative slowdown), modify the datum
+5. Update if necessary
Used to handle proccalls called indirectly by an admin (e.g. tgs, circuits).
+Has to be a mob because IsAdminAdvancedProcCall() checks usr, which is a mob variable.
+So usr is set to this for any proccalls that don't have any usr mob/client to refer to.
Gets the ban cache of the passed in client
+If the cache has not been generated, we start off a query
+If we still have a query going for this request, we just sleep until it's recieved back
Allow me to explain
+for some reason, if pick() is passed arglist(args) directly and args contains only one list
+it considers it to be a list of lists
+this means something like _pick(list) would fail
+need to do this instead
The triple ai controller handles the admin triple AI mode, if enabled.
+It is first created when "Toggle AI Triumvirate" triggers it, and it can be referenced from GLOB.triple_ai_controller
+After it handles roundstart business, it cleans itself up.
Used to test the game for issues with different types of color blindness
+WARNING ASSHOLE: Because we can only apply matrixes, and can't preform gamma correction
+https://web.archive.org/web/20220227030606/https://ixora.io/projects/colorblindness/color-blindness-simulation-research/
+The results of this tool aren't perfect. It's way better then nothing, but IT IS NOT A PROPER SIMULATION
+Please do not make us look like assholes by assuming it is. Thanks.
The highlander controller handles the admin highlander mode, if enabled.
+It is first created when "there can only be one" triggers it, and it can be referenced from GLOB.highlander_controller
When the revolution wins, any remaining heads and security become Enemies of the Revolution.
+Previously being nonantagonists, they only have one simple objective: survive!
When the station wins, any remaining living headrevs become Enemies of the State, a small solo antagonist.
+They either have the choice to fuck off and do their own thing, or try and regain their honor with a hijack.
This guide will explain how the values for progression traitor works, how to balance progression traitors and what you should NOT do when balancing.
+This guide will only explain progression values.
+Definitions
+
+
Progression points OR Progression - A currency that controls what uplink items a player can purchase and what objectives they have accessible to them. Gained passively or by completing objectives and has diminishing returns as it strays from the expected progression
+
Expected Progression - A global value that increments by a value of 1 minute every minute, representing the 'time' that a player should be at if they had not completed any objectives.
+
Objectives - An activity or job that a player can take for rewards such as TC and progression points.
+
Player - The user(s) that are playing as the antagonist in this new system.
+
Expected deviance - The amount of deviance that can be expected from the minimum and maximum progressions. Usually calculated by progression_scaling_deviance + progression_scaling_deviance * global_progression_deviance_required (explained further down)
+
+How it works
+
This section will explain how the entire balance system works. This is an overview of the entire system.
+Progression
+
Progression points is passively given to a player, and are represented as minutes (or time values) in code. The round has its own 'expected progression', which is the progression value that you'd normally have if you hadn't completed any objectives whatsoever. This is the baseline progression that all players will be at unless they're a latejoiner, and it acts as the basis for determining how much progression points a player should get over time and the cost of objectives for a specific player, if they deviate too much from this value. The idea is that they will slowly drift back towards the expected progression if they do nothing and it becomes harder for them to progress as they deviate further from the expected progression. The amount that is passively given can also vary depending on how many players there are, so that at lower populations, expected progression rises more slowly.
+Objectives
+
Objectives are worth a certain amount of progression points, determined by the code. However, this can be scaled to be less if the player taking them is ahead of the expected progression. This scales exponentially, so that as a player deviates further from the expected progression, the reward diminishes exponentially, up to a reduced value of 90%. The similar thing happens in the opposite direction, with people who are lower than the expected progression getting more progression than usual for completing objectives.
+How to balanceThe traitor subsystem
+
+
newjoin_progression_coeff - The coefficient multiplied by the expected progression for new joining traitors to calculate their starting progression, so that they don't start from scratch
+
progression_scaling_deviance - The value that the entire system revolves around. This determines how your disadvantages are calculated, if you stray from the expected progression. Having a progression value that is progression_scaling_deviance minutes off of the expected progression means that you won't get any progression at all, and if objectives were configured to suit this, you'd have the highest reduction you can possibly get. From the expected progression to this value, it scales linearly and it also works in the opposite direction.
+
current_progression_scaling - Defined at compile time, this determines how fast expected progression scales. So if you have it set to 0.5 MINUTES, it'll take twice as long to unlock uplink items and new objectives.
+
CONFIG:TRAITOR_IDEAL_PLAYER_COUNT - The ideal player count before expected progression stops increasing. If the living player list gets below this value, the current progression scaling will be multiplied by player_count/traitor_ideal_player_count. In essence, this makes it so that progression scales more slowly when there isn't a lot of people alive.
+
+
If you want to balance how fast the system progresses, you should look at modifying current_progression_scaling. If you want to balance how far someone should be allowed to deviate, you should look at modifying progression-scaling-deviance
+Objectives
+
+
progression_minimum - The minimum number of progression points required before this objective can show up as a potential objective
+
progression_maximum - The maximum number of progression points before this objective stops showing up as a potential objective, used to prevent roundstart objectives from showing up during the late game.
+
progression_reward - The progression reward you get from completing an objective. This is the base value, and can also be a two element list of numbers if you want it to be random. This value is then scaled depending on whether a player is ahead or behind the expected progression
+
global_progression_influence_intensity - Determines how influential expected progression will affect the progression reward of this objective. Set to 0 to disable.
+
global_progression_deviance_required - Determines how much deviance is required before the scaling kicks in, to give objectives more leeway so that at the progression_scaling_deviance, it doesn't scale to 90% immediately.
+
progression_cost_coeff_deviance - This determines the randomness of the progression reward, to prevent all of the scaling from looking the same. Becomes a lot less significant as the scaling variable gets closer to 1.
+
+
If you want to balance the expected timeframe an objective should be available, you should look at changing the progression_minimum or progression_maximum. If you want to balance how much objectives reward, you may want to look at modifying progression_reward. If you want to look at balancing the cost of an objective depending on the expected progression, you may want to look at global_progression_influence_intensity. If you want to look at decreasing or increasing the deviance allowed before objectives become worthless progression-wise, you may want to look at modifying global_progression_deviance_required
+Uplink Items
+
+
progression_minimum - The minimum number of progression points required to purchase this uplink item.
+
+What NOT to do when balancingOvercompensate
+
You do not want to overcompensate variables such as progression_minimum and progression_maximum. Such values need to be an accurate representation of roughly around the time a player should unlock the objective or uplink item. progression_scaling_deviance is supposed to represents the limit that a casual player can be at before it becomes significantly harder for them to progress throughout. You should expect people to be within progression_scaling_deviance + progression_scaling_deviance * global_progression_deviance_required. (Assuming progression_scaling_deviance is 20 minutes and progression_scaling_deviance_required is 0.5, 20 + 0.5 * 20 = 30; this gives us a value of 30 minutes). This is the expected deviance.
+Reward large amounts of progression points
+
Progression points are passively gained, so rewarding large amounts of progression points will let people bypass the scaling as they'll immediately jump to an absurd value. A good rule of thumb is to always keep the reward within or below the expected deviance.
The objective category.
+Used to group up entire objectives into 1 weight objects to prevent having a
+higher chance of getting an objective due to an increased number of different objective subtypes.
+These are nothing but informational holders and will have no other purpose.
A traitor objective. Traitor objectives should not be deleted after they have been created and established, only failed.
+If a traitor objective needs to be removed from the failed/completed objective list of their handler, then you are doing something wrong
+and you should reconsider. When an objective is failed/completed, that is final and the only way you can change that is by refactoring the code.
Framework for managing browser assets (javascript,css,images,etc)
+
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:
+Asset datum:
+
Make a datum in asset_list_items.dm with your browser assets for your thing.
+
Checkout asset_list.dm for the helper subclasses
+
The simple subclass will most likely be of use for most cases.
+
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.
+Manual backend:
+
See the documentation for /datum/asset_transport for the backend api the asset datums utilize.
+
The global variable SSassets.transport contains the currently configured transport.
+Notes:
+
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 get_url_mappings() or by asset_transport's get_asset_url(). (TGUI also has helpers for this.) If this can not be easily done, you can bypass the cdn using legacy assets, see the simple asset datum for details.
+
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/simple/namespaced for details.
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)
Technically vacuum doesn't have a specific entropy. Just use a really big number (infinity would be ideal) here so that it's easy to add gas to vacuum and hard to take gas out.
Technically vacuum doesn't have a specific entropy. Just use a really big number (infinity would be ideal) here so that it's easy to add gas to vacuum and hard to take gas out.
When the AUTOWIKI define is enabled, will generate an output file for tools/autowiki/autowiki.js to consume.
+Autowiki code intentionally still exists even without the define, to ensure developers notice
+when they break it immediately, rather than until CI or worse, call time.
+Returns a string of the autowiki output file
Original Food export file got eaten somewhere along the line and I have no idea when or where it got completely deleted.
+Foods given a venue value are exportable to cargo as a backup to selling from venues, however at the expense of elasticity.
We're going to take a list that dictates the pace of speech, and a sentence fragment to say
+Then say() that fragment at that pace
+You can pass in a starting delay to wait before speaking the next sound
Client Colour Priority System By RemieRichards (then refactored by another contributor)
+A System that gives finer control over which client.colour value to display on screen
+so that the "highest priority" one is always displayed as opposed to the default of
+"whichever was set last is displayed".
Gets the resulting colour/tone from client_colours.
+In the case of multiple colours, they'll be converted to RGBA matrices for compatibility,
+summed together, and then each element divided by the number of matrices. (except we do this with lists because byond)
+target is the target variable.
Gets the resulting colour/tone from client_colours.
+In the case of multiple colours, they'll be converted to RGBA matrices for compatibility,
+summed together, and then each element divided by the number of matrices. (except we do this with lists because byond)
+target is the target variable.
This does not contain all the information on specific values--you can find those as doc-comments in relevant paths, such as /datum/preference. Rather, this gives you an overview for creating most preferences, and getting your foot in the door to create more advanced ones.
+Anatomy of a preference (A.K.A. how do I make one?)
+
Most preferences consist of two parts:
+
+
A /datum/preference type.
+
A tgui representation in a TypeScript file.
+
+
Every /datum/preference requires these three values be set:
savefile_key - The value which will be saved in the savefile. This will also be the identifier for tgui.
+
savefile_identifier - Whether or not this is a character specific preference (PREFERENCE_CHARACTER) or one that affects the player (PREFERENCE_PLAYER). As an example: hair color is PREFERENCE_CHARACTER while your UI settings are PREFERENCE_PLAYER, since they do not change between characters.
+
+
For the tgui representation, most preferences will create a .tsx file in tgui/packages/tgui/interfaces/PreferencesMenu/preferences/features/. If your preference is a character preference, make a new file in character_preferences. Otherwise, put it in game_preferences. The filename does not matter, and this file can hold multiple relevant preferences if you would like.
+
From here, you will want to write code resembling:
+
import { Feature } from "../base";
+
+export const savefile_key_here: Feature<T> = {
+ name: "Preference Name Here",
+ component: Component,
+
+ // Necessary for game preferences, unused for others
+ category: "CATEGORY",
+
+ // Optional, only shown in game preferences
+ description: "This preference will blow your mind!",
+}
+
+
T and Component depend on the type of preference you're making. Here are all common examples...
+Numeric preferences
+
Examples include age and FPS.
+
A numeric preference derives from /datum/preference/numeric.
This will create a dropdown input for your preference.
+Choiced preferences - Icons
+
Choiced preferences can generate icons. This is how the clothing/species preferences work, for instance. However, if we just want a basic dropdown input with icons, it would look like this:
+
/datum/preference/choiced/favorite_drink
+ category = PREFERENCE_CATEGORY_NON_CONTEXTUAL
+ savefile_identifier = PREFERENCE_CHARACTER
+ savefile_key = "favorite_drink"
+ should_generate_icons = TRUE // NEW! This is necessary.
+
+// Instead of returning a flat list, this now returns an assoc list
+// of values to icons.
+/datum/preference/choiced/favorite_drink/init_possible_values()
+ return list(
+ "Milk" = icon('drinks.dmi', "milk"),
+ "Cola" = icon('drinks.dmi', "cola"),
+ "Water" = icon('drinks.dmi', "water"),
+ )
+
These refer to an alternative name. Examples include AI names and backup human names.
+
These exist in code/modules/client/preferences/names.dm.
+
These do not need a .ts file, and will be created in the UI automatically.
+
/datum/preference/name/doctor
+ savefile_key = "doctor_name"
+
+ // The name on the UI
+ explanation = "Doctor name"
+
+ // This groups together with anything else with the same group
+ group = "medicine"
+
+ // Optional, if specified the UI will show this name actively
+ // when the player is a medical doctor.
+ relevant_job = /datum/job/medical_doctor
+
+Making your preference do stuff
+
There are a handful of procs preferences can use to act on their own:
+
/// Apply this preference onto the given client.
+/// Called when the savefile_identifier == PREFERENCE_PLAYER.
+/datum/preference/proc/apply_to_client(client/client, value)
+
+/// Fired when the preference is updated.
+/// Calls apply_to_client by default, but can be overridden.
+/datum/preference/proc/apply_to_client_updated(client/client, value)
+
+/// Apply this preference onto the given human.
+/// Must be overriden by subtypes.
+/// Called when the savefile_identifier == PREFERENCE_CHARACTER.
+/datum/preference/proc/apply_to_human(mob/living/carbon/human/target, value)
+
+
For example, /datum/preference/numeric/age contains:
+
/datum/preference/numeric/age/apply_to_human(mob/living/carbon/human/target, value)
+ target.age = value
+
+
If your preference is PREFERENCE_CHARACTER, it MUST override apply_to_human, even if just to immediately return.
+
You can also read preferences directly with preferences.read_preference(/datum/preference/type/here), which will return the stored value.
+Categories
+
Every preference needs to be in a category. These can be found in code/__DEFINES/preferences.dm.
+
/// These will be shown in the character sidebar, but at the bottom.
+#define PREFERENCE_CATEGORY_FEATURES "features"
+
+/// Any preferences that will show to the sides of the character in the setup menu.
+#define PREFERENCE_CATEGORY_CLOTHING "clothing"
+
+/// Preferences that will be put into the 3rd list, and are not contextual.
+#define PREFERENCE_CATEGORY_NON_CONTEXTUAL "non_contextual"
+
+/// Will be put under the game preferences window.
+#define PREFERENCE_CATEGORY_GAME_PREFERENCES "game_preferences"
+
+/// These will show in the list to the right of the character preview.
+#define PREFERENCE_CATEGORY_SECONDARY_FEATURES "secondary_features"
+
+/// These are preferences that are supplementary for main features,
+/// such as hair color being affixed to hair.
+#define PREFERENCE_CATEGORY_SUPPLEMENTAL_FEATURES "supplemental_features"
+
+
+
+
SECONDARY_FEATURES or NON_CONTEXTUAL?
+
+
Secondary features tend to be species specific. Non contextual features shouldn't change much from character to character.
+Default values and randomization
+
There are three procs to be aware of in regards to this topic:
+
+
create_default_value(). This is used when a value deserializes improperly or when a new character is created.
+
create_informed_default_value(datum/preferences/preferences) - Used for more complicated default values, like how names require the gender. Will call create_default_value() by default.
+
create_random_value(datum/preferences/preferences) - Explicitly used for random values, such as when a character is being randomized.
+
+
create_default_value() in most preferences will create a random value. If this is a problem (like how default characters should always be human), you can override create_default_value(). By default (without overriding create_random_value), random values are just default values.
Compiled data is used wherever the server needs to give the client some value it can't figure out on its own. Skin tones use this to tell the client what colors they represent, for example.
+
Compiled data is sent to the serverData field in the FeatureValueProps.
+Advanced - Creating your own tgui component
+
If you have good knowledge with tgui (especially TypeScript), you'll be able to create your own component to represent preferences.
+
The component field in a feature accepts any component that accepts FeatureValueProps<TReceiving, TSending = TReceiving, TServerData = undefined>.
A /datum/preference_middleware is a way to inject your own data at specific points, as well as hijack actions.
+
Middleware can hijack actions by specifying action_delegations:
+
/datum/preference_middleware/congratulations
+ action_delegations = list(
+ "congratulate_me" = PROC_REF(congratulate_me),
+ )
+
+/datum/preference_middleware/congratulations/proc/congratulate_me(list/params, mob/user)
+ to_chat(user, span_notice("Wow, you did a great job learning about middleware!"))
+
+ return TRUE
+
+
Middleware can inject its own data at several points, such as providing new UI assets, compiled data (used by middleware such as quirks to tell the client what quirks exist), etc. Look at code/modules/client/preferences/middleware/_middleware.dm for full information.
+
+Antagonists
+
In order to make an antagonist selectable, you must do a few things:
+
+
Your antagonist needs an icon.
+
Your antagonist must be in a Dynamic ruleset. The ruleset must specify the antagonist as its antag_flag.
+
Your antagonist needs a file in tgui/packages/tgui/interfaces/PreferencesMenu/antagonists/antagonists/filename.ts. This file name MUST be the antag_flag of your ruleset, with nothing but letters remaining (e.g. "Nuclear Operative" -> nuclearoperative).
+
Add it to special_roles.
+
+Creating icons
+
If you are satisfied with your icon just being a dude with some clothes, then you can specify preview_outfit in your /datum/antagonist.
However, if you want to get creative, you can override /get_preview_icon(). This proc should return an icon of size ANTAGONIST_PREVIEW_ICON_SIZExANTAGONIST_PREVIEW_ICON_SIZE.
+
There are some helper procs you can use as well. render_preview_outfit(outfit_type) will take an outfit and give you an icon of someone wearing those clothes. finish_preview_outfit will, given an icon, resize it appropriately and zoom in on the head. Note that this will look bad on anything that isn't a human, so if you have a non-human antagonist (such as sentient disease), just run icon.Scale(ANTAGONIST_PREVIEW_ICON_SIZE, ANTAGONIST_PREVIEW_ICON_SIZE).
In the .ts file you created earlier, you must now give the information of your antagonist. For reference, this is the changeling's:
+
import { Antagonist, Category } from "../base";
+import { multiline } from "common/string";
+
+const Changeling: Antagonist = {
+ key: "changeling", // This must be the same as your filename
+ name: "Changeling",
+ description: [
+ multiline`
+ A highly intelligent alien predator that is capable of altering their
+ shape to flawlessly resemble a human.
+ `,
+
+ multiline`
+ Transform yourself or others into different identities, and buy from an
+ arsenal of biological weaponry with the DNA you collect.
+ `,
+ ],
+ category: Category.Roundstart, // Category.Roundstart, Category.Midround, or Category.Latejoin
+};
+
+export default Changeling;
+
+Readying the Dynamic ruleset
+
You already need to create a Dynamic ruleset, so in order to get your antagonist recognized, you just need to specify antag_flag. This must be unique per ruleset.
+
Two other values to note are antag_flag_override and antag_preference.
+
antag_flag_override exists for cases where you want the banned antagonist to be separate from antag_flag. As an example: roundstart, midround, and latejoin traitors have separate antag_flag, but all have antag_flag_override = ROLE_TRAITOR. This is because admins want to ban a player from Traitor altogether, not specific rulesets.
+
If antag_preference is set, it will refer to that preference instead of antag_flag. This is used for clown operatives, which we want to be on the same preference as standard nuke ops, but must specify a unique antag_flag for.
+Updating special_roles
+
In code/__DEFINES/role_preferences.dm (the same place you'll need to make your ROLE_* defined), simply add your antagonist to the special_roles assoc list. The key is your ROLE, the value is the number of days since your first game in order to play as that antagonist.
In the before times, toggles were all stored in one bitfield.
+In order to preserve this existing data (and code) without massive
+migrations, this middleware attempts to handle this in a way
+transparent to the preferences UI itself.
+In the future, the existing toggles data should just be migrated to
+individual /datum/preference/toggles.
This can be set to TRUE from the prefs menu only once the user has
+gained over 5K playtime hours.
+If true, it allows the user to get a cool looking roundstart cloak.
Documentation for the embed object and all of its variables can be found at
+https://discord.com/developers/docs/resources/channel#embed-object
+It is recommended to read the documentation on the discord website, as the information below could become outdated in the future.
Kudzu severity values for traits, based on severity in terms of how severely it impacts the game, the lower the severity, the more likely it is to appear
Kudzu spread cap is a scaled version of production speed, such that the better the production speed, ie. the lower the speed value is, the faster is spreads
Kudzu spread multiplier is a reciporal function of production speed, such that the better the production speed, ie. the lower the speed value is, the faster it spreads
Kudzu severity values for traits, based on severity in terms of how severely it impacts the game, the lower the severity, the more likely it is to appear
Kudzu spread cap is a scaled version of production speed, such that the better the production speed, ie. the lower the speed value is, the faster is spreads
Kudzu spread multiplier is a reciporal function of production speed, such that the better the production speed, ie. the lower the speed value is, the faster it spreads
Places that shouldn't explode
+Subtypes from the above that actually should explode.
+A rare variant that drops a crate containing syndicate uplink items
Future improvements:
+ Better names/descriptions for ships/trading/planets
+ More fluff lines for each site type.
+ Adventure-Maker : styling aaaaah.
+ Adventure-Maker : Consider parsing define hard-configured dm file for constants
+ Typelists for event/site stuff to reduce costs
+ Figure out some way to cache adventure prototypes / defer loading somehow so it scales better with a lot of adventure files.
+ Unit test for json loading?
+ Mk II drones with more tool slots/other buffs researchable at R&D ?
+ Could use more scan conditions
+ Exit Node - Random Node
+
Plays a laughter sound when someone slips on it.
+Like the sitcom component but for plants.
+Just like slippery skin, if we have a trash type this only functions on that. (Banana peels)
coordinate and control movement across linked industrial_lift's. allows moving large single multitile platforms and many 1 tile platforms.
+also is capable of linking platforms across linked z levels
lift_id landmarks. used to map in specific_lift_id to trams. when the trams lift_master encounters one on a trams tile
+it sets its specific_lift_id to that landmark. allows you to have multiple trams and multiple controls linking to their specific tram
datum/job/bureaucrat,
+This is the file you should use to add alternate titles for each job, just
+follow the way they're done here, it's easy enough and shouldn't take any
+time at all to add more or add some for a job that doesn't have any.
This type is used to indicate a lack of a job.
+The mind variable assigned_role will point here by default.
+As any other job datum, this is a singleton.
This whole system is heavily based off of forum_account's keyboard library.
+Thanks to forum_account for saving the day, the library can be found
+here!
+
.dmf macros have some very serious shortcomings. For example, they do not allow reusing parts
+of one macro in another, so giving cyborgs their own shortcuts to swap active module couldn't
+inherit the movement that all mobs should have anyways. The webclient only supports one macro,
+so having more than one was problematic. Additionally each keybind has to call an actual
+verb, which meant a lot of hidden verbs that just call one other proc. Also our existing
+macro was really bad and tied unrelated behavior into Northeast(), Southeast(), Northwest(),
+and Southwest().
+
The basic premise of this system is to not screw with .dmf macro setup at all and handle
+pressing those keys in the code instead. We have every key call client.keyDown()
+or client.keyUp() with the pressed key as an argument. Certain keys get processed
+directly by the client because they should be doable at any time, then we call
+keyDown() or keyUp() on the client's holder and the client's mob's focus.
+By default mob.focus is the mob itself, but you can set it to any datum to give control of a
+client's keypresses to another object. This would be a good way to handle a menu or driving
+a mech. You can also set it to null to disregard input from a certain user.
+
Movement is handled by having each client call client.keyLoop() every game tick.
+As above, this calls holder and focus.keyLoop(). atom/movable/keyLoop() handles movement
+Try to keep the calculations in this proc light. It runs every tick for every client after all!
+
You can also tell which keys are being held down now. Each client a list of keys pressed called
+keys_held. Each entry is a key as a text string associated with the world.time when it was
+pressed.
+
No client-set keybindings at this time, but it shouldn't be too hard if someone wants.
+
Notes about certain keys:
+
+
Tab has client-sided behavior but acts normally
+
T, O, and M move focus to the input when pressed. This fires the keyUp macro right away.
+
\ needs to be escaped in the dmf so any usage is \\
+
+
You cannot TICK_CHECK or check world.tick_usage inside of procs called by key down and up
+events. They happen outside of a byond tick and have no meaning there. Key looping
+works correctly since it's part of a subsystem, not direct input.
Language holders will either exist in an atom/movable or a mind. Creation of language holders happens
+automatically when they are needed, for example when something tries to speak.
+Where a mind is available, the mind language holder will be the one "in charge". The mind holder
+will update its languages based on the atom holder, and will get updated as part of
+transformations and other events that cause new languages to become available.
+
Every language holder has three lists of languages (and sources for each of them):
+
+
understood_languages
+
spoken_languages
+
blocked_languages
+
+
Understood languages let you understand them, spoken languages lets you speak them
+(if your tongue is compatible), and blocked languages will let you do neither no matter
+what the source of the language is.
+
Language holders are designed to mostly only ever require the use the helpers in atom/movable
+to achieve your goals, but it is also possible to work on them directly if needed. Any adding
+and removing of languages and sources should only happen through the procs, as directly changing
+these will mess something up somewhere down the line.
+
All atom movables have the initial_language_holder var which allows you to set the default language
+holder to create. For example, /datum/language_holder/alien will give you xenocommon and a block for
+galactic common. Human species also have a default language holder var that will be updated on
+species change, initial_species_holder.
The code in this module originally evolved from dmm_suite and has since been
+specialized for SS13 and otherwise tweaked to fit /tg/station's needs.
+
+dmm_suite version 1.0
+ Released January 30th, 2011.
+
+NOTE: Map saving functionality removed
+
+defines the object /dmm_suite
+ - Provides the proc load_map()
+ - Loads the specified map file onto the specified z-level.
+ - provides the proc write_map()
+ - Returns a text string of the map in dmm format
+ ready for output to a file.
+ - provides the proc save_map()
+ - Returns a .dmm file if map is saved
+ - Returns FALSE if map fails to save
+
+The dmm_suite provides saving and loading of map files in BYOND's native DMM map
+format. It approximates the map saving and loading processes of the Dream Maker
+and Dream Seeker programs so as to allow editing, saving, and loading of maps at
+runtime.
+
+------------------------
+
+To save a map at runtime, create an instance of /dmm_suite, and then call
+write_map(), which accepts three arguments:
+ - A turf representing one corner of a three dimensional grid (Required).
+ - Another turf representing the other corner of the same grid (Required).
+ - Any, or a combination, of several bit flags (Optional, see documentation).
+
+The order in which the turfs are supplied does not matter, the /dmm_writer will
+determine the grid containing both, in much the same way as DM's block() function.
+write_map() will then return a string representing the saved map in dmm format;
+this string can then be saved to a file, or used for any other purose.
+
+------------------------
+
+To load a map at runtime, create an instance of /dmm_suite, and then call load_map(),
+which accepts two arguments:
+ - A .dmm file to load (Required).
+ - A number representing the z-level on which to start loading the map (Optional).
+
+The /dmm_suite will load the map file starting on the specified z-level. If no
+z-level was specified, world.maxz will be increased so as to fit the map. Note
+that if you wish to load a map onto a z-level that already has objects on it,
+you will have to handle the removal of those objects. Otherwise the new map will
+simply load the new objects on top of the old ones.
+
+Also note that all type paths specified in the .dmm file must exist in the world's
+code, and that the /dmm_reader trusts that files to be loaded are in fact valid
+.dmm files. Errors in the .dmm format will cause runtime errors.
+
Modular map loading is a system to allow maps to be generated with random variants by selecting from a set of pre-made modules. The system is designed to be as simple as possible for mappers to use, with a minimum of interaction with the code required.
+Implementation/obj/modular_map_root
+
This root object handled picking and loading in map modules. It has two variables, and one proc.
+
+
var/config_file - A string, points to a TOML configuration file, which is used to hold the information necessary to pull the correct map files and place them on the correct roots. This will be the same for all roots on a map.
+
var/key - A string, used to pull a list of .dmm files from the configuration file.
+
load_map() - Called asynchronously in the root's Initialize(). This proc creates a new instance of /datum/map_template/map_module, ingests the configuration file config_file points to, and picks a .dmm file path which maps to the root's key, by picking a random filename from among those which key maps to, and appending it to a folder path. This file path is passed into the map templace instance's load(), and the template takes over.
+
+
INITIALIZE_IMMEDIATE is used to ensure the ruins are loaded at the right time to avoid runtime errors related to lighting.
+/datum/map_template/map_module
+
This map templace subtype is responsible for loading in the module, it has two variables and two relevant procs.
+
+
var/x_offset and var/y_offset - Integers, used to store the offsets used to correctly align the module when it is loaded.
+
load() - Extends the functionality of the general map template's load() to allow a map to be specified at runtime. This means preload_size() must be called again here as the template's map file has been changed. The origin turf for the map to be loaded from is set using the offsets, and the map is loaded as per the parent.
+
preload_size() - Extends the functionality of the general map template's preload_size() to run the discover_offset proc, calculating the offset of /obj/modular_map_connector and setting the offset variables accordingly.
+
+/obj/modular_map_connector
+
This object is used only to determine the offsets to be used on loading, and has no other functionality.
+TOML configuration
+
This TOML file is used to map between a list of .dmm files and a string key. The file consists of two parts. The first is a line
+
directory = "_maps/etc/"
+
+
which points at a folder containing the .dmm files of the modules used in the map. The second is a series of tables
which contains the mapping between the key "example" and the list of filenames ["example_1.dmm", "example_2.dmm"].
+/datum/unit_test/modular_map_loader
+
This is the unit test for modular map loading. It performs two checks on every subtype of /obj/modular_map_root. First it checks if the file config_file points at, and if it does not the test is failed because the file does not exist. If it does exist, it then attempts to read the file, if this is null it means the fild is not valid TOML, and the test is failed because the TOML file is invalid.
+How-To
+
This section will cover the basics of how to use map modules as a mapper. If you want a concrete example to look at, the space ruin _maps/RandomRuins/SpaceRuins/DJstation.dmm and its associated code, configuration and modules employ all the techniques covered in this tutorial.
+The Main Map
+
First we need to create a map, as we usually would. Let's say we want to create a new space ruin foobar.dmm, and we put it in the appropriate folder as usual, _maps/RandomRuins/SpaceRuins/foobar.dmm. We now need to create three more things.
+
+
code/modules/ruins/spaceruin_code/foobar.dm - A code file like would be used to store any code specific to this map.
+
strings/modular_maps/foobar.toml- A configuration file, this will be looked at in more detail later.
+
_maps/RandomRuins/SpaceRuins/foobar/ - A new subfolder, which is where we will put the .dmm files for the modules.
+
+
In code/modules/ruins/spaceruin_code/foobar.dm we need to add a small piece of code to define a new modular map root type for our map, which should look like this
This means when we place root objects /obj/modular_map_root in our new map, we use this subtype that points to the correct configuration file.
+
When creating our main map, we place one of these roots in the location we want to generate a module at. Typically this would be placed at a natural landmark, such as a doorway. We then edit the varaibles of the placed root object, and set the key var to some string, let's use key = vault. Make the rest of the map, ensuring that every root you want to use a unique set of modules has a unique key.
+Module Maps
+
Now we need to make the modules to be placed on our roots. These will be saved in the folder we created earlier, _maps/RandomRuins/SpaceRuins/foobar/. Modules do not have to be the same size, so long as all modules will fit properly on the root without running into other parts of the map.
+
When making a module, you need to include a connector object /obj/modular_map_connector. When the module is loaded, it will be offset so this connector is placed on top of the root on the main map.
+
We will be making the first variant of our vault module, so we save this as vault_1.dmm, following the format [key]_[number].dmm. Keep doing this until all your modules have been made.
+
If you wish, you can also place another root on a module, if for some reason that module's position is dependent on the current one. IF you do this, make sure you've placed a root with the same key on every variant of the current module (unless you only want it to appear on certain varaints of this one.)
+Configuration
+
Now we go back to our configuration file strings/modular_maps/foobar.toml. Say we ended up using three different sets of modules in our map, vault, airlock and bathroom, each of which have two variants. We want our .toml file to look like this
directory = "_maps/RandomRuins/SpaceRuins/foobar/" points to the folder where our modules are stored.
+
[rooms.vault] identifies the following line as being the modules for a root with key = vault.
+
modules = ["vault_1.dmm", "vault_2.dmm"] specifies which map files within the folder are to be associated with this key.
+
Once this configuration is done, the map should be fully functional. Compile and run, place your map somewhere, and continue doing this until you have satisfied yourself that everything looks how you expected it to. Remember to do everything else you need to do when adding any new ruin, or whatever kind of map you made.
+Common Mistakes
+
+
My map has modules that didn't load!
+
+
Check your configuration is correct. Do the filenames given for the problem root match the names of the map files? Is the key specified in the configuration file the same as the one on the root in the map?
+
+
A module is loading in the wrong location!
+
+
Check the positioning of the connector is correct, and that only one is placed on the module.
+
+
My ruin is spawning too close to or overlapping with something!
+
+
Make sure your main map is large enough to fully contain the most expansive variation that can possibly be chosen.
+
+
Parts of my map are overlapping with each other!
+
+
Make sure modules placed adjacent or close to each other have no combination of variants which can overlap with each other, this may take some trial and error in complicated cases.
+
+
My map still isn't working and I don't know what's wrong!
+
+
Ping Thunder12345#9999 in the #coding-general channel of our discord if you need help with any problems.
DMM SPEC:
+DMM is split into two parts. First we have strings of text linked to lists of paths and their modifications (I will call this the cache)
+We call these strings "keys" and the things they point to members. Keys have a static length
DMM SPEC:
+DMM is split into two parts. First we have strings of text linked to lists of paths and their modifications (I will call this the cache)
+We call these strings "keys" and the things they point to members. Keys have a static length
+
The second part is a list of locations matched to a string of keys. (I'll be calling this the grid)
+These are used to lookup the cache we built earlier.
+We store location lists as grid_sets. the lines represent different things depending on the spec
+
In standard DMM (which you can treat as the base case, since it also covers weird modifications) each line
+represents an x file, and there's typically only one grid set per z level.
+The meme is you can look at a DMM formatted map and literally see what it should roughly look like
+This differs in TGM, and we can pull some performance from this
+
Any restrictions here also apply to TGM
+
/tg/ Restrictions:
+Paths have a specified order. First atoms in the order in which they should be loaded, then a single turf, then the area of the cell
+DMM technically supports turf stacking, but this is deprecated for all formats
TGM SPEC:
+TGM is a derevation of DMM, with restrictions placed on it
+to make it easier to parse and to reduce merge conflicts/ease their resolution
+
Requirements:
+Each "statement" in a key's details ends with a new line, and wrapped in (...)
+All paths end with either a comma or occasionally a {, then a new line
+Excepting the area, who is listed last and ends with a ) to mark the end of the key
+
{} denotes a list of variable edits applied to the path that came before the first {
+the final } is followed by a comma, and then a new line
+Variable edits have the form \tname = value;\n
+Except the last edit, which has no final ;, and just ends in a newline
+No extra padding is permitted
+Many values are supported. See parse_constant()
+Strings must be wrapped in "...", files in '...', and lists in list(...)
+Files are kinda susy, and may not actually work. buyer beware
+Lists support assoc values as expected
+These constants can be further embedded into lists
+One var edited list will be shared among all the things it is applied to
+
There can be no padding in front of, or behind a path
Simple animals 2.0, This time, let's really try to keep it simple. This basetype should purely be used as a base-level for implementing simplified behaviours for things such as damage and attacks. Everything else should be in components or AI behaviours.
Provides a dummy for unit_tests that functions like a normal human, but with a standardized appearance
+Copies the stock dna setup from the dummy/consistent type
Brutal damage caused by brute force (punching, being clubbed by a toolbox ect... this also accounts for pressure damage)
+Oxygen depravation damage (no air in lungs)
+Toxic damage caused by being poisoned or radiated
+Burn damage caused by being way too hot, too cold or burnt.
+Damage caused by being cloned or ejected from the cloner early. slimes also deal cloneloss damage to victims
+Used by [living/Bump()][/mob/living/proc/Bump] and [living/PushAM()][/mob/living/proc/PushAM] to prevent potential infinite loop.
CREDITS
+
+Initial code credit for this goes to Uristqwerty.
+Debugging, functionality, all comments and porting by Giacom.
+
+Everything about freelook (or what we can put in here) will be stored here.
+
+
+WHAT IS THIS?
+
+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.
+
+
+HOW IT WORKS
+
+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 Del().
+
+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.
+
+
+HOW IT UPDATES
+
+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.
+
+
+WHERE IS EVERYTHING?
+
+cameranet.dm = Everything about the cameranet datum.
+chunk.dm = Everything about the chunk datum.
+eye.dm = Everything about the AI and the AIEye.
+updating.dm = Everything about triggers that will update chunks.
+
Defining specific kinds of robots
+This is the subtype that gets created by robot suits. It's needed so that those kind of borgs don't have a useless cell in them
Definition of /obj/item/robot_model, which defines behavior for each model.
+Deals with the creation and deletion of modules (tools).
+Assigns modules and traits to a borg with a specific model selected.
Lobstrosities, the poster boy of charging AI mobs. Drops crab meat and bones.
+Outside of charging, it's intended behavior is that it is generally slow moving, but makes up for that with a knockdown attack to score additional hits.
Vatbeasts are creatures from vatgrowing and are literaly a beast in a vat, yup. They are designed to be a powerful mount roughly equal to a gorilla in power.
A strange alien creature capable of increasing its mass when threatened,
+giving it unmatched defensive capabilities temporarily. The rest of the
+time, it is quite fragile.
Shake the camera of the person viewing the mob SO REAL!
+Takes the mob to shake, the time span to shake for, and the amount of tiles we're allowed to shake by in tiles
+Duration isn't taken as a strict limit, since we don't trust our coders to not make things feel shitty. So it's more like a soft cap.
This document is a little dated but I believe it's accurate mostly (oranges 2019)
+MIAUW'S SAY REWRITE
+
This is a basic explanation of how say() works. Read this if you don't understand something.
+
The basic "flow" of say() is that a speaker says a message, which is heard by hearers. What appears on screen
+is constructed by each hearer separately, and not by the speaker.
+
This rewrite was needed, but is far from perfect. Report any bugs you come across and feel free to fix things up.
+Radio code, while very much related to saycode, is not something I wanted to touch, so the code related to that may be messy.
+
If you came here to see how to use saycode, all you will ever really need to call is say(message).
+To have things react when other things speak around them, add the HEAR_1 flag to their flags variable and
+override their Hear() proc.
+PROCS & VARIABLES
+
Here follows a list of say()-related procs and variables.
+
global procs
+ get_radio_span(freq)
+ Returns the span class associated with that frequency.
+
+ get_radio_name(freq)
+ Returns the name of that frequency.
+
+ get_hearers_in_view(R, atom/source)
+ Self-explanatory. Calls get_hear() and then calls recursive_hear_check on everything that get_hear() returns.
+
+ recursive_hear_check(atom/O)
+ Checks for hearers by looping through the contents of O and the contents of the contents of O and etc and checking
+ each object for the HEAR_1 flag. Returns a list of objects with the HEAR_1 flag.
+
+ get_hear(range, atom/source)
+ Like view(), but ignores luminosity.
+
+ message_spans_start(spans)
+ Turns each element of spans into a span class.
+
+ attach_spans(input, spans)
+ Attaches span classes around input.
+
+/atom/movable
+ flags
+ The HEAR_1 flag determines whether something is a hearer or not.
+ Hear() is only called on procs with this flag.
+
+ languages
+ languages live either in datum/languages_holder or in the mind.
+
+ verb_say/verb_ask/verb_exclaim/verb_yell/verb_sing
+ These determine what the verb is for their respective action. Used in say_quote().
+
+ say(message, bubble_type, var/list/spans, sanitize, datum/language/language, ignore_spam, forced)
+ Say() is the "mother-proc". It calls all the other procs required for speaking, but does little itself.
+ At the atom/movable level, say() just calls send_speech.
+
+ Hear(message, atom/movable/speaker, message_langs, raw_message, radio_freq, spans, message_mods)
+ This proc handles hearing. What it does varies. For mobs, it treats the message with hearer-specific things
+ like language and deafness, then outputs it to the hearer.
+
+ IMPORTANT NOTE: If radio_freq is not null, the code will assume that the speaker is virtual! (more info on this in the Radios section below)
+
+ send_speech(message, range, source, bubble_type, spans, list/message_mods)
+ This proc composes a list of hearers (things with the HEAR_1 flag + dead people) and calls Hear() on them.
+ Message treatment or composition of output are not done by this proc, these are handled by the rest of
+ say() and the hearer respectively.
+
+ lang_treat(message, atom/movable/speaker, message_langs, raw_message, spans, list/message_mods)
+ Modifies the message by comparing the languages of the speaker with the languages of the hearer.
+ Called on the hearer.
+ Passes message_mods to say_quote.
+
+ say_quote(input, spans, list/message_mods)
+ Adds a verb and quotes to a message. Also attaches span classes to a message.
+ Verbs are determined by verb_say/verb_ask/verb_yell/verb_sing variables. Called on the speaker.
+
+/mob
+ say_dead(message)
+ Sends a message to all dead people. Does not use Hear().
+
+ compose_message(message, atom/movable/speaker, message_langs, raw_message, radio_freq, spans, list/message_mods)
+ Composes the message mobs see on their screen when they hear something.
+
+ compose_track_href(message, atom/movable/speaker, message_langs, raw_message, radio_freq)
+ Composes the href tags used by the AI for tracking. Returns "" for all mobs except AIs.
+
+ compose_job(message, atom/movable/speaker, message_langs, raw_message, radio_freq)
+ Composes the job and the end tag for tracking hrefs. Returns "" for all mobs except AIs.
+
+ hivecheck()
+ Returns TRUE if the mob can hear and talk in the alien hivemind.
+
+ lingcheck()
+ Returns a bitflag representing who is trying to talk to the changeling hivemind.
+
+/mob/living
+ say(message, bubble_type, var/list/spans, sanitize, datum/language/languag, ignore_spam, forced)
+ The say() of mob_living is significantly more complex than that of objects.
+ Most of the extra code has to do with radios and message treatment.
+
+ send_speech(message, range, source, bubble_type, spans, list/message_mods)
+ mob/living's send_speech allows mobs one tile outside of the defined range to still hear the message,
+ but starred with the stars() proc.
+
+ check_emote(message)
+ Checks if the message begins with an * and is thus an emote.
+
+ can_speak(message)
+ Calls can_speak_basic() and can_speak_vocal(), if they both pass it passes
+
+ can_speak_basic(message)
+ Sees if the mob can "think" the message. Does not include vocalization or stat checks.
+ Vocalization checks are in can_speak_vocal, stat checks have to be done manually.
+ Called right before handle_inherent_channels()
+
+ can_speak_vocal(message)
+ Checks if the mob can vocalize their message. This is separate so, for example, muzzles don't block
+ hivemind chat.
+ Called right after handle_inherent_channels()
+
+ get_message_mods(message, list/message_mods)
+ Checks the start of the message for each of the components it could contain, stores that info in mods, and returns a trimmed list
+
+ treat_message(message)
+ What it says on the tin. Treats the message according to flags set on the mob.
+ Also handles captilization of the message
+
+ radio(message, list/message_mods = list(), spans)
+ Handles talking into radios. Uses a switch to determine what radio to speak into and in which manner to do so.
+
+ Return is a bitflag.
+ NOPASS = terminate say()
+ ITALICS = add italics to the message
+ REDUCE_RANGE = reduce the message range to one tile.
+
+ Return 0 if no radio was spoken into.
+ IMPORTANT: remember to call ..() and check for ..()'s return value properly!
+
+/datum/saymode
+ This is made to handle things like admin or alien chat.
+ Features that look like radio, but aren't quite
+
+ key
+ The key used to talk on this channel, in combination with : or .
+ mode
+ The UID we use for this channel
+
+ handle_message(message, list/message_mods, datum/language/language)
+ Intercepts say() after it's done all of it's message building.
+ If this returns true we stop say(), if it returns false we keep going
+
+RADIOS
+
I did not want to interfere with radios too much, but I sort of had to.
+For future generations, here is how radio code works:
+First, talk_into() is called on a radio. This sends a signal datum into the magic machine that is tcomms, which
+eventually results in broadcast_message() being called.
+
Broadcast_message() does NOT call say() on radios, but rather calls Hear() on everyone in range of a radio.
+This is because the system does not like repeating says.
+
Furthermore, I changed radios to not be in the SSpackets. Instead, they are in a global list called all_radios.
+This is an associative list, and the numbers as strings are the keys. The values are lists of radios that can hear said frequency.
+
To add a radio, simply use add_radio(radio, frequency). To remove a radio, use remove_radio(radio, frequency).
+To remove a radio from ALL frequencies, use remove_radio_all(radio).
+VIRTUAL SPEAKERS:
+
Virtual speakers are simply atom/movables with a few extra variables.
+If radio_freq is not null, the code will rely on the fact that the speaker is virtual. This means that several procs will return something:
+
(all of these procs are defined at the atom/movable level and return "" at that level.)
+ GetJob()
+ Returns the job string variable of the virtual speaker.
+ GetTrack()
+ Returns wether the tracking href should be fake or not.
+ GetSource()
+ Returns the source of the virtual speaker.
+ GetRadio()
+ Returns the radio that was spoken through by the source. Needed for AI tracking.
+
+
This is fairly hacky, but it means that I can advoid using istypes. It's mainly relevant for AI tracking and AI job display.
dead facehuggers, great for xeno ruins so you can have a cool ruin without spiraling the entire round into xenomorph hell. also, this is a terrible terrible artifact of time
This is a step by step guide for creating a MODsuit theme, skin and module.
+Theme
+
This is pretty simple, we go here and add a new definition, let's go with a Psychologist theme as an example.
+Their names should be like model names or use similar adjectives, like "magnate" or simply "engineering", so we'll go with "psychological".
+After that, it's good to decide what company is manufacturing the suit, and a basic description of what it offers, we'll write that down in the desc.
+So, let's our suit should be a low-power usage with lowered module capacity. We'd go with something like this.
+
/datum/mod_theme/psychological
+ name = "psychological"
+ desc = "A DeForest Medical Corporation power-saving psychological suit, limiting its' module capacity."
+
+
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.
+
/datum/mod_theme/psychological
+ name = "psychological"
+ desc = "A DeForest Medical Corporation power-saving psychological suit, limiting its' module capacity."
+ extended_desc = "DeForest Medical Corporation's prototype suit, based off the work of \
+ Nakamura Engineering. The suit has been modified to save power compared to regular suits, \
+ for operating at lower power levels, keeping people sane. As consequence, the capacity \
+ of the suit has decreased, not being able to fit many modules at all."
+ default_skin = "psychological"
+
+
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.
+Currently crew MODsuits should be lightly armored in combat relevant stats.
+
/datum/mod_theme/psychological
+ name = "psychological"
+ desc = "A DeForest Medical Corporation power-saving psychological suit, limiting its' module capacity."
+ extended_desc = "DeForest Medical Corporation's prototype suit, based off the work of \
+ Nakamura Engineering. The suit has been modified to save power compared to regular suits, \
+ for operating at lower power levels, keeping people sane. As consequence, the capacity \
+ of the suit has decreased, not being able to fit many modules at all."
+ default_skin = "psychological"
+ armor_type = /datum/armor/modtheme_psychological
+ complexity_max = DEFAULT_MAX_COMPLEXITY - 7
+ charge_drain = DEFAULT_CHARGE_DRAIN * 0.5
+
+
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.
+Let's go into here. It's as simple as adding a new suit type with the appropriate modules you want.
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.
+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.
+
/datum/mod_theme/psychological
+ name = "psychological"
+ desc = "A DeForest Medical Corporation power-saving psychological suit, limiting its' module capacity."
+ extended_desc = "DeForest Medical Corporation's prototype suit, based off the work of \
+ Nakamura Engineering. The suit has been modified to save power compared to regular suits, \
+ for operating at lower power levels, keeping people sane. As consequence, the capacity \
+ of the suit has decreased, not being able to fit many modules at all."
+ default_skin = "psychological"
+ armor_type = /datum/armor/modtheme_psychological
+ complexity_max = DEFAULT_MAX_COMPLEXITY - 7
+ charge_drain = DEFAULT_CHARGE_DRAIN * 0.5
+ variants = list(
+ "psychological" = list(
+ /obj/item/clothing/head/mod = list(
+ ),
+ /obj/item/clothing/suit/mod = list(
+ ),
+ /obj/item/clothing/gloves/mod = list(
+ ),
+ /obj/item/clothing/shoes/mod = list(
+ ),
+ ),
+ )
+
+
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.
+For example, if our helmet's icon covers the full head (like the research skin), we want to do something like 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.
+
/datum/mod_theme/psychological
+ name = "psychological"
+ desc = "A DeForest Medical Corporation power-saving psychological suit, limiting its' module capacity."
+ extended_desc = "DeForest Medical Corporation's prototype suit, based off the work of \
+ Nakamura Engineering. The suit has been modified to save power compared to regular suits, \
+ for operating at lower power levels, keeping people sane. As consequence, the capacity \
+ of the suit has decreased, not being able to fit many modules at all."
+ default_skin = "psychological"
+ armor_type = /datum/armor/modtheme_psychological
+ complexity_max = DEFAULT_MAX_COMPLEXITY - 7
+ charge_drain = DEFAULT_CHARGE_DRAIN * 0.5
+ variants = list(
+ "psychological" = list(
+ /obj/item/clothing/head/mod = list(
+ UNSEALED_LAYER = NECK_LAYER
+ UNSEALED_CLOTHING = SNUG_FIT,
+ SEALED_CLOTHING = THICKMATERIAL|STOPSPRESSUREDAMAGE,
+ UNSEALED_INVISIBILITY = HIDEFACIALHAIR,
+ SEALED_INVISIBILITY = HIDEMASK|HIDEEARS|HIDEEYES|HIDEFACE|HIDEHAIR|HIDESNOUT,
+ SEALED_COVER = HEADCOVERSMOUTH|HEADCOVERSEYES|PEPPERPROOF,
+ ),
+ /obj/item/clothing/suit/mod = list(
+ UNSEALED_CLOTHING = THICKMATERIAL,
+ SEALED_CLOTHING = STOPSPRESSUREDAMAGE,
+ SEALED_INVISIBILITY = HIDEJUMPSUIT,
+ ),
+ /obj/item/clothing/gloves/mod = list(
+ UNSEALED_CLOTHING = THICKMATERIAL,
+ SEALED_CLOTHING = STOPSPRESSUREDAMAGE,
+ ),
+ /obj/item/clothing/shoes/mod = list(
+ UNSEALED_CLOTHING = THICKMATERIAL,
+ SEALED_CLOTHING = STOPSPRESSUREDAMAGE,
+ ),
+ "psychotherapeutic" = list(
+ /obj/item/clothing/head/mod = list(
+ UNSEALED_CLOTHING = SNUG_FIT|THICKMATERIAL,
+ SEALED_CLOTHING = STOPSPRESSUREDAMAGE,
+ UNSEALED_INVISIBILITY = HIDEFACIALHAIR|HIDEMASK|HIDEEARS|HIDEEYES|HIDEFACE|HIDEHAIR|HIDESNOUT,
+ UNSEALED_COVER = HEADCOVERSMOUTH|HEADCOVERSEYES|PEPPERPROOF,
+ ),
+ /obj/item/clothing/suit/mod = list(
+ UNSEALED_CLOTHING = THICKMATERIAL,
+ SEALED_CLOTHING = STOPSPRESSUREDAMAGE,
+ SEALED_INVISIBILITY = HIDEJUMPSUIT,
+ ),
+ /obj/item/clothing/gloves/mod = list(
+ UNSEALED_CLOTHING = THICKMATERIAL,
+ SEALED_CLOTHING = STOPSPRESSUREDAMAGE,
+ ),
+ /obj/item/clothing/shoes/mod = list(
+ UNSEALED_CLOTHING = THICKMATERIAL,
+ SEALED_CLOTHING = STOPSPRESSUREDAMAGE,
+ ),
+ ),
+ )
+
+
Thus we finished our codeside. Now we go to the icon files for the suits and simply add our new skin's icons.
+Now our suit is finished. But let's say we want to give it an unique module.
+Module
+
So, for our psychological suit, let's say we want a module that heals the brain damage of everyone in range.
+As it's a medical module, we'll put it here. Let's start with the object definition.
+
/obj/item/mod/module/neuron_healer
+ name = "MOD neuron healer module"
+ desc = "A module made experimentally by DeForest Medical Corporation. On demand it releases waves \
+ that heal neuron damage of everyone nearby, getting their brains to a better state."
+ icon_state = "neuron_healer"
+
+
As we want this effect to be on demand, we probably want this to be an usable module. There are four types of modules:
+
+
Passive: These have a passive effect.
+
Togglable: You can turn these on and off.
+
Usable: You can use these for a one time effect.
+
Active: You can only have one selected at a time. It gives you a special click effect.
+
+
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, and are equippable to certain slots, so let's update our definition, and also add a new variable for how much brain damage we'll heal.
+
/obj/item/mod/module/neuron_healer
+ name = "MOD neuron healer module"
+ desc = "A module made experimentally by DeForest Medical Corporation. On demand it releases waves \
+ that heal neuron damage of everyone nearby, getting their brains to a better state."
+ icon_state = "neuron_healer"
+ module_type = MODULE_USABLE
+ complexity = 3
+ use_energy_cost = DEFAULT_CHARGE_DRAIN
+ incompatible_modules = list(/obj/item/mod/module/neuron_healer)
+ cooldown_time = 15 SECONDS
+ required_slot = list(ITEM_SLOT_HEAD)
+ var/brain_damage_healed = 25
+
+
Now, we want to override the on_use proc for our new effect. You can read about most procs and variables by reading this
+
/obj/item/mod/module/neuron_healer/on_use()
+
+
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.
Ok. so a quick rundown on how to make a program. This is kind of a shitty documentation, but oh well I was asked to.
+Base setup
+
This is how the base program is setup. the rest is mostly tgui stuff. I'll use the ntnetmonitor as a base
+
/datum/computer_file/program/ntnetmonitor
+ /// This is obviously the name of the file itself. not much to be said
+ filename = "ntmonitor"
+
+ /// This is sort of the official name. it's what shows up on the main menu
+ filedesc = "NTNet Diagnostics and Monitoring"
+
+ /// This is what the screen will look like when the program is active
+ program_icon_state = "comm_monitor"
+
+ /// This is a sort of a description, visible when looking on the ntnet
+ extended_desc = "This program is a dummy."
+
+ /// size of the program. Big programs need more hard drive space. Don't
+ /// make it too big though.
+ size = 12
+
+ /// If this is set, the program will not run without an ntnet connection,
+ /// and will close if the connection is lost. Mainly for primarily online
+ /// programs.
+ requires_ntnet = 1
+
+ /// This is access required to run the program itself. ONLY SET THIS FOR
+ /// SUPER SECURE SHIT. This also acts as transfer_access as well.
+ required_access = access_network
+
+ /// This is the access needed to download from ntnet or host on the ptp
+ /// program. This is what you want to use most of the time.
+ transfer_access = access_change_ids
+
+ /// If it's available to download on ntnet. pretty self explanatory.
+ available_on_ntnet = 1
+
+ /// ditto but on emagged syndie net. Use this for antag programs
+ available_on_syndinet = 0
+
+ /// Bitflags (PROGRAM_CONSOLE, PROGRAM_LAPTOP, PROGRAM_TABLET combination)
+ /// or PROGRAM_ALL. Use this to limit what kind of machines can run the
+ /// program. For example, comms program should be limited to consoles and laptops.
+ usage_flags = PROGRAM_ALL
+
+ /// This one is kinda cool. If you have the program minimized, this will
+ /// show up in the header of the computer screen. You can even have the
+ /// program change what the header is based on the situation! See `alarm.dm`
+ /// for an example.
+ var/ui_header = "downloader_finished.gif"
+
+Preinstalls
+
Now. for pre-installing stuff.
+
Primarily done for consoles, there's an install_programs() proc in the console presets file in the machines folder.
Basically, you want to do cpu.hard_drive.store_file(new/program path here()) and put it in the subtype's install_programs().
+Probably pretty self explanatory, but just in case.
+
Will probably be expanded when new features come around or I get asked to mention something.
This recharger exists only in borg built-in tablets. I would have tied it to the borg's cell but
+the program that displays laws should always be usable, and the exceptions were starting to pile.
Move speed is now calculated by using modifier datums which are added to mobs. Some of them (nonvariable ones) are globally cached, the variable ones are instanced and changed based on need.
+
This gives us the ability to have multiple sources of movespeed, reliabily keep them applied and remove them when they should be
+
THey can have unique sources and a bunch of extra fancy flags that control behaviour
+
Previously trying to update move speed was a shot in the dark that usually meant mobs got stuck going faster or slower
+
Movespeed modification list is a simple key = datum system. Key will be the datum's ID if it is overridden to not be null, or type if it is not.
+
DO NOT override datum IDs unless you are going to have multiple types that must overwrite each other. It's more efficient to use types, ID functionality is only kept for cases where dynamic creation of modifiers need to be done.
+
When update movespeed is called, the list of items is iterated, according to flags priority and a bunch of conditions
+this spits out a final calculated value which is used as a modifer to last_move + modifier for calculating when a mob
+can next move
Grabs a STATIC MODIFIER datum from cache. YOU MUST NEVER EDIT THESE DATUMS, OR IT WILL AFFECT ANYTHING ELSE USING IT TOO!
+
Used for variable slowdowns like hunger/health loss/etc, works somewhat like the old list-based modification adds. Returns the modifier datum if successful
+How this SHOULD work is:
+1. Ensures type_id_datum one way or another refers to a /variable datum. This makes sure it can't be cached. This includes if it's already in the modification list.
+2. Instantiate a new datum if type_id_datum isn't already instantiated + in the list, using the type. Obviously, wouldn't work for ID only.
+3. Add the datum if necessary using the regular add proc
+4. If any of the rest of the args are not null (see: slowdown), modify the datum
+5. Update if necessary
A unique version of c4 possessed only by the space ninja. Has a stronger blast radius.
+Can only be detonated by space ninjas with the bombing objective. Can only be set up where the objective says it can.
+When it primes, the space ninja responsible will have their objective set to complete.
Paper is now using markdown (like in github pull notes) for ALL rendering
+so we do loose a bit of functionality but we gain in easy of use of
+paper and getting rid of that crashing bug
(this*100)% of stored power outputted per tick.
+Doesn't change output total, lower numbers just increases the smoothing - taking longer to ramp up, and longer to drop away.
+4% means an accumulator, when starting up for the first time:
(this*100)% of stored power outputted per tick.
+Doesn't change output total, lower numbers just increases the smoothing - taking longer to ramp up, and longer to drop away.
+4% means an accumulator, when starting up for the first time:
+
+
emits 50% of what is being received after 40 seconds
+
emits 90% of what is being received after two minutes
+
emits 99% of what is being received after four minutes
+after having stored energy for at least 4-5 minutes, then dropping input to nothing:
+
emits 50% of what was previously being received after 40 seconds
+
emits 25% of what was previously being received after 79 seconds
+
emits 10% of what was previously being received after two minutes
+
emits 1% of what was previously being received after four minutes
BoH tear
+The BoH tear is a stationary singularity with a really high gravitational pull, which collapses briefly after being created
+The BoH isn't deleted for 10 minutes (only moved to nullspace) so that admins may retrieve the things back in case of a grief
BoH tear
+The BoH tear is a stationary singularity with a really high gravitational pull, which collapses briefly after being created
+The BoH isn't deleted for 10 minutes (only moved to nullspace) so that admins may retrieve the things back in case of a grief
Selects cinematic to play as part of the cult end depending on the outcome then ends the round afterward
+called either when narsie eats everyone, or when [/proc/begin_the_end()] reaches it's conclusion
by RemieRichards
+
+//////////////////////////////
+// CODER INFORMATIVE README //
+//////////////////////////////
+(See below for Mapper Friendly Readme)
+
+mapGenerator:
+ Desc: a mapGenerator is a master datum that collects
+ and syncs all mapGeneratorModules in it's modules list
+
+ defineRegion(var/turf/Start, turf/End, replace = 0)
+ Example: defineRegion(locate(1,1,1),locate(5,5,5),0)
+ Desc: Sets the bounds of the mapGenerator's "map"
+
+ defineCircularRegion(var/turf/Start, turf/End, replace = 0)
+ Example: defineCircularRegion(locate(1,1,1),locate(5,5,5),0)
+ Desc: Sets the mapGenerator's "map" as a circle, with center in the middle of Start and End's X,Y,Z coordinates
+
+ undefineRegion()
+ Example: undefineRegion()
+ Desc: Empties the map generator list
+
+ checkRegion(var/turf/Start, turf/End)
+ Example: checkRegion(locate(1,1,1), locate(5,5,5))
+ Desc: Checks if a rectangle between Start's coords and End's coords is valid
+ Existing Calls: mapGenerator/defineRegion(), mapGenerator/defineCircularRegion()
+
+ generate()
+ Example: generate()
+ Desc: Orders all mapGeneratorModules in the modules list to generate()
+
+ generateOneTurf(var/turf/T)
+ Example: generateOneTurf(locate(1,1,1))
+ Desc: Orders all mapGeneratorModules in the modules list to place(T) on this turf
+
+ initialiseModules()
+ Example: initialiseModules()
+ Desc: Replaces all typepaths in the modules list with actual /datum/map_generator/Module types
+ Existing Calls: mapGenerator/New()
+
+ syncModules()
+ Example: syncModules()
+ Desc: Sets the Mother variable on all mapGeneratorModules in the modules list to this mapGenerator
+ Existing Calls: initialiseModules(),generate(),generateOneTurf()
+
+
+mapGeneratorModule
+ Desc: a mapGeneratorModule has spawnableAtoms and spawnableTurfs lists
+ which it will generate on turfs in it's mother's map based on cluster variables
+
+ sync(var/datum/map_generator/mum)
+ Example: sync(a_mapGenerator_as_a_variable)
+ Desc: Sets the Mother variable to the mum argument
+ Existing Calls: mapGenerator/syncModules()
+
+ generate()
+ Example: generate()
+ Desc: Calls place(T) on all turfs in it's mother's map
+ Existing Calls: mapGenerator/generate()
+
+ place(var/turf/T)
+ Example: place(locate(1,1,1))
+ Desc: Run this mapGeneratorModule's effects on this turf (Spawning atoms, Changing turfs)
+ Existing Calls: mapGenerator/generate(), mapGenerator/generateOneTurf()
+
+ checkPlaceAtom(var/turf/T)
+ Example: checkPlace(locate(1,1,1))
+ Desc: Checks if the turf is valid for placing atoms
+ Existing Calls: place()
+
+
+////////////////////////////
+// MAPPER FRIENDLY README //
+////////////////////////////
+
+Simple Workflow:
+
+ 1. Define a/some mapGeneratorModule(s) to your liking, choosing atoms and turfs to spawn
+ #Note: I chose to split Turfs and Atoms off into separate modules, but this is NOT required.
+ #Note: A mapGeneratorModule may have turfs AND atoms, so long as each is in it's appropriate list
+
+ 2. Define a mapGenerator type who's modules list contains the typepath(s) of all the module(s) you wish to use
+ #Note: The order of the typepaths in the modules list is the order they will happen in, this is important for clusterCheckFlags.
+
+ 3. Take notes of the Bottom Left and Top Right turfs of your rectangular "map"'s coordinates
+ #Note: X,Y AND Z, Yes you can created 3D "maps" by having differing Z coords
+
+ 4. Create the mapGenerator type you created
+
+ 5. Call yourMapGeneratorType.defineRegion(locate(X,Y,Z), locate(X,Y,Z))
+ #Note: The above X/Y/Zs are the coordinates of the start and end turfs, the locate() simply finds the turf for the code
+
+ 6. Call yourMapGeneratorType.generate(), this will cause all the modules in the generator to build within the map bounds
+
+Option Suggestions:
+
+ * Have separate modules for Turfs and Atoms, this is not enforced, but it is how I have structured my nature example.
+ * If your map doesn't look quite to your liking, simply jiggle with the variables on your modules and the type probabilities
+ * You can mix and map premade areas with the procedural generation, for example mapping an entire flat land but having code generate just the grass tufts
+
+
+Using the Modules list
+
+ Simply think of it like each module is a layer in a graphics editing program!
+ To help you do this templates such as /mapGeneratorModule/bottomLayer have been provided with appropriate default settings.
+ These are located near the bottom of mapGeneratorModule.dm
+ you would order your list left to right, top to bottom, e.g:
+ modules = list(bottomLayer,nextLayer,nextNextLayer) etc.
+
+
+Variable Breakdown (For Mappers):
+
+ mapGenerator
+ map - INTERNAL, do not touch
+ modules - A list of typepaths of mapGeneratorModules
+
+ mapGeneratorModule
+ mother - INTERNAL, do not touch
+ spawnableAtoms - A list of typepaths and their probability to spawn, eg: spawnableAtoms = list(/obj/structure/flora/tree/pine = 30)
+ spawnableTurfs - A list of typepaths and their probability to spawn, eg: spawnableTurfs = list(/turf/unsimulated/floor/grass = 100)
+ clusterMax - The max range to check for something being "too close" for this atom/turf to spawn, the true value is random between clusterMin and clusterMax
+ clusterMin - The min range to check for something being "too close" for this atom/turf to spawn, the true value is random between clusterMin and clusterMax
+ clusterCheckFlags - A Bitfield that controls how the cluster checks work, All based on clusterMin and clusterMax guides
+ allowAtomsOnSpace - A Boolean for if we allow atoms to spawn on space tiles
+
+ clusterCheckFlags flags:
+ CLUSTER_CHECK_NONE 0 //No checks are done, cluster as much as possible
+ CLUSTER_CHECK_DIFFERENT_TURFS 2 //Don't let turfs of DIFFERENT types cluster
+ CLUSTER_CHECK_DIFFERENT_ATOMS 4 //Don't let atoms of DIFFERENT types cluster
+ CLUSTER_CHECK_SAME_TURFS 8 //Don't let turfs of the SAME type cluster
+ CLUSTER_CHECK_SAME_ATOMS 16 //Don't let atoms of the SAME type cluster
+
+ CLUSTER_CHECK_SAMES 24 //Don't let any of the same type cluster
+ CLUSTER_CHECK_DIFFERENTS 6 //Don't let any different types cluster
+ CLUSTER_CHECK_ALL_TURFS 10 //Don't let ANY turfs cluster same and different types
+ CLUSTER_CHECK_ALL_ATOMS 20 //Don't let ANY atoms cluster same and different types
+
+ CLUSTER_CHECK_ALL 30 //Don't let anything cluster, like, at all
+
Gun has a bolt, it stays closed while not cycling. The gun must be racked to have a bullet chambered when a mag is inserted.
+Example: c20, shotguns, m90
Gun has no moving bolt mechanism, it cannot be racked. Also dumps the entire contents when emptied instead of a magazine.
+Example: Break action shotguns, revolvers
Gun has a bolt, it is open when ready to fire. The gun can never have a chambered bullet with no magazine, but the bolt stays ready when a mag is removed.
+Example: Some SMGs, the L6
The basic chemical bomb proc.
+Combines a set of reagent holders into one holder and reacts it.
+If there are any reagents left over it spreads them across the surrounding environment.
+The maximum volume of the holder is temporarily adjusted to allow for reactions which increase total volume to work at full effectiveness.
+The maximum volume of the holder is then reset to its original value.
Exposes all accessible atoms within some distance of an epicenter to some reagents.
+Does not clear the source reagent holder; that must be done manually if it is desired.
Generate the big list of reagent based reactions.
+style='background-color:#FFEE88;'|{{anchor|Synthetic-derived growth factor}}Synthetic-derived growth factor▮
How to make fermi reactions from a code perspective
+
+
+
+
+
How purity works
+
Purity by default only splits on a mob’s consumption unless reaction_flags in the recipe is set to one of the CLEAR_CONVERT defines. Here is a bad flowchart for the on mob process.
+
I am not good at flowcharts sorry.
+
+
Essentially
+For purity:
+If 1: normal
+If above inverse_chem_val: normal + impure
+If below: inverse
+How reactions mechanics work
+
For the effects starting/during/at the end of a reaction see below:
+
+
Maybe this makes no sense.
+
In brief:
+
Holder.dm now sets up reactions, while equilibrium.dm runs them. Holder itself is processed when there is a list of reactions, but the equilibrium does the calculating. In essence, it holds onto a list of objects to run. Handle_reactions() is used to update the reaction list, with a few checks at the start to prevent any unnecessary updates.
+When a reaction is detected:
+
+
If it’s REACTION_INSTANT then it’ll use a method similar to the old mechanics.
+
If not then it’ll set up an equilibrium, which checks to see if the reaction is valid on creation.
+
If it’s valid, then on_reaction is called.
+
If the reaction’s temperature is over the overheat_temp overheated() is called
+
When equilibriums detect they’re invalid, they flag for deletion and holder.dm deletes them.
+
If there’s a list of reactions, then the holder starts processing.
+
+When holder is processing:
+
+
Each equilibrium is processed, and it handles it’s own reaction. For each step it handles every reaction.
+
At the start, the equilibrium checks it’s conditions and calculates how much it can make in this step.
+
It checks the temp, reagents and catalyst.
+
If it’s overheated, call overheated()
+
If it’s too impure call overly_impure()
+
The offset of optimal pH and temp is calculated, and these correlate with purity and yield.
+
+How a holder stops reacting:
+
When one of the checks fails in the equilibrium object, it is flagged for deletion. The holder will detect this and call reaction_finish() and delete the equilibrium object – ending that reaction.
+Recipe and processing mechanics
+
Lets go over the reaction vars below. These can be edited and set on a per chemical_reaction basis
+
/datum/chemical_reaction
+ ...
+ var/required_temp = 100
+ var/optimal_temp = 500 // Upper end for above
+ var/overheat_temp = 900 // Temperature at which reaction explodes - If any reaction is this hot, it procs overheated()
+ var/optimal_ph_min = 5 // Lowest value of pH determining pH a 1 value for pH based rate reactions (Plateu phase)
+ var/optimal_ph_max = 9 // Higest value for above
+ var/determin_ph_range = 4 // How far out pH wil react, giving impurity place (Exponential phase)
+ var/temp_exponent_factor = 2 // How sharp the temperature exponential curve is (to the power of value)
+ var/ph_exponent_factor = 1 // How sharp the pH exponential curve is (to the power of value)
+ var/thermic_constant = 1 // Temperature change per 1u produced
+ var/H_ion_release = 0.01 // pH change per 1u reaction
+ var/rate_up_lim = 20 // Optimal/max rate possible if all conditions are perfect
+ var/purity_min = 0.15 // If purity is below 0.15, it calls OverlyImpure() too. Set to 0 to disable this.
+ var/reaction_flags // bitflags for clear conversions; REACTION_CLEAR_IMPURE, REACTION_CLEAR_INVERSE, REACTION_CLEAR_RETAIN, REACTION_INSTANT
+
+How temperature ranges are set and how reaction rate is determined
+
Reaction rates are determined by the current temperature of the reagents holder. There are a few variables related to this:
+
/datum/chemical_reaction
+ var/required_temp = 100
+ var/optimal_temp = 500 // Upper end for above
+ var/overheat_temp = 900 // Temperature at which reaction explodes - If any reaction is this hot, it procs overheated()
+ var/temp_exponent_factor = 2 // How sharp the temperature exponential curve is (to the power of value)
+ var/rate_up_lim = 20 // Optimal/max rate possible if all conditions are perfect
+
+
The amount added is based off the recipies’ required_temp, optimal_temp, overheat_temp and temp_exponent_factor. See below:
+
+
the y axis is the normalised value of growth, which is then muliplied by the rate_up_lim. You can see that temperatures below the required_temp produce no result (the reaction doesn't start, or if it is reacting, the reaction will stop). Between the required and optimal is a region that is defined by the temp_exponent_factor, so in this case the value is ^2, so we see exponential growth. Between the optimal_temp and the overheat_temp is the optimal phase - where the rate factor is 1. After that it continues to react, but will call overheated() per timestep. Presently the default for overheated() is to reduce the yield of the product (i.e. it's faster but you get less). The rate_up_lim is the maximum rate the reaction can go at optimal temperatures, so in this case a rate factor of 1 i.e. a temperature between 500+ will produce 10u, or a temperature of 400 will roughly produce 4u per step (independant of product ratio produced, if you put 10, it will only create 10 maximum regardless of how much product is defined in the results list).
+How pH ranges are set and what pH mechanics do
+
Optimal pH ranges are set on a per recipe basis - though at the moment all recipes use a default recipe, so they all have the same window (except for the buffers). Hopefully either as a community effort/or in future PRs we can create unique profiles for the present reactions in the game.
+
As for how you define the reaction variables for a reaction, there are a few new variables for the chemical_recipe datum. I'll go over specifically how pH works for the default reaction.
+
/datum/chemical_reaction
+ ...
+ var/optimal_ph_min = 5 // Lowest value of pH determining pH a 1 value for pH based rate reactions (Plateu phase)
+ var/optimal_ph_max = 9 // Higest value for above
+ var/determin_ph_range = 4 // How far out pH wil react, giving impurity place (Exponential phase)
+ var/ph_exponent_factor = 1 // How sharp the pH exponential curve is (to the power of value)
+ var/purity_min = 0.15 // If purity is below 0.15, it calls overly_impure(). In addition, if the product's purity is below this value at the end, the product will be 100% converted into the reagent's failed_chem. Set to 0 to disable this.
+
+
For this default reaction, the curve looks like this:
+
+
The y axis is the purity of the product made for that time step. This is recalculated based off the beaker's sum pH for every tick in the reaction. The rate in which your product is made based off the temperature (If you want me to describe that too I can.) So say our reaction has 10u of a purity 1 of product in there, and for our step we're making another 10u with our pH at (roughly) 3, from the curve our purity is (roughly) 0.5. So we will be adding 10u of 0.5 purity to 10u of 1 purity, resulting in 20u of 0.75 purity product. (Though - to note the reactant's purities also modify the purity of volume created on top of this).
+
If you're designing a reaction you can define an optimal range between the OptimalpHMin to OptimalpHMax (5 - 7 in this case) and a deterministic region set by the ReactpHLim (5 - 4, 9 + 4 aka between 1 to 5 and 9 to 13). This deterministic region is exponential, so if you set it to 2 then it’ll exponentially grow, but since our CurveSharpph = 1, it’s linear (basically normalise the range in the determinsitic region, then put that to the power of CurveSharppH). Finally values outside of these ranges will prevent reactions from starting, but if a reaction drifts out during a reaction, the purity of volume created for each step will be 0 (It does not stop ongoing reactions). It’s entirely possible to design a reaction without a deterministic or optimal phase if you wanted.
+
Though to note; if your purity dips below the PurityMin of a reaction it’ll call the overly_impure() function – which by default reduces the purity of all reagents in the beaker. Additionally, if the purity at the end of a reaction is below the PurityMin, it’ll convert into the failed chem defined by the product’s failed_chem defined in it's reagent datum. For default the PurityMin is 0.15, and is pretty difficult to fail. This is all customisable however, if you wanted to use these hooks to design a even more unique reaction, just don’t call the parent proc when using methods.
+Conditional changes in reagents datum per timestep
+
/datum/chemical_reaction
+ ...
+ var/thermic_constant = 1 // Temperature change per 1u produced
+ var/H_ion_release = 0.01 // pH change per 1u reaction
+
+
The thermic_constant is how much the temperature changes per u created, so for 10u created the temperature will increase by 10K. The H_ion_release is how much the pH changes per u created, for 10u created the pH will increase by 0.1. During a reaction this is the only factor in pH changes - presently the addition/removal of reagents tie to the reaction won't affect this, though other reactions ongoing in the beaker will also affect pH, as well as the removal/addition of reagents outside of the reaction.
+Reaction flags
+
Reaction_flags can be used to set these defines:
+
#define REACTION_CLEAR_IMPURE //Convert into impure/pure on reaction completion in the datum/reagents holder instead of on consumption
+#define REACTION_CLEAR_INVERSE //Convert into inverse on reaction completion when purity is low enough in the datum/reagents holder instead of on consumption
+#define REACTION_CLEAR_RETAIN //Clear converted chems retain their purities/inverted purities. Requires 1 or both of the above. This is so that it can split again after splitting from a reaction (i.e. if your impure_chem or inverse_chem has it's own impure_chem/inverse_chem and you want it to split again on consumption).
+#define REACTION_INSTANT //Used to create instant reactions
+
+/datum/chemical_reaction
+ var/reaction_flags
+
+
For REACTION_CLEAR – this causes the purity mechanics to resolve in the beaker at the end of the reaction, instead of when added to a mob.
+A note on cold recipies
+
Is_cold_recipie requires you to set your overheat_temp and optimal_temp descend instead.
+Eg:
/datum/reagent
+ /// pH of the reagent
+ var/ph = 7
+ ///Purity of the reagent
+ var/purity = 1
+ ///the purity of the reagent on creation (i.e. when it's added to a mob and it's purity split it into 2 chems; the purity of the resultant chems are kept as 1, this tracks what the purity was before that)
+ var/creation_purity = 1
+ //impure chem values (see fermi_readme.dm for more details):
+ var/impure_chem = /datum/reagent/impurity // What chemical path is made when metabolised as a function of purity
+ var/inverse_chem_val = 0.2 // If the impurity is below 0.5, replace ALL of the chem with inverse_chem upon metabolising
+ var/inverse_chem = /datum/reagent/impurity/toxic // What chem is metabolised when purity is below inverse_chem_val
+ var/failed_chem = /datum/reagent/consumable/failed_reaction //what chem is made at the end of a reaction IF the purity is below the recipies purity_min
+ var/chemical_flags
+
+
+
pH is the innate pH of the reagent and is used to calculate the pH of a reagents datum on addition/removal. This does not change and is a reference value. The reagents datum pH changes.
+
purity is the INTERNAL value for splitting. This is set to 1 after splitting so that it doesn't infinite split
+
creation_purity is the purity of the reagent on creation. This won't change. If you want to write code that checks the purity in any of the methods, use this.
+
impure_chem is the datum type that is created provided that it's creation_purity is above the inverse_chem_val. When the reagent is consumed it will split into this OR if the associated datum/chemical_recipe has a REACTION_CLEAR_IMPURE flag it will split at the end of the reaction in the datum/reagents holder
+
inverse_chem_val if a reagent's purity is below this value it will 100% convert into inverse_chem. If above it will split into impure_chem. See the note on purity effects above
+
inverse_chem is the datum type that is created provided that it's creation_purity is below the inverse_chem_val. When the reagent is consumed it will 100% convert into this OR if the associated datum/chemical_recipe has a REACTION_CLEAR_INVERSE flag it will 100% convert at the end of the reaction in the datum/reagents holder
+
failed_chem is the chem that the product is 100% converted into if the purity is below the associated datum/chemical_recipies' PurityMin AT THE END OF A REACTION.
+
+
When writing any reagent code ALWAYS use creation_purity. Purity is kept for internal mechanics only and won’t reflect the purity on creation.
+
See above for purity mechanics, but this is where you set the reagents that are created. If you’re making an impure reagent I recommend looking at impure_reagents.dm to see how they’re set up and consider using the datum/reagents/impure as a parent.
+
The flags you can set for var/chemical_flags are:
+
#define REAGENT_DEAD_PROCESS (1<<0) //allows on_mob_dead() if present in a dead body
+#define REAGENT_DONOTSPLIT (1<<1) //Do not split the chem at all during processing - ignores all purity effects
+#define REAGENT_INVISIBLE (1<<2) //Doesn't appear on handheld health analyzers.
+#define REAGENT_SNEAKYNAME (1<<3) //When inverted, the inverted chem uses the name of the original chem
+#define REAGENT_SPLITRETAINVOL (1<<4) //Retains initial volume of chem when splitting for purity effects
+
+/datum/reagent
+ var/chemical_flags
+
+
While you might think reagent_flags is a more sensible name - it is already used for beakers. Hopefully this doesn't trip anyone up.
+Relivant vars from the holder.dm / reagents datum
+
There are a few variables that are useful to know about
+
/datum/reagents
+ /// Current temp of the holder volume
+ var/chem_temp = 150
+ ///pH of the whole system
+ var/ph = CHEMICAL_NORMAL_PH //aka 7
+ ///cached list of reagents
+ var/list/datum/reagent/previous_reagent_list = new/list()
+ ///Hard check to see if the reagents is presently reacting
+ var/is_reacting = FALSE
+
+
+
chem_temp is the temperature used in the datum/chemical_recipe
+
pH is a result of the sum of all reagents, as well as any changes from buffers and reactions. This is the pH used in datum/chemical_recipe.
+
isReacting is a bool that can be used outside to ensure that you don't touch a reagents that is reacting.
+
previous_reagent_list is a list of the previous reagents (just the typepaths, not the objects) that was present on the last handle_reactions() method. This is to prevent pointless method calls.
base class for addiction, handles when you become addicted and what the effects of that are. By default you become addicted when you hit a certain threshold, and stop being addicted once you go below another one.
Honorbound God
+Makes the person holy, but they now also have to follow the honorbound code (CBT). Actually earns favor, convincing others to uphold the code (tm) is not easy
How much damage is dealt per healing done for the stabilized back.
+This multiplier is applied to prevent two people from converting each other's damage away.
How much damage is dealt per healing done for the stabilized back.
+This multiplier is applied to prevent two people from converting each other's damage away.
Helper proc that tests to ensure all whiteship templates can spawn at their docking port, and logs their sizes
+This should be a unit test, but too much of our other code breaks during shuttle movement, so not yet, not yet.
This step requires and uses a reagent to finish itself. This step is great as a last step since reagents can't be recovered from disassembly.
+This alternatively can also transfer to a container inside the crafting assembly too!
This is the base action for how many of the game's
+spells (and spell adjacent) abilities function.
+These spells function off of a cooldown-based system.
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.
+
+
_definitions.dm contains defines needed across DMAPI internals.
+
byond_world_export.dm contains the default /datum/tgs_http_handler implementation which uses world.Export().
+
core.dm contains the implementations of the /world/proc/TgsXXX() procs. Many map directly to the /datum/tgs_api functions. It also contains the /datum selection and setup code.
+
datum.dm contains the /datum/tgs_api declarations that all APIs must implement.
+
tgs_version.dm contains the /datum/tgs_version definition
Returns a UI status such that users adjacent to source will be able to interact,
+far away users will be able to see, and anyone farther won't see anything.
+Dead users will receive updates no matter what, though you likely want to add
+a [ui_status_only_living] check for finer observer interactions.
Returns a UI status such that users with debilitating conditions, such as
+being dead or not having power for silicons, will not be able to interact.
+Being dead will disable UI, being incapacitated will continue updating it,
+and anything else will make it interactive.
Returns a UI status such that silicons will be able to interact with whatever
+they would have access to if this was a machine. For example, AIs can
+interact if there's cameras with wireless control is enabled.
On their most basic level, when UNIT_TESTS is defined, all subtypes of /datum/unit_test will have their Run proc executed. From here, if Fail is called at any point, then the tests will report as failed.
+How do I write one?
+
+
Find a relevant file.
+
+
All unit test related code is in code/modules/unit_tests. If you are adding a new test for a surgery, for example, then you'd open surgeries.dm. If a relevant file does not exist, simply create one in this folder, then #include it in _unit_tests.dm.
+
+
Create the unit test.
+
+
To make a new unit test, you simply need to define a /datum/unit_test.
+
For example, let's suppose that we are creating a test to make sure a proc square correctly raises inputs to the power of two. We'd start with first:
+
/datum/unit_test/square/Run()
+
+
This defines our new unit test, /datum/unit_test/square. Inside this function, we're then going to run through whatever we want to check. Tests provide a few assertion functions to make this easy. For now, we're going to use TEST_ASSERT_EQUAL.
+
/datum/unit_test/square/Run()
+ TEST_ASSERT_EQUAL(square(3), 9, "square(3) did not return 9")
+ TEST_ASSERT_EQUAL(square(4), 16, "square(4) did not return 16")
+
+
As you can hopefully tell, we're simply checking if the output of square matches the output we are expecting. If the test fails, it'll report the error message given as well as whatever the actual output was.
+
+
Run the unit test
+
+
Open code/_compile_options.dm and uncomment the following line.
+
//#define UNIT_TESTS //If this is uncommented, we do a single run though of the game setup and tear down process with unit tests in between
+
+
Then, run daedalus.dmb in Dream Daemon. Don't bother trying to connect, you won't need to. You'll be able to see the outputs of all the tests. You'll get to see which tests failed and for what reason. If they all pass, you're set!
+How to think about tests
+
Unit tests exist to prevent bugs that would happen in a real game. Thus, they should attempt to emulate the game world wherever possible. For example, the quick swap sanity test emulates a real scenario of the bug it fixed occurring by creating a character and giving it real items. The unrecommended alternative would be to create special test-only items. This isn't a hard rule, the reagent method exposure tests create a test-only reagent for example, but do keep it in mind.
+
Unit tests should also be just that--testing units of code. For example, instead of having one massive test for reagents, there are instead several smaller tests for testing exposure, metabolization, etc.
+The unit testing API
+
You can find more information about all of these from their respective doc comments, but for a brief overview:
+
/datum/unit_test - The base for all tests to be ran. Subtypes must override Run(). New() and Destroy() can be used for setup and teardown. To fail, use TEST_FAIL(reason).
+
/datum/unit_test/proc/allocate(type, ...) - Allocates an instance of the provided type with the given arguments. Is automatically destroyed when the test is over. Commonly seen in the form of var/mob/living/carbon/human/human = allocate(/mob/living/carbon/human).
+
TEST_FAIL(reason) - Marks a failure at this location, but does not stop the test.
+
TEST_ASSERT(assertion, reason) - Stops the unit test and fails if the assertion is not met. For example: TEST_ASSERT(powered(), "Machine is not powered").
+
TEST_ASSERT_NOTNULL(a, message) - Same as TEST_ASSERT, but checks if !isnull(a). For example: TEST_ASSERT_NOTNULL(myatom, "My atom was never set!").
+
TEST_ASSERT_NULL(a, message) - Same as TEST_ASSERT, but checks if isnull(a). If not, gives a helpful message showing what a was. For example: TEST_ASSERT_NULL(delme, "Delme was never cleaned up!").
+
TEST_ASSERT_EQUAL(a, b, message) - Same as TEST_ASSERT, but checks if a == b. If not, gives a helpful message showing what both a and b were. For example: TEST_ASSERT_EQUAL(2 + 2, 4, "The universe is falling apart before our eyes!").
+
TEST_ASSERT_NOTEQUAL(a, b, message) - Same as TEST_ASSERT_EQUAL, but reversed.
+
TEST_FOCUS(test_path) - Only run the test provided within the parameters. Useful for reducing noise. For example, if we only want to run our example square test, we can add TEST_FOCUS(/datum/unit_test/square). Should never be pushed in a pull request--you will be laughed at.
+Final Notes
+
+
Writing tests before you attempt to fix the bug can actually speed up development a lot! It means you don't have to go in game and folllow the same exact steps manually every time. This process is known as "TDD" (test driven development). Write the test first, make sure it fails, then start work on the fix/feature, and you'll know you're done when your tests pass. If you do try this, do make sure to confirm in a non-testing environment just to double check.
+
Make sure that your tests don't accidentally call RNG functions like prob. Since RNG is seeded during tests, you may not realize you have until someone else makes a PR and the tests fail!
+
Do your best not to change the behavior of non-testing code during tests. While it may sometimes be necessary in the case of situations such as the above, it is still a slippery slope that can lead to the code you're testing being too different from the production environment to be useful.
Only run the test provided within the parentheses
+This is useful for debugging when you want to reduce noise, but should never be pushed
+Intended to be used in the manner of TEST_FOCUS(/datum/unit_test/math)
This must be the last test to run due to the inherent nature of the test iterating every single tangible atom in the game
+and qdeleting all of them (while taking long sleeps to make sure the garbage collector fires properly) taking a large amount of time.
This must be the last test to run due to the inherent nature of the test iterating every single tangible atom in the game
+and qdeleting all of them (while taking long sleeps to make sure the garbage collector fires properly) taking a large amount of time.
Only run the test provided within the parentheses
+This is useful for debugging when you want to reduce noise, but should never be pushed
+Intended to be used in the manner of TEST_FOCUS(/datum/unit_test/math)
Tests to make sure humans can breath in normal situations
+Built to prevent regression on an issue surrounding QUANTIZE() and BREATH_VOLUME
+See the comment on BREATH_VOLUME for more details
This set of tests is focused on ensuring the stability of preference dummies
+And by extension the hacks built to make them fast
+Organ consistency, object pooling via the wardrobe ss, etc
Unit test to ensure seeds can properly be added to the plant seed extractor through multiple methods.
+This only tests transferring seeds to the storage, it does NOT test creating seeds.
See #66313 and #60901. outfit_sanity used to runtime whenever you had two mergable sheets in either hand. Previously, this only had a 3% chance of occuring. Now 100%.
This runs some simple speech tests on a speaker and listener and determines if a person can hear whispering or speaking as they are moved a distance away
This is an example for screenshot tests, and a meta-test to make sure they work in the success case.
+It creates a picture that is red on the left side, green on the other.
This folder contains the results for screenshot tests. Screenshot tests make sure an icon looks the same as it did before a change to prevent regressions.
+
You can create one by simply using the test_screenshot proc.
+
This example test screenshots a red image and keeps it.
+
/// This is an example for screenshot tests, and a meta-test to make sure they work in the success case.
+/// It creates a picture that is red on the left side, green on the other.
+/datum/unit_test/screenshot_basic
+
+/datum/unit_test/screenshot_basic/Run()
+ var/icon/red = icon('icons/blanks/32x32.dmi', "nothing")
+ red.Blend(COLOR_RED, ICON_OVERLAY)
+ test_screenshot("red", red)
+
+
Unfortunately, screenshot tests are sanest to test through a pull request directly, due to limitations with both DM and GitHub.
Every species should use a species ID unique to it and it alone. This test runs through every subtype of /datum/species, and checks for a species ID.
+Every ID is written to a list, gathered_species_ids, and if a previously written ID is written again, this test will fail.
Goes through every subtype of /obj/item/stack to check for a singular name, var/singular_name.
+Everything within the blacklist does not need to be tested because it exists to be overriden.
+This test will fail if a subtype of /obj/item/stack is missing a singular name.
Shield processing
+*An object to take the hit for us when using the Durand's defense mode.
+It is spawned in during the durand's initilization, and always stays on the same tile.
+Normally invisible, until defense mode is actvated. When the durand detects an attack that should be blocked, the
+attack is passed to the shield. The shield takes the damage, uses it to calculate charge cost, and then sets its
+own integrity back to max. Shield is automatically dropped if we run out of power or the user gets out.
Mechs focus is on a more heavy-but-slower damage approach
+For this they have the following mechanics
+Backstab
+
Basically the tldr is that mechs are less flexible so we encourage good positioning, pretty simple
+Armor modules
+
Pretty simple, adds armor, you can choose against what
+Internal damage
+
When taking damage will force you to take some time to repair, encourages improvising in a fight
+Targetting different def zones will damage them to encurage a more strategic approach to fights
+where they target the "dangerous" modules
only has cyborg flashing since felinid moving spikes time dilation when spammed and the other two features of laserpointers would be unbalanced when spammed
+no stunning, just a blind
+laserpointer image
A handheld device with several buttons.
+In game, this translates to having different signals for normal usage, alt-clicking, and ctrl-clicking when in your hand.
A datum instantiated has no physical world prescence, use an atom if you want something
+that actually lives in the world
+
Be very mindful about adding variables to this class, they are inherited by every single
+thing in the entire game, and so you can easily cause memory usage to rise a lot with careless
+use of variables at this level
Generate a tag for this /datum, if it implements one
+Should be called as early as possible, best would be in New, to avoid weakref mistargets
+Really just don't use this, you don't need it, global lists will do just fine MOST of the time
+We really only use it for mobs to make id'ing people easier
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
Return text from this proc to provide extra context to hard deletes that happen to it
+Optional, you should use this for cases where replication is difficult and extra context is required
Gets the flat list that can be passed in a new /type(argslist(retval)) expression to recreate the datum. Must only return a list containing values that can be JATUM serialized
This proc is called on a datum on every "cycle" if it is being processed by a subsystem. The time between each cycle is determined by the subsystem's "wait" setting.
+You can start and stop processing a datum using the START_PROCESSING and STOP_PROCESSING defines.
If this is non zero then the object has been garbage collected and is awaiting either
+a hard del by the GC subsystme, or to be autocollected (if it has no references)
This should be overridden to remove all references pointing to the object being destroyed, if
+you do override it, make sure to call the parent and return it's return value by default
+
Return an appropriate QDEL_HINT to modify handling of your deletion;
+in most cases this is QDEL_HINT_QUEUE.
+
The base case is responsible for doing the following
+
+
Erasing timers pointing to this datum
+
Erasing compenents on this datum
+
Notifying datums listening to signals from this datum that we are going away
Generate a tag for this /datum, if it implements one
+Should be called as early as possible, best would be in New, to avoid weakref mistargets
+Really just don't use this, you don't need it, global lists will do just fine MOST of the time
+We really only use it for mobs to make id'ing people easier
GetComponent
+
+
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:
+
+
datum/component/c_type The typepath of the component you want to get a reference to
+
GetComponents
+
+
Get all components of a given type that are attached to this datum
+
Arguments:
+
+
c_type The component type path
+
GetExactComponent
+
+
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:
+
+
datum/component/c_type The typepath of the component you want to get a reference to
+
RegisterSignal
+
+
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:
+
+
datum/target The target to listen for signals from
+
sig_type_or_types Either a string signal name, or a list of signal names (strings)
+
proctype The proc to call back when the signal is emitted
+
override If a previous registration exists you must explicitly set this
+
TakeComponent
+
+
Transfer this component to another parent
+
Component is taken from source datum
+
Arguments:
+
+
datum/component/target Target datum to transfer to
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
_AddElement
+
+
Finds the singleton for the element type given and attaches it to src
_LoadComponent
+
+
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:
+
+
component_type The typepath of the component to create or return
+
... additional arguments to be passed when creating the component if it does not exist
+
_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
+
Will runtime if used on datums with an empty component list
Only override this if you know what you're doing. You do not know what you're doing
+This is a threat
deserialize_json
+
+
Deserializes from JSON. Does not parse type.
deserialize_list
+
+
Accepts a LIST from deserialize_datum. Should return src or another datum.
dump_harddel_info
+
+
Return text from this proc to provide extra context to hard deletes that happen to it
+Optional, you should use this for cases where replication is difficult and extra context is required
jatum_new_arglist
+
+
Gets the flat list that can be passed in a new /type(argslist(retval)) expression to recreate the datum. Must only return a list containing values that can be JATUM serialized
process
+
+
This proc is called on a datum on every "cycle" if it is being processed by a subsystem. The time between each cycle is determined by the subsystem's "wait" setting.
+You can start and stop processing a datum using the START_PROCESSING and STOP_PROCESSING defines.
+
Since the wait setting of a subsystem can be changed at any time, it is important that any rate-of-change that you implement in this proc is multiplied by the delta_time that is sent as a parameter,
+Additionally, any "prob" you use in this proc should instead use the DT_PROB define to make sure that the final probability per second stays the same even if the subsystem's wait is altered.
+Examples where this must be considered:
+
+
Implementing a cooldown timer, use mytimer -= delta_time, not mytimer -= 1. This way, mytimer will always have the unit of seconds
+
Damaging a mob, do L.adjustFireLoss(20 * delta_time), not L.adjustFireLoss(20). This way, the damage per second stays constant even if the wait of the subsystem is changed
+
Probability of something happening, do if(DT_PROB(25, delta_time)), not if(prob(25)). This way, if the subsystem wait is e.g. lowered, there won't be a higher chance of this event happening per second
+
+
If you override this do not call parent, as it will return PROCESS_KILL. This is done to prevent objects that dont override process() from staying in the processing list
ref_search_details
+
+
Return info about us for reference searching purposes
+Will be logged as a representation of this datum if it's a part of a search chain
serialize_json
+
+
Serializes into JSON. Does not encode type.
serialize_list
+
+
Return a LIST for serialize_datum to encode! Not the actual json!
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
+
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 user's input has been handled and the UI should update.
ui_assets
+
+
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.
ui_close
+
+
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
ui_data
+
+
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.
ui_host
+
+
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.
ui_interact
+
+
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.
ui_state
+
+
private
+
The UI's state controller to be used for created uis
+This is a proc over a var for memory reasons
ui_static_data
+
+
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.
ui_status
+
+
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.
update_static_data
+
+
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
update_static_data_for_all
+
+
public
+
Forces an update on static data. Should be done manually whenever something
+happens to change static data. Applies to all UIs tied to this object.
+
+
+
diff --git a/datum/abductor_gear.html b/datum/abductor_gear.html
new file mode 100644
index 000000000000..65b6d48a5dc0
--- /dev/null
+++ b/datum/abductor_gear.html
@@ -0,0 +1,71 @@
+
+
+
+
+
+
+ /datum/abductor_gear - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Unlocks an achievement of a specific type. achievement type is a typepath to the award, user is the mob getting the award, and value is an optional value to be used for defining a score to add to the leaderboard
Updates local cache with db data for the given achievement type if it wasn't loaded yet.
reset
+
+
Resets an achievement to default values.
unlock
+
+
Unlocks an achievement of a specific type. achievement type is a typepath to the award, user is the mob getting the award, and value is an optional value to be used for defining a score to add to the leaderboard
This is the icon state state for the BACKGROUND underlay icon of the button
+(If set to ACTION_BUTTON_DEFAULT_BACKGROUND, uses the hud's default background)
This is who currently owns the action, and most often, this is who is using the action if it is triggered
+This can be the same as "target" but is not ALWAYS the same - this is set and unset with Grant() and Remove()
If TRUE, this action button will be shown to observers / other mobs who view from this action's owner's eyes.
+Used in /mob/proc/show_other_mob_action_buttons
The target the action is attached to. If the target datum is deleted, the action is as well.
+Set in New() via the proc link_to(). PLEASE set a target if you're making an action
Signal proc that clears any references based on the owner or target deleting
+If the owner's deleted, we will simply remove from them, but if the target's deleted, we will self-delete
This is the icon state state for the BACKGROUND underlay icon of the button
+(If set to ACTION_BUTTON_DEFAULT_BACKGROUND, uses the hud's default background)
This is who currently owns the action, and most often, this is who is using the action if it is triggered
+This can be the same as "target" but is not ALWAYS the same - this is set and unset with Grant() and Remove()
If TRUE, this action button will be shown to observers / other mobs who view from this action's owner's eyes.
+Used in /mob/proc/show_other_mob_action_buttons
The target the action is attached to. If the target datum is deleted, the action is as well.
+Set in New() via the proc link_to(). PLEASE set a target if you're making an action
List of all mobs that are viewing our action button -> A unique movable for them to view.
Proc Details
GiveAction
+
+
Gives our action to the passed viewer.
+Puts our action in their actions list and shows them the button.
Grant
+
+
Grants the action to the passed mob, making it the owner
HideFrom
+
+
Removes our action from the passed viewer.
IsAvailable
+
+
Whether our action is currently available to use or not
+
+
feedback - If true this is being called to check if we have any messages to show to the owner
+
Remove
+
+
Remove the passed mob from being owner of our action
ShowTo
+
+
Adds our action button to the screen of the passed viewer.
Trigger
+
+
Actually triggers the effects of the action.
+Called when the on-screen button is clicked, for example.
apply_button_background
+
+
Creates the background underlay for the button
+
current_button - what button are we editing?
+force - whether an update is forced regardless of existing status
apply_button_icon
+
+
Applies our button icon and icon state to the button
+
current_button - what button are we editing?
+force - whether an update is forced regardless of existing status
apply_button_overlay
+
+
Applies any overlays to our button
+
current_button - what button are we editing?
+force - whether an update is forced regardless of existing status
build_all_button_icons
+
+
Builds / updates all buttons we have shared or given out
build_button_icon
+
+
Builds the icon of the button.
+
Concept:
+
+
Underlay (Background icon)
+
Icon (button icon)
+
Maptext
+
Overlay (Background border)
+
+
button - which button we are modifying the icon of
+force - whether we're forcing a full update
clear_ref
+
+
Signal proc that clears any references based on the owner or target deleting
+If the owner's deleted, we will simply remove from them, but if the target's deleted, we will self-delete
create_button
+
+
Creates an action button movable for the passed mob, and returns it.
is_action_active
+
+
Checks if our action is actively selected. Used for selecting icons primarily.
link_to
+
+
Links the passed target to our action, registering any relevant signals
on_target_icon_update
+
+
Updates our buttons if our target's icon was updated
on_target_mind_swapped
+
+
Signal proc for COMSIG_MIND_TRANSFERRED - for minds, transfers our action to our new mob on mind transfer
update_button_name
+
+
Updates the name and description of the button to match our action name and discription.
+
current_button - what button are we editing?
+force - whether an update is forced regardless of existing status
update_button_status
+
+
Any other miscellaneous "status" updates within the action button is handled here,
+such as redding out when unavailable or modifying maptext.
+
current_button - what button are we editing?
+force - whether an update is forced regardless of existing status
update_status_on_signal
+
+
A general use signal proc that reacts to an event and updates JUST our button's status
Maximum stat before the ability is blocked. For example, UNCONSCIOUS prevents it from being used when in hard crit or dead, while DEAD allows the ability to be used on any stat values.
Contrary to the name, this proc isn't just used by changeling stings. It handles the activation of the action and the deducation of its cost.
+The order of the proc chain is:
+can_sting(). Should this fail, the process gets aborted early.
+sting_action(). This proc usually handles the actual effect of the action.
+Should sting_action succeed the following will be done:
+sting_feedback(). Produces feedback on the performed action. Don't ask me why this isn't handled in sting_action()
+The deduction of the cost of this power.
+Returns TRUE on a successful activation.
Maximum stat before the ability is blocked. For example, UNCONSCIOUS prevents it from being used when in hard crit or dead, while DEAD allows the ability to be used on any stat values.
Proc Details
try_to_sting
+
+
Contrary to the name, this proc isn't just used by changeling stings. It handles the activation of the action and the deducation of its cost.
+The order of the proc chain is:
+can_sting(). Should this fail, the process gets aborted early.
+sting_action(). This proc usually handles the actual effect of the action.
+Should sting_action succeed the following will be done:
+sting_feedback(). Produces feedback on the performed action. Don't ask me why this isn't handled in sting_action()
+The deduction of the cost of this power.
+Returns TRUE on a successful activation.
+
+
+
diff --git a/datum/action/changeling/absorb_dna.html b/datum/action/changeling/absorb_dna.html
new file mode 100644
index 000000000000..976a720698e6
--- /dev/null
+++ b/datum/action/changeling/absorb_dna.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /datum/action/changeling/absorb_dna - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Starts a cooldown time for other abilities that share a cooldown with this. Has some niche usage with more complicated attack ai!
+Will use default cooldown time if an override is not specified
Check if the target we're casting on is a valid target.
+For no-target (self cast) actions, the target being checked (cast_on) is the caster.
+For click_to_activate actions, the target being checked is the clicked atom.
If TRUE, will log action usage to the owner's action log.
Proc Details
Activate
+
+
To be implemented by subtypes (if not generic)
InterceptClickOn
+
+
Intercepts client owner clicks to activate the ability
PreActivate
+
+
For signal calling
StartCooldown
+
+
Starts a cooldown time to be shared with similar abilities
+Will use default cooldown time if an override is not specified
StartCooldownOthers
+
+
Starts a cooldown time for other abilities that share a cooldown with this. Has some niche usage with more complicated attack ai!
+Will use default cooldown time if an override is not specified
StartCooldownSelf
+
+
Starts a cooldown time for this ability only
+Will use default cooldown time if an override is not specified
create_sequence_actions
+
+
Initializes any sequence actions
handle_melee_attack
+
+
Cancels melee attacks if they are on cooldown.
is_valid_target
+
+
Check if the target we're casting on is a valid target.
+For no-target (self cast) actions, the target being checked (cast_on) is the caster.
+For click_to_activate actions, the target being checked is the clicked atom.
+
Return TRUE if cast_on is valid, FALSE otherwise
set_click_ability
+
+
Set our action as the click override on the passed mob.
set_statpanel_format
+
+
Formats the action to be returned to the stat panel.
unset_click_ability
+
+
Unset our action as the click override of the passed mob.
+
if refund_cooldown is TRUE, we are being unset by the user clicking the action off
+if refund_cooldown is FALSE, we are being forcefully unset, likely by someone actually using the action
+
+
+
diff --git a/datum/action/cooldown/alien.html b/datum/action/cooldown/alien.html
new file mode 100644
index 000000000000..f41b33438358
--- /dev/null
+++ b/datum/action/cooldown/alien.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /datum/action/cooldown/alien - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
This is the base action for how many of the game's
+spells (and spell adjacent) abilities function.
+These spells function off of a cooldown-based system.
+Pre-spell checks:
+
+
can_cast_spell checks if the OWNER
+of the spell is able to cast the spell.
+
is_valid_target checks if the TARGET
+THE SPELL IS BEING CAST ON is a valid target for the spell. NOTE: The CAST TARGET is often THE SAME as THE OWNER OF THE SPELL,
+but is not always - depending on how Pre Activate is resolved.
+
try_invoke is run in can_cast_spell to check if
+the OWNER of the spell is able to say the current invocation.
+
+The spell chain:
+
+
before_cast is the last chance for being able
+to interrupt a spell cast. This returns a bitflag. if SPELL_CANCEL_CAST is set, the spell will not continue.
+
spell_feedback is called right before cast, and handles
+invocation and sound effects. Overridable, if you want a special method of invocation or sound effects,
+or you want your spell to handle invocation / sound via special means.
+
cast is where the brunt of the spell effects should be done
+and implemented.
+
after_cast is the aftermath - final effects that follow
+the main cast of the spell. By now, the spell cooldown has already started
+
+Other procs called / may be called within the chain:
+
+
invocation handles saying any vocal (or emotive) invocations the spell
+may have, and can be overriden or extended. Called by spell_feedback.
+
reset_spell_cooldown is a way to handle reverting a spell's
+cooldown and making it ready again if it fails to go off at any point. Not called anywhere by default. If you
+want to cancel a spell in before_cast and would like the cooldown restart, call this.
+
+Other procs of note:
+
+
level_spell is where the process of adding a spell level is handled.
+this can be extended if you wish to add unique effects on level up for wizards.
+
delevel_spell is where the process of removing a spell level is handled.
+this can be extended if you wish to undo unique effects on level up for wizards.
+
get_spell_title returns the prefix of the spell name based on its level,
+for use in updating the button name / spell name.
This determines what type of antimagic is needed to block the spell.
+(MAGIC_RESISTANCE, MAGIC_RESISTANCE_MIND, MAGIC_RESISTANCE_HOLY)
+If SPELL_REQUIRES_NO_ANTIMAGIC is set in Spell requirements,
+The spell cannot be cast if the caster has any of the antimagic flags set.
The school of magic the spell belongs to.
+Checked by some holy sects to punish the
+caster for casting things that do not align
+with their sect's alignment - see magic.dm in defines to learn more
This determines what type of antimagic is needed to block the spell.
+(MAGIC_RESISTANCE, MAGIC_RESISTANCE_MIND, MAGIC_RESISTANCE_HOLY)
+If SPELL_REQUIRES_NO_ANTIMAGIC is set in Spell requirements,
+The spell cannot be cast if the caster has any of the antimagic flags set.
The school of magic the spell belongs to.
+Checked by some holy sects to punish the
+caster for casting things that do not align
+with their sect's alignment - see magic.dm in defines to learn more
Flag for certain states that the spell requires the user be in to cast.
Proc Details
after_cast
+
+
Actions done after the main cast is finished.
+This is called after the cooldown's already begun.
+
It can be used to apply late spell effects where order matters
+(for example, causing smoke after a teleport occurs in cast())
+or to clean up variables or references post-cast.
before_cast
+
+
Actions done before the actual cast is called.
+This is the last chance to cancel the spell from being cast.
+
Can be used for target selection or to validate checks on the caster (cast_on).
+
Returns a bitflag.
+
+
SPELL_CANCEL_CAST will stop the spell from being cast.
+
SPELL_NO_FEEDBACK will prevent the spell from calling [proc/spell_feedback] on cast. (invocation), sounds)
+
SPELL_NO_IMMEDIATE_COOLDOWN will prevent the spell from starting its cooldown between cast and before after_cast.
+
can_cast_spell
+
+
Checks if the owner of the spell can currently cast it.
+Does not check anything involving potential targets.
cast
+
+
Actions done as the main effect of the spell.
+
For spells without a click intercept, [cast_on] will be the owner.
+For click spells, [cast_on] is whatever the owner clicked on in casting the spell.
delevel_spell
+
+
Levels the spell down a single level, down to 1.
get_spell_title
+
+
Gets the title of the spell based on its level.
invocation
+
+
The invocation that accompanies the spell, called from spell_feedback() before cast().
level_spell
+
+
Levels the spell up a single level, reducing the cooldown.
+If bypass_cap is TRUE, will level the spell up past it's set cap.
reset_spell_cooldown
+
+
Resets the cooldown of the spell, sending COMSIG_SPELL_CAST_RESET
+and allowing it to be used immediately (+ updating button icon accordingly)
spell_feedback
+
+
Provides feedback after a spell cast occurs, in the form of a cast sound and/or invocation
try_invoke
+
+
Checks if the current OWNER of the spell is in a valid state to say the spell's invocation
A spell that iterates over atoms near the caster and casts a spell on them.
+Calls cast_on_thing_in_aoe on all atoms returned by get_things_to_cast_on by default.
A basic subtype for jaunt related spells.
+Jaunt spells put their caster in a dummy
+phased_mob effect that allows them to float
+around incorporeally.
+
Doesn't actually implement any behavior on cast to
+enter or exit the jaunt - that must be done via subtypes.
Ejects the [unjaunter] from jaunt
+The jaunt object in turn should call on_jaunt_exited
+If [loc_override] is supplied,
+the jaunt will be moved to that turf
+before ejecting the unjaunter
Called when a mob is ejected from the jaunt holder and goes back to normal.
+This is called both fom exit_jaunt() but also if the caster is ejected involuntarily for some reason.
+Use this to clear state data applied when jaunting, such as the trait TRAIT_MAGICALLY_PHASED.
+Arguments
What dummy mob type do we put jaunters in on jaunt?
Proc Details
enter_jaunt
+
+
Places the [jaunter] in a jaunt holder mob
+If [loc_override] is supplied,
+the jaunt will be moved to that turf to start at
+
Returns the holder mob that was created
exit_jaunt
+
+
Ejects the [unjaunter] from jaunt
+The jaunt object in turn should call on_jaunt_exited
+If [loc_override] is supplied,
+the jaunt will be moved to that turf
+before ejecting the unjaunter
+
Returns TRUE on successful exit, FALSE otherwise
is_jaunting
+
+
Simple helper to check if the passed mob is currently jaunting or not
on_jaunt_exited
+
+
Called when a mob is ejected from the jaunt holder and goes back to normal.
+This is called both fom exit_jaunt() but also if the caster is ejected involuntarily for some reason.
+Use this to clear state data applied when jaunting, such as the trait TRAIT_MAGICALLY_PHASED.
+Arguments
+
+
jaunt - The mob holder effect the caster has just exited
+
unjaunter - The spellcaster who is no longer jaunting
Signal proc for COMSIG_LIVING_DEATH and COMSIG_PARENT_QDELETING
+
If our demon is deleted or destroyed, expel all of our consumed mobs
on_victim_deleted
+
+
Handle signal from a consumed mob being deleted. Clears any references.
on_victim_statchange
+
+
Handle signal from a consumed mob changing stat.
+
A signal handler for if one of the laughter demon's consumed mobs has
+changed stat. If they're no longer dead (because they were dead when
+swallowed), eject them so they can't rip their way out from the inside.
Begin the jaunt, and the entire jaunt chain.
+Puts cast_on in the phased mob holder here.
+
Calls do_jaunt_out:
+
+
if jaunt_out_time is set to more than 0,
+Or immediately calls start_jaunt:
+
if jaunt_out_time = 0
+
do_jaunt_in
+
+
The wind-up (wind-out?) of exiting the jaunt.
+Optional, only called if jaunt_in_time is above 2.5 seconds.
+
Calls end_jaunt.
do_jaunt_out
+
+
The wind-up to the jaunt.
+Optional, only called if jaunt_out_time is set.
+
Calls start_jaunt.
do_steam_effects
+
+
Does some steam effects from the jaunt at passed loc.
end_jaunt
+
+
Finally, the actual veritable end of the jaunt chains.
+Deletes the phase holder, ejecting the caster at final_point.
+
If the final_point is dense for some reason,
+tries to put the caster in an adjacent turf.
start_jaunt
+
+
The actual process of starting the jaunt.
+Sets up the signals and exit points and allows
+the caster to actually start moving around.
+
Calls stop_jaunt after the jaunt runs out.
stop_jaunt
+
+
The stopping of the jaunt.
+Unregisters and signals and places
+the jaunter on the turf they will exit at.
+
Calls do_jaunt_in:
+
+
immediately, if jaunt_in_time >= 2.5 seconds
+
2.5 seconds - jaunt_in_time seconds otherwise
+
update_exit_point
+
+
Updates the exit point of the jaunt
+
Called when the jaunting mob holder moves, this updates the backup exit-jaunt
+location, in case the jaunt ends with the mob still in a wall. Five
+spots are kept in the list, in case the last few changed since we passed
+by (doors closing, engineers building walls, etc)
Pointed spells that, instead of casting a spell directly on the target that's clicked,
+will instead fire a projectile pointed at the target's direction.
Whenever someone shapeshifts within a vent,
+and enters a state in which they are no longer a ventcrawler,
+they are brutally ejected from the vents. In the form of gibs.
Whenever someone shapeshifts within a vent,
+and enters a state in which they are no longer a ventcrawler,
+they are brutally ejected from the vents. In the form of gibs.
+
+
+
diff --git a/datum/action/cooldown/spell/shapeshift/slime_form.html b/datum/action/cooldown/spell/shapeshift/slime_form.html
new file mode 100644
index 000000000000..82711335a46f
--- /dev/null
+++ b/datum/action/cooldown/spell/shapeshift/slime_form.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /datum/action/cooldown/spell/shapeshift/slime_form - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Trades 20 max health for a refresh on all of your spells.
+I was considering making it depend on the cooldowns of your spells, but I want to support "Big spell wizard" with this loadout.
+The two spells that sound most problematic with this is mindswap and lichdom,
+but soul tap requires clothes for mindswap and lichdom takes your soul.
The actual process of casting the spell on the victim from the caster.
+
Override / extend this to implement casting effects.
+Return TRUE on a successful cast to use up the hand (delete it)
+Return FALSE to do nothing and let them keep the hand in hand
cast_on_secondary_hand_hit
+
+
For any special casting effects done if the user right-clicks
+on touch spell instead of left-clicking
+
Return SECONDARY_ATTACK_CALL_NORMAL to call the normal cast_on_hand_hit
+Return SECONDARY_ATTACK_CONTINUE_CHAIN to prevent the normal cast_on_hand_hit from calling, but still use up the hand
+Return SECONDARY_ATTACK_CANCEL_CHAIN to prevent the spell from being used
create_hand
+
+
Creates a new hand_path hand and equips it to the caster.
+
If the equipping action fails, reverts the cooldown and returns FALSE.
+Otherwise, registers signals and returns TRUE.
do_hand_hit
+
+
Calls cast_on_hand_hit() from the caster onto the victim.
do_secondary_hand_hit
+
+
Calls do_secondary_hand_hit() from the caster onto the victim.
If our caster drops the hand, remove the hand / revert the cast
+Basically gives them an easy hotkey to lose their hand without needing to click the button
Same as on_hand_hit, but for if right-click was used on hit.
remove_hand
+
+
Unregisters any signals and deletes the hand currently summoned by the spell.
+
If reset_cooldown_after is TRUE, we will additionally refund the cooldown of the spell.
+If reset_cooldown_after is FALSE, we will instead just start the spell's cooldown
+
+
+
diff --git a/datum/action/cooldown/spell/voice_of_god.html b/datum/action/cooldown/spell/voice_of_god.html
new file mode 100644
index 000000000000..056e5f4531d5
--- /dev/null
+++ b/datum/action/cooldown/spell/voice_of_god.html
@@ -0,0 +1,57 @@
+
+
+
+
+
+
+ /datum/action/cooldown/spell/voice_of_god - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
This is gross, but a somewhat-required bit of copy+paste until action code becomes slightly more sane.
+Anything that uses these functions should eventually be moved to use cooldown actions.
+(Either that, or the click ability of cooldown actions should be moved down a type.)
This is gross, but a somewhat-required bit of copy+paste until action code becomes slightly more sane.
+Anything that uses these functions should eventually be moved to use cooldown actions.
+(Either that, or the click ability of cooldown actions should be moved down a type.)
+
If you're adding something that uses these, rethink your choice in subtypes.
+Sets this action as the active ability for the passed mob
unset_ranged_ability
+
+
Removes this action as the active ability of the passed mob
+
+
+
diff --git a/datum/action/innate/ai.html b/datum/action/innate/ai.html
new file mode 100644
index 000000000000..e1cf990114cd
--- /dev/null
+++ b/datum/action/innate/ai.html
@@ -0,0 +1,57 @@
+
+
+
+
+
+
+ /datum/action/innate/ai - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Called by [deactivate_wash] on a timer to allow noises and animation to play out.
+Finally disables the buffer. Doesn't do everything mind, just the stuff that we wanted to delay
Activate the buffer, comes with a nice animation that loops while it's on
allow_buffer_activate
+
+
Should we keep trying to activate our buffer, or did you fuck it up somehow
clean
+
+
Call this to attempt to actually clean the turf underneath us
deactivate_wash
+
+
Start the process of disabling the buffer. Plays some effects, waits a bit, then finishes
toggle_wash
+
+
Toggle our wash mode
turn_off_wash
+
+
Called by [deactivate_wash] on a timer to allow noises and animation to play out.
+Finally disables the buffer. Doesn't do everything mind, just the stuff that we wanted to delay
Called via intercepted clicks when the missile ability is active
+Spawns a droppod and starts the cooldown of the missile strike ability
+arguments:
+
+
target_turf: turf of the atom that was clicked on
+
end_missile_targeting
+
+ end_missile_targeting
+
Called by the ivanov strike datum action or other actions that would end targetting
+Unhooks signals into clicking to call drop_missile plus other flavor like the overlay
on_equipment_click
+
+
signal called from clicking with equipment
on_melee_click
+
+
signal called from clicking with no equipment
reset_button_icon
+
+ reset_button_icon
+
called after an addtimer when the cooldown is finished with the ivanov strike, resets the icon
start_missile_targeting
+
+ start_missile_targeting
+
Called by the ivanov strike datum action, hooks signals into clicking to call drop_missile
+Plus other flavor like the overlay
Called by skyfall_charge_loop if the charging is interrupted.
+Applies cooldown and resets charge level
begin_landing
+
+ begin_landing
+
Called by skyfall_charge_loop after some time if it reaches full charge level.
+it's just the animations of the mecha coming down + another timer for the final landing effect
land
+
+ land
+
Called by skyfall_charge_loop after some time if it reaches full charge level.
+it's just the animations of the mecha coming down + another timer for the final landing effect
reset_button_icon
+
+ reset_button_icon
+
called after an addtimer when the cooldown is finished with the skyfall, resets the icon
skyfall_charge_loop
+
+ skyfall_charge_loop
+
The actual skyfall loop itself. Repeatedly calls itself after a do_after, so any interruptions will call abort_skyfall and end the loop
+the other way the loop ends is if charge level (var it's ticking up) gets to SKYFALL_CHARGELEVEL_LAUNCH, in which case it ends the loop and does the ability.
Unique ID. You can never have different modifications with the same ID. By default, this SHOULD NOT be set. Only set it for cases where you're dynamically making modifiers/need to have two types overwrite each other. If unset, uses path (converted to text) as ID.
Higher ones override lower priorities. This is NOT used for ID, ID must be unique, if it isn't unique the newer one overwrites automatically if overriding.
Whether or not this is a variable modifier. Variable modifiers can NOT be ever auto-cached. ONLY CHECKED VIA INITIAL(), EFFECTIVELY READ ONLY (and for very good reason)
Unique ID. You can never have different modifications with the same ID. By default, this SHOULD NOT be set. Only set it for cases where you're dynamically making modifiers/need to have two types overwrite each other. If unset, uses path (converted to text) as ID.
Higher ones override lower priorities. This is NOT used for ID, ID must be unique, if it isn't unique the newer one overwrites automatically if overriding.
Whether or not this is a variable modifier. Variable modifiers can NOT be ever auto-cached. ONLY CHECKED VIA INITIAL(), EFFECTIVELY READ ONLY (and for very good reason)
base class for addiction, handles when you become addicted and what the effects of that are. By default you become addicted when you hit a certain threshold, and stop being addicted once you go below another one.
Returns whether or not the given client has a verified 2FA connection.
+The output is in the form of a list with the first index being whether or not the
+check was successful, the 2nd is the ID of the associated database entry
+if its a false result and if one can be found.
target_datum - The datum you want to create a tag for
+
can_place_additional_admin_ban
+
+
Checks if the admin can place an additional admin ban.
+
Returns FALSE if the query fails to execute.
+Returns FALSE and notifies the admin in chat if they are at their max number of admin bans already.
+Returns TRUE if an admin can place an additional admin ban.
+
Arguments:
+
+
admin_ckey - The ckey of the admin who is trying to place an admin ban.
+
check_2fa
+
+
Returns whether or not the given client has a verified 2FA connection.
+The output is in the form of a list with the first index being whether or not the
+check was successful, the 2nd is the ID of the associated database entry
+if its a false result and if one can be found.
display_tags
+
+
Display all of the tagged datums
handle_tagged_del
+
+
Get ahead of the curve with deleting
modify_traits
+
+
Allow admin to add or remove traits of datum
notify_all_banned_players
+
+
Notifies all banned players about their ban and gives them a link to appeal from the config. If it was a server ban, it also kicks them.
+
If the banned player's ckey has a linked client on the server, it notifies them of the ban details and kicks them if it was a server ban.
+If there is anyone else sharing the banned player's IP or CID, it notifies them of the ban details and kicks them if it was a server ban.
+
Builds the ban cache for every client impacted by the ban.
+
Arguments:
+
+
banned_player_ckey - The ckey of the banned player.
+
banned_player_ip - IP address of the banned player.
+
banned_player_cid - CID of the banned player.
+
banned_player_message - The message to show to only the specifically banned player.
+
banned_other_message - The message to show to any other players who share the banned player's IP or CID.
+
kick_banned_players - TRUE if we want to kick affected players, FALSE otherwise. This should generally only be TRUE for server bans.
+
applies_to_admins - TRUE if this ban applies to admins and we may need to kick them, FALSE otherwise.
+
poll_list_panel
+
+
Shows a list of all current and future polls and buttons to edit or delete them or create a new poll.
poll_management_panel
+
+
Show the options for creating a poll or editing its parameters along with its linked options.
poll_option_panel
+
+
Show the options for creating a poll option or editing its parameters.
poll_option_parse_href
+
+
Processes topic data from poll option panel.
+
Reads through returned form data and assigns data to the option datum, creating a new one if required, before passing it to be saved.
+Also does some simple error checking to ensure the option will be valid before creation.
poll_parse_href
+
+
Processes topic data from poll management panel.
+
Reads through returned form data and assigns data to the poll datum, creating a new one if required, before passing it to be saved.
+Also does some simple error checking to ensure the poll will be valid before creation.
reban
+
+
Sometimes an admin did not intend to unban a player. This proc undoes an unbanning operation by setting the unbanned_ keys in the DB back to null.
A proc representing when the mob is pushed to actually attack the target. Again, subtypes can be used to represent different attacks from different animals, or it can be some other generic behavior
Proc Details
attack
+
+
A proc representing when the mob is pushed to actually attack the target. Again, subtypes can be used to represent different attacks from different animals, or it can be some other generic behavior
+
+
+
diff --git a/datum/ai_behavior/battle_screech.html b/datum/ai_behavior/battle_screech.html
new file mode 100644
index 000000000000..617690f61109
--- /dev/null
+++ b/datum/ai_behavior/battle_screech.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /datum/ai_behavior/battle_screech - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
A proc representing when the mob is pushed to actually attack the target. Again, subtypes can be used to represent different attacks from different animals, or it can be some other generic behavior
Proc Details
attack
+
+
A proc representing when the mob is pushed to actually attack the target. Again, subtypes can be used to represent different attacks from different animals, or it can be some other generic behavior
+
+
+
diff --git a/datum/ai_behavior/item_move_close_and_attack.html b/datum/ai_behavior/item_move_close_and_attack.html
new file mode 100644
index 000000000000..26e8d00c7ad4
--- /dev/null
+++ b/datum/ai_behavior/item_move_close_and_attack.html
@@ -0,0 +1,43 @@
+
+
+
+
+
+
+ /datum/ai_behavior/item_move_close_and_attack - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
This is a list of variables the AI uses and can be mutated by actions. When an action is performed you pass this list and any relevant keys for the variables it can mutate.
All subtrees this AI has available, will run them in order, so make sure they're in the order you want them to run. On initialization of this type, it will start as a typepath(s) and get converted to references of ai_subtrees found in SSai_controllers when init_subtrees() is called
Use this proc to define how your controller defines what access the pawn has for the sake of pathfinding, likely pointing to whatever ID slot is relevant
Loops over the subtrees in planning_subtrees and looks at the ai_controllers to grab a reference, ENSURE planning_subtrees ARE TYPEPATHS AND NOT INSTANCES/REFERENCES BEFORE EXECUTING THIS
This is a list of variables the AI uses and can be mutated by actions. When an action is performed you pass this list and any relevant keys for the variables it can mutate.
All subtrees this AI has available, will run them in order, so make sure they're in the order you want them to run. On initialization of this type, it will start as a typepath(s) and get converted to references of ai_subtrees found in SSai_controllers when init_subtrees() is called
Proc Details
PossessPawn
+
+
Proc to move from one pawn to another, this will destroy the target's existing controller.
SelectBehaviors
+
+
Are we close enough to engage?
+This is where you decide what actions are taken by the AI.
TryPossessPawn
+
+
Abstract proc for initializing the pawn to the new controller
UnpossessPawn
+
+
Proc for deinitializing the pawn to the old controller
able_to_run
+
+
Returns TRUE if the ai controller can actually run at the moment.
change_ai_movement_type
+
+
Overrides the current ai_movement of this controller with a new one
get_access
+
+
Use this proc to define how your controller defines what access the pawn has for the sake of pathfinding, likely pointing to whatever ID slot is relevant
get_minimum_distance
+
+
Returns the minimum required distance to preform one of our current behaviors. Honestly this should just be cached or something but fuck you
init_subtrees
+
+
Loops over the subtrees in planning_subtrees and looks at the ai_controllers to grab a reference, ENSURE planning_subtrees ARE TYPEPATHS AND NOT INSTANCES/REFERENCES BEFORE EXECUTING THIS
process
+
+
Runs any actions that are currently running
queue_behavior
+
+
Call this to add a behavior to the stack.
replace_planning_subtrees
+
+
Completely replaces the planning_subtrees with a new set based on argument provided, list provided must contain specifically typepaths
set_ai_status
+
+
This proc handles changing ai status, and starts/stops processing if required.
Haunted AI tries to not be interacted with, and will attack people who do.
+Cursed AI instead tries to be interacted with, and will attempt to equip itself onto people.
+Added by /datum/element/cursed, and as such will try to remove this element and go dormant when it finds a victim to curse
Someone we like is pointing at something, see if it's something we might want to interact with (like if they might want us to fetch something for them)
Someone has thrown something, see if it's someone we care about and start listening to the thrown item so we can see if we want to fetch it when it lands
Someone is being mean to us, take them off our friends (add actual enemies behavior later)
Proc Details
befriend
+
+
Someone is being nice to us, let's make them a friend!
check_altclicked
+
+
Someone alt clicked us, see if they're someone we should show the radial command menu to
check_point
+
+
Someone we like is pointing at something, see if it's something we might want to interact with (like if they might want us to fetch something for them)
check_verbal_command
+
+
One of our friends said something, see if it's a valid command, and if so, take action
command_radial
+
+
Show the command radial menu
listen_throw_land
+
+
A throw we were listening to has finished, see if it's in range for us to try grabbing it
listened_throw
+
+
Someone has thrown something, see if it's someone we care about and start listening to the thrown item so we can see if we want to fetch it when it lands
on_attack_hand
+
+
Someone's interacting with us by hand, see if they're being nice or mean
on_death
+
+
If we died, drop anything we were carrying
on_examined
+
+
Someone is looking at us, if we're currently carrying something then show what it is, and include a message if they're our friend
set_command_mode
+
+
Whether we got here via radial menu or a verbal command, this is where we actually process what our new command will be
unfriend
+
+
Someone is being mean to us, take them off our friends (add actual enemies behavior later)
Someone we like is pointing at something, see if it's something we might want to interact with (like if they might want us to fetch something for them)
Someone is being mean to us, take them off our friends (add actual enemies behavior later)
Proc Details
befriend
+
+
Befriends someone
check_altclicked
+
+
Someone alt clicked us, see if they're someone we should show the radial command menu to
check_point
+
+
Someone we like is pointing at something, see if it's something we might want to interact with (like if they might want us to fetch something for them)
check_verbal_command
+
+
One of our friends said something, see if it's a valid command, and if so, take action
command_radial
+
+
Show the command radial menu
on_examined
+
+
Someone is looking at us, if we're currently carrying something then show what it is, and include a message if they're our friend
set_command_mode
+
+
Whether we got here via radial menu or a verbal command, this is where we actually process what our new command will be
unfriend
+
+
Someone is being mean to us, take them off our friends (add actual enemies behavior later)
+
+
+
diff --git a/datum/ai_controller/mod.html b/datum/ai_controller/mod.html
new file mode 100644
index 000000000000..9c76005b137c
--- /dev/null
+++ b/datum/ai_controller/mod.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /datum/ai_controller/mod - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
A subtree is attached to a controller and is occasionally called by /ai_controller/SelectBehaviors(), this mainly exists to act as a way to subtype and modify SelectBehaviors() without needing to subtype the ai controller itself
Determines what behaviors should the controller try processing; if this returns SUBTREE_RETURN_FINISH_PLANNING then the controller won't go through the other subtrees should multiple exist in controller.planning_subtrees
Proc Details
SelectBehaviors
+
+
Determines what behaviors should the controller try processing; if this returns SUBTREE_RETURN_FINISH_PLANNING then the controller won't go through the other subtrees should multiple exist in controller.planning_subtrees
Sends an alarm to any interested things, does some checks to prevent unneeded work
+Important to note is that source_atom is not held as a ref, we're used as a proxy to prevent hard deletes
+optional_camera should only be used when you have one camera you want to pass along to alarm listeners, most of the time you should have no use for it
Exists so we can request that the alarms from an area are cleared, even if our source atom is no longer in that area
send_alarm
+
+
Sends an alarm to any interested things, does some checks to prevent unneeded work
+Important to note is that source_atom is not held as a ref, we're used as a proxy to prevent hard deletes
+optional_camera should only be used when you have one camera you want to pass along to alarm listeners, most of the time you should have no use for it
Adds an alarm to our alarms list, you shouldn't be calling this manually
+It should all be handled by the signal listening we do, unless you want to only send an alarm to one listener
Removes an alarm to our alarms list, you probably shouldn't be calling this manually
+It should all be handled by the signal listening we do, unless you want to only remove an alarm to one listener
Accepts a list of alarm types to pay attention to, a list of valid z levels, and a list of valid areas. areas and zlevels are ignored if null
add_alarm
+
+
Adds an alarm to our alarms list, you shouldn't be calling this manually
+It should all be handled by the signal listening we do, unless you want to only send an alarm to one listener
allow_alarm_changes
+
+
Does what it says on the tin, exists for signal hooking
clear_alarm
+
+
Removes an alarm to our alarms list, you probably shouldn't be calling this manually
+It should all be handled by the signal listening we do, unless you want to only remove an alarm to one listener
clear_camera_ref
+
+
Used to manually clear camera refs if one is ref'd directly
prevent_alarm_changes
+
+
Does what it says on the tin, exists for signal hooking
String dialogue that is added to the player's in-round notes and memories regarding specifics of that antagonist, eg. the nuke code for nuke ops, or your unlock code for traitors.
This will hide adding this antag type in antag panel, use only for internal subtypes that shouldn't be added directly but still show if possessed by mind
Adds a HUD that will show you other members with the same antagonist.
+If an antag typepath is passed to antag_to_check, will check that, otherwise will use the source type.
Proc that sends fluff or instructional messages to the player when they lose this antag datum.
+Use this proc for playing sounds, sending alerts, or otherwise informing the player that they're no longer a specific antagonist type.
Given an icon, will crop it to be consistent of those in the preferences menu.
+Not necessary, and in fact will look bad if it's anything other than a human.
Proc that will return the team this antagonist belongs to, when called. Helpful with antagonists that may belong to multiple potential teams in a single round, like families.
Proc that sends fluff or instructional messages to the player when they are given this antag datum.
+Use this proc for playing sounds, sending alerts, or helping to setup non-gameplay influencing aspects of the antagonist type.
Gets how fast we can hijack the shuttle, return 0 for can not hijack.
+Defaults to hijack_speed var, override for custom stuff like buffing hijack speed for hijack objectives or something.
Called by the transfer_to() mind proc after the mind (mind.current and new_character.mind) has moved but before the player (key and client) is transfered.
Creates an icon from the preview outfit.
+Custom implementors of get_preview_icon should use this, as the
+result of get_preview_icon is expected to be the completed version.
Proc that sends string information for the end-round report window to the server.
+This runs on every instance of every antagonist that exists at the end of the round.
+This is the body of the message, sandwiched between roundend_report_header and roundend_report_footer.
Proc that sends string data for the round-end report.
+Displayed after roundend_report and roundend_report_footer.
+Appears at the end of the roundend_catagory section.
Proc that sends string data for the round-end report.
+Displayed before roundend_report and roundend_report_footer.
+Appears at start of roundend_catagory section.
String dialogue that is added to the player's in-round notes and memories regarding specifics of that antagonist, eg. the nuke code for nuke ops, or your unlock code for traitors.
This will hide adding this antag type in antag panel, use only for internal subtypes that shouldn't be added directly but still show if possessed by mind
name of the UI that will try to open, right now using a generic ui
Proc Details
add_team_hud
+
+
Adds a HUD that will show you other members with the same antagonist.
+If an antag typepath is passed to antag_to_check, will check that, otherwise will use the source type.
admin_add
+
+
Called when using admin tools to give antag status
admin_remove
+
+
Called when removing antagonist using admin tools
antag_panel_data
+
+
Additional data to display in the antagonist panel section.
+For example, nuke disk code, genome count, etc
build_greeting
+
+
Builds a list of strings to print out in greet().
farewell
+
+
Proc that sends fluff or instructional messages to the player when they lose this antag datum.
+Use this proc for playing sounds, sending alerts, or otherwise informing the player that they're no longer a specific antagonist type.
finish_preview_icon
+
+
Given an icon, will crop it to be consistent of those in the preferences menu.
+Not necessary, and in fact will look bad if it's anything other than a human.
get_admin_commands
+
+
List of ["Command"] = CALLBACK(), user will be appeneded to callback arguments on execution
get_objectives
+
+
generic helper to send objectives as data through tgui.
get_preview_icon
+
+
Returns the icon to show on the preferences menu.
get_team
+
+
Proc that will return the team this antagonist belongs to, when called. Helpful with antagonists that may belong to multiple potential teams in a single round, like families.
greet
+
+
Proc that sends fluff or instructional messages to the player when they are given this antag datum.
+Use this proc for playing sounds, sending alerts, or helping to setup non-gameplay influencing aspects of the antagonist type.
handle_clown_mutation
+
+
Handles adding and removing the clumsy mutation from clown antags. Gets called in apply/remove_innate_effects
hijack_speed
+
+
Gets how fast we can hijack the shuttle, return 0 for can not hijack.
+Defaults to hijack_speed var, override for custom stuff like buffing hijack speed for hijack objectives or something.
is_banned
+
+
Proc that checks the sent mob aganst the banlistfor this antagonist.
+Returns FALSE if no mob is sent, or the mob is not found to be banned.
+
+
mob/M: The mob that you are looking for on the banlist.
+
on_body_transfer
+
+
Called by the transfer_to() mind proc after the mind (mind.current and new_character.mind) has moved but before the player (key and client) is transfered.
on_gain
+
+
Called by the add_antag_datum() mind proc after the instanced datum is added to the mind's antag_datums list.
on_mindshield
+
+
This is called when the antagonist is successfully mindshielded.
on_removal
+
+
Called by the remove_antag_datum() and remove_all_antag_datums() mind procs for the antag datum to handle its own removal and deletion.
pre_mindshield
+
+
This is called when the antagonist is being mindshielded.
render_preview_outfit
+
+
Creates an icon from the preview outfit.
+Custom implementors of get_preview_icon should use this, as the
+result of get_preview_icon is expected to be the completed version.
replace_banned_player
+
+
Proc that replaces a player who cannot play a specific antagonist due to being banned via a poll, and alerts the player of their being on the banlist.
roundend_report
+
+
Proc that sends string information for the end-round report window to the server.
+This runs on every instance of every antagonist that exists at the end of the round.
+This is the body of the message, sandwiched between roundend_report_header and roundend_report_footer.
roundend_report_footer
+
+
Proc that sends string data for the round-end report.
+Displayed after roundend_report and roundend_report_footer.
+Appears at the end of the roundend_catagory section.
roundend_report_header
+
+
Proc that sends string data for the round-end report.
+Displayed before roundend_report and roundend_report_footer.
+Appears at start of roundend_catagory section.
Abductees are created by being operated on by abductors. They get some instructions about not
+remembering the abduction, plus some random weird objectives for them to act crazy with.
+
+
+
diff --git a/datum/antagonist/abductor.html b/datum/antagonist/abductor.html
new file mode 100644
index 000000000000..496dd104f295
--- /dev/null
+++ b/datum/antagonist/abductor.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /datum/antagonist/abductor - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
A reference to the handler datum that manages the families gamemode. In case of no handler (admin-spawned during round), this will be null; this is fine.
A reference to the handler datum that manages the families gamemode. In case of no handler (admin-spawned during round), this will be null; this is fine.
Signal proc for COMSIG_PARENT_QDELETING registered on sac targets
+if sacrifice targets are deleted (gibbed, dusted, whatever), free their slot and reference
A list of TOTAL how many sacrifices completed. (Includes high value sacrifices)
Proc Details
add_sacrifice_target
+
+
Add [target] as a sacrifice target for the heretic.
+Generates a preview image and associates it with a weakref of the mob.
check_mansus_grasp_offhand
+
+
Callback to check that the user's still got their Mansus Grasp out when drawing a rune.
+
Arguments
+
+
user - the mob drawing the rune
+
draw_rune
+
+
The actual process of drawing a rune.
+
Arguments
+
+
user - the mob drawing the rune
+
target_turf - the place the rune's being drawn
+
drawing_time - how long the do_after takes to make the rune
+
additional checks - optional callbacks to be ran while drawing the rune
+
forge_primary_objectives
+
+
Create our objectives for our heretic.
on_target_deleted
+
+
Signal proc for COMSIG_PARENT_QDELETING registered on sac targets
+if sacrifice targets are deleted (gibbed, dusted, whatever), free their slot and reference
passive_influence_gain
+
+
Increments knowledge by one.
+Used in callbacks for passive gain over time.
remove_sacrifice_target
+
+
Removes [target] from the heretic's sacrifice list.
+Returns FALSE if no one was removed, TRUE otherwise
try_draw_rune
+
+
Attempt to draw a rune on [target_turf].
+
Arguments
+
+
user - the mob drawing the rune
+
target_turf - the place the rune's being drawn
+
drawing_time - how long the do_after takes to make the rune
+
additional checks - optional callbacks to be ran while drawing the rune
+
+
+
+
diff --git a/datum/antagonist/heretic_monster.html b/datum/antagonist/heretic_monster.html
new file mode 100644
index 000000000000..98f430eb6b8e
--- /dev/null
+++ b/datum/antagonist/heretic_monster.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /datum/antagonist/heretic_monster - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Imps used to be summoned by a devil ascending to their final form, but now they're just
+kinda sitting in limbo... Well, whatever! They're kinda cool anyways!
Whether or not this asset can be cached across rounds of the same commit under the CACHE_ASSETS config.
+This is not a guarantee the asset will be cached. Not all asset subtypes respect this field, and the
+config can, of course, be disabled.
Whether or not this asset can be cached across rounds of the same commit under the CACHE_ASSETS config.
+This is not a guarantee the asset will be cached. Not all asset subtypes respect this field, and the
+config can, of course, be disabled.
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)
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.
Proc Details
get_htmlloader
+
+
Get a html string that will load a html asset.
+Needed because byond doesn't allow you to browse() to a url.
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)
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)
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 get_asset_url and the asset isn't marked legacy, fix one of those.
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
+asset_name - the identifier of the asset
+asset - the actual asset file (or an asset_cache_item datum)
+returns a /datum/asset_cache_item.
+mutiple calls to register the same asset under the same asset_name return the same datum
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.
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 get_asset_url and the asset isn't marked legacy, fix one of those.
Proc Details
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
+asset_name - the identifier of the asset
+asset - the actual asset file (or an asset_cache_item datum)
+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
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
+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.
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
associative list of the form: list(z level = list(hud atom)).
+tracks what hud atoms for this hud exists in what z level so we can only give users
+the hud images that they can actually see.
used for signal tracking purposes, associative list of the form: list(hud user = number of times this hud was added to this user).
+that isnt separated by z level
whether or not this atom_hud type updates the global huds_by_category list.
+some subtypes cant work like this since theyre supposed to "belong" to
+one target atom each. it will still go in the other global hud lists.
all passed in hud_atoms's hud images (that are part of this atom_hud) to requesting_mob's client.images list
+optimization of /datum/atom_hud/proc/add_atom_to_single_mob_hud for hot cases, we assert that no nulls will be passed in via the list
add just hud_atom's hud images (that are part of this atom_hud) to all the requesting_mobs's client.images list
+optimization of /datum/atom_hud/proc/add_atom_to_single_mob_hud for hot cases, we assert that no nulls will be passed in via the list
when a hud atom or hud user changes z levels this makes sure it gets the images it needs and removes the images it doesnt need.
+because of how signals work we need the same proc to handle both use cases because being a hud atom and being a hud user arent mutually exclusive
remove every hud image for this hud pulled from atoms_to_remove from client_mob's client.images list
+optimization of /datum/atom_hud/proc/remove_atom_from_single_hud for hot cases, we assert that no nulls will be passed in via the list
remove every hud image for this hud on atom_to_remove from client_mobs's client.images list
+optimization of /datum/atom_hud/proc/remove_atom_from_single_hud for hot cases, we assert that no nulls will be passed in via the list
removes the image or images in hud_atom.hud_list[hud_category_to_remove] from every mob that can see it but leaves every other image
+from that atom there.
associative list of the form: list(z level = list(hud atom)).
+tracks what hud atoms for this hud exists in what z level so we can only give users
+the hud images that they can actually see.
used for signal tracking purposes, associative list of the form: list(hud user = number of times this hud was added to this user).
+that isnt separated by z level
whether or not this atom_hud type updates the global huds_by_category list.
+some subtypes cant work like this since theyre supposed to "belong" to
+one target atom each. it will still go in the other global hud lists.
Proc Details
add_all_atoms_to_single_mob_hud
+
+
all passed in hud_atoms's hud images (that are part of this atom_hud) to requesting_mob's client.images list
+optimization of /datum/atom_hud/proc/add_atom_to_single_mob_hud for hot cases, we assert that no nulls will be passed in via the list
add_atom_to_all_mob_huds
+
+
add just hud_atom's hud images (that are part of this atom_hud) to all the requesting_mobs's client.images list
+optimization of /datum/atom_hud/proc/add_atom_to_single_mob_hud for hot cases, we assert that no nulls will be passed in via the list
add_atom_to_hud
+
+
add new_hud_atom to this hud
add_atom_to_single_mob_hud
+
+
add just hud_atom's hud images (that are part of this atom_hud) to requesting_mob's client.images list
add_single_hud_category_on_atom
+
+
adds a newly active hud category's image on a hud atom to every mob that could see it
get_hud_atoms_for_z_level
+
+
returns a list of all hud atoms in the given z level and linked lower z levels (because hud users in higher z levels can see below)
get_hud_users_for_z_level
+
+
returns a list of all hud users in the given z level.
hide_from
+
+
Hides the images in this hud from former_viewer
+If absolute is set to true, this will forcefully remove the hud, even if sources in theory remain
on_atom_or_user_z_level_changed
+
+
when a hud atom or hud user changes z levels this makes sure it gets the images it needs and removes the images it doesnt need.
+because of how signals work we need the same proc to handle both use cases because being a hud atom and being a hud user arent mutually exclusive
remove_all_atoms_from_single_hud
+
+
remove every hud image for this hud pulled from atoms_to_remove from client_mob's client.images list
+optimization of /datum/atom_hud/proc/remove_atom_from_single_hud for hot cases, we assert that no nulls will be passed in via the list
remove_atom_from_all_huds
+
+
remove every hud image for this hud on atom_to_remove from client_mobs's client.images list
+optimization of /datum/atom_hud/proc/remove_atom_from_single_hud for hot cases, we assert that no nulls will be passed in via the list
remove_atom_from_hud
+
+
remove this atom from this hud completely
remove_atom_from_single_hud
+
+
remove every hud image for this hud on atom_to_remove from client_mob's client.images list
remove_single_hud_category_on_atom
+
+
removes the image or images in hud_atom.hud_list[hud_category_to_remove] from every mob that can see it but leaves every other image
+from that atom there.
show_to
+
+
show this hud to the passed in user
+
+
+
diff --git a/datum/augment_item.html b/datum/augment_item.html
new file mode 100644
index 000000000000..be1d7cd2ac53
--- /dev/null
+++ b/datum/augment_item.html
@@ -0,0 +1,64 @@
+
+
+
+
+
+
+ /datum/augment_item - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
The page on the wiki to be replaced.
+This should never be a user-facing page, like "Guide to circuits".
+It should always be a template that only Autowiki should touch.
+For example: "Template:Autowiki/CircuitInfo".
Generates an auto formatted template user.
+Your autowiki should ideally be a lot of these.
+It lets wiki editors edit it much easier later, without having to enter repo.
+Parameters will be passed in by name. That means your template should expect
+something that looks like {{ Autowiki_Circuit|name=Combiner|description=This combines }}
+Lists, which must be array-like (no keys), will be turned into a flat list with their key and a number,
+such that list("food" = list("fruit", "candy")) -> food1=fruit|food2=candy
The page on the wiki to be replaced.
+This should never be a user-facing page, like "Guide to circuits".
+It should always be a template that only Autowiki should touch.
+For example: "Template:Autowiki/CircuitInfo".
Proc Details
escape_value
+
+
Escape a parameter such that it can be correctly put inside a wiki output
generate
+
+
Override and return the new text of the page.
+This proc can be impure, usually to call upload_file.
include_template
+
+
Generates an auto formatted template user.
+Your autowiki should ideally be a lot of these.
+It lets wiki editors edit it much easier later, without having to enter repo.
+Parameters will be passed in by name. That means your template should expect
+something that looks like {{ Autowiki_Circuit|name=Combiner|description=This combines }}
+Lists, which must be array-like (no keys), will be turned into a flat list with their key and a number,
+such that list("food" = list("fruit", "candy")) -> food1=fruit|food2=candy
upload_icon
+
+
Takes an icon and uploads it to Autowiki-name.png.
+Do your best to make sure this is unique, so it doesn't clash with other autowiki icons.
This sends a local chat message to the owner of a bank account, on all ID cards registered to the bank_account.
+If not held, sends out a message to all nearby players.
This proc handles passive income gain for players, using their job's paycheck value.
+Funds are taken from the given bank account unless null. This can result in payment brown-outs if the company is poor.
Proc guarantees the account_id possesses a unique number.
+If it doesn't, it tries to find a unique alternative.
+It then adds it to the SSeconomy.bank_accounts_by_id global list.
Performs a transfer of credits to the bank_account datum from another bank account.
+*datum/bank_account/from: The bank account that is sending the credits to this bank_account datum.
+*amount: the quantity of credits that are being moved between bank_account datums.
Can this account be replaced? Set to true for default IDs not recognized by the station.
Proc Details
_adjust_money
+
+
Performs the math component of adjusting a bank account balance.
adjust_money
+
+
Adjusts the balance of a bank_account as well as sanitizes the numerical input.
bank_card_talk
+
+
This sends a local chat message to the owner of a bank account, on all ID cards registered to the bank_account.
+If not held, sends out a message to all nearby players.
dumpeet
+
+
Sets the bank_account to behave as though a CRAB-17 event is happening.
has_money
+
+
Returns TRUE if a bank account has more than or equal to the amount, amt.
+Otherwise returns false.
payday
+
+
This proc handles passive income gain for players, using their job's paycheck value.
+Funds are taken from the given bank account unless null. This can result in payment brown-outs if the company is poor.
setup_unique_account_id
+
+
Proc guarantees the account_id possesses a unique number.
+If it doesn't, it tries to find a unique alternative.
+It then adds it to the SSeconomy.bank_accounts_by_id global list.
transfer_money
+
+
Performs a transfer of credits to the bank_account datum from another bank account.
+*datum/bank_account/from: The bank account that is sending the credits to this bank_account datum.
+*amount: the quantity of credits that are being moved between bank_account datums.
IF YOU ARE LAZY AND DO NOT WANT TO READ, GO TO THE BOTTOM OF THE FILE AND USE THAT PROC!
+
+
+
This is the beam datum! It's a really neat effect for the game in drawing a line from one atom to another.
+
+
+
It has two parts:
+
+
+
The datum itself which manages redrawing the beam to constantly keep it pointing from the origin to the target.
+
+
+
The effect which is what the beams are made out of. They're placed in a line from the origin to target, rotated towards the target and snipped off at the end.
+
+
+
These effects are kept in a list and constantly created and destroyed (hence the proc names draw and reset, reset destroying all effects and draw creating more.)
+
+
+
You can add more special effects to the beam itself by changing what the drawn beam effects do. For example you can make a vine that pricks people by making the beam_type
+
+
+
include a crossed proc that damages the crosser. Examples in venus_human_trap.dm
This is used as the visual_contents of beams, so you can apply one effect to this and the whole beam will look like that. never gets deleted on redrawing.
Triggered by signals set up when the beam is set up. If it's still sane to create a beam, it removes the old beam, creates a new one. Otherwise it kills the beam.
This is used as the visual_contents of beams, so you can apply one effect to this and the whole beam will look like that. never gets deleted on redrawing.
Proc Details
Draw
+
+
Creates the beam effects and places them in a line from the origin to the target. Sets their rotation to make the beams face the target, too.
Start
+
+
Proc called by the atom Beam() proc. Sets up signals, and draws the beam for the first time.
redrawing
+
+
Triggered by signals set up when the beam is set up. If it's still sane to create a beam, it removes the old beam, creates a new one. Otherwise it kills the beam.
+
Arguments:
+mover: either the origin of the beam or the target of the beam that moved.
+oldloc: from where mover moved.
+direction: in what direction mover moved from.
A datum that holds a proc to be called on another object, used to track proccalls to other objects
+USAGE
+
var/datum/callback/C = new(object|null, GLOBAL_PROC_REF(type/path|"procstring"), arg1, arg2, ... argn)
+var/timerid = addtimer(C, time, timertype)
+you can also use the compiler define shorthand
+var/timerid = addtimer(CALLBACK(object|null, GLOBAL_PROC_REF(type/path|procstring), arg1, arg2, ... argn), time, timertype)
+
+
Note: proc strings can only be given for datum proc calls, global procs must be proc paths
+
Also proc strings are strongly advised against because they don't compile error if the proc stops existing
+
In some cases you can provide a shortform of the procname, see the proc typepath shortcuts documentation below
+INVOKING THE CALLBACK
+
var/result = C.Invoke(args, to, add) additional args are added after the ones given when the callback was created
+
var/result = C.InvokeAsync(args, to, add) Asyncronous - returns . on the first sleep then continues on in the background
+after the sleep/block ends, otherwise operates normally.
+PROC TYPEPATH SHORTCUTS
+
(these operate on paths, not types, so to these shortcuts, datum is NOT a parent of atom, etc...)
+global proc while in another global proc:
+
.procname
+
CALLBACK(GLOBAL_PROC, .some_proc_here)
+proc defined on current(src) object (when in a /proc/ and not an override) OR overridden at src or any of it's parents:
+
.procname
+
CALLBACK(src, .some_proc_here)
+when the above doesn't apply:
+
.proc/procname
+
CALLBACK(src, PROC_REF(some_proc_here))
+
proc defined on a parent of a some type
+
/some/type/.proc/some_proc_here
+
Otherwise you must always provide the full typepath of the proc (/type/of/thing/proc/procname)
like normal callbacks but they also record their creation time for measurement purposes
+they also require the same usr/user that made the callback to both still exist and to still have a client in order to execute
new turfs that we couldnt see last update but can now
+turfs that we could see last update but cant see now
+Create a new camera chunk, since the chunks are made as they are needed.
Updates the chunk, makes sure that it doesn't update too much. If the chunk isn't being watched it will
+instead be flagged to update the next time an AI Eye moves near it.
new turfs that we couldnt see last update but can now
+turfs that we could see last update but cant see now
+Create a new camera chunk, since the chunks are made as they are needed.
add
+
+
Add an AI eye to the chunk, then update if changed.
hasChanged
+
+
Updates the chunk, makes sure that it doesn't update too much. If the chunk isn't being watched it will
+instead be flagged to update the next time an AI Eye moves near it.
remove
+
+
Remove an AI eye from the chunk
update
+
+
The actual updating. It gathers the visible turfs from cameras and puts them into the appropiate lists.
visibilityChanged
+
+
Called when a chunk has changed. I.E: A wall was deleted.
Never access this proc directly!!!!
+This will update the chunk and all the surrounding chunks.
+It will also add the atom to the cameras list if you set the choice to 1.
+Setting the choice to 0 will remove the camera from the chunks.
+If you want to update the chunks around an object, without adding/removing a camera, use choice 2.
Will check if a mob is on a viewable turf. Returns 1 if it is, otherwise returns 0.
chunkGenerated
+
+
Checks if a chunk has been Generated in x, y, z.
majorChunkChange
+
+
Never access this proc directly!!!!
+This will update the chunk and all the surrounding chunks.
+It will also add the atom to the cameras list if you set the choice to 1.
+Setting the choice to 0 will remove the camera from the chunks.
+If you want to update the chunks around an object, without adding/removing a camera, use choice 2.
removeCamera
+
+
Removes a camera from a chunk.
updatePortableCamera
+
+
Used for Cyborg cameras. Since portable cameras can be in ANY chunk.
updateVisibility
+
+
Updates the chunks that the turf is located in. Use this when obstacles are destroyed or when doors open.
visibility
+
+
Updates what the aiEye can see. It is recommended you use this when the aiEye moves or it's location is set.
+
+
+
diff --git a/datum/can_pass_info.html b/datum/can_pass_info.html
new file mode 100644
index 000000000000..58186219d2f1
--- /dev/null
+++ b/datum/can_pass_info.html
@@ -0,0 +1,173 @@
+
+
+
+
+
+
+ /datum/can_pass_info - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Holds all information about what an atom can move through
+Passed into CanAStarPass to provide context for a pathing attempt
+
Also used to check if using a cached path_map is safe
+There are some vars here that are unused. They exist to cover cases where caller_ref is used
+They're the properties of caller_ref used in those cases.
+It's kinda annoying, but there's some proc chains we can't convert to this datum
Weakref to the caller used to generate this info
+Should not use this almost ever, it's for context and to allow for proc chains that
+Require a movable
Weakref to the caller used to generate this info
+Should not use this almost ever, it's for context and to allow for proc chains that
+Require a movable
An extra descriptor for the card. Combined with the cardtype for a larger card descriptor, i.e. Creature- Xenomorph, Spell- Instant, that sort of thing. For creatures, this has no effect, for spells, this is important.
Unique ID, for use in lookups and (eventually) for persistence. MAKE SURE THIS IS UNIQUE FOR EACH CARD IN AS SERIES, OR THE ENTIRE SYSTEM WILL BREAK, AND I WILL BE VERY DISAPPOINTED.
Searches for keywords in the card's variables, marked by wrapping them in {$}
+Adds on hovor logic to them, using the passed in list
+We use the changed_vars list just to make the var searching faster
An extra descriptor for the card. Combined with the cardtype for a larger card descriptor, i.e. Creature- Xenomorph, Spell- Instant, that sort of thing. For creatures, this has no effect, for spells, this is important.
Unique ID, for use in lookups and (eventually) for persistence. MAKE SURE THIS IS UNIQUE FOR EACH CARD IN AS SERIES, OR THE ENTIRE SYSTEM WILL BREAK, AND I WILL BE VERY DISAPPOINTED.
What it costs to summon this card to the battlefield.
Proc Details
apply
+
+
For each var that the card datum and the json entry share, we set the datum var to the json entry
applyKeywords
+
+
Searches for keywords in the card's variables, marked by wrapping them in {$}
+Adds on hovor logic to them, using the passed in list
+We use the changed_vars list just to make the var searching faster
This datum exists to make the large, repeated "everything in some range" pattern faster
+Rather then just refreshing against everything, we track all the cells in range of the passed in "window"
+This lets us do entered/left logic, and make ordinarially quite expensive logic much cheaper
+
Note: This system should not be used for things who have strict requirements about what is NOT in their processed entries
+It should instead only be used for logic that only really cares about limiting how much gets "entered" in any one call
+Because we apply this limitation, we can do things to make our code much less prone to unneeded work
Pull out all the new and old memebers we want
+Recalculates our member list, returns a list in the form list(new members, old members) for reaction
+Accepts the turf to use as our "center"
Returns a list of newly and formerly joined spatial grid managed objects of type [type] in the form list(new, old)
+Takes the center of our window as input
Accepts a width and height to use for this tracker
+Also accepts the ratio to use between inner and outer window. Optional, defaults to 2
recalculate_cells
+
+
Pull out all the new and old memebers we want
+Recalculates our member list, returns a list in the form list(new members, old members) for reaction
+Accepts the turf to use as our "center"
recalculate_type_members
+
+
Returns a list of newly and formerly joined spatial grid managed objects of type [type] in the form list(new, old)
+Takes the center of our window as input
set_bounds
+
+
Takes a width and height, and uses them to set the inner window, and interpolate the outer window
+
+
+
diff --git a/datum/cellular_emporium.html b/datum/cellular_emporium.html
new file mode 100644
index 000000000000..cf85b4ae56ea
--- /dev/null
+++ b/datum/cellular_emporium.html
@@ -0,0 +1,43 @@
+
+
+
+
+
+
+ /datum/cellular_emporium - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Cached icons to show what language the user is speaking
+Applies final animations to overlay CHAT_MESSAGE_EOL_FADE deciseconds prior to message deletion,
+sets timer for scheduling deletion
Contains the scheduled destruction time, used for scheduling EOL
Proc Details
New
+
+
Constructs a chat message overlay
+
Arguments:
+
+
text - The text content of the overlay
+
target - The target atom to display the overlay at
+
owner - The mob that owns this overlay, only this mob will be able to view it
+
language - The language this message was spoken in
+
extra_classes - Extra classes to apply to the span that holds the text
+
lifespan - The lifespan of the message in deciseconds
+
end_of_life
+
+
Cached icons to show what language the user is speaking
+Applies final animations to overlay CHAT_MESSAGE_EOL_FADE deciseconds prior to message deletion,
+sets timer for scheduling deletion
+
Arguments:
+
+
fadetime - The amount of time to animate the message's fadeout for
+
generate_image
+
+
Generates a chat message image representation
+
Arguments:
+
+
text - The text content of the overlay
+
target - The target atom to display the overlay at
+
owner - The mob that owns this overlay, only this mob will be able to view it
+
language - The language this message was spoken in
+
extra_classes - Extra classes to apply to the span that holds the text
+
lifespan - The lifespan of the message in deciseconds
+
on_parent_qdel
+
+
Calls qdel on the chatmessage when its parent is deleted, used to register qdel signal
FermiChem! - See fermi_readme.md
+Required temperature for the reaction to begin, for fermimechanics it defines the lower area of bell curve for determining heat based rate reactions, aka the minimum
How much the temperature changes per unit of chem used. without REACTION_HEAT_ARBITARY flag the rate of change depends on the holder heat capacity else results are more accurate
REACTION PROCS
+Shit that happens on reaction
+Only procs at the START of a reaction
+use reaction_step() for each step of a reaction
+or reaction_end() when the reaction stops
+If reaction_flags & REACTION_INSTANT then this is the only proc that is called.
Occurs when a reation is overheated (i.e. past it's overheatTemp)
+Will be called every tick in the reaction that it is overheated
+If you want this to be a once only proc (i.e. the reaction is stopped after) set reaction.toDelete = TRUE
+The above is useful if you're writing an explosion
+By default the parent proc will reduce the final yield slightly. If you don't want that don't add ..()
Stuff that occurs at the end of a reaction. This will proc if the beaker is forced to stop and start again (say for sudden temperature changes).
+Only procs at the END of reaction
+If reaction_flags & REACTION_INSTANT then this isn't called
Stuff that occurs in the middle of a reaction
+Only procs DURING a reaction
+If reaction_flags & REACTION_INSTANT then this isn't called
+returning END_REACTION will END the reaction
FermiChem! - See fermi_readme.md
+Required temperature for the reaction to begin, for fermimechanics it defines the lower area of bell curve for determining heat based rate reactions, aka the minimum
How much the temperature changes per unit of chem used. without REACTION_HEAT_ARBITARY flag the rate of change depends on the holder heat capacity else results are more accurate
Proc Details
chemical_mob_spawn
+
+
Magical mob spawning when chemicals react
+
Your go to proc when you want to create new mobs from chemicals. please dont use on_reaction.
+Arguments:
+
+
holder - the datum that holds this reagent, be it a beaker or anything else
+
amount_to_spawn - how much /mob to spawn
+
reaction_name - what is the name of this reaction. be creative, the world is your oyster after all!
+
mob_class - determines if the mob will be friendly, neutral or hostile
+
mob_faction - used in determining targets, mobs from the same faction won't harm eachother.
+
random - creates random mobs. self explanatory.
+
clear_products
+
+
Clears the beaker of the product only
clear_reactants
+
+
Clears the beaker of the reagents only
+if volume is not set, it will remove all of the reactant
clear_reagents
+
+
Clears the beaker of ALL reagents inside
default_explode
+
+
Generic explosions/failures
explode_fire
+
+
BEGIN FIRE BASED EXPLOSIONS
freeze_radius
+
+
END FIRE BASED EXPLOSIONS
on_reaction
+
+
REACTION PROCS
+Shit that happens on reaction
+Only procs at the START of a reaction
+use reaction_step() for each step of a reaction
+or reaction_end() when the reaction stops
+If reaction_flags & REACTION_INSTANT then this is the only proc that is called.
+
Proc where the additional magic happens.
+You dont want to handle mob spawning in this since there is a dedicated proc for that.client
+Arguments:
+
+
holder - the datum that holds this reagent, be it a beaker or anything else
+
created_volume - volume created when this is mixed. look at 'var/list/results'.
+
overheated
+
+
Occurs when a reation is overheated (i.e. past it's overheatTemp)
+Will be called every tick in the reaction that it is overheated
+If you want this to be a once only proc (i.e. the reaction is stopped after) set reaction.toDelete = TRUE
+The above is useful if you're writing an explosion
+By default the parent proc will reduce the final yield slightly. If you don't want that don't add ..()
+
Arguments:
+
+
holder - the datum that holds this reagent, be it a beaker or anything else
+
equilibrium - the equilibrium datum that contains the equilibrium reaction properties and methods
+
step_volume_added - how much product (across all products) was added for this single step
+
reaction_finish
+
+
Stuff that occurs at the end of a reaction. This will proc if the beaker is forced to stop and start again (say for sudden temperature changes).
+Only procs at the END of reaction
+If reaction_flags & REACTION_INSTANT then this isn't called
+
Proc where the additional magic happens.
+You dont want to handle mob spawning in this since there is a dedicated proc for that.client
+Arguments:
+
+
holder - the datum that holds this reagent, be it a beaker or anything else
+
react_volume - volume created across the whole reaction
+
reaction_step
+
+
Stuff that occurs in the middle of a reaction
+Only procs DURING a reaction
+If reaction_flags & REACTION_INSTANT then this isn't called
+returning END_REACTION will END the reaction
+
Arguments:
+
+
reaction - the equilibrium reaction holder that is reaction is processed within - use this to edit delta_t and delta
+
holder - the datum that holds this reagent, be it a beaker or anything else
+
created_volume - volume created per step
+
added_purity - how pure the created volume is per step
+
+
Outputs:
+
+
returning END_REACTION will end the associated reaction - flagging it for deletion and preventing any reaction in that timestep from happening. Make sure to set the vars in the holder to one that can't start it from starting up again.
+
update_info
+
+
Updates information during the roundstart
+
This proc is mainly used by explosives but can be used anywhere else
+You should generally use the special reactions in /datum/chemical_reaction/randomized
+But for simple variable edits, like changing the temperature or adding/subtracting required reagents it is better to use this.
+
+
+
diff --git a/datum/chemical_reaction/randomized.html b/datum/chemical_reaction/randomized.html
new file mode 100644
index 000000000000..ad277262ad1c
--- /dev/null
+++ b/datum/chemical_reaction/randomized.html
@@ -0,0 +1,78 @@
+
+
+
+
+
+
+ /datum/chemical_reaction/randomized - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Used to generate composite types from anything that was generated
+before global variables were all initialized.
+Used for when composite datatypes are used in globally defined lists, before GLOB.circuit_datatypes is available.
Generates a name for the datatype using the unique list of composite datatypes.
+This should always generate a constant value for the input given as it is used as
+the unique identifier
Used to generate composite types from anything that was generated
+before global variables were all initialized.
+Used for when composite datatypes are used in globally defined lists, before GLOB.circuit_datatypes is available.
generate_composite_type
+
+
Generates a composite type using this template. Not recommended to use directly, use a define instead.
+
Arguments:
+
+
composite_datatypes - The list of composite datatypes to use to generate this type.
+
generate_name
+
+
Generates a name for the datatype using the unique list of composite datatypes.
+This should always generate a constant value for the input given as it is used as
+the unique identifier
Determines if a datatype is compatible with another port of a different type.
+Note: This is ALWAYS called on the input port, never on the output port.
+Inputs need to care about what types they're receiving, output ports don't have to care.
Similar to convert value, however it doesn't get called by a port when a value is set. Useful for extensive conversions that may only need to be done for player inputs (e.g. lists)
Determines if a port is compatible with this datatype.
+This WILL throw a runtime if it returns false. This is for sanity checking and it should not return false
+unless under extraordinary circumstances or people fail to write proper code.
Whether we should extensively convert this datatype, important for composite lists who may not have datatypes that need implicit conversions
Proc Details
can_receive_from_datatype
+
+
Determines if a datatype is compatible with another port of a different type.
+Note: This is ALWAYS called on the input port, never on the output port.
+Inputs need to care about what types they're receiving, output ports don't have to care.
+
Arguments:
+
+
datatype_to_check - The datatype to check
+
convert_value
+
+
Returns the value to be set for the port
+
Used for implicit conversions between outputs and inputs (e.g. number -> string)
+and applying/removing signals on inputs
convert_value_extensive
+
+
Similar to convert value, however it doesn't get called by a port when a value is set. Useful for extensive conversions that may only need to be done for player inputs (e.g. lists)
datatype_ui_data
+
+
The data to send to the UI attached to the port. Received by the type in FUNDAMENTAL_PORT_TYPES
+
Arguments:
+
+
port - The port sending the data.
+
get_datatype
+
+
Used by composite datatypes. Returns a single datatype from the list if it exists by index.
get_datatypes
+
+
Used by composite datatypes. Returns all the datatypes that build this datatype up.
handle_manual_input
+
+
When an input is manually set by a player. This is where extra sanitizing can happen. Will still call convert_value()
+
Arguments:
+
+
port - The port sending the data.
+
is_compatible
+
+
Determines if a port is compatible with this datatype.
+This WILL throw a runtime if it returns false. This is for sanity checking and it should not return false
+unless under extraordinary circumstances or people fail to write proper code.
+
Arguments:
+
+
port - The port to check if it is compatible.
+
on_gain
+
+
Called when the datatype is given to a port.
+
Arguments:
+
+
gained_port - The gained port.
+
on_loss
+
+
Called when the datatype is removed from a port.
+
Arguments:
+
+
lost_port - The removed port.
+
+
+
+
diff --git a/datum/circuit_datatype/composite_instance.html b/datum/circuit_datatype/composite_instance.html
new file mode 100644
index 000000000000..8ca6c6fe91bd
--- /dev/null
+++ b/datum/circuit_datatype/composite_instance.html
@@ -0,0 +1,50 @@
+
+
+
+
+
+
+ /datum/circuit_datatype/composite_instance - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Client Colour Priority System By RemieRichards (then refactored by another contributor)
+A System that gives finer control over which client.colour value to display on screen
+so that the "highest priority" one is always displayed as opposed to the default of
+"whichever was set last is displayed".
+
Refactored to allow multiple overlapping client colours
+(e.g. wearing blue glasses under a yellow visor, even though the result is a little unsatured.)
+As well as some support for animated colour transitions.
We prioritize colours with higher priority (lower numbers), so they don't get overriden by less important ones:
+eg: "Bloody screen" > "goggles colour" as the former is much more important
We prioritize colours with higher priority (lower numbers), so they don't get overriden by less important ones:
+eg: "Bloody screen" > "goggles colour" as the former is much more important
Proc Details
update_colour
+
+
Sets a new colour, then updates the owner's screen colour.
+
+
+
diff --git a/datum/client_interface.html b/datum/client_interface.html
new file mode 100644
index 000000000000..84d3487b85f2
--- /dev/null
+++ b/datum/client_interface.html
@@ -0,0 +1,43 @@
+
+
+
+
+
+
+ /datum/client_interface - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Used to test the game for issues with different types of color blindness
+WARNING ASSHOLE: Because we can only apply matrixes, and can't preform gamma correction
+https://web.archive.org/web/20220227030606/https://ixora.io/projects/colorblindness/color-blindness-simulation-research/
+The results of this tool aren't perfect. It's way better then nothing, but IT IS NOT A PROPER SIMULATION
+Please do not make us look like assholes by assuming it is. Thanks.
List of simulated blindness -> matrix to use
+Most of these matrixes are based off https://web.archive.org/web/20220227030606/https://ixora.io/projects/colorblindness/color-blindness-simulation-research/
+AGAIN, THESE ARE NOT PERFECT BECAUSE WE CANNOT COMPUTE GAMMA CORRECTION, AND CONVERT SRGB TO LINEAR RGB
+Do not assume this is absolute
List of simulated blindness -> matrix to use
+Most of these matrixes are based off https://web.archive.org/web/20220227030606/https://ixora.io/projects/colorblindness/color-blindness-simulation-research/
+AGAIN, THESE ARE NOT PERFECT BECAUSE WE CANNOT COMPUTE GAMMA CORRECTION, AND CONVERT SRGB TO LINEAR RGB
+Do not assume this is absolute
+
+
+
diff --git a/datum/command_report_menu.html b/datum/command_report_menu.html
new file mode 100644
index 000000000000..67b6fbebf6b2
--- /dev/null
+++ b/datum/command_report_menu.html
@@ -0,0 +1,78 @@
+
+
+
+
+
+
+ /datum/command_report_menu - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
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
Removes the component from parent, ends up with a null parent
+Used as a helper proc by the component transfer proc, does not clean up the component like Destroy does
C's type will always be the same of the called component
+
return TRUE if you are absorbing the component, otherwise FALSE if you are fine having it exist as a duplicate component
ClearFromParent
+
+
Removes the component from parent, ends up with a null parent
+Used as a helper proc by the component transfer proc, does not clean up the component like Destroy does
Destroy
+
+
Properly removes the component from parent and cleans up references
+
Arguments:
+
+
force - makes it not check for and remove the component from the parent
Fish sprite how to:
+Need to be centered on 16,16 in the dmi and facing left by default.
+sprite_height/sprite_width is the size it will have in aquarium and used to control animation boundaries.
+source_height/source_width is the size of the original icon (ideally only the non-empty parts)
+Icon used for in aquarium sprite
If this is set this icon state will be used for the holder while icon_state will only be used for item/catalog. Transformation from source_width/height WON'T be applied.
Fish sprite how to:
+Need to be centered on 16,16 in the dmi and facing left by default.
+sprite_height/sprite_width is the size it will have in aquarium and used to control animation boundaries.
+source_height/source_width is the size of the original icon (ideally only the non-empty parts)
+Icon used for in aquarium sprite
If this is set this icon state will be used for the holder while icon_state will only be used for item/catalog. Transformation from source_width/height WON'T be applied.
Component for atmos-related atoms to be able to record and transmit their reaction_results data
+Use this ONLY for atoms, gasmixtures will be accessed by calling return air on the object.
+Add this component after gasmixes has been initialized.
Applies healing to those in the area.
+Will provide them with an alert while they're in range, as well as
+give them a healing particle.
+Can be applied to those only with a trait conditionally.
Component for clothing items that can pick up blood from decals and spread it around everywhere when walking, such as shoes or suits with integrated shoes.
If an ojvect 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.
This component adds a near-invisible underlay to a movable target to expand the clickable surface of its icon without
+resorting to MOUSE_OPACITY_OPAQUE.
+The underlay ignores the parent's color and alpha and can be offset.
+The name is a portmanteau of "click" and "hitbox", because technically this isn't an hitbox,
+but it helps catch clicks, and I don't want to give it a loooong name like openspace_item_click_handler
Component that allows for highlighting of words or phrases in chat based on regular expressions.
+
Hooks into the parent's COMSIG_MOVABLE_HEAR signal 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)].
Do the flooding. Trigger temperature is the temperature we will flood at if we dont have a temp set at the start. Trigger referring to whatever triggered it.
Welder check. Here because tool_act is higher priority than attackby.
Proc Details
attackby_react
+
+
Being attacked by something
flame_react
+
+
fire_act reaction.
flood
+
+
Do the flooding. Trigger temperature is the temperature we will flood at if we dont have a temp set at the start. Trigger referring to whatever triggered it.
hotspots_react
+
+
Hotspot reaction.
projectile_react
+
+
Shot by something
welder_react
+
+
Welder check. Here because tool_act is higher priority than attackby.
+
+
+
diff --git a/datum/component/connect_containers.html b/datum/component/connect_containers.html
new file mode 100644
index 000000000000..b3f5bf7b160e
--- /dev/null
+++ b/datum/component/connect_containers.html
@@ -0,0 +1,45 @@
+
+
+
+
+
+
+ /datum/component/connect_containers - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
This component behaves similar to connect_loc, hooking into a signal on a tracked object's turf
+It has the ability to react to that signal on behalf of a separate listener however
+This has great use, primarily for components, but it carries with it some overhead
+So we do it separately as it needs to hold state which is very likely to lead to bugs if it remains as an element.
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
This component behaves similar to connect_loc_behalf but for all turfs in range, hooking into a signal on each of them.
+Just like connect_loc_behalf, It can react to that signal on behalf of a seperate listener.
+Good for components, though it carries some overhead. Can't be an element as that may lead to bugs.
The atom the component is tracking. The component will delete itself if the tracked is deleted.
+Signals will also be updated whenever it moves (if it's a movable).
The atom the component is tracking. The component will delete itself if the tracked is deleted.
+Signals will also be updated whenever it moves (if it's a movable).
When added to an atom, item ingredients can be put into that.
+The sprite is updated and reagents are transfered.
+
If the component is added to something that is processed, creating new objects (being cut, for example),
+the replacement type needs to also have the component. The ingredients will be copied over. Reagents are not
+copied over since other components already take care of that.
Deployable - Bring your big guns with you, and smack em' down where you want.
+
Allows items to spawn other items (usually objects) in front of the user after a short delay.
+If attaching this to something:
+Set deploy_time to a number in seconds for the deploy delay
+Set thing_to_be_deployed to an obj path for the thing that gets spawned
+Lastly, set delete_on_use to TRUE or FALSE if you want the object you're deploying with to get deleted when used
Component that handles drifting
+Manages a movement loop that actually does the legwork of moving someone
+Alongside dealing with the post movement input blocking required to make things look nice
Should we ignore the next glide rate input we get?
+This is to some extent a hack around the order of operations
+Around COMSIG_MOVELOOP_POSTPROCESS. I'm sorry lad
Should we ignore the next glide rate input we get?
+This is to some extent a hack around the order of operations
+Around COMSIG_MOVELOOP_POSTPROCESS. I'm sorry lad
Proc Details
Initialize
+
+
Accepts three args. The direction to drift in, if the drift is instant or not, and if it's not instant, the delay on the start
handle_glidesize_update
+
+
We're going to take the passed in glide size
+and use it to manually delay our loop for that period
+to allow the other movement to complete
stopped_pulling
+
+
If we're pulling something and stop, we want it to continue at our rate and such
Component that manages how many eggs to lay, what can be fed to the mob to make them lay more, and what is actually laid.
+Since the only real interaction with the component is an attackby, the nice part is that we're able to make this an atom level proc.
+egg_layer will loudly fail if you do not provide it the arguments, as to encourage explicicy(?)
attach it to any atom/movable that can be buckled to in order to have it shock mobs buckled to it. by default it shocks mobs buckled to parent every shock_loop_time.
+the parent is supposed to define its behavior with arguments in AddComponent
this signal was given as an argument to register for parent to emit, if its emitted to parent then shock_on_demand is called. var is so it can be unregistered
this signal was given as an argument to register for parent to emit, if its emitted to parent then shock_on_demand is called. var is so it can be unregistered
these flags tells this instance what is required in order to allow shocking
Proc Details
Initialize
+
+
Initialize args:
+
+
input_requirements - bitflag that defines how the component is supposed to act, see __DEFINES/electrified_buckle.dm for the options. sets usage_flags
+
input_item - if set to an item and input_requirements has SHOCK_REQUIREMENT_ITEM, moves that item inside parent and the component will delete itself if input_item no longer exists/moves out of parent. sets required_object
+
overlays_to_add - pass in a list of images and the component will add them to parent as well as remove them in UnregisterFromParent(). sets requested_overlays
+
override_buckle - if TRUE, sets parent.can_buckle = TRUE and resets it on UnregisterFromParent(), usually objects that have need to be overridden will look janky on buckle
+
damage_on_shock - if SHOCK_REQUIREMENT_LIVE_CABLE is not set in input_requirements, then this is how much damage each shock does. sets shock_damage
+
signal_to_register_from_parent - if set, the component registers to listen for this signal targeting parent to manually shock. sets requested_signal_parent_emits
+
process
+
+
where the guinea pig is actually shocked if possible
Called when a carbon with an object embedded/stuck to them inspects themselves and clicks the appropriate link to begin ripping the item out. This handles the ripping attempt, descriptors, and dealing damage, then calls safe_remove()
This proc handles the final step and actual removal of an embedded/stuck item from a carbon, whether or not it was actually removed safely.
+If you want the thing to go into someone's hands rather than the floor, pass them in to_hands
if both our pain multiplier and jostle pain multiplier are 0, we're harmless and can omit most of the damage related stuff
Proc Details
checkTweeze
+
+
The signal for listening to see if someone is using a hemostat on us to pluck out this object
complete_rip_out
+
+
everything async that ripOut used to do
fallOut
+
+
Called when then item randomly falls out of a carbon. This handles the damage and descriptors, then calls safe_remove()
jostleCheck
+
+
/////////BEHAVIOR PROCS//////////////
+
Called every time a carbon with a harmful embed moves, rolling a chance for the item to cause pain. The chance is halved if the carbon is crawling or walking.
on_healthscan
+
+
Called whenever the limb owner is health scanned
ripOut
+
+
Called when a carbon with an object embedded/stuck to them inspects themselves and clicks the appropriate link to begin ripping the item out. This handles the ripping attempt, descriptors, and dealing damage, then calls safe_remove()
safeRemove
+
+
This proc handles the final step and actual removal of an embedded/stuck item from a carbon, whether or not it was actually removed safely.
+If you want the thing to go into someone's hands rather than the floor, pass them in to_hands
tweezePluck
+
+
The actual action for pulling out an embedded object with a hemostat
weaponDeleted
+
+
Something deleted or moved our weapon while it was embedded, how rude!
Component specifically for explosion sensetive things, currently only applies to heat based explosions but can later perhaps be used for things that are dangerous to handle carelessly like nitroglycerin.
component attached to items, lets them be used in hand once to add yourself to a certain faction
+one good example is the chaplain plushie that grants you the carp faction, making you friendly with them.
--Food storage component--
+This component lets you slide one item into large foods, such as bread, cheese wheels, or cakes.
+Consuming food storages with an item inside can cause unique interactions, such as eating glass shards.
Genetic damage, given by DNA consoles, will start to deal toxin damage
+past a certain threshold, and will go down consistently.
+Adding multiple of this component will increase the total damage.
+Can turn monkeys into gorillas.
This is a relatively simple component that attempts to deter the parent of the component away
+from a specific area or areas. By default it simply applies a penalty where all movement is
+four times slower than usual and any action that would affect your 'next move' has a penalty
+multiplier of 4 attached.
This signal handler does a few house cleaning tasks when a new area is created.
+If the created area already exists in the blacklist or whitelist it simply returns,
+however if it isn't we check for an overwritten area and if non-hazardous setup the area to
+allow the parent.
+If there isnt an overwritten area it assumes it to be non-hazardous, abuse it and you will weep -ZephyrTFA
A variable storing the typepath of the last checked area to prevent any further logic running if it has not changed
Proc Details
check_area_hazardous
+
+
Checks if the area being checked is considered hazardous
+The whitelist is checked first if it exists, otherwise it checks if it is in the blacklist
+
+
checking - This should be the typepath of the area being checked, but there is a conversion handler if you pass in a reference instead
+
handle_parent_area_change
+
+
This signal should be called whenever our parent moves.
on_area_creation
+
+
This signal handler does a few house cleaning tasks when a new area is created.
+If the created area already exists in the blacklist or whitelist it simply returns,
+however if it isn't we check for an overwritten area and if non-hazardous setup the area to
+allow the parent.
+If there isnt an overwritten area it assumes it to be non-hazardous, abuse it and you will weep -ZephyrTFA
reject_ladder_movement
+
+
This signal handler checks the area the target ladder is in and if hazardous prevents them from using it
reject_vehicle
+
+
A simple signal handler that informs the parent they cannot ride a vehicle and ejects them
update_parent_status_effect
+
+
This proc handles the status effect applied to the parent, most noteably applying or removing it as required
If we should stabilize ourselves when not drifting
Proc Details
Initialize
+
+
Arguments:
+
+
stabilize - If we should drift when we finish moving, or sit stable in space]
+
activation_signal - Signal we activate on
+
deactivation_signal - Signal we deactivate on
+
return_flag - Flag to return if activation fails
+
get_mover - Callback we use to get the "moving" thing, for trail purposes, alongside signal registration
+
check_on_move - Callback we call each time we attempt a move, we expect it to retun true if the move is ok, false otherwise. It expects an arg, TRUE if fuel should be consumed, FALSE othewise
+
effect_type - Type of trail_follow to spawn
+
block_starting_visuals
+
+
Basically, tell the drift component not to do its starting visuals, because they look dumb for us
ignore_ending_block
+
+
If we're on, don't let the drift component block movements at the end since we can speed
thrust
+
+
Returns true if the thrust went well, false otherwise
Bitflag used in equip to determine what slots we need to be in to be knocked off.
+If set, we must be equipped in one of the slots to have a chance of our item being knocked off.
+If unset / NONE, a disarm or knockdown will have a chance of our item being knocked off regardless of slot, INCLUDING hand slots.
Used in being disarmed.
+If set, we will only roll the knockoff chance if the disarmer is targeting one of these zones.
+If unset, any disarm act will cause the knock-off chance to be rolled, no matter the zone targeted.
Bitflag used in equip to determine what slots we need to be in to be knocked off.
+If set, we must be equipped in one of the slots to have a chance of our item being knocked off.
+If unset / NONE, a disarm or knockdown will have a chance of our item being knocked off regardless of slot, INCLUDING hand slots.
Used in being disarmed.
+If set, we will only roll the knockoff chance if the disarmer is targeting one of these zones.
+If unset, any disarm act will cause the knock-off chance to be rolled, no matter the zone targeted.
Proc Details
on_dropped
+
+
Signal proc for COMSIG_ITEM_DROPPED
+Unregisters our signals which can cause a knockdown when we're unequipped (dropped)
on_equipped
+
+
Signal proc for COMSIG_ITEM_EQUIPPED
+Registers our signals which can cause a knockdown whenever we're equipped correctly
on_equipped_mob_disarm
+
+
Signal proc for COMSIG_HUMAN_DISARM_HIT on the mob who's equipped our parent
+Rolls a chance for knockoff whenever we're disarmed
on_equipped_mob_knockdown
+
+
Signal proc for COMSIG_LIVING_STATUS_KNOCKDOWN on the mob who's equipped our parent
+Rolls a chance for knockoff whenever we're knocked down
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.
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.
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.
The name of the label the player is applying to the parent.
Proc Details
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.
+
Arguments:
+
+
source: The parent.
+
user: The mob exmaining the parent.
+
examine_list: The current list of text getting passed from the parent's normal examine() proc.
+
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.
+
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:
+
+
source: The parent.
+
attacker: The object that is hitting the parent.
+
user: The mob who is wielding the attacking object.
+
apply_label
+
+
Applies a label to the name of the parent in the format of: "parent_name (label)"
For consuming a dictionary of materials. mats is the map of materials to use and the corresponding amounts, example: list(M/datum/material/glass =100, datum/material/iron=200)
The total amount of materials this material container contains
Proc Details
Initialize
+
+
Sets up the proper signals and fills the list of materials with the appropriate references.
amount2sheet
+
+
Turns a material amount into the amount of sheets it should output
can_hold_material
+
+
The default check for whether we can add materials to this material container.
+
Arguments:
+
+
mat: The material we are checking for insertability.
+
can_insert_amount_mat
+
+
Proc for checking if there is room in the component, returning the amount or else the amount lacking.
get_categories
+
+
Returns all the categories in a recipe.
get_item_material_amount
+
+
returns the amount of material relevant to this container; if this container does not support glass, any glass in 'I' will not be taken into account
get_material_amount
+
+
Returns the amount of a specific material in this container.
has_enough_of_category
+
+
Returns TRUE if you have enough of a specified material category (Which could be multiple materials)
has_enough_of_material
+
+
Returns TRUE if you have enough of the specified material.
has_materials
+
+
Checks if its possible to afford a certain amount of materials. Takes a dictionary of materials.
has_space
+
+
Proc that returns TRUE if the container has space
insert_amount_mat
+
+
For inserting an amount of material
insert_item
+
+
Proc specifically for inserting items, returns the amount of materials entered.
insert_item_materials
+
+
Inserts the relevant materials from an item into this material container.
+
Arguments:
+
+
source: The source of the materials we are inserting.
+
multiplier: The multiplier for the materials being inserted.
+
breakdown_flags: The breakdown bitflags that will be used to retrieve the materials from the source
+
on_attackby
+
+
Proc that allows players to fill the parent with mats
retrieve_all
+
+
Proc to get all the materials and dump them as sheets
retrieve_sheets
+
+
For spawning mineral sheets at a specific location. Used by machines to output sheets.
sheet2amount
+
+
Turns an amount of sheets into the amount of material amount it should output
transer_amt_to
+
+
Proc for transfering materials to another container.
ui_data
+
+
List format is list(material_name = list(amount = ..., ref = ..., etc.))
use_amount_mat
+
+
Uses an amount of a specific material, effectively removing it.
use_materials
+
+
For consuming a dictionary of materials. mats is the map of materials to use and the corresponding amounts, example: list(M/datum/material/glass =100, datum/material/iron=200)
A component that handles linking multiple player's minds
+into one network which allows them to talk directly to one another.
+Like telepathy but for multiple people at once!
A simple component that spawns a mob of the same type and transfers itself to it when parent dies.
+For more complex behaviors, use the COMSIG_ON_MULTIPLE_LIVES_RESPAWN comsig.
omen.dm: For when you want someone to have a really bad day
+
When you attach an omen component to someone, they start running the risk of all sorts of bad environmental injuries, like nearby vending machines randomly falling on you,
+or hitting your head really hard when you slip and fall, or... well, for now those two are all I have. More will come.
+
Omens are removed once the victim is either maimed by one of the possible injuries, or if they receive a blessing (read: bashing with a bible) from the chaplain.
Whatever's causing the omen, if there is one. Destroying the vessel won't stop the omen, but we destroy the vessel (if one exists) upon the omen ending
Whatever's causing the omen, if there is one. Destroying the vessel won't stop the omen, but we destroy the vessel (if one exists) upon the omen ending
Proc Details
check_accident
+
+
check_accident() is called each step we take
+
While we're walking around, roll to see if there's any environmental hazards (currently only vending machines) on one of the adjacent tiles we can trigger.
+We do the prob() at the beginning to A. add some tension for /when/ it will strike, and B. (more importantly) ameliorate the fact that we're checking up to 5 turfs's contents each time
check_bless
+
+
Hijack the mood system to see if we get the blessing mood event to cancel the omen
check_slip
+
+
If we get knocked down, see if we have a really bad slip and bash our head hard
Movable atom the parent is attached to. For example, a flashlight into a helmet or gun. We'll need to track the thing the parent is attached to as if it were the parent itself.
Movable atom the parent is attached to. For example, a flashlight into a helmet or gun. We'll need to track the thing the parent is attached to as if it were the parent itself.
A component that stores colors for use by painting-related items like spraycans or palettes
+which can be accessed through a radial menu by right clicking the item while it's held by the user mob.
+Right-clicking a color will open a color input prompt to edit it. Left clicking will instead select it
+and call set_painting_tool_color() on the parent for more specific object behavior.
Handles simple payment operations where the cost of the object in question doesn't change.
+
What this is useful for:
+Basic forms of vending.
+Objects that can drain the owner's money linearly.
+What this is not useful for:
+Things where the seller may want to fluxuate the price of the object.
+Improving standardizing every form of payment handing, as some custom handling is specific to that object.
How many shrapnel projectiles are we responsible for tracking? May be reduced for grenades if someone dives on top of it. Defined by ammo casing for casings, derived from magnitude otherwise
For grenades, tracking how many pellets are removed due to martyrs and how many pellets are added due to the last person to touch it being on top of it
create_blast_pellets() is for when we have a central point we want to shred the surroundings of with a ring of shrapnel, namely frag grenades and landmines.
handle_martyrs() is used for grenades that shoot shrapnel to check if anyone threw themselves/were thrown on top of the grenade, thus absorbing a good chunk of the shrapnel
One of our pellets disappeared due to hitting their max range (or just somehow got qdel'd), remove it from our list and check if we're done (terminated == num_pellets)
How many shrapnel projectiles are we responsible for tracking? May be reduced for grenades if someone dives on top of it. Defined by ammo casing for casings, derived from magnitude otherwise
For grenades, tracking how many pellets are removed due to martyrs and how many pellets are added due to the last person to touch it being on top of it
how many pellets ranged out without hitting anything
Proc Details
create_blast_pellets
+
+
create_blast_pellets() is for when we have a central point we want to shred the surroundings of with a ring of shrapnel, namely frag grenades and landmines.
O- Our parent, the thing making the shrapnel obviously (grenade or landmine)
+
punishable_triggerer- For grenade lances or people who step on the landmines (if we shred the triggerer), we spawn extra shrapnel for them in addition to the normal spread
+
create_casing_pellets
+
+
create_casing_pellets() is for directed pellet clouds for ammo casings that have multiple pellets (buckshot and scatter lasers for instance)
+
Honestly this is mostly just a rehash of [/obj/item/ammo_casing/proc/fire_casing] for pellet counts > 1, except this lets us tamper with the pellets and hook onto them for tracking purposes.
+The arguments really don't matter, this proc is triggered by COMSIG_PELLET_CLOUD_INIT which is only for this really, it's just a big mess of the state vars we need for doing the stuff over here.
finalize
+
+
All of our pellets are accounted for, time to go target by target and tell them how many things they got hit by.
grenade_armed
+
+
Look alive, we're armed! Now we start watching to see if anyone's covering us
grenade_dropped
+
+
Someone dropped the grenade, so set them to the shooter in case they're on top of it when it goes off
grenade_moved
+
+
Our grenade has moved, reset var/list/bodies so we're "on top" of any mobs currently on the tile
grenade_uncrossed
+
+
Someone who was originally "under" the grenade has moved off the tile and is now eligible for being a martyr and "covering" it
handle_martyrs
+
+
handle_martyrs() is used for grenades that shoot shrapnel to check if anyone threw themselves/were thrown on top of the grenade, thus absorbing a good chunk of the shrapnel
+
Between the time the grenade is armed and the actual detonation, we set var/list/bodies to the list of mobs currently on the new tile, as if the grenade landed on top of them, tracking if any of them move off the tile and removing them from the "under" list
+Once the grenade detonates, handle_martyrs() is called and gets all the new mobs on the tile, and add the ones not in var/list/bodies to var/list/martyrs
+We then iterate through the martyrs and reduce the shrapnel magnitude for each mob on top of it, shredding each of them with some of the shrapnel they helped absorb. This can snuff out all of the shrapnel if there's enough bodies
+
Note we track anyone who's alive and client'd when they get shredded in var/list/purple_hearts, for achievement checking later
nullspace_parent
+
+
Our grenade or landmine or caseless shell or whatever tried deleting itself, so we intervene and nullspace it until we're done here
on_target_qdel
+
+
Someone who was originally "under" the grenade has moved off the tile and is now eligible for being a martyr and "covering" it
pellet_hit
+
+
One of our pellets hit something, record what it was and check if we're done (terminated == num_pellets)
pellet_range
+
+
One of our pellets disappeared due to hitting their max range (or just somehow got qdel'd), remove it from our list and check if we're done (terminated == num_pellets)
pew
+
+
Minor convenience function for creating each shrapnel piece with circle explosions, mostly stolen from the MIRV component
If the mob containing our lich's mind is killed,
+we can initiate the revival process.
+
We use the global mob death signal here,
+instead of registering the normal death signal,
+as it's entirely possible the wizard mindswaps
+or is gibbed or something wacky happens, and
+we need to make sure WHOEVER has our mind is dead
Minds shouldn't be getting deleted but if for some ungodly reason
+the lich'd mind is deleted our component should go with it, as
+we don't have a reason to exist anymore.
revive_lich
+
+
Actually undergo the process of reviving the lich at the site of the phylacery.
+
Arguments
+
+
corpse - optional, the old body of the lich. Can be QDELETED or null.
Begins the countdown before a target can be irradiated.
+Added by the radiation subsystem when a pulse information has a minimum exposure time.
+Will clear itself out after a while.
Allows the parent to act similarly to the Altar of Gods with modularity. Invoke and Sect Selection is done via attacking with a bible. This means you cannot sacrifice Bibles (you shouldn't want to do this anyways although now that I mentioned it you probably will want to).
This component is used to manage names and descriptions changed with the pen.
+
Atoms can only have one instance of this component at a time.
+
When a player renames or changes the description of an atom with a pen, this component gets applied to it.
+If a player resets the name and description, they will be reverted to their state before being changed and the component will be removed.
This proc will fire after the parent's name or desc is changed with a pen, which is trying to apply another rename component.
+Since the parent already has a rename component, it will remove the old one and apply the new one.
+The name and description changes will be merged or overwritten.
This proc will fire after the parent's name or desc is changed with a pen, which is trying to apply another rename component.
+Since the parent already has a rename component, it will remove the old one and apply the new one.
+The name and description changes will be merged or overwritten.
apply_rename
+
+
Saves the current name and description before changing them to the player's inputs.
revert_rename
+
+
Reverts the name and description to the state before they were changed.
This is the riding component, which is applied to a movable atom by the ridable element when a mob is successfully buckled to said movable.
+
This component lives for as long as at least one mob is buckled to the parent. Once all mobs are unbuckled, the component is deleted, until another mob is buckled in
+and we make a new riding component, so on and so forth until the sun explodes.
If the driver needs a certain item in hand (or inserted, for vehicles) to drive this. For vehicles, this must be duplicated on the actual vehicle object in their
+/obj/vehicle/var/key_type variable because the vehicle objects still have a few special checks/functions of their own I'm not porting over to the riding component
+quite yet. Make sure if you define it on the vehicle, you define it here too.
Ride check flags defined for the specific riding component types, so we know if we need arms, legs, or whatever.
+Takes additional flags from the ridable element and the buckle proc (buckle_mob_flags) for riding cyborgs/humans in case we need to reserve arms
This proc is used to see if we have the appropriate key to drive this atom, if such a key is needed. Returns FALSE if we don't have what we need to drive.
Check to see if we have all of the necessary bodyparts and not-falling-over statuses we need to stay onboard.
+If not and if consequences is TRUE, well, there'll be consequences.
If the driver needs a certain item in hand (or inserted, for vehicles) to drive this. For vehicles, this must be duplicated on the actual vehicle object in their
+/obj/vehicle/var/key_type variable because the vehicle objects still have a few special checks/functions of their own I'm not porting over to the riding component
+quite yet. Make sure if you define it on the vehicle, you define it here too.
Ride check flags defined for the specific riding component types, so we know if we need arms, legs, or whatever.
+Takes additional flags from the ridable element and the buckle proc (buckle_mob_flags) for riding cyborgs/humans in case we need to reserve arms
tick delay between movements, lower = faster, higher = slower
Proc Details
driver_move
+
+
Every time the driver tries to move, this is called to see if they can actually drive and move the vehicle (via relaymove)
handle_specials
+
+
This proc handles all of the proc calls to things like set_vehicle_dir_layer() that a type of riding datum needs to call on creation
+
The original riding component had these procs all called from the ridden object itself through the use of GetComponent() and LoadComponent()
+This was obviously problematic for componentization, but while lots of the variables being set were able to be moved to component variables,
+the proc calls couldn't be. Thus, anything that has to do an initial proc call should be handled here.
handle_vehicle_layer
+
+
Some ridable atoms may want to only show on top of the rider in certain directions, like wheelchairs
keycheck
+
+
This proc is used to see if we have the appropriate key to drive this atom, if such a key is needed. Returns FALSE if we don't have what we need to drive.
+
Still needs to be neatened up and spruced up with proper OOP, as a result of vehicles having their own key handling from other ridable atoms
ride_check
+
+
Check to see if we have all of the necessary bodyparts and not-falling-over statuses we need to stay onboard.
+If not and if consequences is TRUE, well, there'll be consequences.
riding_can_z_move
+
+
Extra checks before buckled.can_z_move can be called in mob/living/can_z_move()
unequip_buckle_inhands
+
+
currently replicated from ridable because we need this behavior here too, see if we can deal with that
vehicle_bump
+
+
So we can check all occupants when we bump a door to see if anyone has access
vehicle_mob_buckle
+
+
This proc is called when a rider buckles, allowing for offsets to be set properly
vehicle_mob_unbuckle
+
+
This proc is called when a rider unbuckles, whether they chose to or not. If there's no more riders, this will be the riding component's death knell.
vehicle_moved
+
+
This is called after the ridden atom is successfully moved and is used to handle icon stuff
After we somehow moved (because ss13 is godless and does not respect anything), how long do we need to stand still to feel safe to setup our "behind" area again
see_through_map is a define pointing to a specific map. It's basically defining the area which is considered behind. See see_through_maps.dm for a list of maps
After we somehow moved (because ss13 is godless and does not respect anything), how long do we need to stand still to feel safe to setup our "behind" area again
A list of turfs on which we make ourself transparent
Proc Details
Initialize
+
+
see_through_map is a define pointing to a specific map. It's basically defining the area which is considered behind. See see_through_maps.dm for a list of maps
clear_image
+
+
Remove a screen image from a client
dismantle_perimeter
+
+
Unrout ourselves after we somehow moved, and start a timer so we can re-restablish our behind area after standing still for a bit
on_client_disconnect
+
+
Image is removed when they log out because client gets deleted, so drop the mob reference
on_entered
+
+
Someone entered one of our tiles, so sent an override overlay and a cute animation to make us fade out a bit
on_exited
+
+
Remove the screen object and make us appear solid to the client again
setup_perimeter
+
+
Loop through a list with relative coordinate lists to mark those tiles and hide our parent when someone enters those tiles
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)
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_check_block
+
+
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_equipped
+
+
Check if we've been equipped to a valid slot to shield
Makes sure we don't move out of the z-level by checking the turfs around us.
+Takes in the direction we're going, and optionally how many steps forward to look.
+If steps are not provided, it will be inferred by singularity_size.
Fired when the singularity is fired at with the BSA and deletes it
check_turfs_in
+
+
Makes sure we don't move out of the z-level by checking the turfs around us.
+Takes in the direction we're going, and optionally how many steps forward to look.
+If steps are not provided, it will be inferred by singularity_size.
default_singularity_act
+
+
Calls singularity_act on the thing passed, usually destroying the object
on_entered
+
+
Triggered when something enters the component's parent.
+
+
+
diff --git a/datum/component/slippery.html b/datum/component/slippery.html
new file mode 100644
index 000000000000..ebed927510fa
--- /dev/null
+++ b/datum/component/slippery.html
@@ -0,0 +1,99 @@
+
+
+
+
+
+
+ /datum/component/slippery - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
the particle holder of the particle path (created when song starts) ((no i cant think of a better var name because i made the typepath and im perfect))
prevent more songs from being blessed concurrently, mob signal
+and hook into the instrument this time, preventing other weird exploity stuff.
+Prevents changing tempo during a song to sneak in final effects quicker
the particle holder of the particle path (created when song starts) ((no i cant think of a better var name because i made the typepath and im perfect))
whether to call the rite's finish effect, only true when the song is long enough
Proc Details
start_singing
+
+
Initiates the effect when the song begins playing.
stop_singing
+
+
Ends the effect when the song is no longer playing.
tempo_change
+
+
prevent more songs from being blessed concurrently, mob signal
+and hook into the instrument this time, preventing other weird exploity stuff.
+Prevents changing tempo during a song to sneak in final effects quicker
Called when parent leaves the zlevel this is set to (aka whichever zlevel it was on when it was added)
+Sends a message, then does an effect depending on what the punishment was.
Proc Details
punish
+
+
Called when parent leaves the zlevel this is set to (aka whichever zlevel it was on when it was added)
+Sends a message, then does an effect depending on what the punishment was.
+
Punishments:
+
+
PUNISHMENT_MURDER: kills parent
+
PUNISHMENT_GIB: gibs parent
+
PUNISHMENT_TELEPORT: finds a safe turf if possible, or a completely random one if not.
subtype picker component allows for an item to transform into its subtypes (this is not enforced and you can turn in whatever types, but
+i used this name as it was incredibly accurate for current usage of the behavior)
+
Used for the null rod to pick the other holy weapons.
pick_subtype: called from on_attack_self, shows a user a radial menu of all available null rod reskins and replaces the current null rod with the user's chosen reskinned variant
pick_subtype: turns the list of types to their description into all the data radial menus need
check_menu
+
+
Checks if we are allowed to interact with the radial menu
+
Arguments:
+
+
target: parent the radial menu is from
+
user: the mob interacting with the menu
+
on_attack_self
+
+
signal called by the stat of the target changing
pick_subtype
+
+
pick_subtype: called from on_attack_self, shows a user a radial menu of all available null rod reskins and replaces the current null rod with the user's chosen reskinned variant
+
Arguments:
+
+
target: parent this element is attached to that is being activated
For when you want to throw a person at something and have fun stuff happen
+
This component is made for carbon mobs (really, humans), and allows its parent to throw themselves and perform tackles. This is done by enabling throw mode, then clicking on your
+intended target with an empty hand. You will then launch toward your target. If you hit a carbon, you'll roll to see how hard you hit them. If you hit a solid non-mob, you'll
+roll to see how badly you just messed yourself up. If, along your journey, you hit a table, you'll slam onto it and send up to MAX_TABLE_MESSES (8) /obj/items on the table flying,
+and take a bit of extra damage and stun for each thing launched.
+
There are 2 separate """skill rolls""" involved here, which are handled and explained in rollTackle() (for roll 1, carbons), and splat() (for roll 2, walls and solid objects)
Some gloves, generally ones that increase mobility, may have a minimum distance to fly. Rocket gloves are especially dangerous with this, be sure you'll hit your target or have a clear background if you miss, or else!
A flat modifier to your roll against your target, as described in rollTackle(). Slightly misleading, skills aren't relevant here, this is a matter of what type of gloves (or whatever) is granting you the ability to tackle.
How fast you sail through the air. Standard tackles are 1 speed, but gloves that throw you faster come at a cost: higher speeds make it more likely you'll be badly injured if you fly into a non-mob obstacle.
If we're currently tackling or are on cooldown. Actually, shit, if I use this to handle cooldowns, then getting thrown by something while on cooldown will count as a tackle..... whatever, i'll fix that next commit
This handles all of the modifiers for the actual carbon-on-carbon tackling, and gets its own proc because of how many there are (with plenty more in mind!)
This is where we handle diving into dense atoms, generally with effects ranging from bad to REALLY bad. This works as a percentile roll that is modified in two steps as detailed below. The higher
+the roll, the more severe the result.
Some gloves, generally ones that increase mobility, may have a minimum distance to fly. Rocket gloves are especially dangerous with this, be sure you'll hit your target or have a clear background if you miss, or else!
A flat modifier to your roll against your target, as described in rollTackle(). Slightly misleading, skills aren't relevant here, this is a matter of what type of gloves (or whatever) is granting you the ability to tackle.
How fast you sail through the air. Standard tackles are 1 speed, but gloves that throw you faster come at a cost: higher speeds make it more likely you'll be badly injured if you fly into a non-mob obstacle.
If we're currently tackling or are on cooldown. Actually, shit, if I use this to handle cooldowns, then getting thrown by something while on cooldown will count as a tackle..... whatever, i'll fix that next commit
Proc Details
checkObstacle
+
+
Check to see if we hit a table, and if so, make a big mess!
checkTackle
+
+
See if we can tackle or not. If we can, leap!
registerTackle
+
+
Store the thrownthing datum for later use
rollTackle
+
+
This handles all of the modifiers for the actual carbon-on-carbon tackling, and gets its own proc because of how many there are (with plenty more in mind!)
+
The base roll is between (-3, 3), with negative numbers favoring the target, and positive numbers favoring the tackler. The target and the tackler are both assessed for
+how easy they are to knock over, with clumsiness and dwarfiness being strong maluses for each, and gigantism giving a bonus for each. These numbers and ideas
+are absolutely subject to change.
+
In addition, after subtracting the defender's mod and adding the attacker's mod to the roll, the component's base (skill) mod is added as well. Some sources of tackles
+are better at taking people down, like the bruiser and rocket gloves, while the dolphin gloves have a malus in exchange for better mobility.
sack
+
+
sack() is called when you actually smack into something, assuming we're mid-tackle. First it deals with smacking into non-carbons, in two cases:
+
+
If it's a non-carbon mob, we don't care, get out of here and do normal thrown-into-mob stuff
+
Else, if it's something dense (walls, machinery, structures, most things other than the floor), go to /datum/component/tackler/proc/splat and get ready for some high grade shit
+
+
If it's a carbon we hit, we'll call rollTackle() which rolls a die and calculates modifiers for both the tackler and target, then gives us a number. Negatives favor the target, while positives favor the tackler.
+Check rollTackle() for a more thorough explanation on the modifiers at play.
+
Then, we figure out what effect we want, and we get to work! Note that with standard gripper gloves and no modifiers, the range of rolls is (-3, 3). The results are as follows, based on what we rolled:
+
+
-inf to -5: Seriously botched tackle, tackler suffers a concussion, brute damage, and a 3 second paralyze, target suffers nothing
+
-4 to -2: weak tackle, tackler gets 3 second knockdown, target gets shove slowdown but is otherwise fine
+
-1 to 0: decent tackle, tackler gets up a bit quicker than the target
+
1: solid tackle, tackler has more of an advantage getting up quicker
+
2 to 4: expert tackle, tackler has sizeable advantage and lands on their feet with a free passive grab
+
5 to inf: MONSTER tackle, tackler gets up immediately and gets a free aggressive grab, target takes sizeable stamina damage from the hit and is paralyzed for one and a half seconds and knocked down for three seconds
+
+
Finally, we return a bitflag to COMSIG_MOVABLE_IMPACT that forces the hitpush to false so that we don't knock them away.
splat
+
+
This is where we handle diving into dense atoms, generally with effects ranging from bad to REALLY bad. This works as a percentile roll that is modified in two steps as detailed below. The higher
+the roll, the more severe the result.
+
Mod 1: Speed-
+
+
Base tackle speed is 1, which is what normal gripper gloves use. For other sources with higher speed tackles, like dolphin and ESPECIALLY rocket gloves, we obey Newton's laws and hit things harder.
+
For every unit of speed above 1, move the lower bound of the roll up by 15. Unlike Mod 2, this only serves to raise the lower bound, so it can't be directly counteracted by anything you can control.
+
+
Mod 2: Misc-
+-Flat modifiers, these take whatever you rolled and add/subtract to it, with the end result capped between the minimum from Mod 1 and 100. Note that since we can't roll higher than 100 to start with,
+wearing a helmet should be enough to remove any chance of permanently paralyzing yourself and dramatically lessen knocking yourself unconscious, even with rocket gloves. Will expand on maybe
+
+
Wearing a helmet: -6
+
Wearing riot armor: -6
+
Clumsy: +6
+
+
Effects: Below are the outcomes based off your roll, in order of increasing severity
+
+
1-67: Knocked down for a few seconds and a bit of brute and stamina damage
+
68-85: Knocked silly, gain some confusion as well as the above
+
86-92: Cranial trauma, get a concussion and more confusion, plus more damage
+
93-96: Knocked unconscious, get a random mild brain trauma, as well as a fair amount of damage
+
97-98: Massive head damage, probably crack your skull open, random mild brain trauma
+
99-Infinity: Break your spinal cord, get paralyzed, take a bunch of damage too. Very unlucky!
component for walls that applies an engraved overlay and lets you examine it to read a story (+ art element yay)
+new creations will get a high art value, cross round scrawlings will get a low one.
+MUST be a component, though it doesn't look like it. SSPersistence demandeth
Actually tip over the mob, setting it to tipped.
+Also invoking any callbacks we have, with the tipper as the argument,
+and set a timer to right our self-right our tipped mob if we can.
Proc called after a timer to have a tipped mob un-tip itself after a certain length of time.
+Sets our mob to untipped and invokes the untipped callback without any arguments if we have one.
Try to tip over [tipped_mob].
+If the mob is dead, or optional callback returns a value, or our do-after fails, we don't tip the mob.
+Otherwise, upon completing of the do_after, tip over the mob.
Time it takes to untip the mob. Can also be 0, for instant untip.
Proc Details
accept_roleplay
+
+
Accepts "roleplay" in the form of emotes, which removes a quarter of the remaining time left to untip ourself.
+
Arguments:
+
+
mob/living/user - The tipped mob
+
datum/emote/emote - The emote used by the mob
+
do_tip
+
+
Actually tip over the mob, setting it to tipped.
+Also invoking any callbacks we have, with the tipper as the argument,
+and set a timer to right our self-right our tipped mob if we can.
+
tipped_mob - the mob who was tipped
+tipper - the mob who tipped the tipped_mob
do_untip
+
+
Actually untip over the mob, setting it to untipped.
+Also invoke any untip callbacks we have, with the untipper as the argument.
+
tipped_mob - the mob who was tipped
+tipper - the mob who tipped the tipped_mob
interact_with_tippable
+
+
Attempt to interact with [source], either tipping it or helping it up.
+
source - the mob being tipped over
+user - the mob interacting with source
right_self
+
+
Proc called after a timer to have a tipped mob un-tip itself after a certain length of time.
+Sets our mob to untipped and invokes the untipped callback without any arguments if we have one.
+
tipped_mob - the mob who was tipped, and is freeing itself
set_tipped_status
+
+
Toggles our tipped status between tipped or untipped (TRUE or FALSE)
+also handles rotating our mob and adding immobilization traits
+
tipped_mob - the mob we're setting to tipped or untipped
+new_status - the tipped status we're setting the mob to - TRUE for tipped, FALSE for untipped
try_tip
+
+
Try to tip over [tipped_mob].
+If the mob is dead, or optional callback returns a value, or our do-after fails, we don't tip the mob.
+Otherwise, upon completing of the do_after, tip over the mob.
+
tipped_mob - the mob being tipped over
+tipper - the mob tipping the tipped_mob
try_untip
+
+
Try to untip a mob that has been tipped.
+After a do-after is completed, we untip the mob.
+
tipped_mob - the mob who is tipped
+untipper - the mob who is untipping the tipped_mob
+
+
+
diff --git a/datum/component/toggle_icon.html b/datum/component/toggle_icon.html
new file mode 100644
index 000000000000..ac5f8ab00c10
--- /dev/null
+++ b/datum/component/toggle_icon.html
@@ -0,0 +1,50 @@
+
+
+
+
+
+
+ /datum/component/toggle_icon - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
component attached to floors to turn them into trapdoors, a constructable trap that when signalled drops people to the level below.
+assembly code at the bottom of this file
All /obj/item(s) have a hidden_uplink var. By default it's null. Give the item one with 'new(src') (it must be in it's contents). Then add 'uses.'
+Use whatever conditionals you want to check that the user has an uplink, and then call interact() on their uplink.
+You might also want the uplink menu to open if active. Check if the uplink is 'active' and then interact() with it.
Whether to highlight our program in the main screen. Intended for alerts, but loosely available for any need to notify of changed conditions. Think Windows task bar highlighting. Available even if alerts are muted.
NTNet status, updated every tick by computer running this program. Don't use this for checks if NTNet works, computers do that. Use this for calculations, etc.
Optional, if above is set to 1 checks for specific function of NTNet (currently NTNET_SOFTWAREDOWNLOAD, NTNET_PEERTOPEER, NTNET_SYSTEMCONTROL and NTNET_COMMUNICATION)
Example: "something.gif" - a header image that will be rendered in computer's UI when this program is running at background. Images are taken from /icons/program_icons. Be careful not to use too large images!
Check if the user can run program. Only humans and silicons can operate computer. Automatically called in run_program()
+ID must be inserted into a card slot to be read. If the program is not currently installed (as is the case when
+NT Software Hub is checking available software), a list can be given to be used instead.
+Arguments:
+user is a ref of the mob using the device.
+loud is a bool deciding if this proc should use to_chats
+access_to_check is an access level that will be checked against the ID
+transfer, if TRUE and access_to_check is null, will tell this proc to use the program's transfer_access in place of access_to_check
+access can contain a list of access numbers to check against. If access is not empty, it will be used istead of checking any inserted ID.
Whether to highlight our program in the main screen. Intended for alerts, but loosely available for any need to notify of changed conditions. Think Windows task bar highlighting. Available even if alerts are muted.
NTNet status, updated every tick by computer running this program. Don't use this for checks if NTNet works, computers do that. Use this for calculations, etc.
Optional, if above is set to 1 checks for specific function of NTNet (currently NTNET_SOFTWAREDOWNLOAD, NTNET_PEERTOPEER, NTNET_SYSTEMCONTROL and NTNET_COMMUNICATION)
Example: "something.gif" - a header image that will be rendered in computer's UI when this program is running at background. Images are taken from /icons/program_icons. Be careful not to use too large images!
Bitflags (PROGRAM_CONSOLE, PROGRAM_LAPTOP, PROGRAM_TABLET combination) or PROGRAM_ALL
Proc Details
can_run
+
+
Check if the user can run program. Only humans and silicons can operate computer. Automatically called in run_program()
+ID must be inserted into a card slot to be read. If the program is not currently installed (as is the case when
+NT Software Hub is checking available software), a list can be given to be used instead.
+Arguments:
+user is a ref of the mob using the device.
+loud is a bool deciding if this proc should use to_chats
+access_to_check is an access level that will be checked against the ID
+transfer, if TRUE and access_to_check is null, will tell this proc to use the program's transfer_access in place of access_to_check
+access can contain a list of access numbers to check against. If access is not empty, it will be used istead of checking any inserted ID.
event_id_inserted
+
+
Called when an ID card is added to the computer.
event_id_removed
+
+
Called when an ID card is removed from computer.
run_emag
+
+
Called by the device when it is emagged.
+
Emagging the device allows certain programs to unlock new functions. However, the program will
+need to be downloaded first, and then handle the unlock on their own in their run_emag() proc.
+The device will allow an emag to be run multiple times, so the user can re-emag to run the
+override again, should they download something new. The run_emag() proc should return TRUE if
+the emagging affected anything, and FALSE if no change was made (already emagged, or has no
+emag functions).
tap
+
+
Runs when the device is used to attack an atom in non-combat mode.
+
Simulates using the device to read or scan something. Tap is called by the computer during pre_attack
+and sends us all of the related info. If we return TRUE, the computer will stop the attack process
+there. What we do with the info is up to us, but we should only return TRUE if we actually perform
+an action of some sort.
+Arguments:
+A is the atom being tapped
+user is the person making the attack action
+params is anything the pre_attack() proc had in the same-named variable.
+
+
+
diff --git a/datum/computer_file/program/aidiag.html b/datum/computer_file/program/aidiag.html
new file mode 100644
index 000000000000..f3d838ee34a8
--- /dev/null
+++ b/datum/computer_file/program/aidiag.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /datum/computer_file/program/aidiag - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
This proc is used to determin if a borg should be shown in the list (based on the borg's scrambledcodes var). Syndicate version overrides this to show only syndicate borgs.
Progress of current download, 0 to 100, -1 for no current download
checkID
+
+
Gets the ID's name, if one is inserted into the device. This is a separate proc solely to be overridden by the syndicate version of the app.
evaluate_borg
+
+
This proc is used to determin if a borg should be shown in the list (based on the borg's scrambledcodes var). Syndicate version overrides this to show only syndicate borgs.
+
+
+
diff --git a/datum/computer_file/program/bounty_board.html b/datum/computer_file/program/bounty_board.html
new file mode 100644
index 000000000000..f5f34512add8
--- /dev/null
+++ b/datum/computer_file/program/bounty_board.html
@@ -0,0 +1,64 @@
+
+
+
+
+
+
+ /datum/computer_file/program/bounty_board - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
The name of the shuttle template being used as the cargo shuttle. 'supply' is default and contains critical code. Don't change this unless you know what you're doing.
The name of the shuttle template being used as the cargo shuttle. 'supply' is default and contains critical code. Don't change this unless you know what you're doing.
The list of accesses this program is verified to change based on the authenticated ID. Used for state checking against player input.
Proc Details
authenticate
+
+
Authenticates the program based on the specific ID card.
+
If the card has ACCESS_CHANGE_IDs, it authenticates with all options.
+Otherwise, it authenticates depending on SSid_access.sub_department_managers_tgui
+compared to the access on the supplied ID card.
+Arguments:
+
+
user - Program's user.
+
id_card - The ID card to attempt to authenticate under.
+
+
+
+
diff --git a/datum/computer_file/program/job_management.html b/datum/computer_file/program/job_management.html
new file mode 100644
index 000000000000..deb3d6275650
--- /dev/null
+++ b/datum/computer_file/program/job_management.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /datum/computer_file/program/job_management - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
The last input in the search tab, stored here and reused in the UI to show successive users if
+the current list of paintings is limited to the results of a search or not.
The last input in the search tab, stored here and reused in the UI to show successive users if
+the current list of paintings is limited to the results of a search or not.
Ref of the last trackable object selected by the user in the tgui window. Updated in the ui_act() proc.
Proc Details
find_atom
+
+
Finds the atom in the appropriate list that the selected var indicates
+
The selected var holds a REF, which is a string. A mob REF may be
+something like "mob_209". In order to find the actual atom, we need
+to search the appropriate list for the REF string. This is dependant
+on the program (Lifeline uses GLOB.human_list, while Fission360 uses
+GLOB.poi_list), but the result will be the same; evaluate the string and
+return an atom reference.
scan
+
+
Runs a scan of all the trackable atoms.
+
Checks each entry in the GLOB of the specific trackable atoms against
+the track() proc, and fill the objects list with lists containing the
+atoms' names and REFs. The objects list is handed to the tgui screen
+for displaying to, and being selected by, the user. A two second
+sleep is used to delay the scan, both for thematical reasons as well
+as to limit the load players may place on the server using these
+somewhat costly loops.
track
+
+
Updates tracking information of the selected target.
+
The track() proc updates the entire set of information about the location
+of the target, including whether the Ntos window should use a pinpointer
+crosshair over the up/down arrows, or none in favor of a rotating arrow
+for far away targets. This information is returned in the form of a list.
trackable
+
+
Checks the trackability of the selected target.
+
If the target is on the computer's Z level, or both are on station Z
+levels, and the target isn't untrackable, return TRUE.
+Arguments:
+*arg1 is the atom being evaluated.
+
+
+
diff --git a/datum/computer_file/program/robocontrol.html b/datum/computer_file/program/robocontrol.html
new file mode 100644
index 000000000000..01825300d1ae
--- /dev/null
+++ b/datum/computer_file/program/robocontrol.html
@@ -0,0 +1,50 @@
+
+
+
+
+
+
+ /datum/computer_file/program/robocontrol - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Sets up the signal listener for Supermatter delaminations.
Proc Details
clear_signals
+
+
Removes the signal listener for Supermatter delaminations from the selected supermatter.
+
Pretty much does what it says.
send_alert
+
+
Sends an SM delam alert to the computer.
+
Triggered by a signal from the selected supermatter, this proc sends a notification
+to the computer if the program is either closed or minimized. We do not send these
+notifications to the comptuer if we're the active program, because engineers fixing
+the supermatter probably don't need constant beeping to distract them.
send_start_alert
+
+
Sends an SM delam start alert to the computer.
+
Triggered by a signal from the selected supermatter at the start of a delamination,
+this proc sends a notification to the computer if this program is the active one.
+We do this so that people carrying a tablet with NT CIMS open but with the NTOS window
+closed will still get one audio alert. This is not sent to computers with the program
+minimized or closed to avoid double-notifications.
set_signals
+
+
Sets up the signal listener for Supermatter delaminations.
+
Unregisters any old listners for SM delams, and then registers one for the SM refered
+to in the active variable. This proc is also used with no active SM to simply clear
+the signal and exit.
Read-only default value for this config entry, used for resetting value to defaults when necessary. This is what config_entry_value is initially set to
Read-only default value for this config entry, used for resetting value to defaults when necessary. This is what config_entry_value is initially set to
Almost 100% of the time the lists passed into set_holdable are reused for each instance
+Just fucking cache it 4head
+Yes I could generalize this, but I don't want anyone else using it. in fact, DO NOT COPY THIS
+If you find yourself needing this pattern, you're likely better off using static typecaches
+I'm not because I do not trust implementers of the storage component to use them, BUT
+IF I FIND YOU USING THIS PATTERN IN YOUR CODE I WILL BREAK YOU ACROSS MY KNEES
+~Lemon
The same rules of the above also apply here, with the exception that this is for the unique_features string variable
+(commonly abbreviated with uf) and its blocks. Both ui and uf have a standard block length of 3 ASCII characters.
Some identity blocks (basically pieces of the unique_identity string variable of the dna datum, commonly abbreviated with ui)
+may have a length that differ from standard length of 3 ASCII characters. This list is necessary
+for these non-standard blocks to work, as well as the entire unique identity string.
+Should you add a new ui block which size differ from the standard (again, 3 ASCII characters), like for example, a color,
+please do not forget to also include it in this list in the following format:
+"[dna block number]" = dna block size,
+Failure to do that may result in bugs. Thanks.
Whitelist of saymodes or radio extensions that can be spoken through even if not fully conscious.
+Associated values are their maximum allowed mob stats.
Holds the global datum for rpgloot, so anywhere may check for its existence (it signals into whatever it needs to modify, so it shouldn't require fetching)
Holds the global datum for rpgtitle, so anywhere may check for its existence (it signals into whatever it needs to modify, so it shouldn't require fetching)
global statics for the see_through_component coordinate maps
+For ease of use, include a comment in the shape of the coordinate map, where O is nothing, X is a hidden tile and A is the object
+List-coordinate layout is list(relative_x, relative_y, relative_z)
+Turf finding algorithm needs the z and you can totally use it, but I can't think of any reason to ever do it
+Also it'd be really cool if you could keep the list-coordinates in here represent their actual relative coords, dont use tabs though since their spacing can differ
This defines the antagonists you can operate with in the settings.
+Keys are the antagonist, values are the number of days since the player's
+first connection in order to play.
A list of numbers that keeps track of where ui blocks start in the unique_identity string variable of the dna datum.
+Commonly used by the datum/dna/set_uni_identity_block and datum/dna/get_uni_identity_block procs.
A typecache listing structures that are considered to have surfaces that you can place items on that are higher than the floor. This, of course, should be restricted to /atom/movables. This is primarily used for food decomposition code.
typecache for turfs that should be considered ok during floorchecks.
+A linked turf being anything not in this typecache will cause the holodeck to perform an emergency shutdown.
Log associated with [/proc/log_suspicious_login()] - Intended to hold all logins that failed due to suspicious circumstances such as ban detection, CID randomisation etc.
Almost 100% of the time the lists passed into set_holdable are reused for each instance
+Just fucking cache it 4head
+Yes I could generalize this, but I don't want anyone else using it. in fact, DO NOT COPY THIS
+If you find yourself needing this pattern, you're likely better off using static typecaches
+I'm not because I do not trust implementers of the storage component to use them, BUT
+IF I FIND YOU USING THIS PATTERN IN YOUR CODE I WILL BREAK YOU ACROSS MY KNEES
+~Lemon
The same rules of the above also apply here, with the exception that this is for the unique_features string variable
+(commonly abbreviated with uf) and its blocks. Both ui and uf have a standard block length of 3 ASCII characters.
Some identity blocks (basically pieces of the unique_identity string variable of the dna datum, commonly abbreviated with ui)
+may have a length that differ from standard length of 3 ASCII characters. This list is necessary
+for these non-standard blocks to work, as well as the entire unique identity string.
+Should you add a new ui block which size differ from the standard (again, 3 ASCII characters), like for example, a color,
+please do not forget to also include it in this list in the following format:
+"[dna block number]" = dna block size,
+Failure to do that may result in bugs. Thanks.
Whitelist of saymodes or radio extensions that can be spoken through even if not fully conscious.
+Associated values are their maximum allowed mob stats.
Checks that the paicard is in the user's top-level
+(hand, ear, pocket, belt, etc) inventory OR
+if the paicard has been slotted into a PDA which
+is also on the user's person.
Holds the global datum for rpgloot, so anywhere may check for its existence (it signals into whatever it needs to modify, so it shouldn't require fetching)
Holds the global datum for rpgtitle, so anywhere may check for its existence (it signals into whatever it needs to modify, so it shouldn't require fetching)
global statics for the see_through_component coordinate maps
+For ease of use, include a comment in the shape of the coordinate map, where O is nothing, X is a hidden tile and A is the object
+List-coordinate layout is list(relative_x, relative_y, relative_z)
+Turf finding algorithm needs the z and you can totally use it, but I can't think of any reason to ever do it
+Also it'd be really cool if you could keep the list-coordinates in here represent their actual relative coords, dont use tabs though since their spacing can differ
This defines the antagonists you can operate with in the settings.
+Keys are the antagonist, values are the number of days since the player's
+first connection in order to play.
Adding a wizard area teleport list because motherfucking lag -- Urist
+I am far too lazy to make it a proper list of areas so I'll just make it run the usual telepot routine at the start of the game
A list of numbers that keeps track of where ui blocks start in the unique_identity string variable of the dna datum.
+Commonly used by the datum/dna/set_uni_identity_block and datum/dna/get_uni_identity_block procs.
A typecache listing structures that are considered to have surfaces that you can place items on that are higher than the floor. This, of course, should be restricted to /atom/movables. This is primarily used for food decomposition code.
typecache for turfs that should be considered ok during floorchecks.
+A linked turf being anything not in this typecache will cause the holodeck to perform an emergency shutdown.
Log associated with [/proc/log_suspicious_login()] - Intended to hold all logins that failed due to suspicious circumstances such as ban detection, CID randomisation etc.
Start of queue linked list
+End of queue linked list (used for appending to the list)
+Are we loading in a new map?
+for scheduling different subsystems for different stages of the round
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
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
SetRunLevel
+
+
Best way to tell if a server is a local debug vs production
laggy_byond_map_update_incoming
+
+
Warns us that the end of tick byond map_update will be laggier then normal, so that we can just skip running subsystems this tick.
+
+
+
diff --git a/datum/controller/modmanager.html b/datum/controller/modmanager.html
new file mode 100644
index 000000000000..894d25a64478
--- /dev/null
+++ b/datum/controller/modmanager.html
@@ -0,0 +1,57 @@
+
+
+
+
+
+
+ /datum/controller/modmanager - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
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
Subsystem Flags 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.
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
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
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.
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
Subsystem Flags 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.
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
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
Time to wait (in deciseconds) between each call to fire(). Must be a positive integer.
Proc Details
OnConfigLoad
+
+
Called after the config has been loaded or reloaded.
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.
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
+
+
+
Update next_fire for the next run.
+
reset_time (bool) - Ignore things that would normally alter the next fire, like tick_overrun, and last_fire. (also resets postpone)
+
+
+
+
diff --git a/datum/controller/subsystem/achievements.html b/datum/controller/subsystem/achievements.html
new file mode 100644
index 000000000000..149c895103e5
--- /dev/null
+++ b/datum/controller/subsystem/achievements.html
@@ -0,0 +1,50 @@
+
+
+
+
+
+
+ /datum/controller/subsystem/achievements - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
A stack of list(source, desired initialized state)
+We read the source of init changes from the last entry, and assert that all changes will come with a reset
Use this to set initialized to prevent error states where the old initialized is overriden, and we end up losing all context
+Accepts a state and a source, the most recent state is used, sources exist to prevent overriding old values accidentially
A stack of list(source, desired initialized state)
+We read the source of init changes from the last entry, and assert that all changes will come with a reset
Atoms that will be deleted once the subsystem is initialized
Proc Details
CreateAtoms
+
+
Actually creates the list of atoms. Exists soley so a runtime in the creation logic doesn't cause initalized to totally break
InitAtom
+
+
Init this specific atom
get_initialized_source
+
+
Returns the source currently modifying SSatom's init behavior
initializing_something
+
+
Returns TRUE if anything is currently being initialized
prepare_deletion
+
+
Prepares an atom to be deleted once the atoms SS is initialized.
set_tracked_initalized
+
+
Use this to set initialized to prevent error states where the old initialized is overriden, and we end up losing all context
+Accepts a state and a source, the most recent state is used, sources exist to prevent overriding old values accidentially
Generates ban caches for any logged in clients. This ensures the amount of in-series ban checking we have to do that actually involves sleeps is VERY low
Proc Details
generate_queries
+
+
Generates ban caches for any logged in clients. This ensures the amount of in-series ban checking we have to do that actually involves sleeps is VERY low
Queues any callbacks to be executed instantly instead of using the subsystem.
Proc Details
add_callback
+
+
Adds a callback to be invoked when the next fire() is done. Used by the integrated circuit system.
+
Prevents race conditions as it acts like a queue system.
+Those that registered first will be executed first and those registered last will be executed last.
execute_instant_run
+
+
Instantly executes the stored callbacks and does this in a loop until there are no stored callbacks or it hits tick limit.
+
Returns a list containing any values added by any input port.
queue_instant_run
+
+
Queues any callbacks to be executed instantly instead of using the subsystem.
Perform a full-text search through all codex entries. Entries matching the query by name will be shown first.
+Results are cached. Relies on the index database.
Straight-DM implimentation of full text search. Objectively garbage.
+Does not use the DB. Used when database loading is skipped.
+Argument has already been sanitized.
+Safety checks have already been done. Cache has already been checked.
Search result cache, so we don't need to hit the DB every time.
Proc Details
build_db_index
+
+
Holds the revision the index was compiled for. If it's different then live, we need to regenerate the index.
get_codex_entry
+
+
Returns a codex entry for the given query. May return a list if multiple are found, or null if none.
prepare_search_database
+
+
Prepare the search database.
present_codex_entry
+
+
Presents a codex entry to a mob. If it receives a list of entries, it will prompt them to choose one.
present_codex_search
+
+
Presents a list of codex entries to a mob.
retrieve_entries_for_string
+
+
Perform a full-text search through all codex entries. Entries matching the query by name will be shown first.
+Results are cached. Relies on the index database.
text_search_no_db
+
+
Straight-DM implimentation of full text search. Objectively garbage.
+Does not use the DB. Used when database loading is skipped.
+Argument has already been sanitized.
+Safety checks have already been done. Cache has already been checked.
Should only really happen during april fools.
+Checks to see that it's been at least 5 minutes since the last emergency meeting call.
+Arguments:
+
+
user - Mob who called the meeting
+
emergency_meeting
+
+
Call an emergency meeting
+
Communications subsystem wrapper for the call_emergency_meeting world proc.
+Checks to make sure the proc can be called, and handles
+relevant logging and timing. See that proc definition for more detail.
+Arguments:
Supporing proc for getting general records
+and using them as pAI ui data. This gets
+medical information - or what I would deem
+medical information - and sends it as a list.
The array of records
+The object containing the crew info
+Supporing proc for getting secrurity records
+and using them as pAI ui data. Sends it as a
+list.
A list of data libraries keyed by DATACORE_RECORDS_*
Proc Details
OnReady
+
+
Add a callback to execute when the datacore has loaded
demanifest
+
+
Removes a person from history. Except locked. That's permanent history.
generate_manifest
+
+
Create the roundstart manifest using the newplayer list.
get_general_records
+
+
Supporing proc for getting general records
+and using them as pAI ui data. This gets
+medical information - or what I would deem
+medical information - and sends it as a list.
+
@return - list(general_records_out)
get_pda_netids
+
+
Grab all PDA network IDs by department.
get_record_by_name
+
+
Returns a data record or null.
get_records
+
+
Returns a data library's records list
get_security_records
+
+
The array of records
+The object containing the crew info
+Supporing proc for getting secrurity records
+and using them as pAI ui data. Sends it as a
+list.
+
@return - list(security_records_out)
new_crime_entry
+
+
The array of records
+The object containing the crew info
+Creates a new crime entry and hands it back.
List of normal (no department ones) accounts' identifiers with associated datum accounts, for big O performance.
+A list of sole account datums can be obtained with flatten_list(), another variable would be redundant rn.
Enables extra money charges for things that normally would be free, such as sleepers/cryo/beepsky.
+Take care when enabling, as players will NOT respond well if the economy is set up for low cash flows.
List of normal (no department ones) accounts' identifiers with associated datum accounts, for big O performance.
+A list of sole account datums can be obtained with flatten_list(), another variable would be redundant rn.
Enables extra money charges for things that normally would be free, such as sleepers/cryo/beepsky.
+Take care when enabling, as players will NOT respond well if the economy is set up for low cash flows.
A var that collects the total amount of credits owned in player accounts on station, reset and recounted on fire()
Proc Details
payday
+
+
The first fire at roundstart is discarded.
price_update
+
+
Updates the prices of all station vendors.
+
Iterates over the machines list for vending machines, resets their regular and premium product prices (Not contraband).
spawn_cash_for_amount
+
+
Spawns a given amount of money in optimal stacks at the given location.
track_purchase
+
+
Proc that adds a set of strings and ints to the audit log, tracked by the economy SS.
+
+
account: The bank account of the person purchasing the item.
+
price_to_use: The cost of the purchase made for this transaction.
+
vendor: The object or structure medium that is charging the user. For Vending machines that's the machine, for payment component that's the parent, cargo that's the crate, etc.
+
update_mail
+
+
We don't use transfering, because we already know there's enough money.
The roundstart generated code for the spare ID safe. This is given to the Captain on shift start. If there's no Captain, it's given to the HoP. If there's no HoP
Helper list containing all trim paths that can be used as job templates. Intended to be used alongside logic for ACCESS_CHANGE_IDS. Grab templates from sub_department_managers_tgui for Head of Staff restrictions.
Helper list containing all PDA paths that can be painted by station machines. Intended to be used alongside logic for ACCESS_CHANGE_IDS. Grab templates from sub_department_managers_tgui for Head of Staff restrictions.
The roundstart generated code for the spare ID safe. This is given to the Captain on shift start. If there's no Captain, it's given to the HoP. If there's no HoP
Helper list containing all trim paths that can be used as job templates. Intended to be used alongside logic for ACCESS_CHANGE_IDS. Grab templates from sub_department_managers_tgui for Head of Staff restrictions.
Helper list containing all PDA paths that can be painted by station machines. Intended to be used alongside logic for ACCESS_CHANGE_IDS. Grab templates from sub_department_managers_tgui for Head of Staff restrictions.
Dictionary of wildcard compatibility flags. Keys are strings for the wildcards. Values are their associated flags.
Proc Details
add_trim_access_to_card
+
+
Adds the accesses associated with a trim to an ID card.
+
Clears the card's existing access levels first.
+Primarily intended for applying trim templates to cards. Will attempt to add as many ordinary access
+levels as it can, without consuming any wildcards. Will then attempt to apply the trim-specific wildcards after.
+
Arguments:
+
+
id_card - The ID card to remove the trim from.
+
apply_trim_to_card
+
+
Applies a trim singleton to a card.
+
Returns FALSE if the trim could not be applied due to being incompatible with the card.
+Incompatibility is defined as a card not being able to hold all the trim's required wildcards.
+Returns TRUE otherwise.
+Arguments:
+
+
id_card - ID card to apply the trim_path to.
+
trim_path - A trim path to apply to the card. Grabs the trim's associated singleton and applies it.
+
copy_access - Boolean value. If true, the trim's access is also copied to the card.
+
apply_trim_to_chameleon_card
+
+
+
+
Applies a trim to a chameleon card. This is purely visual, utilising the card's override vars.
+
+
+
Arguments:
+
+
+
+
id_card - The chameleon card to apply the trim visuals to.
+
+
+
+
+
trim_path - A trim path to apply to the card. Grabs the trim's associated singleton and applies it.
+
+
+
+
+
check_forged - Boolean value. If TRUE, will not overwrite the card's assignment if the card has been forged.
+
+
+
get_access_desc
+
+
Returns the access description associated with any given access level.
+
In proc form due to accesses being stored in the list as text instead of numbers.
+Arguments:
+
+
access - Access as either pure number or as a string representation of the number.
+
get_access_flag
+
+
Returns the access bitflags associated with any given access level.
+
In proc form due to accesses being stored in the list as text instead of numbers.
+Arguments:
+
+
access - Access as either pure number or as a string representation of the number.
+
get_flag_access_list
+
+
Returns the list of all accesses associated with any given access flag.
+
In proc form due to accesses being stored in the list as text instead of numbers.
+Arguments:
+
+
flag - The flag to get access for as either a pure number of string representation of the flag.
+
get_region_access_list
+
+
Builds and returns a list of accesses from a list of regions.
+
Arguments:
+
+
regions - A list of region defines.
+
refresh_job_trim_singletons
+
+
Called by [/datum/controller/subsystem/ticker/proc/setup]
+
This runs through every /datum/id_trim/job singleton and ensures that its access is setup according to
+appropriate config entries.
remove_trim_from_card
+
+
Removes a trim from an ID card. Also removes all accesses from it too.
+
Arguments:
+
+
id_card - The ID card to remove the trim from.
+
remove_trim_from_chameleon_card
+
+
Removes a trim from a chameleon ID card.
+
Arguments:
+
+
id_card - The ID card to remove the trim from.
+
setup_access_descriptions
+
+
Setup dictionary that converts access levels to text descriptions.
setup_access_flags
+
+
Build access flag lists.
setup_region_lists
+
+
Populates the region lists with data about which accesses correspond to which regions.
setup_tgui_lists
+
+
Creates various data structures that primarily get fed to tgui interfaces, although these lists are used in other places.
setup_trim_singletons
+
+
Instantiate trim singletons and add them to a list.
setup_wildcard_dict
+
+
Set up dictionary to convert wildcard names to flags.
tally_access
+
+
Tallies up all accesses the card has that have flags greater than or equal to the access_flag supplied.
+
Returns the number of accesses that have flags matching access_flag or a higher tier access.
+Arguments:
+
+
id_card - The ID card to tally up access for.
+
access_flag - The minimum access flag required for an access to be tallied up.
Keys should be assigned job roles. Values should be >= 1.
+Represents the chain of command on the station. Lower numbers mean higher priority.
+Used to give the Cap's Spare safe code to a an appropriate player.
+Assumed Captain is always the highest in the chain of command.
+See [/datum/controller/subsystem/ticker/proc/equip_characters]
Dictionary that maps job priorities to low/medium/high. Keys have to be number-strings as assoc lists cannot be indexed by integers. Set in setup_job_lists.
Keys should be assigned job roles. Values should be >= 1.
+Represents the chain of command on the station. Lower numbers mean higher priority.
+Used to give the Cap's Spare safe code to a an appropriate player.
+Assumed Captain is always the highest in the chain of command.
+See [/datum/controller/subsystem/ticker/proc/equip_characters]
Dictionary that maps job priorities to low/medium/high. Keys have to be number-strings as assoc lists cannot be indexed by integers. Set in setup_job_lists.
latejoin - Set to TRUE if this is a latejoin role assignment.
+
do_eligibility_checks - Set to TRUE to conduct all job eligibility tests and reject on failure. Set to FALSE if job eligibility has been tested elsewhere and they can be safely skipped.
+
CheckHeadPositions
+
+
Attempts to fill out all possible head positions for players with that job at a a given job priority level.
+
Arguments:
+
+
level - One of the JP_LOW, JP_MEDIUM or JP_HIGH defines. Attempts to find candidates with head jobs at this priority only.
+
DivideOccupations
+
+
+
Proc DivideOccupations
+
fills var "assigned_role" for all ready players.
+
This proc must not have any side effect besides of modifying "assigned_role".
+
DropLandAtRandomHallwayPoint
+
+
Lands specified mob at a random spot in the hallways
FillHeadPosition
+
+
Will try to select a head, ignoring ALL non-head preferences for every level until.
+
Basically tries to ensure there is at least one head in every shift if anyone has that job preference enabled at all.
assign_captain
+
+
Finds a captain first a foremost. Returns success or failure
assign_priority_positions
+
+
Blindly assigns the required roles to every player in the dynamic_forced_occupations list.
check_job_eligibility
+
+
Runs a standard suite of eligibility checks to make sure the player can take the reqeusted job.
+
Checks:
+
+
Role bans
+
How many days old the player account is
+
Whether the player has the required hours in other jobs to take that role
+
If the job is in the mind's restricted roles, for example if they have an antag datum that's incompatible with certain roles.
+
+
Arguments:
+
+
player - The player to check for job eligibility.
+
possible_job - The job to check for eligibility against.
+
debug_prefix - Logging prefix for the JobDebug log entries. For example, GRJ during GiveRandomJob or DO during DivideOccupations.
+
add_job_to_log - If TRUE, appends the job type to the log entry. If FALSE, does not. Set to FALSE when check is part of iterating over players for a specific job, set to TRUE when check is part of iterating over jobs for a specific player and you don't want extra log entry spam.
+
fill_ai_positions
+
+
Attempts to fill out all available AI positions.
get_necessary_departments
+
+
Returns a list of department paths that must be filled.
job_priority_level_to_string
+
+
Takes a job priority #define such as JP_LOW and gets its string representation for logging.
promote_to_department_head
+
+
Called when there's no department head present.
send_spare_id_safe_code
+
+
Send a drop pod containing a piece of paper with the spare ID safe code to loc
setup_alt_job_items
+
+
Shows a list of all current and future polls and buttons to edit or delete them or create a new poll.
+
All extra functionality to run on new player mobs, in a place where we actually have the client,
+and haven't called COMSIG_GLOB_JOB_AFTER_SPAWN yet, so we are running before the wallet trait,
+and other things that rely on items already being settled.
setup_job_lists
+
+
Builds various lists of jobs based on station, centcom and additional jobs with icons associated with them.
shows the default gravity value for each z level. recalculated when gravity generators change.
+List in the form: list(z level num = max generator gravity in that z level OR the gravity level trait)
List of Z level connections. This is NOT direct connections, Decks 1 and 3 of a ship are "connected", but not directly. Use SSmapping.are_same_zstack()
Adds a new reservation z level. A bit of space that can be handed out on request
+Of note, reservations default to transit turfs, to make their most common use, shuttles, faster
Sets up a z level as reserved
+This is not for wiping reserved levels, use wipe_reservations() for that.
+If this is called after SSatom init, it will call Initialize on all turfs on the passed z, as its name promises
shows the default gravity value for each z level. recalculated when gravity generators change.
+List in the form: list(z level num = max generator gravity in that z level OR the gravity level trait)
List of Z level connections. This is NOT direct connections, Decks 1 and 3 of a ship are "connected", but not directly. Use SSmapping.are_same_zstack()
list of all z level datums in the order of their z (z level 1 is at index 1, etc.)
Proc Details
add_reservation_zlevel
+
+
Adds a new reservation z level. A bit of space that can be handed out on request
+Of note, reservations default to transit turfs, to make their most common use, shuttles, faster
are_same_zstack
+
+
Checks if 2 levels are in the same Z-stack.
build_area_turfs
+
+
Increment all the z level lists (note: not all yet)
filter_map_options
+
+
Takes a list of map names, returns a list of valid maps.
get_station_center
+
+
Prefer not to use this one too often
get_zstack
+
+
Get a list of Z levels that are in zA's Z-stack.
initialize_biomes
+
+
Initialize all biomes, assoc as type || instance
initialize_reserved_level
+
+
Sets up a z level as reserved
+This is not for wiping reserved levels, use wipe_reservations() for that.
+If this is called after SSatom init, it will call Initialize on all turfs on the passed z, as its name promises
level_has_all_traits
+
+
Check if levels[z] has all of the specified traits
level_has_any_trait
+
+
Check if levels[z] has any of the specified traits
level_trait
+
+
Look up levels[z].traits[trait]
levels_by_any_trait
+
+
Get a list of all z which have any of the specified traits
levels_by_trait
+
+
Get a list of all z which have the specified trait
manage_z_level
+
+
Takes a z level datum, and tells the mapping subsystem to manage it
reserve_turfs
+
+
Schedules a group of turfs to be handed back to the reservation system's control
+If await is true, will sleep until the turfs are finished work
A two-entry list containing the erroring tag, and a reason for the error.
+Quarantine proc for json decoding, Has handling code for most reasonable issues with file structure, and can safely die.
+Returns -1/MEDIA_LOAD_FAILED on error, a list on success, and null on suicide.
Media definitions grouped by their media_tags, All tracks share the implicit tag all
Proc Details
decode_or_null
+
+
A two-entry list containing the erroring tag, and a reason for the error.
+Quarantine proc for json decoding, Has handling code for most reasonable issues with file structure, and can safely die.
+Returns -1/MEDIA_LOAD_FAILED on error, a list on success, and null on suicide.
log_load_fail
+
+
Log a failure to load a specific media track, and notify admins.
validate_media
+
+
Run media validation checks. Returns null on success, or a log_load_failure compatible tuple-list on failure.
+
+
+
diff --git a/datum/controller/subsystem/mouse_entered.html b/datum/controller/subsystem/mouse_entered.html
new file mode 100644
index 000000000000..d357928b4093
--- /dev/null
+++ b/datum/controller/subsystem/mouse_entered.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /datum/controller/subsystem/mouse_entered - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Removes the atom from some movement subsystem. Defaults to SSmovement
Proc Details
add_to_loop
+
+
Adds a movable thing to a movement subsystem. Returns TRUE if it all worked, FALSE if it failed somehow
force_move
+
+
Used for force-move loops, similar to move_towards_legacy() but not quite the same
+
Returns TRUE if the loop sucessfully started, or FALSE if it failed
+
Arguments:
+moving - The atom we want to move
+chasing - The atom we want to move towards
+delay - How many deci-seconds to wait between fires. Defaults to the lowest value, 0.1
+timeout - Time in deci-seconds until the moveloop self expires. Defaults to infinity
+subsystem - The movement subsystem to use. Defaults to SSmovement. Only one loop can exist for any one subsystem
+priority - Defines how different move loops override each other. Lower numbers beat higher numbers, equal defaults to what currently exists. Defaults to MOVEMENT_DEFAULT_PRIORITY
+flags - Set of bitflags that effect move loop behavior in some way. Check _DEFINES/movement.dm
force_move_dir
+
+
Like move(), but we don't care about collision at all
+
Returns TRUE if the loop sucessfully started, or FALSE if it failed
+
Arguments:
+moving - The atom we want to move
+direction - The direction we want to move in
+delay - How many deci-seconds to wait between fires. Defaults to the lowest value, 0.1
+timeout - Time in deci-seconds until the moveloop self expires. Defaults to infinity
+subsystem - The movement subsystem to use. Defaults to SSmovement. Only one loop can exist for any one subsystem
+priority - Defines how different move loops override each other. Lower numbers beat higher numbers, equal defaults to what currently exists. Defaults to MOVEMENT_DEFAULT_PRIORITY
+flags - Set of bitflags that effect move loop behavior in some way. Check _DEFINES/movement.dm
home_onto
+
+
Helper proc for homing onto something with move_towards
+
Returns TRUE if the loop sucessfully started, or FALSE if it failed
+
Arguments:
+moving - The atom we want to move
+chasing - The atom we want to move towards
+delay - How many deci-seconds to wait between fires. Defaults to the lowest value, 0.1
+home - Should we move towards the object at all times? Or launch towards them, but allow walls and such to take us off track. Defaults to FALSE
+timeout - Time in deci-seconds until the moveloop self expires. Defaults to INFINITY
+subsystem - The movement subsystem to use. Defaults to SSmovement. Only one loop can exist for any one subsystem
+priority - Defines how different move loops override each other. Lower numbers beat higher numbers, equal defaults to what currently exists. Defaults to MOVEMENT_DEFAULT_PRIORITY
+flags - Set of bitflags that effect move loop behavior in some way. Check _DEFINES/movement.dm
jps_move
+
+
Used for following jps defined paths. The proc signature here's a bit long, I'm sorry
+
Returns TRUE if the loop sucessfully started, or FALSE if it failed
+
Arguments:
+moving - The atom we want to move
+chasing - The atom we want to move towards
+delay - How many deci-seconds to wait between fires. Defaults to the lowest value, 0.1
+repath_delay - How often we're allowed to recalculate our path
+max_path_length - The maximum number of steps we can take in a given path to search (default: 30, 0 = infinite)
+miminum_distance - Minimum distance to the target before path returns, could be used to get near a target, but not right to it - for an AI mob with a gun, for example
+id - An ID card representing what access we have and what doors we can open
+simulated_only - Whether we consider turfs without atmos simulation (AKA do we want to ignore space)
+avoid - If we want to avoid a specific turf, like if we're a mulebot who already got blocked by some turf
+skip_first - Whether or not to delete the first item in the path. This would be done because the first item is the starting tile, which can break things
+timeout - Time in deci-seconds until the moveloop self expires. Defaults to infinity
+subsystem - The movement subsystem to use. Defaults to SSmovement. Only one loop can exist for any one subsystem
+priority - Defines how different move loops override each other. Lower numbers beat higher numbers, equal defaults to what currently exists. Defaults to MOVEMENT_DEFAULT_PRIORITY
+flags - Set of bitflags that effect move loop behavior in some way. Check _DEFINES/movement.dm
move
+
+
Replacement for walk()
+
Returns TRUE if the loop sucessfully started, or FALSE if it failed
+
Arguments:
+moving - The atom we want to move
+direction - The direction we want to move in
+delay - How many deci-seconds to wait between fires. Defaults to the lowest value, 0.1
+timeout - Time in deci-seconds until the moveloop self expires. Defaults to infinity
+subsystem - The movement subsystem to use. Defaults to SSmovement. Only one loop can exist for any one subsystem
+priority - Defines how different move loops override each other. Lower numbers beat higher numbers, equal defaults to what currently exists. Defaults to MOVEMENT_DEFAULT_PRIORITY
+flags - Set of bitflags that effect move loop behavior in some way. Check _DEFINES/movement.dm
move_away
+
+
Wrapper around walk_away()
+
Returns TRUE if the loop sucessfully started, or FALSE if it failed
+
Arguments:
+moving - The atom we want to move
+chasing - The atom we want to move towards
+max_dist - the furthest away from the target we're allowed to get
+delay - How many deci-seconds to wait between fires. Defaults to the lowest value, 0.1
+timeout - Time in deci-seconds until the moveloop self expires. Defaults to infinity
+subsystem - The movement subsystem to use. Defaults to SSmovement. Only one loop can exist for any one subsystem
+priority - Defines how different move loops override each other. Lower numbers beat higher numbers, equal defaults to what currently exists. Defaults to MOVEMENT_DEFAULT_PRIORITY
+flags - Set of bitflags that effect move loop behavior in some way. Check _DEFINES/movement.dm
move_disposals
+
+
Snowflake disposal movement. Moves a disposal holder along a chain of disposal pipes
+
Returns TRUE if the loop sucessfully started, or FALSE if it failed
+
Arguments:
+moving - The atom we want to move
+delay - How many deci-seconds to wait between fires. Defaults to the lowest value, 0.1
+timeout - Time in deci-seconds until the moveloop self expires. Defaults to infinity
+subsystem - The movement subsystem to use. Defaults to SSmovement. Only one loop can exist for any one subsystem
+priority - Defines how different move loops override each other. Lower numbers beat higher numbers, equal defaults to what currently exists. Defaults to MOVEMENT_DEFAULT_PRIORITY
+flags - Set of bitflags that effect move loop behavior in some way. Check _DEFINES/movement.dm
move_rand
+
+
Helper proc for the move_rand datum
+
Returns TRUE if the loop sucessfully started, or FALSE if it failed
+
Arguments:
+moving - The atom we want to move
+directions - A list of acceptable directions to try and move in. Defaults to GLOB.alldirs
+delay - How many deci-seconds to wait between fires. Defaults to the lowest value, 0.1
+timeout - Time in deci-seconds until the moveloop self expires. Defaults to infinity
+subsystem - The movement subsystem to use. Defaults to SSmovement. Only one loop can exist for any one subsystem
+priority - Defines how different move loops override each other. Lower numbers beat higher numbers, equal defaults to what currently exists. Defaults to MOVEMENT_DEFAULT_PRIORITY
+flags - Set of bitflags that effect move loop behavior in some way. Check _DEFINES/movement.dm
move_to
+
+
Wrapper around walk_to()
+
Returns TRUE if the loop sucessfully started, or FALSE if it failed
+
Arguments:
+moving - The atom we want to move
+chasing - The atom we want to move towards
+min_dist - the closest we're allower to get to the target
+delay - How many deci-seconds to wait between fires. Defaults to the lowest value, 0.1
+timeout - Time in deci-seconds until the moveloop self expires. Defaults to infinity
+subsystem - The movement subsystem to use. Defaults to SSmovement. Only one loop can exist for any one subsystem
+priority - Defines how different move loops override each other. Lower numbers beat higher numbers, equal defaults to what currently exists. Defaults to MOVEMENT_DEFAULT_PRIORITY
+flags - Set of bitflags that effect move loop behavior in some way. Check _DEFINES/movement.dm
move_to_rand
+
+
Wrapper around walk_rand(), doesn't actually result in a random walk, it's more like moving to random places in viewish
+
Returns TRUE if the loop sucessfully started, or FALSE if it failed
+
Arguments:
+moving - The atom we want to move
+delay - How many deci-seconds to wait between fires. Defaults to the lowest value, 0.1
+timeout - Time in deci-seconds until the moveloop self expires. Defaults to infinity
+subsystem - The movement subsystem to use. Defaults to SSmovement. Only one loop can exist for any one subsystem
+priority - Defines how different move loops override each other. Lower numbers beat higher numbers, equal defaults to what currently exists. Defaults to MOVEMENT_DEFAULT_PRIORITY
+flags - Set of bitflags that effect move loop behavior in some way. Check _DEFINES/movement.dm
move_towards
+
+
Helper proc for the move_towards datum
+
Returns TRUE if the loop sucessfully started, or FALSE if it failed
+
Arguments:
+moving - The atom we want to move
+chasing - The atom we want to move towards
+delay - How many deci-seconds to wait between fires. Defaults to the lowest value, 0.1
+home - Should we move towards the object at all times? Or launch towards them, but allow walls and such to take us off track. Defaults to FALSE
+timeout - Time in deci-seconds until the moveloop self expires. Defaults to INFINITY
+subsystem - The movement subsystem to use. Defaults to SSmovement. Only one loop can exist for any one subsystem
+priority - Defines how different move loops override each other. Lower numbers beat higher numbers, equal defaults to what currently exists. Defaults to MOVEMENT_DEFAULT_PRIORITY
+flags - Set of bitflags that effect move loop behavior in some way. Check _DEFINES/movement.dm
move_towards_legacy
+
+
Wrapper for walk_towards, not reccomended, as it's movement ends up being a bit stilted
+
Returns TRUE if the loop sucessfully started, or FALSE if it failed
+
Arguments:
+moving - The atom we want to move
+chasing - The atom we want to move towards
+delay - How many deci-seconds to wait between fires. Defaults to the lowest value, 0.1
+timeout - Time in deci-seconds until the moveloop self expires. Defaults to infinity
+subsystem - The movement subsystem to use. Defaults to SSmovement. Only one loop can exist for any one subsystem
+priority - Defines how different move loops override each other. Lower numbers beat higher numbers, equal defaults to what currently exists. Defaults to MOVEMENT_DEFAULT_PRIORITY
+flags - Set of bitflags that effect move loop behavior in some way. Check _DEFINES/movement.dm
processing_on
+
+
Returns the subsystem's loop if we're processing on it, null otherwise
stop_looping
+
+
Removes the atom from some movement subsystem. Defaults to SSmovement
Random name search for
+DO NOT REMOVE NAMES HERE UNLESS YOU KNOW WHAT YOUR DOING
Proc Details
add_log
+
+
Records a message into the station logging system for the network
+
This CAN be read in station by personal so do not use it for game debugging
+during fire. At this point data.receiver_id has already been converted if it was a broadcast but
+is undefined in this function. It is also dumped to normal logs but remember players can read/intercept
+these messages
+Arguments:
+
+
log_string - message to log
+
hardware_id = optional, text, Blindly stapled to the end.
+
purge_logs
+
+
Removes all station logs for the current game
update_max_log_count
+
+
Updates the maximum amount of logs and purges those that go beyond that number
+
Shouldn't been needed to be run by players but maybe admins need it?
+Arguments:
Network packets
+Cycle the packet queue
+No packets no problem
+This might need [set waitfor = FALSE] alongside a CHECK_TICK
+Remove this signal from the queue and see if we're strangling the server
+Reset to the first stage
+Immediately send a packet to it's target(s). Used for high-importance packets.
Add the respective sensitivity and gridmap membership to a device.
+This is here instead of /atom/movable because there's no good reason for them to do it themselves
+(and it centralizes all the radio weirdness). Handles the atmos/nonatmos bucket split internally.
Network packets
+Cycle the packet queue
+No packets no problem
+This might need [set waitfor = FALSE] alongside a CHECK_TICK
+Remove this signal from the queue and see if we're strangling the server
+Reset to the first stage
+Immediately send a packet to it's target(s). Used for high-importance packets.
_irps_spatialgrid_atmos
+
+
Do Spatial Grid handling for IRPS, Atmos Radio group.
+These are separate to save just that little bit more overhead.
_irps_spatialgrid_everyone_else
+
+
Do Spatial Grid handling for IRPS, Non-Atmos Radio group.
+These are separate to save just that little bit more overhead.
generate_net_id
+
+
Generates a unique (at time of read) ID for an atom, It just plays silly with the ref.
+Pass the target atom in as arg[1]
make_radio_sensitive
+
+
Add the respective sensitivity and gridmap membership to a device.
+This is here instead of /atom/movable because there's no good reason for them to do it themselves
+(and it centralizes all the radio weirdness). Handles the atmos/nonatmos bucket split internally.
returns a list of cosmetic frames which patronage tier values are are within credit_value.
+If only_current_tier is TRUE, the list will be populated only by the ones from the highest tier.
A list of /datum/paintings saved or ready to be saved this round.
Proc Details
get_available_frames
+
+
returns a list of cosmetic frames which patronage tier values are are within credit_value.
+If only_current_tier is TRUE, the list will be populated only by the ones from the highest tier.
get_paintings_with_tag
+
+
Returns paintings with given tag.
painting_ui_data
+
+
Generates painting data ready to be consumed by ui.
+Args:
+
+
filter: a bitfield argument is used to filter out paintings that don't match certain requisites.
+
admin : whether all the json data of the painting is added to the return value or only the more IC details
+
search_text : text to search for if the PAINTINGS_FILTER_SEARCH_TITLE or PAINTINGS_FILTER_SEARCH_CREATOR filters are enabled.
+
save_paintings
+
+
Saves all persistent paintings
save_to_file
+
+
Saves all currently tracked painting data to file
update_format
+
+
Updates paintings data format to latest if necessary
Returns a list of mob POIs with names as keys and mobs as values.
+
If multiple POIs have the same name, then avoid_assoc_duplicate_keys is used alongside used_name_list to
+tag them as Mob Name (1), Mob Name (2), Mob Name (3) etc.
+
Arguments:
+
+
poi_validation_override - [OPTIONAL] Callback to a proc that takes a single argument for the POI and returns TRUE if this POI should be included. Overrides standard POI validation.
+
append_dead_role - [OPTIONAL] If TRUE, adds a ghost tag to the end of observer names and a dead tag to the end of any other mob which is not alive.
+
get_other_pois
+
+
Returns a list of non-mob POIs with names as keys and atoms as values.
+
If multiple POIs have the same name, then avoid_assoc_duplicate_keys is used alongside used_name_list to
+tag them as Object Name (1), Object Name (2), Object Name (3) etc.
+
Arguments:
+
+
poi_validation_override - [OPTIONAL] Callback to a proc that takes a single argument for the POI and returns TRUE if this POI should be included. Overrides standard POI validation.
+
get_poi_atom_by_ref
+
+
If there is a valid POI for a given reference, it returns that POI's associated atom. Otherwise, it returns null.
is_valid_poi
+
+
Returns TRUE if potential_poi has an associated poi_datum that validates.
make_point_of_interest
+
+
Turns new_poi into a new point of interest by adding the /datum/element/point_of_interest element to it.
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
Remove old decals and apply new decals after rotation as necessary
Proc Details
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
rotate_decals
+
+
Remove old decals and apply new decals after rotation as necessary
+
+
+
diff --git a/datum/controller/subsystem/processing/instruments.html b/datum/controller/subsystem/processing/instruments.html
new file mode 100644
index 000000000000..2c401729ffe4
--- /dev/null
+++ b/datum/controller/subsystem/processing/instruments.html
@@ -0,0 +1,85 @@
+
+
+
+
+
+
+ /datum/controller/subsystem/processing/instruments - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
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.
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.
Takes a list of quirk names and returns a new list of quirks that would
+be valid.
+If no changes need to be made, will return the same list.
+Expects all quirk names to be unique, but makes no other expectations.
Takes a list of quirk names and returns a new list of quirks that would
+be valid.
+If no changes need to be made, will return the same list.
+Expects all quirk names to be unique, but makes no other expectations.
how many times the tram can move costing less than half max_time milliseconds before we speed it back up again.
+is only used if the tram has been slowed down for exceeding max_time
how many times the tram can move costing less than half max_time milliseconds before we speed it back up again.
+is only used if the tram has been slowed down for exceeding max_time
A list of radiation sources (/datum/radiation_pulse_information) that have yet to process.
+Do not interact with this directly, use radiation_pulse instead.
A list of radiation sources (/datum/radiation_pulse_information) that have yet to process.
+Do not interact with this directly, use radiation_pulse instead.
Proc Details
can_irradiate_basic
+
+
Returns whether or not the target can be irradiated by any means.
+Does not check for clothing.
irradiate
+
+
Will attempt to irradiate the given target, limited through IC means, such as radiation protected clothing.
wearing_rad_protected_clothing
+
+
Returns whether or not the human is covered head to toe in rad-protected clothing.
+
+
+
diff --git a/datum/controller/subsystem/restaurant.html b/datum/controller/subsystem/restaurant.html
new file mode 100644
index 000000000000..d135241dcd53
--- /dev/null
+++ b/datum/controller/subsystem/restaurant.html
@@ -0,0 +1,50 @@
+
+
+
+
+
+
+ /datum/controller/subsystem/restaurant - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Caches appearances of food, assoc list where key is the type of food, and value is the appearance. Used so we don't have to keep creating new food. Gets filled whenever a new food that hasn't been ordered gets ordered for the first time.
Caches appearances of food, assoc list where key is the type of food, and value is the appearance. Used so we don't have to keep creating new food. Gets filled whenever a new food that hasn't been ordered gets ordered for the first time.
Are we currently in the process of loading a shuttle? Useful to ensure we don't load more than one at once, to avoid weird inconsistencies and possible runtimes.
An associative list of the mobile docking ports that have failed a transit request, with the amount of times they've actually failed that transit request, up to MAX_TRANSIT_REQUEST_RETRIES
Are we currently in the process of loading a shuttle? Useful to ensure we don't load more than one at once, to avoid weird inconsistencies and possible runtimes.
An associative list of the mobile docking ports that have failed a transit request, with the amount of times they've actually failed that transit request, up to MAX_TRANSIT_REQUEST_RETRIES
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.
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.
empty spatial grid cell content lists are just a reference to this instead of a standalone list to save memory without needed to check if its null when iterating
associative list of the form: movable.spatial_grid_key (string) -> inner list of spatial grid types for that key.
+inner lists contain contents channel types such as SPATIAL_GRID_CONTENTS_TYPE_HEARING etc.
+we use this to make adding to a cell static cost, and to save on memory
Adds grid awareness to the passed in atom, of the passed in type
+Basically, when this atom moves between grids, it wants to have enter/exit cell called on it
Alerts the atom's current cell that it wishes to be treated as a member
+This functionally amounts to "hey, I was recently made aware by [add_grid_awareness], please insert me into my current cell"
adds cells to the grid for every z level when world.maxx or world.maxy is expanded after this subsystem is initialized. hopefully this is never needed.
+because i never tested this.
allocate one /mob/oranges_ear mob per turf containing atoms_that_need_ears and give them a reference to every listed atom in their turf.
+if an oranges_ear is allocated to a turf that already has an oranges_ear then the second one fails to allocate (and gives the existing one the atom it was assigned to)
find the spatial map cell that target used to belong to, then remove the target (and sometimes it's important_recusive_contents) from it.
+make sure to provide the turf old_target used to be "in"
creates number_to_generate new oranges_ear's and adds them to the subsystems list of ears.
+i really fucking hope this never gets called after init :clueless:
if for whatever reason this movable is "untracked" e.g. it breaks the assumption that a movable is only inside the contents of any grid cell associated with its loc,
+this will error. this checks every grid cell in the world so dont call this on live unless you have to.
+returns TRUE if this movable is untracked, FALSE otherwise
empty spatial grid cell content lists are just a reference to this instead of a standalone list to save memory without needed to check if its null when iterating
associative list of the form: movable.spatial_grid_key (string) -> inner list of spatial grid types for that key.
+inner lists contain contents channel types such as SPATIAL_GRID_CONTENTS_TYPE_HEARING etc.
+we use this to make adding to a cell static cost, and to save on memory
everything that spawns before us is added to this list until we initialize
Proc Details
add_grid_awareness
+
+
Adds grid awareness to the passed in atom, of the passed in type
+Basically, when this atom moves between grids, it wants to have enter/exit cell called on it
add_grid_membership
+
+
Alerts the atom's current cell that it wishes to be treated as a member
+This functionally amounts to "hey, I was recently made aware by [add_grid_awareness], please insert me into my current cell"
add_single_type
+
+
acts like enter_cell() but only adds the target to a specified type of grid cell contents list
after_world_bounds_expanded
+
+
adds cells to the grid for every z level when world.maxx or world.maxy is expanded after this subsystem is initialized. hopefully this is never needed.
+because i never tested this.
assign_oranges_ears
+
+
allocate one /mob/oranges_ear mob per turf containing atoms_that_need_ears and give them a reference to every listed atom in their turf.
+if an oranges_ear is allocated to a turf that already has an oranges_ear then the second one fails to allocate (and gives the existing one the atom it was assigned to)
enter_cell
+
+
find the spatial map cell that target belongs to, then add the target to it, as its type prefers.
+make sure to provide the turf new_target is "in"
enter_pre_init_queue
+
+
add a movable to the pre init queue for whichever type is specified so that when the subsystem initializes they get added to the grid
exit_cell
+
+
find the spatial map cell that target used to belong to, then remove the target (and sometimes it's important_recusive_contents) from it.
+make sure to provide the turf old_target used to be "in"
+
+
old_target - the thing we want to remove from the spatial grid cell
+
target_turf - the turf we use to determine the cell we're removing from
+
exclusive_type - either null or a valid contents channel. if you just want to remove a single type from the grid cell then use this
+
find_hanging_cell_refs_for_movable
+
+
if shit goes south, this will find hanging references for qdeleting movables inside the spatial grid
force_remove_from_cell
+
+
remove this movable from the given spatial_grid_cell
force_remove_from_grid
+
+
example:
+
/mob/living/trolls_the_maintainer instance, which is supposed to only be in the contents of a spatial grid cell at coords: (136, 136, 14),
+was in the contents of 3 spatial grid cells when it was only supposed to be in one! within the contents of the following cells:
+{(68, 153, 2), within channels: hearing},
+{coords: (221, 170, 3), within channels: hearing},
+{coords: (255, 153, 11), within channels: hearing},
+{coords: (136, 136, 14), within channels: hearing}.
+
remove this movable from the grid by finding the grid cell its in and removing it from that.
+if it cant infer a grid cell its located in (e.g. if its in nullspace but it can happen if the grid isnt expanded to a z level), search every grid cell.
get_cell_of
+
+
get the grid cell encomapassing targets coordinates
get_cells_in_bounds
+
+
get all grid cells intersecting the bounding box around center with sides of length (2 * range_x, 2 * range_y)
get_cells_in_range
+
+
get all grid cells intersecting the bounding box around center with sides of length 2 * range
searches through the grid cells intersecting a rectangular search space (with sides of length 2 * range) then returns all contents of type inside them.
+much faster than iterating through view() to find all of what you want.
+
this does NOT return things only in range distance from center! the search space is a square not a circle, if you want only things in a certain distance
+then you need to filter that yourself
+
+
center - the atom that is the center of the searched circle
+
type - the type of grid contents you are looking for, see __DEFINES/spatial_grid.dm
+
range - the bigger this is, the more spatial grid cells the search space intersects
+
pregenerate_more_oranges_ears
+
+
creates number_to_generate new oranges_ear's and adds them to the subsystems list of ears.
+i really fucking hope this never gets called after init :clueless:
propogate_spatial_grid_to_new_z
+
+
creates the spatial grid for a new z level
queued_item_deleted
+
+
if a movable is inside our pre init queue before we're initialized and it gets deleted we need to remove that reference with this proc
remove_from_pre_init_queue
+
+
removes an initialized and probably deleted movable from our pre init queue before we're initialized
remove_grid_awareness
+
+
Removes grid awareness from the passed in atom, of the passed in type
remove_grid_membership
+
+
Removes grid membership from the passed in atom, of the passed in type
remove_single_type
+
+
acts like exit_cell() but only removes the target from the specified type of grid cell contents list
untracked_movable_error
+
+
if for whatever reason this movable is "untracked" e.g. it breaks the assumption that a movable is only inside the contents of any grid cell associated with its loc,
+this will error. this checks every grid cell in the world so dont call this on live unless you have to.
+returns TRUE if this movable is untracked, FALSE otherwise
update_grid_awareness
+
+
Updates the string that atoms hold that stores their grid awareness
+We will use it to key into their spatial grid categories later
Close all UIs regardless of their attachment to src_object.
+
return int The number of UIs closed.
close_uis
+
+
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.
close_user_uis
+
+
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.
force_close_all_windows
+
+
public
+
Force closes all tgui windows.
+
required user mob
force_close_window
+
+
public
+
Force closes the tgui window by window_id.
+
required user mob
+required window_id string
get_open_ui
+
+
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.
on_close
+
+
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.
on_logout
+
+
private
+
Handle client logout, by closing all their UIs.
+
required user mob The mob which logged out.
+
return int The number of UIs closed.
on_open
+
+
private
+
Add a UI to the list of open UIs.
+
required ui datum/tgui The UI to be added.
on_transfer
+
+
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.
request_pooled_window
+
+
public
+
Requests a usable tgui window from the pool.
+Returns null if pool was exhausted.
+
required user mob
+return datum/tgui
try_update_ui
+
+
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.
update_uis
+
+
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.
update_user_uis
+
+
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.
total service income
+This is the richest account on station at roundend.
+This is the station's total wealth at the end of the round.
+How many players joined the round.
+Awards the service department an achievement and updates the chef and bartender's highscore for tourists served.
Num of ready admins, used for pregame stats on statpanel (only viewable by admins)
Proc Details
HandleRandomHardcoreScore
+
+
Handles random hardcore point rewarding if it applies.
antag_report
+
+
gotta escape nerd
award_service
+
+
total service income
+This is the richest account on station at roundend.
+This is the station's total wealth at the end of the round.
+How many players joined the round.
+Awards the service department an achievement and updates the chef and bartender's highscore for tourists served.
+
Arguments:
+
+
award: Achievement to give service department
+
choose_round_end_song
+
+
The reference to the end of round sound that we have chosen.
declare_completion
+
+
no score no glory
draft_gamemodes
+
+
Generate a list of gamemodes we can play.
filter_headless_departments
+
+
Removes departments with a head present from the given list, returning the values as bitflags
handle_hearts
+
+
Once the round is actually over, cycle through the ckeys in the hearts list and give them the hearted status
hardcore_random_report
+
+
Generate a report for all players who made it out alive with a hardcore random character and prints their final score
log_roundend_report
+
+
Log the round-end report as an HTML file
+
Composits the roundend report, and saves it in two locations.
+The report is first saved along with the round's logs
+Then, the report is copied to a fixed directory specifically for
+housing the server's last roundend report. In this location,
+the file will be overwritten at the end of each shift.
market_report
+
+
Generate a report for how much money is on station, as well as the richest crewmember on the station.
pick_credits_music
+
+
The full path of the last song used
+The full datum of the last song used.
poll_hearts
+
+
Called when the shuttle starts launching back to centcom, polls a few random players who joined the round for commendations
Because old me wanted to keep memory costs down, each cardpack type shares a rarity list
+We do the spooky stuff in here to ensure we don't have too many lists lying around
Gets the keyword this string wants to use
+We offset the start by two indexes to account for
+Loads the contents of a json file into our global card list
List of loaded keywords matched with their hovor text
Proc Details
checkCardDatums
+
+
Checks the global card list for cards that don't override all the default values of the card datum
checkCardDistribution
+
+
Used to test open a large amount of cardpacks
checkCardpacks
+
+
Checks the passed type list for missing raritys, or raritys out of bounds
clearCards
+
+
Empty the rarity cache so we can safely add new cards
get_guarenteed_rarity_table
+
+
See above
get_rarity_table
+
+
Because old me wanted to keep memory costs down, each cardpack type shares a rarity list
+We do the spooky stuff in here to ensure we don't have too many lists lying around
loadAllCardFiles
+
+
Loads all the card files
loadCardFile
+
+
Gets the keyword this string wants to use
+We offset the start by two indexes to account for
+Loads the contents of a json file into our global card list
loadKeywordFile
+
+
Loads the contents of a json file into our global card list
printAllCards
+
+
Prints all the cards names
reloadAllCardFiles
+
+
Reloads all card files
resolve_keywords
+
+
Takes a string as input. Searches it for keywords in the pattern {$keyword}, and replaces them with their expanded form, generated above
styleKeywords
+
+
Styles our keywords, converting them from just the raw text to the output we want
+
+
+
diff --git a/datum/controller/subsystem/traitor.html b/datum/controller/subsystem/traitor.html
new file mode 100644
index 000000000000..0e3938d90939
--- /dev/null
+++ b/datum/controller/subsystem/traitor.html
@@ -0,0 +1,130 @@
+
+
+
+
+
+
+ /datum/controller/subsystem/traitor - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Global configuration data that gets applied to each objective when it is created.
+Basic objective format
+'/datum/traitor_objective/path/to/objective': {
+"global_progression_influence_intensity": 0
+}
The amount of deviance from the current global progression before you start getting 2x the current scaling or no scaling at all
+Also affects objectives, so -50% progress reduction or 50% progress boost.
Global configuration data that gets applied to each objective when it is created.
+Basic objective format
+'/datum/traitor_objective/path/to/objective': {
+"global_progression_influence_intensity": 0
+}
The amount of deviance from the current global progression before you start getting 2x the current scaling or no scaling at all
+Also affects objectives, so -50% progress reduction or 50% progress boost.
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.
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()
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 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
Proc Details
can_queue_verb
+
+
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_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()
+
returns TRUE if the queuing was successful, FALSE otherwise.
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().
+
+
+
diff --git a/datum/controller/subsystem/verb_manager/input.html b/datum/controller/subsystem/verb_manager/input.html
new file mode 100644
index 000000000000..790f0d4bf5dc
--- /dev/null
+++ b/datum/controller/subsystem/verb_manager/input.html
@@ -0,0 +1,101 @@
+
+
+
+
+
+
+ /datum/controller/subsystem/verb_manager/input - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
running average of the amount of real time clicks take to truly execute after the command is originally sent to the server.
+if a click isnt delayed at all then it counts as 0 deciseconds.
running average of the amount of real time clicks take to truly execute after the command is originally sent to the server.
+if a click isnt delayed at all then it counts as 0 deciseconds.
Takes a path to get the callback owner for
+Returns the deepest path in our callback store that matches the input
+The hope is this will prevent dumb conflicts, since the furthest down is always going to be the most relevant
Once every medium while, go through the current stock and make sure we don't have too much of one thing
+Or that we're not too low on some other stock
+This exists as a failsafe, so the wardrobe doesn't just end up generating too many items or accidentially running out somehow
Sets up insertion and removal callbacks by typepath
+We will always use the deepest path. So /obj/item/blade/knife superceeds the entries of /obj/item and /obj/item/blade
+Mind this
How many times we've had to generate a stock item on request
Proc Details
canonize_type
+
+
Canonizes the type, which means it's now managed by the subsystem, and will be created deleted and passed out to comsumers
+
Arguments:
+
+
type to stock - What type exactly do you want us to remember?
+
get_callback_type
+
+
Takes a path to get the callback owner for
+Returns the deepest path in our callback store that matches the input
+The hope is this will prevent dumb conflicts, since the furthest down is always going to be the most relevant
hard_refresh_queue
+
+
Resets the load queue to the master template, accounting for the existing stock
run_inspection
+
+
Once every medium while, go through the current stock and make sure we don't have too much of one thing
+Or that we're not too low on some other stock
+This exists as a failsafe, so the wardrobe doesn't just end up generating too many items or accidentially running out somehow
setup_callbacks
+
+
Sets up insertion and removal callbacks by typepath
+We will always use the deepest path. So /obj/item/blade/knife superceeds the entries of /obj/item and /obj/item/blade
+Mind this
stash_object
+
+
Take an existing object, and insert it into our storage
+If we can't or won't take it, it's deleted. You do not own this object after passing it in
stock_wardrobe
+
+
Turns the order list into actual loaded items, this is where most work is done
unload_stock
+
+
Unloads an amount of some type we have in stock
+Private function, for internal use only
//////TILES//////////
+///////DEFERRED TILES//////////
+///////CHECK_EDGES/////////
+///////EDGES//////////
+///////HOTSPOTS//////////
+///////ZONES//////////
+//////ATMOS EXPOSE//////
+Adds a zone to the subsystem, gives it's identifer, and marks it for update.
A global cache of unsimulated gas mixture singletons, associative by type.
Proc Details
Reboot
+
+
Stops processing while all ZAS-controlled airs and fires are nulled and the subsystem is reinitialized.
add_zone
+
+
//////TILES//////////
+///////DEFERRED TILES//////////
+///////CHECK_EDGES/////////
+///////EDGES//////////
+///////HOTSPOTS//////////
+///////ZONES//////////
+//////ATMOS EXPOSE//////
+Adds a zone to the subsystem, gives it's identifer, and marks it for update.
air_blocked
+
+
Checks to see if air can flow between A and B.
connect
+
+
Forms a /connection/ between two turfs.
create_edge
+
+
Create an edge of the appropriate type between zone A and zone-or-turf B.
excite_edge
+
+
Wakes an edge, adding it to the active process list.
get_edge
+
+
Returns the edge between zones A and B. If one doesn't exist, it creates one. See header for more information
mark_for_update
+
+
The logic around get_edge() requires air to exist at this point, which it probably should.
+Marks a turf for update.
Required machines for the craft, set the assigned value of the typepath to CRAFTING_MACHINERY_CONSUME or CRAFTING_MACHINERY_USE. Lazy associative list: type_path key -> flag value.
Required machines for the craft, set the assigned value of the typepath to CRAFTING_MACHINERY_CONSUME or CRAFTING_MACHINERY_USE. Lazy associative list: type_path key -> flag value.
Type paths of items needed but not consumed. Lazy list.
Proc Details
atmos_pipe_check
+
+
Check if the pipe used for atmospheric device crafting is the proper one
check_requirements
+
+
Run custom pre-craft checks for this recipe, don't add feedback messages in this because it will spam the client
+
user: The /mob that initiated the crafting
+collected_requirements: A list of lists of /obj/item instances that satisfy reqs. Top level list is keyed by requirement path.
+
+
+
diff --git a/datum/crewmonitor.html b/datum/crewmonitor.html
new file mode 100644
index 000000000000..562f6dfb227c
--- /dev/null
+++ b/datum/crewmonitor.html
@@ -0,0 +1,57 @@
+
+
+
+
+
+
+ /datum/crewmonitor - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Returns the object that will be stored in the controller blackboard for the customer bot.
+Normally but not necessarily, this would be the custom order itself. The moth clothing is a
+good example of an exception to that.
Whether or not the order is correct. Only relevant if dispense_order didn't return another object.
Proc Details
dispense_order
+
+
Returns the object that will be stored in the controller blackboard for the customer bot.
+Normally but not necessarily, this would be the custom order itself. The moth clothing is a
+good example of an exception to that.
get_order_appearance
+
+
Returns the appearance of the order that appears when hovering over the mob with the cursor
get_order_line
+
+
Returns the order line shout by the mob and also shown to the player when examining it.
is_correct_order
+
+
Whether or not the order is correct. Only relevant if dispense_order didn't return another object.
+
+
+
diff --git a/datum/custom_order/icecream.html b/datum/custom_order/icecream.html
new file mode 100644
index 000000000000..7b07064b14e0
--- /dev/null
+++ b/datum/custom_order/icecream.html
@@ -0,0 +1,50 @@
+
+
+
+
+
+
+ /datum/custom_order/icecream - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Creates a copy of the record, without it's library.
get_front_photo
+
+
A helper proc to get the front photo of a character from the record.
+Handles calling get_photo(), read its documentation for more information.
get_photo
+
+
You shouldn't be calling this directly, use get_front_photo() or get_side_photo()
+instead.
+
This is the proc that handles either fetching (if it was already generated before) or
+generating (if it wasn't) the specified photo from the specified record. This is only
+intended to be used by records that used to try to access fields["photo_front"] or
+fields["photo_side"], and will return an empty icon if there isn't any of the necessary
+fields.
+
Arguments:
+
+
field_name - The name of the key in the fields list, of the record itself.
+
orientation - The direction in which you want the character appearance to be rotated
+in the outputed photo.
+
+
Returns an empty /icon if there was no character_appearance entry in the fields list,
+returns the generated/cached photo otherwise.
get_side_photo
+
+
A helper proc to get the side photo of a character from the record.
+Handles calling get_photo(), read its documentation for more information.
Bitflags indicating what machines this design is compatable with. ([IMPRINTER]|AWAY_IMPRINTER|[FABRICATOR]|[AWAY_LATHE]|[AUTOLATHE]|[MECHFAB]|[BIOGENERATOR]|[LIMBGROWER]|[SMELTER])
Bitflags indicating what machines this design is compatable with. ([IMPRINTER]|AWAY_IMPRINTER|[FABRICATOR]|[AWAY_LATHE]|[AUTOLATHE]|[MECHFAB]|[BIOGENERATOR]|[LIMBGROWER]|[SMELTER])
Documentation for the embed object and all of its variables can be found at
+https://discord.com/developers/docs/resources/channel#embed-object
+It is recommended to read the documentation on the discord website, as the information below could become outdated in the future.
Proc to process the disease and decide on whether to advance, cure or make the sympthoms appear. Returns a boolean on whether to continue acting on the symptoms or not.
The probability of this infection advancing a stage every second the cure is not present.
Proc Details
is_viable_mobtype
+
+
Checks the given typepath against the list of viable mobtypes.
+
Returns TRUE if the mob_type path is derived from of any entry in the viable_mobtypes list.
+Returns FALSE otherwise.
+
Arguments:
+
+
mob_type - Type path to check against the viable_mobtypes list.
+
stage_act
+
+
Proc to process the disease and decide on whether to advance, cure or make the sympthoms appear. Returns a boolean on whether to continue acting on the symptoms or not.
Called when beginning a new dream for the dreamer.
+Gives back a list of dream events. Events can be text or callbacks that return text.
+The associated value is the delay FOLLOWING the message at that index, in deciseconds.
The relative chance this dream will be randomly selected
Proc Details
DreamLoop
+
+
Displays the passed list of dream fragments to a sleeping carbon.
+
Displays the first string of the passed dream fragments, then either ends the dream sequence
+or performs a callback on itself depending on if there are any remaining dream fragments to display.
+
Arguments:
+
+
dreamer - The mob we're looping on.
+
dreamer_mind - The mind that is dreaming.
+
dream_fragments - A list of strings, in the order they will be displayed.
+
GenerateDream
+
+
Called when beginning a new dream for the dreamer.
+Gives back a list of dream events. Events can be text or callbacks that return text.
+The associated value is the delay FOLLOWING the message at that index, in deciseconds.
OnDreamEnd
+
+
Called when the dream ends or is interrupted.
OnDreamStart
+
+
Called when the dream starts.
WrapMessage
+
+
Called by dream_sequence to wrap a message in any effects.
+
+
+
diff --git a/datum/dream/detective_nightmare/limbic_system.html b/datum/dream/detective_nightmare/limbic_system.html
new file mode 100644
index 000000000000..81ea145b718a
--- /dev/null
+++ b/datum/dream/detective_nightmare/limbic_system.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /datum/dream/detective_nightmare/limbic_system - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Judges the amount of antagonists to apply, for both solo and teams.
+Note that some antagonists (such as traitors, lings, heretics, etc) will add more based on how many times they've been scaled.
+Written as a linear equation--ceil(x/denominator) + offset, or as a fixed constant.
+If written as a linear equation, will be in the form of `list("denominator" = denominator, "offset" = offset).
Base probability used in scaling. The higher it is, the more likely to scale. Kept as a var to allow for config editing._SendSignal(sigtype, list/arguments)
Delay for when execute will get called from the time of post_setup (roundstart) or process (midround/latejoin).
+Make sure your ruleset works with execute being called during the game when using this, and that the clean_up proc reverts it properly in case of faliure.
If set, there needs to be a certain amount of players doing those roles (among the players who won't be drafted) for the rule to be drafted IMPORTANT: DOES NOT WORK ON ROUNDSTART RULESETS.
If set, rule will only accept candidates from those roles. If on a roundstart ruleset, requires the player to have the correct antag pref enabled and any of the possible roles enabled.
If enemy_roles was set, this is the amount of enemy job workers needed per threat_level range (0-10,10-20,etc) IMPORTANT: DOES NOT WORK ON ROUNDSTART RULESETS.
Requirements are the threat level requirements per pop range.
+With the default values, The rule will never get drafted below 10 threat level (aka: "peaceful extended"), and it requires a higher threat level at lower pops.
By default, a rule is acceptable if it satisfies the threat level/population requirements.
+If your rule has extra checks, such as counting security officers, do that in ready() instead
Runs from gamemode process() if ruleset fails to start, like delayed rulesets not getting valid candidates.
+This one only handles refunding the threat, override in ruleset to clean up the rest.
Called on post_setup on roundstart and when the rule executes on midround and latejoin.
+Give your candidates or assignees equipment and antag datum here.
Gets weight of the ruleset
+Note that this decreases weight if repeatable is TRUE and repeatable_weight_decrease is higher than 0
+Note: If you don't want repeatable rulesets to decrease their weight use the weight variable directly
Here you can perform any additional checks you want. (such as checking the map etc)
+Remember that on roundstart no one knows what their job is at this point.
+IMPORTANT: If ready() returns TRUE, that means pre_execute() or execute() should never fail!
When picking rulesets, if dynamic picks the same one multiple times, it will "scale up".
+However, doing this blindly would result in lowpop rounds (think under 10 people) where over 80% of the crew is antags!
+This function is here to ensure the antag ratio is kept under control while scaling up.
+Returns how much threat to actually spend in the end.
Here you can remove candidates that do not meet your requirements.
+This means if their job is not correct or they have disconnected you can remove them from candidates here.
+Usually this does not need to be changed unless you need some specific requirements from your candidates.
Judges the amount of antagonists to apply, for both solo and teams.
+Note that some antagonists (such as traitors, lings, heretics, etc) will add more based on how many times they've been scaled.
+Written as a linear equation--ceil(x/denominator) + offset, or as a fixed constant.
+If written as a linear equation, will be in the form of `list("denominator" = denominator, "offset" = offset).
Base probability used in scaling. The higher it is, the more likely to scale. Kept as a var to allow for config editing._SendSignal(sigtype, list/arguments)
Delay for when execute will get called from the time of post_setup (roundstart) or process (midround/latejoin).
+Make sure your ruleset works with execute being called during the game when using this, and that the clean_up proc reverts it properly in case of faliure.
If set, there needs to be a certain amount of players doing those roles (among the players who won't be drafted) for the rule to be drafted IMPORTANT: DOES NOT WORK ON ROUNDSTART RULESETS.
If set, rule will only accept candidates from those roles. If on a roundstart ruleset, requires the player to have the correct antag pref enabled and any of the possible roles enabled.
If enemy_roles was set, this is the amount of enemy job workers needed per threat_level range (0-10,10-20,etc) IMPORTANT: DOES NOT WORK ON ROUNDSTART RULESETS.
Requirements are the threat level requirements per pop range.
+With the default values, The rule will never get drafted below 10 threat level (aka: "peaceful extended"), and it requires a higher threat level at lower pops.
0 -> 9, probability for this rule to be picked against other rules. If zero this will effectively disable the rule.
Proc Details
acceptable
+
+
By default, a rule is acceptable if it satisfies the threat level/population requirements.
+If your rule has extra checks, such as counting security officers, do that in ready() instead
check_finished
+
+
Returns TRUE if the round should end.
clean_up
+
+
Runs from gamemode process() if ruleset fails to start, like delayed rulesets not getting valid candidates.
+This one only handles refunding the threat, override in ruleset to clean up the rest.
execute
+
+
Called on post_setup on roundstart and when the rule executes on midround and latejoin.
+Give your candidates or assignees equipment and antag datum here.
get_antag_cap
+
+
Returns what the antag cap with the given population is.
get_weight
+
+
Gets weight of the ruleset
+Note that this decreases weight if repeatable is TRUE and repeatable_weight_decrease is higher than 0
+Note: If you don't want repeatable rulesets to decrease their weight use the weight variable directly
pre_execute
+
+
Called on game mode pre_setup for roundstart rulesets.
+Do everything you need to do before job is assigned here.
+IMPORTANT: ASSIGN special_role HERE
ready
+
+
Here you can perform any additional checks you want. (such as checking the map etc)
+Remember that on roundstart no one knows what their job is at this point.
+IMPORTANT: If ready() returns TRUE, that means pre_execute() or execute() should never fail!
round_result
+
+
Set mode result and news report here.
+Only called if ruleset is flagged as HIGH_IMPACT_RULESET
rule_process
+
+
This is called if persistent variable is true everytime SSTicker ticks.
scale_up
+
+
When picking rulesets, if dynamic picks the same one multiple times, it will "scale up".
+However, doing this blindly would result in lowpop rounds (think under 10 people) where over 80% of the crew is antags!
+This function is here to ensure the antag ratio is kept under control while scaling up.
+Returns how much threat to actually spend in the end.
trim_candidates
+
+
Here you can remove candidates that do not meet your requirements.
+This means if their job is not correct or they have disconnected you can remove them from candidates here.
+Usually this does not need to be changed unless you need some specific requirements from your candidates.
Whether to weld every vent and air scrubber in the affected area shut.
Proc Details
Chilled
+
+
Chills an open turf.
+
Forces the air temperature to a specific value.
+Transmutes all of the plasma in the air into nitrogen.
+Extinguishes all fires and burning objects/mobs in the turf.
+May freeze all vents and vent scrubbers shut.
bespoke element that picks an suffix to append onto the icon state from a list given on creation, among some pixel shifting stuff
+basically you will see VARIETY in a batch of simplemobs.
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
+Leaving something at 0 means it's off - has no maximum.
+This damage is taken when atmos doesn't fit all the requirements above.
+atmos requirements element!
+
bespoke element that deals damage to the attached mob when the atmos requirements aren't satisfied
When attached to a gun and the gun is successfully fired, this element creates a "backblast" of fire and pain, like you'd find in a rocket launcher or recoilless rifle
+
The backblast is simulated by a number of fire plumes, or invisible incendiary rounds that will torch anything they come across for a short distance, as well as knocking
+back nearby items.
Beauty element. It makes the indoor area the parent is in prettier or uglier depending on the beauty var value.
+Clean and well decorated areas lead to positive moodlets for passerbies;
+Shabbier, dirtier ones lead to negative moodlets EXCLUSIVE to characters with the snob quirk.
Assoc list of atoms as keys and number of time the same element instance has been attached to them as assoc value.
+So things don't get odd with same-valued yet dissimilar beauty modifiers being added to the same atom.
Assoc list of atoms as keys and number of time the same element instance has been attached to them as assoc value.
+So things don't get odd with same-valued yet dissimilar beauty modifiers being added to the same atom.
Bespoke element that, on a certain chance to proc, transfers all chemicals from the person attacking to the victim being attacked
+with whatever item has this element.
+
attacker_message uses %VICTIM as whomever is getting attacked.
+victim_message uses %ATTACKER for the same.
Apply basic contextual screentips when the user hovers over this item with an empty hand.
+A "Type B" interaction.
+This stacks with other contextual screentip elements, though you may want to register the signal/flag manually at that point for performance.
Apply basic contextual screentips when the user hovers over this item with a provided item.
+A "Type B" interaction.
+This stacks with other contextual screentip elements, though you may want to register the signal/flag manually at that point for performance.
Apply basic contextual screentips when the user hovers over this item with an item of the given tool behavior.
+A "Type B" interaction.
+This stacks with other contextual screentip elements, though you may want to register the signal/flag manually at that point for performance.
Bespoke element that sends a harrowing message when you first pick up an item, applying a spooky color outline and renaming the item.
+For most items, it will announce when picked up. If the item can be equipped, though, it will only announce when the item is worn.
+Possible improvements for the future: add an option to allow the cursed affix to be a prefix. right now only coded for suffixes
What smoothing junction this was initialized with.
Proc Details
generate_appearance
+
+ generate_appearance
+
If the decal was not given an appearance, it will generate one based on the other given arguments.
+element won't be compatible if it cannot do either
+all args are fed into creating an image, they are byond vars for images you'll recognize in the byond docs
+(except source, source is the object whose appearance we're copying.)
smooth_react
+
+
Reacts to the source atom smoothing.
+
Arguments:
+
+
source: The source of the signal and recently smoothed atom.
whether we can skip assigning all the vars (since these are bespoke elements, we don't have to reset the vars every time we attach to something, we already know what we are!)
tryForceEmbed() is called here when we fire COMSIG_EMBED_TRY_FORCE from /obj/item/proc/tryEmbed. Mostly, this means we're a piece of shrapnel from a projectile that just impacted something, and we're trying to embed in it.
whether we can skip assigning all the vars (since these are bespoke elements, we don't have to reset the vars every time we attach to something, we already know what we are!)
Proc Details
checkEmbed
+
+
Checking to see if we're gonna embed into a human
checkEmbedProjectile
+
+
checkEmbedProjectile() is what we get when a projectile with a defined shrapnel_type impacts a target.
+
If we hit a valid target, we create the shrapnel_type object and immediately call tryEmbed() on it, targeting what we impacted. That will lead
+it to call tryForceEmbed() on its own embed element (it's out of our hands here, our projectile is done), where it will run through all the checks it needs to.
detachFromWeapon
+
+
If we don't want to be embeddable anymore (deactivating an e-dagger for instance)
examined
+
+
Someone inspected our embeddable item
severancePackage
+
+
A different embed element has been attached, so we'll detach and let them handle things
tryForceEmbed
+
+
tryForceEmbed() is called here when we fire COMSIG_EMBED_TRY_FORCE from /obj/item/proc/tryEmbed. Mostly, this means we're a piece of shrapnel from a projectile that just impacted something, and we're trying to embed in it.
+
The reason for this extra mucking about is avoiding having to do an extra hitby(), and annoying the target by impacting them once with the projectile, then again with the shrapnel, and possibly
+AGAIN if we actually embed. This way, we save on at least one message.
+
Arguments:
+
+
I- the item we're trying to insert into the target
+
target- what we're trying to shish-kabob, either a bodypart or a carbon
+
hit_zone- if our target is a carbon, try to hit them in this zone, if we don't have one, pick a random one. If our target is a bodypart, we already know where we're hitting.
+
forced- if we want this to succeed 100%
+
+
+
+
diff --git a/datum/element/eyestab.html b/datum/element/eyestab.html
new file mode 100644
index 000000000000..ee2a57131496
--- /dev/null
+++ b/datum/element/eyestab.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /datum/element/eyestab - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
A list of turfs occupied by the movables this element is attached to.
+Needed so it stops listening the turf's signals ONLY when it has no movable with the element.
Adds the movable to the list of movables with the element occupying the turf.
+If the turf was not on the list of occupied turfs before, a signal will be registered
+to it.
Removes the movable from the list of movables with the element occupying the turf.
+If the turf is no longer occupied, it'll be removed from the list, and the signal
+unregistered from it
A list of turfs occupied by the movables this element is attached to.
+Needed so it stops listening the turf's signals ONLY when it has no movable with the element.
The priority this element has in relation to other elements of the same type attached to other movables on the same turf.
Proc Details
occupy_turf
+
+
Adds the movable to the list of movables with the element occupying the turf.
+If the turf was not on the list of occupied turfs before, a signal will be registered
+to it.
prepare_steps
+
+
Changes the sound types to be played if the element priority is higher than the one in the steps list.
vacate_turf
+
+
Removes the movable from the list of movables with the element occupying the turf.
+If the turf is no longer occupied, it'll be removed from the list, and the signal
+unregistered from it
+
+
+
diff --git a/datum/element/forced_gravity.html b/datum/element/forced_gravity.html
new file mode 100644
index 000000000000..51a462ba30dd
--- /dev/null
+++ b/datum/element/forced_gravity.html
@@ -0,0 +1,43 @@
+
+
+
+
+
+
+ /datum/element/forced_gravity - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Element for scaling item appearances in the overworld or in inventory/storage.
+
This bespoke element allows for items to have varying sizes depending on their location.
+The overworld simply refers to items being on a turf. Inventory includes HUD item slots,
+and storage is anywhere a storage component is used.
+Scaling should affect the item's icon and all attached overlays (such as blood decals).
Scaling value when the attached item is in a storage component or inventory slot.
Proc Details
Attach
+
+
Attach proc for the item_scaling element
+
The proc checks the target's type before attaching. It then initializes
+the target to overworld scaling. The target should then rescale if it is placed
+in inventory/storage on initialization. Relevant signals are registered to listen
+for pickup/drop or storage events. Scaling values of 1 will result in items
+returning to their original size.
+Arguments:
+
+
target - Datum to attach the element to.
+
overworld_scaling - Integer or float to scale the item in the overworld.
+
storage_scaling - Integer or float to scale the item in storage/inventory.
+
Detach
+
+
Detach proc for the item_scaling element.
+
All registered signals are unregistered, and the attached element is removed from the target datum.
+Arguments:
+
+
target - Datum which the element is attached to.
+
scale
+
+
Scales the attached item's matrix.
+
The proc first narrows the type of the source to (datums do not have a transform matrix).
+It then creates an identity matrix, M, which is transformed by the scaling value.
+The object's transform variable (matrix) is then set to the resulting value of M.
+Arguments:
+
+
source - Source datum which sent the signal.
+
scaling - Integer or float to scale the item's matrix.
+
scale_overworld
+
+
Signal handler for COMSIG_ITEM_DROPPED or COMSIG_ATOM_EXITED
+
Longer detailed paragraph about the proc
+including any relevant detail
+Arguments:
+
+
source - Source datum which sent the signal.
+
scale_storage
+
+
Signal handler for COMSIG_ITEM_EQUIPPED or COMSIG_ATOM_ENTERED.
+
Longer detailed paragraph about the proc
+including any relevant detail
+Arguments:
Kneecapping element replaces the item's secondary attack with an aimed attack at the kneecaps under certain circumstances.
+
Element is incompatible with non-items. Requires the parent item to have a force equal to or greater than WOUND_MINIMUM_DAMAGE.
+Also requires that the parent can actually get past pre_secondary_attack without the attack chain cancelling.
+
Kneecapping attacks have a wounding bonus between severe and critical+10 wound thresholds. Without some serious wound protecting
+armour this all but guarantees a wound of some sort. The attack is directed specifically at a limb and the limb takes the damage.
+
Requires the attacker to be aiming for either leg zone, which will be targetted specifically. They will than have a 3-second long
+do_mob before executing the attack.
+
Kneecapping requires the target to either be on the floor, immobilised or buckled to something. And also to have an appropriate leg.
+
Passing all the checks will cancel the entire attack chain.
Signal handler for COMSIG_ITEM_ATTACK_SECONDARY. Does checks for pacifism, zones and target state before either returning nothing
+if the special attack could not be attempted, performing the ordinary attack procs instead - Or cancelling the attack chain if
+the attack can be started.
Proc Details
do_kneecap_target
+
+
After a short do_mob, attacker applies damage to the given leg with a significant wounding bonus, applying the weapon's force as damage.
try_kneecap_target
+
+
Signal handler for COMSIG_ITEM_ATTACK_SECONDARY. Does checks for pacifism, zones and target state before either returning nothing
+if the special attack could not be attempted, performing the ordinary attack procs instead - Or cancelling the attack chain if
+the attack can be started.
Mobs and items with this element will knock movable targets they hit away from them.
+Guns and turrets will instead fire projectiles with similar effects.
Heals the user (if attached to an item) or the mob itself (if attached to a hostile simple mob)
+by a flat amount whenever a successful attack is performed against another living mob.
An element that enables and disables movetype bitflags whenever the relative traits are added or removed.
+It also handles the +2/-2 pixel y anim loop typical of mobs possessing the FLYING or FLOATING movetypes.
+This element is necessary for the TRAIT_MOVE_ traits to work correctly, so make sure to attach this element
+before adding them to non-living movables.
Bespoke element that plays a fun message, sends a heart out, and gives a stronger mood bonus when you pet this animal.
+I may have been able to make this work for carbons, but it would have been interjecting on some help mode interactions anyways.
-- Plant backfire element --
+Certain high-danger plants, like death-nettles, will backfire and harm the holder if they're not properly protected.
+If a user is protected with something like leather gloves, they can handle them normally.
+If they're not protected properly, we invoke a callback on the user, harming or inconveniencing them.
Any plant genes we want to check that are required for our plant to be dangerous. Plants without a gene in this list will be considered safe. List of typepaths.
The actual backfire occurs here.
+Checks if the user is able to safely handle the plant.
+If not, sends the backfire signal (meaning backfire will occur and be handled by one or multiple genes).
Any plant genes we want to check that are required for our plant to be dangerous. Plants without a gene in this list will be considered safe. List of typepaths.
The actual backfire occurs here.
+Checks if the user is able to safely handle the plant.
+If not, sends the backfire signal (meaning backfire will occur and be handled by one or multiple genes).
+
Returns FALSE if the user was safe and no backfire occured.
+Returns TRUE if the user was not safe and a backfire actually happened.
pickup_safety_check
+
+
Checks before we pick up the plant if we're okay to continue.
Actually checks if our user is safely handling our plant.
+
Checks for TRAIT_PLANT_SAFE, and returns TRUE if we have it.
+Then, any extra traits we need to check (Like TRAIT_PIERCEIMMUNE for nettles) and returns TRUE if we have one of them.
+Then, any extra genes we need to check (Like liquid contents for bluespace tomatos) and returns TRUE if we don't have the gene.
This element is used to indicate that a movable atom can be mounted by mobs in order to ride it. The movable is considered mounted when a mob is buckled to it,
+at which point a riding component is created on the movable, and that component handles the actual riding behavior.
+
Besides the target, the ridable element has one argument: the component subtype. This is not really ideal since there's ~20-30 component subtypes rather than
+having the behavior defined on the ridable atoms themselves or some such, but because the old riding behavior was so horrifyingly spread out and redundant,
+just having the variables, behavior, and procs be standardized is still a big improvement.
Adding this element to an atom will have it automatically render an overlay.
+The overlay can be specified in new as the first paramter; if not set it defaults to rust_overlay's rust_default
bespoke element that assigns a series number to toys on examine, and shows their series name!
+used for mechas and rare collectable hats, should totally be used for way more ;)
Non bespoke element (1 in existence) that makes animals fly while living and... not while dead!
+Note: works for carbons and above, but please do something better. humans have wings got dangit!
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
+
+
+
diff --git a/datum/element/strippable.html b/datum/element/strippable.html
new file mode 100644
index 000000000000..12c2ec326ecf
--- /dev/null
+++ b/datum/element/strippable.html
@@ -0,0 +1,54 @@
+
+
+
+
+
+
+ /datum/element/strippable - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
A proc path that returns TRUE/FALSE if we should show the strip panel for this entity.
+If it does not exist, the strip menu will always show.
+Will be called with (mob/user).
A proc path that returns TRUE/FALSE if we should show the strip panel for this entity.
+If it does not exist, the strip menu will always show.
+Will be called with (mob/user).
Most of the text that's not someone talking is based off of this.
+
Yes, the displayed message is stored on the datum, it would cause problems
+for emotes with a message that can vary, but that's handled differently in
+run_emote(), so be sure to use can_message_change if you plan to have
+different displayed messages from player to player.
Returns a number to be used as the frequency variable for the emote sound.
+[/datum/emote/var/vary] must also be set to TRUE for this to work, due a check in playsound_local().
Check to see if the user is allowed to run the emote.
+
Arguments:
+
+
user - Person that is trying to send the emote.
+
status_check - Bool that says whether we should check their stat or not.
+
intentional - Bool that says whether the emote was forced (FALSE) or not (TRUE).
+
+
Returns a bool about whether or not the user can run the emote.
check_cooldown
+
+
For handling emote cooldown, return true to allow the emote to happen.
+
Arguments:
+
+
user - Person that is trying to send the emote.
+
intentional - Bool that says whether the emote was forced (FALSE) or not (TRUE).
+
+
Returns FALSE if the cooldown is not over, TRUE if the cooldown is over.
get_frequency
+
+
Returns a number to be used as the frequency variable for the emote sound.
+[/datum/emote/var/vary] must also be set to TRUE for this to work, due a check in playsound_local().
+
Arguments:
+
+
user - Person that is trying to send the emote.
+
+
Returns the frequency that will modify the the sound used by the emote.
get_sound
+
+
To get the sound that the emote plays, for special sound interactions depending on the mob.
+
Arguments:
+
+
user - Person that is trying to send the emote.
+
+
Returns the sound that will be made while sending the emote.
replace_pronoun
+
+
To replace pronouns in the inputed string with the user's proper pronouns.
+
Arguments:
+
+
user - Person that is trying to send the emote.
+
msg - The string to modify.
+
+
Returns the modified msg string.
run_emote
+
+
Handles the modifications and execution of emotes.
+
Arguments:
+
+
user - Person that is trying to send the emote.
+
params - Parameters added after the emote.
+
type_override - Override to the current emote_type.
+
intentional - Bool that says whether the emote was forced (FALSE) or not (TRUE).
+
+
Returns TRUE if it was able to run the emote, FALSE otherwise.
select_message_type
+
+
Selects the message type to override the message with.
+
Arguments:
+
+
user - Person that is trying to send the emote.
+
msg - The string to modify.
+
intentional - Bool that says whether the emote was forced (FALSE) or not (TRUE).
+
+
Returns the new message, or msg directly, if no change was needed.
select_param
+
+
Replaces the %t in the message in message_param by params.
+
Arguments:
+
+
user - Person that is trying to send the emote.
+
params - Parameters added after the emote.
+
+
Returns the modified string.
should_play_sound
+
+
Check to see if the user should play a sound when performing the emote.
+
Arguments:
+
+
user - Person that is doing the emote.
+
intentional - Bool that says whether the emote was forced (FALSE) or not (TRUE).
+
+
Returns a bool about whether or not the user should play a sound when performing the emote.
+
+
+
diff --git a/datum/emote/living/blush.html b/datum/emote/living/blush.html
new file mode 100644
index 000000000000..4672c9fde974
--- /dev/null
+++ b/datum/emote/living/blush.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /datum/emote/living/blush - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Used to store specific data needed for a reaction, usually used to keep track of things between explosion calls. CANNOT be used as a part of chemical_recipe - those vars are static lookup tables.
The target volume the reaction is headed towards. This is updated every tick, so isn't the total value for the reaction, it's just a way to ensure we can't make more than is possible.
Allow us to deal with lag by "charging" up our reactions to react faster over a period - this means that the reaction doesn't suddenly mass react - which can cause explosions
Used to store specific data needed for a reaction, usually used to keep track of things between explosion calls. CANNOT be used as a part of chemical_recipe - those vars are static lookup tables.
The target volume the reaction is headed towards. This is updated every tick, so isn't the total value for the reaction, it's just a way to ensure we can't make more than is possible.
Allow us to deal with lag by "charging" up our reactions to react faster over a period - this means that the reaction doesn't suddenly mass react - which can cause explosions
Try to find aventure first since they're the meat of the system.
+Fill other events
+Baseline weights for each event root type
+Weight mods scaled by distance, resources are more easily found on farther sites
These are used to determine events/adventures possible for this site
Proc Details
build_exploration_event_requirements_cache
+
+
List of exploration event requirements indexed by type, ./datum/exploration_site/a = list("required"=list(trait),"blacklisted"=list(other_trait))
generate_scan_conditions
+
+
Try to find aventure first since they're the meat of the system.
+Fill other events
+Baseline weights for each event root type
+Weight mods scaled by distance, resources are more easily found on farther sites
Unit name. Only used in "Received [total_amount] [name]s [message]." message
Proc Details
sell_object
+
+
Calculates the exact export value of the object, while factoring in all the relivant variables.
+
Called only once, when the object is actually sold by the datum.
+Adds item's cost and amount to the current export cycle.
+get_cost, get_amount and applies_to do not neccesary mean a successful sale.
total_printout
+
+
This is the value of the object, as derived from export datums.
+Quantity of the object in question.
+
+
+
diff --git a/datum/fantasy_affix.html b/datum/fantasy_affix.html
new file mode 100644
index 000000000000..7b30c3b20384
--- /dev/null
+++ b/datum/fantasy_affix.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /datum/fantasy_affix - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
This proc assigns each feed_channel a random integer, from 1-999 as a unique identifer.
+Using this value, the TGUI window has a unique identifier to attach to messages that can be used to reattach them
+to their parent channels back in dreammaker.
+Based on implementation, we're limiting outselves to only 998 player made channels maximum. How we'd use all of them, I don't know.
This proc assigns each feed_channel a random integer, from 1-999 as a unique identifer.
+Using this value, the TGUI window has a unique identifier to attach to messages that can be used to reattach them
+to their parent channels back in dreammaker.
+Based on implementation, we're limiting outselves to only 998 player made channels maximum. How we'd use all of them, I don't know.
+
+
+
diff --git a/datum/feed_comment.html b/datum/feed_comment.html
new file mode 100644
index 000000000000..08298a0a3f45
--- /dev/null
+++ b/datum/feed_comment.html
@@ -0,0 +1,50 @@
+
+
+
+
+
+
+ /datum/feed_comment - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
The total number of fluid objects that have ever been in this group.
Proc Details
add_node
+
+
Adds a fluid node to this fluid group.
+
Is a noop if the node is already in the group.
+Removes the node from any other fluid groups it is in.
+Syncs the group of the node with the group it is being added to (this one).
+Increments the total size of the fluid group.
+
Arguments:
+
+
node: The fluid node that is going to be added to this group.
+
+
Returns:
+
+
[TRUE]: If the node to be added is in this group by the end of the proc.
+
+
remove_node
+
+
Removes a fluid node from this fluid group.
+
Is a noop if the node is not in this group.
+Nulls the nodes fluid group ref to sync it with its new state.
+DOES NOT decrement the total size of the fluid group.
+
Arguments:
+
+
node: The fluid node that is going to be removed from this group.
+
+
Returns:
+
+
[TRUE]: If the node to be removed is not in the group by the end of the proc.
+
+
+
+
diff --git a/datum/food_processor_process.html b/datum/food_processor_process.html
new file mode 100644
index 000000000000..21b9f96faa72
--- /dev/null
+++ b/datum/food_processor_process.html
@@ -0,0 +1,78 @@
+
+
+
+
+
+
+ /datum/food_processor_process - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
If set, rule will only accept candidates from those roles. If on a roundstart ruleset, requires the player to have the correct antag pref enabled and any of the possible roles enabled.
Jobs required for this round type to function, k:v list of JOB_TITLE : NUM_JOB. list(list(cap=1),list(hos=1,sec=2)) translates to one captain OR one hos and two secmans
If set, rule will only accept candidates from those roles. If on a roundstart ruleset, requires the player to have the correct antag pref enabled and any of the possible roles enabled.
Jobs required for this round type to function, k:v list of JOB_TITLE : NUM_JOB. list(list(cap=1),list(hos=1,sec=2)) translates to one captain OR one hos and two secmans
A number between -5 and +5.
+Equivalent to threat_curve_centre, but for the budget split.
+A negative value will weigh towards midround rulesets, and a positive
+value will weight towards roundstart ones.
A number between 0.5 and 4.
+Equivalent to threat_curve_width, but for the budget split.
+Higher value will favour more variance in splits and
+lower value rounds closer to the average.
* If the value is five the range is:
+* 0-4, 5-9, 10-14, 15-19, 20-24, 25-29, 30-34, 35-39, 40-54, 45+
+* If it is six the range is:
+* 0-5, 6-11, 12-17, 18-23, 24-29, 30-35, 36-41, 42-47, 48-53, 54+
+* If it is seven the range is:
+* 0-6, 7-13, 14-20, 21-27, 28-34, 35-41, 42-48, 49-55, 56-62, 63+
+
A number between -5 and +5.
+Equivalent to threat_curve_centre, but for the budget split.
+A negative value will weigh towards midround rulesets, and a positive
+value will weight towards roundstart ones.
A number between 0.5 and 4.
+Equivalent to threat_curve_width, but for the budget split.
+Higher value will favour more variance in splits and
+lower value rounds closer to the average.
A special datum used by the families gamemode and dynamic rulesets to centralize code. "Family" and "gang" used interchangeably in code.
+
This datum centralizes code used for the families gamemode / dynamic rulesets. Families incorporates a significant
+amount of unique processing; without this datum, that could would be duplicated. To ensure the maintainability
+of the families gamemode / rulesets, the code was moved to this datum. The gamemode / rulesets instance this
+datum, pass it lists (lists are passed by reference; removing candidates here removes candidates in the gamemode),
+and call its procs. Additionally, the families antagonist datum and families induction package also
+contain vars that reference this datum, allowing for new families / family members to add themselves
+to this datum's lists thereof (primarily used for point calculation). Despite this, the basic team mechanics
+themselves should function regardless of this datum's instantiation, should a player have the gang or cop
+antagonist datum added to them through methods external to the families gamemode / rulesets.
List of all eligible starting family members / undercover cops. Set externally (passed by reference) by gamemode / ruleset; used internally. Note that dynamic uses a list of mobs to handle candidates while game_modes use lists of minds! Don't be fooled!
Keeps track of the amount of deaths since the calling of pre_setup_analogue() if this is a midround handler. Used to prevent a high wanted level due to a large amount of deaths during the shift prior to the activation of this handler / the midround ruleset.
List of all family member minds. Used internally; added to internally, and externally by /obj/item/gang_induction_package when used to induct a new family member.
Internal. Checks if our wanted level has changed; calls update_wanted_level. Only updates wanted level post the initial announcement and until the cops show up. After that, it's locked.
Internal. Polls ghosts and sends in a team of space cops according to the wanted level, accompanied by an announcement. Will let the shuttle leave 10 minutes after sending. Freezes the wanted level.
List of all eligible starting family members / undercover cops. Set externally (passed by reference) by gamemode / ruleset; used internally. Note that dynamic uses a list of mobs to handle candidates while game_modes use lists of minds! Don't be fooled!
Keeps track of the amount of deaths since the calling of pre_setup_analogue() if this is a midround handler. Used to prevent a high wanted level due to a large amount of deaths during the shift prior to the activation of this handler / the midround ruleset.
List of all family member minds. Used internally; added to internally, and externally by /obj/item/gang_induction_package when used to induct a new family member.
The current wanted level. Set internally; used internally, and for updating the wanted HUD.
Proc Details
New
+
+
Sets antag_candidates and restricted_jobs.
+
Sets the antag_candidates and restricted_jobs lists to the equivalent
+lists of its instantiating game_mode / dynamic_ruleset datum. As lists
+are passed by reference, the variable set in this datum and the passed list
+list used to set it are literally the same; changes to one affect the other.
+Like all New() procs, called when the datum is first instantiated.
+There's an annoying caveat here, though -- dynamic rulesets don't have
+lists of minds for candidates, they have lists of mobs. Ghost mobs, before
+the round has started. But we still want to preserve the structure of the candidates
+list by not duplicating it and making sure to remove the candidates as we use them.
+So there's a little bit of boilerplate throughout to preserve the sanctity of this reference.
+Arguments:
+
+
given_candidates - The antag_candidates list or equivalent of the datum instantiating this one.
+
revised_restricted - The restricted_jobs list or equivalent of the datum instantiating this one.
+
announce_gang_locations
+
+
Internal. Announces the presence of families to the entire station and sets sent_announcement to true to allow other checks to occur.
check_wanted_level
+
+
Internal. Checks if our wanted level has changed; calls update_wanted_level. Only updates wanted level post the initial announcement and until the cops show up. After that, it's locked.
on_gain_wanted_level
+
+
Internal. Updates the end_time and sends out an announcement if the wanted level has increased. Called by update_wanted_level().
on_lower_wanted_level
+
+
Internal. Updates the end_time and sends out an announcement if the wanted level has decreased. Called by update_wanted_level().
post_setup_analogue
+
+
post_setup() or execute() equivalent.
+
This proc is always called externally, by the instantiating game_mode / dynamic_ruleset.
+This is done during the post_setup() or execute() phase, after the pre_setup() / pre_execute() phase.
+It is intended to take the place of the code that would normally occupy the pre_setup()
+or pre_execute() proc. As such, it ensures that all prospective starting family members /
+undercover cops are eligible, and picks replacements if there were ineligible cops / family members.
+It then assigns gear to the finalized family members and undercover cops, adding them to its lists,
+and sets the families announcement proc (that does the announcing) to trigger in five minutes.
+Additionally, if given the argument TRUE, it will return FALSE if there are no eligible starting family members.
+This is only to be done if the instantiating datum is a dynamic_ruleset, as these require returns
+while a game_mode is not expected to return early during this phase.
+Arguments:
+
+
return_if_no_gangs - Boolean that determines if the proc should return FALSE should it find no eligible family members. Should be used for dynamic only.
+
pre_setup_analogue
+
+
pre_setup() or pre_execute() equivalent.
+
This proc is always called externally, by the instantiating game_mode / dynamic_ruleset.
+This is done during the pre_setup() or pre_execute() phase, after first instantiation
+and the modification of gangs_to_generate, gang_balance_cap, and midround_ruleset.
+It is intended to take the place of the code that would normally occupy the pre_setup()
+or pre_execute() proc, were the code localized to the game_mode or dynamic_ruleset datum respectively
+as opposed to this handler. As such, it picks players to be chosen for starting familiy members
+or undercover cops prior to assignment to jobs. Sets start_time, default end_time,
+and the current value of deaths_during_shift, to ensure the wanted level only cares about
+the deaths since this proc has been called.
+Takes no arguments.
process_analogue
+
+
process() or rule_process() equivalent.
+
This proc is always called externally, by the instantiating game_mode / dynamic_ruleset.
+This is done during the process() or rule_process() phase, after post_setup() or
+execute() and at regular intervals thereafter. process() and rule_process() are optional
+for a game_mode / dynamic_ruleset, but are important for this gamemode. It is of central
+importance to the gamemode's flow, calculating wanted level updates, family point gain,
+and announcing + executing the arrival of the space cops, achieved through calling internal procs.
+Takes no arguments.
send_in_the_fuzz
+
+
Internal. Polls ghosts and sends in a team of space cops according to the wanted level, accompanied by an announcement. Will let the shuttle leave 10 minutes after sending. Freezes the wanted level.
set_round_result_analogue
+
+
set_round_result() or round_result() equivalent.
+
This proc is always called externally, by the instantiating game_mode / dynamic_ruleset.
+This is done by the set_round_result() or round_result() procs, at roundend.
+Sets the ticker subsystem to the correct result based off of the relative populations
+of space cops and family members.
+Takes no arguments.
update_wanted_level
+
+
Internal. Updates the icon states for everyone, and calls procs that send out announcements / change the end_time if the wanted level has changed.
+
+
+
diff --git a/datum/gang_theme.html b/datum/gang_theme.html
new file mode 100644
index 000000000000..6347fe445b4f
--- /dev/null
+++ b/datum/gang_theme.html
@@ -0,0 +1,85 @@
+
+
+
+
+
+
+ /datum/gang_theme - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
If check_vacuum is TRUE, if one of the mixtures is a vacuum, return FALSE until both are or neither are.
+Rechecks the gas_mixture and adjusts the graphic list if needed. ///Two lists can be passed by reference if you need know specifically which graphics were added and removed.
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:
+Plas_PP = get_partial_pressure(gas_mixture.plasma)
+O2_PP = get_partial_pressure(gas_mixture.oxygen)
+getBreathPartialPressure(gas_pp) --> gas_pp/get_moles()breath_pp = pp
+getTrueBreathPressure(pp) --> gas_pp = pp/breath_ppget_moles()
Updates the total_moles count and trims any empty gases. DO NOT USE. USE AIR_UPDATE_VALUES(air)!!!
Proc Details
add
+
+
Simpler version of merge(), adjusts gas amounts directly and doesn't account for temperature or group_multiplier.
adjustGas
+
+
Takes a gas string and the amount of moles to adjust by. Calls updateValues() if update isn't 0.
adjustGasWithTemp
+
+
Same as adjustGas(), but takes a temperature which is mixed in with the gas.
adjustMultipleGases
+
+
Variadic version of adjustGas(). Takes any number of gas and mole pairs and applies them.
adjustMultipleGasesWithTemp
+
+
Variadic version of adjustGasWithTemp(). Takes any number of gas, mole and temperature associations and applies them.
adjustThermalEnergy
+
+
Adds or removes thermal energy. Returns the actual thermal energy change, as in the case of removing energy we can't go below TCMB.
checkTileGraphic
+
+
If check_vacuum is TRUE, if one of the mixtures is a vacuum, return FALSE until both are or neither are.
+Rechecks the gas_mixture and adjusts the graphic list if needed. ///Two lists can be passed by reference if you need know specifically which graphics were added and removed.
compare
+
+
Checks if we are within acceptable range of another gas_mixture to suspend processing or merge.
copy
+
+
Returns a gas_mixture datum with identical contents.
copyFrom
+
+
Copies gas and temperature from another gas_mixture.
divide
+
+
Divide all gas amounts by a factor.
equalize
+
+
Used to equalize the mixture between two zones before sleeping an edge.
getBreathPartialPressure
+
+
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:
+Plas_PP = get_partial_pressure(gas_mixture.plasma)
+O2_PP = get_partial_pressure(gas_mixture.oxygen)
+getBreathPartialPressure(gas_pp) --> gas_pp/get_moles()breath_pp = pp
+getTrueBreathPressure(pp) --> gas_pp = pp/breath_ppget_moles()
+
10/205 = 2.5
+10 = 2.5/520
getByFlag
+
+
Returns the amount of gas that has the given flag, in moles..
getGroupGas
+
+
Returns the volume of a specific gas within the entire zone.
getGroupMoles
+
+
Returns the volume of the entire zone's gas contents.
getHeatCapacity
+
+
Returns the heat capacity of the gas mix based on the specific heat of the gases.
getThermalEnergyChange
+
+
Returns the thermal energy change required to get to a new temperature
getTileOverlay
+
+
Inlined getTileOverlay(g)
+End inline
getTrueBreathPressure
+
+
inverse
get_volume
+
+
LINDA COMPATABILITY PROCS
hasGas
+
+
Returns TRUE if the given gas has a volume equal to or greater than the given amount in one group share of gas.
isEqual
+
+
Compares the contents of two mixtures to see if they are identical.
merge
+
+
Merges all the gas from another mixture into this one. Respects group_multipliers and adjusts temperature correctly. Does not modify giver in any way.
multiply
+
+
Multiply all gas amounts by a factor.
remove
+
+
Removes moles from the gas mixture and returns a gas_mixture containing the removed air.
removeByFlag
+
+
Removes moles from the gas mixture, limited by a given flag. Returns a gax_mixture containing the removed air.
removeRatio
+
+
Removes a ratio of gas from the mixture and returns a gas_mixture containing the removed air.
removeVolume
+
+
Removes a volume of gas from the mixture and returns a gas_mixture containing the removed air with the given volume.
returnPressure
+
+
Returns the pressure of the gas mix. Only accurate if there have been no gas modifications since updateValues() has been called.
setGasMoles
+
+
Sets the given gas id's mole count to the specified amount.
shareRatio
+
+
Shares gas with another gas_mixture based on the amount of connecting tiles and a fixed lookup table.
shareSpace
+
+
A wrapper around share_ratio for spacing gas at the same rate as if it were going into a large airless room.
specificGroupEntropy
+
+
Returns the ideal gas specific entropy of the whole mix. This is the entropy per mole of /mixed/ gas.
subtract
+
+
Simpler version of remove(), adjusts gas amounts directly and doesn't account for group_multiplier.
updateValues
+
+
Updates the total_moles count and trims any empty gases. DO NOT USE. USE AIR_UPDATE_VALUES(air)!!!
Stored in a global datum, and created when it is turned on via event or VV'ing the GLOB.embedpocalypse_controller to be a new /datum/global_funny_embedding.
+Gives every item in the world a prefix to their name, and...
+Makes every item in the world embed when thrown, but also hooks into global signals for new items created to also bless them with embed-ability(??).
Gathers information from the layer about what variables are expected in the json.
+Override and add to the two argument lists if you want extra information in your layer.
+The lists are formatted like keyname:keytype_define.
+The key name is assigned to the var named the same on the layer type.
Handles the processing of the json data and conversion to correct value types.
+Will error on incorrect, missing, or unexpected values.
Proc Details
CrossVerify
+
+
Use this proc for extra verification needed by a particular layer, gets run after all greyscale configs have finished reading their json files.
DiskRefresh
+
+
Override this if you need to do something during a full config refresh from disk, return TRUE if something was changed
Generate
+
+
Used to actualy create the layer using the given colors
+Do not override, use InternalGenerate instead
GetExpectedValues
+
+
Gathers information from the layer about what variables are expected in the json.
+Override and add to the two argument lists if you want extra information in your layer.
+The lists are formatted like keyname:keytype_define.
+The key name is assigned to the var named the same on the layer type.
Initialize
+
+
Override this to do initial set up
InternalGenerate
+
+
Override this to implement layers.
+The colors var will only contain colors that this layer is configured to use.
ReadJsonData
+
+
Handles the processing of the json data and conversion to correct value types.
+Will error on incorrect, missing, or unexpected values.
Gun has a bolt, it stays closed while not cycling. The gun must be racked to have a bullet chambered when a mag is inserted.
+Example: c20, shotguns, m90
The priority of the knowledge. Higher priority knowledge appear higher in the ritual list.
+Number itself is completely arbitrary. Does not need to be set for non-ritual knowledge.
Assoc list of [typepaths we need] to [amount needed].
+If set, this knowledge allows the heretic to do a ritual on a transmutation rune with the components set.
The priority of the knowledge. Higher priority knowledge appear higher in the ritual list.
+Number itself is completely arbitrary. Does not need to be set for non-ritual knowledge.
Assoc list of [typepaths we need] to [amount needed].
+If set, this knowledge allows the heretic to do a ritual on a transmutation rune with the components set.
What path is this on. If set to "null", assumed to be unreachable (or abstract).
Proc Details
can_be_invoked
+
+
Determines if a heretic can actually attempt to invoke the knowledge as a ritual.
+By default, we can only invoke knowledge with rituals associated.
+
Return TRUE to have the ritual show up in the rituals list, FALSE otherwise.
cleanup_atoms
+
+
Called after on_finished_recipe returns TRUE
+and a ritual was successfully completed.
+
Goes through and cleans up (deletes)
+all atoms in the selected_atoms list.
+
Remove atoms from the selected_atoms
+(either in this proc or in on_finished_recipe)
+to NOT have certain atoms deleted on cleanup.
+
Arguments
+
+
selected_atoms - a list of all atoms we intend on destroying.
+
on_finished_recipe
+
+
Called whenever the knowledge's associated ritual is completed successfully.
+
Creates atoms from types in result_atoms.
+Override this is you want something else to happen.
+This CAN sleep, such as for summoning rituals which poll for ghosts.
+
Arguments
+
+
user - the mob who did the ritual
+
selected_atoms - an list of atoms chosen as a part of this ritual.
+
loc - the turf the ritual's occuring on
+
+
Returns: TRUE, if the ritual should cleanup afterwards, or FALSE, to avoid calling cleanup after.
on_gain
+
+
Called when the knowledge is applied to a mob.
+This can be called multiple times per heretic,
+in the case of bodyswap shenanigans.
+
Arguments
+
+
user - the heretic which we're applying things to
+
on_lose
+
+
Called when the knowledge is removed from a mob,
+either due to a heretic being de-heretic'd or bodyswap memery.
+
Arguments
+
+
user - the heretic which we're removing things from
+
on_research
+
+
Called when the knowledge is first researched.
+This is only ever called once per heretic.
+
Arguments
+
+
user - the heretic who researched something
+
recipe_snowflake_check
+
+
Special check for rituals.
+Called before any of the required atoms are checked.
+
If you are adding a more complex summoning,
+or something that requires a special check
+that parses through all the atoms,
+you should override this.
+
Arguments
+
+
user - the mob doing the ritual
+
atoms - a list of all atoms being checked in the ritual.
+
selected_atoms - an empty list(!) instance passed in by the ritual. You can add atoms to it in this proc.
+
loc - the turf the ritual's occuring on
+
+
Returns: TRUE, if the ritual will continue, or FALSE, if the ritual is skipped / cancelled
+
+
+
diff --git a/datum/heretic_knowledge/blade_dance.html b/datum/heretic_knowledge/blade_dance.html
new file mode 100644
index 000000000000..0249c33cec74
--- /dev/null
+++ b/datum/heretic_knowledge/blade_dance.html
@@ -0,0 +1,38 @@
+
+
+
+
+
+
+ /datum/heretic_knowledge/blade_dance - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
"Fuck you" proc that gets called if the chain is interrupted at some points.
+Disembowels the [sac_target] and brutilizes their body. Throws some gibs around for good measure.
This proc is called from [proc/after_target_wakes] after the helgrasp runs out in the [sac_target].
+
It gives them a message letting them know it's getting easier and they're almost free.
after_return_dead_target
+
+
This proc is called from [proc/return_target] if the target dies in the shadow realm.
+
After teleporting the target back to the station (dead),
+it spawns a special red broken illusion on their spot, for style.
after_return_live_target
+
+
This proc is called from [proc/return_target] if the [sac_target] survives the shadow realm.
+
Gives the sacrifice target some after effects upon ariving back to reality.
after_target_sleeps
+
+
This proc is called from [proc/begin_sacrifice] after the [sac_target] falls asleep, shortly after the sacrifice occurs.
+
Teleports the [sac_target] to the heretic room, asleep.
+If it fails to teleport, they will be disemboweled and stop the chain.
+
Arguments
+
+
sac_target - the mob being sacrificed.
+
destination - the spot they're being teleported to.
+
after_target_wakes
+
+
This proc is called from [proc/after_target_sleeps] when the [sac_target] should be waking up.
+
Begins the survival minigame, featuring the sacrifice targets.
+Gives them Helgrasp, throwing cursed hands towards them that they must dodge to survive.
+Also gives them a status effect, Unholy Determination, to help them in this endeavor.
+
Then applies some miscellaneous effects.
begin_sacrifice
+
+
This proc is called from [proc/sacrifice_process] after the heretic successfully sacrifices [sac_target].
+
Sets off a chain that sends the person sacrificed to the shadow realm to dodge hands to fight for survival.
+
Arguments
+
+
sac_target - the mob being sacrificed.
+
disembowel_target
+
+
"Fuck you" proc that gets called if the chain is interrupted at some points.
+Disembowels the [sac_target] and brutilizes their body. Throws some gibs around for good measure.
generate_heretic_z_level
+
+
Generate the sacrifice z-level.
obtain_targets
+
+
Obtain a list of targets for the user to hunt down and sacrifice.
+Tries to get four targets (minds) with living human currents.
+
Returns FALSE if no targets are found, TRUE if the targets list was populated.
on_target_death
+
+
If they die in the shadow realm, they lost. Send them back.
on_target_escape
+
+
If they somehow cheese the shadow realm by teleporting out, they are disemboweled and killed.
return_target
+
+
This proc is called from [proc/begin_sacrifice] if the target survived the shadow realm, or COMSIG_LIVING_DEATH if they don't.
+
Teleports [sac_target] back to a random safe turf on the station (or observer spawn if it fails to find a safe turf).
+Also clears their status effects, unregisters any signals associated with the shadow realm, and sends a message
+to the heretic who did the sacrificed about whether they survived, and where they ended up.
+
Arguments
+
+
sac_target - the mob being sacrificed
+
heretic - the heretic who originally did the sacrifice.
+
sacrifice_process
+
+
Begin the process of sacrificing the target.
+
Arguments
+
+
user - the mob doing the sacrifice (a heretic)
+
selected_atoms - a list of all atoms chosen. Should be (at least) one human.
+
loc - the turf the sacrifice is occuring on
+
+
+
+
diff --git a/datum/heretic_knowledge/knowledge_ritual.html b/datum/heretic_knowledge/knowledge_ritual.html
new file mode 100644
index 000000000000..62e8b8d48d67
--- /dev/null
+++ b/datum/heretic_knowledge/knowledge_ritual.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /datum/heretic_knowledge/knowledge_ritual - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Creates the mark status effect on our target.
+This proc handles the instatiate and the application of the station effect,
+and returns the /datum/status_effect instance that was made.
The status effect typepath we apply on people on mansus grasp.
Proc Details
create_mark
+
+
Creates the mark status effect on our target.
+This proc handles the instatiate and the application of the station effect,
+and returns the /datum/status_effect instance that was made.
+
Can be overriden to set or pass in additional vars of the status effect.
The highlander controller handles the admin highlander mode, if enabled.
+It is first created when "there can only be one" triggers it, and it can be referenced from GLOB.highlander_controller
Triggers at beginning of the game when there is a confirmed list of valid, ready players.
+Creates a 100% ready game that has NOT started (no players in bodies)
+Followed by start game
Proc Details
new_highlander
+
+
Triggers at beginning of the game when there is a confirmed list of valid, ready players.
+Creates a 100% ready game that has NOT started (no players in bodies)
+Followed by start game
+
Does the following:
+
+
Picks map, and loads it
+
Grabs landmarks if it is the first time it's loading
+
Sets up the role list
+
Puts players in each role randomly
+Arguments:
+
setup_list: list of all the datum setups (fancy list of roles) that would work for the game
+
ready_players: list of filtered, sane players (so not playing or disconnected) for the game to put into roles
+
+
+
+
diff --git a/datum/holiday.html b/datum/holiday.html
new file mode 100644
index 000000000000..ae5590b3538b
--- /dev/null
+++ b/datum/holiday.html
@@ -0,0 +1,106 @@
+
+
+
+
+
+
+ /datum/holiday - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
The color to use for the screentips.
+This is updated by the preference for cheaper reads than would be
+had with a proc call, especially on one of the hottest procs in the
+game (MouseEntered).
Whether or not screentips are enabled.
+This is updated by the preference for cheaper reads than would be
+had with a proc call, especially on one of the hottest procs in the
+game (MouseEntered).
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.
The color to use for the screentips.
+This is updated by the preference for cheaper reads than would be
+had with a proc call, especially on one of the hottest procs in the
+game (MouseEntered).
Whether or not screentips are enabled.
+This is updated by the preference for cheaper reads than would be
+had with a proc call, especially on one of the hottest procs in the
+game (MouseEntered).
Proc Details
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.
+
It returns a list, which is pretty much just a struct of info
hide_action
+
+
Removes the passed in action from its current position on the screen
hide_landings
+
+
Clears all currently visible landings
view_audit_buttons
+
+
Ensures all of our buttons are properly within the bounds of our client's view, moves them if they're not
Accesses that this trim unlocks on a card that require wildcard slots to apply. If a card cannot accept all a trim's wildcard accesses, the card is incompatible with the trim.
Accesses that this trim unlocks on a card that require wildcard slots to apply. If a card cannot accept all a trim's wildcard accesses, the card is incompatible with the trim.
This file contains all the trims associated with station jobs.
+It also contains special prisoner trims and the miner's spare ID trim.
+ID Trims for station jobs.
What config entry relates to this job. Should be a lowercase job name with underscores for spaces, eg "prisoner" "research_director" "head_of_security"
An ID card with an access in this list can apply this trim to IDs or use it as a job template when adding access to a card. If the list is null, cannot be used as a template. Should be Head of Staff or ID Console accesses or it may do nothing.
What config entry relates to this job. Should be a lowercase job name with underscores for spaces, eg "prisoner" "research_director" "head_of_security"
An ID card with an access in this list can apply this trim to IDs or use it as a job template when adding access to a card. If the list is null, cannot be used as a template. Should be Head of Staff or ID Console accesses or it may do nothing.
Proc Details
refresh_trim_access
+
+
Goes through various non-map config settings and modifies the trim's access based on this.
+
Returns TRUE if the config is loaded, FALSE otherwise.
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.
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
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)
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.
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
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)
Proc Details
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.
Represents a new-player interview form, enabled by configuration to require
+players with low playtime to request access to the server. To do so, they will
+out a brief questionnaire, and are otherwise unable to do anything while they
+wait for a response.
Used in the new client pipeline to catch when clients are reconnecting and need to have their
+reference re-assigned to the 'owner' variable of an interview
Used in the destroy client pipeline to catch when clients are disconnecting and need to have their
+reference nulled on the 'owner' variable of an interview
Attempts to return an interview for a given client, using an existing interview if found, otherwise
+a new interview is created; if the user is on cooldown then it will return null.
The interviews that are currently "open", those that are not submitted as well as those that are waiting review
Proc Details
client_login
+
+
Used in the new client pipeline to catch when clients are reconnecting and need to have their
+reference re-assigned to the 'owner' variable of an interview
+
Arguments:
+
+
C - The client who is logging in
+
client_logout
+
+
Used in the destroy client pipeline to catch when clients are disconnecting and need to have their
+reference nulled on the 'owner' variable of an interview
+
Arguments:
+
+
C - The client who is logging out
+
close_interview
+
+
Closes an interview, removing it from the queued interviews as well as adding it to the closed
+interviews list.
+
Arguments:
+
+
to_close - The interview to dequeue
+
dequeue
+
+
Dequeues the first interview from the interview queue, and updates the queue positions of any relevant
+interviews that follow it.
dequeue_specific
+
+
Dequeues an interview from the interview queue if present, and updates the queue positions of
+any relevant interviews that follow it.
+
Arguments:
+
+
to_dequeue - The interview to dequeue
+
enqueue
+
+
Enqueues an interview in the interview queue, and notifies admins of the new interview to be
+reviewed.
+
Arguments:
+
+
to_queue - The interview to enqueue
+
interview_by_id
+
+
Attempts to return an interview for a provided ID, will return null if no matching interview is found
+
Arguments:
+
+
id - The ID of the interview to find
+
interview_for_client
+
+
Attempts to return an interview for a given client, using an existing interview if found, otherwise
+a new interview is created; if the user is on cooldown then it will return null.
+
Arguments:
+
+
C - The client to get the interview for
+
release_from_cooldown
+
+
Removes a ckey from the cooldown list, used for enforcing cooldown after an interview is denied.
datum/job/bureaucrat,
+This is the file you should use to add alternate titles for each job, just
+follow the way they're done here, it's easy enough and shouldn't take any
+time at all to add more or add some for a job that doesn't have any.
A list of slots that can't have loadout items assigned to them if no_dresscode is applied, used for important items such as ID, PDA, backpack and headset
Lazy list with the departments this job belongs to.
+Required to be set for playable jobs.
+The first department will be used in the preferences menu,
+unless department_for_prefs is set.
Minutes of experience-time required to play in this job. The type is determined by [exp_required_type] and [exp_required_type_department] depending on configs.
If you have the use_age_restriction_for_jobs config option enabled and the database set up, this option will add a requirement for players to be at least minimal_player_age days old. (meaning they first signed in at least that many days before.)
Innate skill levels unlocked at roundstart. Based on config.jobs_have_minimal_access config setting, for example with a full crew. Format is list(/datum/skill/foo = SKILL_EXP_NOVICE) with exp as an integer or as per code/_DEFINES/skills.dm
Innate skill levels unlocked at roundstart. Based on config.jobs_have_minimal_access config setting, for example with a skeleton crew. Format is list(/datum/skill/foo = SKILL_EXP_NOVICE) with exp as an integer or as per code/_DEFINES/skills.dm
A list of slots that can't have loadout items assigned to them if no_dresscode is applied, used for important items such as ID, PDA, backpack and headset
Lazy list with the departments this job belongs to.
+Required to be set for playable jobs.
+The first department will be used in the preferences menu,
+unless department_for_prefs is set.
Minutes of experience-time required to play in this job. The type is determined by [exp_required_type] and [exp_required_type_department] depending on configs.
If you have the use_age_restriction_for_jobs config option enabled and the database set up, this option will add a requirement for players to be at least minimal_player_age days old. (meaning they first signed in at least that many days before.)
Innate skill levels unlocked at roundstart. Based on config.jobs_have_minimal_access config setting, for example with a full crew. Format is list(/datum/skill/foo = SKILL_EXP_NOVICE) with exp as an integer or as per code/_DEFINES/skills.dm
Innate skill levels unlocked at roundstart. Based on config.jobs_have_minimal_access config setting, for example with a skeleton crew. Format is list(/datum/skill/foo = SKILL_EXP_NOVICE) with exp as an integer or as per code/_DEFINES/skills.dm
For late joiners, we're forced to put them in an alone department at some point.
+
This is because reusing the round-start algorithm would force existing officers into
+a different department in order to preserve having partners at all times.
+
This would mean retroactively updating their access as well, which is too much
+of a headache for me to want to bother.
+
So, here's the method. If any department currently has 1 officer, they are forced into
+that.
+
Otherwise, the department with the least officers in it is chosen.
+Preference takes priority, meaning that if both medical and engineering have zero officers,
+and the preference is medical, then medical is what will be chosen.
+
Just like get_officer_departments, this function is deterministic.
+Randomness should instead be handled in the shuffling of the departments argument.
How many steps it's taken to get here from the start (currently pulling double duty as steps taken & cost to get here, since all moves incl diagonals cost 1 rn)
How many steps it's taken to get here from the start (currently pulling double duty as steps taken & cost to get here, since all moves incl diagonals cost 1 rn)
Copies all languages from the supplied atom/language holder. Source should be overridden when you
+do not want the language overwritten by later atom updates or want to avoid blocked languages.
Initializes, and copies in the languages from the current atom if available.
add_blocked_language
+
+
Adds a single language or list of languages to the blocked language list.
can_speak_language
+
+
Checks if you can speak the language. Tongue limitations should be supplied as an argument.
copy_languages
+
+
Copies all languages from the supplied atom/language holder. Source should be overridden when you
+do not want the language overwritten by later atom updates or want to avoid blocked languages.
get_atom
+
+
Gets the atom, since we some times need to check if the tongue has limitations.
get_random_spoken_language
+
+
Gets a random spoken language, useful for forced speech and such.
get_random_understood_language
+
+
Gets a random understood language, useful for hallucinations and such.
get_selected_language
+
+
Returns selected language if it can be spoken, or decides, sets and returns a new selected language if possible.
grant_all_languages
+
+
Grants every language to understood and spoken, and gives omnitongue.
grant_language
+
+
Grants the supplied language.
has_language
+
+
Checks if you have the language. If spoken is true, only checks if you can speak the language.
open_language_menu
+
+
Opens a language menu reading from the language holder.
remove_all_languages
+
+
Removes every language and optionally sets omnitongue false. If a non default source is supplied, only removes that source.
remove_blocked_language
+
+
Removes a single language or list of languages from the blocked language list.
remove_language
+
+
Removes a single language or source, removing all sources returns the pre-removal state of the language.
update_atom_languages
+
+
Empties out the atom specific languages and updates them according to the supplied atoms language holder.
coordinate and control movement across linked industrial_lift's. allows moving large single multitile platforms and many 1 tile platforms.
+also is capable of linking platforms across linked z levels
taken from our lift platforms. if true we go through each z level of platforms and attempt to make the lowest left corner platform
+into one giant multitile object the size of all other platforms on that z level.
the lift platforms we consider as part of this lift. ordered in order of lowest z level to highest z level after init.
+(the sorting algorithm sucks btw)
overridable ID string to link control units to this specific lift_master datum. created by placing a lift id landmark object
+somewhere on the tram, if its anywhere on the tram we'll find it in init and set this to whatever it specifies
Moves the lift UP or DOWN, this is what users invoke with their hand.
+This is a SAFE proc, ensuring every part of the lift moves SANELY.
+It also locks controls for the (miniscule) duration of the movement, so the elevator cannot be broken by spamming.
+Arguments:
+going - UP or DOWN directions, where the lift should go. Keep in mind by this point checks of whether it should go up or down have already been done.
+user - Whomever made the lift movement.
Moves the lift, this is what users invoke with their hand.
+This is a SAFE proc, ensuring every part of the lift moves SANELY.
+It also locks controls for the (miniscule) duration of the movement, so the elevator cannot be broken by spamming.
resets the contents of all platforms to their original state in case someone put a bunch of shit onto the tram.
+intended to be called by admins. passes all arguments to reset_contents() for each of our platforms.
taken from our lift platforms. if true we go through each z level of platforms and attempt to make the lowest left corner platform
+into one giant multitile object the size of all other platforms on that z level.
the lift platforms we consider as part of this lift. ordered in order of lowest z level to highest z level after init.
+(the sorting algorithm sucks btw)
overridable ID string to link control units to this specific lift_master datum. created by placing a lift id landmark object
+somewhere on the tram, if its anywhere on the tram we'll find it in init and set this to whatever it specifies
lift platforms have already been sorted in order of z level.
Proc Details
Check_lift_move
+
+
Check destination turfs
MoveLift
+
+
Moves the lift UP or DOWN, this is what users invoke with their hand.
+This is a SAFE proc, ensuring every part of the lift moves SANELY.
+It also locks controls for the (miniscule) duration of the movement, so the elevator cannot be broken by spamming.
+Arguments:
+going - UP or DOWN directions, where the lift should go. Keep in mind by this point checks of whether it should go up or down have already been done.
+user - Whomever made the lift movement.
MoveLiftHorizontal
+
+
Moves the lift, this is what users invoke with their hand.
+This is a SAFE proc, ensuring every part of the lift moves SANELY.
+It also locks controls for the (miniscule) duration of the movement, so the elevator cannot be broken by spamming.
Rebuild_lift_plaform
+
+
Collect all bordered platforms via a simple floodfill algorithm. allows multiz trams because its funny
check_for_landmarks
+
+
check for any landmarks placed inside the locs of the given lift_platform
create_multitile_platform_for_z_level
+
+
goes through all platforms in the given list and finds the one in the lower left corner
get_platforms_on_level
+
+
returns all industrial_lifts associated with this tram on the given z level or given atoms z level
order_platforms_by_z_level
+
+
orders the lift platforms in order of lowest z level to highest z level.
reset_lift_contents
+
+
resets the contents of all platforms to their original state in case someone put a bunch of shit onto the tram.
+intended to be called by admins. passes all arguments to reset_contents() for each of our platforms.
+
Arguments:
+
+
consider_anything_past - number. if > 0 our platforms will only handle foreign contents that exceed this number in each of their locs
+
foreign_objects - bool. if true our platforms will consider /atom/movable's that arent mobs as part of foreign contents
+
foreign_non_player_mobs - bool. if true our platforms consider mobs that dont have a mind to be foreign
+
consider_player_mobs - bool. if true our platforms consider player mobs to be foreign. only works if foreign_non_player_mobs is true as well
+
return_closest_platform_to
+
+
returns the closest lift to the specified atom, prioritizing lifts on the same z level. used for comparing distance
set_controls
+
+
Sets all lift parts's controls_locked variable. Used to prevent moving mid movement, or cooldowns.
set_info_from_id_landmark
+
+
set vars and such given an overriding lift_id landmark
reference to the destination landmark we consider ourselves "at". since we potentially span multiple z levels we dont actually
+know where on us this platform is. as long as we know THAT its on us we can just move the distance and direction between this
+and the destination landmark.
decisecond delay between horizontal movement. cannot make the tram move faster than 1 movement per world.tick_lag.
+this var is poorly named its actually horizontal movement delay but whatever.
Signal for when the tram runs into a field of which it cannot go through.
+Stops the train's travel fully, sends a message, and destroys the train.
+Arguments:
+bumped_atom - The atom this tram bumped into
reference to the destination landmark we consider ourselves "at". since we potentially span multiple z levels we dont actually
+know where on us this platform is. as long as we know THAT its on us we can just move the distance and direction between this
+and the destination landmark.
decisecond delay between horizontal movement. cannot make the tram move faster than 1 movement per world.tick_lag.
+this var is poorly named its actually horizontal movement delay but whatever.
whether this tram is traveling across vertical and/or horizontal axis for some distance. not all lifts use this
Proc Details
gracefully_break
+
+
Signal for when the tram runs into a field of which it cannot go through.
+Stops the train's travel fully, sends a message, and destroys the train.
+Arguments:
+bumped_atom - The atom this tram bumped into
tram_travel
+
+
Handles moving the tram
+
Tells the individual tram parts where to actually go and has an extra safety check
+incase multiple inputs get through, preventing conflicting directions and the tram
+literally ripping itself apart. all of the actual movement is handled by SStramprocess
unlock_controls
+
+
Handles unlocking the tram controls for use after moving
+
More safety checks to make sure the tram has actually docked properly
+at a location before users are allowed to interact with the tram console again.
+Tram finds its location at this point before fully unlocking controls to the user.
(list or soundfile) Since this can be either a list or a single soundfile you can have random sounds. May contain further lists but must contain a soundfile at the end.
(list or soundfile) Since this can be either a list or a single soundfile you can have random sounds. May contain further lists but must contain a soundfile at the end.
used for debugging in testing (doesn't put people out of the game, some other shit i forgot, who knows just don't set this in live) honestly kinda deprecated
and these (judgement_innocent_votes, judgement_abstain_votes and judgement_guilty_votes) are the judgement phase votes, aka people sorting themselves into guilty and innocent, and "eh, i don't really care" lists. whichever has more inno or guilty wins!
Helper proc that adds a random role of a type to a setup. if it doesn't exist in the setup, it adds the path to the list and otherwise bumps the path in the list up one. unique roles can only get added once.
PHASE ONE: TALLY UP ALL NUMBERS OF PEOPLE STILL ALIVE
+PHASE TWO: SEND STATS TO SOLO ANTAGS, SEE IF THEY WON OR TEAMS CANNOT WIN
+Lets the game award roles with all their checks and sanity, prevents achievements given out for debug games
Called when the game is setting up, AFTER map is loaded but BEFORE the phase timers start. Creates and places each role's body and gives the correct player key
Triggers at beginning of the game when there is a confirmed list of valid, ready players.
+Creates a 100% ready game that has NOT started (no players in bodies)
+Followed by start game
The actual start of night for players. Mostly info is given at the start of the night as the end of the night is when votes and actions are submitted and tried.
The end of the game is in two procs, because we want a bit of time for players to see eachothers roles.
+Because of how check_victory works, the game is halted in other places by this point.
used for debugging in testing (doesn't put people out of the game, some other shit i forgot, who knows just don't set this in live) honestly kinda deprecated
and these (judgement_innocent_votes, judgement_abstain_votes and judgement_guilty_votes) are the judgement phase votes, aka people sorting themselves into guilty and innocent, and "eh, i don't really care" lists. whichever has more inno or guilty wins!
Helper proc that adds a random role of a type to a setup. if it doesn't exist in the setup, it adds the path to the list and otherwise bumps the path in the list up one. unique roles can only get added once.
award_role
+
+
PHASE ONE: TALLY UP ALL NUMBERS OF PEOPLE STILL ALIVE
+PHASE TWO: SEND STATS TO SOLO ANTAGS, SEE IF THEY WON OR TEAMS CANNOT WIN
+Lets the game award roles with all their checks and sanity, prevents achievements given out for debug games
+
Arguments:
+
+
award: path of the award
+
role: mafia_role datum to reward.
+
basic_setup
+
+
Called when enough players have signed up to fill a setup. DOESN'T NECESSARILY MEAN THE GAME WILL START.
+
Checks for a custom setup, if so gets the required players from that and if not it sets the player requirement to MAFIA_MAX_PLAYER_COUNT and generates one IF basic setup starts a game.
+Checks if everyone signed up is an observer, and is still connected. If people aren't, they're removed from the list.
+If there aren't enough players post sanity, it aborts. otherwise, it selects enough people for the game and starts preparing the game for real.
check_signups
+
+
Filters inactive player into a different list until they reconnect, and removes players who are no longer ghosts.
+
If a disconnected player gets a non-ghost mob and reconnects, they will be first put back into mafia_signup then filtered by that.
check_trial
+
+
Players have voted someone up, and now the person must defend themselves while the town votes innocent or guilty.
+
What players do in this phase:
+
+
Vote innocent or guilty, if they are not on trial.
+
Defend themselves and wait for judgement, if they are.
+
Leads to the lynch phase.
+Arguments:
+
verbose: boolean, announces whether there were votes or not. after judgement it goes back here with no voting period to end the day.
+
check_victory
+
+
Checks to see if a faction (or solo antagonist) has won.
+
Calculates in this order:
+
+
counts up town, mafia, and solo
+
solos can count as town members for the purposes of mafia winning
+
sends the amount of living people to the solo antagonists, and see if they won OR block the victory of the teams
+
checks if solos won from above, then if town, then if mafia
+
starts the end of the game if a faction won
+
returns TRUE if someone won the game, halting other procs from continuing in the case of a victory
+
create_bodies
+
+
Called when the game is setting up, AFTER map is loaded but BEFORE the phase timers start. Creates and places each role's body and gives the correct player key
+
Notably:
+
+
Toggles godmode so the mafia players cannot kill themselves
+
Adds signals for voting overlays, see display_votes proc
+
gives mafia panel
+
sends the greeting text (goals, role name, etc)
+
display_votes
+
+
Adds mutable appearances to people who get publicly voted on (so not night votes) showing how many people are picking them
+Arguments:
+
+
source: the body of the role getting the overlays
+
overlay_list: signal var passing the overlay list of the mob
+
end_game
+
+
Cleans up the game, resetting variables back to the beginning and removing the map with the generator.
generate_random_setup
+
+
Returns a semirandom setup with 12 roles. balance not guaranteed!
+
please check the variables at the top of the proc to see how much of each role types it picks
get_random_voter
+
+
Returns a random person who voted for whatever vote (day vote, night kill vote)
+Arguments:
+
+
vote_type: vote type (getting a random day voter, or mafia night voter)
+
get_vote_count
+
+
Returns how many people voted for the role, in whatever vote (day vote, night kill vote)
+Arguments:
+
+
role: the mafia role the proc tries to get the amount of votes for
+
vote_type: the vote type (getting how many day votes were for the role, or mafia night votes for the role)
+
get_vote_winner
+
+
Returns whichever role got the most votes, in whatever vote (day vote, night kill vote)
+returns null if no votes
+Arguments:
+
+
vote_type: the vote type (getting the role that got the most day votes, or the role that got the most mafia votes)
+
lockdown
+
+
After the voting and judgement phases, the game goes to night shutting the windows and beginning night with a proc.
lynch
+
+
Players have voted innocent or guilty on the person on trial, and that person is now killed or returned home.
+
What players do in this phase:
+
+
r/watchpeopledie
+
If the accused is killed, their true role is revealed to the rest of the players.
+
prepare_game
+
+
Triggers at beginning of the game when there is a confirmed list of valid, ready players.
+Creates a 100% ready game that has NOT started (no players in bodies)
+Followed by start game
+
Does the following:
+
+
Picks map, and loads it
+
Grabs landmarks if it is the first time it's loading
+
Sets up the role list
+
Puts players in each role randomly
+Arguments:
+
setup_list: list of all the datum setups (fancy list of roles) that would work for the game
+
ready_players: list of filtered, sane players (so not playing or disconnected) for the game to put into roles
+
reset_votes
+
+
Clears out the votes of a certain type (day votes, mafia kill votes) while leaving others untouched
resolve_night
+
+
The end of the night, and a series of signals for the order of events on a night.
+
Order of events, and what they mean:
+
+
Start of resolve (NIGHT_START) is for activating night abilities that MUST go first
+
Action phase (NIGHT_ACTION_PHASE) is for non-lethal day abilities
+
Mafia then tallies votes and kills the highest voted person (note: one random voter visits that person for the purposes of roleblocking)
+
Killing phase (NIGHT_KILL_PHASE) is for lethal night abilities
+
End of resolve (NIGHT_END) is for cleaning up abilities that went off and i guess doing some that must go last
+
Finally opens the curtains and calls the start of day phase, completing the cycle until check victory returns TRUE
+
send_home
+
+
Teenie helper proc to move players back to their home.
+Used in the above, but also used in the debug button "send all players home"
+Arguments:
+
+
role: mafia role that is getting sent back to the game.
+
start_day
+
+
How every day starts.
+
What players do in this phase:
+
+
If day one, just a small starting period to see who is in the game and check role, leading to the night phase.
+
Otherwise, it's a longer period used to discuss events that happened during the night, leading to the voting phase.
+
start_game
+
+
The game by this point is now all set up, and so we can put people in their bodies and start the first phase.
+
Does the following:
+
+
Creates bodies for all of the roles with the first proc
+
Starts the first day manually (so no timer) with the second proc
+
start_night
+
+
The actual start of night for players. Mostly info is given at the start of the night as the end of the night is when votes and actions are submitted and tried.
+
What players do in this phase:
+
+
Mafia are told to begin voting on who to kill
+
Powers that are picked during the day announce themselves right now
+
start_the_end
+
+
The end of the game is in two procs, because we want a bit of time for players to see eachothers roles.
+Because of how check_victory works, the game is halted in other places by this point.
+
What players do in this phase:
+
+
See everyone's role postgame
+
See who won the game
+Arguments:
+
message: string, if non-null it sends it to all players. used to announce team victories while solos are handled in check victory
+
start_voting_phase
+
+
Players have finished the discussion period, and now must put up someone to the chopping block.
+
What players do in this phase:
+
+
Vote on which player to put up for lynching, leading to the judgement phase.
+
If no votes are case, the judgement phase is skipped, leading to the night phase.
+
toggle_night_curtains
+
+
Shuts poddoors attached to mafia.
+Arguments:
+
+
close: boolean, the state you want the curtains in.
+
try_autostart
+
+
Called when someone signs up, and sees if there are enough people in the signup list to begin.
+
Only checks if everyone is actually valid to start (still connected and an observer) if there are enough players (basic_setup)
vote_for
+
+
Proc that goes off when players vote for something with their mafia panel.
+
If teams, it hides the tally overlay and only sends the vote messages to the team that is voting
+Arguments:
+
+
voter: the mafia role that is trying to vote for...
+
target: the mafia role that is getting voted for
+
vote_type: type of vote submitted (is this the day vote? is this the mafia night vote?)
+
teams: see mafia team defines for what to put in, makes the messages only send to a specific team (so mafia night votes only sending messages to mafia at night)
This type is responsible for any map generation behavior that is done in areas, override this to allow for area-specific map generation. This generation is ran by areas in initialize.
Takes in a type path, locates an instance of that type in the cached map, and calculates its offset from the origin of the map, returns this offset in the form list(x, y).
if true, turfs loaded from this template are placed on top of the turfs already there, defaults to TRUE
Proc Details
discover_offset
+
+
Takes in a type path, locates an instance of that type in the cached map, and calculates its offset from the origin of the map, returns this offset in the form list(x, y).
How much does this shuttle cost the cargo budget to purchase? Put in terms of CARGO_CRATE_VALUE to properly scale the cost with the current balance of cargo's income.
How much does this shuttle cost the cargo budget to purchase? Put in terms of CARGO_CRATE_VALUE to properly scale the cost with the current balance of cargo's income.
Item categories available from this market, only items which are in these categories can be gotten from this market. Automatically assigned, so don't manually adjust.
Item categories available from this market, only items which are in these categories can be gotten from this market. Automatically assigned, so don't manually adjust.
this var is so that the strong punch is always aiming for the body part the user is targeting and not trying to apply to the chest before deviating
+Crashing Wave Kick: Punch Shove combo, throws people seven tiles backwards
Gnashing Teeth: Harm Harm, consistent 20 force punch on every second harm punch
Proc Details
dropKick
+
+
Keelhaul: Harm Grab combo, knocks people down, deals stamina damage while they're on the floor
launchKick
+
+
this var is so that the strong punch is always aiming for the body part the user is targeting and not trying to apply to the chest before deviating
+Crashing Wave Kick: Punch Shove combo, throws people seven tiles backwards
strongPunch
+
+
Gnashing Teeth: Harm Harm, consistent 20 force punch on every second harm punch
little tidbits of past events generated by the player doing things. can be used in engravings, dreams, and changeling succs.
+all of those things are supposed to be taken vaguely (engravings crossround and should not include names, dreams and succs are memory goop)
+and as such the generated text of the memory is vague. also, no references held so hard delling isn't an issue, thank god
extra information used in the memories to more accurately describe what happened. Assoc list of key -> string identifying what kind of info it is, value is a string identifying the detail.
The action-specific reactions with mood intercepted into it e.g. "the clown looks (story_mood_here) at the situation"
+Moods the mob can express e.g. "chuckles" "looks disinterested"
extra information used in the memories to more accurately describe what happened. Assoc list of key -> string identifying what kind of info it is, value is a string identifying the detail.
the value of the mood in it's worth as a story, defines how beautiful art from it can be and whether or not it stays in persistence.
Proc Details
generate_memory_name
+
+
The action-specific reactions with mood intercepted into it e.g. "the clown looks (story_mood_here) at the situation"
+Moods the mob can express e.g. "chuckles" "looks disinterested"
+
+
+
diff --git a/datum/merger.html b/datum/merger.html
new file mode 100644
index 000000000000..8ce7d975178b
--- /dev/null
+++ b/datum/merger.html
@@ -0,0 +1,71 @@
+
+
+
+
+
+
+ /datum/merger - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Skill multiplier, adjusts how much xp you get/loose from adjust_xp. Dont override it directly, add your reason to experience_multiplier_reasons and use that as a key to put your value in there.
List of skills the user has received a reward for. Should not be used to keep track of currently known skills. Lazy list because it shouldnt be filled often
Checks to see if the mind has an accessible uplink (their own, if they are a traitor; any unlocked uplink otherwise),
+and gives them a fallback spell if no uplink was found
Skill multiplier, adjusts how much xp you get/loose from adjust_xp. Dont override it directly, add your reason to experience_multiplier_reasons and use that as a key to put your value in there.
List of skills the user has received a reward for. Should not be used to keep track of currently known skills. Lazy list because it shouldnt be filled often
A lazy list of statuses to add next to this mind in the traitor panel
Proc Details
add_addiction_points
+
+
Adds addiction points to the specified addiction
add_memory
+
+
add_memory
+
Adds a memory to a mob's mind if conditions are met, called wherever the memory takes place (memory for catching on fire in mob's fire code, for example)
+Argument:
+
+
memory_type: defined string in memory_defines.dm, shows the memories.json file which story parts to use (and generally what type it is)
+
extra_info: the contents of the story. You're gonna want at least the protagonist for who is the main character in the story (Any non basic type will be converted to a string on insertion)
+
story_value: the quality of the memory, make easy or roundstart memories have a low value so they don't flood persistence
+
memory_flags: special specifications for skipping parts of the memory like moods for stories where showing moods doesn't make sense
+Returns the datum memory created, null otherwise.
+
adjust_experience
+
+
Adjust experience of a specific skill
announce_objectives
+
+
Prints the objectives to the mind's owner. If loudly is true, instead open a window.
build_story_detail
+
+
returns the story name of anything
build_story_mob
+
+
returns the story name of a mob
exp_needed_to_level_up
+
+
Return the amount of EXP needed to go to the next level. Returns 0 if max level
get_hijack_speed
+
+
Sets our can_hijack to the fastest speed our antag datums allow.
get_skill_exp
+
+
Gets the player's current exp from the relevant skill
get_skill_level
+
+
Gets the player's current level number from the relevant skill
get_skill_modifier
+
+
Gets the skill's singleton and returns the result of its get_skill_modifier
give_uplink
+
+ give_uplink
+
A mind proc for giving anyone an uplink.
+arguments:
+
+
silent: if this should send a message to the mind getting the uplink. traitors do not use this silence, but the silence var on their antag datum.
+
antag_datum: the antag datum of the uplink owner, for storing it in antag memory. optional!
+
remove_addiction_points
+
+
Adds addiction points to the specified addiction
remove_antags_for_borging
+
+
Remove the antagonists that should not persist when being borged
select_memory
+
+
sane proc for giving a mob with a mind the option to select one of their memories, returns the memory selected (null otherwise)
set_assigned_role
+
+
Setter for the assigned_role job datum.
set_experience
+
+
Set experience of a specific skill to a number
set_level
+
+
Set level of a specific skill
try_give_equipment_fallback
+
+
Checks to see if the mind has an accessible uplink (their own, if they are a traitor; any unlocked uplink otherwise),
+and gives them a fallback spell if no uplink was found
update_skill_level
+
+
Check what the current skill level is based on that skill's exp
Called during SSmapping.generate_asteroid(). Here is where you mangle the geometry provided by the asteroid generator function.
+Atoms at this stage are NOT initialized
Called during SSmapping.generate_asteroid() after all atoms have been initialized.
Generate
+
+
The proc to call to completely generate an asteroid
Populate
+
+
Called during SSmapping.generate_asteroid(). Here is where you mangle the geometry provided by the asteroid generator function.
+Atoms at this stage are NOT initialized
get_description
+
+
Called by an asteroid magnet to return a description as a list of bullets
randomize
+
+
Randomize the data of this template. Does not change size, center, or location.
An extra reference we pass around
+It is on occasion useful to have a reference to some datum without storing it on the moving object
+Mostly comes up in high performance senarios where we care about things being singletons
+This feels horrible, but constantly making components seems worse
An extra reference we pass around
+It is on occasion useful to have a reference to some datum without storing it on the moving object
+Mostly comes up in high performance senarios where we care about things being singletons
+This feels horrible, but constantly making components seems worse
Recalculates the slope between our object and the target, sets our rates to it
+
The math below is reminiscent of something like y = mx + b
+Except we don't need to care about axis, since we do all our movement in steps of 1
+Because of that all that matters is we only move one tile at a time
+So we take the smaller delta, divide it by the larger one, and get smaller step per large step
+Then we set the large step to 1, and we're done. This way we're guaranteed to never move more then a tile at once
+And we can have nice lines
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
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
Flags passed from the move loop before it calls move() and unset right after.
+Allows for properties of a move loop to be easily checked by mechanics outside of it.
+Having this a bitfield rather than a type var means we don't get screwed over
+if the move loop gets deleted mid-move, FYI.
Tries to figure out the current favorite loop to run. More complex then just deciding between two different loops, assumes no running loop currently exists
Flags passed from the move loop before it calls move() and unset right after.
+Allows for properties of a move loop to be easily checked by mechanics outside of it.
+Having this a bitfield rather than a type var means we don't get screwed over
+if the move loop gets deleted mid-move, FYI.
Adds a loop to our parent. Returns the created loop if a success, null otherwise
contest_running_loop
+
+
Attempts to contest the current running move loop. Returns TRUE if the loop is active, FALSE otherwise
decide_on_running_loop
+
+
Tries to figure out the current favorite loop to run. More complex then just deciding between two different loops, assumes no running loop currently exists
+
+
+
diff --git a/datum/movespeed_modifier.html b/datum/movespeed_modifier.html
new file mode 100644
index 000000000000..7dc8fe1f1d2f
--- /dev/null
+++ b/datum/movespeed_modifier.html
@@ -0,0 +1,78 @@
+
+
+
+
+
+
+ /datum/movespeed_modifier - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Unique ID. You can never have different modifications with the same ID. By default, this SHOULD NOT be set. Only set it for cases where you're dynamically making modifiers/need to have two types overwrite each other. If unset, uses path (converted to text) as ID.
Higher ones override lower priorities. This is NOT used for ID, ID must be unique, if it isn't unique the newer one overwrites automatically if overriding.
Whether or not this is a variable modifier. Variable modifiers can NOT be ever auto-cached. ONLY CHECKED VIA INITIAL(), EFFECTIVELY READ ONLY (and for very good reason)
Unique ID. You can never have different modifications with the same ID. By default, this SHOULD NOT be set. Only set it for cases where you're dynamically making modifiers/need to have two types overwrite each other. If unset, uses path (converted to text) as ID.
Higher ones override lower priorities. This is NOT used for ID, ID must be unique, if it isn't unique the newer one overwrites automatically if overriding.
Whether or not this is a variable modifier. Variable modifiers can NOT be ever auto-cached. ONLY CHECKED VIA INITIAL(), EFFECTIVELY READ ONLY (and for very good reason)
Called by hooked signals whenever burden_level var needs to go up or down by 1.
+Sends messages on burden level, gives powers and takes them if needed, etc
goes from 0 to 6 (but can be beyond 6, just does nothing) and gives rewards. increased by disabling yourself with debuffs
Proc Details
addict_added_burden
+
+
Signal to increase burden_level (see update_burden proc) if an addiction is added
addict_removed_burden
+
+
Signal to decrease burden_level (see update_burden proc) if an addiction is removed
limbs_added_burden
+
+
Signal to decrease burden_level (see update_burden proc) if a limb is added
limbs_removed_burden
+
+
Signal to increase burden_level (see update_burden proc) if a limb is removed
mutation_added_burden
+
+
Signal to increase burden_level (see update_burden proc) if a mutation is added
mutation_removed_burden
+
+
Signal to decrease burden_level (see update_burden proc) if a mutation is removed
organ_added_burden
+
+
Signal to decrease burden_level (see update_burden proc) if an organ is added
organ_removed_burden
+
+
Signal to increase burden_level (see update_burden proc) if an organ is removed
trauma_added_burden
+
+
Signal to increase burden_level (see update_burden proc) if a trauma is added
trauma_removed_burden
+
+
Signal to decrease burden_level (see update_burden proc) if a trauma is removed
update_burden
+
+
Called by hooked signals whenever burden_level var needs to go up or down by 1.
+Sends messages on burden level, gives powers and takes them if needed, etc
+
Arguments:
+
+
increase: whether to tick burden_level up or down 1
Called by hooked signals whenever someone attacks the person with this mutation
+Checks if the attacker should be considered guilty and adds them to the guilty list if true
Signal to see if the mutation allows us to attack a target
guilty
+
+
Called by hooked signals whenever someone attacks the person with this mutation
+Checks if the attacker should be considered guilty and adds them to the guilty list if true
+
Arguments:
+
+
user: person who attacked the honorbound
+
declaration: if this wasn't an attack, but instead the honorbound spending favor on declaring this person guilty
+
is_honorable
+
+
Called by attack_honor signal to check whether an attack should be allowed or not
+
Arguments:
+
+
honorbound_human: typecasted owner of mutation
+
target_creature: person honorbound_human is attacking
+
punishment
+
+
Called when a spell is casted or a magic gun is fired, checks the signal and punishes accordingly
+
Arguments:
+
+
user: typecasted owner of mutation
+
school: school of magic casted from the staff/spell
Basically, we only proceed if we're in throw mode with a tailed carbon in our grasp with at least a neck grab and we're not restrained in some way
+Do a short 2 second do_after before starting the actual swing
Checks damage of a hulk's arm and applies bone wounds as necessary.
+
Called by specific atoms being attacked, such as walls. If an atom
+does not call this proc, than punching that atom will not cause
+arm breaking (even if the atom deals recoil damage to hulks).
+Arguments:
+arg1 is the arm to evaluate damage of and possibly break.
check_swing
+
+
Run a barrage of checks to see if any given click is actually able to swing
finish_swing
+
+
Time to toss the victim at high speed
setup_swing
+
+
Basically, we only proceed if we're in throw mode with a tailed carbon in our grasp with at least a neck grab and we're not restrained in some way
+Do a short 2 second do_after before starting the actual swing
swing_loop
+
+
Does the animations for the hulk swing loop
+
This code is based in part on the wrestling swing code ported from goon, see [code/datums/martial/wrestling.dm]
+credit to: cogwerks, pistoleer, spyguy, angriestibm, marquesas, and stuntwaffle.
+For each step of the swinging, with the delay getting shorter along the way. Checks to see we still have them in our grasp at each step.
This takes a held photograph, and updates the current_image variable with that of the held photograph's image.
+*user: The mob who is being checked for a held photo object.
Performs a series of sanity checks before giving the user confirmation to create a new feed_channel using channel_name, and channel_desc.
+*channel_locked: This variable determines if other users than the author can make comments and new feed_stories on this channel.
Constructs a comment to attach to the currently selected feed_message of choice, assuming that a user can be found and that a message body has been written.
Creates a new feed story to the global newscaster network.
+Verifies that the message is being written to a real feed_channel, then provides a text input for the feed story to be written into.
+Finally, it submits the message to the network, is logged globally, and clears all message-specific variables from the machine.
This proc performs checks before enabling the creating_channel var on the newscaster, such as preventing a user from having multiple channels,
+preventing an un-ID'd user from making a channel, and preventing censored authors from making a channel.
+Otherwise, sets creating_channel to TRUE.
Selects a currently held photo from the user's hand and makes it the current_image held by the newscaster.
+If a photo is still held in the newscaster, it will otherwise clear it from the machine.
Is the current user editing or viewing a new wanted issue at the moment?
Proc Details
attach_photo
+
+
This takes a held photograph, and updates the current_image variable with that of the held photograph's image.
+*user: The mob who is being checked for a held photo object.
create_channel
+
+
Performs a series of sanity checks before giving the user confirmation to create a new feed_channel using channel_name, and channel_desc.
+*channel_locked: This variable determines if other users than the author can make comments and new feed_stories on this channel.
create_comment
+
+
Constructs a comment to attach to the currently selected feed_message of choice, assuming that a user can be found and that a message body has been written.
create_story
+
+
Creates a new feed story to the global newscaster network.
+Verifies that the message is being written to a real feed_channel, then provides a text input for the feed story to be written into.
+Finally, it submits the message to the network, is logged globally, and clears all message-specific variables from the machine.
send_photo_data
+
+
Sends photo data to build the newscaster article.
start_creating_channel
+
+
This proc performs checks before enabling the creating_channel var on the newscaster, such as preventing a user from having multiple channels,
+preventing an un-ID'd user from making a channel, and preventing censored authors from making a channel.
+Otherwise, sets creating_channel to TRUE.
toggle_photo
+
+
Selects a currently held photo from the user's hand and makes it the current_image held by the newscaster.
+If a photo is still held in the newscaster, it will otherwise clear it from the machine.
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
This is a clean system of applying outfits to mobs, if you need to equip someone in a uniform
+this is the way to do it cleanly and properly.
+
You can also specify an outfit datum on a job to have it auto equipped to the mob on join
+
/mob/living/carbon/human/proc/equipOutfit(outfit) is the mob level proc to equip an outfit
+and you pass it the relevant datum outfit
+
outfits can also be saved as json blobs downloadable by a client and then can be uploaded
+by that user to recreate the outfit, this is used by admins to allow for custom event outfits
+that can be restored at a later date
Return a list of types to pregenerate for later equipping
+This should not be things that do unique stuff in Initialize() based off their location, since we'll be storing them for a while
Apply a fingerprint from the passed in human to all items in the outfit
+
Used for forensics setup when the mob is first equipped at roundstart
+essentially calls add_fingerprint to every defined item on the human
copyFrom
+
+
Copy most vars from another outfit to this one
equip
+
+
Equips all defined types and paths to the mob passed in
+
Extra Arguments
+
+
visualsOnly true if this is only for display (in the character setup screen)
+
+
If visualsOnly is true, you can omit any work that doesn't visually appear on the character sprite
get_chameleon_disguise_info
+
+
Return a list of all the types that are required to disguise as this outfit type
get_json_data
+
+
Return a json list of this outfit
get_types_to_preload
+
+
Return a list of types to pregenerate for later equipping
+This should not be things that do unique stuff in Initialize() based off their location, since we'll be storing them for a while
load_from
+
+
Create an outfit datum from a list of json data
post_equip
+
+
Called after the equip proc has finished
+
All items are on the mob at this point, use this proc to toggle internals
+fiddle with id bindings and accesses etc
+
Extra Arguments
+
+
visualsOnly true if this is only for display (in the character setup screen)
+
+
If visualsOnly is true, you can omit any work that doesn't visually appear on the character sprite
pre_equip
+
+
Called at the start of the equip proc
+
Override to change the value of the slots depending on client prefs, species and
+other such sources of change
+
Extra Arguments
+
+
visualsOnly true if this is only for display (in the character setup screen)
+
+
If visualsOnly is true, you can omit any work that doesn't visually appear on the character sprite
save_to_file
+
+
Prompt the passed in mob client to download this outfit as a json blob
+
+
+
diff --git a/datum/outfit/ctf.html b/datum/outfit/ctf.html
new file mode 100644
index 000000000000..cbb9a3a2f1e1
--- /dev/null
+++ b/datum/outfit/ctf.html
@@ -0,0 +1,78 @@
+
+
+
+
+
+
+ /datum/outfit/ctf - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Stanrdard loading, not used in production
+Doesn't take advantage of any tgm optimizations, which makes it slower but also more general
+Use this if for some reason your map format is messy
Builds key caches for general formats
+Slower then the proc above, tho it could still be optimized slightly. it's just not a priority
+Since we don't run DMM maps, ever.
Stanrdard loading, not used in production
+Doesn't take advantage of any tgm optimizations, which makes it slower but also more general
+Use this if for some reason your map format is messy
Builds key caches for general formats
+Slower then the proc above, tho it could still be optimized slightly. it's just not a priority
+Since we don't run DMM maps, ever.
load
+
+
Load the parsed map into the world. See /proc/load_map for arguments.
+
+
+
diff --git a/datum/particle_editor.html b/datum/particle_editor.html
new file mode 100644
index 000000000000..41ae7786cafa
--- /dev/null
+++ b/datum/particle_editor.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /datum/particle_editor - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
search_step() is the workhorse of pathfinding. It'll do the searching logic, and will slowly build up a path
+returns TRUE if everything is stable, FALSE if the pathfinding logic has failed, and we need to abort
early_exit() is called when something goes wrong in processing, and we need to halt the pathfinding NOW
finished
+
+
Cleanup pass for the pathfinder. This tidies up the path, and fufills the pathfind's obligations
hand_back
+
+
Call to return a value to whoever spawned this pathfinding work
+Will fail if it's already been called
search_step
+
+
search_step() is the workhorse of pathfinding. It'll do the searching logic, and will slowly build up a path
+returns TRUE if everything is stable, FALSE if the pathfinding logic has failed, and we need to abort
start
+
+
"starts" off the pathfinding, by storing the values this datum will need to work later on
+returns FALSE if it fails to setup properly, TRUE otherwise
search_step() is the workhorse of pathfinding. It'll do the searching logic, and will slowly build up a path
+returns TRUE if everything is stable, FALSE if the pathfinding logic has failed, and we need to abort
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]
If we should delete the first step in the path or not. Used often because it is just the starting tile
Proc Details
diag_scan_spec
+
+
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:
+
+
original_turf: What turf did we start this scan at?
+
heading: What direction are we going in? Obviously, should be diagonal
+
parent_node: We should always have a parent node for diagonals
+
finished
+
+
Cleanup pass for the pathfinder. This tidies up the path, and fufills the pathfind's obligations
lateral_scan_spec
+
+
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:
+
+
original_turf: What turf did we start this scan at?
+
heading: What direction are we going in? Obviously, should be cardinal
+
parent_node: Only given for normal lateral scans, if we don't have one, we're a diagonal subscan.
+
search_step
+
+
search_step() is the workhorse of pathfinding. It'll do the searching logic, and will slowly build up a path
+returns TRUE if everything is stable, FALSE if the pathfinding logic has failed, and we need to abort
start
+
+
"starts" off the pathfinding, by storing the values this datum will need to work later on
+returns FALSE if it fails to setup properly, TRUE otherwise
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]
For a machine to properly "connect" to a pipeline and share gases,
+the pipeline needs to acknowledge a gas mixture as it's member.
+This is currently handled by the other_airs list in the pipeline datum.
For a machine to properly "connect" to a pipeline and share gases,
+the pipeline needs to acknowledge a gas mixture as it's member.
+This is currently handled by the other_airs list in the pipeline datum.
+
Other_airs itself is populated by gas mixtures through the parents list that each machineries have.
+This parents list is populated when a machinery calls update_parents and is then added into the queue by the controller.
+
build_pipeline
+
+
Preps a pipeline for rebuilding, insterts it into the rebuild queue
build_pipeline_blocking
+
+
Has the same effect as build_pipeline(), but this doesn't queue its work, so overrun abounds. It's useful for the pregame
reconcile_air
+
+
Called when the pipenet needs to update and mix together all the air mixes
Intends to compare a reagent gene with a set of seeds, and if the seeds contain the same gene, with more production rate, upgrades the rate to the highest of the two.
The typepath of the actual reagent that this gene is tied to.
Proc Details
try_upgrade_gene
+
+
Intends to compare a reagent gene with a set of seeds, and if the seeds contain the same gene, with more production rate, upgrades the rate to the highest of the two.
+
Called when plants are crossbreeding, this looks for two matching reagent_ids, where the rates are greater, in order to upgrade.
A plant trait that causes the plant's food reagents to ferment instead.
+
In practice, it replaces the plant's nutriment and vitamins with half as much of it's fermented reagent.
+This exception is executed in seeds.dm under 'prepare_result'.
+
Incompatible with auto-juicing composition.
+
+
+
diff --git a/datum/plant_gene/trait/eyes.html b/datum/plant_gene/trait/eyes.html
new file mode 100644
index 000000000000..5c4d030bce09
--- /dev/null
+++ b/datum/plant_gene/trait/eyes.html
@@ -0,0 +1,37 @@
+
+
+
+
+
+
+ /datum/plant_gene/trait/eyes - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Plays a laughter sound when someone slips on it.
+Like the sitcom component but for plants.
+Just like slippery skin, if we have a trash type this only functions on that. (Banana peels)
The specific point of interest this datum references. This won't hard del as the POI element will be removed from the target when it qdels, which will clear this reference.
The specific point of interest this datum references. This won't hard del as the POI element will be removed from the target when it qdels, which will clear this reference.
Proc Details
compare_to
+
+
Comparison proc used to sort POIs. Override to implement logic used doing binary sort insertions.
validate
+
+
Validates the POI. Returns TRUE if the POI has valid state, returns FALSE if the POI has invalid state.
Hint for statbus, not used by the game; If this option should be included by default when calculating the resulting percentages of all options for this poll
Hint for statbus, not used by the game; If this option should be included by default when calculating the resulting percentages of all options for this poll
Sets a poll option and its votes as deleted in the database then deletes its datum.
save_option
+
+
Inserts or updates a poll option to the database.
+
Uses INSERT ON DUPLICATE KEY UPDATE to handle both inserting and updating at once.
+The list of columns and values is built dynamically to avoid excess data being sent when not a rating type poll.
Supplementary text displayed only when responding to a poll.
Proc Details
clear_poll_votes
+
+
Deletes all votes or text replies for this poll, depending on its type.
delete_poll
+
+
Sets a poll and its associated data as deleted in the database.
+
Calls the procedure set_poll_deleted to set the deleted column to 1 for each row in the poll_ tables matching the poll id used.
+Then deletes each option datum and finally the poll itself.
save_all_options
+
+
Saves all options of a poll to the database.
+
Saves all the created options for a poll when it's submitted to the DB for the first time and associated an id with the options.
+Insertion and id querying for each option is done separately to ensure data integrity; this is less performant, but not significantly.
+Using MassInsert() would mean having to query a list of rows by poll_id or matching by fields afterwards, which doesn't guarantee accuracy.
save_poll_data
+
+
Inserts or updates a poll question to the database.
+
Uses INSERT ON DUPLICATE KEY UPDATE to handle both inserting and updating at once.
+The start and end datetimes and poll id for new polls is then retrieved for the poll datum.
+Arguments:
+
+
clear_votes - When true will call clear_poll_votes() to delete all votes matching this poll id.
It's a tgui window that lets you look through all the portraits, and choose one as your AI.
+very similar to centcom_podlauncher in terms of how this is coded, so i kept a lot of comments from it
The category of preference, for use by the PreferencesMenu.
+This isn't used for anything other than as a key for UI data.
+It is up to the PreferencesMenu UI itself to interpret it.
What savefile should this preference be read from?
+Valid values are PREFERENCE_CHARACTER and PREFERENCE_PLAYER.
+See the documentation in code/__DEFINES/preferences.dm.
Produce a default, potentially random value for when no value for this
+preference is found in the savefile.
+Either this or create_informed_default_value must be overriden by subtypes.
Produce a default, potentially random value for when no value for this
+preference is found in the savefile.
+Unlike create_default_value(), will provide the preferences object if you
+need to use it.
+If not overriden, will call create_default_value() instead.
Called on the saved input when retrieving.
+Also called by the value sent from the user through UI. Do not trust it.
+Input is the value inside the savefile, output is to tell other code
+what the value is.
+This is useful either for more optimal data saving or for migrating
+older data.
+Must be overridden by subtypes.
+Can return null if no value was found.
The category of preference, for use by the PreferencesMenu.
+This isn't used for anything other than as a key for UI data.
+It is up to the PreferencesMenu UI itself to interpret it.
What savefile should this preference be read from?
+Valid values are PREFERENCE_CHARACTER and PREFERENCE_PLAYER.
+See the documentation in code/__DEFINES/preferences.dm.
A typepath for a sub preference. Ex: Hair Style's sub_preference is /datum/preference/color/hair_color
Proc Details
apply_to_client
+
+
Apply this preference onto the given client.
+Called when the savefile_identifier == PREFERENCE_PLAYER.
apply_to_client_updated
+
+
Fired when the preference is updated.
+Calls apply_to_client by default, but can be overridden.
apply_to_human
+
+
Apply this preference onto the given human.
+Must be overriden by subtypes.
+Called when the savefile_identifier == PREFERENCE_CHARACTER.
compile_constant_data
+
+
Returns data compiled into the preferences JSON asset
compile_ui_data
+
+
Returns data to be sent to users in the menu
create_default_value
+
+
Produce a default, potentially random value for when no value for this
+preference is found in the savefile.
+Either this or create_informed_default_value must be overriden by subtypes.
create_informed_default_value
+
+
Produce a default, potentially random value for when no value for this
+preference is found in the savefile.
+Unlike create_default_value(), will provide the preferences object if you
+need to use it.
+If not overriden, will call create_default_value() instead.
create_random_value
+
+
Produce a random value for the purposes of character randomization.
+Will just create a default value by default.
deserialize
+
+
Called on the saved input when retrieving.
+Also called by the value sent from the user through UI. Do not trust it.
+Input is the value inside the savefile, output is to tell other code
+what the value is.
+This is useful either for more optimal data saving or for migrating
+older data.
+Must be overridden by subtypes.
+Can return null if no value was found.
get_spritesheet_key
+
+
Returns the key that will be used in the spritesheet for a given value.
is_accessible
+
+
Returns whether or not this preference is accessible.
+If FALSE, will not show in the UI and will not be editable (by update_preference).
is_randomizable
+
+
Returns whether or not a preference can be randomized.
is_valid
+
+
Checks that a given value is valid.
+Must be overriden by subtypes.
+Any type can be passed through.
read
+
+
Given a savefile, return either the saved data or an acceptable default.
+This will write to the savefile if a value was not found with the new value.
serialize
+
+
Called on the input while saving.
+Input is the current value, output is what to save in the savefile.
value_changed
+
+
Called when a user updates the value of this preference.
write
+
+
Given a savefile, writes the inputted value.
+Returns TRUE for a successful application.
+Return FALSE if it is invalid.
If this is TRUE, icons will be generated.
+This is necessary for if your init_possible_values() override
+returns an assoc list of names to atoms/icons.
If this is TRUE, icons will be generated.
+This is necessary for if your init_possible_values() override
+returns an assoc list of names to atoms/icons.
Proc Details
get_choices
+
+
Returns a list of every possible value.
+The first time this is called, will run init_values().
+Return value can be in the form of:
+
+
A flat list of raw values, such as list(MALE, FEMALE, PLURAL).
+
An assoc list of raw values to atoms/icons.
+
get_choices_serialized
+
+
Returns a list of every possible value, serialized.
+Return value can be in the form of:
+
+
A flat list of serialized values, such as list(MALE, FEMALE, PLURAL).
+
An assoc list of serialized values to atoms/icons.
+
init_possible_values
+
+
Returns a list of every possible value.
+This must be overriden by /datum/preference/choiced subtypes.
+Return value can be in the form of:
+
+
A flat list of raw values, such as list(MALE, FEMALE, PLURAL).
+
An assoc list of raw values to atoms/icons, in which case
+icons will be generated.
+
+
+
+
diff --git a/datum/preference/name.html b/datum/preference/name.html
new file mode 100644
index 000000000000..2bbb67c92450
--- /dev/null
+++ b/datum/preference/name.html
@@ -0,0 +1,50 @@
+
+
+
+
+
+
+ /datum/preference/name - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Map of ui_act actions -> proc paths to call.
+Signature is `(list/params, mob/user) -> TRUE/FALSE.
+Return output is the same as ui_act--TRUE if it should update, FALSE if it should not
Map of ui_act actions -> proc paths to call.
+Signature is `(list/params, mob/user) -> TRUE/FALSE.
+Return output is the same as ui_act--TRUE if it should update, FALSE if it should not
Someone thought we were nice! We get a little heart in OOC until we join the server past the below time (we can keep it until the end of the round otherwise)
Called when reading preferences if a savefile update is detected. This proc is for
+overriding preference datum values before they are sanitized by deserialize()
Will perform an update on the preference, but not write to the savefile.
+This will, for instance, update the character preference view.
+Performs sanity checks.
Someone thought we were nice! We get a little heart in OOC until we join the server past the below time (we can keep it until the end of the round otherwise)
A cache of preference entries to values.
+Used to avoid expensive READ_FILE every time a preference is retrieved.
Proc Details
apply_all_client_preferences
+
+
Applies all PREFERENCE_PLAYER preferences
apply_prefs_to
+
+
Applies the given preferences to a human mob.
check_keybindings
+
+
checks through keybindings for outdated unbound keys and updates them
early_update_character
+
+
Called when reading preferences if a savefile update is detected. This proc is for
+overriding preference datum values before they are sanitized by deserialize()
get_highest_priority_job
+
+
Returns what job is marked as highest
get_key_bindings_by_key
+
+
Inverts the key_bindings list such that it can be used for key_bindings_by_key
get_savefile_for_savefile_identifier
+
+
Returns which savefile to use for a given savefile identifier
randomise_appearance_prefs
+
+
Fully randomizes everything in the character.
read_preference
+
+
Read a /datum/preference type and return its value.
+This will write to the savefile if a value was not found with the new value.
reset_loadout
+
+
Resets current loadout slot
safe_transfer_prefs_to
+
+
Sanitizes the preferences, applies the randomization prefs, and then applies the preference to the human mob.
update_preference
+
+
Will perform an update on the preference, but not write to the savefile.
+This will, for instance, update the character preference view.
+Performs sanity checks.
write_preference
+
+
Set a /datum/preference entry.
+Returns TRUE for a successful preference application.
+Returns FALSE if it is invalid.
Any special effects or chat messages which should be applied.
+This proc is guaranteed to run if the mob has a client when the quirk is added.
+Otherwise, it runs once on the next COMSIG_MOB_LOGIN.
Reference to the mob currently tied to this quirk datum. Quirks are not singletons.
Proc Details
add
+
+
Any effect that should be applied every single time the quirk is added to any mob, even when transferred.
add_to_holder
+
+
Adds the quirk to a new quirk_holder.
+
Performs logic to make sure new_holder is a valid holder of this quirk.
+Returns FALSEy if there was some kind of error. Returns TRUE otherwise.
+Arguments:
+
+
new_holder - The mob to add this quirk to.
+
quirk_transfer - If this is being added to the holder as part of a quirk transfer. Quirks can use this to decide not to spawn new items or apply any other one-time effects.
+
add_unique
+
+
Any effects from the proc that should not be done multiple times if the quirk is transferred between mobs.
+Put stuff like spawning items in here.
on_holder_qdeleting
+
+
Called when quirk_holder is qdeleting. Simply qdels this datum and lets Destroy() handle the rest.
on_quirk_holder_first_login
+
+
On client connection set quirk preferences.
+
Run post_add to set the client preferences for the quirk.
+Clear the attached signal for login.
+Used when the quirk has been gained and no client is attached to the mob.
post_add
+
+
Any special effects or chat messages which should be applied.
+This proc is guaranteed to run if the mob has a client when the quirk is added.
+Otherwise, it runs once on the next COMSIG_MOB_LOGIN.
remove
+
+
Removal of any reversible effects added by the quirk.
Lazylist of strings describing where all the quirk items have been spawned.
Proc Details
give_item_to_holder
+
+
Handles inserting an item in any of the valid slots provided, then allows for post_add notification.
+
If no valid slot is available for an item, the item is left at the mob's feet.
+Arguments:
+
+
quirk_item - The item to give to the quirk holder. If the item is a path, the item will be spawned in first on the player's turf.
+
valid_slots - Assoc list of descriptive location strings to item slots that is fed into [/mob/living/carbon/proc/equip_in_one_of_slots]. list(LOCATION_BACKPACK = ITEM_SLOT_BACKPACK)
+
flavour_text - Optional flavour text to append to the where_items_spawned string after the item's location.
+
default_location - If the item isn't possible to equip in a valid slot, this is a description of where the item was spawned.
Assoc list with key type of addiction this reagent feeds, and value amount of addiction points added per unit of reagent metabolzied (which means * REAGENTS_METABOLISM every life())
How fast the reagent metabolizes when ingested. NOTE: Due to how reagents are coded, if you have an on_metabolize() for blood, this MUST be greater than metabolization_rate.
The molar mass of the reagent - if you're adding a reagent that doesn't have a recipe, just add a random number between 10 - 800. Higher numbers are "harder" but it's mostly arbitary.
New, standardized method for chemicals to affect hydroponics trays.
+Defined on a per-chem level as opposed to by the tray.
+Can affect plant's health, stats, or cause the plant to react in certain ways.
Assoc list with key type of addiction this reagent feeds, and value amount of addiction points added per unit of reagent metabolzied (which means * REAGENTS_METABOLISM every life())
How fast the reagent metabolizes when ingested. NOTE: Due to how reagents are coded, if you have an on_metabolize() for blood, this MUST be greater than metabolization_rate.
The molar mass of the reagent - if you're adding a reagent that doesn't have a recipe, just add a random number between 10 - 800. Higher numbers are "harder" but it's mostly arbitary.
Should return a associative list where keys are taste descriptions and values are strength ratios
on_hydroponics_apply
+
+
New, standardized method for chemicals to affect hydroponics trays.
+Defined on a per-chem level as opposed to by the tray.
+Can affect plant's health, stats, or cause the plant to react in certain ways.
on_merge
+
+
Called when two reagents of the same are mixing.
on_mob_add
+
+
Called when this reagent is first added to a mob
on_mob_delete
+
+
Called when this reagent is removed while inside a mob
on_mob_end_metabolize
+
+
Called when this reagent stops being metabolized by a liver
This proc turns the living mob passed as the arg "invisible_man"s invisible by giving him the invisible man trait and updating his body, this changes the sprite of all his organic limbs to a 1 alpha version.
Proc Details
turn_man_invisible
+
+
This proc turns the living mob passed as the arg "invisible_man"s invisible by giving him the invisible man trait and updating his body, this changes the sprite of all his organic limbs to a 1 alpha version.
Checks to see if the reagents has a difference in reagents_list and previous_reagent_list (I.e. if there's a difference between the previous call and the last)
+Also checks to see if the saved reactions in failed_but_capable_reactions can start as a result of temp change
Check if this holder contains a reagent with a chemical_flags containing this flag
+Reagent takes the bitflag to search for
+Amount checks for having a specific amount of reagents matching that chemical
Check if this holder contains this reagent.
+Reagent takes a PATH to a reagent.
+Amount checks for having a specific amount of that chemical.
+Needs matabolizing takes into consideration if the chemical is matabolizing when it's checked.
Removes all reagents either proportionally(amount is the direct volume to remove)
+when proportional the total volume of all reagents removed will equal to amount
+or relatively(amount is a percentile between 0->1) when relative amount is the %
+of each reagent to be removed
The bitflag of the currently selected tags in the ui
Proc Details
add_reagent
+
+
Adds a reagent to this holder
+
Arguments:
+
+
reagent - The reagent id to add
+
amount - Amount to add
+
list/data - Any reagent data for this reagent, used for transferring data with reagents
+
reagtemp - Temperature of this reagent, will be equalized
+
no_react - prevents reactions being triggered by this addition
+
ignore splitting - Don't call the process that handles reagent spliting in a mob (impure/inverse) - generally leave this false unless you care about REAGENTS_DONOTSPLIT flags (see reagent defines)
+
add_reagent_list
+
+
Like add_reagent but you can enter a list.
+Arguments
+
+
[list_reagents][list] - list to add. Format it like this: list(/datum/reagent/toxin = 10, "beer" = 15)
+
[data][list] - additional data to add
+
add_reagent_up_to
+
+
Adds a reagent up to a cap.
adjust_thermal_energy
+
+
+
+
Adjusts the thermal energy of the reagents in this holder by an amount.
+
+
+
Arguments:
+
+
+
+
delta_energy: The amount to change the thermal energy by.
+
+
+
+
+
min_temp: The minimum temperature that can be reached.
+
+
+
+
+
max_temp: The maximum temperature that can be reached.
+
+
+
clear_reagents
+
+
Removes all reagents
copy_data
+
+
Shallow copies (deep copy of viruses) data from the provided reagent into our copy of that reagent
copy_to
+
+
Copies the reagents to the target object
del_reagent
+
+
Removes an specific reagent from this holder
+Arguments
Atom/A: What mob/turf/object is being exposed to reagents? This is your reaction target.
+
Methods: What reaction type is the reagent itself going to call on the reaction target? Types are TOUCH, INGEST, VAPOR, PATCH, and INJECT.
+
Volume_modifier: What is the reagent volume multiplied by when exposed? Note that this is called on the volume of EVERY reagent in the base body, so factor in your Maximum_Volume if necessary!
+
Show_message: Whether to display anything to mobs when they are exposed.
mob/living/taster - who is doing the tasting. Some mobs can pick up specific flavours.
+
minimum_percent - the lower the minimum percent, the more sensitive the message is.
+
generate_thermodynamic_profile
+
+
Generates a (rough) rate vs temperature graph profile
getHeatCapacity
+
+
Returns the total heat capacity for all of the reagents currently in this holder.
get_data
+
+
helper function to preserve data across reactions (needed for xenoarch)
get_external_reagent_log_string
+
+
Outputs a log-friendly list of reagents based on an external reagent list.
+
Arguments:
+
+
external_list - Assoc list of (reagent_type) = list(REAGENT_TRANSFER_AMOUNT = amounts)
+
get_master_reagent
+
+
Get a reference to the reagent there is the most of in this holder
get_master_reagent_id
+
+
Get the id of the reagent there is the most of in this holder
get_master_reagent_name
+
+
Get the name of the reagent there is the most of in this holder
get_priority_instant_reaction
+
+
Possibly remove - see if multiple instant reactions is okay (Though, this "sorts" reactions by temp decending)
+Presently unused
get_reagent
+
+
Get a reference to the reagent if it exists
get_reagent_amount
+
+
Get the amount of this reagent
get_reagent_log_string
+
+
Outputs a log-friendly list of reagents based on the internal reagent_list.
+
Arguments:
+
+
external_list - Assoc list of (reagent_type) = list(REAGENT_TRANSFER_AMOUNT = amounts)
+
get_reagent_names
+
+
Get a comma separated string of every reagent name in this holder. UNUSED
handle_reactions
+
+
Handle any reactions possible in this holder
+Also UPDATES the reaction list
+High potential for infinite loopsa if you're editing this.
has_changed_state
+
+
Checks to see if the reagents has a difference in reagents_list and previous_reagent_list (I.e. if there's a difference between the previous call and the last)
+Also checks to see if the saved reactions in failed_but_capable_reactions can start as a result of temp change
has_chemical_flag
+
+
Check if this holder contains a reagent with a chemical_flags containing this flag
+Reagent takes the bitflag to search for
+Amount checks for having a specific amount of reagents matching that chemical
has_reagent
+
+
Check if this holder contains this reagent.
+Reagent takes a PATH to a reagent.
+Amount checks for having a specific amount of that chemical.
+Needs matabolizing takes into consideration if the chemical is matabolizing when it's checked.
has_reagent_list
+
+
Like has_reagent but you can enter a list.
holder_full
+
+
Is this holder full or not
instant_react
+
+
Old reaction mechanics, edited to work on one only
+This is changed from the old - purity of the reagents will affect yield
is_reaction_overheating
+
+
Returns TRUE if this container's temp would overheat a reaction.
isolate_reagent
+
+
Remove every reagent except this one
metabolize
+
+
Triggers metabolizing for all the reagents in this holder
Multiplies the reagents inside this holder by a specific amount
reaction_message
+
+
Gives feedback that a reaction is occuring. Returns an icon2html string.
remove_all
+
+
Removes all reagents either proportionally(amount is the direct volume to remove)
+when proportional the total volume of all reagents removed will equal to amount
+or relatively(amount is a percentile between 0->1) when relative amount is the %
+of each reagent to be removed
+
Arguments
+
+
amount - the amount to remove
+
relative - if TRUE amount is treated as an percentage between 0->1. If FALSE amount is the direct volume to remove
+
remove_reagent
+
+
Removes a specific reagent. can supress reactions if needed
+Arguments
safety - if FALSE will initiate reactions upon removing. used for trans_id_to
+
include_subtypes - if TRUE will remove the specified amount from all subtypes of reagent_type as well
+
remove_reagent_list
+
+
Like remove_reagent but you can enter a list.
set_data
+
+
helper function to preserve data across reactions (needed for xenoarch)
set_temperature
+
+
+
+
Sets the temperature of this reagent container to a new value.
+
+
+
Handles setter signals.
+
+
+
Arguments:
+
+
+
+
_temperature: The new temperature value.
+
+
+
trans_id_to
+
+
Transfer a specific reagent id to the target object. Accepts a reagent instance, but assumes the reagent is in src.
trans_to
+
+
Transfer some stuff from this holder to a target object
+
Arguments:
+
+
obj/target - Target to attempt transfer to
+
amount - amount of reagent volume to transfer
+
multiplier - multiplies amount of each reagent by this number
+
preserve_data - if preserve_data=0, the reagents data will be lost. Usefull if you use data for some strange stuff and don't want it to be transferred.
round_robin - if round_robin=TRUE, so transfer 5 from 15 water, 15 sugar and 15 plasma becomes 10, 15, 15 instead of 13.3333, 13.3333 13.3333. Good if you hate floating point errors
A global singleton data that tracks all the heretic
+influences ("reality smashes") that we've created,
+and all of the heretics (minds) that can see them.
+
Handles ensuring all minds can see influences, generating
+new influences for new heretic minds, and allowing heretics
+to see new influences that are created.
Called to perform the invocation of the rite, with args being the performer and the altar where it's being performed. Maybe you want it to check for something else?
Does the thing if the rite was successfully performed. return value denotes that the effect successfully (IE a harm rite does harm)
perform_rite
+
+
Called to perform the invocation of the rite, with args being the performer and the altar where it's being performed. Maybe you want it to check for something else?
+
+
+
diff --git a/datum/religion_rites/adapted_food.html b/datum/religion_rites/adapted_food.html
new file mode 100644
index 000000000000..c1266cc0d3d2
--- /dev/null
+++ b/datum/religion_rites/adapted_food.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /datum/religion_rites/adapted_food - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Honorbound God
+Makes the person holy, but they now also have to follow the honorbound code (CBT). Actually earns favor, convincing others to uphold the code (tm) is not easy
visible message sent to indicate a song will have special properties
Proc Details
finish_effect
+
+
When the song is long enough, it will have a special effect when it ends.
+
If you want something that ALWAYS goes off regardless of song length, affix it to the Destroy proc. The rite is destroyed when smooth tunes is done.
+
Arguments:
+
+
song_player - parent of the smooth_tunes component. This is limited to the compatible items of said component, which currently includes mobs and objects so we'll have to type appropriately.
+
song_datum - Datum song being played
+
song_effect
+
+
Perform the song effect.
+
Arguments:
+
+
song_player - parent of the smooth_tunes component. This is limited to the compatible items of said component, which currently includes mobs and objects so we'll have to type appropriately.
+
song_datum - Datum song being played
+
+
+
+
diff --git a/datum/religion_rites/song_tuner/lullaby.html b/datum/religion_rites/song_tuner/lullaby.html
new file mode 100644
index 000000000000..9c1e816eb67f
--- /dev/null
+++ b/datum/religion_rites/song_tuner/lullaby.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /datum/religion_rites/song_tuner/lullaby - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Religious Sects are a way to convert the fun of having an active 'god' (admin) to code-mechanics so you aren't having to press adminwho.
+
Sects are not meant to overwrite the fun of choosing a custom god/religion, but meant to enhance it.
+The idea is that Space Jesus (or whoever you worship) can be an evil bloodgod who takes the lifeforce out of people, a nature lover, or all things righteous and good. You decide!
Returns TRUE if the item can be sacrificed. Can be modified to fit item being tested as well as person offering. Returning TRUE will stop the attackby sequence and proceed to on_sacrifice.
Activates when the sect sacrifices an item. This proc has NO bearing on the attackby sequence of other objects when used in conjunction with the religious_tool component.
Tgui icon used by this sect - https://fontawesome.com/icons
Proc Details
adjust_favor
+
+
Adjust Favor by a certain amount. Can provide optional features based on a user. Returns actual amount added/removed
can_sacrifice
+
+
Returns TRUE if the item can be sacrificed. Can be modified to fit item being tested as well as person offering. Returning TRUE will stop the attackby sequence and proceed to on_sacrifice.
on_conversion
+
+
Activates once selected and on newjoins, oriented around people who become holy.
on_riteuse
+
+
Activates when an individual uses a rite. Can provide different/additional benefits depending on the user.
on_sacrifice
+
+
Activates when the sect sacrifices an item. This proc has NO bearing on the attackby sequence of other objects when used in conjunction with the religious_tool component.
on_select
+
+
Activates once selected
sect_bless
+
+
Replaces the bible's bless mechanic. Return TRUE if you want to not do the brain hit.
set_favor
+
+
Sets favor to a specific amount. Can provide optional features based on a user.
Called by deaconize rite, this async'd proc waits for a response on joining the sect.
+If yes, the deaconize rite can now recruit them instead of just offering invites
people who have agreed to join the crusade, and can be deaconized
Proc Details
invite_crusader
+
+
Called by deaconize rite, this async'd proc waits for a response on joining the sect.
+If yes, the deaconize rite can now recruit them instead of just offering invites
+
+
+
diff --git a/datum/religion_sect/spar.html b/datum/religion_sect/spar.html
new file mode 100644
index 000000000000..4a04cc706532
--- /dev/null
+++ b/datum/religion_sect/spar.html
@@ -0,0 +1,57 @@
+
+
+
+
+
+
+ /datum/religion_sect/spar - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Used in the new client pipeline to catch when clients are reconnecting and need to have their
+reference re-assigned to the 'owner' variable of any requests
Used in the destroy client pipeline to catch when clients are disconnecting and need to have their
+reference nulled on the 'owner' variable of any requests
Used in the new client pipeline to catch when clients are reconnecting and need to have their
+reference re-assigned to the 'owner' variable of any requests
+
Arguments:
+
+
C - The client who is logging in
+
client_logout
+
+
Used in the destroy client pipeline to catch when clients are disconnecting and need to have their
+reference nulled on the 'owner' variable of any requests
+
Arguments:
+
+
C - The client who is logging out
+
message_centcom
+
+
Creates a request for a Centcom message
+
Arguments:
+
+
C - The client who is sending the request
+
message - The message
+
message_syndicate
+
+
Creates a request for a Syndicate message
+
Arguments:
+
+
C - The client who is sending the request
+
message - The message
+
nuke_request
+
+
Creates a request for the nuclear self destruct codes
+
Arguments:
+
+
C - The client who is sending the request
+
message - The message
+
pray
+
+
Creates a request for a prayer, and notifies admins who have the sound notifications enabled when appropriate
+
Arguments:
+
+
C - The client who is praying
+
message - The prayer
+
is_chaplain - Boolean operator describing if the prayer is from a chaplain
+
request_for_client
+
+
Creates a request and registers the request with all necessary internal tracking lists
+
Arguments:
+
+
C - The client who is sending the request
+
type - The type of request, see defines
+
message - The message
+
+
+
+
diff --git a/datum/roll_result.html b/datum/roll_result.html
new file mode 100644
index 000000000000..a3b94b46efe7
--- /dev/null
+++ b/datum/roll_result.html
@@ -0,0 +1,71 @@
+
+
+
+
+
+
+ /datum/roll_result - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Stored in a global datum, and created when rpgloot is turned on via event or VV'ing the GLOB.rpgloot_controller to be a new /datum/rpgloot_controller.
+Makes every item in the world fantasy, but also hooks into global signals for new items created to also bless them with fantasy.
+
What do I mean by fantasy?
+
+
Items will have random qualities assigned to them
+
Good quality items will have positive buffs/special powers applied to them
+
Bad quality items will get the opposite!
+
All of this is reflected in a fitting name for the item
+
See fantasy.dm and read the component for more information :)
Gives every viable item in the world the fantasy component.
+If the item it is giving fantasy to is a storage item, there's a chance it'll drop in an item fortification scroll. neat!
Calls on_crewmember_join on every crewmember
+If the item it is giving fantasy to is a storage item, there's a chance it'll drop in an item fortification scroll. neat!
Behaviour after the item is created, and before the slapcrafting assembly is disposed.
+Here you can move the components into the item if you wish, or do other stuff with them.
Runs when the last step tries to be performed and cancels the step if it returns FALSE. Could be used to validate location in structure construction via slap crafting.
Check if we want to craft multiple items, if yes then populate the list passed by the argument with them.
+Creates and returns a new item. This gets called for every item that is supposed to be created in the recipe.
Behaviour after the item is created, and before the slapcrafting assembly is disposed.
+Here you can move the components into the item if you wish, or do other stuff with them.
can_finish
+
+
Runs when the last step tries to be performed and cancels the step if it returns FALSE. Could be used to validate location in structure construction via slap crafting.
check_correct_step
+
+
Checks if a step of type step_type can be performed with the given step_states state.
create_item
+
+
Check if we want to craft multiple items, if yes then populate the list passed by the argument with them.
+Creates and returns a new item. This gets called for every item that is supposed to be created in the recipe.
create_items
+
+
The proc that creates the resulted item(s). Make sure to add them to the passed results list.
dispose_assembly
+
+
Here is the proc to get rid of the assembly, should one want to override it to handle that differently.
finish_recipe
+
+
User has finished the recipe in an assembly.
next_suitable_step
+
+
Returns the next suitable step to be performed with the item by the user with such step_states
Whether this step is optional. This is forbidden for first and last steps of recipes, and cannot be used on recipes with an order of SLAP_ORDER_FIRST_THEN_FREEFORM
Below are virtual procs I allow steps to override for their specific behaviours.
+Checks whether a user can perform this step with an item. Exists so steps can override this proc for their own behavioural checks.
+assembly can be null here, when the recipe finding checks are trying to figure out what recipe we can make.
Whether the step progresses towards the next step when successfully performed.
+This can be used to allow "freeform" crafting to put more things into an assembly than required, possibly utilizing it for things like custom burgers
Whether this step is optional. This is forbidden for first and last steps of recipes, and cannot be used on recipes with an order of SLAP_ORDER_FIRST_THEN_FREEFORM
Below are virtual procs I allow steps to override for their specific behaviours.
+Checks whether a user can perform this step with an item. Exists so steps can override this proc for their own behavioural checks.
+assembly can be null here, when the recipe finding checks are trying to figure out what recipe we can make.
check_type
+
+
Checks whether a type is in the typecache of the step.
get_speed_multiplier
+
+
Returns a speed multiplier to the time it takes for the step to complete. Useful for tool-related steps
make_desc
+
+
Makes a description for the step.
make_finish_msg
+
+
Makes a description for the visible message of finishing a step.
make_finish_msg_self
+
+
Makes a personalized description for the visible message of finishing a step.
make_finished_desc
+
+
Makes a finished description for the step.
make_list_desc
+
+
Makes a list description for the item.
make_start_msg
+
+
Makes a description for the visible message of starting a step that requires some time to perform.
make_start_msg_self
+
+
Makes a personalized description for the visible message of starting a step that requires some time to perform.
make_todo_desc
+
+
Makes a todo description for the step.
move_item_to_assembly
+
+
Behaviour to move the item into the assembly. Stackable items may want to change how they do this.
on_perform
+
+
Behaviour to happen on performing this step. Perhaps removing a portion of reagents to create an IED or something.
perform
+
+
Make a user perform this step, by using an item on the assembly, trying to progress the assembly.
perform_check
+
+
Checks if the passed item is a proper type to perform this step, and whether it passes the can_perform() check. Assembly can be null
perform_do_after
+
+
Proc to perform handling a do_after, return FALSE if it failed, TRUE if succeeded.
play_perform_sound
+
+
Plays a sound on successfully performing the step.
progress_crafting
+
+
Whether the step progresses towards the next step when successfully performed.
+This can be used to allow "freeform" crafting to put more things into an assembly than required, possibly utilizing it for things like custom burgers
step_replace_text
+
+
Text replacing for sending visibile messages when the steps are happening.
+
+
+
diff --git a/datum/slapcraft_step/attack.html b/datum/slapcraft_step/attack.html
new file mode 100644
index 000000000000..e4454fe968c3
--- /dev/null
+++ b/datum/slapcraft_step/attack.html
@@ -0,0 +1,50 @@
+
+
+
+
+
+
+ /datum/slapcraft_step/attack - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
This step requires and uses a reagent to finish itself. This step is great as a last step since reagents can't be recovered from disassembly.
+This alternatively can also transfer to a container inside the crafting assembly too!
Called once after either choosing the option to smite a player, or when selected in smite build mode.
+Use this to prompt the user configuration options.
+Return FALSE if the smite should not be used.
Called once after either choosing the option to smite a player, or when selected in smite build mode.
+Use this to prompt the user configuration options.
+Return FALSE if the smite should not be used.
effect
+
+
The effect of the smite, make sure to call this in your own smites
+
+
+
diff --git a/datum/smite/bad_luck.html b/datum/smite/bad_luck.html
new file mode 100644
index 000000000000..037e9b34db2a
--- /dev/null
+++ b/datum/smite/bad_luck.html
@@ -0,0 +1,43 @@
+
+
+
+
+
+
+ /datum/smite/bad_luck - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
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)
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.
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)
Parses a song the user has input into lines and stores them.
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.
instrument_status_ui
+
+
Returns the HTML for the status UI for this song datum.
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.
+
Arguments:
+
+
note is a number from 1-7 for A-G
+
acc is either "b", "n", or "#"
+
oct is 1-8 (or 9 for C)
+
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.
+
Arguments:
+
+
wait_ds - the deciseconds we should decay by. This is to compensate for any lag, as otherwise songs would get pretty nasty during high time dilation.
+
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_repeats
+
+
Sets and sanitizes the repeats variable.
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.
+
Arguments:
+
+
finished: boolean, whether the song ended via reaching the end.
+
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.
updateDialog
+
+
Updates the window for our users. Override down the line.
update_sustain
+
+
Updates our cached linear/exponential falloff stuff, saving calculations down the line.
Like gallopLeft, except that if the range contains an element equal to
+key, gallopRight returns the index after the rightmost equal element.
Proc Details
gallopRight
+
+
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]
used by /datum/controller/subsystem/spatial_grid to cover every z level so that the coordinates of every turf in the world corresponds to one of these in
+the subsystems list of grid cells by z level. each one of these contains content lists holding all atoms meeting a certain criteria that is in our borders.
+these datums shouldnt have significant behavior, they should just hold data. the lists are filled and emptied by the subsystem.
This datum handles species in the game, such as lizardpeople, mothmen, zombies, skeletons, etc.
+It is used in carbon humans to determine various things about them, like their food preferences, if they have biological genders, their damage resistances, and more.
What gas does this species breathe? Used by suffocation screen alerts, most of actual gas breathing is handled by mutantlungs. See [life.dm][code/modules/mob/living/carbon/human/life.dm]
Bitflag that controls what in game ways something can select this species as a spawnable source, such as magic mirrors. See mob defines for possible sources.
This allows races to have specific hair colors. If null, it uses the H's hair/facial hair colors. If "mutcolor", it uses the H's mutant_color. If "fixedmutcolor", it uses fixedmutcolor
Forces an item into this species' hands. Only an honorary mutantthing because this is not an organ and not loaded in the same way, you've been warned to do your research.
The formatting of the name of the species in plural context. Defaults to "[name]\s" if unset.
+Ex "[Plasmamen] are weak", "[Mothmen] are strong", "[Lizardpeople] don't like", "[Golems] hate"
Given a human, will adjust it before taking a picture for the preferences UI.
+This should create a CONSISTENT result, so the icons don't randomly change.
What gas does this species breathe? Used by suffocation screen alerts, most of actual gas breathing is handled by mutantlungs. See [life.dm][code/modules/mob/living/carbon/human/life.dm]
Bitflag that controls what in game ways something can select this species as a spawnable source, such as magic mirrors. See mob defines for possible sources.
This allows races to have specific hair colors. If null, it uses the H's hair/facial hair colors. If "mutcolor", it uses the H's mutant_color. If "fixedmutcolor", it uses fixedmutcolor
Forces an item into this species' hands. Only an honorary mutantthing because this is not an organ and not loaded in the same way, you've been warned to do your research.
The formatting of the name of the species in plural context. Defaults to "[name]\s" if unset.
+Ex "[Plasmamen] are weak", "[Mothmen] are strong", "[Lizardpeople] don't like", "[Golems] hate"
Does the species use skintones or not? As of now only used by humans.
Proc Details
body_temperature_alerts
+
+
Used to set alerts and debuffs based on body temperature
+vars:
+
+
humi (required) The mob we will targeting
+
body_temperature_core
+
+
Used to stabilize the core temperature back to normal on living mobs
+
The metabolisim heats up the core of the mob trying to keep it at the normal body temp
+vars:
+
+
humi (required) The mob we will stabilize
+
body_temperature_damage
+
+
Used to apply wounds and damage based on core/body temp
+vars:
+
+
humi (required) The mob we will targeting
+
body_temperature_skin
+
+
Used to normalize the skin temperature on living mobs
+
The core temp effects the skin, then the enviroment effects the skin, then we refect that back to the core.
+This happens even when dead so bodies revert to room temp over time.
+vars:
+
+
humi (required) The mob we will targeting
+
+
+
delta_time: The amount of time that is considered as elapsing
+
times_fired: The number of times SSmobs has fired
+
check_roundstart_eligible
+
+
Checks if a species is eligible to be picked at roundstart.
+
Checks the config to see if this species is allowed to be picked in the character setup menu.
+Used by /proc/generate_selectable_species.
copy_properties_from
+
+
Copies some vars and properties over that should be kept when creating a copy of this species.
+
Used by slimepeople to copy themselves, and by the DNA datum to hardset DNA to a species
+Arguments:
+
+
old_species - The species that the carbon used to be before copying
+
create_fresh_body
+
+
Creates body parts for the target completely from scratch based on the species
create_pref_biotypes_perks
+
+
Adds adds any perks related to the species' inherent_biotypes flags.
+
Returns a list containing perks, or an empty list.
create_pref_blood_perks
+
+
Adds adds any perks related to the species' blood (or lack thereof).
+
Returns a list containing perks, or an empty list.
create_pref_damage_perks
+
+
Adds adds any perks related to sustaining damage.
+For example, brute damage vulnerability, or fire damage resistance.
+
Returns a list containing perks, or an empty list.
create_pref_language_perk
+
+
Adds in a language perk based on all the languages the species
+can speak by default (according to their language holder).
+
Returns a list containing perks, or an empty list.
create_pref_temperature_perks
+
+
Adds adds any perks related to how the species deals with temperature.
+
Returns a list containing perks, or an empty list.
create_pref_traits_perks
+
+
Adds adds any perks related to the species' inherent_traits list.
+
Returns a list containing perks, or an empty list.
create_pref_unique_perks
+
+
Used to add any species specific perks to the perk list.
+
Returns null by default. When overriding, return a list of perks.
get_constant_data
+
+
Generates nested lists of constant data for UIs.
get_features
+
+
Returns a list of strings representing features this species has.
+Used by the preferences UI to know what buttons to show.
get_innate_languages
+
+
Returns a list of each language we know innately.
get_perk_data
+
+
Perks of varying types.
+(Postives, neutrals, and negatives)
+in the format of a list of lists.
+Used in the preference menu.
+
"Perk" format is as followed:
+list(
+SPECIES_PERK_TYPE = type of perk (postiive, negative, neutral - use the defines)
+SPECIES_PERK_ICON = icon used, unused due to no longer being on tgui prefs
+SPECIES_PERK_NAME = name of the perk on hover
+SPECIES_PERK_DESC = description of the perk on hover
+)
+
Returns a list of lists.
+The outer list is an assoc list of [perk type]s to a list of perks.
+The innter list is a list of perks. Can be empty, but won't be null.
get_random_blood_type
+
+
Returns a random blood type for this species
get_scream_sound
+
+
Returns the species's scream sound.
get_species_description
+
+
Gets a short description for the specices. Should be relatively succinct.
+Used in the preference menu.
+
Returns a string.
get_species_diet
+
+
Translate the species liked foods from bitfields into strings
+and returns it in the form of an associated list.
+
Returns a list, or null if they have no diet.
get_species_lore
+
+
Gets the lore behind the type of species. Can be long.
+Used in the preference menu.
+
Returns a list of strings.
+Between each entry in the list, a newline will be inserted, for formatting.
give_important_for_life
+
+
Equip the outfit required for life. Replaces items currently worn.
Handles lipstick, having no eyes, eye color, undergarnments like underwear, undershirts, and socks, and body layers.
+Calls [handle_mutant_bodyparts][/datum/species/proc/handle_mutant_bodyparts]
+Arguments:
+
+
species_human - Human, whoever we're handling the body for
+
handle_body_temperature
+
+
Body temperature handler for species
+
These procs manage body temp, bamage, and alerts
+Some of these will still fire when not alive to balance body temp to the room temp.
+vars:
+
+
humi (required)(type: /mob/living/carbon/human) The mob we will target
+
handle_environment
+
+
Environment handler for species
+
vars:
+
+
environment (required) The environment gas mix
+
humi (required)(type: /mob/living/carbon/human) The mob we will target
time_since_irradiated: The amount of time since the mob was first irradiated
+
delta_time: The amount of time that has passed since the last tick
+
harm
+
+
This proc handles punching damage.
on_owner_login
+
+
Owner login
+
A simple proc to be overwritten if something needs to be done when a mob logs in. Does nothing by default.
+
Arguments:
+
+
owner - The owner of our species.
+
on_species_gain
+
+
Proc called when a carbon becomes this species.
+
This sets up and adds/changes/removes things, qualities, abilities, and traits so that the transformation is as smooth and bugfree as possible.
+Produces a COMSIG_SPECIES_GAIN signal.
+Arguments:
+
+
C - Carbon, this is whoever became the new species.
+
old_species - The species that the carbon used to be before becoming this race, used for regenerating organs.
+
pref_load - Preferences to be loaded from character setup, loads in preferred mutant things like bodyparts, digilegs, skin color, etc.
+
on_species_loss
+
+
Proc called when a carbon is no longer this species.
+
This sets up and adds/changes/removes things, qualities, abilities, and traits so that the transformation is as smooth and bugfree as possible.
+Produces a COMSIG_SPECIES_LOSS signal.
+Arguments:
+
+
C - Carbon, this is whoever lost this species.
+
new_species - The new species that the carbon became, used for genetics mutations.
+
pref_load - Preferences to be loaded from character setup, loads in preferred mutant things like bodyparts, digilegs, skin color, etc.
+
pre_equip_species_outfit
+
+
Equips the necessary species-relevant gear before putting on the rest of the uniform.
prepare_human_for_preview
+
+
Given a human, will adjust it before taking a picture for the preferences UI.
+This should create a CONSISTENT result, so the icons don't randomly change.
random_name
+
+
Generates a random name for a carbon.
+
This generates a random unique name based on a human's species and gender.
+Arguments:
+
+
gender - The gender that the name should adhere to. Use MALE for male names, use anything else for female names.
+
unique - If true, ensures that this new name is not a duplicate of anyone else's name currently on the station.
+
lastname - Does this species' naming system adhere to the last name system? Set to false if it doesn't.
+
randomize_active_underwear
+
+
Proc that will randomise the underwear (i.e. top, pants and socks) of a species' associated mob
randomize_main_appearance_element
+
+
Proc that will randomise the hair, or primary appearance element (i.e. for moths wings) of a species' associated mob
regenerate_organs
+
+
Corrects organs in a carbon, removing ones it doesn't need and adding ones it does.
+
Takes all organ slots, removes organs a species should not have, adds organs a species should have.
+can use replace_current to refresh all organs, creating an entirely new set.
+
Arguments:
+
+
C - carbon, the owner of the species datum AKA whoever we're regenerating organs in
+
old_species - datum, used when regenerate organs is called in a switching species to remove old mutant organs.
+
replace_current - boolean, forces all old organs to get deleted whether or not they pass the species' ability to keep that organ
+
excluded_zones - list, add zone defines to block organs inside of the zones from getting handled. see headless mutation for an example
+
visual_only - boolean, only load organs that change how the species looks. Do not use for normal gameplay stuff
+
replace_body
+
+
Handles replacing all of the bodyparts with their species version during set_species()
Currently only used by mutantparts so don't worry about hair and stuff.
+This is the source that this accessory will get its color from. Default is MUTCOLOR, but can also be HAIR, FACEHAIR, EYECOLOR and 0 if none.
Currently only used by mutantparts so don't worry about hair and stuff.
+This is the source that this accessory will get its color from. Default is MUTCOLOR, but can also be HAIR, FACEHAIR, EYECOLOR and 0 if none.
Pause stamina regeneration for some period of time. Does not support doing this from multiple sources at once because I do not do that and I will add it later if I want to.
Pause stamina regeneration for some period of time. Does not support doing this from multiple sources at once because I do not do that and I will add it later if I want to.
resume
+
+
Resume stamina processing
stop
+
+
Stops stamina regeneration entirely until manually resumed.
+
+
+
diff --git a/datum/station_alert.html b/datum/station_alert.html
new file mode 100644
index 000000000000..88a391a76c61
--- /dev/null
+++ b/datum/station_alert.html
@@ -0,0 +1,64 @@
+
+
+
+
+
+
+ /datum/station_alert - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
A combined all in one datum that stores everything about the request, the requester's account, as well as the requestee's account
+All of this is passed to the Request Console UI in order to present in organized way.
For counting up how much of the station exists at the start of the shift, and how much is left behind by the end of it.
+
"For God's sake, please be careful with those fuel tanks, you're going to set them off and compromise the station's integrity."
+"Relax boss, everyone knows this station has no integrity."
+"Yeah, that's why we all like it so much!"
+
+
-Recovered engineering chatter from a destroyed NT station, 2557
When set initially / in on_creation, this is how long the status effect lasts in deciseconds.
+While processing, this becomes the world.time when the status effect will expire.
+-1 = infinite duration.
When set initially / in on_creation, this is how long between [proc/tick] calls in deciseconds.
+While processing, this becomes the world.time when the next tick will occur.
+-1 = will stop processing, if duration is also unlimited (-1).
Called instead of on_remove when a status effect
+of status_type STATUS_EFFECT_REPLACE is replaced by itself,
+or when a status effect with on_remove_on_mob_delete
+set to FALSE has its mob deleted
Called from New() with any supplied status effect arguments.
+Not guaranteed to exist by the end.
+Returning FALSE from on_apply will stop on_creation and self-delete the effect.
Called whenever the buff expires or is removed (qdeleted)
+Note that at the point this is called, it is out of the
+owner's status_effects list, but owner is not yet null
When set initially / in on_creation, this is how long the status effect lasts in deciseconds.
+While processing, this becomes the world.time when the status effect will expire.
+-1 = infinite duration.
When set initially / in on_creation, this is how long between [proc/tick] calls in deciseconds.
+While processing, this becomes the world.time when the next tick will occur.
+-1 = will stop processing, if duration is also unlimited (-1).
Proc Details
be_replaced
+
+
Called instead of on_remove when a status effect
+of status_type STATUS_EFFECT_REPLACE is replaced by itself,
+or when a status effect with on_remove_on_mob_delete
+set to FALSE has its mob deleted
before_remove
+
+
Called before being fully removed (before on_remove)
+Returning FALSE will cancel removal
get_examine_text
+
+
Gets and formats examine text associated with our status effect.
+Return 'null' to have no examine text appear (default behavior).
nextmove_adjust
+
+
Adds nextmove adjustment additiviely to the owner while applied
nextmove_modifier
+
+
Adds nextmove modifier multiplicatively to the owner while applied
on_apply
+
+
Called whenever the effect is applied in on_created
+Returning FALSE will cause it to delete itself during creation instead.
on_creation
+
+
Called from New() with any supplied status effect arguments.
+Not guaranteed to exist by the end.
+Returning FALSE from on_apply will stop on_creation and self-delete the effect.
on_remove
+
+
Called whenever the buff expires or is removed (qdeleted)
+Note that at the point this is called, it is out of the
+owner's status_effects list, but owner is not yet null
refresh
+
+
Called when a status effect of status_type STATUS_EFFECT_REFRESH
+has its duration refreshed in apply_status_effect - is passed New() args
remove_duration
+
+
Remove [seconds] of duration from the status effect, qdeling / ending if we eclipse the current world time.
Stage 2 of being drunk, applied at drunk values between 6 and onward.
+Has all the main side effects of being drunk, scaling up as they get more drunk.
Icon state for overlays applied when the status effect is applied
+States in the file must be given a name, followed by a number which corresponds to a number of stacks.
+Put the state name without the number in these state vars
Icon state for underlays applied when the status effect is applied
+The number is concatonated onto the string based on the number of stacks to get the correct state name.
Icon state for overlays applied when the status effect is applied
+States in the file must be given a name, followed by a number which corresponds to a number of stacks.
+Put the state name without the number in these state vars
Icon state for underlays applied when the status effect is applied
+The number is concatonated onto the string based on the number of stacks to get the correct state name.
Proc Details
add_stacks
+
+
Add (or remove) [stacks_added] stacks to our current stack count.
can_gain_stacks
+
+
Whether the owner can currently gain stacks or not
+Return FALSE if the owner is not in a valid state, or TRUE otherwise
can_have_status
+
+
Whether the owner can have the status effect.
+Return FALSE if the owner is not in a valid state (self-deletes the effect), or TRUE otherwise
fadeout_effect
+
+
Effects that occur if the status is removed due to being under 1 remaining stack
on_threshold_cross
+
+
Called when the stack_threshold is crossed (stacks go over the threshold)
on_threshold_drop
+
+
Called when the stack_threshold is uncrossed / dropped (stacks go under the threshold after being over it)
stack_decay_effect
+
+
Runs every time tick(), causes stacks to decay over time
stacks_consumed_effect
+
+
Effects that occur if the status effect is removed due to the stack_threshold being crossed
threshold_cross_effect
+
+
Effects that occur when the stack count crosses stack_threshold
+
+
+
diff --git a/datum/status_effect/stat_mod.html b/datum/status_effect/stat_mod.html
new file mode 100644
index 000000000000..5215cd847494
--- /dev/null
+++ b/datum/status_effect/stat_mod.html
@@ -0,0 +1,50 @@
+
+
+
+
+
+
+ /datum/status_effect/stat_mod - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Datumized Storage
+Eliminates the need for custom signals specifically for the storage component, and attaches a storage variable (atom_storage) to every atom.
+If you're looking to create custom storage type behaviors, check ../subtypes
A reference to the atom where the items are actually stored.
+By default this is parent. Should generally never be null.
+Sometimes it's not the parent, that's what is called "dissassociated storage".
A reference to the atom where the items are actually stored.
+By default this is parent. Should generally never be null.
+Sometimes it's not the parent, that's what is called "dissassociated storage".
If TRUE, chat messages for inserting/removing items will not be shown.
Proc Details
animate_parent
+
+
Gives a spiffy animation to our parent to represent opening and closing.
attempt_insert
+
+
Attempts to insert an item into the storage
+
@param datum/source used by the signal handler
+@param obj/item/to_insert the item we're inserting
+@param mob/user the user who is inserting the item
+@param override see item_insertion_feedback()
+@param force bypass locked storage
attempt_remove
+
+
Attempts to remove an item from the storage
+
@param obj/item/thing the object we're removing
+@param atom/newLoc where we're placing the item
+@param silent if TRUE, we won't play any exit sounds
+@param user the mob performing the action
can_insert
+
+
Checks if an item is capable of being inserted into the storage
+
@param obj/item/to_insert the item we're checking
+@param messages if TRUE, will print out a message if the item is not valid
+@param force bypass locked storage
can_manipulate_contents
+
+
Check to see if items can be added/removed.
+
@param mob/living/user an optional user
+@param force will bypass most checks
+@param silent will surpress feedback messages
can_see_contents
+
+
Checks who is currently capable of viewing our storage (and is.)
check_slots_full
+
+
Checks if we have enough slots to allow the item inside.
check_total_weight
+
+
Checks if the total weight would exceed our capacity when adding the item.
check_typecache_for_item
+
+
Checks if the item is in our can_hold list.
check_weight_class
+
+
Checks if the item is allowed into storage based on it's weight class
close_all
+
+
Close the storage UI for everyone viewing us.
close_distance
+
+
Signal handler for whenever a mob walks away with us, close if they can't reach us.
collect_on_turf
+
+
Collects every item of a type on a turf.
+
@param obj/item/thing the initial object to pick up
+@param mob/user the user who is picking up the items
contents_for_display
+
+
Returns a list of items to display in the hud
dump_content_at
+
+
Dumps all of our contents at a specific location.
+
@param atom/dest_object where to dump to
+@param mob/user the user who is dumping the contents
generate_hold_desc
+
+
Generates a description, primarily for clothing storage.
get_quickdraw_item
+
+
Returns an item to pull out with the quickdraw interaction.
get_real_location
+
+
Getter for [real_location].
handle_enter
+
+
Automatically ran on all object insertions: flag marking and view refreshing.
handle_exit
+
+
Automatically ran on all object removals: flag marking and view refreshing.
handle_mass_pickup
+
+
Inserts every item in a given list, with a progress bar
+
@param mob/user the user who is inserting the items
+@param list/things the list of items to insert
+@param atom/thing_loc the location of the items (used to make sure an item hasn't moved during pickup)
+@param list/rejections a list used to make sure we only complain once about an invalid insertion
+@param datum/progressbar/progress the progressbar used to show the progress of the insertion
hide_contents
+
+
Hide our storage from a mob.
+
@param mob/toshow the mob to hide the storage from
item_insertion_feedback
+
+
Provides visual feedback in chat for an item insertion
+
@param mob/user the user who is inserting the item
+@param obj/item/thing the item we're inserting
+@param override skip feedback, only do animation check
mass_empty
+
+
Signal handler for remove_all()
on_attack
+
+
Signal handler for whenever we're attacked by a mob.
on_attackby
+
+
Signal handler for whenever we're attacked by an object.
on_emp_act
+
+
Signal handler for the emp_act() of all contents
on_mousedrop_onto
+
+
Signal handler for whenever we drag the storage somewhere.
on_mousedropped_onto
+
+
Signal handler for whenever something gets mouse-dropped onto us.
on_preattack
+
+
Signal handler for preattack from an object.
open_storage
+
+
Opens the storage to the mob, showing them the contents to their UI.
open_storage_attackby_secondary
+
+
Signal handler for when we get attacked with secondary click by an item.
open_storage_on_signal
+
+
Signal handler to open up the storage when we recieve a signal.
orient_item_boxes
+
+
Generates the actual UI objects, their location, and alignments whenever we open storage up.
orient_to_hud
+
+
Updates the storage UI to fit all objects inside storage.
process_numerical_display
+
+
Generates the numbers on an item in storage to show stacking.
put_in_hands_async
+
+
Async version of putting something into a mobs hand.
real_location_gone
+
+
Signal handler for when the real location is deleted.
refresh_views
+
+
Refresh the views of everyone currently viewing the storage.
remove_all
+
+
Removes everything inside of our storage
+
@param atom/target where we're placing the item
remove_and_refresh
+
+
Resets an object, removes it from our screen, and refreshes the view.
+
@param atom/movable/gone the object leaving our storage
remove_type
+
+
Removes only a specific type of item from our storage
+
@param type the type of item to remove
+@param amount how many we should attempt to pick up at one time
+@param check_adjacent if TRUE, we'll check adjacent locations for the item type
+@param force if TRUE, we'll bypass the check_adjacent check all together
+@param mob/user the user who is removing the items
+@param list/inserted a list passed to attempt_remove for ultimate removal
reset_item
+
+
Refreshes and item to be put back into the real world, out of storage.
return_inv
+
+
Recursive proc to get absolutely EVERYTHING inside a storage item, including the contents of inner items.
+
@param list/interface the list we're adding objects to
+@param recursive whether or not we're checking inside of inner items
set_parent
+
+
Set the passed atom as the parent
set_real_location
+
+
Sets where items are physically being stored in the case it shouldn't be on the parent.
+
@param atom/real the new real location of the datum
+@param should_drop if TRUE, all the items in the old real location will be dropped
show_contents
+
+
Show our storage to a mob.
+
@param mob/toshow the mob to show the storage to
toggle_collection_mode
+
+
Toggles the collectmode of our storage.
+
@param mob/toshow the mob toggling us
update_actions
+
+
Updates the action button for toggling collectmode.
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.
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_action
+
+
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_item
+
+
Gets the item from the given source.
get_obscuring
+
+
Returns a STRIPPABLE_OBSCURING_* define to report on whether or not this is obscured.
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.
+
+
+
diff --git a/datum/strippable_item/hand.html b/datum/strippable_item/hand.html
new file mode 100644
index 000000000000..340be7ebf825
--- /dev/null
+++ b/datum/strippable_item/hand.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /datum/strippable_item/hand - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
The specific, occupied family member antagonist datum that is used to reach the handler / check objectives, and from which the above properties (sans points) are inherited.
The specific, occupied family member antagonist datum that is used to reach the handler / check objectives, and from which the above properties (sans points) are inherited.
Proc Details
rename_gangster
+
+
Allow gangs to have custom naming schemes for their gangsters.
User definable callback for executing HTTP GET requests.
+MUST perform BYOND sleeps while the request is in flight.
+MUST return a /datum/tgs_http_result.
+SHOULD log its own errors
Proc Details
PerformGet
+
+
User definable callback for executing HTTP GET requests.
+MUST perform BYOND sleeps while the request is in flight.
+MUST return a /datum/tgs_http_result.
+SHOULD log its own errors
+
url - The full URL to execute the GET request for including query parameters.
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.
close
+
+
public
+
Close the UI.
+
optional can_be_suspended bool
get_payload
+
+
private
+
Package the data to send to the UI, as JSON.
+
return list
on_act_message
+
+
Wrapper for behavior to potentially wait until the next tick if the server is overloaded
on_message
+
+
private
+
Callback for handling incoming tgui messages.
open
+
+
public
+
Open this UI (and initialize it with data).
+
return bool - TRUE if a new pooled window is opened, FALSE in all other situations including if a new pooled window didn't open because one already exists.
process
+
+
private
+
Run an update cycle for this UI. Called internally by SStgui
+every second or so.
process_status
+
+
private
+
Updates the status, and returns TRUE if status has changed.
send_asset
+
+
public
+
Makes an asset available to use in tgui.
+
required asset datum/asset
+
return bool - true if an asset was actually sent
send_full_update
+
+
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.
send_update
+
+
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.
required client /client
+required id string A unique window identifier.
acquire_lock
+
+
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
can_be_suspended
+
+
public
+
Checks if the window can be sanely suspended.
+
return bool
close
+
+
public
+
Close the UI.
+
optional can_be_suspended bool
flush_message_queue
+
+
private
+
Sends queued messages if the queue wasn't empty.
initialize
+
+
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 injec
is_ready
+
+
public
+
Checks if the window is ready to receive data.
+
return bool
on_message
+
+
private
+
Callback for handling incoming tgui messages.
reinitialize
+
+
public
+
Reinitializes the panel with previous data used for initialization.
release_lock
+
+
public
+
Release the window lock.
replace_html
+
+
public
+
Replaces the inline HTML content.
+
required inline_html string HTML to inject
send_asset
+
+
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
send_message
+
+
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.
send_raw_message
+
+
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.
subscribe
+
+
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.
unsubscribe
+
+
public
+
Unsubscribes the datum. Do not forget to call this when cleaning up.
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.
+
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.
getcallingtype
+
+
Returns a string of the type of the callback for this timer
A traitor objective. Traitor objectives should not be deleted after they have been created and established, only failed.
+If a traitor objective needs to be removed from the failed/completed objective list of their handler, then you are doing something wrong
+and you should reconsider. When an objective is failed/completed, that is final and the only way you can change that is by refactoring the code.
Determines the minimum and maximum progression this objective can be worth as a result of being influenced by global progression
+Should only be smaller than or equal to 1
Called when the objective should be generated. Should return if the objective has been successfully generated.
+If false is returned, the objective will be removed as a potential objective for the traitor it is being generated for.
+This is only temporary, it will run the proc again when objectives are generated for the traitor again.
Returns a list of variables that can be changed by config, allows for balance through configuration.
+It is not recommended to finetweak any values of objectives on your server.
Determines the minimum and maximum progression this objective can be worth as a result of being influenced by global progression
+Should only be smaller than or equal to 1
The time at which this objective was first created
Proc Details
completion_payout
+
+
Called when rewards should be given to the user.
fail_objective
+
+
Used to fail objectives. Players can clear completed objectives in the UI
finish_objective
+
+
Called by player input, do not call directly. Validates whether the objective is finished and pays out the handler if it is.
generate_objective
+
+
Called when the objective should be generated. Should return if the objective has been successfully generated.
+If false is returned, the objective will be removed as a potential objective for the traitor it is being generated for.
+This is only temporary, it will run the proc again when objectives are generated for the traitor again.
generate_ui_buttons
+
+
Used for generating the UI buttons for the UI. Use ui_perform_action to respond to clicks.
handle_cleanup
+
+
Used to handle cleaning up the objective.
is_duplicate
+
+
Determines whether this objective is a duplicate. objective_to_compare is always of the type it is being called on.
replace_in_name
+
+
Replaces a word in the name of the proc. Also does it for the description
succeed_objective
+
+
Used to succeed objectives. Allows the player to cash it out in the UI.
supported_configuration_changes
+
+
Returns a list of variables that can be changed by config, allows for balance through configuration.
+It is not recommended to finetweak any values of objectives on your server.
to_debug_string
+
+
Converts the type into a useful debug string to be used for logging and debug display.
ui_perform_action
+
+
Return TRUE to trigger a UI update
ungenerate_objective
+
+
Used to clean up signals and stop listening to states.
update_progression_reward
+
+
Updates the progression reward, scaling it depending on their current progression compared against the global progression
Makes the objective only set heads as targets when true, and block them from being targets when false.
+This also blocks the objective from generating UNTIL the un-heads_of_staff version (WHICH SHOULD BE A DIRECT PARENT) is completed.
+example: calling card objective, you kill someone, you unlock the chance to roll a head of staff target version of calling card.
Makes the objective only set heads as targets when true, and block them from being targets when false.
+This also blocks the objective from generating UNTIL the un-heads_of_staff version (WHICH SHOULD BE A DIRECT PARENT) is completed.
+example: calling card objective, you kill someone, you unlock the chance to roll a head of staff target version of calling card.
The objective category.
+Used to group up entire objectives into 1 weight objects to prevent having a
+higher chance of getting an objective due to an increased number of different objective subtypes.
+These are nothing but informational holders and will have no other purpose.
Allocates an instance of the provided type, and places it somewhere in an available loc
+Instances allocated through this proc will be destroyed when the test is over
Allocates an instance of the provided type, and places it somewhere in an available loc
+Instances allocated through this proc will be destroyed when the test is over
Simple unit test to ensure there's no regression in behaviour where machine frames should not be stacked.
Proc Details
Run
+
+
Simple unit test to ensure there's no regression in behaviour where machine frames should not be stacked.
+
We attempt to use the RCD to build multiple stacked machine frames on a turf. If we end up with any number that
+is not equal to 1, this means we've either built no machine frames (bad) or built more than one (regression).
+
If this is successful, we attempt to spawn in some no-density machines that result in machine frames and we run
+the test again on our turf containing our single frame, deconstructing the machines! This should also not spawn
+any stacked machine frames.
A test to make sure harvesting plants in hydroponics results in the correct number of plants with the correct chemicals inside of it.
Proc Details
Run
+
+
A test to make sure harvesting plants in hydroponics results in the correct number of plants with the correct chemicals inside of it.
+
We plant a seed into a tray and harvest it with a human.
+This seed is set to have the maximum potency and yield with no instability to prevent mutations.
+Then we check how many products we got from the harvest. For most plants, this should be 10 products, as we have a yield of 10.
+Alternatively, if the plant has a trait that halves the products on harvest, it should result in 5 products.
+
After we harvest our seed, we check for the plant's nutriments and vitamins.
+Most plants have nutriments, so most plants should result in a number of nutriments.
+Some plants have vitamins and some don't, so we then check the number of vitamins.
+Additionally, the plant may have traits that double the amount of chemicals it can hold. We check the max volume in that case and adjust accordingly.
+Plants may have additional chemicals genes that we don't check.
+Plants may have traits that effect the final product's contents that we don't check.
+Chemicals may react inside of the plant on harvest, which we don't check.
+
After we check the harvest and the chemicals in the harvest, we go ahead and clean up the harvested products and remove the seed if it has perennial growth.
+
This test checks both /obj/item/food/grown items and /obj/item/grown items since, despite both being used in hydroponics,
+they aren't the same type so everything that works with one isn't guaranteed to work with the other.
Species IDs are used in keyed_list config entries and their config values can either be set implicitly or explicitly.
Proc Details
Run
+
+
Species IDs are used in keyed_list config entries and their config values can either be set implicitly or explicitly.
+
In order to accomplish this, the keyed_list looks for a specific splitter that is meant to separate the key from the value.
+
While it supports multiple instances of the splitter (for example, space) being present, the intent is ambiguous.
+
To combat that, this unit test runs through every species ID and make sure it doesn't contain the splitter character, so
+valid config entries are never ambiguous.
If the view is currently being supressed by some other "monitor"
+For when you want to own the client's eye without fucking with their viewport
+Doesn't make sense for a binocoler to effect your view in a camera console
This client's current zoom level, if it's not being supressed
+If it's 0, we autoscale to the size of the window. Otherwise it's treated as the ratio between
+the pixels on the map and output pixels. Only looks proper nice in increments of whole numbers (iirc)
+Stored here so other parts of the code have a non blocking way of getting a user's functional zoom
If the view is currently being supressed by some other "monitor"
+For when you want to own the client's eye without fucking with their viewport
+Doesn't make sense for a binocoler to effect your view in a camera console
This client's current zoom level, if it's not being supressed
+If it's 0, we autoscale to the size of the window. Otherwise it's treated as the ratio between
+the pixels on the map and output pixels. Only looks proper nice in increments of whole numbers (iirc)
+Stored here so other parts of the code have a non blocking way of getting a user's functional zoom
+
+
+
diff --git a/datum/voice_of_god_command.html b/datum/voice_of_god_command.html
new file mode 100644
index 000000000000..99c4e3f95c50
--- /dev/null
+++ b/datum/voice_of_god_command.html
@@ -0,0 +1,50 @@
+
+
+
+
+
+
+ /datum/voice_of_god_command - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
A weakref holds a non-owning reference to a datum.
+The datum can be referenced again using resolve().
+
To figure out why this is important, you must understand how deletion in
+BYOND works.
+
Imagine a datum as a TV in a living room. When one person enters to watch
+TV, they turn it on. Others can come into the room and watch the TV.
+When the last person leaves the room, they turn off the TV because it's
+no longer being used.
+
A datum being deleted tells everyone who's watching the TV to stop.
+If everyone leaves properly (AKA cleaning up their references), then the
+last person will turn off the TV, and everything is well.
+However, if someone is resistant (holds a hard reference after deletion),
+then someone has to walk in, drag them away, and turn off the TV forecefully.
+This process is very slow, and it's known as hard deletion.
+
This is where weak references come in. Weak references don't count as someone
+watching the TV. Thus, when what it's referencing is destroyed, it will
+hopefully clean up properly, and limit hard deletions.
+
A common use case for weak references is holding onto what created itself.
+For example, if a machine wanted to know what its last user was, it might
+create a var/mob/living/last_user. However, this is a strong reference to
+the mob, and thus will force a hard deletion when that mob is deleted.
+It is often better in this case to instead create a weakref to the user,
+meaning this type definition becomes var/datum/weakref/last_user.
+
A good rule of thumb is that you should hold strong references to things
+that you own. For example, a dog holding a chew toy would be the owner
+of that chew toy, and thus a var/obj/item/chew_toy reference is fine
+(as long as it is cleaned up properly).
+However, a chew toy does not own its dog, so a var/mob/living/dog/owner
+might be inferior to a weakref.
+This is also a good rule of thumb to avoid circular references, such as the
+chew toy example. A circular reference that doesn't clean itself up properly
+will always hard delete.
Causes weather to occur on a z level in certain area types
+
The effects of weather occur across an entire z-level.
+Weather always occurs on different z levels at different times, regardless of weather type.
+Can have custom durations, targets, and can automatically protect indoor areas.
The display name for the wire set shown in station blueprints. Not shown in blueprints if randomize is TRUE or it's an item NT wouldn't know about (Explosives/Nuke). Also used in the hacking interface.
The display name for the wire set shown in station blueprints. Not shown in blueprints if randomize is TRUE or it's an item NT wouldn't know about (Explosives/Nuke). Also used in the hacking interface.
Allows us to lazyload asset datums
+Anything inserted here will fully load if directly gotten
+So this just serves to remove the requirement to load assets fully during init
Initializes any assets that need to be loaded ASAP.
+This houses preference menu assets, since they can be loaded at any time,
+most dangerously before the atoms SS initializes.
+Thus, we want it to fail consistently in CI as if it would've if a player
+opened it up early.
Subsystem exists so we can separately log init time costs from the costs of general operation
+Hopefully this makes sorting out what causes problems when easier
We get our awareness updated by the important recursive contents stuff, here we remove our membership
+We get our awareness updated by the important recursive contents stuff, here we remove our membership
the next unallocated /mob/oranges_ear that we try to allocate to assigned_atom's turf
+the next atom in atoms_that_need_ears an ear assigned to it
+the turf loc of the current assigned_atom. turfs are used to track oranges_ears already assigned to one location so we dont allocate more than one
+because allocating more than one oranges_ear to a given loc wastes view iterations
+verb_manager subsystem just for handling say's
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.
This subsystem strives to make loading large amounts of select objects as smooth at execution as possible
+It preloads a set of types to store, and caches them until requested
+Doesn't catch everything mind, this is intentional. There's many types that expect to either
+A: Not sit in a list for 2 hours, or B: have extra context passed into them, or for their parent to be their location
+You should absolutely not spam this system, it will break things in new and wonderful ways
+S close enough for government work though.
+Fuck you goonstation
returns a GUID like identifier (using a mostly made up record format)
+guids are not on their own suitable for access or security tokens, as most of their bits are predictable.
+(But may make a nice salt to one)
\ref behaviour got changed in 512 so this is necesary to replicate old behaviour.
+If it ever becomes necesary to get a more performant REF(), this lies here in wait
+#define REF(thing) (thing && istype(thing, /datum) && (thing:datum_flags & DF_USE_TAG) && thing:tag ? "[thing:tag]" : "\ref[thing]")
Returns the euclidian square magnitude of a vector of either a list or variadic arguments: VecSquareMag(list(1, 2, 3)) = 14 , VecSquareMag(1, 2, 3) = 14
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.
Allow me to explain
+for some reason, if pick() is passed arglist(args) directly and args contains only one list
+it considers it to be a list of lists
+this means something like _pick(list) would fail
+need to do this instead
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.
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
Step-towards method of determining whether one atom can see another. Similar to viewers()
+note: this is a line of sight algorithm, view() does not do any sort of raycasting and cannot be emulated by it accurately
Center's an image.
+Requires:
+The Image
+The x dimension of the icon file used in the image
+The y dimension of the icon file used in the image
+eg: center_image(image_to_center, 32,32)
+eg2: center_image(image_to_center, 96,96)
We're going to take a list that dictates the pace of speech, and a sentence fragment to say
+Then say() that fragment at that pace
+You can pass in a starting delay to wait before speaking the next sound
Check if there is already a wall item on the turf loc
+floor_loc = floor tile in front of the wall
+dir_toward_wall = direction from the floor tile in front of the wall towards the wall
+check_external = truthy if we should be checking against items coming out of the wall, rather than visually on top of the wall.
The basic chemical bomb proc.
+Combines a set of reagent holders into one holder and reacts it.
+If there are any reagents left over it spreads them across the surrounding environment.
+The maximum volume of the holder is temporarily adjusted to allow for reactions which increase total volume to work at full effectiveness.
+The maximum volume of the holder is then reset to its original value.
Converts RGB shorthands into RGBA matrices complete of constants rows (ergo a 20 keys list in byond).
+if return_identity_on_fail is true, stack_trace is called instead of CRASH, and an identity is returned.
Creates a regular expression to match against the given phobia
+Capture group 2 = the scary word
+Capture group 3 = an optional suffix on the scary word
Selects cinematic to play as part of the cult end depending on the outcome then ends the round afterward
+called either when narsie eats everyone, or when [/proc/begin_the_end()] reaches it's conclusion
Timed action involving at least one mob user and a list of targets. interaction_key is the assoc key under which the do_after is capped under, and the max interaction count is how many of this interaction you can do at once.
Version of view() which ignores darkness, because BYOND doesn't have it (I actually suggested it but it was tagged redundant, BUT HEARERS IS A T- /rant).
Returns a copy of a list where text values (except assoc-keys and string representations of lua-only values) are
+wrapped in quotes and existing quote marks are escaped,
+and nulls are replaced with the string "null"
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
When the AUTOWIKI define is enabled, will generate an output file for tools/autowiki/autowiki.js to consume.
+Autowiki code intentionally still exists even without the define, to ensure developers notice
+when they break it immediately, rather than until CI or worse, call time.
+Returns a string of the autowiki output file
Generate the big list of reagent based reactions.
+style='background-color:#FFEE88;'|{{anchor|Synthetic-derived growth factor}}Synthetic-derived growth factor▮
Overlay cache. Why isn't this just in /obj/machinery/door/airlock? Because its used just a
+tiny bit in door_assembly.dm Refactored so you don't have to make a null copy of airlock
+to get to the damn thing
+Someone, for the love of god, profile this. Is there a reason to cache mutable_appearance
+if so, why are we JUST doing the airlocks when we can put this in mutable_appearance.dm for
+everything
Returns a list with the names of the areas around a center at a certain distance
+Returns the local area if no distance is indicated
+Returns an empty list if the center is null
Returns the top-most atom sitting on the turf.
+For example, using this on a disk, which is in a bag, on a mob,
+will return the mob because it's on the turf.
return first thing in L which has var/varname == value
+this is typecaste as list/L, but you could actually feed it an atom instead.
+completely safe to use
A simpler version of get_flat_human_icon() that uses an existing human as a base to create the icon.
+Does not feature caching yet, since I could not think of a good way to cache them without having a possibility
+of using the cached version when we don't want to, so only use this proc if you just need this flat icon
+generated once and handle the caching yourself if you need to access that icon multiple times, or
+refactor this proc to feature caching of icons.
Returns a list of movable atoms that are hearing sensitive in view_radius and line of sight to source
+the majority of the work is passed off to the spatial grid if view_radius > 0
+because view() isnt a raycasting algorithm, this does not hold symmetry to it. something in view might not be hearable with this.
+if you want that use get_hearers_in_view() - however thats significantly more expensive
returns every hearaing movable in view to the turf of source not taking into account lighting
+useful when you need to maintain always being able to hear something if a sound is emitted from it and you can see it (and youre in range).
+otherwise this is just a more expensive version of get_hearers_in_LOS()
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 ""
Gets the perceived "danger" of radiation pulse, given the threshold to the target.
+Returns a RADIATION_DANGER_* define, see code/__DEFINES/radiation.dm
Finds the distance between two atoms, in pixels
+centered = FALSE counts from turf edge to edge
+centered = TRUE counts from turf center to turf center
+of course mathematically this is just adding world.icon_size on again
Lets the turf this atom's ICON appears to inhabit
+it takes into account:
+Pixel_x/y
+Matrix x/y
+NOTE: if your atom has non-standard bounds then this proc
+will handle it, but:
+if the bounds are even, then there are an even amount of "middle" turfs, the one to the EAST, NORTH, or BOTH is picked
+this may seem bad, but you're atleast as close to the center of the atom as possible, better than byond's default loc being all the way off)
+if the bounds are odd, the true middle turf of the atom is returned
Takes a list of numbers as input, returns the highest value that is cleanly divides them all
+Note: this implementation is expensive as heck for large numbers, I only use it because most of my usecase
+Is < 10 ints
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)
Picks a string of symbols to display as the law number for hacked or ion laws
+is at the start to prevent us from changing say modes via get_message_mode()
Compare source's dir, the clockwise dir of source and the anticlockwise dir of source
+To the opposite dir of the dir returned by get_dir(target,source)
+If one of them is a match, then source is facing target
These are generally cheaper than looping contents so they go first
+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. Mind that diagonals
+cost the same as cardinal moves currently, so paths may look a bit strange, but should still be optimal.
Converts a list into a list of assoc lists of the form ("key" = key, "value" = value)
+so that list keys that are themselves lists can be fully json-encoded
Proc handling the loading of map configs. Will return the default map config using /proc/load_default_map_config if the loading of said file fails for any reason whatsoever, so we always have a working map for the server to run.
Writes to a special log file if the log_suspicious_login config flag is set,
+which is intended to contain all logins that failed under suspicious circumstances.
Move a single element from position from_index within a list, to position to_index
+All elements in the range [1,to_index) before the move will be before the pivot afterwards
+All elements in the range [to_index, L.len+1) before the move will be after the pivot afterwards
+In other words, it's as if the range [from_index,to_index) have been rotated using a <<< operation common to other languages.
+from_index and to_index must be in the range [1,L.len+1]
+This will preserve associations ~Carnie
Move elements [from_index,from_index+len) to [to_index-len, to_index)
+Same as moveElement but for ranges of elements
+This will preserve associations ~Carnie
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
Converts an overlay list into text for debug printing
+Of note: overlays aren't actually mutable appearances, they're just appearances
+Don't have access to that type tho, so this is the best you're gonna get
Return a string for the specified body zone. Should be used for parsing non-instantiated bodyparts, otherwise use /obj/item/bodypart/var/plaintext_zone
Uses funny pass by reference bullshit to take the path created by pathfinding, and insert it into a return list
+We'll be able to use this return list to tell a sleeping proc to continue execution
Picks a random element from a list based on a weighting system.
+For example, given the following list:
+A = 6, B = 3, C = 1, D = 0
+A would have a 60% chance of being picked,
+B would have a 30% chance of being picked,
+C would have a 10% chance of being picked,
+and D would have a 0% chance of being picked.
+You should only pass integers in.
Sends out a pulse of radiation, eminating from the source.
+Radiation is performed by collecting all radiatables within the max range (0 means source only, 1 means adjacent, etc),
+then makes their way towards them. A number, starting at 1, is multiplied
+by the insulation amounts of whatever is in the way (for example, walls lowering it down).
+If this number hits equal or below the threshold, then the target can no longer be irradiated.
+If the number is above the threshold, then the chance is the chance that the target will be irradiated.
+As a consumer, this means that max_range going up usually means you want to lower the threshold too,
+as well as the other way around.
+If max_range is high, but threshold is too high, then it usually won't reach the source at the max range in time.
+If max_range is low, but threshold is too low, then it basically guarantees everyone nearby, even if there's walls
+and such in the way, can be irradiated.
+You can also pass in a minimum exposure time. If this is set, then this radiation pulse
+will not irradiate the source unless they have been around any radioactive source for that
+period of time.
Gets the ban cache of the passed in client
+If the cache has not been generated, we start off a query
+If we still have a query going for this request, we just sleep until it's recieved back
returns nothing with an alert instead of the message if it contains something in the ic filter, and sanitizes normally if the name is fine. It returns nothing so it backs out of the input the same way as if you had entered nothing.
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
Sends a round tip to a target. If selected_tip is null, a random tip will be sent instead (5% chance of it being silly).
+Tips that starts with the @ character won't be html encoded. That's necessary for any tip containing markup tags,
+just make sure they don't also have html characters like <, > and ' which will be garbled.
Shake the camera of the person viewing the mob SO REAL!
+Takes the mob to shake, the time span to shake for, and the amount of tiles we're allowed to shake by in tiles
+Duration isn't taken as a strict limit, since we don't trust our coders to not make things feel shitty. So it's more like a soft cap.
Returns a boolean based on whether or not the string contains a comma or an apostrophe,
+to be used for emotes to decide whether or not to have a space between the name of the user
+and the emote.
Gets cached recipes for a type. This is a method of optimizating recipe lookup. Ugly but gets the job done.
+also WARNING: This will make it so all recipes whose first step is not type checked will not work, which all recipes that I can think of will be.
+If you wish to remove this and GLOB.slapcraft_firststep_recipe_cache should this cause issues, replace the return with GLOB.slapcraft_recipes
Exposes all accessible atoms within some distance of an epicenter to some reagents.
+Does not clear the source reagent holder; that must be done manually if it is desired.
This proc replaces all instances of the "replace" character in "text" with the character in the same position within the "compare" string
+"FFFFFFFFFFFFFFFFF***" and "FFFFFFFFFFFFFFF*****************FFFFFFFFFFFFFFFFFF"
+is "FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF"
Used to get a properly sanitized input, of max_length
+no_trim is self explanatory but it prevents the input from being trimed if you intend to parse newlines or whitespace.
Move elements from [from_index, from_index+len) to [to_index, to_index+len)
+Move any elements being overwritten by the move to the now-empty elements, preserving order
+Note: if the two ranges overlap, only the destination order will be preserved fully, since some elements will be within both ranges ~Carnie
Helper proc that tests to ensure all whiteship templates can spawn at their docking port, and logs their sizes
+This should be a unit test, but too much of our other code breaks during shuttle movement, so not yet, not yet.
Converts a time expressed in deciseconds (like world.time) to the 12-hour time format.
+the format arg is the format passed down to time2text() (e.g. "hh:mm" is hours and minutes but not seconds).
Returns a UI status such that silicons will be able to interact with whatever
+they would have access to if this was a machine. For example, AIs can
+interact if there's cameras with wireless control is enabled.
Returns a UI status such that users with debilitating conditions, such as
+being dead or not having power for silicons, will not be able to interact.
+Being dead will disable UI, being incapacitated will continue updating it,
+and anything else will make it interactive.
Returns a UI status such that users adjacent to source will be able to interact,
+far away users will be able to see, and anyone farther won't see anything.
+Dead users will receive updates no matter what, though you likely want to add
+a [ui_status_only_living] check for finer observer interactions.
Like typesof() or subtypesof(), but returns a typecache instead of a list.
+This time it also uses the associated values given by the input list for the values of the subtypes.
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
Allows us to lazyload asset datums
+Anything inserted here will fully load if directly gotten
+So this just serves to remove the requirement to load assets fully during init
Initializes any assets that need to be loaded ASAP.
+This houses preference menu assets, since they can be loaded at any time,
+most dangerously before the atoms SS initializes.
+Thus, we want it to fail consistently in CI as if it would've if a player
+opened it up early.
A subsystem that processes the propagation and effects of a particular fluid.
+
Both fluid spread and effect processing are handled through a carousel system.
+Fluids being spread and fluids being processed are organized into buckets.
+Each fresh (non-resumed) fire one bucket of each is selected to be processed.
+These selected buckets are then fully processed.
+The next fresh fire selects the next bucket in each set for processing.
+If this would walk off the end of a carousel list we wrap back to the first element.
+This effectively makes each set a circular list, hence a carousel.
Subsystem exists so we can separately log init time costs from the costs of general operation
+Hopefully this makes sorting out what causes problems when easier
Acts as a namespace for movement packet/type related procs
+
Exists to provide an in code implementation of movement looping
+Replaces things like walk() or walk_to(), among others
+
Because we're doing things in engine, we have a lot more control over how different operations are performed
+We also get more say in when things happen, so we can subject movements to the whims of the master controller
+Rather then using a fuck ton of cpu just moving mobs or meteors
+
The goal is to keep the loops themselves reasonably barebone, and implement more advanced behavior and control via the signals
+
This may be bypassed in cases where snowflakes are nessesary, or where performance is important. S not a hard and fast thing
+
Every atom can have a movement packet, which contains information and behavior about currently active loops, and queuing info
+Loops control how movement actually happens. So there's a "move in this direction" loop, a "move randomly" loop
+
You can find the logic for this control in this file
+
Specifics of how different loops operate can be found in the movement_types.dm file, alongside the add to loop helper procs that use them
We get our awareness updated by the important recursive contents stuff, here we remove our membership
+We get our awareness updated by the important recursive contents stuff, here we remove our membership
a gamewide grid of spatial_grid_cell datums, each "covering" SPATIAL_GRID_CELLSIZE ^ 2 turfs.
+each spatial_grid_cell datum stores information about what is inside its covered area, so that searches through that area dont have to literally search
+through all turfs themselves to know what is within it since view() calls are expensive, and so is iterating through stuff you dont want.
+this allows you to only go through lists of what you want very cheaply.
+
you can also register to objects entering and leaving a spatial cell, this allows you to do things like stay idle until a player enters, so you wont
+have to use expensive view() calls or iteratite over the global list of players and call get_dist() on every one. which is fineish for a few things, but is
+k * n operations for k objects iterating through n players.
+
currently this system is only designed for searching for relatively uncommon things, small subsets of /atom/movable.
+dont add stupid shit to the cells please, keep the information that the cells store to things that need to be searched for often
+
The system currently implements two different "classes" of spatial type
The second pattern is more paired down, and supports more wide use.
+Rather then the object and anything the object is in being sensitive, it's limited to just the object itself
+Currently only SPATIAL_GRID_CONTENTS_TYPE_ATMOS uses this pattern. This is because it's far more common, and so worth optimizing
the next unallocated /mob/oranges_ear that we try to allocate to assigned_atom's turf
+the next atom in atoms_that_need_ears an ear assigned to it
+the turf loc of the current assigned_atom. turfs are used to track oranges_ears already assigned to one location so we dont allocate more than one
+because allocating more than one oranges_ear to a given loc wastes view iterations
+verb_manager subsystem just for handling say's
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.
This subsystem strives to make loading large amounts of select objects as smooth at execution as possible
+It preloads a set of types to store, and caches them until requested
+Doesn't catch everything mind, this is intentional. There's many types that expect to either
+A: Not sit in a list for 2 hours, or B: have extra context passed into them, or for their parent to be their location
+You should absolutely not spam this system, it will break things in new and wonderful ways
+S close enough for government work though.
+Fuck you goonstation
Typecache of all objects that we seek out to apply a neighbor stripe overlay
Proc Details
Atan2
+
+
The 2-argument arctangent of x and y
GUID
+
+
returns a GUID like identifier (using a mostly made up record format)
+guids are not on their own suitable for access or security tokens, as most of their bits are predictable.
+(But may make a nice salt to one)
GenerateRoundAsteroid
+
+
Generates a circular asteroid.
GetBestWeapon
+
+
Returns either the best weapon from the given choices or null if held weapons are better
Gibberish
+
+
Turn text into complete gibberish!
+
text is the inputted message, replace_characters will cause original letters to be replaced and chance are the odds that a character gets modified.
HandleUserlessProcCall
+
+
Handles a userless proccall, used by circuits.
+
Arguments:
+
+
user - a string used to identify the user
+
target - the target to proccall on
+
proc - the proc to call
+
arguments - any arguments
+
HandleUserlessSDQL
+
+
Handles a userless sdql, used by circuits and tgs.
+
Arguments:
+
+
user - a string used to identify the user
+
query_text - the query text
+
HeapPathWeightCompare
+
+
TODO: Macro this to reduce proc overhead
Interpolate
+
+
Returns a linear interpolation from a to b according to weight. weight 0 is a, weight 1 is b, weight 0.5 is half-way between the two.
IsEdible
+
+
returns if something can be consumed, drink or food
Mean
+
+
Returns the mean of either a list or variadic arguments: Mean(list(1, 2, 3)) = 2 , Mean(1, 2, 3) = 2
REF
+
+
\ref behaviour got changed in 512 so this is necesary to replicate old behaviour.
+If it ever becomes necesary to get a more performant REF(), this lies here in wait
+#define REF(thing) (thing && istype(thing, /datum) && (thing:datum_flags & DF_USE_TAG) && thing:tag ? "[thing:tag]" : "\ref[thing]")
ReserveTurfsForAsteroidGeneration
+
+
Sanitizes a block of turfs to prevent writing over undesired locations
RoundDiagBar
+
+
Diagnostic HUDs!
VecMag
+
+
Returns the euclidian magnitude of a vector of either a list or variadic arguments: VecMag(list(3, 4)) = 5 , VecMag(3, 4) = 5
VecSquareMag
+
+
Returns the euclidian square magnitude of a vector of either a list or variadic arguments: VecSquareMag(list(1, 2, 3)) = 14 , VecSquareMag(1, 2, 3) = 14
WEAKREF
+
+
Creates a weakref to the given input.
+See /datum/weakref's documentation for more information.
WrapAdminProcCall
+
+
Wrapper for proccalls where the datum is flagged as vareditted
___TraitAdd
+
+
DO NOT USE ___TraitAdd OR ___TraitRemove as a replacement for ADD_TRAIT / REMOVE_TRAIT defines. To be used explicitly for callback.
___TraitRemove
+
+
DO NOT USE ___TraitAdd OR ___TraitRemove as a replacement for ADD_TRAIT / REMOVE_TRAIT defines. To be used explicitly for callback.
______qdel_list_wrapper
+
+
the underscores are to encourage people not to use this directly.
_addtimer
+
+
Create a new timer and insert it in the queue.
+You should not call this directly, and should instead use the addtimer macro, which includes source information.
+
Arguments:
+
+
callback the callback to call on timer finish
+
wait deciseconds to run the timer for
+
flags flags for this timer, see: code__DEFINES\subsystems.dm
+
timer_subsystem the subsystem to insert this timer into
+
_alert_drones
+
+
Broadcast a message to all drones in a faction
+
Arguments:
+
+
msg - The message to send
+
dead_can_hear - Boolean that determines if ghosts can hear the message (FALSE by default)
Allow me to explain
+for some reason, if pick() is passed arglist(args) directly and args contains only one list
+it considers it to be a list of lists
+this means something like _pick(list) would fail
+need to do this instead
+
I hate this timeline
_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.
+
returns TRUE if the queuing was successful, FALSE otherwise.
aas_mass_pda_message
+
+
Get an announcement system and call mass_pda_message()
aas_pda_message
+
+
Get an announcement system and call pda_message()
aas_pda_message_department
+
+
Send an ASS pda message to an entire department
aas_pda_message_name
+
+
Send an ASS pda message to a given name
above_neck
+
+
Would this zone be above the neck
actionspeed_data_null_check
+
+
Checks if a action speed modifier is valid and not missing any data
active_free_borgs
+
+
Silicon Mob Procs
add_keybinding
+
+
Adds an instanced keybinding to the global tracker
add_memory_in_range
+
+
Adds a memory to people that can see this happening, only use this for impactful or rare events to reduce overhead.
add_verb
+
+
handles adding verbs and updating the stat panel browser
+
pass the verb type path to this instead of adding it directly to verbs so the statpanel can update
+Arguments:
+
+
target - Who the verb is being added to, client or mob typepath
+
verb - typepath to a verb, or a list of verbs, supports lists of lists
+
bypass_restricted - Whether or not to bypass client.restricted_mode
+
admin_pm_href
+
+
Returns an adminpm link with the inserted HTML.
adminscrub
+
+
Runs STRIP_HTML_SIMPLE and byond's sanitization proc.
alone_in_area
+
+
Checks if the mob provided (must_be_alone) is alone in an area
announce_arrival
+
+
Send a message in common radio when a player arrives
anyprob
+
+
chances are 1:value. anyprob(1) will always return true
assert_sorted
+
+
Runtimes if the passed in list is not sorted
assoc_to_keys
+
+
Turns an associative list into a flat list of keys
atmos_scan
+
+
Outputs a message to the user describing the target's gasmixes.
+
Gets called by analyzer_act, which in turn is called by tool_act.
+Also used in other 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
baseturfs_string_list
+
+
A wrapper for baseturf string lists, to offer support of non list values, and a stack_trace if we have major issues
begin_the_end
+
+
Begins the process of ending the round via cult narsie win
+Consists of later called procs (in order of called):
+
+
[/proc/narsie_end_begin_check()]
+
[/proc/narsie_end_second_check()]
+
[/proc/narsie_start_destroy_station()]
+
[/proc/narsie_apocalypse()]
+
[/proc/narsie_last_second_win()]
+
[/proc/cult_ending_helper()]
+
bit_count
+
+
counts the number of bits in Byond's 16-bit width field, in constant time and memory!
bitfield_to_list
+
+
Converts a bitfield to a list of numbers (or words if a wordlist is provided)
body_zone2cover_flags
+
+
For finding out what body parts a body zone covers, the inverse of the below basically
build_exploration_site_ui_data
+
+
Helper proc for exploration site listings in ui.
build_medicine_reagents
+
+
Just grab every craftable medicine you can think off
calculate_projectile_angle_and_pixel_offsets
+
+
Calculates the pixel offsets and angle that a projectile should be launched at.
+
Arguments:
+
+
source: The thing that the projectile is being shot from.
+
target: (Optional) The thing that the projectile is being shot at.
+
+
If this is not provided the source atom must be a mob with a client.
+
+
+
modifiers: A list of click parameters used to modify the shot angle.
+
call_emergency_meeting
+
+
If the announcer overrides alert messages, use that message.
+Summon the crew for an emergency meeting
+
Teleports the crew to a specified area, and tells everyone (via an announcement) who called the meeting. Should only be used during april fools!
+Arguments:
+
+
user - Mob who called the meeting
+
button_zone - Area where the meeting was called and where everyone will get teleported to
+
callback_select
+
+
Runs a list of callbacks asyncronously, returning only when all have finished
+
Callbacks can be repeated, to call it multiple times
+
Arguments:
+
+
list/callbacks the list of callbacks to be called
+
list/callback_args the list of lists of arguments to pass into each callback
+
savereturns Optionally save and return the list of returned values from each of the callbacks
+
resolution The number of byond ticks between each time you check if all callbacks are complete
+
can_see
+
+
Step-towards method of determining whether one atom can see another. Similar to viewers()
+note: this is a line of sight algorithm, view() does not do any sort of raycasting and cannot be emulated by it accurately
center_image
+
+
Center's an image.
+Requires:
+The Image
+The x dimension of the icon file used in the image
+The y dimension of the icon file used in the image
+eg: center_image(image_to_center, 32,32)
+eg2: center_image(image_to_center, 96,96)
chatter_speak
+
+
We're going to take a list that dictates the pace of speech, and a sentence fragment to say
+Then say() that fragment at that pace
+You can pass in a starting delay to wait before speaking the next sound
cheap_hypotenuse
+
+
Calculate the hypotenuse cheaply (this should be in maths.dm)
check_asay_links
+
+
Checks a given message to see if any of the words are something we want to treat specially, as detailed below.
+
There are 3 cases where a word is something we want to act on
+
+
Admin pings, like @adminckey. Pings the admin in question, text is not clickable
+
Datum refs, like @0x2001169 or @mob_23. Clicking on the link opens up the VV for that datum
+
Ticket refs, like #3. Displays the status and ahelper in the link, clicking on it brings up the ticket panel for it.
+Returns a list being used as a tuple. Index ASAY_LINK_NEW_MESSAGE_INDEX contains the new message text (with clickable links and such)
+while index ASAY_LINK_PINGED_ADMINS_INDEX contains a list of pinged admin clients, if there are any.
+
+
Arguments:
+
+
msg - the message being scanned
+
check_target_facings
+
+
Returns the direction that the initiator and the target are facing
check_wall_item
+
+
Check if there is already a wall item on the turf loc
+floor_loc = floor tile in front of the wall
+dir_toward_wall = direction from the floor tile in front of the wall towards the wall
+check_external = truthy if we should be checking against items coming out of the wall, rather than visually on top of the wall.
chem_splash
+
+
The basic chemical bomb proc.
+Combines a set of reagent holders into one holder and reacts it.
+If there are any reagents left over it spreads them across the surrounding environment.
+The maximum volume of the holder is temporarily adjusted to allow for reactions which increase total volume to work at full effectiveness.
+The maximum volume of the holder is then reset to its original value.
+
Arguments:
+
+
epicenter: The epicenter of the splash if some of the reagents aren't consumed.
+
holder: The holder to combine all of the reagents into. A temporary one is created if this is null.
+
[reactants][/list/datum/reagents]: The set of reagent holders to combine.
+
extra_heat: Some amount to heat the combined reagents by before reacting them.
+
threatscale: A multiplier for the reagent quantities involved.
+
adminlog: Whether to alert the admins that this has occured.
+
circle_range
+
+
Returns all atoms present in a circle around the center
circle_range_turfs
+
+
Returns a list of turfs around a center based on RANGE_TURFS()
circle_view
+
+
Returns all atoms present in a circle around the center but uses view() instead of range() (Currently not used)
circle_view_turfs
+
+
Returns a list of turfs around a center based on view()
cmp_bodypart_by_body_part_asc
+
+
Orders bodyparts by their body_part value, ascending.
cmp_bodyparts_display_order
+
+
Orders bodyparts by how they should be shown to players in a UI
cmp_codex_name
+
+
Orders codex entries by name alphabetically
cmp_crafting_req_priority
+
+
Sorts crafting recipe requirements before the crafting recipe is inserted into GLOB.crafting_recipes
+
Prioritises /datum/reagent to ensure reagent requirements are always processed first when crafting.
+This prevents any reagent_containers from being consumed before the reagents they contain, which can
+lead to runtimes and item duplication when it happens.
cmp_design_name
+
+
Orders designs by name
cmp_fusion_reaction_des
+
+
Orders R-UST fusion by priority
cmp_heretic_knowledge
+
+
Orders heretic knowledge by priority
cmp_list_length
+
+
Orders lists by the size of lists in their contents
cmp_port_order_asc
+
+
Orders by integrated circuit weight
cmp_pref_modules
+
+
Sort modules by priority
cmp_uplink_category_desc
+
+
Orders by uplink category weight
cmp_zm_render_order
+
+
Sort by plane, then by layer. Approximately BYOND rendering order.
color_list_to_string
+
+
Turns a list such as ("#FFFFFF", #00FFFF) into a color string of "#FFFFFF#00FFFF"
color_string_to_list
+
+
Turns a color string such as "#FFFFFF#00FFFF" into a list of ("#FFFFFF", #00FFFF)
color_to_full_rgba_matrix
+
+
Converts RGB shorthands into RGBA matrices complete of constants rows (ergo a 20 keys list in byond).
+if return_identity_on_fail is true, stack_trace is called instead of CRASH, and an identity is returned.
colorize_string
+
+
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:
+
+
name - The name to generate a color for
+
sat_shift - A value between 0 and 1 that will be multiplied against the saturation
+
lum_shift - A value between 0 and 1 that will be multiplied against the luminescence
+
compare_list
+
+
compare two lists, returns TRUE if they are the same
considered_afk
+
+
Checks if a player is considered AFK
considered_alive
+
+
Returns true if the mob that a player is controlling is alive
considered_exiled
+
+
Exiled check
+
Checks if the current body of the mind has an exile implant and is currently in
+an away mission. Returns FALSE if any of those conditions aren't met.
construct_phobia_regex
+
+
Creates a regular expression to match against the given phobia
+Capture group 2 = the scary word
+Capture group 3 = an optional suffix on the scary word
convert_integer_to_words
+
+
Takes an integer up to 999,999,999 and returns it in words. Works with negative numbers and 0.
+
Arguments:
+
+
number - Integer up to 999,999,999 to convert.
+
capitalise - Whether the number it returns should be capitalised or not, e.g. "Eighty Million" vs. "eighty million".
+
convert_ph_to_readable_color
+
+
Converts the pH into a tgui readable color - i.e. white and black text is readable over it. This is NOT the colourwheel for pHes however.
count_by_type
+
+
return the amount of items of the same type inside a list
create_mafia_game
+
+
Creates the global datum for playing mafia games, destroys the last if that's required and returns the new.
create_strippable_list
+
+
Creates an assoc list of keys to /datum/strippable_item
cult_ending_helper
+
+
Selects cinematic to play as part of the cult end depending on the outcome then ends the round afterward
+called either when narsie eats everyone, or when [/proc/begin_the_end()] reaches it's conclusion
cut_relative_direction
+
+
Takes a screen_loc string and cut out any directions like NORTH or SOUTH
debug_variable
+
+
Get displayed variable in VV variable list
deep_compare_list
+
+
Compares 2 lists, returns TRUE if they are the same
deep_copy_list
+
+
Copies a list, and all lists inside it recusively
+Does not copy any other reference type
default_ui_state
+
+
The sane defaults for a UI such as a computer or a machine.
delete_all_SS_and_recreate_master
+
+
Delete all existing SS to basically start over
deltimer
+
+
Delete a timer
+
Arguments:
+
+
id a timerid or a /datum/timedevent
+
deprecise_zone
+
+
Takes a zone and returns it's "parent" zone, if it has one.
dice_outcome_map
+
+
Certified LummoxJR code, this returns an array which is a map of outcomes to roll [index] value.
dice_probability
+
+
Returns a number between 0 and 100 to roll the desired value when rolling the given dice.
display_energy
+
+
Format an energy value measured in Power Cell units.
display_joules
+
+
Format an energy value in J, kJ, MJ, or GJ. 1W = 1J/s.
display_power
+
+
Format a power value in W, kW, MW, or GW.
do_after
+
+
Timed action involving one mob user. Target is optional, defaulting to user.
+
Checks that user does not move, change hands, get stunned, etc. for the
+given time. Returns TRUE on success or FALSE on failure.
+Interaction_key is the assoc key under which the do_after is capped, with max_interact_count being the cap. Interaction key will default to target if not set.
do_after_mob
+
+
Timed action involving at least one mob user and a list of targets. interaction_key is the assoc key under which the do_after is capped under, and the max interaction count is how many of this interaction you can do at once.
do_chem_smoke
+
+
Helper to quickly create a cloud of reagent smoke
do_smoke
+
+
A helper proc used to spawn small puffs of smoke.
+
Arguments:
+
+
range: The amount of smoke to produce as number of steps from origin covered.
+
amount: The amount of smoke to produce as the total desired coverage area. Autofilled from the range arg if not set.
+
location: Where to produce the smoke cloud.
+
smoke_type: The smoke typepath to spawn.
+
dview
+
+
Version of view() which ignores darkness, because BYOND doesn't have it (I actually suggested it but it was tagged redundant, BUT HEARERS IS A T- /rant).
dyn_explosion
+
+
Using default dyn_ex scale:
+
100 explosion power is a (5, 10, 20) explosion.
+75 explosion power is a (4, 8, 17) explosion.
+50 explosion power is a (3, 7, 14) explosion.
+25 explosion power is a (2, 5, 10) explosion.
+10 explosion power is a (1, 3, 6) explosion.
+5 explosion power is a (0, 1, 3) explosion.
+1 explosion power is a (0, 0, 1) explosion.
+
Arguments:
+
+
epicenter: Turf the explosion is centered at.
+
power - Dyn explosion power. See reference above.
+
flame_range: Flame range. Equal to the equivalent of the light impact range multiplied by this value.
+
flash_range: The range at which the explosion flashes people. Equal to the equivalent of the light impact range multiplied by this value.
+
adminlog: Whether to log the explosion/report it to the administration.
+
ignorecap: Whether to ignore the relevant bombcap. Defaults to FALSE.
+
flame_range: The range at which the explosion should produce hotspots.
+
silent: Whether to generate/execute sound effects.
+
smoke: Whether to generate a smoke cloud provided the explosion is powerful enough to warrant it.
+
explosion_cause: [Optional] The atom that caused the explosion, when different to the origin. Used for logging.
Returns a copy of a list where text values (except assoc-keys and string representations of lua-only values) are
+wrapped in quotes and existing quote marks are escaped,
+and nulls are replaced with the string "null"
end_cooldown
+
+
Callback called by a timer to end an associative-list-indexed cooldown.
+
Arguments:
+
+
source - datum storing the cooldown
+
index - string index storing the cooldown on the cooldowns associative list
+
+
This sends a signal reporting the cooldown end.
english_list
+
+
Returns a list in plain english as a string
expand_three_digit_color
+
+
Given a 3 character color (no hash), converts it into #RRGGBB (with hash)
expand_weights
+
+
Takes a weighted list (see above) and expands it into raw entries
+This eats more memory, but saves time when actually picking from it
devastation_range: The range at which the effects of the explosion are at their strongest.
+
heavy_impact_range: The range at which the effects of the explosion are relatively severe.
+
light_impact_range: The range at which the effects of the explosion are relatively weak.
+
flash_range: The range at which the explosion flashes people.
+
adminlog: Whether to log the explosion/report it to the administration.
+
ignorecap: Whether to ignore the relevant bombcap. Defaults to FALSE.
+
flame_range: The range at which the explosion should produce hotspots.
+
silent: Whether to generate/execute sound effects.
+
smoke: Whether to generate a smoke cloud provided the explosion is powerful enough to warrant it.
+
explosion_cause: [Optional] The atom that caused the explosion, when different to the origin. Used for logging.
+
filter_gas
+
+
Just transfer it, who really cares at a scale this small.
find_obstruction_free_location
+
+
Find an obstruction free turf that's within the range of the center. Can also condition on if it is of a certain area type.
find_reagent
+
+
Returns reagent datum from typepath
findname
+
+
Find if the message has the real name of any user mob in the mob_list
finish_unequip_mob
+
+
A utility function for /datum/strippable_items to finish unequipping an item from a mob.
firing_squad
+
+
firing_squad is a proc for the :B:erforate smite to shoot each individual bullet at them, so that we can add actual delays without sleep() nonsense
+
Hilariously, if you drag someone away mid smite, the bullets will still chase after them from the original spot, possibly hitting other people. Too funny to fix imo
+
Arguments:
+
+
target- guy we're shooting obviously
+
source_turf- where the bullet begins, preferably on a turf next to the target
+
body_zone- which bodypart we're aiming for, if there is one there
+
damage- the damage we're assigning to the bullet, since we don't care about the base one
+
first_day_of_month
+
+
Returns the first day of the given year and month in number format, from 1 (monday) - 7 (sunday).
flash_color
+
+
Flash a color on the client
flatten_list
+
+
Flattens a keyed list into a list of it's contents
flick_overlay
+
+
Add an image to a list of clients and calls a proc to remove it after a duration
flick_overlay_static
+
+
Flickers an overlay on an atom
flick_overlay_view
+
+
wrapper for flick_overlay(), flicks to everyone who can see the target atom
flop_animation
+
+
This animation should be applied to actual parent atom instead of vc_object.
format_frequency
+
+
Format frequency by moving the decimal.
format_text
+
+
Properly format a string of text by using replacetext()
gas_mixture_parser
+
+
+
A simple rudimentary gasmix to information list converter. Can be used for UIs.
Returns: A list parsed_gasmixes with the following structure:
+
+
+
parsed_gasmixes Value: Assoc List Desc: The thing we return
+
+
+
-- Key: name Value: String Desc: Gasmix Name
+
-- Key: temperature Value: Number Desc: Temperature in kelvins
+
-- Key: volume Value: Number Desc: Volume in liters
+
-- Key: pressure Value: Number Desc: Pressure in kPa
+
-- Key: ref Value: String Desc: The reference for the instantiated gasmix.
+
-- Key: gases Value: Numbered list Desc: List of gasses in our gasmix
+
--- Key: 1 Value: String Desc: gas id var from the gas
+
--- Key: 2 Value: String Desc: Human readable gas name.
+
--- Key: 3 Value: Number Desc: Mol amount of the gas.
+
-- Key: gases Value: Numbered list Desc: Assoc list of reactions that occur inside.
+
--- Key: 1 Value: String Desc: reaction id var from the gas.
+
--- Key: 2 Value: String Desc: Human readable reaction name.
+
--- Key: 3 Value: Number Desc: The number associated with the reaction.
+
Returned list should always be filled with keys even if value are nulls.
+
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
generate_asset_name
+
+
Generate a filename for this asset
+The same asset will always lead to the same asset name
+(Generated names do not include file extention.)
generate_autowiki_output
+
+
When the AUTOWIKI define is enabled, will generate an output file for tools/autowiki/autowiki.js to consume.
+Autowiki code intentionally still exists even without the define, to ensure developers notice
+when they break it immediately, rather than until CI or worse, call time.
+Returns a string of the autowiki output file
generate_bitfields
+
+
Turns /datum/bitfield subtypes into a list for use in debugging
generate_chemwiki_line
+
+
Generate the big list of reagent based reactions.
+style='background-color:#FFEE88;'|{{anchor|Synthetic-derived growth factor}}Synthetic-derived growth factor▮
generate_cult_rune_types
+
+
Returns an associated list of rune types. [rune.cultist_name] = [typepath]
generate_generator_index
+
+
Creates generator__id => type map.
generate_icon_alpha_mask
+
+
Helper proc to generate a cutout alpha mask out of an icon.
+
Why is it a helper if it's so simple?
+
Because BYOND's documentation is hot garbage and I don't trust anyone to actually
+figure this out on their own without sinking countless hours into it. Yes, it's that
+simple, now enjoy.
+
But why not use filters?
+
Filters do not allow for masks that are not the exact same on every dir. An example of a
+need for that can be found in [/proc/generate_left_leg_mask()].
+
Arguments:
+
+
icon_to_mask - The icon file you want to generate an alpha mask out of.
+
icon_state_to_mask - The specific icon_state you want to generate an alpha mask out of.
+
+
Returns an /icon that is the alpha mask of the provided icon and icon_state.
generate_items_inside
+
+
Creates new items inside an atom based on a list
generate_paperwork
+
+
We only send to one fax machine in an area
generate_selectable_species
+
+
Generates species available to choose in character setup at roundstart
+
This proc generates which species are available to pick from in character setup.
+If there are no available roundstart species, defaults to human.
get
+
+
Returns the atom type in the specified loc
getFlatIcon
+
+
Only the first argument is required.
get_active_player_count
+
+
Get active players who are playing in the round
get_adjacent_areas
+
+
Returns a list of all areas that are adjacent to the center atom's area, clear the list of nulls at the end.
get_adjacent_open_areas
+
+
Returns a list with all the adjacent areas by getting the adjacent open turfs
get_adjacent_open_turfs
+
+
Returns a list with all the adjacent open turfs.
get_airlock_overlay
+
+
Overlay cache. Why isn't this just in /obj/machinery/door/airlock? Because its used just a
+tiny bit in door_assembly.dm Refactored so you don't have to make a null copy of airlock
+to get to the damn thing
+Someone, for the love of god, profile this. Is there a reason to cache mutable_appearance
+if so, why are we JUST doing the airlocks when we can put this in mutable_appearance.dm for
+everything
get_allowed_instrument_ids
+
+
Get all non admin_only instruments as a list of text ids.
get_angle
+
+
Calculate the angle between two points and the west|east coordinate
get_area_name
+
+
Returns the name of the area the atom is in
get_areas_in_range
+
+
Returns a list with the names of the areas around a center at a certain distance
+Returns the local area if no distance is indicated
+Returns an empty list if the center is null
get_atom_on_turf
+
+
Returns the top-most atom sitting on the turf.
+For example, using this on a disk, which is in a bag, on a mob,
+will return the mob because it's on the turf.
+
Arguments
+
+
something_in_turf - a movable within the turf, somewhere.
+
stop_type - optional - stops looking if stop_type is found in the turf, returning that type (if found).
+
get_bbox_of_atoms
+
+
Get a bounding box of a list of atoms.
+
Arguments:
+
+
atoms - List of atoms. Can accept output of view() and range() procs.
+
+
Returns: list(x1, y1, x2, y2)
get_cached_actionspeed_modifier
+
+
Grabs a STATIC MODIFIER datum from cache. YOU MUST NEVER EDIT THESE DATUMS, OR IT WILL AFFECT ANYTHING ELSE USING IT TOO!
get_cached_movespeed_modifier
+
+
Grabs a STATIC MODIFIER datum from cache. YOU MUST NEVER EDIT THESE DATUMS, OR IT WILL AFFECT ANYTHING ELSE USING IT TOO!
get_cardinal_dir
+
+
Get the cardinal direction between two atoms
get_chem_id
+
+
Returns reagent datum from reagent name string
get_closest_atom
+
+
Returns the closest atom of a specific type in a list from a source
get_consistent_feature_entry
+
+
Takes in an accessory list and returns the first entry from that list, ensuring that we dont return SPRITE_ACCESSORY_NONE in the process.
Returns the manhattan distance between two atoms. Returns INFINITY if either are not on a turf, for BYOND get_dist() parity.
get_distribution
+
+
This is a pretty complicated algorithm, but it's one I'm rather proud of.
+
This is the function that is responsible for taking the list of preferences,
+and spitting out what to put them in.
+
However, it should, wherever possible, prevent solo departments.
+That means that if there's one medical officer, and one engineering officer,
+that they should be put onto the same department (either medical or engineering).
+
The first step is to get the "distribution". This describes how many officers
+should be in each department, no matter what they are.
+This is handled in get_distribution. Examples of inputs/outputs are:
+get_distribution(1, 4) => [1]
+get_distribution(2, 4) => [2]
+get_distribution(3, 4) => [3] # If this returned [2, 1], then we'd get a loner.
+get_distribution(4, 4) => [2, 2] # We have enough to put into a separate group
+
Once this distribution is received, the next step is to figure out where to put everyone.
+
If all members have no preference, just make one an unused department (from the departments argument).
+Then, call ourselves again.
+
Order the groups from most populated to least.
+
If the top group has enough officers who actually want that department, then we give it to them.
+If there are any leftovers (for example, if 3 officers want medical, but we only want 2), then we
+update those to have no preference instead.
+
If the top group does NOT have enough officers, then we kill the least popular group by setting
+them all to have no preference.
+
Anyone in the most popular group will be removed from the list, and the final tally will be updated.
+In the case of not having enough officers, this is a no-op, as there won't be any in the most popular group yet.
+
If there are any candidates left, then we call the algorithm again, but for everyone who hasn't been selected yet.
+We take the results from that run, and put them in the correct order.
+
As an example, let's assume we have the following preferences:
+[engineer, medical, medical, medical, medical, cargo]
+
The distribution of this is [2, 2, 2], meaning there will be 3 departments chosen and they will have 2 each.
+We order from most popular to least popular and get:
+
+
medical: 4
+
engineer: 1
+
cargo: 1
+
+
We need 2 to fill the first group. There are enough medical staff to do it. Thus, we take the first 2 medical staff
+and update the output, making it now: [engineer, medical, medical, ?, ?, cargo].
+
The remaining two want-to-be-medical officers are now updated to act as no preference. We run the algorithm again.
+This time, are candidates are [engineer, none, none, cargo].
+The distribution of this is [2, 2]. The frequency is:
+
+
engineer: 1
+
cargo: 1
+
no preference: 2
+
+
We need 2 to fill the engineering group, but only have one who wants to do it.
+We have enough no preferences for it, making our result: [engineer, engineer, none, cargo].
+We run the algorithm again, but this time with: [none, cargo].
+Frequency is:
+
+
cargo: 1
+
no preference: 1
+Enough to fill cargo, etc, and we get [cargo, cargo].
+
+
These are all then compounded into one list.
+
In the case that all are no preference, it will pop the last department, and use that.
+For example, if departments is [engi, medical, cargo], and we have the preferences:
+[none, none, none]...
+Then we will just give them all cargo.
+
One of the most important parts of this algorithm is IT IS DETERMINISTIC.
+That means that this proc is 100% testable.
+Instead, to get random results, the preferences and departments are shuffled
+before the proc is ever called.
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_element_by_var
+
+
return first thing in L which has var/varname == value
+this is typecaste as list/L, but you could actually feed it an atom instead.
+completely safe to use
get_first_open_turf_in_area
+
+
Iterates over all turfs in the target area and returns the first non-dense one
get_flat_existing_human_icon
+
+
A simpler version of get_flat_human_icon() that uses an existing human as a base to create the icon.
+Does not feature caching yet, since I could not think of a good way to cache them without having a possibility
+of using the cached version when we don't want to, so only use this proc if you just need this flat icon
+generated once and handle the caching yourself if you need to access that icon multiple times, or
+refactor this proc to feature caching of icons.
+
Arguments:
+
+
existing_human - The human we want to get a flat icon out of.
+
directions_to_output - The directions of the resulting flat icon, defaults to all cardinal directions.
+
get_hear
+
+
Like view but bypasses luminosity check
get_hearers_in_LOS
+
+
Returns a list of movable atoms that are hearing sensitive in view_radius and line of sight to source
+the majority of the work is passed off to the spatial grid if view_radius > 0
+because view() isnt a raycasting algorithm, this does not hold symmetry to it. something in view might not be hearable with this.
+if you want that use get_hearers_in_view() - however thats significantly more expensive
+
+
view_radius - what radius search circle we are using, worse performance as this increases but not as much as it used to
+
source - object at the center of our search area. everything in get_turf(source) is guaranteed to be part of the search area
+
get_hearers_in_radio_ranges
+
+
Returns an associative list-of-lists of radio : hearers
get_hearers_in_view
+
+
returns every hearaing movable in view to the turf of source not taking into account lighting
+useful when you need to maintain always being able to hear something if a sound is emitted from it and you can see it (and youre in range).
+otherwise this is just a more expensive version of get_hearers_in_LOS()
+
+
view_radius - what radius search circle we are using, worse performance as this increases
+
source - object at the center of our search area. everything in get_turf(source) is guaranteed to be part of the search area
+
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.
Return the mob type that is being controlled by a ckey
get_mob_or_brainmob
+
+
Returns the occupant mob or brain from a specified input
get_nested_locs
+
+
Returns a list of all locations (except the area) the movable is within.
get_officer_departments
+
+
Returns the distribution of splitting the given security officers into departments.
+Return value is an assoc list of candidate => SEC_DEPT_*.
get_offset_target_turf
+
+
returns turf relative to target_atom offset in dx and dy tiles, bound to map limits
get_oov_turf
+
+
Returns a turf that is barely out of view of the target.
get_open_turf_in_dir
+
+
Returns the open turf next to the center in a specific direction
get_perceived_radiation_danger
+
+
Gets the perceived "danger" of radiation pulse, given the threshold to the target.
+Returns a RADIATION_DANGER_* define, see code/__DEFINES/radiation.dm
get_pixel_angle
+
+
for getting the angle when animating something's pixel_x and pixel_y
get_pixel_distance
+
+
Finds the distance between two atoms, in pixels
+centered = FALSE counts from turf edge to edge
+centered = TRUE counts from turf center to turf center
+of course mathematically this is just adding world.icon_size on again
get_powernet_info_from_source
+
+
Save any queued packets
+Extracts the powernet and cell of the provided power source
get_preferences_in_priority_order
+
+
Returns a flat list of preferences in order of their priority
get_radio_icon
+
+
Pass in a frequency, get a file name. See chat_icons.dm
get_random_drink
+
+
Gets a random drink excluding the blocked type
get_random_food
+
+
Get a random food item exluding the blocked ones
get_random_jumpskirt
+
+
Returns a random, acceptable jumpskirt typepath
get_random_jumpsuit
+
+
Returns a random, acceptable jumpsuit typepath
get_random_reagent_id
+
+
Returns a random reagent object minus blacklisted reagents
get_random_station_turf
+
+
Returns a random turf on the station
get_ranged_target_turf_direct
+
+
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:
+
+
starting_atom - Initial Firer / Position
+
target - Target to aim towards
+
range - Distance of returned target turf from starting_atom
+
offset - Angle offset, 180 input would make the returned target turf be in the opposite direction
+
get_reagent_type_from_product_string
+
+
Returns a list of chemical_reaction datums that have the input STRING as a product
get_recipe_from_reagent_product
+
+
Takes a type in and returns a list of associated recipes
get_safe_random_station_turf
+
+
Returns a random turf on the station, excludes dense turfs (like walls) and areas that have valid_territory set to FALSE
get_selectable_species
+
+
Gets a list of all species available to choose in roundstart.
get_sorted_areas
+
+
Returns a sorted version of GLOB.areas, by name
get_species_augments
+
+
Returns a tree of species > category > slot > item path
get_teleport_loc
+
+
Returns location. Returns null if no location was found.
get_temp_change_amount
+
+
Used to get the amount of change between two body temperatures
+
When passed the difference between two temperatures returns the amount of change to temperature to apply.
+The change rate should be kept at a low value tween 0.16 and 0.02 for optimal results.
+vars:
+
+
temp_diff (required) The differance between two temperatures
+
change_rate (optional)(Default: 0.06) The rate of range multiplyer
+
get_turf_pixel
+
+
Lets the turf this atom's ICON appears to inhabit
+it takes into account:
+Pixel_x/y
+Matrix x/y
+NOTE: if your atom has non-standard bounds then this proc
+will handle it, but:
+if the bounds are even, then there are an even amount of "middle" turfs, the one to the EAST, NORTH, or BOTH is picked
+this may seem bad, but you're atleast as close to the center of the atom as possible, better than byond's default loc being all the way off)
+if the bounds are odd, the true middle turf of the atom is returned
get_valid_screen_location
+
+
Returns a valid location to place a screen object without overflowing the viewport
+
+
target: The target location as a purely number based screen_loc string "+-left-offset:+-pixel,+-bottom-offset:+-pixel"
+
target_offset: The amount we want to offset the target location by. We explictly don't care about direction here, we will try all 4
+
view: The view variable of the client we're doing this for. We use this to get the size of the screen
+
+
Returns a screen loc representing the valid location
give_admin_popup
+
+
Tries to give the target an admin popup.
+If it fails, will send the error to the passed admin.
goonchem_vortex
+
+
Magical move-wooney that happens sometimes.
+
Simulates a vortex that moves nearby movable atoms towards or away from the turf T.
+Range also determines the strength of the effect. High values cause nearby objects to be thrown.
+Arguments:
+
+
T - turf where it happens
+
setting_type - does it suck or does it blow?
+
range - range.
+
greatest_common_factor
+
+
Takes a list of numbers as input, returns the highest value that is cleanly divides them all
+Note: this implementation is expensive as heck for large numbers, I only use it because most of my usecase
+Is < 10 ints
honkerblast
+
+
Unleashes a honkerblast similar to the honkmech weapon, but with more granular control.
hsv2rgb
+
+
Converts a list storing hsva into an rgb color string
htmlrendertext
+
+
Perform a whitespace cleanup on the text, similar to what HTML renderers do
+
This is useful if you want to better predict how text is going to look like when displaying it to a user.
+HTML renderers collapse multiple whitespaces into one, trims prepending and appending spaces, among other things. This proc attempts to do the same thing.
+HTML5 defines whitespace pretty much exactly like regex defines the \s group, [ \t\r\n\f].
+
Arguments:
+
+
t - The text to "render"
+
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_element
+
+
Display a DM icon in a a browser.
icon_exists
+
+
Checks if the given iconstate exists in the given file, caching the result. Setting scream to TRUE will print a stack trace ONCE.
inLineOfSight
+
+
Calculate if two atoms are in sight, returns TRUE or FALSE
init_crafting_recipes
+
+
Inits the crafting recipe list, sorting crafting recipe requirements in the process.
init_keybindings
+
+
Creates and sorts all the keybinding datums
init_subtypes_w_path_keys
+
+
Functions like init_subtypes, but uses the subtype's path as a key for easy access
initialize_starting_knowledge
+
+
Returns a list of all heretic knowledge TYPEPATHS
+that have route set to PATH_START.
int_to_words
+
+
Takes a 1, 2 or 3 digit number and returns it in words. Don't call this directly, use convert_integer_to_words() instead.
+
Arguments:
+
+
number - 1, 2 or 3 digit number to convert.
+
carried_string - Text to append after number is converted to words, e.g. "million", as in "eighty million".
+
capitalise - Whether the number it returns should be capitalised or not, e.g. "Eighty-Eight" vs. "eighty-eight".
+
invert_HTML_colour
+
+
Inverts the colour of an HTML string
ion_num
+
+
Picks a string of symbols to display as the law number for hacked or ion laws
+is at the start to prevent us from changing say modes via get_message_mode()
isAdminGhostAI
+
+
Is the passed in mob an admin ghost WITH AI INTERACT enabled
isAdminObserver
+
+
Is the passed in mob a ghost with admin powers, doesn't check for AI interact like isAdminGhost() used to
is_admin
+
+
Returns if the given client is an admin, REGARDLESS of if they're deadminned or not.
is_color_dark
+
+
Given a color in the format of "#RRGGBB", will return if the color
+is dark.
is_convertable_to_cult
+
+
Returns whether the given mob is convertable to the blood cult
is_guest_key
+
+
Returns whether or not a player is a guest using their ckey as an input
is_ic_filtered
+
+
Given a text, will return what word is on the IC filter, with the reason.
+Returns null if the message is OK.
is_ic_filtered_for_pdas
+
+
Given a text, will return what word is on the IC filter, ignoring words allowed on the PDA, with the reason.
+Returns null if the message is OK.
is_ooc_filtered
+
+
Given a text, will return what word is on the OOC filter, with the reason.
+Returns null if the message is OK.
is_path_in_list
+
+
Checks for specific paths in a list.
+
If using zebra mode the list should be an assoc list with truthy/falsey values.
+The check short circuits so earlier entries in the input list will take priority.
+Ergo, subpaths should come before parent paths.
+Notice that this is the opposite priority of /proc/typecacheof.
+
Arguments:
+
+
path_to_check: A typepath to check.
+
list_to_check: A list of typepaths to check the path_to_check against.
+
zebra: Whether to use the value of the mathing path in the list instead of just returning true when a match is found.
+
is_safe_turf
+
+
Checks if a given turf is a "safe" location
is_soft_ic_filtered
+
+
Given a text, will return what word is on the soft IC filter, with the reason.
+Returns null if the message is OK.
is_soft_ic_filtered_for_pdas
+
+
Given a text, will return what word is on the soft IC filter, ignoring words allowed on the PDA, with the reason.
+Returns null if the message is OK.
is_soft_ooc_filtered
+
+
Given a text, will return that word is on the soft OOC filter, with the reason.
+Returns null if the message is OK.
is_source_facing_target
+
+
Compare source's dir, the clockwise dir of source and the anticlockwise dir of source
+To the opposite dir of the dir returned by get_dir(target,source)
+If one of them is a match, then source is facing target
is_special_character
+
+
Returns TRUE if the game has started and we're either an AI with a 0th law, or we're someone with a special role/antag datum
is_type_in_list
+
+
Checks for specific types in a list.
+
If using zebra mode the list should be an assoc list with truthy/falsey values.
+The check short circuits so earlier entries in the input list will take priority.
+Ergo, subtypes should come before parent types.
+Notice that this is the opposite priority of /proc/typecacheof.
list_to_check: A list of typepaths to check the type_to_check against.
+
zebra: Whether to use the value of the mathing type in the list instead of just returning true when a match is found.
+
is_valid_dmi_file
+
+
given a text string, returns whether it is a valid dmi icons folder path
is_valid_src
+
+
Check if a datum has not been deleted and is a valid source
ishumanbasic
+
+
Returns if the given target is a human. Like, a REAL human.
+Not a moth, not a felinid (which are human subtypes), but a human.
isvineimmune
+
+
Used to determine whether the mob is immune to actions by the vine.
+Use cases: Stops vine from attacking itself, other plants.
item_heal_robotic
+
+
Heal a robotic body part on a mob
jps_path_to
+
+
These are generally cheaper than looping contents so they go first
+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. Mind that diagonals
+cost the same as cardinal moves currently, so paths may look a bit strange, but should still be optimal.
+
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.
+It will yield until a path is returned, using magic
+
Arguments:
+
+
caller: The movable atom that's trying to find the path
+
end: What we're trying to path to. It doesn't matter if this is a turf or some other atom, we're gonna just path to the turf it's on anyway
+
max_distance: The maximum number of steps we can take in a given path to search (default: 30, 0 = infinite)
+
mintargetdistance: Minimum distance to the target before path returns, could be used to get near a target, but not right to it - for an AI mob with a gun, for example.
+
access: A list representing what access we have and what doors we can open.
+
simulated_only: Whether we consider turfs without atmos simulation (AKA do we want to ignore space)
+
exclude: If we want to avoid a specific turf, like if we're a mulebot who already got blocked by some turf
+
skip_first: Whether or not to delete the first item in the path. This would be done because the first item is the starting tile, which can break movement for some creatures.
+
diagonal_handling: defines how we handle diagonal moves. see __DEFINES/path.dm
+
json_deserialize_datum
+
+
Convert a list of json to datum
json_serialize_datum
+
+
Convert a datum into a json blob
kvpify_list
+
+
Converts a list into a list of assoc lists of the form ("key" = key, "value" = value)
+so that list keys that are themselves lists can be fully json-encoded
lightningbolt
+
+
this is the actual bolt effect and damage, made into its own proc because it is used elsewhere
living_player_count
+
+
Returns the amount of currently living players
load_adventures
+
+
Loads all adventures from DB
load_default_map_config
+
+
Proc that simply loads the default map config, which should always be functional.
load_map
+
+
Shortcut function to parse a map and apply it to the world.
+
+
dmm_file: A .dmm file to load (Required).
+
x_offset, y_offset, z_offset: Positions representign where to load the map (Optional).
+
cropMap: When true, the map will be cropped to fit the existing world dimensions (Optional).
+
measureOnly: When true, no changes will be made to the world (Optional).
+
no_changeturf: When true, [/turf/proc/AfterChange] won't be called on loaded turfs
+
x_lower, x_upper, y_lower, y_upper: Coordinates (relative to the map) to crop to (Optional).
+
placeOnTop: Whether to use [/turf/proc/PlaceOnTop] rather than [/turf/proc/ChangeTurf] (Optional).
+
load_map_config
+
+
Proc handling the loading of map configs. Will return the default map config using /proc/load_default_map_config if the loading of said file fails for any reason whatsoever, so we always have a working map for the server to run.
+
Arguments:
+
+
filename - Name of the config file for the map we want to load. The .json file extension is added during the proc, so do not specify filenames with the extension.
+
directory - Name of the directory containing our .json - Must be in MAP_DIRECTORY_WHITELIST. We default this to MAP_DIRECTORY_MAPS as it will likely be the most common usecase. If no filename is set, we ignore this.
+
log_missing - Bool that says whether failing to load the config for the map will be logged in log_world or not as it's passed to LoadConfig().
+
log_whitelist - Bool that says whether the directory not being in MAP_DIRECTORY_WHITELIST will be logged in log_world.
+
+
Returns the config for the map to load.
load_poll_data
+
+
Loads all current and future server polls and their options to store both as datums.
log_atmos
+
+
Logs the contents of the gasmix to the game log, prefixed by text
log_combat
+
+
Log a combat message in the attack log
+
Arguments:
+
+
atom/user - argument is the actor performing the action
+
atom/target - argument is the target of the action
+
what_done - is a verb describing the action (e.g. punched, throwed, kicked, etc.)
+
atom/object - is a tool with which the action was made (usually an item)
+
addition - is any additional text, which will be appended to the rest of the log line
+
log_directed_talk
+
+
Helper for logging of messages with only one sender and receiver
log_filter
+
+
Logs to the filter log with the given message, match, and scope
log_suspicious_login
+
+
Writes to a special log file if the log_suspicious_login config flag is set,
+which is intended to contain all logins that failed under suspicious circumstances.
+
Mirrors this log entry to log_access when access_log_mirror is TRUE, so this proc
+doesn't need to be used alongside log_access and can replace it where appropriate.
log_tgui
+
+
Appends a tgui-related log entry. All arguments are optional.
make_associative
+
+
Make a normal list an associative one
make_body
+
+
Uses stripped down and bastardized code from respawn character
make_datum_references_lists
+
+
Initial Building
make_tuple
+
+
Returns the name of the mathematical tuple of same length as the number arg (rounded down).
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_centcom
+
+
Used by communications consoles to message CentCom
message_syndicate
+
+
Used by communications consoles to message the Syndicate
message_to_html
+
+
Message-related procs
+
Message format (/list):
+
+
type - Message type, must be one of defines in code/__DEFINES/chat.dm
+
text - Plain message text
+
html - HTML message text
+
Optional metadata, can be any key/value pair.
+
+
Copyright (c) 2020 Aleksej Komarov
+SPDX-License-Identifier: MIT
move_element
+
+
Move a single element from position from_index within a list, to position to_index
+All elements in the range [1,to_index) before the move will be before the pivot afterwards
+All elements in the range [to_index, L.len+1) before the move will be after the pivot afterwards
+In other words, it's as if the range [from_index,to_index) have been rotated using a <<< operation common to other languages.
+from_index and to_index must be in the range [1,L.len+1]
+This will preserve associations ~Carnie
move_range
+
+
Move elements [from_index,from_index+len) to [to_index-len, to_index)
+Same as moveElement but for ranges of elements
+This will preserve associations ~Carnie
mutable_appearance
+
+
Helper similar to image()
narsie_apocalypse
+
+
Third crew last second win check and flufftext for [/proc/begin_the_end()]
narsie_end_begin_check
+
+
First crew last second win check and flufftext for [/proc/begin_the_end()]
narsie_end_second_check
+
+
Second crew last second win check and flufftext for [/proc/begin_the_end()]
narsie_last_second_win
+
+
Called only if the crew managed to destroy narsie at the very last second for [/proc/begin_the_end()]
narsie_start_destroy_station
+
+
security level and shuttle lockdowns for [/proc/begin_the_end()]
next_list_item
+
+
Returns the next item in a list
noop
+
+
A do nothing proc
notify_ghosts
+
+
Fancy notifications for ghosts
+
The kitchen sink of notification procs
+
Arguments:
+
+
message
+
ghost_sound sound to play
+
enter_link Href link to enter the ghost role being notified for
+
source The source of the notification
+
alert_overlay The alert overlay to show in the alert message
+
action What action to take upon the ghost interacting with the notification, defaults to NOTIFY_JUMP
+
flashwindow Flash the byond client window
+
ignore_key Ignore keys if they're in the GLOB.poll_ignore list
+
header The header of the notifiaction
+
notify_suiciders If it should notify suiciders (who do not qualify for many ghost roles)
+
notify_volume How loud the sound should be to spook the user
+
nuke_request
+
+
Used by communications consoles to request the nuclear launch codes
offer_control
+
+
Offer control of the passed in mob to dead player
+
Automatic logging and uses poll_candidates_for_mob, how convenient
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
overlays2text
+
+
Converts an overlay list into text for debug printing
+Of note: overlays aren't actually mutable appearances, they're just appearances
+Don't have access to that type tho, so this is the best you're gonna get
parse_caught_click_modifiers
+
+
Returns a turf based on text inputs, original turf and viewing client
parse_slot_flags
+
+
Returns a list of strings for a given slot flag.
parse_zone
+
+
Return a string for the specified body zone. Should be used for parsing non-instantiated bodyparts, otherwise use /obj/item/bodypart/var/plaintext_zone
pathfinding_finished
+
+
Uses funny pass by reference bullshit to take the path created by pathfinding, and insert it into a return list
+We'll be able to use this return list to tell a sleeping proc to continue execution
peek
+
+
Returns the top (last) element from the list, does not remove it from the list. Stack functionality.
pick_closest_path
+
+
Returns a chosen path that is the closest to a list of matches
pick_n_take
+
+
Pick a random element from the list and remove it from the list.
pick_weight
+
+
Picks a random element from a list based on a weighting system.
+For example, given the following list:
+A = 6, B = 3, C = 1, D = 0
+A would have a 60% chance of being picked,
+B would have a 30% chance of being picked,
+C would have a 10% chance of being picked,
+and D would have a 0% chance of being picked.
+You should only pass integers in.
piglatin_sentence
+
+
runs piglatin_word() proc on each word in a sentence. preserves caps and punctuation
piglatin_word
+
+
takes "word", and returns it piglatinized.
play_fov_effect
+
+
Plays a visual effect representing a sound cue for people with vision obstructed by FOV or blindness
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.
podspawn
+
+
One proc for easy spawning of pods in the code to drop off items before whizzling (please don't proc call this in game, it will destroy you)
+
Arguments:
+
+
specifications: special mods to the pod, see non var edit specifications for details on what you should fill this with
+Non var edit specifications:
+
target = where you want the pod to drop
+
path = a special specific pod path if you want, this can save you a lot of var edits
+
style = style of the pod, defaults to the normal pod
+
spawn = spawned path or a list of the paths spawned, what you're sending basically
+Returns the pod spawned, in case you want to spawn items yourself and modify them before putting them in.
+
poll_candidates
+
+
Calls the show_candidate_poll_window() to all eligible ghosts
poll_candidates_for_mob
+
+
Returns a list of ghosts that are eligible to take over and wish to be considered for a mob.
+
Arguments:
+
+
question - question to show players as part of poll
+
jobban_type - Type of jobban to use to filter out potential candidates.
+
be_special_flag - Unknown/needs further documentation.
+
poll_time - Length of time in deciseconds that the poll input box exists before closing.
+
target_mob - The mob that is being polled for.
+
ignore_category - Unknown/needs further documentation.
+
poll_candidates_for_mobs
+
+
Returns a list of ghosts that are eligible to take over and wish to be considered for a mob.
+
Arguments:
+
+
question - question to show players as part of poll
+
jobban_type - Type of jobban to use to filter out potential candidates.
+
be_special_flag - Unknown/needs further documentation.
+
poll_time - Length of time in deciseconds that the poll input box exists before closing.
+
mobs - The list of mobs being polled for. This list is mutated and invalid mobs are removed from it before the proc returns.
+
ignore_category - Unknown/needs further documentation.
+
poll_ghost_candidates
+
+
Wrapper to send all ghosts the poll to ask them if they want to be considered for a mob.
pop
+
+
Returns the top(last) element from the list and removes it from the list (typical stack function)
populate_editable_sign_types
+
+
This proc populates GLOBAL_LIST_EMPTY(editable_sign_types)
+
The first time a pen is used on any sign, this populates GLOBAL_LIST_EMPTY(editable_sign_types), creating a global list of all the signs that you can set a sign backing to with a pen.
power_fail
+
+
Disable power in the station APCs
previous_list_item
+
+
Returns the previous item in a list
priority_announce
+
+
Create an announcement to send globally or to a specified list of players.
+
args:
+
+
text (string) The body of the announcement
+
title (string) The title of the announcement. Default: "Staton Announcement"
+
sound_type (string OR sound) The sound to play alongside the message. If given a string like PA_COMMAND, it will pick the sound for you.
+
send_to_newscaster (boolean) Whether or not to post this to newscasters
+
do_not_modify (boolean) Whether or not station announcers can add to this message.
+
players (list or null) The players we're sending to. If null, send to all players.
+
process_teleport_locs
+
+
Generate a list of turfs you can teleport to from the areas list
+
Includes areas if they're not a shuttle or not not teleport or have no contents
+
The chosen turf is the first item in the areas contents that is a station level
+
The returned list of turfs is sorted by name
propagate_network
+
+
remove the old powernet and replace it with a new one throughout the network.
pull_apart_damage_states
+
+
This exists purely to import sprites from a codebase like Citadel RP.
pump_gas
+
+
obj/machinery/atmospherics/var/debug = 0
qdel
+
+
Should be treated as a replacement for the 'del' keyword.
+
Datums passed to this will be given a chance to clean up references to allow the GC to collect them.
radiation_pulse
+
+
Sends out a pulse of radiation, eminating from the source.
+Radiation is performed by collecting all radiatables within the max range (0 means source only, 1 means adjacent, etc),
+then makes their way towards them. A number, starting at 1, is multiplied
+by the insulation amounts of whatever is in the way (for example, walls lowering it down).
+If this number hits equal or below the threshold, then the target can no longer be irradiated.
+If the number is above the threshold, then the chance is the chance that the target will be irradiated.
+As a consumer, this means that max_range going up usually means you want to lower the threshold too,
+as well as the other way around.
+If max_range is high, but threshold is too high, then it usually won't reach the source at the max range in time.
+If max_range is low, but threshold is too low, then it basically guarantees everyone nearby, even if there's walls
+and such in the way, can be irradiated.
+You can also pass in a minimum exposure time. If this is set, then this radiation pulse
+will not irradiate the source unless they have been around any radioactive source for that
+period of time.
ran_zone
+
+
Return the zone or randomly, another valid zone
+
Do not use this if someone is intentionally trying to hit a specific body part.
+Use get_zone_with_miss_chance() for that.
random_capital_letter
+
+
handles thousands
random_colour
+
+
Returns a random color picked from a list, has 2 modes (0 and 1), mode 1 doesn't pick white, black or gray
random_fish_type
+
+
Returns random fish, using random_case_rarity probabilities.
random_nukecode
+
+
Returns a string for a random nuke code
random_step
+
+
Forces the atom to take a step in a random direction
rcd_result_with_memory
+
+
Produces a new RCD result from the given one if it can be calculated that
+the RCD should speed up with the remembered form.
rcd_scan
+
+
Global proc that generates RCD hologram in a range.
+
Arguments:
+
+
source - The atom the scans originate from
+
scan_range - The range of turfs we grab from the source
+
fade_time - The time for RCD holograms to fade
+
recover_all_SS_and_recreate_master
+
+
Recreate all SSs which will still cause data survive due to Recover(), the new Master will then find and take them from global.vars
recursive_list_resolve
+
+
Returns a list with all weakrefs resolved
recursive_list_resolve_element
+
+
Helper for recursive_list_resolve()
recursive_loc_check
+
+
Recursively checks if an item is inside a given type, even through layers of storage. Returns the atom if it finds it.
recursive_organ_check
+
+
+
recursive_organ_check
+
inputs: first_object (object to start with)
+
outputs:
+
description: A pseudo-recursive loop based off of the recursive mob check, this check looks for any organs held
+
within 'first_object', toggling their frozen flag. This check excludes items held within other safe organ
+
storage units, so that only the lowest level of container dictates whether we do or don't decompose
+
refify_list
+
+
Returns a copy of the list where any element that is a datum or the world is converted into a ref
reject_bad_chattext
+
+
The procedure to check the text of the entered text on ntnrc_client.dm
+
This procedure is designed to check the text you type into the chat client.
+It checks for invalid characters and the size of the entered text.
reject_bad_name
+
+
Filters out undesirable characters from names.
+
+
strict - return null immidiately instead of filtering out
+
allow_numbers - allows numbers and common special characters - used for silicon/other weird things names
+
reject_bad_text
+
+
Returns the text if properly formatted, or null else.
+
Things considered improper:
+
+
Larger than max_length.
+
Presence of non-ASCII characters if asci_only is set to TRUE.
+
Only whitespaces, tabs and/or line breaks in the text.
+
Presence of the <, >, \ and / characters.
+
Presence of ASCII special control characters (horizontal tab and new line not included).
+
remove_all_tags
+
+
Removes all tags in a string of text.
+May result in some formatting errors, floating whitespace. Not perfect.
remove_clunky_diagonals
+
+
Processes a path (list of turfs), removes any diagonal moves that would lead to a weird bump
+
path - The path to process down
+pass_info - Holds all the info about what this path attempt can go through
+simulated_only - If we are not allowed to pass space turfs
+avoid - A turf to be avoided
remove_diagonals
+
+
Processes a path (list of turfs), removes any diagonal moves
+
path - The path to process down
+pass_info - Holds all the info about what this path attempt can go through
+simulated_only - If we are not allowed to pass space turfs
+avoid - A turf to be avoided
remove_image_from_client
+
+
Removes an image from a client's .images. Useful as a callback.
remove_images_from_clients
+
+
Like remove_image_from_client, but will remove the image from a list of clients
remove_non_canon_overlays
+
+
Recursively removes overlays that do not render to the game plane from an appearance.
remove_verb
+
+
handles removing verb and sending it to browser to update, use this for removing verbs
+
pass the verb type path to this instead of removing it from verbs so the statpanel can update
+Arguments:
+
+
target - Who the verb is being removed from, client or mob typepath
+
verb - typepath to a verb, or a list of verbs, supports lists of lists
+
reset_cooldown
+
+
Proc used by stoppable timers to end a cooldown before the time has ran out.
+
Arguments:
+
+
source - datum storing the cooldown
+
index - string index storing the cooldown on the cooldowns associative list
+
+
This sends a signal reporting the cooldown end, passing the time left as an argument.
resolve_ai_icon_sync
+
+
A form of resolve_ai_icon that is guaranteed to never sleep.
+Not always accurate, but always synchronous.
retrieve_ban_cache
+
+
Gets the ban cache of the passed in client
+If the cache has not been generated, we start off a query
+If we still have a query going for this request, we just sleep until it's recieved back
return_generator_args
+
+
returns the arguments given to a generator and manually extracts them from the internal byond object
+returns:
+
+
flat list of strings for args given to the generator.
+
Note: this means things like "list(1,2,3)" will need to be processed
+
return_unused_frequency
+
+
returns a random unused frequency between MIN_FREE_FREQ & MAX_FREE_FREQ if free = TRUE, and MIN_FREQ & MAX_FREQ if FALSE
reverse_range
+
+
replaces reverseList ~Carnie
rgb2hsv
+
+
Converts an rgb color into a list storing hsva
+Exists because it's useful to have a guarenteed alpha value
rustg_get_version
+
+
Gets the version of rust_g
rustg_unix_timestamp
+
+
Returns the timestamp as a string
sanitize
+
+
Runs byond's html encoding sanitization proc, after replacing new-lines and tabs for the # character.
sanitize_color
+
+
Makes sure the input color is text with a # at the start followed by 6 hexadecimal characters. Examples: "#ff1234", "#A38321", COLOR_GREEN_GRAY
sanitize_css_class_name
+
+
Removes all non-alphanumerics from the text, keep in mind this can lead to id conflicts
sanitize_filepath
+
+
Sanitizes the name of each node in the path.
+
Im case you are wondering when to use this proc and when to use SANITIZE_FILENAME,
+
You use SANITIZE_FILENAME to sanitize the name of a file [e.g. example.txt]
+
You use sanitize_filepath sanitize the path of a file [e.g. root/node/example.txt]
+
If you use SANITIZE_FILENAME to sanitize a file path things will break.
sanitize_frequency
+
+
Ensure the frequency is within bounds of what it should be sending/receiving at
sanitize_name
+
+
returns nothing with an alert instead of the message if it contains something in the ic filter, and sanitizes normally if the name is fine. It returns nothing so it backs out of the input the same way as if you had entered nothing.
scramble_message_replace_chars
+
+
Slightly expensive proc to scramble a message using equal probabilities of character replacement from a list. DOES NOT SUPPORT HTML!
scramble_text
+
+
Scramble a string up.
+intensity = number of times we recursively call ourselves to scramble.
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
screen_text
+
+
Return an object with a new maptext (not currently in use)
seedify
+
+
Finds and extracts seeds from an object
+
Checks if the object is such that creates a seed when extracted. Used by seed
+extractors or posably anything that would create seeds in some way. The seeds
+are dropped either at the extractor, if it exists, or where the original object
+was and it qdel's the object
+
Arguments:
+
+
O - Object containing the seed, can be the loc of the dumping of seeds
+
t_max - Amount of seed copies to dump, -1 is ranomized
+
extractor - Seed Extractor, used as the dumping loc for the seeds and seed multiplier
+
user - checks if we can remove the object from the inventory
+
send2adminchat
+
+
Sends a message to TGS admin chat channels.
+
category - The category of the mssage.
+message - The message to send.
send2chat
+
+
Sends a message to TGS chat channels.
+
message - The message to send.
+channel_tag - Required. If "", the message with be sent to all connected (Game-type for TGS3) channels. Otherwise, it will be sent to TGS4 channels with that tag (Delimited by ','s).
+admin_only - Determines if this communication can only be sent to admin only channels.
send2otherserver
+
+
Sends a message to a set of cross-communications-enabled servers using world topic calls
+
Arguments:
+
+
source - Who sent this message
+
msg - The message body
+
type - The type of message, becomes the topic command under the hood
+
target_servers - A collection of servers to send the message to, defined in config
+
additional_data - An (optional) associated list of extra parameters and data to send with this world topic call
+
send_tip_of_the_round
+
+
Sends a round tip to a target. If selected_tip is null, a random tip will be sent instead (5% chance of it being silly).
+Tips that starts with the @ character won't be html encoded. That's necessary for any tip containing markup tags,
+just make sure they don't also have html characters like <, > and ' which will be garbled.
send_to_playing_players
+
+
sends a whatever to all playing players; use instead of to_chat(world, where needed)
serialize_antag_name
+
+
Serializes an antag name to be used for preferences UI
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!
+Takes the mob to shake, the time span to shake for, and the amount of tiles we're allowed to shake by in tiles
+Duration isn't taken as a strict limit, since we don't trust our coders to not make things feel shitty. So it's more like a soft cap.
should_have_space_before_emote
+
+
Returns a boolean based on whether or not the string contains a comma or an apostrophe,
+to be used for emotes to decide whether or not to have a space between the name of the user
+and the emote.
+
Requires the message to be HTML decoded beforehand. Not doing it here for performance reasons.
+
Returns TRUE if there should be a space, FALSE if there shouldn't.
show_candidate_poll_window
+
+
Show the poll window to the candidate mobs
shuffle
+
+
Randomize: Return the list in a random order
shuffle_inplace
+
+
same as shuffle, but returns nothing and acts on list in place
siunit
+
+
Formats a number to human readable form with the appropriate SI unit.
+
Supports SI exponents between 1e-15 to 1e15, but properly handles numbers outside that range as well.
+Examples:
+
+
+
siunit(1234, "Pa", 1) -> "1.2 kPa"
+
+
+
siunit(0.5345, "A", 0) -> "535 mA"
+
+
+
siunit(1000, "Pa", 4) -> "1 kPa"
+Arguments:
+
+
+
value - The number to convert to text. Can be positive or negative.
+
+
+
unit - The base unit of the number, such as "Pa" or "W".
+
+
+
maxdecimals - Maximum amount of decimals to display for the final number. Defaults to 1.
+
+
+
For pressure conversion, use proc/siunit_pressure() below
+
+
siunit_pressure
+
+
+
The game code never uses Pa, but kPa, since 1 Pa is too small to reasonably handle
+
Thus, to ensure correct conversion from any kPa in game code, this value needs to be multiplied by 10e3 to get Pa, which the siunit() proc expects
+
Args:
+
+
+
value_in_kpa - Value that should be converted to readable text in kPa
+
+
+
+
+
maxdecimals - maximum number of decimals that are displayed, defaults to 1 in proc/siunit()
+
+
+
slapcraft_examine_hints_for_type
+
+
Gets examine hints for this item type for slap crafting.
slapcraft_recipes_for_type
+
+
Gets cached recipes for a type. This is a method of optimizating recipe lookup. Ugly but gets the job done.
+also WARNING: This will make it so all recipes whose first step is not type checked will not work, which all recipes that I can think of will be.
+If you wish to remove this and GLOB.slapcraft_firststep_recipe_cache should this cause issues, replace the return with GLOB.slapcraft_recipes
sort_key
+
+
for sorting clients or mobs by ckey
sort_list
+
+
sort any value in a list
sort_mobs
+
+
Orders mobs by type then by name. Accepts optional arg to sort a custom list, otherwise copies GLOB.mob_list.
sort_names
+
+
uses sort_list() but uses the var's name specifically. This should probably be using mergeAtom() instead
sort_record
+
+
Specifically for record datums in a list.
spawn_express_pods
+
+
Spawns express pod(s) at a given location. Landing_loc can be a list in the case of an emagged console.
special_list_filter
+
+
Returns a list with items filtered from a list that can call callback
spiral_range
+
+
similar function to range(), but with no limitations on the distance; will search spiralling outwards from the center
spiral_range_turfs
+
+
similar function to RANGE_TURFS(), but will search spiralling outwards from the center (like the above, but only turfs)
spread_reagents
+
+
Exposes all accessible atoms within some distance of an epicenter to some reagents.
+Does not clear the source reagent holder; that must be done manually if it is desired.
epicenter: The epicenter/source location of the reagent spread.
+
spread_range: The range in which to spread the reagents.
+
stack_trace
+
+
gives us the stack trace from CRASH() without ending the current proc.
stars
+
+
Convert random parts of a passed in message to stars
+
+
phrase - the string to convert
+
probability - probability any character gets changed
+
+
This proc is dangerously laggy, avoid it or die
start_unequip_mob
+
+
A utility function for /datum/strippable_items to start unequipping an item from a mob.
station_time
+
+
Generate a game-world time value in deciseconds.
stoplag
+
+
returns the number of ticks slept
string_list
+
+
Caches lists with non-numeric stringify-able values (text or typepath).
stringmerge
+
+
This proc replaces all instances of the "replace" character in "text" with the character in the same position within the "compare" string
+"FFFFFFFFFFFFFFFFF***" and "FFFFFFFFFFFFFFF*****************FFFFFFFFFFFFFFFFFF"
+is "FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF"
strip_html
+
+
Runs STRIP_HTML_SIMPLE and sanitize.
stripped_input
+
+
Used to get a properly sanitized input, of max_length
+no_trim is self explanatory but it prevents the input from being trimed if you intend to parse newlines or whitespace.
swap_range
+
+
Move elements from [from_index, from_index+len) to [to_index, to_index+len)
+Move any elements being overwritten by the move to the now-empty elements, preserving order
+Note: if the two ranges overlap, only the destination order will be preserved fully, since some elements will be within both ranges ~Carnie
syndies_escaped
+
+
Returns whether or not syndicate operatives escaped.
test_whiteship_sizes
+
+
Helper proc that tests to ensure all whiteship templates can spawn at their docking port, and logs their sizes
+This should be a unit test, but too much of our other code breaks during shuttle movement, so not yet, not yet.
text_preview
+
+
Provides a preview of [string] up to [len - 3], after which it appends "..." if it pasts the length.
tgalert
+
+
DEPRECATED: USE tgui_alert(...) INSTEAD
+
Designed as a drop in replacement for alert(); functions the same. (outside of needing User specified)
+Arguments:
+
+
User - The user to show the alert to.
+
Message - The textual body of the alert.
+
Title - The title of the alert's window.
+
Button1 - The first button option.
+
Button2 - The second button option.
+
Button3 - The third button option.
+
StealFocus - Boolean operator controlling if the alert will steal the user's window focus.
+
Timeout - The timeout of the window, after which no responses will be valid.
+
tgui_Topic
+
+
Middleware for /client/Topic.
+
return bool If TRUE, prevents propagation of the topic call.
tgui_alert
+
+
Creates a TGUI alert window and returns the user's response.
+
This proc should be used to create alerts that the caller will wait for a response from.
+Arguments:
+
+
user - The user to show the alert to.
+
message - The content of the alert, shown in the body of the TGUI window.
+
title - The of the alert modal, shown on the top of the TGUI window.
+
buttons - The options that can be chosen by the user, each string is assigned a button on the UI.
+
timeout - The timeout of the alert, after which the modal will close and qdel itself. Set to zero for no timeout.
+
autofocus - The bool that controls if this alert should grab window focus.
+
tgui_alert_async
+
+
Creates an asynchronous TGUI alert window with an associated callback.
+
This proc should be used to create alerts that invoke a callback with the user's chosen option.
+Arguments:
+
+
user - The user to show the alert to.
+
message - The content of the alert, shown in the body of the TGUI window.
+
title - The of the alert modal, shown on the top of the TGUI window.
+
buttons - The options that can be chosen by the user, each string is assigned a button on the UI.
+
callback - The callback to be invoked when a choice is made.
+
timeout - The timeout of the alert, after which the modal will close and qdel itself. Disabled by default, can be set to seconds otherwise.
+
autofocus - The bool that controls if this alert should grab window focus.
+
tgui_input_list
+
+
Creates a TGUI input list window and returns the user's response.
+
This proc should be used to create alerts that the caller will wait for a response from.
+Arguments:
+
+
user - The user to show the input box to.
+
message - The content of the input box, shown in the body of the TGUI window.
+
title - The title of the input box, shown on the top of the TGUI window.
+
items - The options that can be chosen by the user, each string is assigned a button on the UI.
+
default - If an option is already preselected on the UI. Current values, etc.
+
timeout - The timeout of the input box, after which the menu will close and qdel itself. Set to zero for no timeout.
+
tgui_input_list_async
+
+
Client does NOT have tgui_input on: Returns regular input
+Creates an asynchronous TGUI input list window with an associated callback.
+
This proc should be used to create inputs that invoke a callback with the user's chosen option.
+Arguments:
+
+
user - The user to show the input box to.
+
message - The content of the input box, shown in the body of the TGUI window.
+
title - The title of the input box, shown on the top of the TGUI window.
+
items - The options that can be chosen by the user, each string is assigned a button on the UI.
+
default - If an option is already preselected on the UI. Current values, etc.
+
callback - The callback to be invoked when a choice is made.
+
timeout - The timeout of the input box, after which the menu will close and qdel itself. Set to zero for no timeout.
+
tgui_input_number
+
+
Creates a TGUI window with a number input. Returns the user's response as num | null.
+
This proc should be used to create windows for number entry that the caller will wait for a response from.
+If tgui fancy chat is turned off: Will return a normal input. If a max or min value is specified, will
+validate the input inside the UI and ui_act.
+
Arguments:
+
+
user - The user to show the number input to.
+
message - The content of the number input, shown in the body of the TGUI window.
+
title - The title of the number input modal, shown on the top of the TGUI window.
+
default - The default (or current) value, shown as a placeholder. Users can press refresh with this.
+
max_value - Specifies a maximum value. If none is set, any number can be entered. Pressing "max" defaults to 1000.
+
min_value - Specifies a minimum value. Often 0.
+
timeout - The timeout of the number input, after which the modal will close and qdel itself. Set to zero for no timeout.
+
round_value - whether the inputted number is rounded down into an integer.
+
tgui_input_number_async
+
+
Creates an asynchronous TGUI number input window with an associated callback.
+
This proc should be used to create number inputs that invoke a callback with the user's entry.
+
Arguments:
+
+
user - The user to show the number input to.
+
message - The content of the number input, shown in the body of the TGUI window.
+
title - The title of the number input modal, shown on the top of the TGUI window.
+
default - The default (or current) value, shown as a placeholder. Users can press refresh with this.
+
max_value - Specifies a maximum value. If none is set, any number can be entered. Pressing "max" defaults to 1000.
+
min_value - Specifies a minimum value. Often 0.
+
callback - The callback to be invoked when a choice is made.
+
timeout - The timeout of the number input, after which the modal will close and qdel itself. Set to zero for no timeout.
+
round_value - whether the inputted number is rounded down into an integer.
+
tgui_input_text
+
+
Creates a TGUI window with a text input. Returns the user's response.
+
This proc should be used to create windows for text entry that the caller will wait for a response from.
+If tgui fancy chat is turned off: Will return a normal input. If max_length is specified, will return
+stripped_multiline_input.
+
Arguments:
+
+
user - The user to show the text input to.
+
message - The content of the text input, shown in the body of the TGUI window.
+
title - The title of the text input modal, shown on the top of the TGUI window.
+
default - The default (or current) value, shown as a placeholder.
+
max_length - Specifies a max length for input. MAX_MESSAGE_LEN is default (1024)
+
multiline - Bool that determines if the input box is much larger. Good for large messages, laws, etc.
+
encode - Toggling this determines if input is filtered via html_encode. Setting this to FALSE gives raw input.
+
timeout - The timeout of the textbox, after which the modal will close and qdel itself. Set to zero for no timeout.
+
tgui_input_text_async
+
+
Creates an asynchronous TGUI text input window with an associated callback.
+
This proc should be used to create text inputs that invoke a callback with the user's entry.
+Arguments:
+
+
user - The user to show the text input to.
+
message - The content of the text input, shown in the body of the TGUI window.
+
title - The title of the text input modal, shown on the top of the TGUI window.
+
default - The default (or current) value, shown as a placeholder.
+
max_length - Specifies a max length for input.
+
multiline - Bool that determines if the input box is much larger. Good for large messages, laws, etc.
+
encode - If toggled, input is filtered via html_encode. Setting this to FALSE gives raw input.
+
callback - The callback to be invoked when a choice is made.
+
time_to_twelve_hour
+
+
Converts a time expressed in deciseconds (like world.time) to the 12-hour time format.
+the format arg is the format passed down to time2text() (e.g. "hh:mm" is hours and minutes but not seconds).
timeleft
+
+
Get the remaining deciseconds on a timer
+
Arguments:
+
+
id a timerid or a /datum/timedevent
+
to_chat
+
+
Sends the message to the recipient (target).
+
Recommended way to write to_chat calls:
+
to_chat(client,
+ type = MESSAGE_TYPE_INFO,
+ html = "You have found <strong>[object]</strong>")
+
to_chat_immediate
+
+
Circumvents the message queue and sends the message
+to the recipient (target) as soon as possible.
tool_behaviour_name
+
+
returns an ic name of the tool needed
+Arguments:
+
+
tool_behaviour: the tool described!
+
truncate
+
+
Truncate a string to the given length
+
Will only truncate if the string is larger than the length and ignores unicode concerns
+
This exists soley because trim does other stuff too.
+
Arguments:
+
+
text - String
+
max_length - integer length to truncate at
+
try_move_adjacent
+
+
Tries to move an atom to an adjacent turf, return TRUE if successful
typecache_filter_list
+
+
returns a new list with only atoms that are in the typecache list
typecache_filter_list_reverse
+
+
return a new list with atoms that are not in the typecache list
typecache_filter_multi_list_exclusion
+
+
similar to typecache_filter_list and typecache_filter_list_reverse but it supports an inclusion list and and exclusion list
typecacheof
+
+
Like typesof() or subtypesof(), but returns a typecache instead of a list.
+
Arguments:
+
+
path: A typepath or list of typepaths.
+
only_root_path: Whether the typecache should be specifically of the passed types.
+
ignore_root_path: Whether to ignore the root path when caching subtypes.
+
ui_status_only_living
+
+
Returns a UI status such that the dead will be able to watch, but not interact.
ui_status_silicon_has_access
+
+
Returns a UI status such that silicons will be able to interact with whatever
+they would have access to if this was a machine. For example, AIs can
+interact if there's cameras with wireless control is enabled.
ui_status_user_has_free_hands
+
+
Returns a UI status such that those without blocked hands will be able to interact,
+but everyone else can only watch.
ui_status_user_is_abled
+
+
Returns a UI status such that users with debilitating conditions, such as
+being dead or not having power for silicons, will not be able to interact.
+Being dead will disable UI, being incapacitated will continue updating it,
+and anything else will make it interactive.
ui_status_user_is_adjacent
+
+
Returns a UI status such that users adjacent to source will be able to interact,
+far away users will be able to see, and anyone farther won't see anything.
+Dead users will receive updates no matter what, though you likely want to add
+a [ui_status_only_living] check for finer observer interactions.
ui_status_user_is_advanced_tool_user
+
+
Returns a UI status such that advanced tool users will be able to interact,
+but everyone else can only watch.
ui_status_user_is_conscious_and_lying_down
+
+
Returns UI_INTERACTIVE if the user is conscious and lying down.
+Returns UI_UPDATE otherwise.
ui_status_user_strictly_adjacent
+
+
Return UI_INTERACTIVE if the user is strictly adjacent to the target atom, whether they can see it or not.
+Return UI_CLOSE otherwise.
unformat_frequency
+
+
Opposite of format, returns as a number
unique_list
+
+
Return a list with no duplicate entries
unique_list_in_place
+
+
same as unique_list, but returns nothing and acts on list in place (also handles associated values properly)
urange
+
+
ultra range (no limitations on distance, faster than range for distances > 8); including areas drastically decreases performance
url2htmlloader
+
+
Return html to load a url.
+for use inside of browse() calls to html assets that might be loaded on a cdn.
valid_window_location
+
+
Checks whether the target turf is in a valid state to accept a directional window
+or other directional pseudo-dense object such as railings.
+
Returns FALSE if the target turf cannot accept a directional window or railing.
+Returns TRUE otherwise.
+
Arguments:
+
+
dest_turf - The destination turf to check for existing windows and railings
+
test_dir - The prospective dir of some atom you'd like to put on this turf.
+
is_fulltile - Whether the thing you're attempting to move to this turf takes up the entire tile or whether it supports multiple movable atoms on its tile.
+
view_to_pixels
+
+
Takes a string or num view, and converts it to pixel width/height in a list(pixel_width, pixel_height)
voice_of_god
+
+
VOICE OF GOD
weakrefify_list
+
+
Returns a copy of the list where any element that is a datum is converted into a weakref
weekday_to_iso
+
+
Returns a string day as an integer in ISO format 1 (Monday) - 7 (Sunday)
weight_class_to_text
+
+
Returns a string based on the weight class define used as argument
window_flash
+
+
Flash the window of a player
zebra_typecacheof
+
+
Like typesof() or subtypesof(), but returns a typecache instead of a list.
+This time it also uses the associated values given by the input list for the values of the subtypes.
+
Latter values from the input list override earlier values.
+Thus subtypes should come after parent types in the input list.
+Notice that this is the opposite priority of /proc/is_type_in_list and /proc/is_path_in_list.
+
Arguments:
+
+
path: A typepath or list of typepaths with associated values.
+
single_value: The assoc value used if only a single path is passed as the first variable.
+
only_root_path: Whether the typecache should be specifically of the passed types.
+
ignore_root_path: Whether to ignore the root path when caching subtypes.
+
clear_nulls: Whether to remove keys with null assoc values from the typecache after generating it.
+
zstep
+
+
A step() variant that allows passing z_movement_flags. Normal step() is fine if you do not need special movement flags.
+
+
+
diff --git a/index.html b/index.html
new file mode 100644
index 000000000000..f2040d825975
--- /dev/null
+++ b/index.html
@@ -0,0 +1,6750 @@
+
+
+
+
+
+
+ Index - Daedalus Dock
+
+
+
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+
+
+
Daedalus Dock
+
+
+
+
Modules
+
+
+
code
+
__DEFINES - This folder is full of #define statements. They are similar to constants,
+but must come before any code that references them, and they do not take up
+memory the way constants do.
render_plate - Custom rendering solution to allow for advanced effects
+We (ab)use plane masters and render source/target to cheaply render 2+ planes as 1
+if you want to read more read the _render_readme.md
materials - How material datums work
+Materials are now instanced datums, with an associative list of them being kept in SSmaterials. We only instance the materials once and then re-use these instances for everything.
edible - This component makes it possible to make things edible. What this means is that you can take a bite or force someone to take a bite (in the case of items).
+These items take a specific time to eat, and can do most of the things our original food items could.
material_container - This datum should be used for handling mineral contents of machines and whatever else is supposed to hold minerals and make use of them.
Contextual screentips (and when to not use this folder) - Contextual screentips provide information in the form of text at the top of your screen to inform you of the possibilities of an item. The "contextual" here refers to this being handled entirely through code, what it displays and when is completely up to you.
Progression Traitor Balance Guide - This guide will explain how the values for progression traitor works, how to balance progression traitors and what you should NOT do when balancing.
+This guide will only explain progression values.
Preferences (by Mothblocks) - This does not contain all the information on specific values--you can find those as doc-comments in relevant paths, such as /datum/preference. Rather, this gives you an overview for creating most preferences, and getting your foot in the door to create more advanced ones.
In-code keypress handling system - This whole system is heavily based off of forum_account's keyboard library.
+Thanks to forum_account for saving the day, the library can be found
+here!
language_holder - Language holders will either exist in an atom/movable or a mind. Creation of language holders happens
+automatically when they are needed, for example when something tries to speak.
+Where a mind is available, the mind language holder will be the one "in charge". The mind holder
+will update its languages based on the atom holder, and will get updated as part of
+transformations and other events that cause new languages to become available.
screenshots - This folder contains the results for screenshot tests. Screenshot tests make sure an icon looks the same as it did before a change to prevent regressions.
emissive_blocker - Internal atom that copies an appearance on to the blocker plane
+
openspace/mimic - Object used to hold a mimiced atom's appearance.
+
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.
+
colorblind - Controller of all planes we're ok with changing with colorblind logic
+
+
render_plane_relay - Render relay object assigned to a plane master to be able to relay it's render onto other planes that are not it's own
status_effect - Alert base type for status effect alerts
+
drunk - Status effect for being fully drunk (not tipsy).
+
high - The status effect for "drugginess"
+
unholy_determination - Screen alert for the below status effect.
+
wound - WOUNDS
+
+
succumb - Gives the player the option to succumb while in critical condition
+
+
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.
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".
blackness - Plane master handling byond internal blackness
+vars are set as to replicate behavior when rendering to other planes
+do not touch this unless you know what you are doing
+
emissive - Handles emissive overlays and emissive blockers.
+
floor - Contains just the floor
+
game_world - Contains most things in the game world
consume - This action lets you consume the mob you're currently pulling. I'M GONNA CONSUUUUUME (this is considered one of the funny memes in the 2019-2020 era)
+
cooldown - Preset for an action that has a cooldown.
The spell action - This is the base action for how many of the game's
+spells (and spell adjacent) abilities function.
+These spells function off of a cooldown-based system.
addiction - base class for addiction, handles when you become addicted and what the effects of that are. By default you become addicted when you hit a certain threshold, and stop being addicted once you go below another one.
+
alcohol - Alcohol
+
medicine - Makes you a hypochondriac - I'd like to call it hypochondria, but "I could use some hypochondria" doesn't work
basic_controller/cow/moonicorn - stop killing my FRIENDS
+
cursed item ai! - Haunted AI tries to not be interacted with, and will attack people who do.
+Cursed AI instead tries to be interacted with, and will attempt to equip itself onto people.
+Added by /datum/element/cursed, and as such will try to remove this element and go dormant when it finds a victim to curse
ai_module - The base module type, which holds info about each ability.
+
destructive - Modules causing destruction
+
blackout - Blackout: Overloads a random number of lights across the station. Three uses.
+
destroy_rcd - Destroy RCDs: Detonates all non-cyborg RCDs on the station.
+
lockdown - Hostile Station Lockdown: Locks, bolts, and electrifies every airlock on the station. After 90 seconds, the doors reset.
+
megahonk - HIGH IMPACT HONKING
+
nuke_station - Doomsday Device: Starts the self-destruct timer. It can only be stopped by killing the AI completely.
+
overload_machine - Overload Machine: Allows the AI to overload a machine, detonating it after a delay. Two uses per purchase.
+
override_machine - Override Machine: Allows the AI to override a machine, animating it into an angry, living version of itself.
+
+
upgrade - Modules that are improving AI abilities and assets
+
eavesdrop - Enhanced Surveillance: Enables AI to hear conversations going on near its active vision.
+
mecha_domination - Unlock Mech Domination: Unlocks the ability to dominate mechs. Big shocker, right?
+
upgrade_cameras - Upgrade Camera Network: EMP-proofs all cameras, in addition to giving them X-ray vision.
+
upgrade_turrets - AI Turret Upgrade: Increases the health and damage of all turrets.
+
+
utility - Modules with stealthy and utility uses
+
break_air_alarms - Air Alarm Safety Override: Unlocks the ability to enable flooding on all air alarms.
+
break_fire_alarms - Thermal Sensor Override: Unlocks the ability to disable all fire alarms from doing their job.
+
emergency_lights - Disable Emergency Lights
+
place_cyborg_transformer - Robotic Factory: Places a large machine that converts humans that go through it into cyborgs. Unlocking this ability removes shunting.
+
reactivate_cameras - Reactivate Camera Network: Reactivates up to 30 cameras across the station.
+
+
+
ai_movement - This datum is an abstract class that can be overriden for different types of movement
dumb - The most braindead type of movement, bee-line to the target with no concern of whats infront of us.
+
jps - This movement datum represents smart-pathing
+
+
ai_planning_subtree - A subtree is attached to a controller and is occasionally called by /ai_controller/SelectBehaviors(), this mainly exists to act as a way to subtype and modify SelectBehaviors() without needing to subtype the ai controller itself
enemy_of_the_revolution - When the revolution wins, any remaining heads and security become Enemies of the Revolution.
+Previously being nonantagonists, they only have one simple objective: survive!
+
enemy_of_the_state - When the station wins, any remaining living headrevs become Enemies of the State, a small solo antagonist.
+They either have the choice to fuck off and do their own thing, or try and regain their honor with a hijack.
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)
Callback Datums - A datum that holds a proc to be called on another object, used to track proccalls to other objects
+
verb_callback - like normal callbacks but they also record their creation time for measurement purposes
+they also require the same usr/user that made the callback to both still exist and to still have a client in order to execute
+
+
callback_select - Helper datum for the select callbacks proc
centcom_announcer - Data holder for the announcers that can be used in a game, this can be used to have alternative announcements outside of the default e.g.the intern
circuit_composite_template - A template used to make composite datatypes for circuits.
+Used so that we don't have to generate every single possible combination of types
+
circuit_datatype - A circuit datatype. Used to determine the datatype of a port and also handle any additional behaviour.
circuit_variable - A circuit variable that holds the name, the datatype and the colour of the variable (taken from the datatype).
+
client_colour - Client Colour Priority System By RemieRichards (then refactored by another contributor)
+A System that gives finer control over which client.colour value to display on screen
+so that the "highest priority" one is always displayed as opposed to the default of
+"whichever was set last is displayed".
+
client_interface - This should match the interface of /client wherever necessary.
colorblind_tester - Used to test the game for issues with different types of color blindness
+WARNING ASSHOLE: Because we can only apply matrixes, and can't preform gamma correction
+https://web.archive.org/web/20220227030606/https://ixora.io/projects/colorblindness/color-blindness-simulation-research/
+The results of this tool aren't perfect. It's way better then nothing, but IT IS NOT A PROPER SIMULATION
+Please do not make us look like assholes by assuming it is. Thanks.
+
colored_assistant - Defines a style of jumpsuit/jumpskirt for assistants.
+Jumpsuit and jumpskirt lists should match in colors, as they are used interchangably.
+
solid - Will pick one color, and stick with it
+
+
command_report_menu - Datum for holding the TGUI window for command reports.
action_item_overlay - Apply to an action to allow it to take an item
+and apply it as an overlay of the action button
+
admin_popup - Applied to clients when they receive an admin popup, alerting them to
+their ticket.
+
anti_magic - This provides different types of magic resistance on an object
+
aquarium_content - Allows movables to be inserted/displayed in aquariums.
+
area_sound_manager - Allows you to set a theme for a set of areas without tying them to looping sounds explicitly
+
areabound - Movables with this component will automatically return to their original turf if moved outside their initial area
+
atmos_reaction_recorder - Component for atmos-related atoms to be able to record and transmit their reaction_results data
+Use this ONLY for atoms, gasmixtures will be accessed by calling return air on the object.
+Add this component after gasmixes has been initialized.
+
aura_healing - Applies healing to those in the area.
+Will provide them with an alert while they're in range, as well as
+give them a healing particle.
+Can be applied to those only with a trait conditionally.
bakeable - This component indicates this object can be baked in an oven.
+
bloodysoles - Component for clothing items that can pick up blood from decals and spread it around everywhere when walking, such as shoes or suits with integrated shoes.
+
feet - Like its parent but can be applied to carbon mobs instead of clothing items
+
+
boomerang - If an ojvect 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.
clickbox - This component adds a near-invisible underlay to a movable target to expand the clickable surface of its icon without
+resorting to MOUSE_OPACITY_OPAQUE.
+The underlay ignores the parent's color and alpha and can be offset.
+The name is a portmanteau of "click" and "hitbox", because technically this isn't an hitbox,
+but it helps catch clicks, and I don't want to give it a loooong name like openspace_item_click_handler
+
codeword_hearing - Component that allows for highlighting of words or phrases in chat based on regular expressions.
connect_containers - This component behaves similar to connect_loc_behalf, but it's nested and hooks a signal onto all MOVABLES containing this atom.
+
connect_loc_behalf - This component behaves similar to connect_loc, hooking into a signal on a tracked object's turf
+It has the ability to react to that signal on behalf of a separate listener however
+This has great use, primarily for components, but it carries with it some overhead
+So we do it separately as it needs to hold state which is very likely to lead to bugs if it remains as an element.
+
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
+
connect_range - This component behaves similar to connect_loc_behalf but for all turfs in range, hooking into a signal on each of them.
+Just like connect_loc_behalf, It can react to that signal on behalf of a seperate listener.
+Good for components, though it carries some overhead. Can't be an element as that may lead to bugs.
+
construction/mecha - Construction datums
+
container_item - Container item, an item which can be stored by specialized containers.
+
tank_holder - Tank holder item - Added to an object which can be added to a tank holder.
+
+
convey - Manages the loop caused by being on a conveyor belt
+Prevents movement while you're floating, etc
+Takes the direction to move, delay between steps, and time before starting to move as arguments
+
cracked - Tracks damage to add or remove crack overlays, when none are needed this components is qdeleted
dejavu - A component to reset the parent to its previous state after some time passes
+
timeline - differently themed dejavu for modsuits.
+
+
deployable - Deployable - Bring your big guns with you, and smack em' down where you want.
+
diggable - Lets you make hitting a turf with a shovel pop something out, and scrape the turf
+
drift - Component that handles drifting
+Manages a movement loop that actually does the legwork of moving someone
+Alongside dealing with the post movement input blocking required to make things look nice
egg layer component! - Component that manages how many eggs to lay, what can be fed to the mob to make them lay more, and what is actually laid.
+Since the only real interaction with the component is an attackby, the nice part is that we're able to make this an atom level proc.
+egg_layer will loudly fail if you do not provide it the arguments, as to encourage explicicy(?)
+
electrified_buckle component: - attach it to any atom/movable that can be buckled to in order to have it shock mobs buckled to it. by default it shocks mobs buckled to parent every shock_loop_time.
+the parent is supposed to define its behavior with arguments in AddComponent
engraved component! - MUST be a component, though it doesn't look like it. SSPersistence demandeth
+
explodable - Component specifically for explosion sensetive things, currently only applies to heat based explosions but can later perhaps be used for things that are dangerous to handle carelessly like nitroglycerin.
food_storage - --Food storage component--
+This component lets you slide one item into large foods, such as bread, cheese wheels, or cakes.
+Consuming food storages with an item inside can cause unique interactions, such as eating glass shards.
+
force_move - Forced directional movement, but with a twist
+Let's block pressure and client movements while doing it so we can't be interrupted
+Supports spinning on each move, for lube related reasons
+
gas_leaker - A component to leak gas over time from damaged objects with gas storage
+
geiger_sound - Atoms with this component will play sounds depending on nearby radiation
+
genetic_damage - Genetic damage, given by DNA consoles, will start to deal toxin damage
+past a certain threshold, and will go down consistently.
+Adding multiple of this component will increase the total damage.
+Can turn monkeys into gorillas.
+
gps - GPS component. Atoms that have this show up on gps. Pretty simple stuff.
+
item - GPS component subtype. Only gps/item's can be used to open the UI.
hazard_area - This is a relatively simple component that attempts to deter the parent of the component away
+from a specific area or areas. By default it simply applies a penalty where all movement is
+four times slower than usual and any action that would affect your 'next move' has a penalty
+multiplier of 4 attached.
+
heirloom - Heirloom component. For use with the family heirloom quirk, tracks that an item is someone's family heirloom.
knockoff - Items with this component will have a chance to get knocked off
+(unequipped and sent to the ground) when the wearer is disarmed or knocked down.
light_eater - Makes anything it attaches to capable of removing something's ability to produce light until it is destroyed
+
Living Heart Component - Applied to a heart to turn it into a heretic's 'living heart'.
+The living heart is what they use to track people they need to sacrifice.
Mind Linker - A component that handles linking multiple player's minds
+into one network which allows them to talk directly to one another.
+Like telepathy but for multiple people at once!
+
multiple_lives - A simple component that spawns a mob of the same type and transfers itself to it when parent dies.
+For more complex behaviors, use the COMSIG_ON_MULTIPLE_LIVES_RESPAWN comsig.
+
omen - omen.dm: For when you want someone to have a really bad day
+
overlay_lighting - Movable atom overlay-based lighting component.
+
palette - A component that stores colors for use by painting-related items like spraycans or palettes
+which can be accessed through a radial menu by right clicking the item while it's held by the user mob.
+Right-clicking a color will open a color input prompt to edit it. Left clicking will instead select it
+and call set_painting_tool_color() on the parent for more specific object behavior.
+
payment - Handles simple payment operations where the cost of the object in question doesn't change.
radiation_countdown - Begins the countdown before a target can be irradiated.
+Added by the radiation subsystem when a pulse information has a minimum exposure time.
+Will clear itself out after a while.
+
religious_tool - Allows the parent to act similarly to the Altar of Gods with modularity. Invoke and Sect Selection is done via attacking with a bible. This means you cannot sacrifice Bibles (you shouldn't want to do this anyways although now that I mentioned it you probably will want to).
subtype_picker - subtype picker component allows for an item to transform into its subtypes (this is not enforced and you can turn in whatever types, but
+i used this name as it was incredibly accurate for current usage of the behavior)
+
tackler - For when you want to throw a person at something and have fun stuff happen
+
tameable - This component lets you make specific mobs tameable by feeding them
traitor_objective_register - Helper component that registers signals on an object
+This is not necessary to use and gives little control over the conditions
eor_credits_delay - Time between the round ending and credits beginning to roll
+
lobby_countdown - Countdown between lobby and the round starting.
+
max_hub_pop - Pop requirement for the server to be removed from the hub
+
maximum_potential_objectives - Determines how many potential objectives a traitor can have.
+
outdated_movedelay - Outdated move delay
+
round_end_countdown - Post round murder death kill countdown.
+
traitor_ideal_player_count - Determines the ideal player count for maximum progression per minute.
+
traitor_scaling_multiplier - Determines how fast traitors scale in general.
+
vote_autotransfer_initial - Length of time before the first autotransfer vote is called (deciseconds, default 2 hours)
+Set to 0 to disable the subsystem altogether.
+
vote_autotransfer_interval - length of time to wait before subsequent autotransfer votes (deciseconds, default 30 minutes)
+
vote_autotransfer_maximum - maximum extensions until the round autoends.
+Set to 0 to force automatic crew transfer after the 'vote_autotransfer_initial' elapsed.
+Set to -1 to disable the maximum extensions cap.
+
vote_delay - minimum time between voting sessions (deciseconds, 10 minute default)
+
vote_period - length of voting period (deciseconds, default 1 minute)
+
+
str_list - List config entry, used for configuring a list of strings
master - Start of queue linked list
+End of queue linked list (used for appending to the list)
+Are we loading in a new map?
+for scheduling different subsystems for different stages of the round
decompose_matrix - Datum which stores information about a matrix decomposed with decompose().
+
design - Design Datums
+All the data for building stuff.
+
advmop - Janitor Designs
+
alloy - SMELTABLE ALLOYS
+
basic_cell - Power
+
bluespace_crystal - Bluespace
+
board - Computer Boards
+
aicore - AI Module Disks
+
cargo_express - Mining
+
electrolyzer - MISC Boards
+
fax_machine - Fax machine design, for techwebs.
+
ripley_main - Mecha Module Disks
+
subspace_receiver - Subspace Telecomms
+
+
borg_upgrade_rename - Borg Upgrades
+
bucket - Autolathe Designs
+
cyberimp_welding - Cybernetic Implants
+
data - Disk Construction Disks
+
data_terminal - Data Terminal
+
disk/normal - Computer Parts
+
handdrill - Tools
+
health_hud - HUDs
+
healthanalyzer - Medical Tools
+
holosign - Holobarriers
+
restaurant - Restaurant Equipment
+
+
implanter - Regular Implants
+
intellicard - Non-Board Computer Stuff
+
leftarm - Limb Grower Designs
+
mech_scattershot - Mecha Equpment
+
milk - Biogenerator Designs
+
reactive_armour - Armour
+
rped - Stock Parts
+
rubbershot/sec - Weapons
+
seclite - Security
+
welding_goggles - Misc
+
+
discord_embed - Documentation for the embed object and all of its variables can be found at
+https://discord.com/developers/docs/resources/channel#embed-object
+It is recommended to read the documentation on the discord website, as the information below could become outdated in the future.
+
discord_link_record - Represents a record from the discord link table in a nicer format
dream - Contains all the behavior needed to play a kind of dream.
+All dream types get randomly selected from based on weight when an appropriate mobs dreams.
traitor - Probability the AI going malf will be accompanied by an ion storm announcement and some ion laws.
+The probability to replace an existing law with an ion law instead of adding a new ion law.
+
+
+
dynamic_snapshot - A "snapshot" of dynamic at an important point in time.
+Exported to JSON in the dynamic.json log file.
trail_follow - ///// Attach a trail to any object, that spawns when it moves (like for the jetpack)
+just pass in the object to attach it to in set_up
+Then do start() to start it and stop() to stop it, obviously
+and don't call start() in a loop that will be repeated otherwise it'll get spammed!
+
+
element - A holder for simple behaviour that can be attached to many different types
+
animal variety element! - bespoke element that picks an suffix to append onto the icon state from a list given on creation, among some pixel shifting stuff
+basically you will see VARIETY in a batch of simplemobs.
+
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
+Leaving something at 0 means it's off - has no maximum.
+This damage is taken when atmos doesn't fit all the requirements above.
+
backblast - When attached to a gun and the gun is successfully fired, this element creates a "backblast" of fire and pain, like you'd find in a rocket launcher or recoilless rifle
+
bane - Deals extra damage to mobs of a certain type or species.
+
basic_body_temp_sensitive - When attached to a basic mob, it gives it the ability to be hurt by cold/hot body temperatures
+
beauty - Beauty element. It makes the indoor area the parent is in prettier or uglier depending on the beauty var value.
+Clean and well decorated areas lead to positive moodlets for passerbies;
+Shabbier, dirtier ones lead to negative moodlets EXCLUSIVE to characters with the snob quirk.
+
bed_tuckable - Tucking element, for things that can be tucked into bed.
+
blood_walk - Blood walk, a bespoke element that causes you to make blood wherever you walk.
connect_loc - This element hooks a signal onto the loc the current object is on.
+When the object moves, it will unhook the signal and rehook it to the new object.
+
contextual_screentip_bare_hands - Apply basic contextual screentips when the user hovers over this item with an empty hand.
+A "Type B" interaction.
+This stacks with other contextual screentip elements, though you may want to register the signal/flag manually at that point for performance.
+
contextual_screentip_item_typechecks - Apply basic contextual screentips when the user hovers over this item with a provided item.
+A "Type B" interaction.
+This stacks with other contextual screentip elements, though you may want to register the signal/flag manually at that point for performance.
+
contextual_screentip_tools - Apply basic contextual screentips when the user hovers over this item with an item of the given tool behavior.
+A "Type B" interaction.
+This stacks with other contextual screentip elements, though you may want to register the signal/flag manually at that point for performance.
+
crackable - Adds crack overlays to an object when integrity gets low
+
curse announcement element! - Bespoke element that sends a harrowing message when you first pick up an item, applying a spooky color outline and renaming the item.
+For most items, it will announce when picked up. If the item can be equipped, though, it will only announce when the item is worn.
+Possible improvements for the future: add an option to allow the cursed affix to be a prefix. right now only coded for suffixes
+
cursed element! - Attaching this element to something will make it float, and get a special ai controller!
haunted - Attaching this element to something will make it float, get a special ai controller, and gives it a spooky outline.
+
honkspam - Attachable to items. Plays a bikehorn sound whenever attack_self is called (with a cooldown).
+
human_biter - Allows carbons with heads to attempt to bite mobs if attacking with cuffed hands / missing arms
+
item_scaling - Element for scaling item appearances in the overworld or in inventory/storage.
+
kneecapping - Kneecapping element replaces the item's secondary attack with an aimed attack at the kneecaps under certain circumstances.
+
kneejerk - An element which enables certain items to tap people on their knees to measure brain health
+
knockback - Mobs and items with this element will knock movable targets they hit away from them.
+Guns and turrets will instead fire projectiles with similar effects.
lifesteal - Heals the user (if attached to an item) or the mob itself (if attached to a hostile simple mob)
+by a flat amount whenever a successful attack is performed against another living mob.
+
light_blocking - Attached to movable atoms with opacity. Listens to them move and updates their old and new turf loc's opacity accordingly.
+
light_eaten - Makes anything that it attaches to incapable of producing light
+
light_eater - Makes anything it attaches to capable of permanently removing something's ability to produce light.
+
mirage_border - Creates a mirage effect allowing you to see around the world border, by adding the opposite side to its vis_contents.
+
movement_turf_changer - movement_turf_changer element; which makes the movement of a movable atom change the turf it moved to
+
movetype_handler - An element that enables and disables movetype bitflags whenever the relative traits are added or removed.
+It also handles the +2/-2 pixel y anim loop typical of mobs possessing the FLYING or FLOATING movetypes.
+This element is necessary for the TRAIT_MOVE_ traits to work correctly, so make sure to attach this element
+before adding them to non-living movables.
+
obj_regen - Object integrity regeneration element added by alien alloy.
+
openspace_item_click_handler - allow players to easily use items such as iron rods, rcds on open space without
+having to pixelhunt for portions not occupied by object or mob visuals.
+
Pet bonus element! - Bespoke element that plays a fun message, sends a heart out, and gives a stronger mood bonus when you pet this animal.
+I may have been able to make this work for carbons, but it would have been interjecting on some help mode interactions anyways.
+
plant_backfire - -- Plant backfire element --
+Certain high-danger plants, like death-nettles, will backfire and harm the holder if they're not properly protected.
+If a user is protected with something like leather gloves, they can handle them normally.
+If they're not protected properly, we invoke a callback on the user, harming or inconveniencing them.
+
point_of_interest - Designates the atom as a "point of interest", meaning it can be directly orbited
+
prevent_attacking_of_types - This hostile will not be able to attack a given typecache, and will receive
+a balloon alert when it tries to.
radiation_protected_clothing - Marks the item as being radiation protected.
+Adds the TRAIT_RADIATION_PROTECTED_CLOTHING trait, as well as adding an
+extra bit to the examine descrpition.
+
radioactive - This atom will regularly pulse radiation.
+As this is only applied on uranium objects for now, this defaults to uranium constants.
+
ranged_attacks - This proc is used by basic mobs to give them a simple ranged attack! In theory this could be extended to
+
ridable - This element is used to indicate that a movable atom can be mounted by mobs in order to ride it. The movable is considered mounted when a mob is buckled to it,
+at which point a riding component is created on the movable, and that component handles the actual riding behavior.
+
rust - Adding this element to an atom will have it automatically render an overlay.
+The overlay can be specified in new as the first paramter; if not set it defaults to rust_overlay's rust_default
simple flying element! - Non bespoke element (1 in existence) that makes animals fly while living and... not while dead!
+Note: works for carbons and above, but please do something better. humans have wings got dangit!
food - Original Food export file got eaten somewhere along the line and I have no idea when or where it got completely deleted.
+Foods given a venue value are exportable to cargo as a backup to selling from venues, however at the expense of elasticity.
Families gamemode / dynamic ruleset handler - A special datum used by the families gamemode and dynamic rulesets to centralize code. "Family" and "gang" used interchangeably in code.
+
gang_theme - Gang themes for the Families gamemode. Used to determine the RP theme of the round, what gangs are present, and what their objectives are.
icon_state - The most basic greyscale layer; a layer which is created from a single icon_state in the given icon file
+
reference - A layer created by using another greyscale icon's configuration
+
+
greyscale_modify_menu - The controller for the ui in charge of all runtime greyscale configuration/debug.
+If Unlock() is not called the menu is safe for players to use.
gun_bolt - Gun has a bolt, it stays closed while not cycling. The gun must be racked to have a bullet chambered when a mag is inserted.
+Example: c20, shotguns, m90
+
locking - Gun has a bolt, it locks back when empty. It can be released to chamber a round if a magazine is in.
+Example: Pistols with a slide lock, some SMGs
+
no_bolt - Gun has no moving bolt mechanism, it cannot be racked. Also dumps the entire contents when emptied instead of a magazine.
+Example: Break action shotguns, revolvers
+
open - Gun has a bolt, it is open when ready to fire. The gun can never have a chambered bullet with no magazine, but the bolt stays ready when a mag is removed.
+Example: Some SMGs, the L6
+
+
hallucination
+
fake_health_doll - Causes the target to see incorrect health damages on the healthdoll
+
xeno_attack - Xeno crawls from nearby vent,jumps at you, and goes back in
+
+
Heretic Knowledge - The datums that allow heretics to progress and learn new spells and rituals.
+
amber_focus - Allows the heretic to craft a spell focus.
+They require a focus to cast advanced spells.
highlander_controller - The highlander controller handles the admin highlander mode, if enabled.
+It is first created when "there can only be one" triggers it, and it can be referenced from GLOB.highlander_controller
id_trim - Simple datum that holds the basic information associated with an ID card trim.
+
admin - Trim for admins and debug cards. Has every single access in the game.
+
away - Generic away/pffstation trim.
+
cat_surgeon - Trim for the cat surgeon ruin.
+
hilbert - Trim for Hilber in Hilbert's Hotel.
+
hotel - Trim for the hotel ruin. Not Hilbert's Hotel.
+
security - Trim for the hotel ruin. Not Hilbert's Hotel.
+
+
old
+
apc - Trim for the oldstation ruin/Charlie station
+
eng - Trim for the oldstation ruin/Charlie station
+
sci - Trim for the oldstation ruin/Charlie station
+
sec - Trim for the oldstation ruin/Charlie station
+
+
+
battlecruiser - Trim for Syndicate mobs, outfits and corpses.
+
captain - Trim for Syndicate mobs, outfits and corpses.
+
+
bounty_hunter - Trim for Bounty Hunters NOT hired by centcom. (?)
+
centcom - Trim for basic Centcom cards.
+
admiral - Trim for Centcom (Soviet) Admirals. All Centcom and Station Access.
+
bartender - Trim for Centcom Bartenders.
+
bounty_hunter - Trim for Bounty Hunters hired by centcom.
+
commander - Trim for Centcom Commanders. All Centcom and Station Access.
+
corpse
+
assault - Trim for various Centcom corpses.
+
bridge_officer - Trim for various Centcom corpses.
+
commander - Trim for various Centcom corpses.
+
private_security - Trim for various Centcom corpses.
+
tradepost_officer - Trim for various Centcom corpses.
+
+
+
custodian - Trim for Centcom Custodians.
+
deathsquad - Trim for Deathsquad officers. All Centcom and Station Access.
+
ert - Trim for generic ERT interns. No universal ID card changing access.
+
chaplain - Trim for generic ERT chaplains. No universal ID card changing access.
+
clown - Trim for generic ERT clowns. No universal ID card changing access.
+
commander - Trim for ERT Commanders. All station and centcom access.
+
engineer - Trim for generic ERT engineers. No universal ID card changing access.
+
janitor - Trim for generic ERT janitors. No universal ID card changing access.
+
medical - Trim for generic ERT medics. No universal ID card changing access.
+
security - Trim for generic ERT seccies. No universal ID card changing access.
+
+
intern - Trim for Centcom Interns.
+
head - Trim for Centcom Head Interns. Different assignment, common station access added on.
+
+
medical_officer - Trim for Centcom Medical Officers.
+
official - Trim for Centcom Officials.
+
research_officer - Trim for Centcom Research Officers.
+
specops_officer - Trim for Centcom Specops Officers. All Centcom and Station Access.
+
thunderdome_overseer - Trim for Centcom Thunderdome Overseers.
+
vip - Trim for Centcom VIPs
+
+
chameleon - Trim for Chameleon ID cards. Many outfits, nuke ops and some corpses hold Chameleon ID cards.
+
operative - Trim for Chameleon ID cards. Many outfits, nuke ops and some corpses hold Chameleon ID cards.
+
clown - Trim for Chameleon ID cards. Many outfits, nuke ops and some corpses hold Chameleon ID cards.
+
clown_leader - Trim for Chameleon ID cards. Many outfits, nuke ops and some corpses hold Chameleon ID cards.
+
nuke_leader - Trim for Chameleon ID cards. Many outfits, nuke ops and some corpses hold Chameleon ID cards.
+
+
+
engioutpost - Trim for various various ruins.
+
highlander - Trim for highlander cards, used during the highlander adminbus event.
+
job - This file contains all the trims associated with station jobs.
+It also contains special prisoner trims and the miner's spare ID trim.
+ID Trims for station jobs.
Instrument Datums - 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.
+
instrument_key - Instrument key datums contain everything needed to know how to play a specific
+note of an instrument.*
+
interview - Represents a new-player interview form
+
Interview Manager - Handles all interviews in the duration of a round, includes the primary functionality for
+handling the interview queue.
+
job - datum/job/bureaucrat,
+This is the file you should use to add alternate titles for each job, just
+follow the way they're done here, it's easy enough and shouldn't take any
+time at all to add more or add some for a job that doesn't have any.
servant_golem - For late joiners, we're forced to put them in an alone department at some point.
+
unassigned - This type is used to indicate a lack of a job.
+The mind variable assigned_role will point here by default.
+As any other job datum, this is a singleton.
+
+
job_department - Singleton representing a category of jobs forming a department.
+
assistant - A special assistant only department, primarily for use by the preferences menu
+
captain - A special captain only department, for use by the preferences menu
+
undefined - Catch-all department for undefined jobs.
+
+
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
+
json_reader - Takes a json list and extracts a single value.
+Subtypes represent different conversions of that value.
lift_master - coordinate and control movement across linked industrial_lift's. allows moving large single multitile platforms and many 1 tile platforms.
+also is capable of linking platforms across linked z levels
map_generator - This type is responsible for any map generation behavior that is done in areas, override this to allow for area-specific map generation. This generation is ran by areas in initialize.
memory - little tidbits of past events generated by the player doing things. can be used in engravings, dreams, and changeling succs.
+all of those things are supposed to be taken vaguely (engravings crossround and should not include names, dreams and succs are memory goop)
+and as such the generated text of the memory is vague. also, no references held so hard delling isn't an issue, thank god
+
merger - A datum that tracks a type or types of objects in a cluster
simple_asteroid/seeded - An asteroid with predetermined material makeup
+
+
mod_link - A MODlink datum, used to handle unique functions that will be used in the MODlink call.
+
mod_link_call - A MODlink call datum, used to handle the call between two MODlinks.
+
mod_part - Datum to handle interactions between a MODsuit and its parts.
+
mod_theme - MODsuit theme, instanced once and then used by MODsuits to grab various statistics.
+
module_picker - The datum and interface for the malf unlock menu, which lets them choose actions to unlock.
+
move_loop - Template class of the movement datums, handles the timing portion of the loops
+
disposal_holder - Disposal holders need to move through a chain of pipes
+Rather then through the world. This supports this
+If this ever changes, get rid of this, add drift component like logic to the holder
+And move them to move()
move_towards - Used as a alternative to walk_towards
+
move_towards_budget - The actual implementation of walk_towards()
+
+
move - Replacement for walk()
+
move_rand - This isn't actually the same as walk_rand
+Because walk_rand is really more like walk_to_rand
+It appears to pick a spot outside of range, and move towards it, then pick a new spot, etc.
+I can't actually replicate this on our side, because of how bad our pathfinding is, and cause I'm not totally sure I know what it's doing.
+I can just implement a random-walk though
+
move_to_rand - Wrapper around step_rand
+
+
movement_detector - A datum to handle the busywork of registering signals to handle in depth tracking of a movable
+
movement_packet - A packet of information that describes the current state of a moving object
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
black_hole - Black Hole - final (emag can spawn singulo, see death event)
+
black_hole_death - You died to a black hole, have some fluff text
+
electronic_part - Malfunction - spend one engine part or wait 3 days (emag effect randomizes some stats)
+
engine_part - Engine Breakdown - spend one engine part or wait 3 days (harmless emag effect)
+
hull_part - Collision - spend one engine part or wait 3 days (has a nasty emag effect)
+
space_port - You found a space port!
+
tau_ceti - You found the midway mark!
+
+
space_port_raid - You raided a space port!
+
+
Outfit datums - This is a clean system of applying outfits to mobs, if you need to equip someone in a uniform
+this is the way to do it cleanly and properly.
stacks_in_hands - See #66313 and #60901. outfit_sanity used to runtime whenever you had two mergable sheets in either hand. Previously, this only had a 3% chance of occuring. Now 100%.
+
+
pai_candidate - Created when a user clicks the "pAI candidate" window
chem_cooling - This trait is the opposite of above - it cools down the plant's chemical contents on harvest.
+This requires nutriment to fuel. 1u nutriment = -5 K.
+
chem_heating - This trait automatically heats up the plant's chemical contents when harvested.
+This requires nutriment to fuel. 1u nutriment = 25 K.
+
eyes - A plant trait that causes the plant to gain aesthetic googly eyes.
+
fire_resistance - Makes the plant and its seeds fireproof. From lavaland plants.
+
gas_production - Corpseflower's miasma production.
+Can be generalized in the future to spawn any gas, but I don't think that's necessarily a good idea.
juicing - Similar to auto-distilling, but instead of brewing the plant's contents it juices it.
+
maxchem - A plant trait that causes the plant's capacity to double.
+
mob_transformation - Traits for plants that can be activated to turn into a mob.
+
shroom - Walking Mushroom's transformation gene
+
tomato - Killer Tomato's transformation gene.
+
+
modified_volume - Traits for plants with a different base max_volume.
+
cherry_bomb - Cherry Bomb's increased max volume gene
+
omega_weed - Omegaweed's funny 420 max volume gene
+
+
one_bite - Traiit for plants eaten in 1 bite.
+
plant_laughter - Plays a laughter sound when someone slips on it.
+Like the sitcom component but for plants.
+Just like slippery skin, if we have a trash type this only functions on that. (Banana peels)
+
plant_type - Plant type traits. Incompatible with one another.
+
alien_properties - Currently unused and does nothing. Appears in strange seeds.
+
fungal_metabolism - Mushrooms need less light and have a minimum yield.
+
weed_hardy - Weeds don't get annoyed by weeds in their tray.
+
+
preserved - Traits for flowers, makes plants not decompose.
+
repeated_harvest - Allows a plant to be harvested multiple times.
blob - Holds any kind of abstract list data you'd like it to. MUST impliment is_valid!
+
augments - Augments!
+
job_priority - Associative list of job:integer, where integer is a priority between 1 and 4
+
+
choiced - A preference that is a choice of one option among a fixed set.
+Used for preferences such as clothing.
+
ai_core_display - What to show on the AI screen
+
backpack - Backpack preference
+
brief_outfit - What outfit to equip when spawning as a briefing officer for an ERT
+
employer - An associative list of job_name:employer_path
+
gender - Gender preference
+
ghost_lighting - How bright a ghost's lighting plane is
+
ghost_orbit - Determines what ghosts orbiting look like to you.
+
jumpsuit - Jumpsuit preference
+
mod_select - Switches between mouse buttons for MODsuit active modules
+
parallax - Determines parallax, "fancy space"
+
preferred_map - During map rotation, this will help determine the chosen map.
+
scaling_method - The scaling method to show the world in, e.g. nearest neighbor
+
socks - Socks preference
+
species - Species preference
+
ui_style - UI style preference
+
undershirt - Undershirt preference
+
underwear - Underwear preference
+
+
color - A preference that represents an RGB color of something.
+Will give the value as 6 hex digits, without a hash.
+
ooc_color - The color admins will speak in for OOC.
+
+
name - A preference for a name. Used not just for normal names, but also for clown names, etc.
+
backup_human - The name for a backup human, when nonhumans are made into head of staff
+
real_name - A character's real name
+
+
numeric - A numeric preference with a minimum and maximum value
+
toggle - A prefernece whose value is always TRUE or FALSE
+
bloom - Whether or not to toggle ambient occlusion, the shadows around people
+
broadcast_login_logout - Whether or not to announce when the player logs in or out.
+
darkened_flash - When toggled, being flashed will show a dark screen rather than a light one.
+
ghost_hud - Toggles the HUD for ghosts
+
glasses_color - Whether or not to toggle ambient occlusion, the shadows around people
+
inquisitive_ghost - Whether or not ghosts can examine things by clicking on them.
+
playtime_reward_cloak - This can be set to TRUE from the prefs menu only once the user has
+gained over 5K playtime hours.
+If true, it allows the user to get a cool looking roundstart cloak.
+
tgui_input_large - Large button preference. Error text is in tooltip.
+
tgui_input_swapped - Swapped button state - sets buttons to SS13 traditional SUBMIT/CANCEL
+
window_flashing - Enables flashing the window in your task tray for important events
preference_middleware - Preference middleware is code that helps to decentralize complicated preference features.
+
keybindings - Middleware to handle keybindings
+
legacy_toggles - In the before times, toggles were all stored in one bitfield.
+In order to preserve this existing data (and code) without massive
+migrations, this middleware attempts to handle this in a way
+transparent to the preferences UI itself.
+In the future, the existing toggles data should just be migrated to
+individual /datum/preference/toggles.
advanced - Movable and easily code-modified fields! Allows for custom AOE effects that affect movement
+and anything inside of them, and can do custom turf effects!
+Supports automatic recalculation/reset on movement.
qdel_item - Qdel Item: Holds statistics on each type that passes thru qdel
+Holds the type as a string for this type
+Total number of times it's passed thru qdel.
+Total amount of milliseconds spent processing this type's Destroy()
+Times it was queued for soft deletion but failed to soft delete.
+Different from failures because it also includes QDEL_HINT_HARDDEL deletions
+Total amount of milliseconds spent hard deleting this type.
+Highest time spent hard_deleting this in ms.
+Number of times hard deletes took longer than the configured threshold
+Number of times it's not respected force=TRUE
+Number of times it's not even bother to give a qdel hint
+Number of times it's slept in its destroy
+Flags related to this type's trip thru qdel.
junkie - If this is defined, reagent_id will be unused and the defined reagent type will be instead.
+actual instanced version of the reagent
+Where the drug spawned
+If this is defined before pill generation, pill generation will be skipped. This is the type of the pill bottle.
+where the accessory spawned
+If this is null, an accessory won't be spawned.
+how frequently the quirk processes
+ticker for processing
deaconize - Honorbound God
+Makes the person holy, but they now also have to follow the honorbound code (CBT). Actually earns favor, convincing others to uphold the code (tm) is not easy
Religious Sects - Religious Sects are a way to convert the fun of having an active 'god' (admin) to code-mechanics so you aren't having to press adminwho.
market_crash - An event which increases vendor prices on station by a factor of 4
+
spooky - You will appear adjacent to the beacon
+
stray_cargo - Spawns a cargo pod containing a random cargo supply pack on a random area of the station
+
syndicate - Places that shouldn't explode
+Subtypes from the above that actually should explode.
+A rare variant that drops a crate containing syndicate uplink items
attack - This steps can check sufficient weapon variables, such as sharpness or force
+
item - A parent type that denotes inserting an item
+
flashlight/again - Disambiguation go BRRRR
+
paper
+
fifth - Disambiguation go BRRRR
+
fourth - Disambiguation go BRRRR
+
second - Disambiguation go BRRRR
+
third - Disambiguation go BRRRR
+
+
pipe/second - Disambiguation go BRRRR
+
+
material - This step requires an amount of a stack items which will be split off and put into the assembly.
+
reagent - This step requires and uses a reagent to finish itself. This step is great as a last step since reagents can't be recovered from disassembly.
+This alternatively can also transfer to a container inside the crafting assembly too!
+
reagent_container - This step requires to input a reagent container, possibly with some reagent inside, or with some volume specifications.
+
stack - This step requires an amount of a stack items which will be split off and put into the assembly.
+
or_other - Can be a stack, another stack, or another item.
+
+
tool - This step requires an item with a specific tool behaviour.
+
+
smite - A smite, used by admins to punish players, or for their own amusement
+
bad_luck - Gives the target bad luck, optionally permanently
+
berforate - Fires an absurd amount of bullets at the target
+
bloodless - Slashes up the target
+
boneless - Gives the target critically bad wounds
+
brain_damage - Inflicts crippling brain damage on the target
Spatial Grid Cell - used by /datum/controller/subsystem/spatial_grid to cover every z level so that the coordinates of every turf in the world corresponds to one of these in
+the subsystems list of grid cells by z level. each one of these contains content lists holding all atoms meeting a certain criteria that is in our borders.
+these datums shouldnt have significant behavior, they should just hold data. the lists are filled and emptied by the subsystem.
+
species datum - Datum that handles different species in the game.
station_alert - Our parent might want to fuck with these numbers
+
station_request - A combined all in one datum that stores everything about the request, the requester's account, as well as the requestee's account
+All of this is passed to the Request Console UI in order to present in organized way.
+
station_state - For counting up how much of the station exists at the start of the shift, and how much is left behind by the end of it.
+
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.
status_effect - Status effects are used to apply temporary or permanent effects to mobs.
+This file contains their code, plus code for applying and removing them.
grouped - Status effect from multiple sources, when all sources are removed, so is the effect
+
hazard_area - The dedicated status effect for the hazard_area component - use with caution and know what it does!
+
incapacitating
+
incapacitated - This status effect represents anything that leaves a character unable to perform basic tasks (interrupting do-afters, for example), but doesn't incapacitate them further than that (no stuns etc..)
inebriated - The drunk status effect.
+Slowly decreases in drunk_value over time, causing effects based on that value.
+
drunk - Stage 2 of being drunk, applied at drunk values between 6 and onward.
+Has all the main side effects of being drunk, scaling up as they get more drunk.
+
tipsy - Stage 1 of drunk, applied at drunk values between 0 and 6.
+Basically is the "drunk but no side effects" stage.
protective_blades - Summons multiple foating knives around the owner.
+Each knife will block an attack straight up.
+
recharging - A subtype that doesn't self-delete / disappear when all blades are gone
+It instead regenerates over time back to the max after blades are consumed
tinlux_light - Makes the mob luminescent for the duration of the effect.
+
unholy_determination - The buff given to people within the shadow realm to assist them in surviving.
+
+
storage - Datumized Storage
+Eliminates the need for custom signals specifically for the storage component, and attaches a storage variable (atom_storage) to every atom.
+If you're looking to create custom storage type behaviors, check ../subtypes
+
holster - A type of storage where a number of slots are reserved for a specific type of item
+
tcg - A storage component to be used on card piles, for use as hands/decks/discard piles. Don't use on something that's not a card pile!
tgs_chat_command - User definable chat command. This abstract version MUST be overridden to be used.
+
tgs_chat_embed
+
field - See https://discord.com/developers/docs/resources/message#embed-object-embed-field-structure for details.
+
footer - See https://discord.com/developers/docs/resources/message#embed-object-embed-footer-structure for details.
+
media - Common datum for similar Discord embed medias.
+
provider - See https://discord.com/developers/docs/resources/message#embed-object-embed-provider-structure for details.
+
author - See https://discord.com/developers/docs/resources/message#embed-object-embed-author-structure for details. Must have name set in New().
+
+
structure - User definable chat embed. Currently mirrors Discord chat embeds. See https://discord.com/developers/docs/resources/message#embed-object for details.
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.
+
async tgui_input_number - An asynchronous version of tgui_input_number to be used with callbacks instead of waiting on user responses.
+
+
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.
+
async tgui_input_text - An asynchronous version of tgui_input_text to be used with callbacks instead of waiting on user responses.
+
+
tgui_list_input - Client does NOT have tgui_input on: Returns regular input
+
async tgui_list_input - An asynchronous version of tgui_list_input to be used with callbacks instead of waiting on user responses.
+
+
tgui_modal - Datum used for instantiating and using a TGUI-controlled modal that prompts the user with
+a message and has buttons for responses.
+
async tgui_modal - An asynchronous version of tgui_modal to be used with callbacks instead of waiting on user responses.
+
+
tgui_panel - tgui_panel datum
+Hosts tgchat and other nice features.
Timed Event - This is the actual timer, it contains the callback and necessary data to maintain
+the timer.
+
traitor_category_handler - The traitor category handler. This is where the probability of all objectives are managed.
+
traitor_objective - A traitor objective. Traitor objectives should not be deleted after they have been created and established, only failed.
+If a traitor objective needs to be removed from the failed/completed objective list of their handler, then you are doing something wrong
+and you should reconsider. When an objective is failed/completed, that is final and the only way you can change that is by refactoring the code.
traitor_objective_category - The objective category.
+Used to group up entire objectives into 1 weight objects to prevent having a
+higher chance of getting an objective due to an increased number of different objective subtypes.
+These are nothing but informational holders and will have no other purpose.
+
triple_ai_controller - The triple ai controller handles the admin triple AI mode, if enabled.
+It is first created when "Toggle AI Triumvirate" triggers it, and it can be referenced from GLOB.triple_ai_controller
+After it handles roundstart business, it cleans itself up.
bloody_footprints - Tests to make sure bloody footprits work as expected
+So no stacking, they actually apply, and shoe staining thrown in for free
+
breath_sanity - Tests to make sure humans can breath in normal situations
+Built to prevent regression on an issue surrounding QUANTIZE() and BREATH_VOLUME
+See the comment on BREATH_VOLUME for more details
+
breath_sanity_plasmamen - Tests to make sure plasmaman can breath from their internal tanks
+
chat_filter_sanity - Tests the sanity of the chat filter, ensuring it properly blocks words and gives the reason
+
circuit_component_category - Tests to make sure each circuit component that could potentially be available to a player has a category
+
closets - Checks that the length of the initial contents of a closet doesn't exceed its storage capacity
+
connect_loc_basic - Test that the connect_loc element handles basic movement cases
+
connect_loc_change_turf - Test that the connect_loc element handles turf changes
+
connect_loc_multiple_on_turf - Tests that multiple objects can have connect_loc on the same turf without runtimes.
crayon_naming - Makes sure that crayons have their crayon_color in their initial name (to differentiate them in the crafting menu).
+
create_and_destroy - Delete one of every type, sleep a while, then check to see if anything has gone fucky
+
dcs_get_id_from_arguments - Tests that DCS' GetIdFromArguments works as expected with standard and odd cases
+
dummy_spawn_outfit - Equips and devests our dummy of one of every job outfit
+
dummy_spawn_species - This set of tests is focused on ensuring the stability of preference dummies
+And by extension the hacks built to make them fast
+Organ consistency, object pooling via the wardrobe ss, etc
+
dynamic_roundstart_ruleset_sanity - Verifies that roundstart dynamic rulesets are setup properly without external configuration.
+
dynamic_unique_antag_flags - Verifies that dynamic rulesets have unique antag_flag.
+
egg_glands - Verifies that all glands for an egg are valid
+
food_edibility_check - Makes sure that spawned food has reagents and the edible component (or else it can't be eaten).
get_message_mods - Test to verify message mods are parsed correctly
+
get_turf_pixel - ensures that get_turf_pixel() returns turfs within the bounds of the map,
+even when called on a movable with its sprite out of bounds
+
greyscale_color_count - Makes sure objects using greyscale configs have, if any, the correct number of colors
+
greyscale_item_icon_states - Makes sure items using GAGS have all the icon states needed to work
+
handcuff_bite - Tests handcuffed (HANDS_BLOCKED) monkeys can still bite despite being cuffed
hulk_attack - Tests hulk attacking over normal attacking
+
hulk_north_star - Tests that hulks aren't given rapid attacks from rapid attack gloves
+
hydroponics_extractor_storage - Unit test to ensure seeds can properly be added to the plant seed extractor through multiple methods.
+This only tests transferring seeds to the storage, it does NOT test creating seeds.
mind_swap_spell - Validates that the mind swap spell
+properly transfers minds between a caster and a target.
+
mob_spawn - Verifies that all glands for an egg are valid
+
modsuit_checks - Checks all pre-equipped MODsuit paths to see if they have something set wrong.
+
novaflower_burn - Unit tests that the novaflower's unique genes function.
+
paintings - Checks that all kind of painting frames have a sprite for each canvas type in the game.
+
preferences_implement_everything - Requires all preferences to implement required methods.
+
preferences_valid_savefile_key - Requires all preferences to have a valid, unique savefile_identifier.
+
quirk_icons - Ensure every quirk has a unique icon
+
reagent_names - Test that all reagent names are different in order to prevent tgstation#65231
+
say_signal - Test to verify COMSIG_MOB_SAY is sent the exact same list as the message args, as they're operated on
+
screenshot_antag_icons - A screenshot test to make sure every antag icon in the preferences menu is consistent
+
screenshot_basic - This is an example for screenshot tests, and a meta-test to make sure they work in the success case.
+It creates a picture that is red on the left side, green on the other.
+
screenshot_humanoids - A screenshot test for every humanoid species with a handful of jobs.
species_unique_id - Every species should use a species ID unique to it and it alone. This test runs through every subtype of /datum/species, and checks for a species ID.
+Every ID is written to a list, gathered_species_ids, and if a previously written ID is written again, this test will fail.
+
speech - This runs some simple speech tests on a speaker and listener and determines if a person can hear whispering or speaking as they are moved a distance away
+
spell_invocations - Validates that all spells have a correct
+invocation type and invocation setup.
+
spell_names - Validates that all spells have a different name.
+
stack_singular_name - Goes through every subtype of /obj/item/stack to check for a singular name, var/singular_name.
+Everything within the blacklist does not need to be tested because it exists to be overriden.
+This test will fail if a subtype of /obj/item/stack is missing a singular name.
living - Brutal damage caused by brute force (punching, being clubbed by a toolbox ect... this also accounts for pressure damage)
+Oxygen depravation damage (no air in lungs)
+Toxic damage caused by being poisoned or radiated
+Burn damage caused by being way too hot, too cold or burnt.
+Damage caused by being cloned or ejected from the cloner early. slimes also deal cloneloss damage to victims
+Used by [living/Bump()][/mob/living/proc/Bump] and [living/PushAM()][/mob/living/proc/PushAM] to prevent potential infinite loop.
+
basic - Simple animals 2.0, This time, let's really try to keep it simple. This basetype should purely be used as a base-level for implementing simplified behaviours for things such as damage and attacks. Everything else should be in components or AI behaviours.
human - Any humanoid (non-Xeno) mob, such as humans, plasmamen, lizards.
+
consistent - Provides a dummy for unit_tests that functions like a normal human, but with a standardized appearance
+Copies the stock dna setup from the dummy/consistent type
robot_defines - Definitions for /mob/living/silicon/robot and its children, including AI shells.
+
nocell - Defining specific kinds of robots
+This is the subtype that gets created by robot suits. It's needed so that those kind of borgs don't have a useless cell in them
+
+
+
simple_animal - Simple, mostly AI-controlled critters, such as pets, bots, and drones.
Wumborian Fugu - A strange alien creature capable of increasing its mass when threatened,
+giving it unmatched defensive capabilities temporarily. The rest of the
+time, it is quite fragile.
lobstrosity - Lobstrosities, the poster boy of charging AI mobs. Drops crab meat and bones.
+Outside of charging, it's intended behavior is that it is generally slow moving, but makes up for that with a knockdown attack to score additional hits.
vatbeast - Vatbeasts are creatures from vatgrowing and are literaly a beast in a vat, yup. They are designed to be a powerful mount roughly equal to a gorilla in power.
proccall_handler - Used to handle proccalls called indirectly by an admin (e.g. tgs, circuits).
+Has to be a mob because IsAdminAdvancedProcCall() checks usr, which is a mob variable.
+So usr is set to this for any proccalls that don't have any usr mob/client to refer to.
durand_shield - Shield processing
+*An object to take the hit for us when using the Durand's defense mode.
+It is spawned in during the durand's initilization, and always stays on the same tile.
+Normally invisible, until defense mode is actvated. When the durand detects an attack that should be blocked, the
+attack is passed to the shield. The shield takes the damage, uses it to calculate charge cost, and then sets its
+own integrity back to max. Shield is automatically dropped if we run out of power or the user gets out.
+
effect
+
abstract - The abstract effect ignores even more effects and is often typechecked for atoms that should truly not be fucked with.
info - An info button that, when clicked, puts some text in the user's chat
+
particle_emitter - This is a special stripped down alternative to a particle_holder. Generally, I don't recommend using it.
+
particle_holder - objects can only have one particle on them at a time, so we use these abstract effects to hold and display the effects. You know, so multiple particle effects can exist at once.
+also because some objects do not display particles due to how their visuals are built
+
smell_holder - An object for placing smells in the world that aren't attached to a physical object
heretic - Lardmarks meant to designate where heretic sacrifices are sent.
+
lift_id - lift_id landmarks. used to map in specific_lift_id to trams. when the trams lift_master encounters one on a trams tile
+it sets its specific_lift_id to that landmark. allows you to have multiple trams and multiple controls linking to their specific tram
corpse - these mob spawn subtypes trigger immediately (New or Initialize) and are not player controlled... since they're dead, you know?
+
ai - dead ai, blue screen and everything.
+
facehugger - dead facehuggers, great for xeno ruins so you can have a cool ruin without spiraling the entire round into xenomorph hell. also, this is a terrible terrible artifact of time
Index Table Component - Gets the row of a table using the index inputted. Will return no value if the index is invalid or a proper table is not returned.
light - only has cyborg flashing since felinid moving spikes time dilation when spammed and the other two features of laserpointers would be unbalanced when spammed
+no stunning, just a blind
+laserpointer image
Bar Overlay Component - Basically an advanced verion of object overlay component that shows a horizontal/vertical bar.
+Requires a BCI shell.
+
+
Pathfinding component - Calcualtes a path, returns a list of entities. Each entity is the next step in the path. Can be used with the direction component to move.
+
Proximity Pinpointer Component - Return the location of its input.
SDQL Component - A component that performs an sdql operation
+
Select Component - Selects a list from a list of lists by a specific column. Used only by USBs for communications to and from computers with lists of varying sizes.
recharger/cyborg - This recharger exists only in borg built-in tablets. I would have tied it to the borg's cell but
+the program that displays laws should always be usable, and the exceptions were starting to pile.
internal - Base console's internal RCD. Has a large material capacity and a fast buildspeed.
+
+
+
Compact Remote - A handheld device with several buttons.
+In game, this translates to having different signals for normal usage, alt-clicking, and ctrl-clicking when in your hand.
monkeycube/syndicate - internal proc called by a monkeycube's suicide_act using a timer and callback. takes as argument the mob/living who activated the suicide
+
muffin - MUFFINS
+
patty/plain - Exists purely for the crafting recipe (because itll take subtypes)
Spider Charge - A unique version of c4 possessed only by the space ninja. Has a stronger blast radius.
+Can only be detonated by space ninjas with the bombing objective. Can only be set up where the objective says it can.
+When it primes, the space ninja responsible will have their objective set to complete.
smokebomb - This is smoke bomb, mezum koman. It is a grenade subtype. All craftmanship is of the highest quality.
+It menaces with spikes of iron. On it is a depiction of an assistant.
+The assistant is bleeding. The assistant has a painful expression. The assistant is dead.
ballistic - Subtype for any kind of ballistic gun
+This has a shitload of vars on it, and I'm sorry for that, but it does make making new subtypes really easy
exile/noteleport - Used to help the staff of the space hotel resist the urge to use the space hotel's incredibly alluring roundstart teleporter to ignore their flavor/greeting text and come to the station.
implantcase - Item used to store implants. Can be renamed with a pen. Implants are moved between those and implanters when a mob uses an implanter on a case.
+
sad_trombone - Implant case that spawns with a sad trombone implant, as well as an appropriate name and description
+
tracking - An implant case that spawns with a tracking implant, as well as an appropriate name and description.
+
weapons_auth - An implant case that spawns with a firearms authentication implant, as well as an appropriate name and description.
+
+
implanter - Players can use this item to put obj/item/implant's in living mobs. Can be renamed with a pen.
+
sad_trombone - Implanter that spawns with a sad trombone implant, as well as an appropriate name
+
+
N-spect scanner - Creates reports for area inspection bounties.
clamp - Hydraulic Clamp - Lets you pick up and drop crates.
+
constructor - Constructor - Lets you build quicker and create RCD holograms.
+
dispenser - Dispenser - Dispenses an item after a time passes.
+
dna_lock - DNA Lock - Prevents people without the set DNA from activating the suit.
+
drill - Drill - Lets you dig through rock and basalt.
+
emp_shield - EMP Shield - Protects the suit from EMPs.
+
energy_shield - Energy Shield - Gives you a rechargeable energy shield that nullifies attacks.
+
eradication_lock - Eradication lock - Prevents people who aren't the owner of the suit from existing on the timeline via eradicating the suit with the intruder inside
+
flamethrower - Flamethrower - Launches fire across the area.
+
flashlight - Flashlight - Gives the suit a customizable flashlight.
+
gps - Internal GPS - Extends a GPS you can use.
+
hat_stabilizer - Hat Stabilizer - Allows displaying a hat over the MOD-helmet, àla plasmamen helmets.
+
health_analyzer - Health Analyzer - Gives the user a ranged health analyzer and their health status in the panel.
paper - Paper is now using markdown (like in github pull notes) for ALL rendering
+so we do loose a bit of functionality but we gain in easy of use of
+paper and getting rid of that crashing bug
+
construction - Construction paper
+
contractor_guide - Contractors
+
crumpled/ruins
+
bigderelict1/manifest - bigderelict1 items
+
snowdin/foreshadowing - papers
+
+
fake_report - Reports printed by fake N-spect scanner
robot_model - Definition of /obj/item/robot_model, which defines behavior for each model.
+Deals with the creation and deletion of modules (tools).
+Assigns modules and traits to a borg with a specific model selected.
emissive_test - Floor tiles used to test emissive turfs.
+
light - If we can't create a window out of this type, return FALSE to not affect attack chain.
+Dense turf (most likely closed). Why check types of if you can check .density
+Something we were mounting the window on was deleted, or unanchored
tcgcard_deck - A stack item that's not actually a stack because ORDER MATTERS with a deck of cards!
+The "top" card of the deck will always be the bottom card in the stack for our purposes.
udder item - Abstract item that is held in nullspace and manages reagents. Created by udder component.
+While perhaps reagents created by udder component COULD be managed in the mob, it would be somewhat finnicky and I actually like the abstract udders.
+
slug - Slug "udders". I'm so sorry it has to be this way
wirebrush - The wirebrush is a tool whose sole purpose is to remove rust from anything that is rusty.
+Because of the inherent nature of hard countering rust heretics it does it very slowly.
chem_master - Machine that allows to identify and separate reagents in fitting container
+as well as to create new containers with separated reagents in it.
+
condimaster - Machine that allows to identify and separate reagents in fitting container
+as well as to create new containers with separated reagents in it.
mystery_box_item - This represents the item that comes out of the box and is constantly changing before the box finishes deciding. Can probably be just an /atom or /movable.
turf - Any floor or wall. What makes up the station and the rest of the map.
+If present, a turf above that is copying this turf. Implies a Z-connection and that the turf above is a z-mimic enabled turf.
+If present, the turf below that we are copying. Implies a Z-connection and that this is a z-mimic enabled turf.
+If we're a non-overwrite z-turf, this holds the appearance of the bottom-most Z-turf in the z-stack.
+Object used to multiply color of all OO overlays at once.
+If this is a delegate (non-overwrite) Z-turf with a z-turf above, this is the delegate copy that's copying us.
+If we're at the bottom of the stack, a proxy used to fake a below space turf.
+Cached computed depth, used in analyzer.
emissive_test - An emissive turf used to test emissive turfs.
+
engine/hull/ceiling - RCD-immune plating generated only by shuttle code for shuttle ceilings on multi-z maps, should not be mapped in or creatable in any other way
misc - Used as a parent type for types that want to allow construction, but do not want to be floors
+I wish I could use components for turfs at scale
+Please do not bloat this. Love you <3
The current client inhabiting this mob. Managed by login/logout
+This exists so we can do cleanup in logout for occasions where a client was transfere rather then destroyed
+We need to do this because the mob on logout never actually has a reference to client
+We also need to clear this var/do other cleanup in client/Destroy, since that happens before logout
+HHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHH
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
Add a action speed modifier to a mob. If a variable subtype is passed in as the first argument, it will make a new datum. If ID conflicts, it will overwrite the old ID.
Add a move speed modifier to a mob. If a variable subtype is passed in as the first argument, it will make a new datum. If ID conflicts, it will overwrite the old ID.
Adds the cliented mob reference to the list of all player-mobs, besides to either the of dead or alive player-mob lists, as appropriate. Called on Login().
Cleanup proc that's called when a mob loses a client, either through client destroy or logout
+Logout happens post client del, so we can't just copypaste this there. This keeps things clean and consistent
the item in our active hand
+our active hand, to check if it's disabled/detatched
+how long it takes for the blind person to find the thing they're examining
+our current intent, so we can go back to it after touching
propogates ourselves through our nested contents, similar to other important_recursive_contents procs
+main difference is that client contents need to possibly duplicate recursive contents for the clients mob AND its eye
Gets what slot the item on the mob is held in.
+Returns null if the item isn't in any slots on our mob.
+Does not check if the passed item is null, which may result in unexpected outcoms.
Finds a target near a mob that is viable for pushing off when moving.
+Takes the intended movement direction as input, alongside if the context is checking if we're allowed to continue drifting
handle_eye_contact() is called when we examine() something. If we examine an alive mob with a mind who has examined us in the last 2 seconds within 5 tiles, we make eye contact!
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:
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.
Removes the mob reference from the list of all player-mobs, besides from either the of dead or alive player-mob lists, as appropriate. Called on Logout().
Proc to create or update an alert. Returns the alert if the alert is new or updated, 0 if it was thrown already
+category is a text string. Each mob may only have one alert per category; the previous one will be replaced
+path is a type path of the actual alert type to throw
+severity is an optional number that will be placed at the end of the icon_state for this alert
+for example, high pressure's icon_state is "highpressure" and can be serverity 1 or 2 to get "highpressure1" or "highpressure2"
+new_master is optional and sets the alert's icon state to "template" in the ui_style icons with the master as an overlay.
+flicks are forwarded to master
+override makes it so the alert is not replaced until cleared by a clear_alert with clear_override, and it's used for hallucinations.
Go through the list of actionspeed modifiers and calculate a final actionspeed. ANY ADD/REMOVE DONE IN UPDATE_actionspeed MUST HAVE THE UPDATE ARGUMENT SET AS FALSE!
Go through the list of movespeed modifiers and calculate a final movespeed. ANY ADD/REMOVE DONE IN UPDATE_MOVESPEED MUST HAVE THE UPDATE ARGUMENT SET AS FALSE!
The current client inhabiting this mob. Managed by login/logout
+This exists so we can do cleanup in logout for occasions where a client was transfere rather then destroyed
+We need to do this because the mob on logout never actually has a reference to client
+We also need to clear this var/do other cleanup in client/Destroy, since that happens before logout
+HHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHH
If an admin possesses an object it's real name is set to the admin name and this
+stores whatever the real name was previously. When possession ends, the real name
+is reset to this value
After that, mostly just check your state, check whether you're holding an item,
+check whether you're adjacent to the target, then pass off the click to whoever
+is receiving it.
+The most common are:
+
+
mob/proc/UnarmedAttack (atom,adjacent) - used here only when adjacent, with no item in hand; in the case of humans, checks gloves
attaches the ash listener element so clients can hear weather
+client can be deleted mid-execution of this proc, chiefly on parent calls, with lag
+
MiddleClickOn
+
+
Middle click
+Mainly used for swapping hands
MouseDrop
+
+
Controls if a mouse drop succeeds (return null if it doesnt)
MouseWheelOn
+
+
MouseWheelOn
Process_Spacemove
+
+
Handles mob/living movement in space (or no gravity)
+
Called by /client/Move()
+
return TRUE for movement or FALSE for none
+
You can move in space if you have a spacewalk ability
RangedAttack
+
+
Ranged unarmed attack:
+
This currently is just a default for all mobs, involving
+laser eyes and telekinesis. You could easily add exceptions
+for things like ranged glove touches, spitting alien acid/neurotoxin,
+animals lunging, etc.
ShiftClickOn
+
+
Shift click
+For most mobs, examine.
+This is overridden in ai.dm
Topic
+
+
Topic call back for any mob
+
+
Unset machines if "mach_close" sent
+
refresh the inventory of machines in range if "refresh" sent
+
handles the strip panel equip and unequip as well if "item" sent
+
UnarmedAttack
+
+
UnarmedAttack: The higest level of mob click chain discounting click itself.
+
This handles, just "clicking on something" without an item. It translates
+into atom/proc/attack_hand, [atom/proc/attack_animal] etc.
+
Note: proximity_flag here is used to distinguish between normal usage (flag=1),
+and usage when clicking on things telekinetically (flag=0). This proc will
+not be called at ranged except with telekinesis.
+
proximity_flag is not currently passed to attack_hand, and is instead used
+in human click code to allow glove touches only at melee range.
+
modifiers is a lazy list of click modifiers this attack had,
+used for figuring out different properties of the click, mostly right vs left and such.
_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
abandon_mob
+
+
Allows you to respawn, abandoning your current mob
+
This sends you back to the lobby creating a new dead mob
+
Only works if flag/norespawn is allowed in config
add_actionspeed_modifier
+
+
Add a action speed modifier to a mob. If a variable subtype is passed in as the first argument, it will make a new datum. If ID conflicts, it will overwrite the old ID.
add_client_colour
+
+
Adds an instance of colour_type to the mob's client_colours list
+colour_type - a typepath (subtyped from /datum/client_colour)
add_movespeed_modifier
+
+
Add a move speed modifier to a mob. If a variable subtype is passed in as the first argument, it will make a new datum. If ID conflicts, it will overwrite the old ID.
add_to_alive_mob_list
+
+
Adds the mob reference to the list of all mobs alive. If mob is cliented, it adds it to the list of all living player-mobs.
add_to_current_dead_players
+
+
Adds the cliented mob reference to either the list of dead player-mobs or to the list of observers, depending on how they joined the game.
add_to_current_living_antags
+
+
Adds the cliented mob reference to the list of living antag player-mobs.
add_to_current_living_players
+
+
Adds the cliented mob reference to the list of living player-mobs. If the mob is an antag, it adds it to the list of living antag player-mobs.
add_to_dead_mob_list
+
+
Adds the mob reference to the list of all the dead mobs. If mob is cliented, it adds it to the list of all dead player-mobs.
add_to_mob_list
+
+
Adds the mob reference to the list and directory of all mobs. Called on Initialize().
add_to_mob_suicide_list
+
+
Adds a mob reference to the list of all suicided mobs
add_to_player_list
+
+
Adds the cliented mob reference to the list of all player-mobs, besides to either the of dead or alive player-mob lists, as appropriate. Called on Login().
adjust_blindness
+
+
Adjust a mobs blindness by an amount
+
Will apply the blind alerts if needed
adjust_blurriness
+
+
Adjust the current blurriness of the mobs vision by amount
adjust_bodytemperature
+
+
Adjust the body temperature of a mob, with min/max settings
adjust_disgust
+
+
Adjust the disgust level of a mob
adjust_drowsyness
+
+
Adds passed value to the drowsyness of a mob
adjust_nutrition
+
+
Adjust the nutrition of a mob
airflow_stun
+
+
Applies the effects of the mob colliding with another movable due to airflow.
animate_client_colour
+
+
Works similarly to 'update_client_colour', but animated.
apply_pref_name
+
+
Generalised helper proc for letting mobs rename themselves. Used to be clname() and ainame()
attack_ui
+
+
This proc is called whenever someone clicks an inventory ui slot.
+
Mostly tries to put the item into the slot if possible, or call attack hand
+on the item in the slot if the users active hand is empty
audible_message
+
+
Show a message to all mobs in earshot of this one
+
This would be for audible actions by the src mob
+
vars:
+
+
message is the message output to anyone who can hear.
+
self_message (optional) is what the src mob hears.
+
deaf_message (optional) is what deaf people will see.
+
hearing_distance (optional) is the range, how many tiles away the message can be heard.
+
auto_deadmin_on_login
+
+
Checks if the attached client is an admin and may deadmin them
+
Configs:
+
+
flag/auto_deadmin_players
+
client.prefs?.toggles & DEADMIN_ALWAYS
+
User is antag and flag/auto_deadmin_antagonists or client.prefs?.toggles & DEADMIN_ANTAGONIST
+
or if their job demands a deadminning SSjob.handle_auto_deadmin_roles()
Cleanup proc that's called when a mob loses a client, either through client destroy or logout
+Logout happens post client del, so we can't just copypaste this there. This keeps things clean and consistent
blind_eyes
+
+
Blind a mobs eyes by amount
blur_eyes
+
+
Make the mobs vision blurry
broadcast_examine
+
+
Tells nearby mobs about our examination.
buckle_mob
+
+
Buckle a living mob to this mob. Also turns you to face the other mob
+
You can buckle on mobs if you're next to them since most are dense
canUnequipItem
+
+
Test if an item can be dropped, core to tryUnequipItem()
canUseStorage
+
+
Can this mob use storage
canUseTopic
+
+
Can the mob use Topic to interact with machines
can_block_magic
+
+
Checks to see if the mob can block magic
+
args:
+
+
casted_magic_flags (optional) A bitfield with the types of magic resistance being checked (see flags at: /datum/component/anti_magic)
+
charge_cost (optional) The cost of charge to block a spell that will be subtracted from the protection used
+
can_cast_magic
+
+
Checks to see if the mob can cast normal magic spells.
+
args:
+
+
magic_flags (optional) A bitfield with the type of magic being cast (see flags at: /datum/component/anti_magic)
+
can_hear
+
+
Can the mob hear
can_hold_items
+
+
Can this mob hold items
can_interact_with
+
+
Can the mob interact() with an atom?
can_read
+
+
Can this mob read
can_resist
+
+
Can this mob resist (default FALSE)
can_see_reagents
+
+
Can the mob see reagents inside of containers?
can_smell
+
+
Can this mob SMELL THE SMELLY SMELLS?
cancel_camera
+
+
Sometimes helps if the user is stuck in another perspective or camera
canface
+
+
Returns true if a mob can turn to face things
+
Conditions:
+
+
client.last_turn > world.time
+
not dead or unconcious
+
not anchored
+
no transform not set
+
we are not restrained
+
check_emote
+
+
Check if this message is an emote
clear_from_recent_examines
+
+
the item in our active hand
+our active hand, to check if it's disabled/detatched
+how long it takes for the blind person to find the thing they're examining
+our current intent, so we can go back to it after touching
clear_important_client_contents
+
+
We got our awareness updated by the important recursive contents stuff, now we add our membership
+Clears the clients channel of this mob
click_random_mob
+
+
Clicks a random nearby mob with the source from this mob
common_trait_examine
+
+
Examine text for traits shared by multiple types.
+
I wish examine was less copypasted. (oranges say, be the change you want to see buddy)
create_chat_message
+
+
Creates a message overlay at a defined location for a given speaker
+
Arguments:
+
+
speaker - The atom who is saying this message
+
message_language - The language that the message is said in
+
raw_message - The text content of the message
+
spans - Additional classes to be added to the message
+
sound_loc - The atom the message was heard from. Usually a speaker_location().
+
default_lighting_alpha
+
+
Returns this mob's default lighting alpha
do_after_count
+
+
Returns the total amount of do_afters this mob is taking part in
do_set_blindness
+
+
Proc that handles adding and removing the blindness overlays.
down
+
+
Moves a mob down a z level
dropItemToGround
+
+
Used to drop an item (if it exists) to the ground.
+
+
Will pass as TRUE is successfully dropped, or if there is no item to drop.
+
Will pass FALSE if the item can not be dropped due to TRAIT_NODROP via tryUnequipItem()
+If the item can be dropped, it will be forceMove()'d to the ground and the turf's Entered() will be called.
+
eastface
+
+
Hidden verb to turn east
enable_client_mobs_in_contents
+
+
propogates ourselves through our nested contents, similar to other important_recursive_contents procs
+main difference is that client contents need to possibly duplicate recursive contents for the clients mob AND its eye
equip_to_appropriate_slot
+
+
Auto equip the passed in item the appropriate slot based on equipment priority
+
puts the item "W" into an appropriate slot in a human's inventory
+
returns 0 if it cannot, 1 if successful
equip_to_slot
+
+
Actually equips an item to a slot (UNSAFE)
+
This is an UNSAFE proc. It merely handles the actual job of equipping. All the checks on
+whether you can or can't equip need to be done before! Use mob_can_equip() for that task.
+
In most cases you will want to use equip_to_slot_if_possible()
equip_to_slot_if_possible
+
+
Try to equip an item to a slot on the mob
+
This is a SAFE proc. Use this instead of equip_to_slot()!
+
set qdel_on_fail to have it delete W if it fails to equip
+
set disable_warning to disable the 'you are unable to equip that' warning.
+
unset redraw_mob to prevent the mob icons from being redrawn at the end.
+
Initial is used to indicate whether or not this is the initial equipment (job datums etc) or just a player doing it
equip_to_slot_or_del
+
+
Equip an item to the slot or delete
+
This is just a commonly used configuration for the equip_to_slot_if_possible() proc, used to
+equip people when the round starts and when events happen and such.
+
Also bypasses equip delay checks, since the mob isn't actually putting it on.
+Initial is used to indicate whether or not this is the initial equipment (job datums etc) or just a player doing it
equipped_speed_mods
+
+
Gets the combined speed modification of all worn items
+Except base mob type doesnt really wear items
examinate
+
+
Signal sent after the eye has been successfully updated, with the client existing.
+Examine a mob
+
mob verbs are faster than object verbs. See
+this byond forum post
+for why this isn't atom/verb/examine()
execute_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
execute_quick_equip
+
+
proc extender of [/mob/verb/quick_equip] used to make the verb queuable if the server is overloaded
face_atom
+
+
Simple helper to face what you clicked on, in case it should be needed in more than one place
faction_check_mob
+
+
Check if the other mob has any factions the same as us
+
If exact match is set, then all our factions must match exactly
first_name
+
+
Find the first name of a mob from the real name with regex
fully_replace_character_name
+
+
Fully update the name of a mob
+
This will update a mob's name, real_name, mind.name, SSdatacore records, pda, id and traitor text
+
Calling this proc without an oldname will only update the mob and skip updating the pda, id and records ~Carn
get_actions_for_statpanel
+
+
Convert a list of spells into a displyable list for the statpanel
+
Shows charge and other important info
get_actionspeed_modifiers
+
+
Get the action speed modifiers list of the mob
get_active_hand
+
+
Get the bodypart for whatever hand we have active, Only relevant for carbons
get_active_held_item
+
+
Returns the thing we're currently holding
get_config_move_delay
+
+
Get the global config movespeed of a mob by type
get_empty_held_index
+
+
Returns the first available empty held index
get_equipped_items
+
+
Used to return a list of equipped items on a mob; does not include held items (use get_all_gear)
+
Argument(s):
+
+
Optional - include_pockets (TRUE/FALSE), whether or not to include the pockets and suit storage in the returned list
+
get_ghost
+
+
Get the ghost of this mob (from the mind)
get_hand_pixels
+
+
Returns a list of (x,y) coordinates, in pixel offsets.
get_item_by_slot
+
+
Get the item on the mob in the storage slot identified by the id passed in
get_message_mods
+
+
Extracts and cleans message of any extenstions at the begining of the message
+Inserts the info into the passed list, returns the cleaned message
+
Result can be
+
+
SAY_MODE (Things like aliens, channels that aren't channels)
+
MODE_WHISPER (Quiet speech)
+
MODE_SING (Singing)
+
MODE_HEADSET (Common radio channel)
+
RADIO_EXTENSION the extension we're using (lots of values here)
+
RADIO_KEY the radio key we're using, to make some things easier later (lots of values here)
+
LANGUAGE_EXTENSION the language we're trying to use (lots of values here)
+
get_mob_buckling_height
+
+
returns the height in pixel the mob should have when buckled to another mob.
get_mouse_pointer_icon
+
+
Gets the dmi file for the mouse pointer the attached client should use
get_movespeed_modifiers
+
+
Get the move speed modifiers list of the mob
get_num_held_items
+
+
Find number of held items, multihand compatible
get_photo_description
+
+
Return the desc of this mob for a photo
get_policy_keywords
+
+
Get the list of keywords for policy config
+
This gets the type, mind assigned roles and antag datums as a list, these are later used
+to send the user relevant headadmin policy config
get_random_valid_zone
+
+
More or less ran_zone, but only returns bodyzones that the mob /actually/ has.
+
+
+
blacklisted_parts - allows you to specify zones that will not be chosen. eg: list(BODY_ZONE_CHEST, BODY_ZONE_R_LEG)
+
+
+
+
!!!! blacklisting BODY_ZONE_CHEST is really risky since it's the only bodypart guarunteed to ALWAYS exists !!!!
+
+
+
+
+
!!!! Only do that if you're REALLY CERTAIN they have limbs, otherwise we'll CRASH() !!!!
+
+
+
+
ran_zone has a base prob(80) to return the base_zone (or if null, BODY_ZONE_CHEST) vs something in our generated list of limbs.
+
+
+
this probability is overriden when either blacklisted_parts contains BODY_ZONE_CHEST and we aren't passed a base_zone (since the default fallback for ran_zone would be the chest in that scenario), or if even_weights is enabled.
+
+
+
you can also manually adjust this probability by altering base_probability
+
+
+
even_weights - ran_zone has a 40% chance (after the prob(80) mentioned above) of picking a limb, vs the torso & head which have an additional 10% chance.
+
+
+
Setting even_weight to TRUE will make it just a straight up pick() between all possible bodyparts.
+
+
get_realname_string
+
+
Returns a mob's real name between brackets. Useful when you want to display a mob's name alongside their real name
get_slot_by_item
+
+
Gets what slot the item on the mob is held in.
+Returns null if the item isn't in any slots on our mob.
+Does not check if the passed item is null, which may result in unexpected outcoms.
get_spacemove_backup
+
+
Finds a target near a mob that is viable for pushing off when moving.
+Takes the intended movement direction as input, alongside if the context is checking if we're allowed to continue drifting
get_status_tab_items
+
+
Adds this list to the output to the stat browser
getorgan
+
+
Get the organ object from the mob matching the passed in typepath
+
Arguments:
+
+
typepath The typepath of the organ to get
+
getorganslot
+
+
Returns a list of all organs in specified slot
+
Arguments:
+
+
slot Slot to get the organs from
+
getorgansofzone
+
+
Get organ objects by zone
+
This will return a list of all the organs that are relevant to the zone that is passedin
handle_eye_contact() is called when we examine() something. If we examine an alive mob with a mind who has examined us in the last 2 seconds within 5 tiles, we make eye contact!
+
Note that if either party has their face obscured, the other won't get the notice about the eye contact
+Also note that examine_more() doesn't proc this or extend the timer, just because it's simpler this way and doesn't lose much.
+The nice part about relying on examining is that we don't bother checking visibility, because we already know they were both visible to each other within the last second, and the one who triggers it is currently seeing them
has_actionspeed_modifier
+
+
Is there a actionspeed modifier for this mob
has_light_nearby
+
+
Checks if there is enough light where the mob is located
+
Args:
+light_amount (optional) - A decimal amount between 1.0 through 0.0 (default is 0.2)
has_movespeed_modifier
+
+
Is there a movespeed modifier for this mob
has_nightvision
+
+
Can this mob see in the dark
+
This checks all traits, glasses, and robotic eyeball implants to see if the mob can see in the dark
+this does NOT check if the mob is missing it's eyeballs. Also see_in_dark is a BYOND mob var (that defaults to 2)
hide_other_mob_action_buttons
+
+
Hide another mob's action buttons from this mob
+
Used for observers viewing another mob's screen
hivecheck
+
+
Check if the mob has a hivemind channel
incapacitated
+
+
Is the mob incapacitated
initialize_actionspeed
+
+
Adds a default action speed
is_blind
+
+
Checks if the mob is able to see or not. eye_blind is temporary blindness, the trait is if they're permanently blind.
is_literate
+
+
This mob is abile to read books
is_muzzled
+
+
Is the mob muzzled (default false)
last_name
+
+
Find the last name of a mob from the real name with regex
log_message
+
+
Logs a message in a mob's individual log, and in the global logs as well if log_globally is true
lost_game
+
+
This proc sends the COMSIG_MOB_LOST_VIDEOGAME signal
+
This should be called by games when the gamer reaches a losing state
lowest_buckled_mob
+
+
Find the mob at the bottom of a buckle chain
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:
+
+
text - The text to send out
+
+
Returns TRUE if it was able to run the emote, FALSE otherwise.
me_verb
+
+
The me emote verb
memory
+
+
Shows a tgui window with memories
mob_negates_gravity
+
+
Does this mob ignore gravity
mode
+
+
Verb to activate the object in your held hand
+
Calls attack self on the item and updates the inventory hud for hands
northface
+
+
Hidden verb to turn north
notify_ghost_revival
+
+
Notify a ghost that it's body is being cloned
onShuttleMove
+
+
Mob move procs
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.
open_language_menu
+
+
Show the language menu for this mob
pickup_item
+
+
A helper for picking up an item.
play_screen_text
+
+
proc for playing a screen_text on a mob.
+enqueues it if a screen text is running and plays i otherwise
+Arguments:
+
+
text: text we want to be displayed
+
alert_type: typepath for screen text type we want to play here
+
played_game
+
+
This proc sends the COMSIG_MOB_PLAYED_VIDEOGAME signal
+
This should be called by games whenever the gamer interacts with the device
pointed
+
+
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
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)
query_heart
+
+
Ask someone if they'd like to award a commendation for the round, 3 tries to get the name they want before we give up
ranged_secondary_attack
+
+
Ranged secondary attack
+
If the same conditions are met to trigger RangedAttack but it is
+instead initialized via a right click, this will trigger instead.
+Useful for mobs that have their abilities mapped to right click.
refresh_looping_ambience
+
+
Tries to play looping ambience to the mobs.
regenerate_icons
+
+
Redraws the entire mob. For carbons, this is rather expensive, please use the individual update_X procs.
remove_actionspeed_modifier
+
+
Remove a action speed modifier from a mob, whether static or variable.
remove_client_colour
+
+
Removes an instance of colour_type from the mob's client_colours list
+colour_type - a typepath (subtyped from /datum/client_colour)
remove_from_alive_mob_list
+
+
Removes the mob reference from the list of all mobs alive. If mob is cliented, it removes it from the list of all living player-mobs.
remove_from_current_dead_players
+
+
Removes the mob reference from either the list of dead player-mobs or from the list of observers, depending on how they joined the game.
remove_from_current_living_antags
+
+
Removes the mob reference from the list of living antag player-mobs.
remove_from_current_living_players
+
+
Removes the mob reference from the list of living player-mobs. If the mob is an antag, it removes it from the list of living antag player-mobs.
remove_from_dead_mob_list
+
+
Remvoes the mob reference from list of all the dead mobs. If mob is cliented, it adds it to the list of all dead player-mobs.
remove_from_mob_list
+
+
Removes the mob reference from the list and directory of all mobs. Called on Destroy().
remove_from_mob_suicide_list
+
+
Removes a mob references from the list of all suicided mobs
remove_from_player_list
+
+
Removes the mob reference from the list of all player-mobs, besides from either the of dead or alive player-mob lists, as appropriate. Called on Logout().
remove_movespeed_modifier
+
+
Remove a move speed modifier from a mob, whether static or variable.
replace_identification_name
+
+
update the ID name of this mob
replace_records_name
+
+
Updates SSdatacore records with new name , see mob/living/carbon/human
reset_perspective
+
+
Reset the attached clients perspective (viewpoint)
+
reset_perspective(null) set eye to common default : mob on turf, loc otherwise
+reset_perspective(thing) set the eye to the thing (if it's equal to current default reset to mob perspective)
resist_grab
+
+
Attempt to break free of grabs. Returning TRUE means the user broke free and can move.
say_dead
+
+
Speak as a dead person (ghost etc)
say_verb
+
+
what clients use to speak. when you type a message into the chat bar in say mode, this is the first thing that goes off serverside.
send_appearance
+
+
Makes a client temporarily aware of an appearance via and invisible vis contents object.
set_blindness
+
+
Force set the blindness of a mob to some level
set_blurriness
+
+
Set the mobs blurriness of vision to an amount
set_disgust
+
+
Set the disgust level of a mob
set_drowsyness
+
+
Set drowsyness of a mob to passed value
set_move_intent
+
+
Toggle the move intent of the mob
+
triggers an update the move intent hud as well
set_nutrition
+
+
Force set the mob nutrition
set_real_name
+
+
Sets the mob's real name, and normal name if desired.
shared_ui_interaction
+
+
public
+
Standard interaction/sanity checks. Different mob types may have overrides.
+
return UI_state The state of the UI.
show_message
+
+
Show a message to this mob (visual or audible)
show_other_mob_action_buttons
+
+
Show (most) of the another mob's action buttons to this mob
+
Used for observers viewing another mob's screen
shuttleRotate
+
+
Mob rotate procs
slip
+
+
Called when this mob slips over, override as needed
+
knockdown_amount - time (in deciseconds) the slip leaves them on the ground
+slipped_on - optional, what'd we slip on? if not set, we assume they just fell over
+lube - bitflag of "lube flags", see [mobs.dm] for more information
+paralyze - time (in deciseconds) the slip leaves them paralyzed / unable to move
+force_drop = the slip forces them to drop held items
southface
+
+
Hidden verb to turn south
spin
+
+
Spin this mob around it's central axis
swapHeldIndexes
+
+
Switches the items inside of two hand indexes.
sync_lighting_plane_alpha
+
+
Set the lighting plane hud alpha to the mobs lighting_alpha var
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
+category is a text string. Each mob may only have one alert per category; the previous one will be replaced
+path is a type path of the actual alert type to throw
+severity is an optional number that will be placed at the end of the icon_state for this alert
+for example, high pressure's icon_state is "highpressure" and can be serverity 1 or 2 to get "highpressure1" or "highpressure2"
+new_master is optional and sets the alert's icon state to "template" in the ui_style icons with the master as an overlay.
+flicks are forwarded to master
+override makes it so the alert is not replaced until cleared by a clear_alert with clear_override, and it's used for hallucinations.
total_slowdown
+
+
Calculate the total slowdown of all movespeed modifiers
up
+
+
Moves a mob upwards in z level
update_action_buttons
+
+
This proc handles adding all of the mob's actions to their screen
update_flags - reload_screen - bool, if TRUE, this proc will add the button to the screen of the passed mob as well
+
update_actionspeed
+
+
Go through the list of actionspeed modifiers and calculate a final actionspeed. ANY ADD/REMOVE DONE IN UPDATE_actionspeed MUST HAVE THE UPDATE ARGUMENT SET AS FALSE!
update_ambience_area
+
+
Set the mob's tracked ambience area, and unset the old one.
update_blindness
+
+
proc that adds and removes blindness overlays when necessary
update_body
+
+
Updates every part of a carbon's body. Including parts, mutant parts, lips, underwear, and socks.
update_client_colour
+
+
Resets the mob's client.color to null, and then reapplies a new color based
+on the client_colour datums it currently has.
update_clothing
+
+
Updates every item slot passed into it.
update_config_movespeed
+
+
Set or update the global movespeed config on a mob
update_eye_blur
+
+
Apply the blurry overlays to a mobs clients screen
update_held_items
+
+
Updates the held items overlay(s) & HUD element.
update_mob_action_buttons
+
+
Updates all action buttons this mob has.
+
Arguments:
+
+
update_flags - Which flags of the action should we update
+
force - Force buttons update even if the given button icon state has not changed
+
update_mouse_pointer
+
+
Update the mouse pointer of the attached client in this mob. Red hot proc!
update_movespeed
+
+
Go through the list of movespeed modifiers and calculate a final movespeed. ANY ADD/REMOVE DONE IN UPDATE_MOVESPEED MUST HAVE THE UPDATE ARGUMENT SET AS FALSE!
update_pockets
+
+
Updates the handcuff overlay & HUD element.
update_pull_hud_icon
+
+
Update the pulling hud icon
update_rest_hud_icon
+
+
Update the resting hud icon
update_sight
+
+
Update the lighting plane and sight of this mob (sends COMSIG_MOB_UPDATE_SIGHT)
update_stamina_hud
+
+
Changes the stamina HUD based on new information
update_suit_storage
+
+
Updates the handcuff overlay & HUD element.
update_worn_back
+
+
Updates the back overlay & HUD element.
update_worn_belt
+
+
Updates the belt overlay & HUD element.
update_worn_ears
+
+
Updates the handcuff overlay & HUD element.
update_worn_glasses
+
+
Updates the glasses overlay & HUD element.
update_worn_gloves
+
+
Updates the glasses overlay & HUD element.
update_worn_handcuffs
+
+
Updates the handcuff overlay & HUD element.
update_worn_head
+
+
Updates the on-head overlay & HUD element.
update_worn_id
+
+
Updates the id overlay & HUD element.
update_worn_legcuffs
+
+
Updates the legcuff overlay & HUD element.
update_worn_mask
+
+
Updates the mask overlay & HUD element.
update_worn_neck
+
+
Updates the neck overlay & HUD element.
update_worn_oversuit
+
+
Updates the oversuit overlay & HUD element.
update_worn_shoes
+
+
Updates the shoes overlay & HUD element.
update_worn_undersuit
+
+
Updates the undersuit/uniform overlay & HUD element.
visible_message
+
+
Adds the functionality to self_message.
vv_get_dropdown
+
+
Get the mob VV dropdown extras
vv_get_var
+
+
extra var handling for the logging var
westface
+
+
Hidden verb to turn west
whisper
+
+
Whisper a message.
+
Basic level implementation just speaks the message, nothing else.
whisper_verb
+
+
Whisper verb
won_game
+
+
This proc sends the COMSIG_MOB_WON_VIDEOGAME signal
+
This should be called by games when the gamer reaches a winning state
+
+
+
diff --git a/mob/camera/ai_eye/remote/base_construction.html b/mob/camera/ai_eye/remote/base_construction.html
new file mode 100644
index 000000000000..0880148b20e7
--- /dev/null
+++ b/mob/camera/ai_eye/remote/base_construction.html
@@ -0,0 +1,39 @@
+
+
+
+
+
+
+ /mob/camera/ai_eye/remote/base_construction - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Controlled by a user who is using a base construction console.
+The user will be granted a set of building actions by the console, and the actions will be carried out by this mob.
+The mob is constrained to a given area defined by the base construction console.
Sets up the imaginary friend's name and look using a set of datum preferences.
Proc Details
Initialize
+
+
Arguments:
+
+
imaginary_friend_owner - The living mob that owns the imaginary friend.
+
appearance_from_prefs - If this is a valid set of prefs, the appearance of the imaginary friend is based on these prefs.
+
setup_friend_from_prefs
+
+
Sets up the imaginary friend's name and look using a set of datum preferences.
+
Arguments:
+
+
appearance_from_prefs - If this is a valid set of prefs, the appearance of the imaginary friend is based on the currently selected character in them. Otherwise, it's random.
Referenced when you want to delete the new_player later on in the code.
Proc Details
create_character
+
+
Creates, assigns and returns the new_character to spawn as. Assumes a valid mind.assigned_role exists.
handle_player_polling
+
+
Shows a list of currently running polls a player can vote/has voted on
open_interview
+
+
Verb for opening the existing interview, or if relevant creating a new interview if possible.
poll_player
+
+
Redirects a player to the correct poll window based on poll type.
poll_player_irv
+
+
Shows voting window for an IRV type poll, listing its options and relevant details.
+
If already voted on, the options are sorted how a player voted for them, otherwise they are randomly shuffled.
poll_player_multi
+
+
Shows voting window for a multiple choice type poll, listing its options and relevant details.
+
If already voted on, the options a player voted for are pre-selected.
poll_player_option
+
+
Shows voting window for an option type poll, listing its options and relevant details.
+
If already voted on, the option a player voted for is pre-selected.
poll_player_rating
+
+
Shows voting window for a rating type poll, listing its options and relevant details.
+
If already voted on, the options a player voted for are pre-selected.
poll_player_text
+
+
Shows voting window for a text response type poll, listing its relevant details.
+
If already responded to, the saved response of a player is shown.
register_for_interview
+
+
Prepares a client for the interview system, and provides them with a new interview
+
This proc will both prepare the user by removing all verbs from them, as well as
+giving them the interview form and forcing it to appear.
vote_on_poll_handler
+
+
Runs some poll validation before a vote is processed.
+
Checks a player is who they claim to be and that a poll is actually still running.
+Also loads the vote_id to pass onto single-option and text polls.
+Increments the vote count when successful.
vote_on_poll_irv
+
+
Processes vote form data and saves results to the database for an IRV type poll.
vote_on_poll_multi
+
+
Processes vote form data and saves results to the database for a multiple choice type poll.
vote_on_poll_option
+
+
Processes vote form data and saves results to the database for an option type poll.
vote_on_poll_rating
+
+
Processes vote form data and saves results to the database for a rating type poll.
vote_on_poll_text
+
+
Processes response form data and saves results to the database for a text response type poll.
Brutal damage caused by brute force (punching, being clubbed by a toolbox ect... this also accounts for pressure damage)
+Oxygen depravation damage (no air in lungs)
+Toxic damage caused by being poisoned or radiated
+Burn damage caused by being way too hot, too cold or burnt.
+Damage caused by being cloned or ejected from the cloner early. slimes also deal cloneloss damage to victims
+Used by [living/Bump()][/mob/living/proc/Bump] and [living/PushAM()][/mob/living/proc/PushAM] to prevent potential infinite loop.
if this exists AND the normal sprite is bigger than 32x32, this is the replacement icon state (because health doll size limitations). the icon will always be screen_gen.dmi
Proc used by different station pets such as Ian and Poly so that some of their data can persist between rounds.
+This base definition only contains a trait and comsig to stop memory from being (over)written.
+Specific behavior is defined on subtypes that use it.
Adjusts a timed status effect on the mob,taking into account any existing timed status effects.
+This can be any status effect that takes into account "duration" with their initialize arguments.
Returns the health of the mob while ignoring damage of non-organic (prosthetic) limbs
+Used by cryo cells to not permanently imprison those with damage from prosthetics,
+as they cannot be healed through chemicals.
The first 1-FLAVOR_PREVIEW_LIMIT characters in the mob's "examine_text" variable. FLAVOR_PREVIEW_LIMIT is defined in flavor_defines.dm.
+Shows any and all examine text related to any status effects the user has.
Directly sets the "drunk value" the mob is currently experiencing to the passed value,
+or applies a drunk effect with the passed value if the mob isn't currently drunk
Sets a timed status effect of some kind on a mob to a specific value.
+If only_if_higher is TRUE, it will only set the value up to the passed duration,
+so any pre-existing status effects of the same type won't be reduced down
Everything related to pipe vision on ventcrawling is handled by update_pipe_vision().
+Called on exit, entrance, and pipenet differences (e.g. moving to a new pipenet).
+One important thing to note however is that the movement of the client's eye is handled by the relaymove() proc in /obj/machinery/atmospherics.
+We move first and then call update. Dont flip this around
if this exists AND the normal sprite is bigger than 32x32, this is the replacement icon state (because health doll size limitations). the icon will always be screen_gen.dmi
Applies the "disoriented" status effect to the mob, among other potential statuses.
+Args:
+
+
amount : duration for src to be disoriented
+
stamina_amount : stamina damage to deal before LERP
+
ignore_canstun : ignore stun immunities, if using a secondary form of status
+
knockdown : duration to knock src down
+
stun : duration to stun src
+
paralyze : duration to paralyze src
+
overstam : If TRUE, stamina_amount will be able to deal stamina damage over the waekened threshold, allowing it to also stamina stun.
+
stack_status : Should the given status value(s) stack ontop of existing status values?
+
Hear
+
+
Play a sound to indicate we just spoke
IsDisoriented
+
+
placeholder
IsFrozen
+
+
FROZEN
Life
+
+
Handles the biological and general over-time processes of the mob.
+
Arguments:
+
+
delta_time: The amount of time that has elapsed since this last fired.
+
times_fired: The number of times SSmobs has fired
+
PermaSleeping
+
+
Allows us to set a permanent sleep on a player (use with caution and remember to unset it with SetSleeping() after the effect is over)
Write_Memory
+
+
Proc used by different station pets such as Ian and Poly so that some of their data can persist between rounds.
+This base definition only contains a trait and comsig to stop memory from being (over)written.
+Specific behavior is defined on subtypes that use it.
add_body_temperature_change
+
+
add_body_temperature_change Adds modifications to the body temperature
+
This collects all body temperature changes that the mob is experiencing to the list body_temp_changes
+the aggrogate result is used to derive the new body temperature for the mob
+
arguments:
+
+
key_name (str) The unique key for this change, if it already exist it will be overridden
+
amount (int) The amount of change from the base body temperature
+
add_movespeed_mod_immunities
+
+
Ignores specific slowdowns. Accepts a list of slowdowns.
add_quirk
+
+
Adds the passed quirk to the mob
+
Arguments
+
+
quirktype - Quirk typepath to add to the mob
+
override_client - optional, allows a client to be passed to the quirks on add procs.
+If not passed, defaults to this mob's client.
+
+
Returns TRUE on success, FALSE on failure (already has the quirk, etc)
adjustBloodVolume
+
+
BLOOD SYSTEM
+Adjusts blood volume, returning the difference.
adjust_drunk_effect
+
+
Adjust the "drunk value" the mob is currently experiencing,
+or applies a drunk effect if the mob isn't currently drunk (or tipsy)
+
The drunk effect doesn't have a set duration, like dizziness or drugginess,
+but instead relies on a value that decreases every status effect tick (2 seconds) by:
+4% the current drunk_value + 0.01
+
A "drunk value" of 6 is the border between "tipsy" and "drunk".
+
amount - the amount of "drunkness" to apply to the mob.
+down_to - the lower end of the clamp, when adding the value
+up_to - the upper end of the clamp, when adding the value
adjust_fire_stacks
+
+
Adjust the amount of fire stacks on a mob
+
This modifies the fire stacks on a mob.
+
Vars:
+
+
stacks: int The amount to modify the fire stacks
+
fire_type: type Type of fire status effect that we apply, should be subtype of /datum/status_effect/fire_handler/fire_stacks
+
adjust_incapacitated
+
+
+
Proc that adds duration to an incapacitated status effect.
+
Checks if the mob has the status effect. If yes, it adds the amount passed in arguments to the remaining duration. If not, applies the status effect
+
and sets the duration to the amount passed in arguments.
+
+
+
amount - Amount of time the status effect should be set to, in deciseconds.
+
+
+
+
+
ignore_canstun - If TRUE, the mob's resistance to stuns is ignored.
+
+
+
adjust_status_effects_on_shake_up
+
+
CLEAR STATUS
adjust_timed_status_effect
+
+
Adjusts a timed status effect on the mob,taking into account any existing timed status effects.
+This can be any status effect that takes into account "duration" with their initialize arguments.
+
Positive durations will add deciseconds to the duration of existing status effects
+or apply a new status effect of that duration to the mob.
+
Negative durations will remove deciseconds from the duration of an existing version of the status effect,
+removing the status effect entirely if the duration becomes less than zero (less than the current world time).
+
duration - the duration, in deciseconds, to add or remove from the effect
+effect - the type of status effect being adjusted on the mob
+max_duration - optional - if set, positive durations will only be added UP TO the passed max duration
admin_give_speech_impediment
+
+
Admin only proc for giving a certain speech impediment to this mob
after_grab_release
+
+
Called by grab objects when a grab has been released
amount_incapacitated
+
+
Proc that returns the remaining duration of the status efect in deciseconds.
Pretty much only used for projectiles applying effects on hit,
+don't use this for anything else please just cause the effects directly
apply_martial_art
+
+
Apply a martial art move from src to target.
+
This is used to process martial art attacks against nonhumans.
+It is also used to process martial art attacks by nonhumans, even against humans
+Human vs human attacks are handled in species code right now.
apply_pain
+
+
Applies pain to a mob.
+
Arguments:
+
+
+
amount - amount to apply
+
+
+
def_zone - Body zone to adjust the pain of. If null, will be divided amongst all bodyparts
+
+
+
message - A to_chat() to play if the target hasn't had one in a while.
+
+
+
ignore_cd - Ignores the message cooldown.
+
+
+
updating_health - Should this proc call updatehealth()?
+
+
+
Returns TRUE if pain changed.
+
+
apply_prefs_job
+
+
Applies the preference options to the spawning mob, taking the job into account. Assumes the client has the proper mind.
apply_status_effect
+
+
Applies a given status effect to this mob.
+
new_effect - TYPEPATH of a status effect to apply.
+Additional status effect arguments can be passed.
+
Returns the instance of the created effected, if successful.
+Returns 'null' if unsuccessful.
blurry_vision_change
+
+
Called when [TRAIT_BLURRY_EYES] is added or removed
can_enter_vent
+
+
Checks if the mob is able to enter the vent, and provides feedback if they are unable to.
can_inject
+
+
Returns whether or not the mob can be injected. Should not perform any side effects.
+
Arguments:
+
+
user - The user trying to inject the mob.
+
target_zone - The zone being targeted.
+
injection_flags - A bitflag for extra properties to check.
+Check _DEFINES/injection.dm for more details, specifically the ones prefixed INJECT_CHECK*.
+
can_look_up
+
+
Checks if the user is incapacitated or on cooldown.
can_unarmed_attack
+
+
Checks if this mob is in a valid state to punch someone.
canface
+
+
Checks mobility move as well as parent checks
do_jitter_animation
+
+
Helper proc that causes the mob to do a jittering animation by jitter_amount.
+jitter_amount will only apply up to 300 (maximum jitter effect).
do_slap_animation
+
+
Does a slap animation on an atom
+
Uses do_attack_animation to animate the attacker attacking
+then draws a hand moving across the top half of the target(where a mobs head would usually be) to look like a slap
+Arguments:
+
+
atom/A - atom being slapped
+
drag_damage
+
+
Take damage from being dragged while prone. Or not. You decide.
dust
+
+
This is the proc for turning a mob into ash.
+Dusting robots does not eject the MMI, so it's a bit more powerful than gib()
+
Arguments:
+
+
just_ash - If TRUE, ash will spawn where the mob was, as opposed to remains
+
drop_items - Should the mob drop their items before dusting?
+
force - Should this mob be FORCABLY dusted?
+
electrocute_act
+
+
As the name suggests, this should be called to apply electric shocks.
execute_resist
+
+
proc extender of [/mob/living/verb/resist] meant to make the process queable if the server is overloaded when the verb is called
expose_reagents
+
+
+
+
Handles exposing a mob to reagents.
+
+
+
If the methods include INGEST the mob tastes the reagents.
+
+
+
If the methods include VAPOR it incorporates permiability protection.
+
+
extinguish_mob
+
+
Extinguish all fire on the mob
+
This removes all fire stacks, fire effects, alerts, and moods
+Signals the extinguishing.
fakedeath
+
+
Induces fake death on a living mob.
find_nearest_stair_or_ladder
+
+
Finds nearest ladder or staircase either up or down.
+
Arguments:
+
+
direction - UP or DOWN.
+
flick_emote_popup_on_mob
+
+
A proc type that, when called, causes a image/sprite to appear above whatever entity it is called on.
+
There are two types: on_mob and on_obj, they can only be called on their respective typepaths.
+
Arguments:
+
+
state -- The icon_state of whatever .dmi file you're attempting to use for the sprite, in "" format. Ex. "combat", not combat.dmi.
+
time -- The amount of time the sprite remains before remove_emote_popup_on_mob is called. Is used in the addtimer.
+
get_active_grab
+
+
Returns the currently selected grab item
get_all_grabbed_movables
+
+
Returns a list of every movable we are grabbing
get_attack_type
+
+
Returns the attack damage type of a living mob such as BRUTE.
get_blood_dna_list
+
+
returns the mob's dna info as a list, to be inserted in an object's blood_DNA list
get_body_temp_cold_damage_limit
+
+
Returns the body temperature at which this mob will start taking cold damage.
get_body_temp_heat_damage_limit
+
+
Returns the body temperature at which this mob will start taking heat damage.
get_body_temp_normal
+
+
get_body_temp_normal Returns the mobs normal body temperature with any modifications applied
+
This applies the result from proc/get_body_temp_normal_change() against the BODYTEMP_NORMAL and returns the result
+
arguments:
+
+
apply_change (optional) Default True This applies the changes to body temperature normal
+
get_body_temp_normal_change
+
+
get_body_temp_normal_change Returns the aggregate change to body temperature
+
This aggregates all the changes in the body_temp_changes list and returns the result
get_damage_amount
+
+
return the damage amount for the type given
get_drunk_amount
+
+
Helper to get the amount of drunkness the mob's currently experiencing.
get_exp_list
+
+
Returns an assoc list of assignments and minutes for updating a client's exp time in the databse.
+
Arguments:
+
+
minutes - The number of minutes to allocate to each valid role.
+
get_fullness
+
+
Get the fullness of the mob
+
This returns a value form 0 upwards to represent how full the mob is.
+The value is a total amount of consumable reagents in the body combined
+with the total amount of nutrition they have.
+This does not have an upper limit.
get_idcard
+
+
Gets ID card from a mob.
+Argument:
+
+
hand_firsts - boolean that checks the hands of the mob first if TRUE.
+
get_organic_health
+
+
Returns the health of the mob while ignoring damage of non-organic (prosthetic) limbs
+Used by cryo cells to not permanently imprison those with damage from prosthetics,
+as they cannot be healed through chemicals.
get_quirk_string
+
+
get_quirk_string() is used to get a printable string of all the quirk traits someone has for certain criteria
+
Arguments:
+
+
Medical- If we want the long, fancy descriptions that show up in medical records, or if not, just the name
+
Category- Which types of quirks we want to print out. Defaults to everything
+
get_status_effect_examinations
+
+
The first 1-FLAVOR_PREVIEW_LIMIT characters in the mob's "examine_text" variable. FLAVOR_PREVIEW_LIMIT is defined in flavor_defines.dm.
+Shows any and all examine text related to any status effects the user has.
get_taste_sensitivity
+
+
Gets taste sensitivity of given mob
+
This is used in calculating what flavours the mob can pick up,
+with a lower number being able to pick up more distinct flavours.
get_timed_status_effect_duration
+
+
Gets how many deciseconds are remaining in
+the duration of the passed status effect on this mob.
+
If the mob is unaffected by the passed effect, returns 0.
gib
+
+
Blow up the mob into giblets
+
Arguments:
+
+
no_brain - Should the mob NOT drop a brain?
+
no_organs - Should the mob NOT drop organs?
+
no_bodyparts - Should the mob NOT drop bodyparts?
+
give_unique_name
+
+
Gives simple mobs their unique/randomized name.
gravity_setup
+
+
Living Mob use event based gravity
+We check here to ensure we haven't dropped any gravity changes
handle_grabs_during_movement
+
+
Called during or immediately after movement. Used to move grab targets around to ensure the grabs do not break during movement.
handle_ventcrawl
+
+
Handles the entrance and exit on ventcrawling
has_reagent
+
+
Check if the mob contains this reagent.
+
This will validate the the reagent holder for the mob and any sub holders contain the requested reagent.
+Vars:
+
+
reagent (typepath) takes a PATH to a reagent.
+
amount (int) checks for having a specific amount of that chemical.
+
needs_metabolizing (bool) takes into consideration if the chemical is matabolizing when it's checked.
+
has_status_effect
+
+
Checks if this mob has a status effect that shares the passed effect's ID
+
checked_effect - TYPEPATH of a status effect to check for. Checks for its ID, not it's typepath
+
Returns an instance of a status effect, or NULL if none were found.
has_status_effect_list
+
+
Returns a list of all status effects that share the passed effect type's ID
+
checked_effect - TYPEPATH of a status effect to check for. Checks for its ID, not it's typepath
+
Returns a list
hasparasites
+
+
parasite tracking/finding procs
heal_bodypart_damage
+
+
heal ONE external organ, organ gets randomly selected from damaged ones.
+
needs to return amount healed in order to calculate things like tend wounds xp gain
heal_ordered_damage
+
+
heal up to amount damage, in a given order
heal_overall_damage
+
+
heal MANY bodyparts, in random order
ignore_slowdown
+
+
Ignores all slowdowns that lack the IGNORE_NOSLOW flag.
in_fov
+
+
Is observed_atom in a mob's field of view? This takes blindness, nearsightness and FOV into consideration
incapacitate
+
+
+
Proc that actually applies the status effect.
+
Applies the Incapacitated status effect to a mob/living.
+
+
+
amount - Amount of time the status effect should be applied for, in deciseconds.
+
+
+
+
+
ignore_canstun - If TRUE, the mob's resistance to stuns is ignored.
+
+
+
incapacitated
+
+
Checks if a mob is incapacitated
+
Normally being restrained, agressively grabbed, or in stasis counts as incapacitated
+unless there is a flag being used to check if it's ignored
+
args:
+
+
flags (optional) bitflags that determine if special situations are exempt from being considered incapacitated
+
+
bitflags: (see code/__DEFINES/status_effects.dm)
+
+
IGNORE_RESTRAINTS - mob in a restraint (handcuffs) is not considered incapacitated
+
IGNORE_STASIS - mob in stasis (stasis bed, etc.) is not considered incapacitated
+
IGNORE_GRAB - mob that is agressively grabbed is not considered incapacitated
+
is_face_visible
+
+
Only defined for carbons who can wear masks and helmets, we just assume other mobs have visible faces
is_grabbing
+
+
Returns TRUE if src is grabbing hold of the target
leavesBloodTrail
+
+
Returns TRUE if we should try to leave a blood trail.
lying_angle_on_movement
+
+
Called by mob Move() when the lying_angle is different than zero, to better visually simulate crawling.
makeBloodTrail
+
+
Creates a trail of blood on Start, facing Direction
mob_pickup
+
+
Spawn a /obj/item/mob_holder, move src into it, and put it into the hands of user.
remove_body_temperature_change Removes the modifications to the body temperature
+
This removes the recorded change to body temperature from the body_temp_changes list
+
arguments:
+
+
key_name (str) The unique key for this change that will be removed
+
remove_emote_popup_on_mob
+
+
A proc that is automatically called whenever flick_emote_popup_on_mob's addtimer expires, and removes the popup.
+
Arguments:
+
+
emote_overlay -- Inherits state from the preceding proc.
+
remove_movespeed_mod_immunities
+
+
Unignores specific slowdowns. Accepts a list of slowdowns.
remove_status_effect
+
+
Removes all instances of a given status effect from this mob
+
removed_effect - TYPEPATH of a status effect to remove.
+Additional status effect arguments can be passed - these are passed into before_remove.
+
Returns TRUE if at least one was removed.
resist_buckle
+
+
Attempt to break out of a buckle. Returns TRUE if successful.
resolve_unarmed_attack
+
+
Called by UnarmedAttack(), directs the proc to a type-specified child proc.
right_click_attack_chain
+
+
Checks for RIGHT_CLICK in modifiers and runs attack_hand_secondary if so. Returns TRUE if normal chain blocked
set_body_position
+
+
Changes the value of the [living/body_position] variable.
set_buckled
+
+
Reports the event of the change in value of the buckled variable.
set_drunk_effect
+
+
Directly sets the "drunk value" the mob is currently experiencing to the passed value,
+or applies a drunk effect with the passed value if the mob isn't currently drunk
+
set_to - the amount of "drunkness" to set on the mob.
set_fire_stacks
+
+
Set the fire stacks on a mob
+
This sets the fire stacks on a mob, stacks are clamped between -20 and 20.
+If the fire stacks are reduced to 0 then we will extinguish the mob.
+
Vars:
+
+
stacks: int The amount to set fire_stacks to
+
fire_type: type Type of fire status effect that we apply, should be subtype of /datum/status_effect/fire_handler/fire_stacks
+
remove_wet_stacks: bool If we remove all wet stacks upon doing this
+
set_health
+
+
Sets the current mob's health value. Do not call directly if you don't know what you are doing, use the damage procs, instead.
set_incapacitated
+
+
+
Proc that set the incapacitated status effect's remaining duration to a certain time.
+
Checks if the mob has the status effect. If yes, it sets the duration to the amount passed in arguments. If not, applies the status effect
+
and sets the duration to the amount passed in arguments.
+
+
+
amount - Amount of time the status effect should be set to, in deciseconds.
+
+
+
+
+
ignore_canstun - If TRUE, the mob's resistance to stuns is ignored.
+
+
+
set_lying_angle
+
+
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.
set_lying_down
+
+
Change the [body_position] to LYING_DOWN and update associated behavior.
set_num_hands
+
+
Proc to modify the value of num_hands and hook behavior associated to this event.
set_num_legs
+
+
Proc to modify the value of num_legs and hook behavior associated to this event.
set_resting
+
+
Proc to hook behavior to the change of value in the resting variable.
set_safe_hunger_level
+
+
Sets the mob's hunger levels to a safe overall level. Useful for TRAIT_NOHUNGER species changes.
set_timed_status_effect
+
+
Sets a timed status effect of some kind on a mob to a specific value.
+If only_if_higher is TRUE, it will only set the value up to the passed duration,
+so any pre-existing status effects of the same type won't be reduced down
+
duration - the duration, in deciseconds, of the effect. 0 or lower will either remove the current effect or do nothing if none are present
+effect - the type of status effect given to the mob
+only_if_higher - if TRUE, we will only set the effect to the new duration if the new duration is longer than any existing duration
set_usable_hands
+
+
Proc to modify the value of usable_hands and hook behavior associated to this event.
set_usable_legs
+
+
Proc to modify the value of usable_legs and hook behavior associated to this event.
shared_living_ui_distance
+
+
public
+
Distance versus interaction check.
+
required src_object atom/movable The object which owns the UI.
+
return UI_state The state of the UI.
singularity_act
+
+
Logs, gibs and returns point values of whatever mob is unfortunate enough to get eaten.
sleeping_carp_help
+
+
Verb added to humans who learn the art of the sleeping carp.
stamina_swing
+
+
Take away stamina from an attack being thrown.
stat_roll
+
+
Perform a stat roll, returning a roll result datum.
+
args:
+
+
requirement (int) The baseline value required to roll a Success.
+
stat (string) The stat, if applicable, to take into account.
+
modifier (int) A modifier applied to the value after roll. Lower means the roll is more difficult.
+
crit_fail_modifier (int) A value subtracted from the requirement, which dictates the crit fail threshold.
+
take_bodypart_damage
+
+
damage ONE external organ, organ gets randomly selected from damaged ones.
take_overall_damage
+
+
damage MANY bodyparts, in random order
tram_slam_land
+
+
A proc triggered by callback when someone gets slammed by the tram and lands somewhere.
+
This proc is used to force people to fall through things like lattice and unplated flooring at the expense of some
+extra damage, so jokers can't use half a stack of iron rods to make getting hit by the tram immediately lethal.
transfer_blood_to
+
+
BLOOD TRANSFERS
treat_message
+
+
Treats the passed message with things that may modify speech (stuttering, slurring etc).
+
message - The message to treat.
+correct_grammar - Whether or not to capitalize the first letter and add punctuation.
try_inject
+
+
Like can_inject, but it can perform side effects.
+
Arguments:
+
+
user - The user trying to inject the mob.
+
target_zone - The zone being targeted.
+
injection_flags - A bitflag for extra properties to check. Check __DEFINES/injection.dm for more details.
+Check _DEFINES/injection.dm for more details. Unlike can_inject, the INJECT_TRY* defines will behave differently.
+
try_make_grab
+
+
Attempt to create a grab, returns TRUE on success
try_slapcraft
+
+
Have a living mob attempt to do a slapcraft. The mob is using the second item on the first item.
unequip_everything
+
+
Drop all items to the floor.
unignore_slowdown
+
+
Unignores all slowdowns that lack the IGNORE_NOSLOW flag.
update_fire_overlay
+
+
Sets fire overlay of the mob.
+
Vars:
+
+
stacks: Current amount of fire_stacks
+
on_fire: If we're lit on fire
+
last_icon_state: Holds last fire overlay icon state, used for optimization
+
suffix: Suffix for the fire icon state for special fire types
+
+
This should return last_icon_state for the fire status efect
update_fullscreen
+
+
Proc used to handle the fullscreen overlay updates, realistically meant for the reset_perspective() proc.
update_med_hud
+
+
Updates both the Health and Status huds. ATOM HUDS, NOT SCREEN HUDS.
update_pipe_vision
+
+
Everything related to pipe vision on ventcrawling is handled by update_pipe_vision().
+Called on exit, entrance, and pipenet differences (e.g. moving to a new pipenet).
+One important thing to note however is that the movement of the client's eye is handled by the relaymove() proc in /obj/machinery/atmospherics.
+We move first and then call update. Dont flip this around
update_resting
+
+
Proc to append and redefine behavior to the change of the [/mob/living/var/resting] variable.
update_transform
+
+
Called whenever the mob is to be resized or when lying/standing up for carbons.
update_wound_overlays
+
+
Proc that only really gets called for humans, to handle bleeding overlays.
whisper
+
+
Living level whisper.
+
Living mobs which whisper have their message only appear to people very close.
+
message - the message to display
+bubble_type - the type of speech bubble that shows up when they speak (currently does nothing)
+spans - a list of spans to apply around the message
+sanitize - whether we sanitize the message
+language - typepath language to force them to speak / whisper in
+ignore_spam - whether we ignore the spam filter
+forced - string source of what forced this speech to happen, also bypasses spam filter / mutes if supplied
+filterproof - whether we ignore the word filter
will_escape_storage
+
+
Whether or not this mob will escape from storages while being picked up/held.
Simple animals 2.0, This time, let's really try to keep it simple. This basetype should purely be used as a base-level for implementing simplified behaviours for things such as damage and attacks. Everything else should be in components or AI behaviours.
This is used to determine if the mob failed a breath. If they did fail a brath, they will attempt to breathe each tick, otherwise just once per 4 ticks.
Check ourselves to see if we've got any shrapnel, return true if we do. This is a much simpler version of what humans do, we only indicate we're checking ourselves if there's actually shrapnel
Get the insulation that is appropriate to the temperature you're being exposed to.
+All clothing, natural insulation, and traits are combined returning a single value.
Brain health scales the pain passout modifier with an importance of 80%
+Blood circulation scales the pain passout modifier with an importance of 40%
+Attempts to implant this skillchip into the target carbon's brain.
Open the internal air tank without checking for any breathing apparatus.
+Returns TRUE if the air tank was opened successfully.
+Closes any existing tanks before opening another one.
If an organ exists in the slot requested, and we are capable of taking damage (we don't have [GODMODE] on), call the set damage proc on that organ, which can
+set or clear the failing variable on that organ, making it either cease or start functions again, unlike adjustOrganLoss.
Prepares to close the currently open internal air tank and notifies in chat.
+Handles displaying messages to the user before doing the actual closing.
+Returns TRUE if
Toggles the given external (that's EX-ternal) air tank open, or close the currently open one, if a compatible breathing apparatus is found.
+Returns TRUE if the tank was opened successfully.
Toggles the given internal air tank open, or close the currently open one, if a compatible breathing apparatus is found.
+Returns TRUE if the tank was opened successfully.
Prepares to open the internal air tank and notifies the mob in chat.
+Handles displaying messages to the user before doing the actual opening.
+Returns TRUE if the tank was opened/closed successfully.
Opens the given internal air tank if a breathing apparatus is found. Returns TRUE if successful, FALSE otherwise.
+Returns TRUE if the tank was opened successfully.
This is used to determine if the mob failed a breath. If they did fail a brath, they will attempt to breathe each tick, otherwise just once per 4 ticks.
Proc to hook behavior on bodypart additions. Do not directly call. You're looking for [/obj/item/bodypart/proc/attach_limb()].
adjustOrganLoss
+
+
If an organ exists in the slot requested, and we are capable of taking damage (we don't have [GODMODE] on), call the damage proc on that organ.
+
Arguments:
+
+
slot - organ slot, like [ORGAN_SLOT_HEART]
+
amount - damage to be done
+
maximum - currently an arbitrarily large number, can be set so as to limit damage
+
adjustPlasma
+
+
Adjusts the plasma level of the carbon's plasma vessel if they have one
adjust_bodytemperature
+
+
Adjust the body temperature of a mob
+expanded for carbon mobs allowing the use of insulation and change steps
+
vars:
+
+
amount The amount of degrees to change body temperature by
+
min_temp (optional) The minimum body temperature after adjustment
+
max_temp (optional) The maximum body temperature after adjustment
+
use_insulation (optional) modifies the amount based on the amount of insulation the mob has
+
use_steps (optional) Use the body temp divisors and max change rates
+
capped (optional) default True used to cap step mode
+
adjust_skillchip_complexity_modifier
+
+
Modifies max_skillchip_count and updates active skillchips
afterEquipItem
+
+
This proc is called after an item has been successfully handled and equipped to a slot.
bleed_warn
+
+
bleed_warn() is used to for carbons with an active client to occasionally receive messages warning them about their bleeding status (if applicable)
+
Arguments:
+
+
bleed_amt- When we run this from [/mob/living/carbon/human/proc/handle_blood] we already know how much blood we're losing this tick, so we can skip tallying it again with this
+
forced-
+
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.
check_obscured_slots
+
+
Returns a bitfield of covered item slots.
check_self_for_injuries
+
+
Check ourselves to see if we've got any shrapnel, return true if we do. This is a much simpler version of what humans do, we only indicate we're checking ourselves if there's actually shrapnel
check_virus
+
+
Medical HUD! Basic mode needs suit sensors on.
clear_shove_slowdown
+
+
Consume stamina to disarm
clone_skillchip_list
+
+
Creates a list of new skillchips cloned from old skillchips in the mob's brain.
+
Returns a complete list of new skillchips cloned from the mob's brain's existing skillchip stock.
+Rumour has it that Changelings just LOVE this proc.
+Arguments:
+
+
cloned_chip_holder - The new holder for the cloned chips. Please don't be null.
+
not_removable - Special override, whether or not to force cloned chips to be non-removable, i.e. to delete on removal.
+
close_all_airtanks
+
+
Quickly/lazily close all airtanks without any returns or notifications.
close_externals
+
+
Close the the currently open external (that's EX-ternal) air tank. Returns TREUE if successful.
close_internals
+
+
Actually closes the active internal or external air tank.
+Returns TRUE if the tank was opened successfully.
+
Arguments:
+
+
is_external - A boolean which indicates if the air tank must be equipped, or stored elsewhere.
+
create_carbon_reagents
+
+
Humans need to init these early for species purposes
cutoff_internals
+
+
Prepares emergency disconnect from open air tanks and notifies in chat. Usually called after mob suddenly unequips breathing apparatus.
destroy_all_skillchips
+
+
Destroys all skillchips in the brain, handling appropriate cleanup and event calls.
disarm
+
+
Attempt to disarm the target mob.
+Will shove the target mob back, and drop them if they're in front of something dense
+or another carbon.
electrocute_act
+
+
Adds to the parent by also adding functionality to propagate shocks through pulling and doing some fluff effects.
expel_ingested
+
+
Expel the reagents you just tried to ingest
+
When you try to ingest reagents but you do not have a stomach
+you will spew the reagents on the floor.
+
Vars:
+
+
bite: /atom the reagents to expel
+
amount: int The amount of reagent
+
getOrganLoss
+
+
If an organ exists in the slot requested, return the amount of damage that organ has
+
Arguments:
+
+
slot - organ slot, like [ORGAN_SLOT_HEART]
+
getPlasma
+
+
Gets the plasma level of this carbon's plasma vessel, or -1 if they don't have one
get_all_covered_flags
+
+
Returns a bitfield of all zones covered by clothing
get_bleed_rate
+
+
A helper to see how much blood we're losing per tick
get_blood_dna_list
+
+
Get the mobs dna list
get_cold_protection
+
+
This returns the percentage of protection from cold as a value from 0 - 1
+temperature is the temperature you're being exposed to
get_covered_body_zones
+
+
Returns a list of all body_zones covered by clothing
get_damageable_bodyparts
+
+
Returns a list of damageable bodyparts
get_damaged_bodyparts
+
+
Returns a list of damaged bodyparts
get_heat_protection
+
+
This returns the percentage of protection from heat as a value from 0 - 1
+temperature is the temperature you're being exposed to
get_insulation_protection
+
+
Get the insulation that is appropriate to the temperature you're being exposed to.
+All clothing, natural insulation, and traits are combined returning a single value.
+
required temperature The Temperature that you're being exposed to
+
return the percentage of protection as a value from 0 - 1
get_item_covering_bodypart
+
+
Returns an item that is covering a bodypart.
get_item_covering_zone
+
+
Returns an item that is covering a body_zone (BODY_ZONE_CHEST, etc)
get_pulse
+
+
generates realistic-ish pulse output based on preset levels as text
get_random_dream
+
+
Generates a dream sequence to be displayed to the sleeper.
+
Generates the "dream" to display to the sleeper. A dream consists of a subject, a verb, and (most of the time) an object, displayed in sequence to the sleeper.
+Dreams are generated as a list of strings stored inside dream_fragments, which is passed to and displayed in dream_sequence().
+Bedsheets on the sleeper will provide a custom subject for the dream, pulled from the dream_messages on each bedsheet.
get_total_bleed_rate
+
+
get our total bleedrate
get_traumas
+
+
TRAUMAS
give
+
+
Proc called when offering an item to another player
+
This handles creating an alert and adding an overlay to it
handle_environment
+
+
Base carbon environment handler, adds natural stabilization
handle_liver
+
+
Check to see if we have the liver, if not automatically gives you last-stage effects of lacking a liver.
heal_bodypart_damage
+
+
Heals ONE bodypart randomly selected from damaged ones.
+
It automatically updates damage overlays if necessary
+
It automatically updates health status
heal_overall_damage
+
+
Heal MANY bodyparts, in random order
humanize
+
+
Humanize
immortality
+
+
For the Wishgranter
implant_skillchip
+
+
Brain health scales the pain passout modifier with an importance of 80%
+Blood circulation scales the pain passout modifier with an importance of 40%
+Attempts to implant this skillchip into the target carbon's brain.
+
Returns whether the skillchip was inserted or not. Can optionally give chat message notification to the mob.
+Arguments:
+
+
skillchip - The skillchip you want to insert.
+
silent - Whether or not to display the implanting message.
+
force - Whether to force the implant to happen, including forcing activating if activate = TRUE. Ignores incompatibility checks. Used by changelings.
+
invalid_internals
+
+
Returns truthy if air tank is open and mob lacks apparatus, or if the tank moved away from the mob.
is_bleeding
+
+
if any of our bodyparts are bleeding
is_bodypart_visibly_covered
+
+
This proc expects to be passed a list of covered zones, for optimization in loops. Use get_covered_body_zones(exact_only = TRUE) for that..
lying_angle_on_lying_down
+
+
Special carbon interaction on lying down, to transform its sprite by a rotation.
natural_bodytemperature_stabilization
+
+
Used to stabilize the body temperature back to normal on living mobs
delta_time: The amount of time that has elapsed since the last tick
+
times_fired: The number of times SSmobs has ticked
+
notify_pain
+
+
Flashes the pain overlay and provides a chat message.
on_noaddiction_trait_gain
+
+
On gain of TRAIT_NO_ADDICTION
+
This will remove all addictions.
on_nobreath_trait_gain
+
+
On gain of TRAIT_NOBREATH
+
This will clear all alerts and moods related to breathing.
on_nometabolism_trait_gain
+
+
On gain of TRAIT_NOMETABOLISM
+
This will clear all moods related to addictions and stop metabolization.
open_internals
+
+
Open the internal air tank without checking for any breathing apparatus.
+Returns TRUE if the air tank was opened successfully.
+Closes any existing tanks before opening another one.
+
Arguments:
+
+
tank - The given tank to open and start breathing from.
+
is_external - A boolean which indicates if the air tank must be equipped, or stored elsewhere.
+
pain_emote
+
+
Perform a pain response emote, amount is the amount of pain they are in. See pain defines for easy numbers.
remove_all_embedded_objects
+
+
Remove all embedded objects from all limbs on the carbon mob
remove_bodypart
+
+
Proc to hook behavior on bodypart removals. Do not directly call. You're looking for [/obj/item/bodypart/proc/drop_limb()].
remove_embedded_object
+
+
Remove a specific embedded item from the carbon mob
remove_skillchip
+
+
Attempts to remove this skillchip from the target carbon's brain.
+
Returns FALSE when the skillchip couldn't be removed for some reason,
+including the target or brain not existing or the skillchip not being in the brain.
+Arguments:
+
+
target - The living carbon whose brain you want to remove the chip from.
+
silent - Whether or not to display the removal message.
+
secondary_shock
+
+
Called slightly after electrocute act to apply a secondary stun.
setOrganLoss
+
+
If an organ exists in the slot requested, and we are capable of taking damage (we don't have [GODMODE] on), call the set damage proc on that organ, which can
+set or clear the failing variable on that organ, making it either cease or start functions again, unlike adjustOrganLoss.
+
Arguments:
+
+
slot - organ slot, like [ORGAN_SLOT_HEART]
+
amount - damage to be set to
+
set_handcuffed
+
+
Modifies the handcuffed value if a different value is passed, returning FALSE otherwise. The variable should only be changed through this proc.
share_bodytemperature
+
+
Have two mobs share body heat between each other.
+Account for the insulation and max temperature change range for the mob
+
vars:
+
+
M The mob/living/carbon that is sharing body heat
+
should_electrocute
+
+
Returns whether or not the carbon should be able to be shocked
spray_blood
+
+
This proc is a helper for spraying blood for things like slashing/piercing wounds and dismemberment.
+
The strength of the splatter in the second argument determines how much it can dirty and how far it can go
+
Arguments:
+
+
splatter_direction: Which direction the blood is flying
+
splatter_strength: How many tiles it can go, and how many items it can pass over and dirty
+
take
+
+
Proc called when the player clicks the give alert
+
Handles checking if the player taking the item has open slots and is in range of the offerer
+Also deals with the actual transferring of the item to the players hands
+Arguments:
+
+
offerer - The person giving the original item
+
I - The item being given by the offerer
+
take_bodypart_damage
+
+
Damages ONE bodypart randomly selected from damagable ones.
+
It automatically updates damage overlays if necessary
+
It automatically updates health status
take_overall_damage
+
+
damage MANY bodyparts, in random order
toggle_close_internals
+
+
Prepares to close the currently open internal air tank and notifies in chat.
+Handles displaying messages to the user before doing the actual closing.
+Returns TRUE if
+
Arguments:
+
+
is_external - A boolean which indicates if the air tank must be equipped, or stored elsewhere.
+
toggle_externals
+
+
Toggles the given external (that's EX-ternal) air tank open, or close the currently open one, if a compatible breathing apparatus is found.
+Returns TRUE if the tank was opened successfully.
+
Arguments:
+
+
tank - The given tank to toggle open and start breathing from externally.
+
toggle_internals
+
+
Toggles the given internal air tank open, or close the currently open one, if a compatible breathing apparatus is found.
+Returns TRUE if the tank was opened successfully.
+
Arguments:
+
+
tank - The given tank to toggle open and start breathing from internally.
+
toggle_open_internals
+
+
Prepares to open the internal air tank and notifies the mob in chat.
+Handles displaying messages to the user before doing the actual opening.
+Returns TRUE if the tank was opened/closed successfully.
+
Arguments:
+
+
tank - The given tank to toggle open and start breathing from.
+
is_external - A boolean which indicates if the air tank must be equipped, or stored elsewhere.
+
try_dream
+
+
Begins the dreaming process on a sleeping carbon.
+
Only one dream sequence can be active at a time.
try_open_internals
+
+
Opens the given internal air tank if a breathing apparatus is found. Returns TRUE if successful, FALSE otherwise.
+Returns TRUE if the tank was opened successfully.
+
Arguments:
+
+
tank - The given tank we will attempt to toggle open and start breathing from.
+
is_external - A boolean which indicates if the air tank must be equipped, or stored elsewhere.
+
update_body_parts
+
+
Checks to see if any bodyparts need to be redrawn, then does so. update_limb_data = TRUE redraws the limbs to conform to the owner.
update_bodypart_bleed_overlays
+
+
Has each bodypart update its bleed/wound overlay icon states
update_eyes
+
+
Update the eye sprite on the carbon. Calling with refresh = TRUE will update the sprite information of the eye organ first.
update_obscurity
+
+
Compiles all flags_inv vars of worn items.
update_slots_for_item
+
+
Update any visuals relating to an item when it's equipped, unequipped, or it's flags_inv changes.
wearing_shock_proof_gloves
+
+
Returns if the carbon is wearing shock proof gloves
When an braindead player has their equipment fiddled with, we log that info here for when they come back so they know who took their ID while they were DC'd for 30 seconds
Set the haircolor of a human. Override instead sets the override value, it will not be changed away from the override value until override is set to null.
When an braindead player has their equipment fiddled with, we log that info here for when they come back so they know who took their ID while they were DC'd for 30 seconds
copies over clothing preferences like underwear to another human
do_cpr
+
+
Performs CPR on the target after a delay.
electrocute_act
+
+
Calculates the siemens coeff based on clothing and species, can also restart hearts.
expose_plasma
+
+
Handles all the bad things phoron can do.
forensic_analysis_roll
+
+
On examine, players have a chance to find forensic evidence. This can only happen once per object.
get_all_worn_items
+
+
Returns a list of every item slot contents on the user.
get_body_temp_normal
+
+
get_body_temperature Returns the body temperature with any modifications applied
+
This applies the result from proc/get_body_temp_normal_change() against the bodytemp_normal
+for the species and returns the result
+
arguments:
+
+
apply_change (optional) Default True This applies the changes to body temperature normal
+
get_equipped_items
+
+
Used to return a list of equipped items on a human mob; does not include held items (use get_all_gear)
+
Argument(s):
+
+
Optional - include_pockets (TRUE/FALSE), whether or not to include the pockets and suit storage in the returned list
+
handle_environment
+
+
Environment handlers for species
has_hair
+
+
Does this mob have hair? Pass bald_is_false = TRUE to have "Bald" count as FALSE
is_wearing_item_of_type
+
+
Bruteforce check for any type or subtype of an item.
needs_organ
+
+
Accepts an organ slot, returns whether or not the mob needs one to survive (or just should have one for non-vital organs).
on_entered
+
+
HUDs
randomize_human_appearance
+
+
Fully randomizes everything according to the given flags.
return_cuff_slots
+
+
Returns the cuff slot contents as a list
return_extra_wearables
+
+
Returns a list of items in slots like the ID slot, belt, backpack
return_pocket_slots
+
+
Returns a list of items in the "*_store" slots
return_worn_clothing
+
+
Returns a list of worn "clothing" items.
sec_hud_set_ID
+
+
Security HUDs! Basic mode shows only the job.
set_haircolor
+
+
Set the haircolor of a human. Override instead sets the override value, it will not be changed away from the override value until override is set to null.
share_blood_on_touch
+
+
Place blood onto us if the toucher has blood on their hands or clothing. messy_slots deteremines what slots to bloody.
singularity_act
+
+
Overrides the point value that the mob is worth
smart_equip_targeted
+
+
take the most recent item out of a slot or place held item in a slot
something_horrible
+
+
DNA HELPER-PROCS
toggle_externals
+
+
Returns TRUE if the tank successfully toggles open/closed. Opens the tank only if a breathing apparatus is found.
update_lips
+
+
Used to update the makeup on a human and apply/remove lipstick traits, then store/unstore them on the head object in case it gets severed
wash
+
+
Called when this human should be washed
wash_hands
+
+
Wash the hands, cleaning either the gloves if equipped and not obscured, otherwise the hands themselves if they're not obscured.
+
Returns false if we couldn't wash our hands due to them being obscured, otherwise true
Are our siliconHUDs on? TRUE for yes, FALSE for no.
Proc Details
assemble_laws
+
+
Assembles all the zeroth, inherent and supplied laws into a single list.
checklaws
+
+
Gives you a link-driven interface for deciding what laws the statelaws() proc will share with the crew.
fully_replace_character_name
+
+
Same as the normal character name replacement, but updates the contents of the modular interface.
get_ui_access
+
+
Returns a UI status representing this silicon's capability to access
+the given source. Called by ui_status_silicon_has_access.
logevent
+
+
Records an IC event log entry in the cyborg's internal tablet.
+
Creates an entry in the borglog list of the cyborg's internal tablet (if it's a borg), listing the current
+in-game time followed by the message given. These logs can be seen by the cyborg in their
+BorgUI tablet app. By design, logging fails if the cyborg is dead.
+
(This used to be in robot.dm. It's in here now.)
+
Arguments:
+arg1: a string containing the message to log.
Cost of the software to purchase
+Supporting proc for the pAI to prick it's master's hand
+or... whatever. It must be held in order to work
+Gives the owner a popup if they want to get the jab.
Cost of the software to purchase
+Supporting proc for the pAI to prick it's master's hand
+or... whatever. It must be held in order to work
+Gives the owner a popup if they want to get the jab.
check_menu
+
+
Checks if we are allowed to interact with a radial menu
+
+
Arguments:
+
anchor The atom that is anchoring the menu
+
choose_chassis
+
+
Sets a new holochassis skin based on a pAI's choice
extendcable
+
+
Extend cable supporting proc
+
When doorjack is installed, allows the pAI to drop
+a cable which is placed either on the floor or in
+someone's hands based (on distance).
hack_door
+
+
Door jacking supporting proc
+
This will, after alerting any AIs on station, begin to hack open a door.
+After a 10 second timer, the door will crack open, provided they don't move out of the way.
hostscan
+
+
Host scan supporting proc
+
Allows the pAI to scan its host's health vitals
+An integrated health analyzer.
refresh_again
+
+
Proc that switches whether a pAI can refresh
+the records window again.
set_holochassis
+
+
Sets the holochassis skin and updates the icons
+
+
Arguments:
+
choice The animal skin that will be used for the pAI holoform
Checking Exited() to detect if a hat gets up and walks off.
+Drones and pAIs might do this, after all.
activate_module
+
+
Finds the first available slot and attemps to put item item_module in it.
+
Arguments
+
+
item_module - the item being equipped to a slot.
+
activated
+
+
Checks if the item is currently in a slot.
+
If the item is found in a slot, this returns TRUE. Otherwise, it returns FALSE
+Arguments
+
+
item_module - the item being checked
+
add_to_upgrades
+
+
Use this to add upgrades to robots. It'll register signals for when the upgrade is moved or deleted, if not single use.
after_righted
+
+
For any special cases for robots after being righted.
break_all_cyborg_slots
+
+
Breaks all of a cyborg's slots.
break_cyborg_slot
+
+
Breaks the slot number, changing the icon.
+
Arguments
+
+
module_num - the slot number being repaired.
+
cycle_modules
+
+
Cycles through the list of enabled modules, deselecting the current one and selecting the next one.
deploy_init
+
+
deploy_init: Deploys AI unit into AI shell
+
Arguments:
+
+
AI - AI unit that initiated the deployment into the AI shell
+
deselect_module
+
+
Deselects the module in the slot module_num.
+Arguments
+
+
module_num - the slot number being de-selected
+
equip_module_to_slot
+
+
What's the first free slot for the borg?
+Is passed an item and a module slot. Equips the item to that borg slot.
+
Arguments
+
+
item_module - the item being equipped to a slot
+
module_num - the slot number being equipped to.
+
get_active_held_item
+
+
Returns the thing in our active hand (whatever is in our active module-slot, in this case)
get_selected_module
+
+
The number of module slots we're checking
+Returns the slot number of the selected module, or zero if no modules are selected.
is_invalid_module_number
+
+
Checks if the provided module number is a valid number.
+
If the number is between 1 and 3 (if check_all_slots is true) or between 1 and the number of disabled
+modules (if check_all_slots is false), then it returns FALSE. Otherwise, it returns TRUE.
+Arguments
+
+
module_num - the passed module num that is checked for validity.
+
check_all_slots - TRUE = the proc checks all slots | FALSE = the proc only checks un-disabled slots
+
make_shell
+
+
make_shell: Makes an AI shell out of a cyborg unit
+
Arguments:
+
+
board - B.O.R.I.S. module board used for transforming the cyborg into AI shell
+
observer_screen_update
+
+
Updates the observers's screens with cyborg itemss.
+Arguments
+
+
item_module - the item being added or removed from the screen
+
add - whether or not the item is being added, or removed.
+
on_light_eater
+
+
Special handling for getting hit with a light eater
on_upgrade_deleted
+
+
Called when an applied upgrade is deleted.
remove_from_upgrades
+
+
Called when an upgrade is moved outside the robot. So don't call this directly, use forceMove etc.
repair_all_cyborg_slots
+
+
Repairs all slots. Unbroken slots are unaffected.
repair_cyborg_slot
+
+
Repairs the slot number, updating the icon.
+
Arguments
+
+
module_num - the module number being repaired.
+
revert_shell
+
+
revert_shell: Reverts AI shell back into a normal cyborg unit
select_module
+
+
Selects the module in the slot module_num.
+Arguments
+
+
module_num - the slot number being selected
+
set_lockcharge
+
+
Reports the event of the change in value of the lockcharge variable.
set_modularInterface_theme
+
+
Sets the tablet theme and icon
+
These variables are based on if the borg is a syndicate type or is emagged. This gets used in model change code
+and also borg emag code.
setup_default_name
+
+
Used to setup the a basic and (somewhat) unique name for the robot.
smash_headlamp
+
+
Handles headlamp smashing
+
When called (such as by the shadowperson lighteater's attack), this proc will break the borg's headlamp
+and then call toggle_headlamp to disable the light. It also plays a sound effect of glass breaking, and
+tells the borg what happened to its chat. Broken lights can be repaired by using a flashlight on the borg.
toggle_headlamp
+
+
Handles headlamp toggling, disabling, and color setting.
+
The initial if statment is a bit long, but the gist of it is that should the lamp be on AND the update_color
+arg be true, we should simply change the color of the lamp but not disable it. Otherwise, should the turn_off
+arg be true, the lamp already be enabled, any of the normal reasons the lamp would turn off happen, or the
+update_color arg be passed with the lamp not on, we should set the lamp off. The update_color arg is only
+ever true when this proc is called from the borg tablet, when the color selection feature is used.
+
Arguments:
+
+
arg1 - turn_off, if enabled will force the lamp into an off state (rather than toggling it if possible)
+
arg2 - update_color, if enabled, will adjust the behavior of the proc to change the color of the light if it is already on.
+
toggle_module
+
+
Toggles selection of the module in the slot module_num.
+Arguments
+
+
module_num - the slot number being toggled
+
uneq_active
+
+
Unequips the active held item, if there is one.
uneq_all
+
+
Unequips all held items.
unequip_module_from_slot
+
+
Unequips item item_module from slot module_num. Deletes it if delete_after = TRUE.
+
Arguments
+
+
item_module - the item being unequipped
+
module_num - the slot number being unequipped.
+
update_sight
+
+
the current percent health of the robot (-1 to 1)
updatename
+
+
Updates the borg name taking the client preferences into account.
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), AI_Z_OFF (Temporarily off due to nonpresence of players).
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
+Leaving something at 0 means it's off - has no maximum.
ticks up every time handle_automated_movement() is called, which is every 2 seconds at the time of documenting. 1 turns per move is 1 movement every 2 seconds.
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), AI_Z_OFF (Temporarily off due to nonpresence of players).
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
+Leaving something at 0 means it's off - has no maximum.
ticks up every time handle_automated_movement() is called, which is every 2 seconds at the time of documenting. 1 turns per move is 1 movement every 2 seconds.
Performs a step_towards and increments the path if successful. Returns TRUE if the bot moved and FALSE otherwise.
get_mode_ui
+
+
Returns a status string about the bot's current status, if it's moving, manually controlled, or idle.
scan
+
+
Attempt to scan tiles near [src], first by checking adjacent, then if a target is still not found, nearby.
+
scan_types - list (of typepaths) that nearby tiles are being scanned for.
+old_target - what has already been scanned, and will early return at checkscan.
+scan_range - how far away from [src] will be scanned, if nothing is found directly adjacent.
+
+
+
diff --git a/mob/living/simple_animal/bot/cleanbot.html b/mob/living/simple_animal/bot/cleanbot.html
new file mode 100644
index 000000000000..22a36689137c
--- /dev/null
+++ b/mob/living/simple_animal/bot/cleanbot.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+ /mob/living/simple_animal/bot/cleanbot - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
What damage type does this bot support. Because the default is brute, if the medkit is brute-oriented there is a slight bonus to healing. set to "all" for it to heal any of the 4 base damage types
What damage type does this bot support. Because the default is brute, if the medkit is brute-oriented there is a slight bonus to healing. set to "all" for it to heal any of the 4 base damage types
Checks whether the bot can complete a step_towards, checking whether the bot is on and has the charge to do the move. Returns COMPONENT_MOB_BOT_CANCELSTEP if the bot should not step.
The amount of steps we should take until we rest for a time.
check_pre_step
+
+
Checks whether the bot can complete a step_towards, checking whether the bot is on and has the charge to do the move. Returns COMPONENT_MOB_BOT_CANCELSTEP if the bot should not step.
get_load_name
+
+
resolves the name to display for the loaded mob. primarily needed for the paranormal subtype since we don't want to show the name of ghosts riding it.
has_power
+
+
returns true if the bot is fully powered.
on_bot_step
+
+
Uses power from the cell when the bot steps.
+
+
+
diff --git a/mob/living/simple_animal/bot/secbot.html b/mob/living/simple_animal/bot/secbot.html
new file mode 100644
index 000000000000..589b52e20292
--- /dev/null
+++ b/mob/living/simple_animal/bot/secbot.html
@@ -0,0 +1,120 @@
+
+
+
+
+
+
+ /mob/living/simple_animal/bot/secbot - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
blacklisted drone machine typecache, compiled from [var/drone_machinery_blacklist_flat], [var/list/drone_machinery_blacklist_recursive], negated by their whitelist counterparts
If we have laws to minimize bothering others. Enables or disables drone laws enforcement components (use [/mob/living/simple_animal/drone/proc/set_shy] to set)
blacklisted drone machine typecache, compiled from [var/drone_machinery_blacklist_flat], [var/list/drone_machinery_blacklist_recursive], negated by their whitelist counterparts
If we have laws to minimize bothering others. Enables or disables drone laws enforcement components (use [/mob/living/simple_animal/drone/proc/set_shy] to set)
Mobs ignore mob/living targets with a stat lower than that of stat_attack. If set to DEAD, then they'll include corpses in their targets, if to UNCONSCIOUS they'll keep attacking until they kill, and so on.
Mobs ignore mob/living targets with a stat lower than that of stat_attack. If set to DEAD, then they'll include corpses in their targets, if to UNCONSCIOUS they'll keep attacking until they kill, and so on.
A strange alien creature capable of increasing its mass when threatened,
+giving it unmatched defensive capabilities temporarily. The rest of the
+time, it is quite fragile.
+
On death, the "fugu gland" is dropped, which can be used on simple mobs
+to increase their size, health, strength, and lets them smash walls.
+
+
+
diff --git a/mob/living/simple_animal/hostile/asteroid/ice_demon.html b/mob/living/simple_animal/hostile/asteroid/ice_demon.html
new file mode 100644
index 000000000000..c3bda930b13d
--- /dev/null
+++ b/mob/living/simple_animal/hostile/asteroid/ice_demon.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /mob/living/simple_animal/hostile/asteroid/ice_demon - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Lobstrosities, the poster boy of charging AI mobs. Drops crab meat and bones.
+Outside of charging, it's intended behavior is that it is generally slow moving, but makes up for that with a knockdown attack to score additional hits.
sound played when the mimic attempts to eat more items than it can
Proc Details
insert
+
+
Called by toggle_open to put items inside the mimic when it's being closed
+
Will return -1 if the insertion fails due to the storage capacity of the mimic having been reached
+Will return FALSE if insertion fails
+Will return TRUE if insertion succeeds
+Arguments:
+
+
AM - item to be inserted
+
toggle_open
+
+
Used to open and close the mimic
+
Will insert tile contents into the mimic when closing
+Will dump mimic contents into the time when opening
+Does nothing if the mimic locked itself
Gelatinious Ooze code below *\\
+Its good stats and high mobility makes this a good assasin type creature. It's vulnerabilites against cold, shotguns and
The Spell that the rat uses to recruit/convert more rats.
Proc Details
cheese_heal
+
+
Conditionally "eat" cheese object and heal, if injured.
+
A private proc for sending a message to the mob's chat about them
+eating some sort of cheese, then healing them, then deleting the cheese.
+The "eating" is only conditional on the mob being injured in the first
+place.
get_clicked_player
+
+
Sets a ghost to control the rat if the rat is eligible
+
Asks the interacting ghost if they would like to control the rat.
+If they answer yes, and another ghost hasn't taken control, sets the ghost to control the rat.
+Arguments:
+
+
mob/user - The ghost to possibly control the rat
+
pry_door
+
+
Allows rat king to pry open an airlock if it isn't locked.
+
A proc used for letting the rat king pry open airlocks instead of just attacking them.
+This allows the rat king to traverse the station when there is a lack of vents or
+accessible doors, something which is common in certain rat king spawn points.
+
+
+
diff --git a/mob/living/simple_animal/hostile/retaliate.html b/mob/living/simple_animal/hostile/retaliate.html
new file mode 100644
index 000000000000..cc63f4276809
--- /dev/null
+++ b/mob/living/simple_animal/hostile/retaliate.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /mob/living/simple_animal/hostile/retaliate - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
This proc eats the atom, certain funny items are stored directly in the prank pouch while bananas grant a heal based on their potency and the peels are retained in the pouch.
This is the list of items we are ready to regurgitate,
Proc Details
Initialize
+
+
This ability lets you fire a single random item from your pouch.
check_edible
+
+
Returns whether or not the supplied movable atom is edible.
eat_atom
+
+
This proc eats the atom, certain funny items are stored directly in the prank pouch while bananas grant a heal based on their potency and the peels are retained in the pouch.
Checks if an item is in the list of wanted items and if it is after a Yes/No radial returns generate_cash with the value of the item for the NPC
+Arguments:
Associated list of items able to be sold to the NPC with the money given for them.
Proc Details
buy_item
+
+
Generates a radial of the items the NPC sells and lets the user try to buy one
+Arguments:
+
+
user - The mob trying to buy something
+
check_menu
+
+
Checks if the user is ok to use the radial
+
Checks if the user is not a mob or is incapacitated or not adjacent to the source of the radial, in those cases returns FALSE, otherwise returns TRUE
+Arguments:
+
+
user - The mob checking the menu
+
deep_lore
+
+
Makes the NPC say one picked thing from the lore list variable, can be overriden for fun stuff
generate_cash
+
+
Creates a holochip the value set by the proc and puts it in the user's hands
+Arguments:
+
+
value - The amount of cash that will be on the holochip
+
user - The mob we put the holochip in hands of
+
sell_item
+
+
Checks if an item is in the list of wanted items and if it is after a Yes/No radial returns generate_cash with the value of the item for the NPC
+Arguments:
+
+
user - The mob trying to sell something
+
selling - The item being sold
+
try_buy
+
+
Tries to buy an item from the trader
+Arguments:
+
+
user - The mob trying to buy something
+
item_to_buy - Item that is being bought
+
try_sell
+
+
Tries to call sell_item on one of the user's held items, if fail gives a chat message
+
Gets both items in the user's hands, and then tries to call sell_item on them, if both fail, he gives a chat message
+Arguments:
A space-faring leviathan-esque monster which breathes fire and summons carp. Spawned during its respective midround antagonist event.
+
A space-faring monstrosity who has the ability to breathe dangerous fire breath and uses its powerful wings to knock foes away.
+Normally spawned as an antagonist during the Space Dragon event, Space Dragon's main goal is to open three rifts from which to pull a great tide of carp onto the station.
+Space Dragon can summon only one rift at a time, and can do so anywhere a blob is allowed to spawn. In order to trigger his victory condition, Space Dragon must summon and defend three rifts while they charge.
+Space Dragon, when spawned, has five minutes to summon the first rift. Failing to do so will cause Space Dragon to return from whence he came.
+When the rift spawns, ghosts can interact with it to spawn in as space carp to help complete the mission. One carp is granted when the rift is first summoned, with an extra one every 30 seconds.
+Once the victory condition is met, all current rifts become invulnerable to damage, are allowed to spawn infinite sentient space carp, and Space Dragon gets unlimited rage.
+Alternatively, if the shuttle arrives while Space Dragon is still active, their victory condition will automatically be met and all the rifts will immediately become fully charged.
+If a charging rift is destroyed, Space Dragon will be incredibly slowed, and the endlag on his gust attack is greatly increased on each use.
+Space Dragon has the following abilities to assist him with his objective:
+
+
Can shoot fire in straight line, dealing 30 burn damage and setting those suseptible on fire.
+
Can use his wings to temporarily stun and knock back any nearby mobs. This attack has no cooldown, but instead has endlag after the attack where Space Dragon cannot act. This endlag's time decreases over time, but is added to every time he uses the move.
+
Can swallow mob corpses to heal for half their max health. Any corpses swallowed are stored within him, and will be regurgitated on death.
+
Can tear through any type of wall. This takes 4 seconds for most walls, and 12 seconds for reinforced walls.
A list of all of the rifts created by Space Dragon. Used for setting them all to infinite carp spawn when Space Dragon wins, and removing them when Space Dragon dies.
A list of all of the rifts created by Space Dragon. Used for setting them all to infinite carp spawn when Space Dragon wins, and removing them when Space Dragon dies.
Determines whether or not Space Dragon is in the middle of using wing gust. If set to true, prevents him from moving and doing certain actions.
Proc Details
add_dragon_overlay
+
+
Adds the proper overlay to the space dragon.
+
Clears the current overlay on space dragon and adds a proper one for whatever animation he's in.
color_selection
+
+
Allows space dragon to choose a color for itself.
+
Prompts the space dragon to choose a color, from which it will then apply to itself.
+If an invalid color is given, will re-prompt the dragon until a proper color is chosen.
destroy_rifts
+
+
Destroys all of Space Dragon's current rifts.
+
QDeletes all the current rifts after removing their references to other objects.
+Currently, the only reference they have is to the Dragon which created them, so we clear that before deleting them.
+Currently used when Space Dragon dies or one of his rifts is destroyed.
dragon_fire_line
+
+
What occurs on each tile to actually create the fire.
+
Creates a fire on the given turf.
+It creates a hotspot on the given turf, damages any living mob with 30 burn damage, and damages mechs by 50.
+It can only hit any given target once.
+Arguments:
+
+
turf/T - The turf to trigger the effects on.
+
dragon_name
+
+
Allows space dragon to choose its own name.
+
Prompts the space dragon to choose a name, which it will then apply to itself.
+If the name is invalid, will re-prompt the dragon until a proper name is chosen.
eat
+
+
Handles consuming and storing consumed things inside Space Dragon
+
Plays a sound and then stores the consumed thing inside Space Dragon.
+Used in AttackingTarget(), paired with a heal should it succeed.
+Arguments:
+
+
atom/movable/A - The thing being consumed
+
empty_contents
+
+
Disperses the contents of the mob on the surrounding tiles.
+
Randomly places the contents of the mob onto surrounding tiles.
+Has a 10% chance to place on the same tile as the mob.
fire_stream
+
+
Spawns fire at each position in a line from the source to the target.
+
Spawns fire at each position in a line from the source to the target.
+Stops if it comes into contact with a solid wall, a window, or a door.
+Delays the spawning of each fire by 1.5 deciseconds.
+Arguments:
+
+
atom/at - The target
+
line_target
+
+
Determines a line of turfs from sources's position to the target with length range.
+
Determines a line of turfs from the source's position to the target with length range.
+The line will extend on past the target if the range is large enough, and not reach the target if range is small enough.
+Arguments:
+
+
offset - whether or not to aim slightly to the left or right of the target
+
range - how many turfs should we go out for
+
atom/at - The target
+
permanant_empower
+
+
Gives Space Dragon their the rift speed buff permanantly.
+
Gives Space Dragon the enraged speed buff from charging rifts permanantly.
+Only happens in circumstances where Space Dragon completes their objective.
reset_status
+
+
Resets Space Dragon's status after using wing gust.
+
Resets Space Dragon's status after using wing gust.
+If it isn't dead by the time it calls this method, reset the sprite back to the normal living sprite.
+Also sets the using_special variable to FALSE, allowing Space Dragon to move and attack freely again.
rift_depower
+
+
Removes Space Dragon's rift speed buff.
+
Removes Space Dragon's speed buff from charging a rift. This is only called
+in rift_empower, which uses a timer to call this after 30 seconds. Also
+removes the red glow from Space Dragon which is synonymous with the speed buff.
rift_empower
+
+
Handles Space Dragon's temporary empowerment after boosting a rift.
+
Empowers and depowers Space Dragon after a successful rift charge.
+Empowered, Space Dragon regains all his health and becomes temporarily faster for 30 seconds, along with being tinted red.
useGust
+
+
Handles wing gust from the windup all the way to the endlag at the end.
+
Handles the wing gust attack from start to finish, based on the timer.
+When intially triggered, starts at 0. Until the timer reaches 10, increase Space Dragon's y position by 2 and call back to the function in 1.5 deciseconds.
+When the timer is at 10, trigger the attack. Change Space Dragon's sprite. reset his y position, and push all living creatures back in a 3 tile radius and stun them for 5 seconds.
+Stay in the ending state for how much our tiredness dictates and add to our tiredness.
+Arguments:
+
+
timer - The timer used for the windup.
+
victory
+
+
Sets up Space Dragon's victory for completing the objectives.
+
Triggers when Space Dragon completes his objective.
+Calls the shuttle with a coefficient of 3, making it impossible to recall.
+Sets all of his rifts to allow for infinite sentient carp spawns
+Also plays appropiate sounds and CENTCOM messages.
The result of a kudzu flower bud, these enemies use vines to drag prey close to them for attack.
+
A carnivorious plant which uses vines to catch and ensnare prey. Spawns from kudzu flower buds.
+Each one has a maximum of four vines, which can be attached to a variety of things. Carbons are stunned when a vine is attached to them, and movable entities are pulled closer over time.
+Attempting to attach a vine to something with a vine already attached to it will pull all movable targets closer on command.
+Once the prey is in melee range, melee attacks from the venus human trap heals itself for 10% of its max health, assuming the target is alive.
+Akin to certain spiders, venus human traps can also be possessed and controlled by ghosts.
Sets a ghost to control the plant if the plant is eligible
+
Asks the interacting ghost if they would like to control the plant.
+If they answer yes, and another ghost hasn't taken control, sets the ghost to control the plant.
+Arguments:
+
+
mob/user - The ghost to possibly control the plant
+
pull_vines
+
+
Manages how the vines should affect the things they're attached to.
+
Pulls all movable targets of the vines closer to the plant
+If the target is on the same tile as the plant, destroy the vine
+Removes any QDELETED vines from the vines list.
remove_vine
+
+
Removes a vine from the list.
+
Removes the vine from our list.
+Called specifically when the vine is about to be destroyed, so we don't have any null references.
+Arguments:
+
+
datum/beam/vine - The vine to be removed from the list.
Special handling for gondolas, as they don't use icon_states and instead rely on overlays. The parent of this proc deletes all our overlays, so we're overriding it.
Proc Details
regenerate_icons
+
+
Special handling for gondolas, as they don't use icon_states and instead rely on overlays. The parent of this proc deletes all our overlays, so we're overriding it.
turns out view() spends a significant portion of its processing time generating lists of contents of viewable turfs which includes EVERYTHING on it visible
+
+
+
and the turf itself. there is an optimization to view() which makes it only generate lists of a certain atom type - this system takes advantage of that.
+
+
+
a fuckton of these are generated as part of its SS's init and stored in a list, when requested for a list of movables returned by the spatial grid or by some
+
+
+
superset of the final output that must be narrowed down by view() one of these gets put on every turf that contains the movables that need filtering
+
+
+
and each is given references to the movables they represent. that way you can do for(var/mob/oranges_ear/ear in view(...)) and check what they reference
+
+
+
as opposed to for(var/atom/movable/target in view(...)) and checking if they have the properties you want which leads to much larger lists generated by view()
+
+
+
and also leads to iterating through more movables to filter them.
+
+
+
TLDR: iterating through just mobs is much faster than all movables when iterating through view(), this system leverages that to boost speed
+
+
+
enough to offset the cost of allocating the mobs
+
+
+
named because the idea was first made by oranges and i didnt know what else to call it (note that this system was originally made for get_hearers_in_view())
references to everything "on" the turf we are assigned to, that we care about. populated in assign() and cleared in unassign().
+movables iside of other movables count as being "on" if they have get_turf(them) == our turf. intentionally not a lazylist
references to everything "on" the turf we are assigned to, that we care about. populated in assign() and cleared in unassign().
+movables iside of other movables count as being "on" if they have get_turf(them) == our turf. intentionally not a lazylist
Used to handle proccalls called indirectly by an admin (e.g. tgs, circuits).
+Has to be a mob because IsAdminAdvancedProcCall() checks usr, which is a mob variable.
+So usr is set to this for any proccalls that don't have any usr mob/client to refer to.
Returns a boolean based on whether or not the string contains a comma or an apostrophe,
+to be used for emotes to decide whether or not to have a space between the name of the user
+and the emote.
maximum extensions until the round autoends.
+Set to 0 to force automatic crew transfer after the 'vote_autotransfer_initial' elapsed.
+Set to -1 to disable the maximum extensions cap.
Adds functionality to custom job titles, making them show up in manifests, ID's and announcements.
+Unfortunately, all 3 of the categories are not set up to be very modular, so this almost entirely consists of TG proc changes.
./code/modules/surgery/organs/tongue.dm > var/static/list/languages_possible_base - added 2 languages
+./code/modules/mob/living/carbon/human/species_types/lizardpeople.dm > commented out "mutant_organs = list(/obj/item/organ/tail/lizard)"
+./code/modules/mob/living/carbon/human/species_types/felinid.dm > commented out "mutantears = /obj/item/organ/ears/cat" and "mutant_organs = list(/obj/item/organ/tail/cat)"
+./code/modules/mob/living/carbon/human/species.dm > var/list/list/mutant_bodyparts (added typed list type)
+./code/_globalvars/lists/flavor_misc.dm > Removed accessory list defines
+.\code\datums\keybindings\living.dm > /datum/keybinding/living/look_up > from L to P
./code/__DEFINES/~skyrat_defines/DNA.dm > A TON of defines
+./code/__DEFINES/~skyrat_defines/obj_flags.dm > Organ flags
+./code/__DEFINES/~skyrat_defines/say.dm > MAX_FLAVOR_LEN
+./code/__DEFINES/~skyrat_defines/traits.dm > TRAIT_NO_HUSK
https://github.com/Skyrat-SS13/Skyrat-tg/pull/9922 -- Mech CI PR from Niko
+Title: Indicators
+
MODULE ID: INDICATORS
+Description:
+
The compilation of all player indicators (SSD, Typing)
+SSD Indicator - Automatically shows when a player has disconnected
+Typing Indicator - Shows when a player is typing
Azarak - Porting and OG code for Combat Indicator, Typing Indicator, SSD Indicator
+FlamingLily - Consolidation, surrender alert
+Niko - making CI work with mechs and stuff
+GoldenAlphrex - Being invaluably helpful in telling me (niko) how to do things
Adds the ability for living mobs to shift their sprite to fit an RP situation better (standing against a wall for example). Not appended to proc due to it being a busy proc
Map tag for something. Tired of it being used on snowflake items. Moved here for some semblance of a standard.
+Next pr after the network fix will have me refactor door interactions, so help me god.
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.
Map tag for something. Tired of it being used on snowflake items. Moved here for some semblance of a standard.
+Next pr after the network fix will have me refactor door interactions, so help me god.
How large is the object, used for stuff like whether it can fit in backpacks or not
Proc Details
acid_act
+
+
the obj's reaction when touched by acid
acid_melt
+
+
called when the obj is destroyed by acid.
airflow_hit_act
+
+
Heheheh
atom_destruction
+
+
what happens when the obj's integrity reaches zero.
attack_tk_grab
+
+
Telekinesis object grab act.
+
+
Called by /obj/attack_tk().
+
Returns COMPONENT_CANCEL_ATTACK_CHAIN when it performs any action, to further acts on the attack chain.
+
burn
+
+
called when the obj is destroyed by fire
check_reskin_menu
+
+
Checks if we are allowed to interact with a radial menu for reskins
+
Arguments:
+
+
user The mob interacting with the menu
+
deconstruct
+
+
the obj is deconstructed into pieces, whether through careful disassembly or when destroyed.
expose_reagents
+
+
Handles exposing an object to reagents.
extinguish
+
+
Called when the obj is no longer on fire.
fire_act
+
+
/ FIRE
+Called when the obj is exposed to fire.
flick_emote_popup_on_obj
+
+
A proc type that, when called, causes a image/sprite to appear above whatever entity it is called on.
+
There are two types: on_mob and on_obj, they can only be called on their respective typepaths.
+
Arguments:
+
+
state -- The icon_state of whatever .dmi file you're attempting to use for the sprite, in "" format. Ex. "combat", not combat.dmi.
+
time -- The amount of time the sprite remains before remove_emote_popup_on_obj is called. Is used in the addtimer.
+
freeze
+
+
attempt to freeze this obj if possible. returns TRUE if it succeeded, FALSE otherwise.
lose_block_z_out
+
+
Removes a BLOCK_Z_OUT_* flag, and then tries to get every movable in the turf to fall.
pipe_eject
+
+
General proc used to expel a holder's contents through src (for bins holder is also the src).
remove_emote_popup_on_obj
+
+
A proc that is automatically called whenever flick_emote_popup_on_obj's addtimer expires, and removes the popup.
+
Arguments:
+
+
emote_overlay -- Inherits state from the preceding proc.
+
reskin_obj
+
+
Reskins object based on a user's choice
+
Arguments:
+
+
M The mob choosing a reskin option
+
unfreeze
+
+
unfreezes this obj if its frozen
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.
The identifier of the port or ship.
+This will be used in numerous other places like the console,
+stationary ports and whatnot to tell them your ship's mobile
+port can be used in these places, or the docking port is compatible, etc.
The identifier of the port or ship.
+This will be used in numerous other places like the console,
+stationary ports and whatnot to tell them your ship's mobile
+port can be used in these places, or the docking port is compatible, etc.
Both lists are associative with a turf:bitflag structure. (new_turfs bitflag space unused currently)
+The bitflag contains the data for what inhabitants of that coordinate should be moved to the new location
+The bitflags can be found in __DEFINES/shuttles.dm
used as a timer (if you want time left to complete move, use timeLeft proc)
Proc Details
beforeShuttleMove
+
+
Misc move procs
get_status_text_tgui
+
+
Gets shuttle location status in a form of string for tgui interfaces
initiate_docking
+
+
This is the main proc. It instantly moves our mobile port to stationary port new_dock.
preflight_check
+
+
Both lists are associative with a turf:bitflag structure. (new_turfs bitflag space unused currently)
+The bitflag contains the data for what inhabitants of that coordinate should be moved to the new location
+The bitflags can be found in __DEFINES/shuttles.dm
Proc that handles checking if the emergency shuttle was successfully hijacked via being the only people present on the shuttle for the elimination hijack or highlander objective
Proc that handles checking if the emergency shuttle was successfully hijacked via being the only people present on the shuttle for the elimination hijack or highlander objective
+
Checks for all mobs on the shuttle, checks their status, and checks if they're
+borgs or simple animals. Depending on the args, certain mobs may be ignored,
+and the presence of other antags may or may not invalidate a hijack.
+Args:
+filter_by_human, default TRUE, tells the proc that only humans should block a hijack. Borgs and animals are ignored and will not block if this is TRUE.
+solo_hijack, default FALSE, tells the proc to fail with multiple hijackers, such as for Highlander mode.
Shield processing
+*An object to take the hit for us when using the Durand's defense mode.
+It is spawned in during the durand's initilization, and always stays on the same tile.
+Normally invisible, until defense mode is actvated. When the durand detects an attack that should be blocked, the
+attack is passed to the shield. The shield takes the damage, uses it to calculate charge cost, and then sets its
+own integrity back to max. Shield is automatically dropped if we run out of power or the user gets out.
This proc is called by a signal sent from the mech's action button and
+relayed by the mech itself. The "forced" variable, signal_args[1], will
+skip the to-pilot text and is meant for when the shield is disabled by
+means other than the action button (like running out of power).
+
Arguments:
+
+
source: the shield
+
owner: mob that activated the shield
+
signal_args: whether it's forced
+
+
+
+
diff --git a/obj/effect/abstract/aim_overlay.html b/obj/effect/abstract/aim_overlay.html
new file mode 100644
index 000000000000..2ba5500f730a
--- /dev/null
+++ b/obj/effect/abstract/aim_overlay.html
@@ -0,0 +1,71 @@
+
+
+
+
+
+
+ /obj/effect/abstract/aim_overlay - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
objects can only have one particle on them at a time, so we use these abstract effects to hold and display the effects. You know, so multiple particle effects can exist at once.
+also because some objects do not display particles due to how their visuals are built
Sets the particles position to the passed coordinate list (X, Y, Z)
+See [https://www.byond.com/docs/ref/#/{notes}/particles] for position documentation
Holds info about how this particle emitter works
+See \code__DEFINES\particles.dm
Proc Details
on_move
+
+
signal called when a parent that's been hooked into this moves
+does a variety of checks to ensure overrides work out properly
parent_deleted
+
+
Non movables don't delete contents on destroy, so we gotta do this
set_particle_position
+
+
Sets the particles position to the passed coordinate list (X, Y, Z)
+See [https://www.byond.com/docs/ref/#/{notes}/particles] for position documentation
+
+
+
diff --git a/obj/effect/anomaly.html b/obj/effect/anomaly.html
new file mode 100644
index 000000000000..79324dfbb325
--- /dev/null
+++ b/obj/effect/anomaly.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /obj/effect/anomaly - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
We can designate a specific target to aim for, in which case we'll try to snipe them rather than just flying in a random direction
Proc Details
go_for_a_walk
+
+
Allows your rod to release restraint level zero and go for a walk.
+
If walkies_location is set, rod will move towards the location, chasing it across z-levels if necessary.
+If walkies_location is not set, rod will call complete_trajectory() and follow the logic from that proc.
+
Arguments:
+
+
walkies_location - Any atom that the immovable rod will now chase down as a special target.
+
sit_stay_good_rod
+
+
Stops your rod's automated movement. Sit... Stay... Good rod!
suplex_rod
+
+
Called when someone manages to suplex the rod.
+
Arguments
+
+
strongman - the suplexer of the rod.
+
walk_in_direction
+
+
Rod will walk towards edge turf in the specified direction.
+
Arguments:
+
+
direction - The direction to walk the rod towards: NORTH, SOUTH, EAST, WEST.
lift_id landmarks. used to map in specific_lift_id to trams. when the trams lift_master encounters one on a trams tile
+it sets its specific_lift_id to that landmark. allows you to have multiple trams and multiple controls linking to their specific tram
This should return raw sound in response to http get request. For example: "https://github.com/DaedalusDock/Gameserver/blob/master/sound/misc/bang.ogg?raw=true"
This should return raw sound in response to http get request. For example: "https://github.com/DaedalusDock/Gameserver/blob/master/sound/misc/bang.ogg?raw=true"
This places an unlinked trapdoor in the tile its on (so someone with a remote needs to link it up first)
+Admins may spawn this in the round for additional trapdoors if they so desire
+if YOU want to learn more about trapdoors, read about the component at trapdoor.dm
+note: this is not a turf subtype because the trapdoor needs the type of the turf to turn back into
+
+
+
diff --git a/obj/effect/mapping_helpers/ztrait_injector.html b/obj/effect/mapping_helpers/ztrait_injector.html
new file mode 100644
index 000000000000..0bdb91281741
--- /dev/null
+++ b/obj/effect/mapping_helpers/ztrait_injector.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /obj/effect/mapping_helpers/ztrait_injector - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
We manually check to see if we've been triggered in case multiple atoms cross us in the time between the mine being triggered and it actually deleting, to avoid a race condition with multiple detonations
We manually check to see if we've been triggered in case multiple atoms cross us in the time between the mine being triggered and it actually deleting, to avoid a race condition with multiple detonations
Proc Details
mineEffect
+
+
The effect of the mine
now_armed
+
+
If the landmine was previously inactive, this beeps and displays a message marking it active
triggermine
+
+
When something sets off a mine
+
+
+
diff --git a/obj/effect/mine/explosive.html b/obj/effect/mine/explosive.html
new file mode 100644
index 000000000000..af9b4b0cf98f
--- /dev/null
+++ b/obj/effect/mine/explosive.html
@@ -0,0 +1,64 @@
+
+
+
+
+
+
+ /obj/effect/mine/explosive - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
If TRUE, we spawn extra pellets to eviscerate the person who stepped on it, otherwise it just spawns a ring of pellets around the tile we're on (making setting it off an offensive move)
If TRUE, we spawn extra pellets to eviscerate the person who stepped on it, otherwise it just spawns a ring of pellets around the tile we're on (making setting it off an offensive move)
+
+
+
diff --git a/obj/effect/mob_spawn.html b/obj/effect/mob_spawn.html
new file mode 100644
index 000000000000..a920419294ac
--- /dev/null
+++ b/obj/effect/mob_spawn.html
@@ -0,0 +1,108 @@
+
+
+
+
+
+
+ /obj/effect/mob_spawn - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
/Human specific stuff. Don't set these if you aren't using a human, the unit tests will put a stop to your sinful hand.
+sets the human as a species, use a typepath (example: /datum/species/skeleton)
/Human specific stuff. Don't set these if you aren't using a human, the unit tests will put a stop to your sinful hand.
+sets the human as a species, use a typepath (example: /datum/species/skeleton)
Typepath indicating the kind of job datum this ghost role will have. PLEASE inherit this with a new job datum, it's not hard. jobs come with policy configs.
/descriptions
+This should be the declaration of what the ghost role is, and maybe a short blurb after if you want. Shown in the spawner menu and after spawning first.
Typepath indicating the kind of job datum this ghost role will have. PLEASE inherit this with a new job datum, it's not hard. jobs come with policy configs.
/descriptions
+This should be the declaration of what the ghost role is, and maybe a short blurb after if you want. Shown in the spawner menu and after spawning first.
Proc Details
allow_spawn
+
+
override this to add special spawn conditions to a ghost role
+
+
+
diff --git a/obj/effect/mob_spawn/ghost_role/drone.html b/obj/effect/mob_spawn/ghost_role/drone.html
new file mode 100644
index 000000000000..f5008bac51e3
--- /dev/null
+++ b/obj/effect/mob_spawn/ghost_role/drone.html
@@ -0,0 +1,46 @@
+
+
+
+
+
+
+ /obj/effect/mob_spawn/ghost_role/drone - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Makes the smoke react to nearby opening/closing airlocks and the like.
+Makes it possible for smoke to spread through airlocks that open after the edge of the smoke cloud has already spread past them.
Animates the smoke gradually fading into visibility.
+Also makes the smoke turf opaque as it passes 160 alpha.
+
Arguments:
+
+
frames = 0.8 [SECONDS]: The amount of time the smoke should fade in over.
+
fade_out
+
+
Animates the smoke gradually fading out of visibility.
+Also makes the smoke turf transparent as it passes 160 alpha.
+
Arguments:
+
+
frames = 0.8 [SECONDS]: The amount of time the smoke should fade out over.
+
kill_smoke
+
+
Makes the smoke fade out and then deletes it.
react_to_atmos_adjacency_changes
+
+
Makes the smoke react to nearby opening/closing airlocks and the like.
+Makes it possible for smoke to spread through airlocks that open after the edge of the smoke cloud has already spread past them.
+
Arguments:
+
+
source: The turf that has been touched by an atmos adjacency change.
+
smoke_mob
+
+
Handles the effects of this smoke on any mobs it comes into contact with.
+
Arguments:
+
+
smoker: The mob that is being exposed to this smoke.
+
seconds_per_tick: A scaling factor for the effects this has. Primarily based off of tick rate to normalize effects to units of rate/sec.
+
+
Returns whether the smoke effect was applied to the mob.
Triggers the effect of the powerup on the target, returns FALSE if the target is not /mob/living, is dead or the cooldown hasn't finished, returns TRUE otherwise
How long in deciseconds it will take for the powerup to respawn, if no value it won't respawn
Proc Details
trigger
+
+
Triggers the effect of the powerup on the target, returns FALSE if the target is not /mob/living, is dead or the cooldown hasn't finished, returns TRUE otherwise
+
+
+
diff --git a/obj/effect/powerup/health.html b/obj/effect/powerup/health.html
new file mode 100644
index 000000000000..2eec5b426897
--- /dev/null
+++ b/obj/effect/powerup/health.html
@@ -0,0 +1,50 @@
+
+
+
+
+
+
+ /obj/effect/powerup/health - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Used as the dye color source in the washing machine only (at the moment). Can be a hex color or a key corresponding to a registry entry, see washing_machine.dm
Grinder var:A reagent list containing the reagents this item produces when ground up in a grinder - this can be an empty list to allow for reagent transferring only
Set this variable to determine up to which temperature (IN KELVIN) the item protects against heat damage. Keep at null to disable protection. Only protects areas set by heat_protection flags
Set this variable to determine down to which temperature (IN KELVIN) the item protects against cold damage. 0 is NOT an acceptable number due to if(varname) tests!! Keep at null to disable protection. Only protects areas set by cold_protection flags
The list of slots by priority. equip_to_appropriate_slot() uses this list. Doesn't matter if a mob type doesn't have a slot. For default list, see /mob/proc/equip_to_appropriate_slot
Dimensions of the icon file used when this item is worn, eg: hats.dmi (32x32 sprite, 64x64 sprite, etc.). Allows inhands/worn sprites to be of any size, but still centered on a mob properly
Dimensions of the icon file used when this item is worn, eg: hats.dmi (32x32 sprite, 64x64 sprite, etc.). Allows inhands/worn sprites to be of any size, but still centered on a mob properly
Adds an item action to our list of item actions.
+Item actions are actions linked to our item, that are granted to mobs who equip us.
+This also ensures that the actions are properly tracked in the actions list and removed if they're deleted.
+Can be be passed a typepath of an action or an instance of an action.
Creates a "Type-A" contextual screentip interaction.
+When a user hovers over something with this item in hand, this proc will be called in order
+to provide context for contextual screentips.
+You must call register_item_context() in order for this to be registered.
+A screentip context list is a list that has context keys (SCREENTIP_CONTEXT_*, from __DEFINES/screentips.dm)
+that map to the action as text.
+If you mutate the list in this signal, you must return CONTEXTUAL_SCREENTIP_SET.
+source can, in all cases, be replaced with src, and only exists because this proc directly connects to a signal.
Called when the item is in the active hand, and right-clicked. Intended for alternate or opposite functions, such as lowering reagent transfer amount. At the moment, there is no verb or hotkey.
For when you want to disable an item's embedding capabilities (like transforming weapons and such), this proc will detach any active embed elements from it.
Called when the wearer is being hit by an attack while wearing/wielding this item.
+Returning TRUE will eat the attack, but this should be done by can_block_attack() instead.
Does the current embedding var meet the criteria for being harmless? Namely, does it have a pain multiplier and jostle pain mult of 0? If so, return true.
the mob M is attempting to equip this item into the slot passed through as 'slot'. Return 1 if it can do this and 0 if it can't.
+if this is being done by a mob other than M, it will include the mob equipper, who is trying to equip the item to mob M. equipper will be null otherwise.
+If you are making custom procs but would like to retain partial or complete functionality of this one, include a 'return ..()' to where you want this to happen.
+Arguments:
An interrupt for someone trying to accept an offered item, called mainly from /mob/living/carbon/proc/take, in case you want to run your own take behavior instead.
An interrupt for offering an item to other people, called mainly from /mob/living/carbon/proc/give, in case you want to run your own offer behavior instead.
Create a "Type-A" contextual screentip interaction, registering to add_item_context().
+This will run add_item_context() when the item hovers over another object for context.
+add_item_context() will not be called unless this is run.
+This is not necessary for Type-A interactions, as you can just apply the flag and register to the signal yourself.
tryEmbed() is for when you want to try embedding something without dealing with the damage + hit messages of calling hitby() on the item while targetting the target.
This proc is executed when someone clicks the on-screen UI button.
+The default action is attack_self().
+Checks before we get to here are: mob is alive, mob is not restrained, stunned, asleep, resting, laying, item is on the mob.
For when you want to add/update the embedding on an item. Uses the vars in /obj/item/var/embedding, and defaults to config values for values that aren't set. Will automatically detach previous embed elements on this item.
How many mats have we found? You can only be affected by two material datums by default
+How much of each material is in it? Used to determine if the glass should break
+The glass shard that is spawned into the source item
+victim's chest (for cavity implanting the item)
+Updates all action buttons associated with this item
To be overwritten to only perform visual tasks;
+this is directly called instead of equipped on visual-only features like human dummies equipping outfits.
Used as the dye color source in the washing machine only (at the moment). Can be a hex color or a key corresponding to a registry entry, see washing_machine.dm
Grinder var:A reagent list containing the reagents this item produces when ground up in a grinder - this can be an empty list to allow for reagent transferring only
Set this variable to determine up to which temperature (IN KELVIN) the item protects against heat damage. Keep at null to disable protection. Only protects areas set by heat_protection flags
Set this variable to determine down to which temperature (IN KELVIN) the item protects against cold damage. 0 is NOT an acceptable number due to if(varname) tests!! Keep at null to disable protection. Only protects areas set by cold_protection flags
The list of slots by priority. equip_to_appropriate_slot() uses this list. Doesn't matter if a mob type doesn't have a slot. For default list, see /mob/proc/equip_to_appropriate_slot
Dimensions of the icon file used when this item is worn, eg: hats.dmi (32x32 sprite, 64x64 sprite, etc.). Allows inhands/worn sprites to be of any size, but still centered on a mob properly
Dimensions of the icon file used when this item is worn, eg: hats.dmi (32x32 sprite, 64x64 sprite, etc.). Allows inhands/worn sprites to be of any size, but still centered on a mob properly
Get an /obj/item/card/id from this object. bypass_wallet will grab the ID from a wallet even if it's closed
IsReflect
+
+
This proc determines if and at what an object will reflect energy projectiles if it's in l_hand,r_hand or wear_suit
add_item_action
+
+
Adds an item action to our list of item actions.
+Item actions are actions linked to our item, that are granted to mobs who equip us.
+This also ensures that the actions are properly tracked in the actions list and removed if they're deleted.
+Can be be passed a typepath of an action or an instance of an action.
add_item_context
+
+
Creates a "Type-A" contextual screentip interaction.
+When a user hovers over something with this item in hand, this proc will be called in order
+to provide context for contextual screentips.
+You must call register_item_context() in order for this to be registered.
+A screentip context list is a list that has context keys (SCREENTIP_CONTEXT_*, from __DEFINES/screentips.dm)
+that map to the action as text.
+If you mutate the list in this signal, you must return CONTEXTUAL_SCREENTIP_SET.
+source can, in all cases, be replaced with src, and only exists because this proc directly connects to a signal.
add_stealing_item_objective
+
+
Called if this item is supposed to be a steal objective item objective. Only done at mapload
proximity_flag - is 1 if this afterattack was called on something adjacent, in your square, or on your person.
+
click_parameters - is the params string from byond /atom/proc/Click code, see that documentation.
+
afterattack_secondary
+
+
Called at the end of the attack chain if the user right-clicked.
+
Arguments:
+
+
atom/target - The thing that was hit
+
mob/user - The mob doing the hitting
+
proximity_flag - is 1 if this afterattack was called on something adjacent, in your square, or on your person.
+
click_parameters - is the params string from byond /atom/proc/Click code, see that documentation.
+
attack
+
+
Called from [/mob/living/proc/attackby]
+
Arguments:
+
+
mob/living/M - The mob being hit by this item
+
mob/living/user - The mob hitting with this item
+
params - Click params of this attack
+
attack_obj
+
+
The equivalent of the standard version of /obj/item/proc/attack but for /obj targets.
attack_qdeleted
+
+
Called if the target gets deleted by our attack
attack_secondary
+
+
If we missed or the attack failed, interrupt attack chain.
+The equivalent of /obj/item/proc/attack but for alternate attacks, AKA right clicking
attack_self
+
+
Called when the item is in the active hand, and clicked; alternately, there is an 'activate held object' verb or you can hit pagedown.
attack_self_secondary
+
+
Called when the item is in the active hand, and right-clicked. Intended for alternate or opposite functions, such as lowering reagent transfer amount. At the moment, there is no verb or hotkey.
attack_turf
+
+
The equivalent of the standard version of /obj/item/proc/attack but for /turf targets.
attackby_storage_insert
+
+
Whether or not this item can be put into a storage item through attackby
attempt_surgery
+
+
Attempt to perform a surgery step.
block_feedback
+
+
Called by try_block_attack on a successful block
cyborg_unequip
+
+
Parent proc - triggers when an item/module is unequipped from a cyborg.
disableEmbedding
+
+
For when you want to disable an item's embedding capabilities (like transforming weapons and such), this proc will detach any active embed elements from it.
dropped
+
+
Called when a mob drops an item.
equipped
+
+
Called after an item is placed in an equipment slot.
+
Note that hands count as slots.
+
Arguments:
+
+
user is mob that equipped it
+
slot uses the slot_X defines found in setup.dm for items that can be placed in multiple slots
+
initial is used to indicate whether or not this is the initial equipment (job datums etc) or just a player doing it
+
failedEmbed
+
+
In case we want to do something special (like self delete) upon failing to embed in something.
get_attack_flag
+
+
Returns an armor flag to check against for dealing damage.
get_belt_overlay
+
+
Returns the icon used for overlaying the object on a belt
get_block_chance
+
+
Returns a number to feed into prob() to determine if the attack was blocked.
get_hitsound
+
+
Returns the sound the item makes when hitting something
Returns the sound the item makes when used as a weapon, but missing.
get_part_rating
+
+
Returns a numeric value for sorting items used as parts in machines, so they can be replaced by the rped
get_sechud_job_icon_state
+
+
Returns the SecHUD job icon state for whatever this object's ID card is, if it has one.
get_temperature
+
+
Returns the temperature of src. If you want to know if an item is hot use this proc.
get_worn_offsets
+
+
Returns offsets used for equipped item overlays in list(px_offset,py_offset) form.
give_item_action
+
+
Gives one of our item actions to a mob, when equipped to a certain slot
handle_openspace_click
+
+
Called on [/datum/element/openspace_item_click_handler/proc/on_afterattack]. Check the relative file for information.
help_light_cig
+
+
Finds a cigarette on another mob to help light.
hit_reaction
+
+
Called when the wearer is being hit by an attack while wearing/wielding this item.
+Returning TRUE will eat the attack, but this should be done by can_block_attack() instead.
isEmbedHarmless
+
+
Does the current embedding var meet the criteria for being harmless? Namely, does it have a pain multiplier and jostle pain mult of 0? If so, return true.
item_action_slot_check
+
+
Sometimes we only want to grant the item's action if it's equipped in a specific slot.
leave_evidence
+
+
Leave evidence of a user on a target
melee_attack_chain
+
+
This is the proc that handles the order of an item_attack.
+
The order of procs called is:
+
+
/atom/proc/tool_act on the target. If it returns TOOL_ACT_TOOLTYPE_SUCCESS or TOOL_ACT_SIGNAL_BLOCKING, the chain will be stopped.
the mob M is attempting to equip this item into the slot passed through as 'slot'. Return 1 if it can do this and 0 if it can't.
+if this is being done by a mob other than M, it will include the mob equipper, who is trying to equip the item to mob M. equipper will be null otherwise.
+If you are making custom procs but would like to retain partial or complete functionality of this one, include a 'return ..()' to where you want this to happen.
+Arguments:
+
+
disable_warning to TRUE if you wish it to not give you text outputs.
+
slot is the slot we are trying to equip to
+
equipper is the mob trying to equip the item
+
bypass_equip_delay_self for whether we want to bypass the equip delay
+
on_action_deleted
+
+
Called when an action associated with our item is deleted
on_found
+
+
called when "found" in pockets and storage items. Returns 1 if the search should end.
on_grind
+
+
Called BEFORE the object is ground up - use this to change grind results based on conditions. Use "return -1" to prevent the grinding from occurring
on_offer_taken
+
+
An interrupt for someone trying to accept an offered item, called mainly from /mob/living/carbon/proc/take, in case you want to run your own take behavior instead.
+
Return TRUE if you want to interrupt the taking.
+
Arguments:
+offerer - the person offering the item
+taker - the person trying to accept the offer
on_offered
+
+
An interrupt for offering an item to other people, called mainly from /mob/living/carbon/proc/give, in case you want to run your own offer behavior instead.
+
Return TRUE if you want to interrupt the offer.
+
Arguments:
+offerer - the person offering the item
on_outfit_equip
+
+
Special stuff you want to do when an outfit equips this item.
on_thrown
+
+
Called by the carbon throw_item() proc. Returns null if the item negates the throw, or a reference to the thing to suffer the throw else.
pick_painting_tool_color
+
+
Common proc used by painting tools like spraycans and palettes that can access the entire 24 bits color space.
pickup
+
+
called just as an item is picked up (loc is not yet changed)
Create a "Type-A" contextual screentip interaction, registering to add_item_context().
+This will run add_item_context() when the item hovers over another object for context.
+add_item_context() will not be called unless this is run.
+This is not necessary for Type-A interactions, as you can just apply the flag and register to the signal yourself.
remove_item_action
+
+
Removes an instance of an action from our list of item actions.
suicide_act
+
+
*Makes cool stuff happen when you suicide with an item
+
*Outputs a creative message and then return the damagetype done
+
+
Arguments:
+
+
+
user: The mob that is suiciding
+
+
+
surgery_sanity_check
+
+
Can a mob perform surgery with this item. Step is optional.
tool_check_callback
+
+
Used in a callback that is passed by use_tool into do_after call. Do not override, do not call manually.
tryEmbed() is for when you want to try embedding something without dealing with the damage + hit messages of calling hitby() on the item while targetting the target.
+
Really, this is used mostly with projectiles with shrapnel payloads, from /datum/element/embed/proc/checkEmbedProjectile, and called on said shrapnel. Mostly acts as an intermediate between different embed elements.
+
Returns TRUE if it embedded successfully, nothing otherwise
+
Arguments:
+
+
target- Either a body part or a carbon. What are we hitting?
+
forced- Do we want this to go through 100%?
+
try_block_attack
+
+
A helper for calling can_block_attack() and hit_reaction() together.
ui_action_click
+
+
This proc is executed when someone clicks the on-screen UI button.
+The default action is attack_self().
+Checks before we get to here are: mob is alive, mob is not restrained, stunned, asleep, resting, laying, item is on the mob.
updateEmbedding
+
+
For when you want to add/update the embedding on an item. Uses the vars in /obj/item/var/embedding, and defaults to config values for values that aren't set. Will automatically detach previous embed elements on this item.
update_action_buttons
+
+
How many mats have we found? You can only be affected by two material datums by default
+How much of each material is in it? Used to determine if the glass should break
+The glass shard that is spawned into the source item
+victim's chest (for cavity implanting the item)
+Updates all action buttons associated with this item
+
Arguments:
+
+
flags - Update flags passed to build_all_button_icons()
+
force - Force buttons update even if the given button icon state has not changed
+
update_greyscale
+
+
Checks if this atom uses the GAGS system and if so updates the worn and inhand icons
use
+
+
Generic use proc. Depending on the item, it uses up fuel, charges, sheets, etc. Returns TRUE on success, FALSE on failure.
use_tool
+
+
Called when a mob tries to use the item as a tool. Handles most checks.
visual_equipped
+
+
To be overwritten to only perform visual tasks;
+this is directly called instead of equipped on visual-only features like human dummies equipping outfits.
+
This separation exists to prevent things like the monkey sentience helmet from
+polling ghosts while it's just being equipped as a visual preview for a dummy.
wear_fallback_version
+
+
Override with a fallback sprite for this item.
+
Arguments:
+
+
file2use - The normal icon for this item.
+
state2use - The normal icon_state for this item.
+
layer - The layer that the final sprite should be rendered on.
Associate list of all paint jobs the airlock painter can apply. The key is the name of the airlock the user will see. The value is the type path of the airlock
Associate list of all paint jobs the airlock painter can apply. The key is the name of the airlock the user will see. The value is the type path of the airlock
list containing the actual ammo within the magazine
Proc Details
ammo_count
+
+
Count of number of bullets in the magazine
attempt_load_round
+
+
Attempts to load a given item into this ammo box
can_load
+
+
Whether or not the box can be loaded, used in overrides
get_ammo_desc
+
+
Returns a string that describes the amount of ammo in the magazine.
get_round
+
+
gets a round from the magazine, if keep is TRUE the round will stay in the gun
give_round
+
+
puts a round into the magazine
top_off
+
+
top_off is used to refill the magazine to max, in case you want to increase the size of a magazine with VV then refill it at once
+
Arguments:
+
+
load_type - if you want to specify a specific ammo casing type to load, enter the path here, otherwise it'll use the basic /obj/item/ammo_box/var/ammo_type. Must be a compatible round
+
starting - Relevant for revolver cylinders, if FALSE then we mind the nulls that represent the empty cylinders (since those nulls don't exist yet if we haven't initialized when this is TRUE)
+
update_ammo_count
+
+
Updates the materials and appearance of this ammo box
update_custom_materials
+
+
Updates the amount of material in this ammo box according to how many bullets are left in it.
Set to true if the device has different icons for each position.
+This will prevent things such as visible lasers from facing the incorrect direction when transformed by assembly_holder's update_appearance()
Set to true if the device has different icons for each position.
+This will prevent things such as visible lasers from facing the incorrect direction when transformed by assembly_holder's update_appearance()
Proc Details
activate
+
+
What the device does when turned on
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
The z level to which the elevator should travel
+The amount of z levels between the our and targetZ
+Direction (up/down) needed to go to reach targetZ
+How long it will/should take us to reach the target Z level
+check if any of the lift platforms are already here
Proc Details
check_z
+
+
The z level to which the elevator should travel
+The amount of z levels between the our and targetZ
+Direction (up/down) needed to go to reach targetZ
+How long it will/should take us to reach the target Z level
+check if any of the lift platforms are already here
+
+
+
diff --git a/obj/item/assembly/control/tram.html b/obj/item/assembly/control/tram.html
new file mode 100644
index 000000000000..322413cea76a
--- /dev/null
+++ b/obj/item/assembly/control/tram.html
@@ -0,0 +1,50 @@
+
+
+
+
+
+
+ /obj/item/assembly/control/tram - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
list of lists that are arguments for readding decals when the linked trapdoor comes back. pain.
+
we are storing this data FOR the trapdoor component we are linked to. kinda like a multitool.
+format: list(list(element's description, element's cleanable, element's directional, element's pic))
+the list will be filled with all the data of the deleting elements (when ChangeTurf is called) only when the trapdoor begins to open.
+so any other case the elements will be changed but not recorded.
Proc Details
carry_over_trapdoor
+
+ carry_over_trapdoor
+
applies the trapdoor to the new turf (created by the last trapdoor)
+apparently callbacks with arguments on invoke and the callback itself have the callback args go first. interesting!
used to store the list of assemblies making up our assembly holder
Proc Details
add_assembly
+
+
Adds an assembly to the assembly holder
+
This proc is used to add an assembly to the assembly holder, update the appearance, and the name of it.
+Arguments:
+
+
attached_assembly - assembly we are adding to the assembly holder
+
user - user we pass into attach()
+
process_activation
+
+
this proc is used to process the activation of the assembly holder
+
This proc is usually called by signalers, timers, or anything that can trigger and
+send a pulse to the assembly holder, which then calls this proc that actually activates the assemblies
+Arguments:
+
+
/obj/device - the device we sent the pulse from which called this proc
+
normal - if this is a normal activation
+
special - if this is a special activation
+
+
+
+
diff --git a/obj/item/banner.html b/obj/item/banner.html
new file mode 100644
index 000000000000..319d1dd3b846
--- /dev/null
+++ b/obj/item/banner.html
@@ -0,0 +1,43 @@
+
+
+
+
+
+
+ /obj/item/banner - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Traits that are given to the holder of the part. If you want an effect that changes this, don't add directly to this. Use the add_bodypart_trait() proc
Modifies our generic bleedstacks. You must use this to change the variable
+Takes the amount to adjust by, and the lowest amount we're allowed to have post adjust
This is the MEAT of limb icon code
+Called from update_body_parts() these procs handle the limb icon cache.
+the limb icon cache adds an icon_render_key to a human mob, it represents:
This proc serves as a way to ensure that legs layer properly on a mob.
+To do this, two separate images are created - A low layer one, and a normal layer one.
+Each of the image will appropriately crop out dirs that are not used on that given layer.
Traits that are given to the holder of the part. If you want an effect that changes this, don't add directly to this. Use the add_bodypart_trait() proc
INTERNAL PROC, DO NOT USE
+Properly sets us up to manage an inserted embeded object
_unembed_object
+
+
INTERNAL PROC, DO NOT USE
+Cleans up any attachment we have to the embedded object, removes it from our list
add_bodypart_trait
+
+
Adds a trait to be applied by this bodypart.
add_cavity_item
+
+
Add an item to our cavity. Call AFTER physically moving it via a proc like forceMove().
add_organ
+
+
Adds the organ to a bodypart.
adjustBleedStacks
+
+
Modifies our generic bleedstacks. You must use this to change the variable
+Takes the amount to adjust by, and the lowest amount we're allowed to have post adjust
adjustPain
+
+
Adjusts the pain of a limb, returning the difference. Do not call directly, use carbon.apply_pain().
apply_bone_break
+
+
Applies the effect of a broken bone to the owner.
apply_bone_heal
+
+
Removes the effects of a broken bone from the owner.
apply_traits
+
+
Applies all bodypart traits to the target.
attach_limb
+
+
Replace organs gracefully
+Transfer cavity items like implants.
+Attach src to target mob if able.
change_appearance
+
+
A multi-purpose setter for all things immediately important to the icon and iconstate of the limb.
damage_internal_organs
+
+
Damages internal organs. Does not call updatehealth(), be mindful.
dismember
+
+
Remove target limb from it's owner, with side effects.
drop_limb
+
+
limb removal. The "special" argument is used for swapping a limb with a new one without the effects of losing a limb kicking in.
generate_husk_key
+
+
Generates a cache key specifically for husks
generate_icon_key
+
+
This is the MEAT of limb icon code
+Called from update_body_parts() these procs handle the limb icon cache.
+the limb icon cache adds an icon_render_key to a human mob, it represents:
+
+
Gender, if applicable
+
The ID of the limb
+
Draw color, if applicable
+These procs only store limbs as to increase the number of matching icon_render_keys
+This cache exists because drawing 6/7 icons for humans constantly is quite a waste
+See RemieRichards on irc.rizon.net #coderbus (RIP remie :sob:)
+
generate_masked_leg
+
+
This proc serves as a way to ensure that legs layer properly on a mob.
+To do this, two separate images are created - A low layer one, and a normal layer one.
+Each of the image will appropriately crop out dirs that are not used on that given layer.
+
Arguments:
+
+
limb_overlay - The limb image being masked, not necessarily the original limb image as it could be an overlay on top of it
+
image_dir - Direction of the masked images.
+
+
Returns the list of masked images, or null if the limb_overlay didn't exist
getPain
+
+
Returns the amount of pain this bodypart is contributing
get_limb_overlays
+
+
Generates a list of mutable appearances for the limb to be used as overlays
get_modified_bleed_rate
+
+
Returns our bleed rate, taking into account laying down and grabbing the limb
handle_antibiotics
+
+
Handle antibiotics and curing infections
handle_germ_effects
+
+
Handle the effects of infections
handle_germ_sync
+
+
Syncing germ levels with external wounds
on_owner_nolimbdisable_trait_gain
+
+
Called when TRAIT_NOLIMBDISABLE is added to the owner.
on_owner_nolimbdisable_trait_loss
+
+
Called when TRAIT_NOLIMBDISABLE is removed from the owner.
on_paralysis_trait_gain
+
+
Called when TRAIT_PARALYSIS is added to the limb.
on_paralysis_trait_loss
+
+
Called when TRAIT_PARALYSIS is removed from the limb.
recolor_cosmetic_organs
+
+
Loops through all of the bodypart's external organs and update's their color.
refresh_bleed_rate
+
+
Refresh the cache of our rate of bleeding sans any modifiers
+ANYTHING ADDED TO THIS PROC NEEDS TO CALL IT WHEN IT'S EFFECT CHANGES
remove_bodypart_trait
+
+
Removes a trait applied by this bodypart.
remove_organ
+
+
Removes the organ from the limb.
remove_traits_from
+
+
Remove all bodypart traits this part grants.
replace_limb
+
+
Try to attach this bodypart to a mob, while replacing one if it exists, does nothing if it fails.
reset_appearance
+
+
Resets the base appearance of a limb to it's default values.
Checks if the user can finish constructing a bot with a given item.
Proc Details
can_finish_build
+
+
Checks if the user can finish constructing a bot with a given item.
+
Arguments:
+
+
I - Item to be used
+
user - Mob doing the construction
+
drop_item - Whether or no the item should be dropped; defaults to 1. Should be set to 0 if the item is a tool, stack, or otherwise doesn't need to be dropped. If not set to 0, item must be deleted afterwards.
How big the grid cells that compose the painting are in the UI.
+This impacts the size of the UI, so smaller values are generally better for bigger canvases and viceversa
How big the grid cells that compose the painting are in the UI.
+This impacts the size of the UI, so smaller values are generally better for bigger canvases and viceversa
If no cached_flat_icon exists, this proc creates it and crops it. This proc then returns the cached_flat_icon. Intended only for use displaying ID card icons in chat.
List of wildcard slot names as keys with lists of wildcard data as values.
Proc Details
add_access
+
+
Attempts to add the given accesses to the ID card as non-wildcards.
+
Depending on the mode, may add accesses as wildcards or error if it can't add them as non-wildcards.
+Arguments:
+
+
add_accesses - List of accesses to check.
+
try_wildcard - If not null, will attempt to add all accesses that require wildcard slots to this wildcard slot only.
+
mode - The method to use when adding accesses. See define for ERROR_ON_FAIL
+
add_wildcards
+
+
Attempts to add the given wildcards to the ID card.
+
Arguments:
+
+
wildcard_list - List of accesses to add.
+
try_wildcard - If not null, will attempt to add all wildcards to this wildcard slot only.
+
mode - The method to use when adding wildcards. See define for ERROR_ON_FAIL
+
build_access_lists
+
+
Helper proc. Creates access lists for the access procs.
+
Takes the accesses list and compares it with the trim. Any basic accesses that match the trim are
+added to basic_access_list and the rest are added to wildcard_access_list.
+
This proc directly modifies the lists passed in as args. It expects these lists to be instantiated.
+There is no return value.
+Arguments:
+
+
accesses - List of accesses you want to stort into basic_access_list and wildcard_access_list. Should not be null.
+
basic_access_list - Mandatory argument. The proc modifies the list passed in this argument and adds accesses the trim supports to it.
+
wildcard_access_list - Mandatory argument. The proc modifies the list passed in this argument and adds accesses the trim does not support to it.
+
can_add_wildcards
+
+
Helper proc, checks whether the ID card can hold any given set of wildcards.
+
Returns TRUE if the card can hold the wildcards, FALSE otherwise.
+Arguments:
+
+
wildcard_list - List of accesses to check.
+
try_wildcard - If not null, will attempt to add wildcards for this wildcard specifically and will return FALSE if the card cannot hold all wildcards in this slot.
+
can_use_id
+
+
Helper proc. Can the user interact with the ID?
clear_access
+
+
Clears all accesses from the ID card - both wildcard and normal.
clear_account
+
+
Clears the economy account from the ID card.
get_cached_flat_icon
+
+
If no cached_flat_icon exists, this proc creates it and crops it. This proc then returns the cached_flat_icon. Intended only for use displaying ID card icons in chat.
get_trim_assignment
+
+
Returns the trim assignment name.
get_trim_sechud_icon_state
+
+
Returns the trim sechud icon state.
remove_access
+
+
Removes the given accesses from the ID Card.
+
Will remove the wildcards if the accesses given are on the card as wildcard accesses.
+Arguments:
+
+
rem_accesses - List of accesses to remove.
+
remove_wildcards
+
+
Removes wildcards from the ID card.
+
Arguments:
+
+
wildcard_list - List of accesses to remove.
+
set_access
+
+
Attempts to set the card's accesses to the given accesses, clearing all accesses not in the given list.
+
Depending on the mode, may add accesses as wildcards or error if it can't add them as non-wildcards.
+Arguments:
+
+
new_access_list - List of all accesses that this card should hold exclusively.
+
mode - The method to use when setting accesses. See define for ERROR_ON_FAIL
+
set_icon
+
+
Sets the UI icon of the ID to their datacore entry, or their current appearance if no record is found.
set_new_account
+
+
Attempts to set a new bank account on the ID card.
update_label
+
+
Updates the name based on the card's vars and state.
If this is set, will manually override the trim's assignmment as it appears in the crew monitor and elsewhere. Intended for admins to VV edit and chameleon ID cards.
If this is set, will manually override the trim's assignmment as it appears in the crew monitor and elsewhere. Intended for admins to VV edit and chameleon ID cards.
A component that performs a function when given an input
+
Can be attached to an integrated circuitboard, where it can then
+be connected between other components to provide an output or to receive
+an input. This is the base type of all components
Called from trigger_component. General component behaviour should go in this proc. This is the default proc that is called if no trigger proc is specified.
Saves data to a list. Shouldn't be used unless you are quite literally saving the data of a component to a list. Input value is the list to save the data to
Called whether this circuit component should receive an input.
+If this returns false, the proc that is supposed to be triggered will not be called and an output signal will not be sent.
+This is to only return false if flow of execution should be stopped because something bad has happened (e.g. no power)
+Returning no value in input_received() is not an issue because it means flow of execution will continue even if the component failed to execute properly.
The colour this circuit component appears in the UI
Proc Details
add_input_port
+
+
Adds an input port and returns it
+
Arguments:
+
+
name - The name of the input port
+
type - The datatype it handles
+
trigger - Whether this input port triggers an update on the component when updated.
+
add_option_port
+
+
Extension of add_input_port. Simplifies the code to make an option port to reduce boilerplate
add_output_port
+
+
Adds an output port and returns it
+
Arguments:
+
+
name - The name of the output port
+
type - The datatype it handles.
+
add_to
+
+
Called when this component is about to be added to an integrated_circuit.
create_table_notices
+
+
Creates a table UI notice entry to be used in get_ui_notices()
+
Returns a list that can then be added to the return list in get_ui_notices()
+Used by components to list their available columns. Recommended to use at the end of get_ui_notices()
create_ui_notice
+
+
Creates a UI notice entry to be used in get_ui_notices()
+
Returns a list that can then be added to the return list in get_ui_notices()
disconnect
+
+
Disconnects a component from other components
+
Disconnects both the input and output ports of the component
get_location
+
+
Called when trying to get the physical location of this object
get_ui_notices
+
+
Gets the UI notices to be displayed on the CircuitInfo panel.
+
Returns a list of buttons in the following format
+list(
+"icon" = ICON(string)
+"content" = CONTENT(string)
+"color" = COLOR(string, not a hex)
+)
input_received
+
+
Called from trigger_component. General component behaviour should go in this proc. This is the default proc that is called if no trigger proc is specified.
+
Return value indicates that the circuit should not send an output signal.
+Arguments:
+
+
port - Can be null. The port that sent the input
+
return_values - Only defined if the component is receiving an input due to instant execution. Contains the values to be returned once execution has stopped.
+
load_data_from_list
+
+
Loads data from a list
populate_options
+
+
Called when the option ports should be set up
populate_ports
+
+
Called when the rest of the ports should be set up
pre_input_received
+
+
Called before input_received and should_receive_input. Used to perform behaviour that shouldn't care whether the input should be received or not.
register_shell
+
+
Called when a shell is registered from the component/the component is added to a circuit.
+
Register all signals here on the shell.
+Arguments:
+
+
shell - Shell being registered
+
register_usb_parent
+
+
Called when a circuit component is added to an object with a USB port.
+
Arguments:
+
+
shell - The object that USB cables can connect to
+
remove_input_port
+
+
Removes an input port and deletes it. This will not cleanup any references made by derivatives of the circuit component
+
Arguments:
+
+
input_port - The input port to remove.
+
remove_output_port
+
+
Removes an output port and deletes it. This will not cleanup any references made by derivatives of the circuit component
+
Arguments:
+
+
output_port - The output port to remove.
+
removed_from
+
+
Called when this component is removed from an integrated_circuit.
save_data_to_list
+
+
Saves data to a list. Shouldn't be used unless you are quite literally saving the data of a component to a list. Input value is the list to save the data to
should_receive_input
+
+
Called whether this circuit component should receive an input.
+If this returns false, the proc that is supposed to be triggered will not be called and an output signal will not be sent.
+This is to only return false if flow of execution should be stopped because something bad has happened (e.g. no power)
+Returning no value in input_received() is not an issue because it means flow of execution will continue even if the component failed to execute properly.
+
Return value indicates whether or not
+Arguments:
+
+
port - Can be null. The port that sent the input
+
trigger_component
+
+
Called whenever an input is received from one of the ports.
+
Return value indicates whether the trigger was successful or not.
+Arguments:
+
+
port - Can be null. The port that sent the input
+
return_values - Only defined if the component is receiving an input due to instant execution. Contains the values to be returned once execution has stopped.
+
ui_perform_action
+
+
Called when a special button is pressed on this component in the UI.
+
Arguments:
+
+
user - Interacting mob
+
action - A string for which action is being performed. No parameters passed because it's only a button press.
+
unregister_shell
+
+
Called when a shell is unregistered from the component/the component is removed from a circuit.
+
Unregister all signals here on the shell.
+Arguments:
+
+
shell - Shell being unregistered
+
unregister_usb_parent
+
+
Called when a circuit component is removed from an object with a USB port.
+
Arguments:
+
+
shell - The object that USB cables can connect to
+
+
+
+
diff --git a/obj/item/circuit_component/airlock.html b/obj/item/circuit_component/airlock.html
new file mode 100644
index 000000000000..fed1c84b676b
--- /dev/null
+++ b/obj/item/circuit_component/airlock.html
@@ -0,0 +1,106 @@
+
+
+
+
+
+
+ /obj/item/circuit_component/airlock - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
only has cyborg flashing since felinid moving spikes time dilation when spammed and the other two features of laserpointers would be unbalanced when spammed
+no stunning, just a blind
+laserpointer image
+Light Component
+
Emits a light of a specific brightness and colour. Requires a shell.
This is used for the paper displayed on the clipboard's icon
+and it is the one attacked, when attacking the clipboard.
+(As you can't organise contents directly in BYOND)
Proc Details
on_top_paper_change
+
+
This is a simple proc to handle calling update_icon() upon receiving the top paper's COMSIG_ATOM_UPDATE_APPEARANCE.
Needs to follow this syntax: either a list() with the x and y coordinates of the pixel you want to get the colour from, or a hexcolour. Colour one replaces red, two replaces blue, and three replaces green in the icon state.
How much integrity is in a specific limb before that limb is disabled (for use in /obj/item/clothing/proc/take_damage_zone, and only if we cover multiple zones.) Set to 0 to disable shredding.
take_damage_zone() is used for dealing damage to specific bodyparts on a worn piece of clothing, meant to be called from [/obj/item/bodypart/proc/check_woundings_mods]
Needs to follow this syntax: either a list() with the x and y coordinates of the pixel you want to get the colour from, or a hexcolour. Colour one replaces red, two replaces blue, and three replaces green in the icon state.
How much integrity is in a specific limb before that limb is disabled (for use in /obj/item/clothing/proc/take_damage_zone, and only if we cover multiple zones.) Set to 0 to disable shredding.
This proc disables all protection on the specified bodypart for this piece of clothing: it'll be as if it doesn't cover it at all anymore (because it won't!)
+If every possible bodypart has been disabled on the clothing, we put it out of commission entirely and mark it as shredded, whereby it will have to be repaired in
+order to equip it again. Also note we only consider it damaged if there's more than one bodypart disabled.
+
Arguments:
+
+
def_zone: The bodypart zone we're disabling
+
damage_type: Only really relevant for the verb for describing the breaking, and maybe atom_destruction()
+
generate_fallback_clothing
+
+
Generates a 'fallback' sprite from fallback_colors and fallback_icon_state, then adds it to GLOB.fallback_clothing_icons.
+
The fallback sprite is created by getting each colour specified in [fallback_colors],
+then mapping each of them to the red, green, and blue sections of the sprite specified by [fallback_icon_state].
list_key - The key that this icon will be saved under in the global list. (Either ["path/to/file.dmi-jumpsuit"], or ["#ffe14d-jumpsuit"] if GAGS is used)
+
repair
+
+
Set the clothing's integrity back to 100%, remove all damage to bodyparts, and generally fix it up
take_damage_zone
+
+
take_damage_zone() is used for dealing damage to specific bodyparts on a worn piece of clothing, meant to be called from [/obj/item/bodypart/proc/check_woundings_mods]
+
This proc only matters when a bodypart that this clothing is covering is harmed by a direct attack (being on fire or in space need not apply), and only if this clothing covers
+more than one bodypart to begin with. No point in tracking damage by zone for a hat, and I'm not cruel enough to let you fully break them in a few shots.
+Also if limb_integrity is 0, then this clothing doesn't have bodypart damage enabled so skip it.
+
Arguments:
+
+
def_zone: The bodypart zone in question
+
damage_amount: Incoming damage
+
damage_type: BRUTE or BURN
+
armor_penetration: If the attack had armor_penetration
+
wear_fallback_version
+
+
Returns a mutable_appearance of this clothing's fallback sprite.
+
If a sprite for this item hasn't already been generated, a new one is made in [generate_fallback_clothing], and added to GLOB.fallback_clothing_icons.
+
Arguments:
+
+
file2use - The normal icon for this item.
+
state2use - The normal icon_state for this item.
+
layer - The layer that the final sprite should be rendered on.
Used for handling bloody gloves leaving behind bloodstains on objects. Will be decremented whenever a bloodstain is left behind, and be incremented when the gloves become bloody.
Used for handling bloody gloves leaving behind bloodstains on objects. Will be decremented whenever a bloodstain is left behind, and be incremented when the gloves become bloody.
Space ninja's gloves. Gives access to a number of special interactions.
+
Gloves only found from space ninjas. Allows the wearer to access special interactions with various objects.
+These interactions are detailed in ninjaDrainAct.dm in the suit file.
+These interactions are toggled by an action tied to the gloves. The interactions will not activate if the user is also not wearing a ninja suit.
if the thrown object's target zone isn't the head
+ignore any hats with the tinfoil counter-measure enabled
+if the hat happens to be capable of holding contents and has something in it. mostly to prevent super cheesy stuff like stuffing a mini-bomb in a hat and throwing it
+check if the item has NODROP
+check if the item is an actual clothing head item, since some non-clothing items can be worn
+SNUG_FIT hats are immune to being knocked off
+if the hat manages to knock something off
Proc Details
throw_impact
+
+
Special throw_impact for hats to frisbee hats at people to place them on their heads/attempt to de-hat them.
worn_overlays
+
+
if the thrown object's target zone isn't the head
+ignore any hats with the tinfoil counter-measure enabled
+if the hat happens to be capable of holding contents and has something in it. mostly to prevent super cheesy stuff like stuffing a mini-bomb in a hat and throwing it
+check if the item has NODROP
+check if the item is an actual clothing head item, since some non-clothing items can be worn
+SNUG_FIT hats are immune to being knocked off
+if the hat manages to knock something off
+
+
+
diff --git a/obj/item/clothing/head/beanie/black/dboy.html b/obj/item/clothing/head/beanie/black/dboy.html
new file mode 100644
index 000000000000..8a8f32468df8
--- /dev/null
+++ b/obj/item/clothing/head/beanie/black/dboy.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /obj/item/clothing/head/beanie/black/dboy - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Proc called in lungs.dm to act if wearing a mask with filters, used to reduce the filters durability, return a changed gas mixture depending on the filter status
+Arguments:
Proc called in lungs.dm to act if wearing a mask with filters, used to reduce the filters durability, return a changed gas mixture depending on the filter status
+Arguments:
Should we smoke all of the chems in the cig before it runs out. Splits each puff to take a portion of the overall chems so by the end you'll always have consumed all of the chems inside.
Should we smoke all of the chems in the cig before it runs out. Splits each puff to take a portion of the overall chems so by the end you'll always have consumed all of the chems inside.
check_trip runs on each step to see if we fall over as a result of our lace status. Knotted laces are a guaranteed trip, while untied shoes are just a chance to stumble
our_guy here is the wearer, if one exists (and he must exist, or we don't care)
+checking to make sure we're still on the person we're supposed to be, for lacing do_after's
Are we currently tied? Can either be SHOES_UNTIED, SHOES_TIED, or SHOES_KNOTTED
Proc Details
adjust_laces
+
+
adjust_laces adjusts whether our shoes (assuming they can_be_tied) and tied, untied, or knotted
+
In addition to setting the state, it will deal with getting rid of alerts if they exist, as well as registering and unregistering the stepping signals
+
Arguments:
+
+
state: SHOES_UNTIED, SHOES_TIED, or SHOES_KNOTTED, depending on what you want them to become
+
user: used to check to see if we're the ones unknotting our own laces
+
check_trip
+
+
check_trip runs on each step to see if we fall over as a result of our lace status. Knotted laces are a guaranteed trip, while untied shoes are just a chance to stumble
handle_tying
+
+
handle_tying deals with all the actual tying/untying/knotting, inferring your intent from who you are in relation to the state of the laces
+
If you're the wearer, you want them to move towards tied-ness (knotted -> untied -> tied). If you're not, you're pranking them, so you're moving towards knotted-ness (tied -> untied -> knotted)
+
Arguments:
+
+
user: who is the person interacting with the shoes?
+
still_shoed
+
+
our_guy here is the wearer, if one exists (and he must exist, or we don't care)
+checking to make sure we're still on the person we're supposed to be, for lacing do_after's
+
+
+
diff --git a/obj/item/clothing/shoes/clown_shoes/banana_shoes.html b/obj/item/clothing/shoes/clown_shoes/banana_shoes.html
new file mode 100644
index 000000000000..d5b382b0372b
--- /dev/null
+++ b/obj/item/clothing/shoes/clown_shoes/banana_shoes.html
@@ -0,0 +1,57 @@
+
+
+
+
+
+
+ /obj/item/clothing/shoes/clown_shoes/banana_shoes - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Wrapper proc to apply shielding through AddComponent().
+Called in /obj/item/clothing/Initialize().
+Override with an AddComponent(/datum/component/shielded, args) call containing the desired shield statistics.
+See /datum/component/shielded documentation for a description of the arguments
Proc Details
setup_shielding
+
+
Wrapper proc to apply shielding through AddComponent().
+Called in /obj/item/clothing/Initialize().
+Override with an AddComponent(/datum/component/shielded, args) call containing the desired shield statistics.
+See /datum/component/shielded documentation for a description of the arguments
+
+
+
diff --git a/obj/item/clothing/suit/armor/abductor/vest.html b/obj/item/clothing/suit/armor/abductor/vest.html
new file mode 100644
index 000000000000..411b56543584
--- /dev/null
+++ b/obj/item/clothing/suit/armor/abductor/vest.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /obj/item/clothing/suit/armor/abductor/vest - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
A proc for doing cooldown effects (like the sparks on the tesla armor, or the semi-stealth on stealth armor)
+Called from the suit activating whilst on cooldown.
+You should be calling ..()
A proc for doing owner unfriendly reactive armor effects.
+Called from the suit activating while off cooldown, while the armor is still suffering from the effect of an EMP.
+Returning TRUE will block the attack that triggered this
A proc for doing reactive armor effects.
+Called from the suit activating while off cooldown, with no emp.
+Returning TRUE will block the attack that triggered this
Duration of the cooldown specific to reactive armor for when it can activate again.
Proc Details
cooldown_activation
+
+
A proc for doing cooldown effects (like the sparks on the tesla armor, or the semi-stealth on stealth armor)
+Called from the suit activating whilst on cooldown.
+You should be calling ..()
emp_activation
+
+
A proc for doing owner unfriendly reactive armor effects.
+Called from the suit activating while off cooldown, while the armor is still suffering from the effect of an EMP.
+Returning TRUE will block the attack that triggered this
reactive_activation
+
+
A proc for doing reactive armor effects.
+Called from the suit activating while off cooldown, with no emp.
+Returning TRUE will block the attack that triggered this
+
+
+
diff --git a/obj/item/clothing/suit/armor/reactive/stealth.html b/obj/item/clothing/suit/armor/reactive/stealth.html
new file mode 100644
index 000000000000..55bd1538df7e
--- /dev/null
+++ b/obj/item/clothing/suit/armor/reactive/stealth.html
@@ -0,0 +1,57 @@
+
+
+
+
+
+
+ /obj/item/clothing/suit/armor/reactive/stealth - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Space ninja's suit. Provides him with most of his powers.
+
Space ninja's suit. Gives space ninja all his iconic powers, which are mostly kept in
+the folder ninja_equipment_actions. Has a lot of unique stuff going on, so make sure to check
+the variables. Check suit_attackby to see radium interaction, disk copying, and cell replacement.
Called to cancel the stealth effect if it is ongoing.
+Does nothing otherwise.
+Arguments:
+
+
Returns false if either the ninja no longer exists or is already visible, returns true if we successfully made the ninja visible.
+
deinitialize
+
+
Deinitializes the ninja suit
+
Deinitializes the ninja suit through eight phases, each of which calls this proc with an incremented phase
+Arguments:
+
+
delay - The delay between each phase of deinitialization
+
ninja - The human who is being affected by the suit
+
phase - The phase of deinitialization
+
lockIcons
+
+
Proc for changing the suit's appearance upon locking.
+
Proc for when space ninja's suit locks. If the user selects Original, gives it glowing lights, along with having an alternate sprite for female body types.
+Yes, we do have nipLEDs, how could you tell?
+If the user selects New Age, it applies new sprites to all the gear.
+Arguments:
+
+
ninja - The person wearing the suit.
+
lock_suit
+
+
Proc called to lock the important gear pieces onto space ninja's body.
+
Called during the suit startup to lock all gear pieces onto space ninja.
+Terminates if a gear piece is not being worn. Also gives the ninja the inability to use firearms.
+If the person in the suit isn't a ninja when this is called, this proc just gibs them instead.
+Arguments:
+
+
ninja - The person wearing the suit.
+
Returns false if the locking fails due to lack of all suit parts, and true if it succeeds.
+
ninitialize
+
+
Initializes the ninja suit
+
Initializes the ninja suit through seven phases, each of which calls this proc with an incremented phase
+Arguments:
+
+
delay - The delay between each phase of initialization
+
ninja - The human who is being affected by the suit
+
phase - The phase of initialization
+
ninja_sword_recall
+
+
Proc called to recall the ninja's sword.
+
Called to summon the ninja's katana back to them
+If the katana can see the ninja, it will throw itself towards them.
+If not, the katana will teleport itself to the ninja.
ninjaboost
+
+
Proc called to activate space ninja's adrenaline.
+
Proc called to use space ninja's adrenaline. Gets the ninja out of almost any stun.
+Also makes them shout MGS references when used. After a bit, it injects the user with
+radium by calling a different proc.
ninjaboost_after
+
+
Proc called to inject the ninja with radium.
+
Used after 7 seconds of using the ninja's adrenaline.
+Injects the user with how much radium the suit needs to refill an adrenaline boost.
ninjacost
+
+
Proc called to check if the ninja can afford an ability's cost.
+
Proc which determine whether or not a space ninja can afford to use a specific ability.
+It can also cancel stealth if the ability requested it.
+Arguments:
+
+
cost - the energy cost of the ability
+
specificCheck - Determines if the check is a normal one, an adrenaline one, or a stealth cancel check.
+
Returns TRUE or the current cooldown timer if we can't perform the ability, and FALSE if we can.
+
ninjanet
+
+
Proc called to ensnare a person in a energy net.
+
Used to ensnare a target in an energy net, preventing them from moving until the net is broken.
+Costs 40E, which is 40% of the default battery's max charge. Intended as a means of reliably locking down an opponent when ninja stars won't suffice.
ninjapulse
+
+
Proc called to allow the ninja to EMP the nearby area.
+
Proc called to allow the ninja to EMP the nearby area. By default, costs 500E, which is half of the default battery's max charge.
+Also affects the ninja as well.
ninjastar
+
+
Proc called to create a ninja star in the ninja's hands.
+
Called to create a ninja star in the wearer's hand. The ninja
+star doesn't do much up-front damage, but deals stamina damage
+as the target moves around, forcing a finish or flee scenario.
ninjastatus
+
+
Proc called to put a status readout to the ninja in chat.
+
Called put some information about the ninja's current status into chat.
+This information used to be displayed constantly on the status tab screen
+when the suit was on, but was turned into this as to remove the code from
+human.dm
terminate
+
+
Proc used to delete all the attachments and itself.
+
Can be called to entire rid of the suit pieces and the suit itself.
toggle_on_off
+
+
Toggles the ninja suit on/off
+
Attempts to initialize or deinitialize the ninja suit
toggle_stealth
+
+
Proc called to toggle ninja stealth.
+
Proc called to toggle whether or not the ninja is in stealth mode.
+If cancelling, calls a separate proc in case something else needs to quickly cancel stealth.
unlock_suit
+
+
Proc called to unlock all the gear off space ninja's body.
+
Proc which is essentially the opposite of lock_suit. Lets you take off all the suit parts.
+Also gets rid of the objection to using firearms from the wearer.
+Arguments:
+
+
ninja - The person wearing the suit.
+
+
+
+
diff --git a/obj/item/clothing/suit/toggle.html b/obj/item/clothing/suit/toggle.html
new file mode 100644
index 000000000000..a777dbc3c621
--- /dev/null
+++ b/obj/item/clothing/suit/toggle.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /obj/item/clothing/suit/toggle - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Called on multitool click, prints diagnostic information to the user.
enable_changed
+
+
Called when the device's enablement changes state.
on_install
+
+
Called when component is installed into PC.
on_remove
+
+
Called when component is removed from PC.
try_eject
+
+
Implement this when your hardware contains an object that the user can eject.
+
Examples include ejecting cells from battery modules, ejecting an ID card from a card reader
+or ejecting an Intellicard from an AI card slot.
+Arguments:
+
+
user - The mob requesting the eject.
+
forced - Whether this action should be forced in some way.
+
try_insert
+
+
Called when someone tries to insert something in it - paper in printer, card in card reader, etc.
Indestructible antag objective that can be photocopied.
+
Photocopying this is handled in photocopier.dm.
+Cannot be destroyed, but can be spaced.
+Save for the inhand, this does not actually have anything in common with /obj/item/paper.
+
+
+
diff --git a/obj/item/documents/photocopy.html b/obj/item/documents/photocopy.html
new file mode 100644
index 000000000000..d0a61d290113
--- /dev/null
+++ b/obj/item/documents/photocopy.html
@@ -0,0 +1,43 @@
+
+
+
+
+
+
+ /obj/item/documents/photocopy - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
The katana that only space ninja spawns with. Comes with 30 force and throwforce, along with a signature special jaunting system.
+Upon clicking on a tile when right clicking, the user will teleport to that tile, assuming their target was not dense.
+The katana has 3 dashes stored at maximum, and upon using the dash, it will return 20 seconds after it was used.
+It also has a special feature where if it is tossed at a space ninja who owns it (determined by the ninja suit), the ninja will catch the katana instead of being hit by it.
list of account IDs which have accepted the license prompt. If this is the multi-payment pin, then this means they accepted the waiver that each shot will cost them money
list of account IDs which have accepted the license prompt. If this is the multi-payment pin, then this means they accepted the waiver that each shot will cost them money
Will this food turn into badrecipe in an oven? Don't use this for everything; preferably mostly for food that is made in an oven to begin with so it burns after some time
Will this food turn into badrecipe on a grill? Don't use this for everything; preferably mostly for food that is made on a grill to begin with so it burns after some time
This proc makes things decompose. Set preserved_food to TRUE to make it never decompose.
+Set decomp_req_handle to TRUE to only make it decompose when someone picks it up.
This proc handles processable elements, overwrite this if you want to add behavior such as slicing, forking, spooning, whatever, to turn the item into something else
Will this food turn into badrecipe in an oven? Don't use this for everything; preferably mostly for food that is made in an oven to begin with so it burns after some time
Will this food turn into badrecipe on a grill? Don't use this for everything; preferably mostly for food that is made on a grill to begin with so it burns after some time
This proc handles bakeable components, overwrite if you want different bake results etc.
MakeDecompose
+
+
This proc makes things decompose. Set preserved_food to TRUE to make it never decompose.
+Set decomp_req_handle to TRUE to only make it decompose when someone picks it up.
MakeEdible
+
+
This proc adds the edible component, overwrite this if you for some reason want to change some specific args like callbacks.
MakeGrillable
+
+
This proc handles grillable components, overwrite if you want different grill results etc.
MakeLeaveTrash
+
+
This proc handles trash components, overwrite this if you want the object to spawn trash
MakeProcessable
+
+
This proc handles processable elements, overwrite this if you want to add behavior such as slicing, forking, spooning, whatever, to turn the item into something else
The typepath of the gang antagonist datum that the person who uses the package should have added to them -- remember that the distinction between e.g. Ballas and Grove Street is on the antag datum level, not the team datum level.
Checks if the user is trying to use the package of the family they are in, and if not, adds them to the family, with some differing processing depending on whether the user is already a family member.
The typepath of the gang antagonist datum that the person who uses the package should have added to them -- remember that the distinction between e.g. Ballas and Grove Street is on the antag datum level, not the team datum level.
The team datum that the person who uses this package should be added to.
Proc Details
add_to_gang
+
+
Adds the user to the family that this package corresponds to, dispenses the free_clothes of that family, and adds them to the handler if it exists.
attempt_join_gang
+
+
Checks if the user is trying to use the package of the family they are in, and if not, adds them to the family, with some differing processing depending on whether the user is already a family member.
called by the gas mask where the filter is installed, lower the filter_status depending on the breath gas composition and by the strength of the filter
+returns the modified breath gas mixture
called by the gas mask where the filter is installed, lower the filter_status depending on the breath gas composition and by the strength of the filter
+returns the modified breath gas mixture
+
Arguments:
+
+
breath - the current gas mixture of the breathed air
arm_grenade (formerly preprime) refers to when a grenade with a standard time fuze is activated, making it go beepbeepbeep and then detonate a few seconds later.
+Grenades with other triggers like remote igniters probably skip this step and go straight to /obj/item/grenade/proc/detonate
arm_grenade (formerly preprime) refers to when a grenade with a standard time fuze is activated, making it go beepbeepbeep and then detonate a few seconds later.
+Grenades with other triggers like remote igniters probably skip this step and go straight to /obj/item/grenade/proc/detonate
botch_check
+
+
Checks for various ways to botch priming a grenade.
+
Arguments:
+
+
mob/living/carbon/human/user - who is priming our grenade?
+
detonate
+
+
detonate (formerly prime) refers to when the grenade actually delivers its payload (whether or not a boom/bang/detonation is involved)
+
Arguments:
+
+
lanced_by- If this grenade was detonated by an elance, we need to pass that along with the COMSIG_GRENADE_DETONATE signal for pellet clouds
+
+
+
+
diff --git a/obj/item/grenade/c4.html b/obj/item/grenade/c4.html
new file mode 100644
index 000000000000..d75620ae8975
--- /dev/null
+++ b/obj/item/grenade/c4.html
@@ -0,0 +1,43 @@
+
+
+
+
+
+
+ /obj/item/grenade/c4 - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
A unique version of c4 possessed only by the space ninja. Has a stronger blast radius.
+Can only be detonated by space ninjas with the bombing objective. Can only be set up where the objective says it can.
+When it primes, the space ninja responsible will have their objective set to complete.
This is smoke bomb, mezum koman. It is a grenade subtype. All craftmanship is of the highest quality.
+It menaces with spikes of iron. On it is a depiction of an assistant.
+The assistant is bleeding. The assistant has a painful expression. The assistant is dead.
Handles adding the seclite mount component to the gun.
+If the gun shouldn't have a seclight mount, override this with a return.
+Or, if a child of a gun with a seclite mount has slightly different behavior or icons, extend this.
Handles adding the seclite mount component to the gun.
+If the gun shouldn't have a seclight mount, override this with a return.
+Or, if a child of a gun with a seclite mount has slightly different behavior or icons, extend this.
after_chambering
+
+
Called after a successful shot and update_chamber()
after_firing
+
+
Called after the weapon has successfully fired it's chambered round, and before update_chamber()
+
Arguments:
+
+
user - The mob firing the gun.
+
pointblank - Is this a pointblank shot?
+
pbtarget - If this is a pointblank shot, what is the target?
+
message - If TRUE, will give chat feedback.
+
before_firing
+
+
Called before the weapon is fired, before the projectile is created.
+
Arguments:
+
+
target - The thing being shot at.
+
user - The mob firing the gun.
+
can_fire
+
+
check if there's enough ammo/energy/whatever to shoot one time
+i.e if clicking would make it shoot
clear_suppressor
+
+
Clears var and updates icon. In the case of ballistic weapons, also updates the gun's weight.
do_chamber_update
+
+
Called after the weapon has successfully fired it's chambered round
+
Arguments:
+
+
empty_chamber - Whether or not the chamber is currently empty.
+
from_firing - If this was called as apart of the gun firing.
+
chamber_next_round - Whether or not the next round should be chambered.
+
do_fire_gun
+
+
The proc for firing the gun. This won't perform any non-gun checks. Returns TRUE if a round was fired.
+
Arguments:
+
+
user - The mob firing the gun.
+
pointblank - Is this a pointblank shot?
+
pbtarget - If this is a pointblank shot, what is the target?
+
message - If TRUE, will give chat feedback.
+
do_fire_in_burst
+
+
Called by do_fire_gun if the rounds per burst is greater than 1.
+
Arguments:
+
+
user - The mob firing the gun.
+
target - The thing being shot.
+
message - Provide chat feedback
+
params - ???
+
zone_override - ???
+
sprd - Bullet spread. This is immediately overwritten so I don't know why it's here.
+
randomized_gun_spread - Calculated by do_fire_gun()
+
randomized_bonus_spread - Calculated by do_fire_gun()
+
rand_spr - Seriously, what the fuck?
+
iteration - What step in the burst we are in.
+
dry_fire_feedback
+
+
Called by shoot_with_empty_chamber().
+
Arguments:
+
+
user - The mob firing the gun.
+
play_fire_sound
+
+
Play the bang bang sound
ready_to_fire
+
+
Called when the gun is ready to fire again
shoot_with_empty_chamber
+
+
Apply pointblank knockback to the target
+Called when there was an attempt to fire the gun, but the chamber was empty.
+
Arguments:
+
+
user - The mob firing the gun.
+
tk_firing
+
+
Check if the user is firing this gun with telekinesis.
try_fire_akimbo
+
+
Called by try_fire_gun() to attempt to fire offhand guns.
try_fire_gun
+
+
The defacto proc for "mob is trying to shoot the gun". Checks if they are able to, and a few other things.
+
Arguments:
+
+
target - The thing being shot at.
+
user - The mob firing the gun.
+
proximity - TRUE if user.Adjacent(target)
+
params - Click parameters.
+
update_chamber
+
+
Called after the weapon has successfully fired it's chambered round.
+
Arguments:
+
+
empty_chamber - Whether or not the chamber is currently empty.
+
from_firing - If this was called as apart of the gun firing.
+
chamber_next_round - Whether or not the next round should be chambered.
The bolt type controls how the gun functions, and what iconstates you'll need to represent those functions.
+/datum/gun_bolt - The Slide doesn't lock back. Clicking on it will only cycle the bolt. Only 1 sprite.
+/datum/gun_bolt/open - Same as standard, but it fires directly from the magazine - No need to rack. Doesn't hold the bullet when you drop the mag.
+/datum/gun_bolt/locking - This is most handguns and bolt action rifles. The bolt will lock back when it's empty. You need yourgun_bolt and yourgun_bolt_locked icon states.
+/datum/gun_bolt/no_bolt - This is shotguns and revolvers. clicking will dump out all the bullets in the gun, spent or not.
The bolt type controls how the gun functions, and what iconstates you'll need to represent those functions.
+/datum/gun_bolt - The Slide doesn't lock back. Clicking on it will only cycle the bolt. Only 1 sprite.
+/datum/gun_bolt/open - Same as standard, but it fires directly from the magazine - No need to rack. Doesn't hold the bullet when you drop the mag.
+/datum/gun_bolt/locking - This is most handguns and bolt action rifles. The bolt will lock back when it's empty. You need yourgun_bolt and yourgun_bolt_locked icon states.
+/datum/gun_bolt/no_bolt - This is shotguns and revolvers. clicking will dump out all the bullets in the gun, spent or not.
Proc that is only called when the beam fails due to something, so not when manually ended.
+manual disconnection = LoseTarget, so it can silently end
+automatic disconnection = beam_died, so we can give a warning message first
Proc Details
LoseTarget
+
+
Proc that always is called when we want to end the beam and makes sure things are cleaned up, see beam_died()
beam_died
+
+
Proc that is only called when the beam fails due to something, so not when manually ended.
+manual disconnection = LoseTarget, so it can silently end
+automatic disconnection = beam_died, so we can give a warning message first
Apply any needed updates to the assailant
+Do flavor things like pixel offsets, animation, sound
+Spread diseases
+Setup the effects applied by grab
+Update appearance
+Setup signals
Apply any needed updates to the assailant
+Do flavor things like pixel offsets, animation, sound
+Spread diseases
+Setup the effects applied by grab
+Update appearance
+Setup signals
intercept_attack_hand
+
+
Intercepts attack_hand() calls on our target.
is_grab_unique
+
+
Used to prevent repeated effect application or early effect removal
is_grabbing
+
+
Primarily used for do_after() callbacks, checks if the grab item is still holding onto something
leave_forensic_traces
+
+
Leave forensic traces on both the assailant and victim. You really don't want to read this proc and it's type fuckery.
remove_competing_grabs
+
+
Removes any grabs applied to the affected movable that aren't src
target_or_owner_del
+
+
Target deleted, ABORT
target_thrown
+
+
If something tries to throw the target.
+
+
+
diff --git a/obj/item/hand_item/kisser.html b/obj/item/hand_item/kisser.html
new file mode 100644
index 000000000000..23a7d512bb33
--- /dev/null
+++ b/obj/item/hand_item/kisser.html
@@ -0,0 +1,43 @@
+
+
+
+
+
+
+ /obj/item/hand_item/kisser - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
The typepath of the gang antagonist datum that the person who uses the package should have added to them -- remember that the distinction between e.g. Ballas and Grove Street is on the antag datum level, not the team datum level.
Checks if the user is trying to use the package of the family they are in, and if not, adds them to the family, with some differing processing depending on whether the user is already a family member.
The typepath of the gang antagonist datum that the person who uses the package should have added to them -- remember that the distinction between e.g. Ballas and Grove Street is on the antag datum level, not the team datum level.
The team datum that the person who uses this package should be added to.
Proc Details
add_to_gang
+
+
Adds the user to the family that this package corresponds to, dispenses the free_clothes of that family, and adds them to the handler if it exists.
attempt_join_gang
+
+
Checks if the user is trying to use the package of the family they are in, and if not, adds them to the family, with some differing processing depending on whether the user is already a family member.
if false, upon implantation of a duplicate implant, an attempt to combine the new implant's uses with the old one's uses will be made, deleting the new implant if successful or stopping the implantation if not
if false, upon implantation of a duplicate implant, an attempt to combine the new implant's uses with the old one's uses will be made, deleting the new implant if successful or stopping the implantation if not
Reference to the uplink handler, deciding which type of uplink this implant has.
Proc Details
_component_removal
+
+
Proc called when component is removed; ie. uplink component
+
Callback catching if the underlying uplink component has been removed,
+generally by admin verbs or var editing. Implant does nothing without
+the component, so delete itself.
+
+
+
diff --git a/obj/item/implantcase.html b/obj/item/implantcase.html
new file mode 100644
index 000000000000..b9aa876b0531
--- /dev/null
+++ b/obj/item/implantcase.html
@@ -0,0 +1,43 @@
+
+
+
+
+
+
+ /obj/item/implantcase - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
This prints fake reports with garbage in them,
+can be set to print them instantly with a screwdriver.
+By default it plays the old "woody" scanning sound, scanning sounds can be cycled by clicking with a multitool.
+Can be crafted into a bananium HONK-spect scanner
Can print things way faster, at full power the reports printed by this will destroy
+themselves and leave water behind when folding is attempted by someone who isn't an
+origami master. Printing at full power costs INSPECTOR_POWER_USAGE_HONK cell units
+instead of INSPECTOR_POWER_USAGE_NORMAL cell units.
Whether the integrated circuit is admin only. Disables power usage and allows admin circuits to be attached, at the cost of making it inaccessible to regular users.
Whether the integrated circuit is admin only. Disables power usage and allows admin circuits to be attached, at the cost of making it inaccessible to regular users.
In-game item that can be used to revive a simplemob once. This makes the mob friendly.
+Becomes useless after use.
+Becomes malfunctioning when EMP'd.
+If a hostile mob is revived with a malfunctioning injector, it will be hostile to everyone except whoever revived it and gets robust searching enabled.
Goodies which can be given to anyone. The base weight for cash is 56. For there to be a 50/50 chance of getting a department item, they need 56 weight as well.
Goodies which can be given to anyone. The base weight for cash is 56. For there to be a 50/50 chance of getting a department item, they need 56 weight as well.
When the hand component of a touch spell is qdel'd, (the hand is dropped or otherwise lost),
+the cooldown on the spell that made it is automatically refunded.
Proc Details
remove_hand_with_no_refund
+
+
When the hand component of a touch spell is qdel'd, (the hand is dropped or otherwise lost),
+the cooldown on the spell that made it is automatically refunded.
+
However, if you want to consume the hand and not give a cooldown,
+such as adding a unique behavior to the hand specifically, this function will do that.
Where the chronofield maker was when the field went up
Proc Details
field_check
+
+ field_check
+
Checks to see if our field can still be linked to the tem. If it isn't, it will unlink the field.
+
Arguments:
+
+
field: chronofield we're checking the connection's validity on.
+
field_connect
+
+ field_connect
+
Links a chrono field to this module. The chrono field will keep track of the eradication process.
+Unlinks a chrono field if it is connected to a tem already.
+
Arguments:
+
+
field: chronofield we are attempting to link to this module.
+
field_disconnect
+
+ field_disconnect
+
Unlinks a chrono field from this module.
+
Arguments:
+
+
field: chronofield we are attempting to unlink from this module.
+
+
+
+
diff --git a/obj/item/mod/module/thermal_regulator.html b/obj/item/mod/module/thermal_regulator.html
new file mode 100644
index 000000000000..01e808b2ec65
--- /dev/null
+++ b/obj/item/mod/module/thermal_regulator.html
@@ -0,0 +1,50 @@
+
+
+
+
+
+
+ /obj/item/mod/module/thermal_regulator - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Displays notification text alongside a soundbeep when requested to by a program.
+
After checking tha the requesting program is allowed to send an alert, creates
+a visible message of the requested text alongside a soundbeep. This proc adds
+text to indicate that the message is coming from this device and the program
+on it, so the supplied text should be the exact message and ending punctuation.
+
Arguments:
+The program calling this proc.
+The message that the program wishes to display.
find_hardware_by_name
+
+
Checks all hardware pieces to determine if name matches, if yes, returns the hardware piece, otherwise returns null
forget_component
+
+
This isn't the "uninstall fully" proc, it just makes the computer lose all its references to the component
install_component
+
+
Installs component.
notify_hardware_change
+
+
Notify all programs of hardware changes.
notify_id_inserted
+
+
Notify all programs about an ID insertion.
notify_id_removed
+
+
Notify all programs about an ID removal.
play_ping
+
+
Plays a ping sound.
+
Timers runtime if you try to make them call playsound. Yep.
set_flashlight_color
+
+
Sets the computer's light color, if it has a light.
+
Called from ui_act(), this proc takes a color string and applies it.
+It is separated from ui_act() to be overwritten as needed.
+Arguments:
+
+
color is the string that holds the color value that we should use. Proc auto-fails if this is null.
+
toggle_flashlight
+
+
Toggles the computer's flashlight, if it has one.
+
Called from ui_act(), does as the name implies.
+It is separated from ui_act() to be overwritten as needed.
uninstall_component
+
+
Uninstalls component.
wipe_program
+
+
Wipes the computer's current program. Doesn't handle any of the niceties around doing this
Ref to the RoboTact app. Important enough to borgs to deserve a ref.
Proc Details
get_robotact
+
+
Returns a ref to the RoboTact app, creating the app if need be.
+
The RoboTact app is important for borgs, and so should always be available.
+This proc will look for it in the tablet's robotact var, then check the
+hard drive if the robotact var is unset, and finally attempt to create a new
+copy if the hard drive does not contain the app. If the hard drive rejects
+the new copy (such as due to lack of space), the proc will crash with an error.
+RoboTact is supposed to be undeletable, so these will create runtime messages.
Generate a unique key based on our sprites. So that if we've aleady drawn these sprites, they can be found in the cache and wont have to be drawn again (blessing and curse)
Called once every life tick on every organ in a carbon's body
+NOTE: THIS IS VERY HOT. Be careful what you put in here
+To give you some scale, if there's 100 carbons in the game, they each have maybe 9 organs
+So that's 900 calls to this proc every life process. Please don't be dumb
+Return TRUE to call updatehealth(). Please only call inside of on_life() if it's important.
SETS an organ's damage to the amount "damage_amount", and in doing so clears or sets the failing flag, good for when you have an effect that should fix an organ if broken
System for drawing organs with overlays. These overlays are drawn directly on the bodypart, attached to a person or not
+Works in tandem with the /datum/sprite_accessory datum to generate sprites
+Unlike normal organs, we're actually inside a persons limbs at all times
Updates the traits of the organ on the specific organ it is called on. Should be called anytime an organ is given a trait while it is already in a body.
processing_organs must ALWAYS be ordered in the same way as organ_process_order
+Otherwise life processing breaks down
add_organ_trait
+
+
Add a trait to an organ that it will give its owner.
applyOrganDamage
+
+
Adjusts an organ's damage by the amount "damage_amount", up to a maximum amount, which is by default max damage
attempt_vital_organ_revival
+
+
Called by Insert() if the organ is vital and the target is dead.
before_organ_replacement
+
+
Called before organs are replaced in regenerate_organs with new ones
build_cache_key
+
+
Generate a unique key based on our sprites. So that if we've aleady drawn these sprites, they can be found in the cache and wont have to be drawn again (blessing and curse)
build_overlays
+
+
Build overlays
can_draw_on_bodypart
+
+
Check whether we can draw the overlays. You generally don't want lizard snouts to draw over an EVA suit
can_recover
+
+
Can this organ be revived from the dead?
check_damage_thresholds
+
+
+
check_damage_thresholds
+
input: mob/organ_owner (a mob, the owner of the organ we call the proc on)
+
output: returns a message should get displayed.
+
description: By checking our current damage against our previous damage, we can decide whether we've passed an organ threshold.
+
If we have, send the corresponding threshold message to the owner, if such a message exists.
+
check_failing_thresholds
+
+
Checks if an organ should/shouldn't be failing and gives the appropriate organ flag
cut_away
+
+
Cut an organ away from it's container, but do not remove it from the container physically.
ex_act
+
+
A little hack to ensure old behavior.
exit_wardrobe
+
+
Used as callbacks by object pooling
get_availability
+
+
+
+
get_availability
+
+
+
returns whether the species should innately have this organ.
+
+
+
regenerate organs works with generic organs, so we need to get whether it can accept certain organs just by what this returns.
+
+
+
This is set to return true or false, depending on if a species has a specific organless trait. stomach for example checks if the species has NOSTOMACH and return based on that.
+
+
+
Arguments:
+
+
+
owner_species - species, needed to return whether the species has an organ specific trait
+
+
get_global_feature_list
+
+
Return a dumb glob list for this specific feature (called from parse_sprite)
get_overlays
+
+
Add the overlays we need to draw on a person. Called from _bodyparts.dm
get_scan_results
+
+
Called by medical scanners to get a simple summary of how healthy the organ is. Returns an empty string if things are fine.
inherit_color
+
+
Give the organ it's color. Force will override the existing one.
mutate_feature
+
+
Update our features after something changed our appearance
on_death
+
+
This is on_life() but for when the organ is dead or outside of a mob. Bad name.
on_life
+
+
Called once every life tick on every organ in a carbon's body
+NOTE: THIS IS VERY HOT. Be careful what you put in here
+To give you some scale, if there's 100 carbons in the game, they each have maybe 9 organs
+So that's 900 calls to this proc every life process. Please don't be dumb
+Return TRUE to call updatehealth(). Please only call inside of on_life() if it's important.
override_color
+
+
Colorizes the limb it's inserted to, if required.
remove_organ_trait
+
+
Removes a trait from an organ, and by extension, its owner.
setOrganDamage
+
+
SETS an organ's damage to the amount "damage_amount", and in doing so clears or sets the failing flag, good for when you have an effect that should fix an organ if broken
set_organ_dead
+
+
Set or unset the organ as failing. Returns TRUE on success.
set_sprite
+
+
System for drawing organs with overlays. These overlays are drawn directly on the bodypart, attached to a person or not
+Works in tandem with the /datum/sprite_accessory datum to generate sprites
+Unlike normal organs, we're actually inside a persons limbs at all times
+
mob_sprite is optional if you havent set sprite_datums for the object, and is used mostly to generate sprite_datums from a persons DNA
+For _mob_sprite we make a distinction between "Round Snout" and "round". Round Snout is the name of the sprite datum, while "round" would be part of the sprite
+I'm sorry
surgically_fix
+
+
Used for the fix_organ surgery, lops off some of the maxHealth if the organ was very damaged.
update_organ_traits
+
+
Updates the traits of the organ on the specific organ it is called on. Should be called anytime an organ is given a trait while it is already in a body.
+
+
+
diff --git a/obj/item/organ/alien/hivenode.html b/obj/item/organ/alien/hivenode.html
new file mode 100644
index 000000000000..db4f615d896e
--- /dev/null
+++ b/obj/item/organ/alien/hivenode.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /obj/item/organ/alien/hivenode - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Controls Xenomorph Embryo growth. If embryo is fully grown (or overgrown), stop the proc. If not, increase the stage by one and if it's not fully grown (stage 6), add a timer to do this proc again after however long the growth time variable is.
What stage of growth the embryo is at. Developed embryos give the host symptoms suggesting that an embryo is inside them.
Proc Details
advance_embryo_stage
+
+
Controls Xenomorph Embryo growth. If embryo is fully grown (or overgrown), stop the proc. If not, increase the stage by one and if it's not fully grown (stage 6), add a timer to do this proc again after however long the growth time variable is.
The brain's organ variables are significantly more different than the other organs, with half the decay rate for balance reasons, and twice the maxHealth
Maximum skillchip complexity we can support before they stop working. Do not reference this var directly and instead call get_max_skillchip_complexity()
The brain's organ variables are significantly more different than the other organs, with half the decay rate for balance reasons, and twice the maxHealth
Maximum skillchip complexity we can support before they stop working. Do not reference this var directly and instead call get_max_skillchip_complexity()
List of skillchip items, their location should be this brain.
Proc Details
activate_skillchip_failsafe
+
+
Deactivates all chips currently in the brain.
clone_skillchip_list
+
+
Creates a list of assoc lists containing skillchip types and key metadata.
+
Returns a complete list of new skillchip types with their metadata cloned from the brain's existing skillchip stock.
+Rumour has it that Changelings just LOVE this proc.
+Arguments:
+
+
not_removable - Special override, whether or not to force cloned chips to be non-removable, i.e. to delete on removal.
+
destroy_all_skillchips
+
+
Destroys all skillchips in the brain, calling on_removal if the brain has an owner.
+Arguments:
+
+
silent - Whether to give the user a chat notification with the removal flavour text.
+
get_attacking_limb
+
+
This proc lets the mob's brain decide what bodypart to attack with in an unarmed strike.
get_max_skillchip_complexity
+
+
Returns the total maximum skillchip complexity supported by this brain.
get_max_skillchip_slots
+
+
Returns the total maximum skillchip slot capacity supported by this brain.
get_used_skillchip_complexity
+
+
Returns the total current skillchip complexity used in this brain.
get_used_skillchip_slots
+
+
Returns the total current skillchip slot capacity used in this brain.
has_trauma_type
+
+
TRAUMAS
implant_skillchip
+
+
Attempts to implant target skillchip into the brain.
+
Returns whether the skillchip was implanted or not.
+If you're implanting the skillchip into a mob, use the implant_skillchip proc in mob/living/carbon instead.
+DANGEROUS - This proc assumes you've done the appropriate checks to make sure the skillchip should be implanted.
+Where possible, call the mob/living/carbon version of this proc which does relevant checks.
+Arguments:
+
+
skillchip - The skillchip you'd like to implant.
+
force - Whether or not to force the skillchip to be implanted, ignoring any checks.
+
remove_skillchip
+
+
Attempts to remove target skillchip from the brain.
+
Returns whether the skillchip was removed or not.
+If you're removing the skillchip from a mob, use the remove_skillchip proc in mob/living/carbon instead.
+Arguments:
+
+
skillchip - The skillchip you'd like to remove.
+
update_skillchips
+
+
Disables or re-enables any extra skillchips after skillchip limit changes.
Items inside toolset implants have TRAIT_NODROP, but we can still use the drop item hotkey as a
+quick way to store implant items. In this case, we check to make sure the user has the correct arm
+selected, and that the item is actually owned by us, and then we'll hand off the rest to Retract()
override this for breath handling unique to lung subtypes, breath_gas is the list of gas in the breath while gas breathed is just what is being added or removed from that list, just as they are when this is called in check_breath()
override this for breath handling unique to lung subtypes, breath_gas is the list of gas in the breath while gas breathed is just what is being added or removed from that list, just as they are when this is called in check_breath()
+
+
+
diff --git a/obj/item/organ/pod_hair.html b/obj/item/organ/pod_hair.html
new file mode 100644
index 000000000000..556e452f75eb
--- /dev/null
+++ b/obj/item/organ/pod_hair.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /obj/item/organ/pod_hair - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Receive a voice packet from the callstation. These are just transparently passed to us.
+This replicates the behaviour of send_speech, since we're being passed all the data in a signal.
Receive a voice packet from the callstation. These are just transparently passed to us.
+This replicates the behaviour of send_speech, since we're being passed all the data in a signal.
Gathers a list of candidates to display in the download candidate
+window. If the candidate isn't marked ready, ie they have not
+pressed submit, they will be skipped over.
Gathers a list of candidates to display in the download candidate
+window. If the candidate isn't marked ready, ie they have not
+pressed submit, they will be skipped over.
+
@return - An array of candidate objects.
setPersonality
+
+
The individual candidate to download
+The newly downloaded pAI personality
+
+
+
diff --git a/obj/item/paint_palette.html b/obj/item/paint_palette.html
new file mode 100644
index 000000000000..ed22cb9eafb0
--- /dev/null
+++ b/obj/item/paint_palette.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /obj/item/paint_palette - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Paper is now using markdown (like in github pull notes) for ALL rendering
+so we do loose a bit of functionality but we gain in easy of use of
+paper and getting rid of that crashing bug
What's been written on the paper by things other than players.
+Will be sanitized by the UI, and finally
+added to info when the user edits the paper text.
What's been written on the paper by things other than players.
+Will be sanitized by the UI, and finally
+added to info when the user edits the paper text.
Fake report but it turns into water under certain circumstances.
+
If someone who isn't an origami master tries to fold it into a paper plane, it will make the floor it's on wet and disappear.
+If it is ground, it will turn into 5u water.
This proc is called when a seed or any grown plant is scanned on right click (chemical mode).
+It formats the plant name as well as its chemical contents.
This proc is called when a seed or any grown plant is scanned on left click (stats mode).
+It formats the plant name as well as either its traits and stats.
This proc is called when we scan a hydroponics tray or soil on right click (chemicals mode)
+It formats the plant name and age, as well as the plant's chemical genes and the tray's contents.
This proc is called when we scan a hydroponics tray or soil on left click (stats mode)
+It formats the plant name, it's age, the plant's stats, and the tray's stats.
Proc Details
get_analyzer_text_chem_contents
+
+
This proc is formats the chemical CONTENTS of a plant into a message.
+
+
scanned_plant - the source plant we are reading out its reagents contents.
+
+
Returns the formatted output as text.
get_analyzer_text_chem_genes
+
+
This proc is formats the chemical GENES of a seed into a message.
+
+
scanned - the source seed for what we are scanning for chemical genes.
+
+
Returns the formatted output as text.
get_analyzer_text_traits
+
+
This proc is formats the traits and stats of a seed into a message.
+
+
scanned - the source seed for what we are scanning for traits.
+
+
Returns the formatted output as text.
get_graft_text
+
+
This proc is formats the scan of a graft of a seed into a message.
+
+
scanned_graft - the graft for what we are scanning.
+
+
Returns the formatted output as text.
pre_attack
+
+
When we attack something, first - try to scan something we hit with left click. Left-clicking uses scans for stats
pre_attack_secondary
+
+
Same as above, but with right click. Right-clicking scans for chemicals.
scan_plant_chems
+
+
This proc is called when a seed or any grown plant is scanned on right click (chemical mode).
+It formats the plant name as well as its chemical contents.
+
+
scanned_object - the source objecte for what we are scanning. This can be a grown food, a grown inedible, or a seed.
+
+
Returns the formatted output as text.
scan_plant_stats
+
+
This proc is called when a seed or any grown plant is scanned on left click (stats mode).
+It formats the plant name as well as either its traits and stats.
+
+
scanned_object - the source objecte for what we are scanning. This can be a grown food, a grown inedible, or a seed.
+
+
Returns the formatted output as text.
scan_tray_chems
+
+
This proc is called when we scan a hydroponics tray or soil on right click (chemicals mode)
+It formats the plant name and age, as well as the plant's chemical genes and the tray's contents.
+
+
scanned_tray - the tray or soil we are scanning.
+
+
Returns the formatted message as text.
scan_tray_stats
+
+
This proc is called when we scan a hydroponics tray or soil on left click (stats mode)
+It formats the plant name, it's age, the plant's stats, and the tray's stats.
+
+
scanned_tray - the tray or soil we are scanning.
+
+
Returns the formatted message as text.
+
+
+
diff --git a/obj/item/plaque.html b/obj/item/plaque.html
new file mode 100644
index 000000000000..02b821ade1c6
--- /dev/null
+++ b/obj/item/plaque.html
@@ -0,0 +1,43 @@
+
+
+
+
+
+
+ /obj/item/plaque - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Both the range around the radio in which mobs can hear what it receives and the range the radio can hear. If it's -1, it will not broadcast sound or listen.
setter for broadcasting that makes us not hearing sensitive if not broadcasting and hearing sensitive if broadcasting
+hearing sensitive in this case only matters for the purposes of listening for words said in nearby tiles, talking into us directly bypasses hearing
Both the range around the radio in which mobs can hear what it receives and the range the radio can hear. If it's -1, it will not broadcast sound or listen.
Checks if this radio can receive on the given frequency.
get_broadcasting
+
+
simple getter for the broadcasting variable. necessary due to VAR_PROTECTED
get_frequency
+
+
simple getter for the frequency variable. necessary due to VAR_PROTECTED
get_listening
+
+
simple getter for the listening variable. necessary due to VAR_PROTECTED
is_on
+
+
simple getter for the on variable. necessary due to VAR_PROTECTED
readd_listening_radio_channels
+
+
goes through all radio channels we should be listening for and readds them to the global list
set_broadcasting
+
+
setter for broadcasting that makes us not hearing sensitive if not broadcasting and hearing sensitive if broadcasting
+hearing sensitive in this case only matters for the purposes of listening for words said in nearby tiles, talking into us directly bypasses hearing
+
+
new_broadcasting- the new value we want to set broadcasting to
+
actual_setting - whether or not the radio is supposed to be broadcasting, sets should_be_broadcasting to the new value if true, otherwise just changes broadcasting
+
set_listening
+
+
setter for the listener var, adds or removes this radio from the global radio list if we are also on
+
+
new_listening - the new value we want to set listening to
+
actual_setting - whether or not the radio is supposed to be listening, sets should_be_listening to the new listening value if true, otherwise just changes listening
+
set_on
+
+
setter for the on var that sets both broadcasting and listening to off or whatever they were supposed to be
Override attack_tk_grab instead of attack_tk because we actually want attack_tk's
+functionality. What we DON'T want is attack_tk_grab attempting to pick up the
+intercom as if it was an ordinary item.
Proc Details
AreaPowerCheck
+
+
Proc called whenever the intercom's area loses or gains power. Responsible for setting the on variable and calling update_icon().
+
Normally called after the intercom's area recieves the COMSIG_AREA_POWER_CHANGE signal, but it can also be called directly.
+Arguments:
+
+
source - the area that just had a power change.
+
attack_tk_grab
+
+
Override attack_tk_grab instead of attack_tk because we actually want attack_tk's
+functionality. What we DON'T want is attack_tk_grab attempting to pick up the
+intercom as if it was an ordinary item.
The current precursor to anomaly cores, these are manufactured into 'finished' anomaly cores for use in research, items, and more.
+
The current amounts created is stored in SSresearch.created_anomaly_types[ANOMALY_CORE_TYPE_DEFINE] = amount.
+The hard limits are in code/__DEFINES/anomalies.dm.
Note: When adding food items with dummy parents, make sure to add
+the parent to the exclusion list in code/__HELPERS/unsorted.dm's
+get_random_food proc.
+
+
+
diff --git a/obj/item/reagent_containers/food/condiment.html b/obj/item/reagent_containers/food/condiment.html
new file mode 100644
index 000000000000..52376e457dab
--- /dev/null
+++ b/obj/item/reagent_containers/food/condiment.html
@@ -0,0 +1,43 @@
+
+
+
+
+
+
+ /obj/item/reagent_containers/food/condiment - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
List of possible styles (list(<icon_state>, , )) for condiment packs.
+Since all of them differs only in color should probably be replaced with usual reagentfillings instead
List of possible styles (list(<icon_state>, , )) for condiment packs.
+Since all of them differs only in color should probably be replaced with usual reagentfillings instead
Proc Details
on_reagent_add
+
+
Handles reagents getting added to the condiment pack.
on_reagent_del
+
+
Handles reagents getting removed from the condiment pack.
+
+
+
diff --git a/obj/item/reagent_containers/food/drinks/bottle.html b/obj/item/reagent_containers/food/drinks/bottle.html
new file mode 100644
index 000000000000..097c20d670d5
--- /dev/null
+++ b/obj/item/reagent_containers/food/drinks/bottle.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /obj/item/reagent_containers/food/drinks/bottle - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
If the can hasn't been opened yet, this is the measure of how fizzed up it is from being shaken or thrown around. When opened, this is rolled as a percentage chance to burst
If the can hasn't been opened yet, this is the measure of how fizzed up it is from being shaken or thrown around. When opened, this is rolled as a percentage chance to burst
Proc Details
burst_soda
+
+
Burst the soda open on someone. Fun! Opens and empties the soda can, but does not crush it.
+
Arguments:
+
+
target - Who's getting covered in soda
+
hide_message - Stops the generic fizzing message, so you can do your own
+
+
+
+
diff --git a/obj/item/reagent_containers/glass/vial.html b/obj/item/reagent_containers/glass/vial.html
new file mode 100644
index 000000000000..c8c9dd398d23
--- /dev/null
+++ b/obj/item/reagent_containers/glass/vial.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /obj/item/reagent_containers/glass/vial - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
note: this timer overlay increments one frame every second (to simulate a clock ticking). If you want to instead have it do a full cycle in a minute, set the 'delay' of each frame of the icon overlay to 75 rather than 10, and the worn overlay to twice that.
note: this timer overlay increments one frame every second (to simulate a clock ticking). If you want to instead have it do a full cycle in a minute, set the 'delay' of each frame of the icon overlay to 75 rather than 10, and the worn overlay to twice that.
Definition of /obj/item/robot_model, which defines behavior for each model.
+Deals with the creation and deletion of modules (tools).
+Assigns modules and traits to a borg with a specific model selected.
A helper proc. checks to see if we can afford the amount of charge that is passed, and if we can docs the charge from our base, and returns TRUE. If we can't we return FALSE
Forms a radial menu based off an object in a list, or a list's associated object
is_allowed
+
+
Helper proc that iterates through all the things we are allowed to spawn on, and sees if the passed atom is one of them
use_matter
+
+
A helper proc. checks to see if we can afford the amount of charge that is passed, and if we can docs the charge from our base, and returns TRUE. If we can't we return FALSE
+
+
+
diff --git a/obj/item/rsf/cookiesynth.html b/obj/item/rsf/cookiesynth.html
new file mode 100644
index 000000000000..66bc4c76b7af
--- /dev/null
+++ b/obj/item/rsf/cookiesynth.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /obj/item/rsf/cookiesynth - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
The number of nutriments we have inside of our plant, for use in our heating / cooling genes
+Setters procs ///
+Adjusts seed yield up or down according to adjustamt. (Max 10)
Override for seeds with unique text for their analyzer. (No newlines at the start or end of unique text!)
+Returns null if no unique text, or a string of text if there is.
Reference to the tray/soil the seeds are planted in.
+Count used for creating the correct amount of results to the harvest.
+List of plants all harvested from the same batch.
+Tile of the harvester to deposit the growables.
+Name of the grown products.
+The Number of products produced by the plant, typically the yield. Modified by certain traits.
+This is where plant chemical products are handled.
Amount of growns created per harvest. If is -1, the plant/shroom/weed is never meant to be harvested.
Proc Details
Copy
+
+
Copy all the variables from one seed to a new instance of the same seed and return it.
adjust_endurance
+
+
Adjusts seed endurance up or down according to adjustamt. (Max 100)
adjust_instability
+
+
Adjusts seed instability up or down according to adjustamt. (Max 100)
adjust_lifespan
+
+
Adjusts seed lifespan up or down according to adjustamt. (Max 100)
adjust_potency
+
+
Adjusts seed potency up or down according to adjustamt. (Max 100)
adjust_production
+
+
Adjusts seed production seed up or down according to adjustamt. (Max 10)
adjust_weed_chance
+
+
Adjusts seed weed chance up or down according to adjustamt. (Max 67%)
adjust_weed_rate
+
+
Adjusts seed weed grwoth speed up or down according to adjustamt. (Max 10)
adjust_yield
+
+
The number of nutriments we have inside of our plant, for use in our heating / cooling genes
+Setters procs ///
+Adjusts seed yield up or down according to adjustamt. (Max 10)
apply_graft
+
+
Applies a graft to this plant.
+
Adds the graft trait to this plant if possible.
+Increases plant stats by 2/3 of the grafts stats to a maximum of 100 (10 for yield).
+Returns TRUE if the graft could apply its trait successfully, FALSE if it fails to apply the trait.
+NOTE even if the graft fails to apply the trait it still adjusts the plant's stats and reagents.
Creates a new graft from this plant.
+Sets the grafts trait to this plants graftable trait.
+Gives the graft a reference to this plant.
+Copies all the relevant stats from this plant to the graft.
+Returns the created graft.
get_unique_analyzer_text
+
+
Override for seeds with unique text for their analyzer. (No newlines at the start or end of unique text!)
+Returns null if no unique text, or a string of text if there is.
on_chem_reaction
+
+
Override for seeds with special chem reactions.
prepare_result
+
+
Reference to the tray/soil the seeds are planted in.
+Count used for creating the correct amount of results to the harvest.
+List of plants all harvested from the same batch.
+Tile of the harvester to deposit the growables.
+Name of the grown products.
+The Number of products produced by the plant, typically the yield. Modified by certain traits.
+This is where plant chemical products are handled.
+
Individually, the formula for individual amounts of chemicals is Potency * the chemical production %, rounded to the fullest 1.
+Specific chem handling is also handled here, like bloodtype, food taste within nutriment, and the auto-distilling/autojuicing traits.
+This is where chemical reactions can occur, and the heating / cooling traits effect the reagent container.
set_endurance
+
+
Sets the plant's endurance stat to the value of adjustamt. (Max 100)
set_instability
+
+
Sets the plant's instability stat to the value of adjustamt. (Max 100)
set_lifespan
+
+
Sets the plant's lifespan stat to the value of adjustamt. (Max 100)
set_potency
+
+
Sets the plant's potency stat to the value of adjustamt. (Max 100)
set_production
+
+
Sets the plant's production stat to the value of adjustamt. (Max 10)
set_weed_chance
+
+
Sets the plant's weed growth percentage to the value of adjustamt. (Max 67%)
set_weed_rate
+
+
Sets the plant's weed production rate to the value of adjustamt. (Max 10)
set_yield
+
+
Sets the plant's yield stat to the value of adjustamt. (Max 10, or 5 with some traits)
Whetstones can be used to increase an item's force, throw_force and it's change it's sharpness to SHARP_EDGED. Whetstones do not work with energy weapons. Two-handed weapons will only get the throw_force bonus. A whetstone can only be used once.
Whetstone that adds 200 damage to an item, with the maximum force and throw_force reachable with it being 200. As with normal whetstones, energy weapons cannot be sharpened with it and two-handed weapons will only get the throw_force bonus.
+
+
+
diff --git a/obj/item/shield/energy.html b/obj/item/shield/energy.html
new file mode 100644
index 000000000000..cc3d494f83e3
--- /dev/null
+++ b/obj/item/shield/energy.html
@@ -0,0 +1,64 @@
+
+
+
+
+
+
+ /obj/item/shield/energy - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Used to determine if this is an abstract type or not. If this is meant to be an abstract type, set it to the type's path. Will be overridden by subsequent abstract parents. See /datum/action/item_action/chameleon/change/skillchip/initialize_disguises()
How complex the skillchip is. Brains can only handle so much complexity at once and skillchips will start to deactivate when the brain's complexity limit is exceeded.
Variable for flags. DANGEROUS - Child types overwrite flags instead of adding to them. If you change this, make sure all child types have the appropriate flags set too.
Used to determine if this is an abstract type or not. If this is meant to be an abstract type, set it to the type's path. Will be overridden by subsequent abstract parents. See /datum/action/item_action/chameleon/change/skillchip/initialize_disguises()
How complex the skillchip is. Brains can only handle so much complexity at once and skillchips will start to deactivate when the brain's complexity limit is exceeded.
Variable for flags. DANGEROUS - Child types overwrite flags instead of adding to them. If you change this, make sure all child types have the appropriate flags set too.
How many slots taken up in the brain by this chip. Max brain slots are hard set and should not be changed at all.
Proc Details
get_chip_data
+
+
Returns a list of basic chip info. Used by the skill station.
get_complexity
+
+
Returns the chip's complexity.
+
Intended to be overriden.
get_metadata
+
+
Gets key metadata from this skillchip in an assoc list.
+
If you override this proc, don't forget to also override set_metadata, which takes the output of
+this proc and uses it to set the metadata.
+Does not copy over any owner or brain status. Handle that externally.
has_activate_incompatibility
+
+
Checks whether a given skillchip has an incompatibility with a brain that should render it impossible
+to activate.
+
Returns a string with an explanation if the chip is not activatable. FALSE otherwise.
+Arguments:
+
+
skillchip - The skillchip you're intending to activate. Does not activate the chip.
+
has_brain_incompatibility
+
+
Performs a full sweep of checks that dictate if this chip can be implanted in a given brain.
+
Override this with any snowflake chip checks.
+Returns TRUE if the chip is fully compatible, FALSE otherwise.
+Arguments:
+
+
brain - The brain to check for implantability with.
+
has_mob_incompatibility
+
+
Performs a full sweep of checks that dictate if this chip can be implanted in a given target.
+
Override this with any snowflake chip checks. An example of which would be checking if a target is
+mindshielded if you've got a special security skillchip.
+Returns a string with an incompatibility explanation if the chip is not compatible, returns FALSE
+if it is compatible.
+Arguments:
+
+
target - The mob to check for implantability with.
+
has_skillchip_incompatibility
+
+
Checks for skillchip incompatibility with another chip.
+
Does this skillchip have incompatibility with the skillchip in the args?
+Override this with any snowflake chip-vs-chip incompatibility checks.
+Returns a string with an incompatibility explanation if the chip is not compatible, returns FALSE
+if it is compatible.
+Arguments:
+
+
skillchip - The skillchip to test for incompatability.
+
is_active
+
+
Returns whether the chip is active.
+
Intended to be overriden.
+Returns TRUE if the chip is active.
is_on_cooldown
+
+
Returns whether the chip is on cooldown. Chips ordinarily go on cooldown when activated.
+
This does not mean the chip should be impossible to do anything with.
+It's up to each individual piece of code to decide what it does with the result of this proc.
+
Returns TRUE if the chip's extraction cooldown hasn't yet passed.
on_activate
+
+
Called when a skillchip is activated.
+
Arguments:
+
+
user - The user to apply skillchip effects to.
+
silent - Boolean. Whether or not an activation message should be shown to the user.
+
on_deactivate
+
+
Called when a skillchip is deactivated.
+
Arguments:
+
+
user - The user to remove skillchip effects from.
+
silent - Boolean. Whether or not a deactivation message should be shown to the user.
+
on_implant
+
+
Called when a skillchip is inserted in a user's brain.
+
Arguments:
+
+
owner_brain - The brain that this skillchip was implanted in to.
+
on_removal
+
+
Called when a skillchip is removed from the user's brain.
+
Always deactivates the skillchip.
+Arguments:
+
+
user - The user to remove skillchip effects from.
+
silent - Boolean. Whether or not a deactivation message should be shown to the user.
+
set_metadata
+
+
Sets key metadata for this skillchip from an assoc list.
+
Best used with the output from get_metadata() of another chip.
+If you override this proc, don't forget to also override get_metadata, which is where you should
+usually get the assoc list that feeds into this proc.
+Does not set any owner or brain status. Handle that externally.
+Arguments:
+metadata - Ideally the output of another chip's get_metadata proc. Assoc list of metadata.
try_activate_skillchip
+
+
Activates the skillchip, if possible.
+
Returns a message containing the reason if activation is not possible.
+Arguments:
+
+
silent - Boolean. Whether or not an activation message should be shown to the user.
+
force - Boolean. Whether or not to just force de-activation if it would be prevented for any reason.
+
try_deactivate_skillchip
+
+
Deactivates the skillchip, if possible.
+
Returns a message containing the reason if deactivation is not possible.
+Arguments:
+
+
silent - Boolean. Whether or not an activation message should be shown to the user.
+
force - Boolean. Whether or not to just force de-activation if it would be prevented for any reason.
This proc is called whenever a Luminescent consumes a slime extract. Each one is separated into major and minor effects depending on the extract. Cooldown is measured in deciseconds.
+
+
arg1 - The mob absorbing the slime extract.
+
arg2 - The valid species for the absorbtion. Should always be a Luminescent unless something very major has changed.
+
arg3 - Whether or not the activation is major or minor. Major activations have large, complex effects, minor are simple.
+
attack
+
+
Core-crossing: Feeding adult slimes extracts to obtain a much more powerful, single extract.
+
By using a valid core on a living adult slime, then feeding it nine more of the same type, you can mutate it into more useful items. Not every slime type has an implemented core cross.
Returns the mob that is currently holding us if we are either in their inventory or a backpack analogue.
+Returns null if it's in an invalid location, so that we can check explicitly for null later.
Proc Details
get_held_mob
+
+
Returns the mob that is currently holding us if we are either in their inventory or a backpack analogue.
+Returns null if it's in an invalid location, so that we can check explicitly for null later.
Feed slimes potions either by hand or using the slime console.
+
Slime potions either augment the slime's behavior, its extract output, or its intelligence. These all come either from extract effects or cross cores.
+A few of the more powerful ones can modify someone's equipment or gender.
+New ones should probably be accessible only through cross cores as all the normal core types already have uses. Rule of thumb is 'stronger effects go in cross cores'.
This controls the color of the soulstone as well as restrictions for who can use it. THEME_CULT is red and is the default of cultist THEME_WIZARD is purple and is the default of wizard and THEME_HOLY is for purified soul stone
Procs for moving soul in and out off stone
+transfer the mind of a carbon mob (which is then dusted) into a shade mob inside src. If forced, sacrifical and stat checks are skipped.
This controls the color of the soulstone as well as restrictions for who can use it. THEME_CULT is red and is the default of cultist THEME_WIZARD is purple and is the default of wizard and THEME_HOLY is for purified soul stone
Proc Details
attack
+
+
Capturing
attack_self
+
+
Options for using captured souls
attempt_exorcism
+
+
attempt_exorcism: called from on_bible_smacked, takes time and if successful
+resets the item to a pre-possessed state
+
Arguments:
+
+
exorcist: user who is attempting to remove the spirit
+
capture_shade
+
+
captures a shade that was previously released from a soulstone.
capture_soul
+
+
Procs for moving soul in and out off stone
+transfer the mind of a carbon mob (which is then dusted) into a shade mob inside src. If forced, sacrifical and stat checks are skipped.
corrupt
+
+
corrupt: turns the soulstone into a cult one and turns the occupant shade, if any, into a cultist
on_bible_smacked
+
+
signal called whenever a soulstone is smacked by a bible
transfer_to_construct
+
+
transfer the mind of the shade to a construct mob selected by the user, then deletes both the shade and src.
+
+
+
diff --git a/obj/item/sparkler.html b/obj/item/sparkler.html
new file mode 100644
index 000000000000..8bec5130d871
--- /dev/null
+++ b/obj/item/sparkler.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /obj/item/sparkler - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Purchases a fully random wizard loadout for [wizard], with a point bonus [bonus_to_give].
+If passed a number [bonus_to_give], the wizard is given additional uses on their spellbook, used in randomization.
Purchases a semi-random wizard loadout for [wizard]
+If passed a number [bonus_to_give], the wizard is given additional uses on their spellbook, used in randomization.
Has no effect on charge, but gives a funny message to people who think they're clever.
prepare_spells
+
+
Instantiates our list of spellbook entries.
purchase_entry
+
+
Attempts to purchased the passed entry [to_buy] for [user].
randomize
+
+
Purchases a fully random wizard loadout for [wizard], with a point bonus [bonus_to_give].
+If passed a number [bonus_to_give], the wizard is given additional uses on their spellbook, used in randomization.
semirandomize
+
+
Purchases a semi-random wizard loadout for [wizard]
+If passed a number [bonus_to_give], the wizard is given additional uses on their spellbook, used in randomization.
wizard_loadout
+
+
Purchases a wizard loadout [loadout] for [wizard].
If set and this used as a splint for a broken bone wound, this is used as a multiplier for applicable slowdowns (lower = better) (also for speeding up burn recoveries)
If set and this used as a splint for a broken bone wound, this is used as a multiplier for applicable slowdowns (lower = better) (also for speeding up burn recoveries)
Proc Details
absorb_blood
+
+
Absorb an incoming bleed amount, return the amount we failed to absorb.
add
+
+
+
+
Adds some number of units to this stack.
+
+
+
Arguments:
+
+
+
+
_amount: The number of units to add to this stack.
+
+
+
build_recipe
+
+
Returns a list of properties of a given recipe
+
Arguments:
+
+
R - The stack recipe we are using to get a list of properties
+
can_merge
+
+
+
+
Checks whether this stack can merge itself into another stack.
Apply the actual effects of the healing if it's a simple animal, goes to /obj/item/stack/medical/proc/heal_carbon if it's a carbon, returns TRUE if it works, FALSE if it doesn't
The healing effects on a carbon patient. Since we have extra details for dealing with bodyparts, we get our own fancy proc. Still returns TRUE on success and FALSE on fail
In which we print the message that we're starting to heal someone, then we try healing them. Does the do_after whether or not it can actually succeed on a targeted mob
Apply the actual effects of the healing if it's a simple animal, goes to /obj/item/stack/medical/proc/heal_carbon if it's a carbon, returns TRUE if it works, FALSE if it doesn't
heal_carbon
+
+
The healing effects on a carbon patient. Since we have extra details for dealing with bodyparts, we get our own fancy proc. Still returns TRUE on success and FALSE on fail
post_heal_effects
+
+
Override this proc for special post heal effects.
try_heal
+
+
In which we print the message that we're starting to heal someone, then we try healing them. Does the do_after whether or not it can actually succeed on a targeted mob
+
+
+
diff --git a/obj/item/stack/medical/mesh.html b/obj/item/stack/medical/mesh.html
new file mode 100644
index 000000000000..043e8eee86c6
--- /dev/null
+++ b/obj/item/stack/medical/mesh.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /obj/item/stack/medical/mesh - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Returns a list of object types to be preloaded by our code
+I'll say it again, be very careful with this. We only need it for a few things
+Don't do anything stupid, please
Should we preload the contents of this type?
+BE CAREFUL, THERE'S SOME REALLY NASTY SHIT IN THIS TYPEPATH
+SANTA IS EVIL
Proc Details
get_types_to_preload
+
+
Returns a list of object types to be preloaded by our code
+I'll say it again, be very careful with this. We only need it for a few things
+Don't do anything stupid, please
+
+
+
diff --git a/obj/item/storage/backpack/duffelbag/cursed.html b/obj/item/storage/backpack/duffelbag/cursed.html
new file mode 100644
index 000000000000..5527f1af9c45
--- /dev/null
+++ b/obj/item/storage/backpack/duffelbag/cursed.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /obj/item/storage/backpack/duffelbag/cursed - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Signal handler for a part is removed from the BRPED.
Proc Details
on_insered_component_reagent_pre_add
+
+
Signal handler for when the reagents datum of an inserted part has reagents added to it.
+
Registers the PRE_ADD variant which allows the signal handler to stop reagents being
+added.
+
Simply returns COMPONENT_CANCEL_REAGENT_ADD. We never want to allow people to add
+reagents to beakers in BRPEDs as they can then be used for spammable remote bombing.
on_part_entered
+
+
Signal handler for when a part has been inserted into the BRPED.
+
If the inserted item is a rigged or corrupted cell, does some logging.
+
If it has a reagent holder, clears the reagents and registers signals to prevent new
+reagents being added and registers clean up signals on inserted item's removal from
+the BRPED.
on_part_exited
+
+
Signal handler for a part is removed from the BRPED.
+
Does signal registration cleanup on its reagents, if it has any.
List in which all currently dispensable reagents go
+If the UI has the pH meter shown
Proc Details
replace_beaker
+
+
Replaces the beaker of the portable chemical mixer with another beaker, or simply adds the new beaker if none is in currently
+
Checks if a valid user and a valid new beaker exist and attempts to replace the current beaker in the portable chemical mixer with the one in hand. Simply places the new beaker in if no beaker is currently loaded
+Arguments:
+
+
mob/living/user - The user who is trying to exchange beakers
+
obj/item/reagent_containers/new_beaker - The new beaker that the user wants to put into the device
+
update_contents
+
+
Updates the contents of the portable chemical mixer
+
A list of dispensable reagents is created by iterating through each source beaker in the portable chemical beaker and reading its contents
+
+
+
diff --git a/obj/item/storage/secure.html b/obj/item/storage/secure.html
new file mode 100644
index 000000000000..4abe1188e2af
--- /dev/null
+++ b/obj/item/storage/secure.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+ /obj/item/storage/secure - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
The volume of this tank. Among other things gas tank explosions (including TTVs) scale off of this. Be sure to account for that if you change this or you will break ~~toxins~~ordinance.
The volume of this tank. Among other things gas tank explosions (including TTVs) scale off of this. Be sure to account for that if you change this or you will break ~~toxins~~ordinance.
Proc Details
after_internals_closed
+
+
Called by carbons after they disconnect the tank from their breathing apparatus.
after_internals_opened
+
+
Called by carbons after they connect the tank to their breathing apparatus.
atom_break
+
+
Handles the tank springing a leak.
atom_destruction
+
+
Handles rupturing and fragmenting
dropped
+
+
Closes the tank if dropped while open.
equipped
+
+
Closes the tank if given to another mob while open.
handle_tolerances
+
+
Handles the minimum and maximum pressure tolerances of the tank.
+
Returns true if it did anything of significance, false otherwise
+Arguments:
+
+
delta_time: How long has passed between ticks.
+
merging_information
+
+
Handle fragmentation
+Holy. Fucking. Shit. This is AGONIZING. Give me /obj/proc/fragmentate() PLEASE.
remove_air_volume
+
+
Removes some volume of the tanks gases as the tanks distribution pressure.
+
Arguments:
+
+
volume_to_return: The amount of volume to remove from the tank.
+
toggle_internals
+
+
Attempts to toggle the mob's internals on or off using this tank. Returns TRUE if successful.
+
+
+
diff --git a/obj/item/tape.html b/obj/item/tape.html
new file mode 100644
index 000000000000..8e03d35d7746
--- /dev/null
+++ b/obj/item/tape.html
@@ -0,0 +1,50 @@
+
+
+
+
+
+
+ /obj/item/tape - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Alright so some brief details here, we store all "immutable" (Think like power) card variables in a global list, indexed by id
+This proc gets the card's associated card datum to play with
Has this card been "tapped"? AKA, is it horizontal?
Proc Details
extract_datum
+
+
Alright so some brief details here, we store all "immutable" (Think like power) card variables in a global list, indexed by id
+This proc gets the card's associated card datum to play with
A stack item that's not actually a stack because ORDER MATTERS with a deck of cards!
+The "top" card of the deck will always be the bottom card in the stack for our purposes.
The user shuffles the order of the deck, then closes any visability into the deck's storage to prevent cheesing.
+*User: The person doing the shuffling, used in visable message and closing UI.
+*Visible: Will anyone need to hear the visable message about the shuffling?
Proc Details
draw_card
+
+
The user draws a single card. The deck is then handled based on how many cards are left.
flip_deck
+
+
The user flips the deck, turning it into a face up/down pile, and reverses the order of the cards from top to bottom.
shuffle_deck
+
+
The user shuffles the order of the deck, then closes any visability into the deck's storage to prevent cheesing.
+*User: The person doing the shuffling, used in visable message and closing UI.
+*Visible: Will anyone need to hear the visable message about the shuffling?
+
+
+
diff --git a/obj/item/teleportation_scroll.html b/obj/item/teleportation_scroll.html
new file mode 100644
index 000000000000..a8bc9f780d81
--- /dev/null
+++ b/obj/item/teleportation_scroll.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /obj/item/teleportation_scroll - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
a throwing star which specifically makes sure you know it came from a real ninja.
+
The most important item in the entire codebase, as without it we would all cease to exist.
+Inherits everything that makes it interesting the stamina throwing star, but the most
+important change made is that its name specifically has the prefix, 'ninja' in it.
+This provides the detective role with information to play off of by ensuring that his
+assumption that a space ninja is aboard the ship to be true when he find 20 of these in
+the captain's back. Along with this, its throwforce is 10 instead of the 5 of the stamina
+throwing star, meaning it'll do a little more damage than the stamina throwing star does as well.
+Changes to this item need to be approved by all maintainers, so if you do change it, make sure
+you go through the proper channels, lest you get permabanned. Do I make myself clear?
+
+
+
diff --git a/obj/item/tk_grab.html b/obj/item/tk_grab.html
new file mode 100644
index 000000000000..9061075edd05
--- /dev/null
+++ b/obj/item/tk_grab.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /obj/item/tk_grab - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Draws the top card unless a card arg is supplied then it picks that specific card
+and returns it (the card arg is used by the radial menu for cardhands to select
+specific cards out of the cardhand)
+Arguments:
+
+
mob/living/user - The user drawing the card.
+
obj/item/toy/singlecard/card (optional) - The card drawn from the hand
+
insert
+
+
This is used to insert a list of cards into a deck or cardhand
+
All cards that are inserted have their angle and pixel offsets reset to zero however their
+flip state does not change unless it's being inserted into a deck which is always facedown
+(see the deck/insert proc)
+
Arguments:
+
+
card_item - Either a singlecard or cardhand that gets inserted into the src
Who's in control of the defender (src)?
+How long has the battle been going?
+Lines chosen for the winning mech
+This proc checks if a battle can be initiated between src and attacker.
Attack is called from the user's toy, aimed at target(another human), checking for target's toy.
attack_tk
+
+
Overrides attack_tk - Sorry, you have to be face to face to initiate a battle, it's good sportsmanship
attackby
+
+
If you attack a mech with a mech, initiate combat between them
check_battle_start
+
+
Who's in control of the defender (src)?
+How long has the battle been going?
+Lines chosen for the winning mech
+This proc checks if a battle can be initiated between src and attacker.
+
Both SRC and attacker (if attacker is included) timers are checked if they're on cooldown, and
+both SRC and attacker (if attacker is included) are checked if they are in combat already.
+If any of the above are true, the proc returns FALSE and sends a message to user (and target, if included) otherwise, it returns TRUE
+Arguments:
+
+
user: the user who is initiating the battle
+
attacker: optional arg for checking two mechs at once
+
target: optional arg used in Mech PvP battles (if used, attacker is target's toy)
+
combat_sleep
+
+
this proc combines "sleep" while also checking for if the battle should continue
+
this goes through some of the checks - the toys need to be next to each other to fight!
+if it's player vs themself: They need to be able to "control" both mechs (either must be adjacent or using TK)
+if it's player vs player: Both players need to be able to "control" their mechs (either must be adjacent or using TK)
+if it's player vs mech (suicide): the mech needs to be in range of the player
+if all the checks are TRUE, it does the sleeps, and returns TRUE. Otherwise, it returns FALSE.
+Arguments:
+
+
delay - the amount of time the sleep at the end of the check will sleep for
+
attacker - the attacking toy in the battle.
+
attacker_controller - the controller of the attacking toy. there should ALWAYS be an attacker_controller
+
opponent - (optional) the defender controller in the battle, for PvP
+
mecha_brawl
+
+
The 'master' proc of the mech battle. Processes the entire battle's events and makes sure it start and finishes correctly.
+
src is the defending toy, and the battle proc is called on it to begin the battle.
+After going through a few checks at the beginning to ensure the battle can start properly, the battle begins a loop that lasts
+until either toy has no more health. During this loop, it also ensures the mechs stay in combat range of each other.
+It will then randomly decide attacks for each toy, occasionally making one or the other use their special attack.
+When either mech has no more health, the loop ends, and it displays the victor and the loser while updating their stats and resetting them.
+Arguments:
+
+
attacker - the attacking toy, the toy in the attacker_controller's hands
+
attacker_controller - the user, the one who is holding the toys / controlling the fight
+
opponent - optional arg used in Mech PvP battles: the other person who is taking part in the fight (controls src)
+
say
+
+
Override the say proc if they're mute
special_attack_move
+
+
Processes any special attack moves that happen in the battle (called in the mechaBattle proc).
+
Makes the toy shout their special attack cry and updates its cooldown. Then, does the special attack.
+Arguments:
+
+
victim - the toy being hit by the special move
+
suicide_act
+
+
Starts a battle, toy mech vs player. Player... doesn't win.
super_special_attack
+
+
Base proc for 'other' special attack moves.
+
This one is only for inheritance, each mech with an 'other' type move has their procs below.
+Arguments:
+
+
victim - the toy being hit by the super special move (doesn't necessarily need to be used)
+
withdraw_offer
+
+
Resets the request for battle.
+
For use in a timer, this proc resets the wants_to_battle variable after a short period.
+Arguments:
+
+
user - the user wanting to do battle
+
+
+
+
diff --git a/obj/item/toy/plush.html b/obj/item/toy/plush.html
new file mode 100644
index 000000000000..3db3bbe60699
--- /dev/null
+++ b/obj/item/toy/plush.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /obj/item/toy/plush - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Internal function used in the toy singularity suicide
Proc Details
manual_suicide
+
+
Internal function used in the toy singularity suicide
+
Cavity implants the toy singularity into the body of the user (arg1), and kills the user.
+Makes the user vomit and receive 120 suffocation damage if there already is a cavity implant in the user.
+Throwing the singularity away will cause the user to start choking themself to death.
+Arguments:
+
+
user - Whoever is doing the suiciding
+
+
+
+
diff --git a/obj/item/toy/sword.html b/obj/item/toy/sword.html
new file mode 100644
index 000000000000..e0794d2856d8
--- /dev/null
+++ b/obj/item/toy/sword.html
@@ -0,0 +1,43 @@
+
+
+
+
+
+
+ /obj/item/toy/sword - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Increments the 'hit' counter if the target we're attacking is a mob, target, or training machine with an attached item.
+Will beep every 9 hits, as 9 hits usually signifies a KO with a normal toolbox
+Arguments
+
+
target - the atom we're hitting
+
+
+
+
diff --git a/obj/item/traitor_bug.html b/obj/item/traitor_bug.html
new file mode 100644
index 000000000000..d325cabffbc4
--- /dev/null
+++ b/obj/item/traitor_bug.html
@@ -0,0 +1,57 @@
+
+
+
+
+
+
+ /obj/item/traitor_bug - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Item that accepts the assembly for the internals and helps link/activate it.
+This base type is an empty shell that needs the assembly added to it first to work.
+
+
+
diff --git a/obj/item/turret_control.html b/obj/item/turret_control.html
new file mode 100644
index 000000000000..60f2acb976f1
--- /dev/null
+++ b/obj/item/turret_control.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /obj/item/turret_control - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Abstract item that is held in nullspace and manages reagents. Created by udder component.
+While perhaps reagents created by udder component COULD be managed in the mob, it would be somewhat finnicky and I actually like the abstract udders.
Proc called on creation separate from the reagent datum creation to allow for signalled milk generation instead of processing milk generation
+also useful for changing initial amounts in reagent holder (cows start with milk, gutlunches start empty)
Proc called every 2 seconds from SSMobs to add whatever reagent the udder is generating.
initial_conditions
+
+
Proc called on creation separate from the reagent datum creation to allow for signalled milk generation instead of processing milk generation
+also useful for changing initial amounts in reagent holder (cows start with milk, gutlunches start empty)
milk
+
+
Proc called from attacking the component parent with the correct item, moves reagents into the glass basically.
+
Arguments:
+
+
obj/item/reagent_containers/glass/milk_holder - what we are trying to transfer the reagents to
+
mob/user - who is trying to do this
+
+
+
+
diff --git a/obj/item/uplink.html b/obj/item/uplink.html
new file mode 100644
index 000000000000..27d39987a482
--- /dev/null
+++ b/obj/item/uplink.html
@@ -0,0 +1,38 @@
+
+
+
+
+
+
+ /obj/item/uplink - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Machines in the world, such as computers, pipes, and airlocks.
+
Overview:
+Used to create objects that need a per step proc call. Default definition of 'Initialize()'
+stores a reference to src machine in global 'machines list'. Default definition
+of 'Destroy' removes reference to src machine in global 'machines list'.
+
Class Variables:
+use_power (num)
+current state of auto power use.
+Possible Values:
+NO_POWER_USE -- no auto power use
+IDLE_POWER_USE -- machine is using power at its idle power level
+ACTIVE_POWER_USE -- machine is using power at its active power level
+
active_power_usage (num)
+Value for the amount of power to use when in active power mode
+
idle_power_usage (num)
+Value for the amount of power to use when in idle power mode
+
power_channel (num)
+What channel to draw from when drawing power for power mode
+Possible Values:
+AREA_USAGE_EQUIP:1 -- Equipment Channel
+AREA_USAGE_LIGHT:2 -- Lighting Channel
+AREA_USAGE_ENVIRON:3 -- Environment Channel
+
component_parts (list)
+A list of component parts of machine used by frame based machines.
+
stat (bitflag)
+Machine status bit flags.
+Possible bit flags:
+BROKEN -- Machine is broken
+NOPOWER -- No power is being supplied to machine.
+MAINT -- machine is currently under going maintenance.
+EMPED -- temporary broken by EMP pulse
+
Class Procs:
+Initialize()
+
Destroy()
+
update_mode_power_usage()
+ updates the static_power_usage var of this machine and makes its static power usage from its area accurate.
+ called after the idle or active power usage has been changed.
+
+update_power_channel()
+ updates the static_power_usage var of this machine and makes its static power usage from its area accurate.
+ called after the power_channel var has been changed or called to change the var itself.
+
+unset_static_power()
+ completely removes the current static power usage of this machine from its area.
+ used in the other power updating procs to then readd the correct power usage.
+
+
+ Default definition uses 'use_power', 'power_channel', 'active_power_usage',
+ 'idle_power_usage', 'powered()', and 'use_power()' implement behavior.
+
+
powered(chan = -1) 'modules/power/power.dm'
+Checks to see if area that contains the object has power available for power
+channel given in 'chan'. -1 defaults to power_channel
+
use_power(amount, chan=-1) 'modules/power/power.dm'
+Deducts 'amount' from the power channel 'chan' of the area that contains the object.
+
power_change() 'modules/power/power.dm'
+Called by the area that contains the object when ever that area under goes a
+power state change (area runs out of power, or area channel is turned off).
+
RefreshParts() 'game/machinery/machine.dm'
+Called to refresh the variables in the machine that are contributed to by parts
+contained in the component_parts list. (example: glass and material amounts for
+the autolathe)
+
Default definition does nothing.
+
+
process() 'game/machinery/machine.dm'
+Called by the 'machinery subsystem' once per machinery tick for each machine that is listed in its 'machines' list.
+
process_atmos()
+Called by the 'air subsystem' once per atmos tick for each machine that is listed in its 'atmos_machines' list.
+Compiled by Aygar
What subsystem this machine will use, which is generally SSmachines or SSfastprocess. By default all machinery use SSmachines. This fires a machine's process() roughly every 2 seconds.
Attempt to locate a network jack on the same tile and link to it, unlinking from any existing terminal.
+Passes through the return code from [/obj/machinery/power/data_terminal/proc/connect_machine()]
Send a signal from a ref. Data sent in signals must be dereferenced.
+If you're sending a forged source address (You should have a good reason for this...) set `preserve_s_addr = TRUE
proc to call when the machine stops requiring power after a duration of requiring power
+saves memory by removing the power relationship with its area if it exists and loses area sensitivity
+does not affect power usage itself
proc to call when the machine starts to require power after a duration of not requiring power
+sets up power related connections to its area if it exists and becomes area sensitive
+does not affect power usage itself
Spawns a frame where this machine is. If the machine was not disassmbled, the
+frame is spawned damaged. If the frame couldn't exist on this turf, it's smashed
+down to metal sheets.
sets the power_usage linked to the specified use_power_mode to new_usage
+e.g. update_mode_power_usage(ACTIVE_POWER_USE, 10) sets active_power_use = 10 and updates its power draw from the machines area if use_power == ACTIVE_POWER_USE
What subsystem this machine will use, which is generally SSmachines or SSfastprocess. By default all machinery use SSmachines. This fires a machine's process() roughly every 2 seconds.
Proc Details
AI_notify_hack
+
+
Alerts the AI that a hack is in progress.
+
Sends all AIs a message that a hack is occurring. Specifically used for space ninja tampering as this proc was originally in the ninja files.
+However, the proc may also be used elsewhere.
begin_processing
+
+
Helper proc for telling a machine to start processing with the subsystem type that is located in its subsystem_type var.
create_signal
+
+
A wrapper to generate basic, minimally-compliant data packets easily.
+Returns a datum/signal with prefilled s_addr and d_addr added to datagram
directly_use_power
+
+
An alternative to 'use_power', this proc directly costs the APC in direct charge, as opposed to being calculated periodically.
+
+
Amount: How much power the APC's cell is to be costed.
+
disk_copy
+
+
Copy data from the internal disk to an inserted one or visa-versa.
dump_contents
+
+
Drop every movable atom in the machine's contents list, including any components and circuit.
dump_inventory_contents
+
+
Drop every movable atom in the machine's contents list that is not a component_part.
+
Proc does not drop components and will skip over anything in the component_parts list.
+Call dump_contents() to drop all contents including components.
+Arguments:
+
+
subset - If this is not null, only atoms that are also contained within the subset list will be dropped.
+
eject_disk
+
+
Eject an inserted disk. Pass a user to put the disk in their hands.
end_processing
+
+
Helper proc for telling a machine to stop processing with the subsystem type that is located in its subsystem_type var.
link_to_jack
+
+
Attempt to locate a network jack on the same tile and link to it, unlinking from any existing terminal.
+Passes through the return code from [/obj/machinery/power/data_terminal/proc/connect_machine()]
on_set_is_operational
+
+
Called when the value of is_operational changes, so we can react to it.
on_set_machine_stat
+
+
Called when the value of machine_stat changes, so we can react to it.
open_machine
+
+
Opens the machine.
+
Will update the machine icon and any user interfaces currently open.
+Arguments:
+
+
drop - Boolean. Whether to drop any stored items in the machine. Does not include components.
+
post_signal
+
+
Send a signal from a ref. Data sent in signals must be dereferenced.
+If you're sending a forged source address (You should have a good reason for this...) set `preserve_s_addr = TRUE
+
NONE OF THE ABOVE IS TRUE IF YOU ARE machinery/power, AS THEY DEAL DIRECTLY WITH SSPACKETS INSTEAD OF ABSTRACTED TERMINALS
power_change
+
+
Called whenever the power settings of the containing area change
+
by default, check equipment channel & set flag, can override if needed
+
Returns TRUE if the NOPOWER flag was toggled
remove_area_power_relationship
+
+
proc to call when the machine stops requiring power after a duration of requiring power
+saves memory by removing the power relationship with its area if it exists and loses area sensitivity
+does not affect power usage itself
set_is_operational
+
+
Called when we want to change the value of the is_operational variable. Boolean.
set_machine_stat
+
+
Called when we want to change the value of the machine_stat variable. Holds bitflags.
setup_area_power_relationship
+
+
proc to call when the machine starts to require power after a duration of not requiring power
+sets up power related connections to its area if it exists and becomes area sensitive
+does not affect power usage itself
spawn_frame
+
+
Spawns a frame where this machine is. If the machine was not disassmbled, the
+frame is spawned damaged. If the frame couldn't exist on this turf, it's smashed
+down to metal sheets.
+
Arguments:
+
+
disassembled - If FALSE, the machine was destroyed instead of disassembled and the frame spawns at reduced integrity.
+
toggle_disk
+
+
Toggle the selected disk between internal and inserted.
try_put_in_hand
+
+
Puts passed object in to user's hand
+
Puts the passed object in to the users hand if they are adjacent.
+If the user is not adjacent then place the object on top of the machine.
+
Vars:
+
+
object (obj) The object to be moved in to the users hand.
+
user (mob/living) The user to recive the object
+
unlink_from_jack
+
+
Unlink from a network terminal
+ignore_check is used as part of machinery destroy.
unset_static_power
+
+
internal proc that removes all static power usage from the current area
update_current_power_usage
+
+
makes this machine draw power from its area according to which use_power mode it is set to
update_mode_power_usage
+
+
sets the power_usage linked to the specified use_power_mode to new_usage
+e.g. update_mode_power_usage(ACTIVE_POWER_USE, 10) sets active_power_use = 10 and updates its power draw from the machines area if use_power == ACTIVE_POWER_USE
+
Arguments:
+
+
use_power_mode - the use_power power mode to change. if IDLE_POWER_USE changes idle_power_usage, ACTIVE_POWER_USE changes active_power_usage
+
new_usage - the new value to set the specified power mode var to
+
update_power_channel
+
+
updates the power channel this machine uses. removes the static power usage from the old channel and readds it to the new channel
update_use_power
+
+
updates the use_power var for this machine and updates its static power usage from its area to reflect the new value
use_power_from_net
+
+
Attempts to draw power directly from the APC's Powernet rather than the APC's battery. For high-draw machines, like the cell charger
+
Checks the surplus power on the APC's powernet, and compares to the requested amount. If the requested amount is available, this proc
+will add the amount to the APC's usage and return that amount. Otherwise, this proc will return FALSE.
+If the take_any var arg is set to true, this proc will use and return any surplus that is under the requested amount, assuming that
+the surplus is above zero.
+Args:
+
+
amount, the amount of power requested from the Powernet. In standard loosely-defined SS13 power units.
+
take_any, a bool of whether any amount of power is acceptable, instead of all or nothing. Defaults to FALSE
main proc for throwing a shitfit if the air isnt right.
+goes into warning mode if gas parameters are beyond the tlv warning bounds, goes into hazard mode if gas parameters are beyond tlv hazard bounds
main proc for throwing a shitfit if the air isnt right.
+goes into warning mode if gas parameters are beyond the tlv warning bounds, goes into hazard mode if gas parameters are beyond tlv hazard bounds
check if the color are the same on both sides or if one of the pipes are grey or have the PIPING_ALL_COLORS flag
+returns TRUE if one of the parameters is TRUE
+Arguments:
check if the piping layer are the same on both sides or one of them has the PIPING_ALL_LAYER flag
+returns TRUE if one of the parameters is TRUE
+called by is_connectable()
+Arguments:
check if the initialized direction are the same on both sides (or if is a multiz adapter)
+returns TRUE or FALSE if the connection is possible or not
+Arguments:
Find a connecting /obj/machinery/atmospherics in specified direction, called by relaymove()
+used by ventcrawling mobs to check if they can move inside a pipe in a specific direction
+Arguments:
check if the piping layer and color are the same on both sides (grey can connect to all colors)
+returns TRUE or FALSE if the connection is possible or not
+Arguments:
Similar to set_pipenet() but instead of setting a network to a pipeline, it replaces the old pipeline with a new one, called by Merge() in datum_pipeline.dm
Called by add_machinery_member() in datum_pipeline.dm, returns a list of gas_mixtures and assigns them into other_airs (by addMachineryMember) to allow pressure redistribution for the machineries.
The bitflag that's being checked on ventcrawling. Default is to allow ventcrawling and seeing pipes.
Proc Details
atmos_init
+
+
Initialize for atmos devices
+
initialize the nodes for each pipe/device, this is called just after the air controller sets up turfs
+Arguments:
+
+
list/node_connects - a list of the nodes on the device that can make a connection to other machines
+
can_be_node
+
+
Check if a node can actually exists by connecting to another machine
+called on atmos_init()
+Arguments:
+
+
obj/machinery/atmospherics/target - the machine we are connecting to
+
iteration - the current node we are checking (from 1 to 4)
+
can_see_pipes
+
+
Used for certain children of obj/machinery/atmospherics to not show pipe vision when mob is inside it.
can_unwrench
+
+
Getter for can_unwrench
+
Called by wrench_act() to check if the device can be unwrenched, each device override this with custom code (like if on/operating can't unwrench)
+Arguments:
+
+
mob/user - the mob doing the act
+
check_connectable_color
+
+
check if the color are the same on both sides or if one of the pipes are grey or have the PIPING_ALL_COLORS flag
+returns TRUE if one of the parameters is TRUE
+Arguments:
+
+
obj/machinery/atmospherics/target - the machinery we want to connect to
+
check_connectable_layer
+
+
check if the piping layer are the same on both sides or one of them has the PIPING_ALL_LAYER flag
+returns TRUE if one of the parameters is TRUE
+called by is_connectable()
+Arguments:
+
+
obj/machinery/atmospherics/target - the machinery we want to connect to
+
given_layer - the piping_layer we are connecting to
+
check_init_directions
+
+
check if the initialized direction are the same on both sides (or if is a multiz adapter)
+returns TRUE or FALSE if the connection is possible or not
+Arguments:
+
+
obj/machinery/atmospherics/target - the machinery we want to connect to
+
connection_check
+
+
Check the connection between two nodes
+
Check if our machine and the target machine are connectable by both calling isConnectable and by checking that the directions and piping_layer are compatible
+called by can_be_node() (for building a network) and find_connecting() (for ventcrawling)
+Arguments:
+
+
obj/machinery/atmospherics/target - the machinery we want to connect to
+
given_layer - the piping_layer we are checking
+
deconstruct
+
+
Pipe deconstruction
+
Called by wrench_act(), create a pipe fitting and remove the pipe
destroy_network
+
+
Called by the machinery disconnect(), custom for each type
disconnect
+
+
Disconnects the nodes
+
Called by nullify_node(), it disconnects two nodes by removing the reference id from the node itself that called this proc
+Arguments:
+
+
obj/machinery/atmospherics/reference - the machinery we are removing from the node connection
+
find_connecting
+
+
Find a connecting /obj/machinery/atmospherics in specified direction, called by relaymove()
+used by ventcrawling mobs to check if they can move inside a pipe in a specific direction
+Arguments:
+
+
direction - the direction we are checking against
+
prompted_layer - the piping_layer we are inside
+
get_init_directions
+
+
Getter of initial directions
get_node_connects
+
+
Getter for node_connects
+
Return a list of the nodes that can connect to other machines, get called by atmos_init()
get_pipe_image
+
+
Getter for piping layer shifted, pipe colored overlays
+
Creates the image for the pipe underlay that all components use, called by get_pipe_underlay() in components_base.dm
+Arguments:
+
+
iconfile - path of the iconstate we are using (ex: 'icons/obj/atmospherics/components/thermomachine.dmi')
+
iconstate - the image we are using inside the file
+
direction - the direction of our device
+
color - the color (in hex value, like #559900) that the pipe should have
+
piping_layer - the piping_layer the device is in, used inside PIPING_LAYER_SHIFT
+
trinary - if TRUE we also use PIPING_FORWARD_SHIFT on layer 1 and 5 for trinary devices (filters and mixers)
+
get_rebuild_targets
+
+
Returns a list of new pipelines that need to be built up
is_connectable
+
+
check if the piping layer and color are the same on both sides (grey can connect to all colors)
+returns TRUE or FALSE if the connection is possible or not
+Arguments:
+
+
obj/machinery/atmospherics/target - the machinery we want to connect to
+
given_layer - the piping_layer we are connecting to
+
normalize_cardinal_directions
+
+
Setter for device direction
+
Set the direction to either SOUTH or WEST if the pipe_flag is set to PIPING_CARDINAL_AUTONORMALIZE, called in New(), used mostly by layer manifolds
nullify_node
+
+
Called on destroy(mostly deconstruction) and when moving nodes around, disconnect the nodes from the network
+Arguments:
+
+
i - is the current iteration of the node, based on the device_type (from 1 to 4)
+
paint
+
+
Called by the RPD.dm pre_attack(), overriden by pipes.dm
+Arguments:
+
+
paint_color - color that the pipe will be painted in (colors in hex like #4f4f4f)
+
pipeline_expansion
+
+
Called on construction and when expanding the datum_pipeline, returns the nodes of the device
rebuild_pipes
+
+
This should only be called by SSzas as part of the rebuild queue.
+Handles rebuilding pipelines after init or they've been changed.
replace_pipenet
+
+
Similar to set_pipenet() but instead of setting a network to a pipeline, it replaces the old pipeline with a new one, called by Merge() in datum_pipeline.dm
return_pipenet
+
+
Called by add_member() in datum_pipeline.dm, returns the parent network the device is connected to
return_pipenet_airs
+
+
Called by add_machinery_member() in datum_pipeline.dm, returns a list of gas_mixtures and assigns them into other_airs (by addMachineryMember) to allow pressure redistribution for the machineries.
return_pipenets
+
+
Getter of a list of pipenets
+
called in relaymove() to create the image for vent crawling
set_init_directions
+
+
Set the initial directions of the device (NORTH || SOUTH || EAST || WEST), called on New()
set_pipenet
+
+
Called by build_pipeline() and add_member() in datum_pipeline.dm, set the network the device is connected to, to the datum pipeline it has reference
set_piping_layer
+
+
setter for pipe layers
+
Set the layer of the pipe that the device has to a new_layer
+Arguments:
+
+
new_layer - the layer at which we want the piping_layer to be (1 to 5)
+
shuttleRotate
+
+
Machine rotate procs
unsafe_pressure_release
+
+
Pipe pressure release calculations
+
Throws the user when they unwrench a pipe with a major difference between the internal and environmental pressure.
+Called by wrench_act() before deconstruct()
+Arguments:
+
+
mob_user - the mob doing the act
+
pressures - it can be passed on from wrench_act(), it's the pressure difference between the enviroment pressure and the pipe internal pressure
+
update_layer
+
+
Update the layer in which the pipe/device is in, that way pipes have consistent layer depending on piping_layer
When this machine is in a pipenet that is reconciling airs, this proc can add airs to the calculation.
+Can be either a list of airs or a single air mix.
We explicitly qdel pipeline when this particular pipeline
+is projected to have no member and cause GC problems.
+We have to do this because components don't qdel pipelines
+while pipes must and will happily wreck and rebuild everything
+again every time they are qdeleted.
When this machine is in a pipenet that is reconciling airs, this proc can add pipelines to the calculation.
+Can be either a list of pipenets or a single pipenet.
Called in most atmos processes and gas handling situations, update the parents pipelines of the devices connected to the source component
+This way gases won't get stuck
Called in Initialize(), set the showpipe var to true or false depending on the situation, calls update_icon()
nullify_pipenet
+
+
Called by nullify_node(), used to remove the pipeline the component is attached to
+Arguments:
+
+
-reference: the pipeline the component is attached to
+
return_airs_for_reconcilation
+
+
When this machine is in a pipenet that is reconciling airs, this proc can add airs to the calculation.
+Can be either a list of airs or a single air mix.
return_pipenet_airs
+
+
We explicitly qdel pipeline when this particular pipeline
+is projected to have no member and cause GC problems.
+We have to do this because components don't qdel pipelines
+while pipes must and will happily wreck and rebuild everything
+again every time they are qdeleted.
return_pipenets_for_reconcilation
+
+
When this machine is in a pipenet that is reconciling airs, this proc can add pipelines to the calculation.
+Can be either a list of pipenets or a single pipenet.
update_icon_nopipes
+
+
Called by update_icon(), used individually by each component to determine the icon state without the pipe in consideration
update_parents
+
+
Called in most atmos processes and gas handling situations, update the parents pipelines of the devices connected to the source component
+This way gases won't get stuck
If the temperature of the mix before the gate is lower than this, the gas will flow (if inverted, if the temperature of the mix before the gate is higher than this)
If the temperature of the mix before the gate is lower than this, the gas will flow (if inverted, if the temperature of the mix before the gate is higher than this)
+
+
+
diff --git a/obj/machinery/atmospherics/components/binary/temperature_pump.html b/obj/machinery/atmospherics/components/binary/temperature_pump.html
new file mode 100644
index 000000000000..01a4da5662b0
--- /dev/null
+++ b/obj/machinery/atmospherics/components/binary/temperature_pump.html
@@ -0,0 +1,43 @@
+
+
+
+
+
+
+ /obj/machinery/atmospherics/components/binary/temperature_pump - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Fills the tank to the maximum safe pressure.
+Safety margin is a multiplier for the cap for the purpose of this proc so it doesn't have to be filled completely.
Fills the tank to the maximum safe pressure.
+Safety margin is a multiplier for the cap for the purpose of this proc so it doesn't have to be filled completely.
merger_refresh_complete
+
+
Handles the combined gas tank for the entire merger group, only the origin tank actualy runs this.
refresh_pressure_limit
+
+
Recalculates pressure based on the current max integrity compared to original
+
+
+
diff --git a/obj/machinery/atmospherics/components/trinary.html b/obj/machinery/atmospherics/components/trinary.html
new file mode 100644
index 000000000000..d3bea351859f
--- /dev/null
+++ b/obj/machinery/atmospherics/components/trinary.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /obj/machinery/atmospherics/components/trinary - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Cryo will continue to treat people with 0 damage but existing wounds, but will sound off when damage healing is done in case doctors want to directly treat the wounds instead
Cryo will continue to treat people with 0 damage but existing wounds, but will sound off when damage healing is done in case doctors want to directly treat the wounds instead
Proc Details
contents_explosion
+
+
Take the turf the cryotube is on
+Take the air composition inside the cryotube
+
+
+
diff --git a/obj/machinery/atmospherics/components/unary/outlet_injector.html b/obj/machinery/atmospherics/components/unary/outlet_injector.html
new file mode 100644
index 000000000000..12580c656f59
--- /dev/null
+++ b/obj/machinery/atmospherics/components/unary/outlet_injector.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /obj/machinery/atmospherics/components/unary/outlet_injector - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Current UI screen. On the moment of writing this comment there were two: 'home' - main screen, and 'analyze' - info about specific reagent
Proc Details
apply_condi_style
+
+
Applies style to condiment bottle.
+
Applies props provided in "style" assuming that "container" is freshly created with no styles applied before.
+User specified name for bottle applied after this method during bottle creation,
+so container.name overwritten here for consistency rather than with some purpose in mind.
+
Arguments:
+
+
container - condiment bottle that gets style applied to it
Defines and provides list of available condiment bottle styles
+
Uses typelist() for styles storage after initialization.
+For fallback style must provide style with key (const) CONDIMASTER_STYLE_FALLBACK
+Returns list(
+ = list(
+"icon_state" = ,
+"name" = ,
+"desc" = ,
+?"generate_name" = <if truthy, autogenerates default name from reagents instead of using "name">,
+?"icon_empty" = <icon_state when empty>,
+?"fill_icon_thresholds" = <list of thresholds for reagentfillings, no tresholds if not provided or falsy>,
+?"inhand_icon_state" = <inhand icon_state, falsy - no icon, not provided - whatever is initial (currently "beer")>,
+?"lefthand_file" = <file for inhand icon for left hand, ignored if "inhand_icon_state" not provided>,
+?"righthand_file" = <same as "lefthand_file" but for right hand>,
+),
+..
+)
guess_condi_style
+
+
Provides condiment bottle style based on reagents.
+
Gets style from available by key, using last part of main reagent type (eg. "rice" for /datum/reagent/consumable/rice) as key.
+If not available returns fallback style, or null if no such thing.
+Returns list that is one of condibottle styles from /obj/machinery/chem_master/proc/get_condi_styles
replace_beaker
+
+
Handles process of moving input reagents containers in/from machine
+
When called checks for previously inserted beaker and gives it to user.
+Then, if new_beaker provided, places it into src.beaker.
+Returns boolean. TRUE if user provided (ignoring whether threre was any beaker change) and FALSE if not.
+
Arguments:
+
+
user - Mob that initialized replacement, gets previously inserted beaker if there's any
+
new_beaker - New beaker to insert. Optional
+
strip_condi_styles_to_icons
+
+
Translates styles data into UI compatible format
+
Expects to receive list of availables condiment styles in its complete format, and transforms them in simplified form with enough data to get UI going.
+Returns list(list("id" = , "className" = , "title" = ),..).
Crewmember executed code, targeted when there are no lings and untargeted when there are some
+If there was no suspected lings (aka random shots) this is just murder and counts towards killed crew
pickweights a new event, sets event var as it. it then preps the event if it needs it
+
giving a path argument will instead find that instanced datum instead of pickweighting. Used in events that follow from events.
+Arguments:
+
+
path: if we want a specific event, this is the path of the wanted one
+
gamer: person using the arcade, used in emag effects
+
gamer_skill: gaming skill of the player
+
gamer_skill_level: gaming skill level of the player
+
gamer_skill_rands: See above but for random chances, you can just look at gaming skill to see how it chalks that up
+
execute_crewmember
+
+
Crewmember executed code, targeted when there are no lings and untargeted when there are some
+If there was no suspected lings (aka random shots) this is just murder and counts towards killed crew
+
Arguments:
+
+
gamer: carbon that may need emag effects applied
+
new_settler_mood
+
+
Creates a new mood icon for each settler
+
Things that effect mood:
+
+
Pioneer count
+
Low food
+
Low parts
+
Sometimes they're just a bit happier or sadder
+Arguments:
The tag of the signal data should be the id_tag var of the atmos object. Format is chamber_role.
+Where chamber is the chamber name and role is one of "sensor", "in", and "out".
The tag of the signal data should be the id_tag var of the atmos object. Format is chamber_role.
+Where chamber is the chamber name and role is one of "sensor", "in", and "out".
+
+
+
diff --git a/obj/machinery/computer/camera_advanced.html b/obj/machinery/computer/camera_advanced.html
new file mode 100644
index 000000000000..ac36ba45fc6b
--- /dev/null
+++ b/obj/machinery/computer/camera_advanced.html
@@ -0,0 +1,73 @@
+
+
+
+
+
+
+ /obj/machinery/computer/camera_advanced - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Camera console used to control a base building drone
+
Using this console will put the user in control of a base building drone.
+The drone will appear somewhere within the allowed_area var, or if no area is specified, at the location of the console.area
+Upon interacting, the user will be granted a set of base building actions that will generally be carried out at the drone's location.
+To create a new base builder system, this class should be the only thing that needs to be subtyped.
Assoc. list ("structure_name" : count) that keeps track of the number of special structures that can't be built with an RCD, for example, tiny fans or turrets.
Assoc. list ("structure_name" : count) that keeps track of the number of special structures that can't be built with an RCD, for example, tiny fans or turrets.
Proc Details
GrantActions
+
+
Go through every action object in the construction_action list (which should be fully initialized by now) and grant it to the user.
find_spawn_spot
+
+
Find a spawn location for the eyeobj. If no allowed_area is defined, spawn ontop of the console.
populate_actions_list
+
+
Fill the construction_actios list with actions
+
Instantiate each action object that we'll be giving to users of
+this console, and put it in the actions list
restock_materials
+
+
Reload materials used by the console
+
Restocks any materials used by the base construction console.
+This might mean refilling the internal RCD (should it be initialized), or
+giving the structures list default values.
The name of the shuttle template being used as the cargo shuttle. 'supply' is default and contains critical code. Don't change this unless you know what you're doing.
The name of the shuttle template being used as the cargo shuttle. 'supply' is default and contains critical code. Don't change this unless you know what you're doing.
how many uses the console has done of toggling the emergency access
Proc Details
authenticated
+
+
Are we a silicon, OR logged in?
authenticated_as_non_silicon_captain
+
+
Are we NOT a silicon, AND we're logged in as the captain?
authenticated_as_silicon_or_captain
+
+
Are we a silicon, OR we're logged in as the captain?
can_buy_shuttles
+
+
Returns TRUE if the user can buy shuttles.
+If they cannot, returns FALSE or a string detailing why.
can_purchase_this_shuttle
+
+
Returns whether we are authorized to buy this specific shuttle.
+Does not handle prerequisite checks, as those should still show.
emergency_meeting
+
+
Call an emergency meeting
+
Comm Console wrapper for the Communications subsystem wrapper for the call_emergency_meeting world proc.
+Checks to make sure the proc can be called, and handles relevant feedback, logging and timing.
+See the SScommunications proc definition for more detail, in short, teleports the entire crew to
+the bridge for a meetup. Should only really happen during april fools.
+Arguments:
+
+
user - Mob who called the meeting
+
has_communication
+
+
Returns whether or not the communications console can communicate with the station
override_cooldown
+
+
Override the cooldown for special actions
+Used in places such as CentCom messaging back so that the crew can answer right away
where this computer expects deliveries to need to go, passed onto orders. it will see if the FIRST one exists, then try a fallback. if no fallbacks it throws an error
signal when the supply shuttle begins to spawn orders. we forget the current order preventing it from being overridden (since it's already past the point of no return on undoing the order)
where this computer expects deliveries to need to go, passed onto orders. it will see if the FIRST one exists, then try a fallback. if no fallbacks it throws an error
access required to override an order - this should be a head of staff for the department
Proc Details
finalize_department_order
+
+
signal when the supply shuttle begins to spawn orders. we forget the current order preventing it from being overridden (since it's already past the point of no return on undoing the order)
Call this proc to attempt a print. It will return false if the print failed, true otherwise, longside some ux
+Accepts a callback to call when the print "finishes"
Should we show the buttons required for changing screens?
Proc Details
attempt_print
+
+
Call this proc to attempt a print. It will return false if the print failed, true otherwise, longside some ux
+Accepts a callback to call when the print "finishes"
Is the conveyor's belt flipped? Useful mostly for conveyor belt corners. It makes the belt point in the other direction, rather than just going in reverse.
Is the conveyor's belt flipped? Useful mostly for conveyor belt corners. It makes the belt point in the other direction, rather than just going in reverse.
Updates the switch's position and last_pos variable. Useful so that the switch can properly cycle between the forwards, backwards and neutral positions.
Called when a user clicks on this switch with an open hand.
update_linked_conveyors
+
+
Updates all conveyor belts that are linked to this switch, and tells them to start processing.
update_linked_switches
+
+
Finds any switches with same id as this one, and set their position and icon to match us.
update_position
+
+
Updates the switch's position and last_pos variable. Useful so that the switch can properly cycle between the forwards, backwards and neutral positions.
Whether or not the door can be opened by hand (used for blast doors and shutters)
+If set, air zones cannot merge across the door even when it is opened.
Whether or not the door can be opened by hand (used for blast doors and shutters)
+If set, air zones cannot merge across the door even when it is opened.
Returns a string representing the type of note pinned to this airlock
+Arguments:
+
+
frame_state - The AIRLOCK_FRAME_ value, as used in update_overlays()
+
set_wires
+
+
Generates the airlock's wire layout based on the current area the airlock resides in.
+
Returns a new /datum/wires/ with the appropriate wire layout based on the airlock_wires
+of the area the airlock is in.
should_try_removing_electronics
+
+
Returns if a crowbar would remove the airlock electronics
try_remove_seal
+
+
Used when attempting to remove a seal from an airlock
+
Called when attacking an airlock with an empty hand, returns TRUE (there was a seal and we removed it, or failed to remove it)
+or FALSE (there was no seal)
+Arguments:
+
+
user - Whoever is attempting to remove the seal
+
+
+
+
diff --git a/obj/machinery/door/airlock/external.html b/obj/machinery/door/airlock/external.html
new file mode 100644
index 000000000000..15db781ce495
--- /dev/null
+++ b/obj/machinery/door/airlock/external.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /obj/machinery/door/airlock/external - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Whether or not the airlock can be opened without access from a certain direction while powered, or with bare hands from any direction while unpowered OR pressurized.
Whether or not the airlock can be opened without access from a certain direction while powered, or with bare hands from any direction while unpowered OR pressurized.
List of ckeys containing players who have recently activated the device, players on this list are prohibited from activating the device untill their residue decays.
List of ckeys containing players who have recently activated the device, players on this list are prohibited from activating the device untill their residue decays.
The power level is displayed using overlays. The current displayed power level is stored in 'powerlevel'.
+The overlay in use and the powerlevel variable must be kept in sync. A powerlevel equal to 0 means that
+no power level overlay is currently in the overlays list.
The power level is displayed using overlays. The current displayed power level is stored in 'powerlevel'.
+The overlay in use and the powerlevel variable must be kept in sync. A powerlevel equal to 0 means that
+no power level overlay is currently in the overlays list.
Our home area, set in Init. Due to loading step order, this seems to be null very early in the server setup process, which is why some procs use my_area? for var or list checks.
Our home area, set in Init. Due to loading step order, this seems to be null very early in the server setup process, which is why some procs use my_area? for var or list checks.
bitfield. used to turn on and off hearing sensitivity depending on if we can act on Hear() at all - meant for lowering the number of unessesary hearable atoms
associative lazylist of the form: list(mob calling us = hologram representing that mob).
+this is only populated for holopads answering calls from another holopad
Currently outgoing holocall, cannot call any other holopads unless this is null.
+creating a new holocall from us to another holopad sets this var to that holocall datum
setter for can_hear_flags. handles adding or removing the given flag on can_hear_flags and then adding hearing sensitivity or removing it depending on the final state
+this is necessary because holopads are a significant fraction of the hearable atoms on station which increases the cost of procs that iterate through hearables
+so we need holopads to not be hearable until it is needed
setter for adding/removing holocalls to this holopad. used to update the holo_calls list and can_hear_flags
+adds the given holocall if add_holocall is TRUE, removes if FALSE
bitfield. used to turn on and off hearing sensitivity depending on if we can act on Hear() at all - meant for lowering the number of unessesary hearable atoms
associative lazylist of the form: list(mob calling us = hologram representing that mob).
+this is only populated for holopads answering calls from another holopad
Currently outgoing holocall, cannot call any other holopads unless this is null.
+creating a new holocall from us to another holopad sets this var to that holocall datum
For pads in secure areas; do not allow forced connecting
Proc Details
callee_hung_up
+
+
Called by holocall to inform outgoing_call that the call is terminated.
callee_picked_up
+
+
Called by holocall to inform outgoing_call that the receiver picked up.
hangup_all_calls
+
+
hangup_all_calls: Disconnects all current holocalls from the holopad
set_can_hear_flags
+
+
setter for can_hear_flags. handles adding or removing the given flag on can_hear_flags and then adding hearing sensitivity or removing it depending on the final state
+this is necessary because holopads are a significant fraction of the hearable atoms on station which increases the cost of procs that iterate through hearables
+so we need holopads to not be hearable until it is needed
+
+
flag - one of the can_hear_flags flag defines
+
set_flag - boolean, if TRUE sets can_hear_flags to that flag and might add hearing sensitivity if can_hear_flags was NONE before,
+if FALSE unsets the flag and possibly removes hearing sensitivity
+
set_holocall
+
+
setter for adding/removing holocalls to this holopad. used to update the holo_calls list and can_hear_flags
+adds the given holocall if add_holocall is TRUE, removes if FALSE
+
+
+
diff --git a/obj/machinery/holopad/tutorial.html b/obj/machinery/holopad/tutorial.html
new file mode 100644
index 000000000000..051fafe75de3
--- /dev/null
+++ b/obj/machinery/holopad/tutorial.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /obj/machinery/holopad/tutorial - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
This is NOW the gradual affects that each chemical applies on every process() proc. Nutrients now use a more robust reagent holder in order to apply less insane
+stat changes as opposed to 271 lines of individual statline effects. Shoutout to the original comments on chems, I just cleaned a few up.
Plant Cross-Pollination.
+Checks all plants in the tray's oview range, then averages out the seed's potency, instability, and yield values.
+If the seed's instability is >= 20, the seed donates one of it's reagents to that nearby plant.
Update Tray Proc
+Handles plant harvesting on the tray side, by clearing the sead, names, description, and dead stat.
+Shuts off autogrow if enabled.
+Sends messages to the cleaer about plants harvested, or if nothing was harvested at all.
Adjust Pests.
+Raises the tray's pest level stat by a given amount.
+
+
adjustamt - Determines how much the pest level will be adjusted upwards or downwards.
+
adjust_plant_health
+
+
Adjust Health.
+Raises the tray's plant_health stat by a given amount, with total health determined by the seed's endurance.
+
+
adjustamt - Determines how much the plant_health will be adjusted upwards or downwards.
+
adjust_toxic
+
+
Adjust toxicity.
+Raises the plant's toxic stat by a given amount.
+
+
adjustamt - Determines how much the toxic will be adjusted upwards or downwards.
+
adjust_waterlevel
+
+
Adjust water.
+Raises or lowers tray water values by a set value. Adding water will dillute toxicity from the tray.
+
+
adjustamt - determines how much water the tray will be adjusted upwards or downwards.
+
adjust_weedlevel
+
+
Adjust Weeds.
+Raises the plant's weed level stat by a given amount.
+
+
adjustamt - Determines how much the weed level will be adjusted upwards or downwards.
+
after_mutation
+
+
Called after plant mutation, update the appearance of the tray content and send a visible_message()
apply_chemicals
+
+
This is NOW the gradual affects that each chemical applies on every process() proc. Nutrients now use a more robust reagent holder in order to apply less insane
+stat changes as opposed to 271 lines of individual statline effects. Shoutout to the original comments on chems, I just cleaned a few up.
mutation_roll
+
+
Contains the reagents within the tray.
plantdies
+
+
Plant Death Proc.
+Cleans up various stats for the plant upon death, including pests, harvestability, and plant health.
pollinate
+
+
Plant Cross-Pollination.
+Checks all plants in the tray's oview range, then averages out the seed's potency, instability, and yield values.
+If the seed's instability is >= 20, the seed donates one of it's reagents to that nearby plant.
+
+
Range - The Oview range of trays to which to look for plants to donate reagents.
+
set_seed
+
+
Sets a new value for the myseed variable, which is the seed of the plant that's growing inside the tray.
spawnplant
+
+
Spawn Plant.
+Upon using strange reagent on a tray, it will spawn a killer tomato or killer tree at random.
update_tray
+
+
Update Tray Proc
+Handles plant harvesting on the tray side, by clearing the sead, names, description, and dead stat.
+Shuts off autogrow if enabled.
+Sends messages to the cleaer about plants harvested, or if nothing was harvested at all.
+
+
User - The mob who clears the tray.
+
weedinvasion
+
+
What happens when a tray's weeds grow too large.
+Plants a new weed in an empty tray, then resets the tray.
Performs the teleport.
+sending - TRUE/FALSE depending on if the launch pad is teleporting to or from the target.
+alternate_log_name - An alternative name to use in logs, if user is not present..
Performs the teleport.
+sending - TRUE/FALSE depending on if the launch pad is teleporting to or from the target.
+alternate_log_name - An alternative name to use in logs, if user is not present..
+
+
+
diff --git a/obj/machinery/libraryscanner.html b/obj/machinery/libraryscanner.html
new file mode 100644
index 000000000000..a9bb16aa676c
--- /dev/null
+++ b/obj/machinery/libraryscanner.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /obj/machinery/libraryscanner - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Gets the turf in the input_dir direction adjacent to the machine, and registers signals for ATOM_ENTERED and ATOM_CREATED. Calls the pickup_item() proc when it receives these signals.
The current direction, in relation to the machine, that items will be output to.
Proc Details
pickup_item
+
+
Base proc for all /mineral subtype machines to use. Place your item pickup behavior in this proc when you override it for your specific machine.
+
Called when the COMSIG_ATOM_ENTERED signal is sent.
+
Arguments:
+
+
source - the turf that is listening for the signals.
+
target - the atom that just moved onto the source turf.
+
oldLoc - the old location that target was at before moving onto source.
+
register_input_turf
+
+
Gets the turf in the input_dir direction adjacent to the machine, and registers signals for ATOM_ENTERED and ATOM_CREATED. Calls the pickup_item() proc when it receives these signals.
unload_mineral
+
+
Generic unloading proc. Takes an atom as an argument and forceMove's it to the turf adjacent to this machine in the output_dir direction.
unregister_input_turf
+
+
Unregisters signals that are registered the machine's input turf, if it has one.
+
+
+
diff --git a/obj/machinery/mineral/labor_claim_console.html b/obj/machinery/mineral/labor_claim_console.html
new file mode 100644
index 000000000000..c5324584e0fc
--- /dev/null
+++ b/obj/machinery/mineral/labor_claim_console.html
@@ -0,0 +1,50 @@
+
+
+
+
+
+
+ /obj/machinery/mineral/labor_claim_console - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Variable that holds a timer which is used for callbacks to send_console_message(). Used for preventing multiple calls to this proc while the ORM is eating a stack of ores.
Variable that holds a timer which is used for callbacks to send_console_message(). Used for preventing multiple calls to this proc while the ORM is eating a stack of ores.
+
+
+
diff --git a/obj/machinery/mineral/processing_unit.html b/obj/machinery/mineral/processing_unit.html
new file mode 100644
index 000000000000..a75d4be25ba9
--- /dev/null
+++ b/obj/machinery/mineral/processing_unit.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /obj/machinery/mineral/processing_unit - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
This sorts through the current list of bounties, and confirms that the intended request found is correct.
+Then, adds the current user to the list of applicants to that bounty.
This takes a held photograph, and updates the current_image variable with that of the held photograph's image.
+*user: The mob who is being checked for a held photo object.
This creates a new bounty to the global list of bounty requests, alongisde the provided value of the request, and the owner of the request.
+For more info, see datum/station_request.
Performs a series of sanity checks before giving the user confirmation to create a new feed_channel using channel_name, and channel_desc.
+*channel_locked: This variable determines if other users than the author can make comments and new feed_stories on this channel.
Constructs a comment to attach to the currently selected feed_message of choice, assuming that a user can be found and that a message body has been written.
Creates a new feed story to the global newscaster network.
+Verifies that the message is being written to a real feed_channel, then provides a text input for the feed story to be written into.
+Finally, it submits the message to the network, is logged globally, and clears all message-specific variables from the machine.
This proc removes a station_request from the global list of requests, after checking that the owner of that request is the one who is trying to remove it.
This pays out the current request_target the amount held by the active request's assigned value, and then clears the active request from the global list.
This takes all current feed stories and messages, and prints them onto a newspaper, after checking that the newscaster has been loaded with paper.
+The newscaster then prints the paper to the floor.
This proc performs checks before enabling the creating_channel var on the newscaster, such as preventing a user from having multiple channels,
+preventing an un-ID'd user from making a channel, and preventing censored authors from making a channel.
+Otherwise, sets creating_channel to TRUE.
Selects a currently held photo from the user's hand and makes it the current_image held by the newscaster.
+If a photo is still held in the newscaster, it will otherwise clear it from the machine.
Is the current user editing or viewing a new wanted issue at the moment?
Proc Details
apply_to_bounty
+
+
This sorts through the current list of bounties, and confirms that the intended request found is correct.
+Then, adds the current user to the list of applicants to that bounty.
attach_photo
+
+
This takes a held photograph, and updates the current_image variable with that of the held photograph's image.
+*user: The mob who is being checked for a held photo object.
create_bounty
+
+
This creates a new bounty to the global list of bounty requests, alongisde the provided value of the request, and the owner of the request.
+For more info, see datum/station_request.
create_channel
+
+
Performs a series of sanity checks before giving the user confirmation to create a new feed_channel using channel_name, and channel_desc.
+*channel_locked: This variable determines if other users than the author can make comments and new feed_stories on this channel.
create_comment
+
+
Constructs a comment to attach to the currently selected feed_message of choice, assuming that a user can be found and that a message body has been written.
create_story
+
+
Creates a new feed story to the global newscaster network.
+Verifies that the message is being written to a real feed_channel, then provides a text input for the feed story to be written into.
+Finally, it submits the message to the network, is logged globally, and clears all message-specific variables from the machine.
delete_bounty_request
+
+
This proc removes a station_request from the global list of requests, after checking that the owner of that request is the one who is trying to remove it.
news_alert
+
+
When a new feed message is made that will alert all newscasters, this causes the newscasters to sent out a spoken message as well as create a sound.
pay_applicant
+
+
This pays out the current request_target the amount held by the active request's assigned value, and then clears the active request from the global list.
print_paper
+
+
This takes all current feed stories and messages, and prints them onto a newspaper, after checking that the newscaster has been loaded with paper.
+The newscaster then prints the paper to the floor.
remove_alert
+
+
This clears alerts on the newscaster from a new message being published and updates the newscaster's appearance.
send_photo_data
+
+
Sends photo data to build the newscaster article.
start_create_channel
+
+
This proc performs checks before enabling the creating_channel var on the newscaster, such as preventing a user from having multiple channels,
+preventing an un-ID'd user from making a channel, and preventing censored authors from making a channel.
+Otherwise, sets creating_channel to TRUE.
toggle_photo
+
+
Selects a currently held photo from the user's hand and makes it the current_image held by the newscaster.
+If a photo is still held in the newscaster, it will otherwise clear it from the machine.
Set to a region define (REGION_SECURITY for example) to create a departmental variant, limited to departmental options. If null, this is unrestricted.
Proc Details
eject_id_card
+
+
Eject the stored ID card into the user's hands if possible, otherwise on the floor.
+
Arguments:
+
+
user - The user to try and eject the ID card into the hands of.
+
eject_pda
+
+
Eject the stored PDA into the user's hands if possible, otherwise on the floor.
+
Arguments:
+
+
user - The user to try and eject the PDA into the hands of.
+
insert_id_card
+
+
Insert an ID card into the machine.
+
Will swap ID cards if one is already inside. Attempts to put the card into the user's hands if possible.
+Returns TRUE on success, FALSE otherwise.
+Arguments:
+
+
new_id_card - The ID card to insert.
+
user - The user to try and eject the PDA into the hands of.
+
insert_pda
+
+
Insert a PDA into the machine.
+
Will swap PDAs if one is already inside. Attempts to put the PDA into the user's hands if possible.
+Returns TRUE on success, FALSE otherwise.
+Arguments:
+
+
new_pda - The PDA to insert.
+
user - The user to try and eject the PDA into the hands of.
A reference to the toner cartridge that's inserted into the copier. Null if there is no cartridge.
Proc Details
check_ass
+
+
Checks the living mob ass exists and its location is the same as the photocopier.
+
Returns FALSE if ass doesn't exist or is not at the copier's location. Returns TRUE otherwise.
copier_blocked
+
+
Checks if the copier is deleted, or has something dense at its location. Called in MouseDroppedOn()
copier_empty
+
+
Checks if there is an item inserted into the copier or a mob sitting on top of it.
+
Return FALSE is the copier has something inside of it. Returns TRUE if it doesn't.
do_copy_loop
+
+
Will invoke the passed in copy_cb callback in 1 second intervals, and charge the user 5 credits for each copy made.
+
Arguments:
+
+
copy_cb - a callback for which proc to call. Should only be one of the make_x_copy() procs, such as make_paper_copy().
+
user - the mob who clicked copy.
+
do_insertion
+
+
Inserts the item into the copier. Called in attackby() after a human mob clicked on the copier with a paper, photo, or document.
+
Arugments:
+
+
object - the object that got inserted.
+
user - the mob that inserted the object.
+
give_pixel_offset
+
+
Gives items a random x and y pixel offset, between -10 and 10 for each.
+
This is done that when someone prints multiple papers, we dont have them all appear to be stacked in the same exact location.
+
Arguments:
+
+
copied_item - The paper, document, or photo that was just spawned on top of the printer.
+
has_enough_toner
+
+
Determines if the photocopier has enough toner to create num_copies amount of copies of the currently inserted item.
make_ass_copy
+
+
Handles the copying of an ass photo.
+
Calls check_ass() first to make sure that ass exists, among other conditions. Since this proc is called from a timer, it's possible that it was removed.
+Additionally checks that the mob has their clothes off.
make_blank_print
+
+
The procedure is called when printing a blank to write off toner consumption.
make_document_copy
+
+
Handles the copying of documents.
+
Checks first if document_copy exists. Since this proc is called from a timer, it's possible that it was removed.
make_paper_copy
+
+
Handles the copying of paper. Transfers all the text, stamps and so on from the old paper, to the copy.
+
Checks first if paper_copy exists. Since this proc is called from a timer, it's possible that it was removed.
make_photo_copy
+
+
Handles the copying of photos, which can be printed in either color or greyscale.
+
Checks first if photo_copy exists. Since this proc is called from a timer, it's possible that it was removed.
remove_photocopy
+
+
Called when someone hits the "remove item" button on the copier UI.
+
If the user is a silicon, it drops the object at the location of the copier. If the user is not a silicon, it tries to put the object in their hands first.
+Sets busy to FALSE because if the inserted item is removed, the copier should halt copying.
+
Arguments:
+
+
object - the item we're trying to remove.
+
user - the user removing the item.
+
reset_busy
+
+
Sets busy to FALSE. Created as a proc so it can be used in callbacks.
+
+
+
diff --git a/obj/machinery/pipedispenser.html b/obj/machinery/pipedispenser.html
new file mode 100644
index 000000000000..2c7f8fb6085c
--- /dev/null
+++ b/obj/machinery/pipedispenser.html
@@ -0,0 +1,50 @@
+
+
+
+
+
+
+ /obj/machinery/pipedispenser - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Holding tanks can get to zero integrity and be destroyed without other warnings due to pressure change.
+This checks for that case and removes our reference to it.
Allow the portable machine to be connected to a connector
+Arguments:
+
+
new_port - the connector that we trying to connect to
+
disconnect
+
+
Allow the portable machine to be disconnected from the connector
replace_tank
+
+
Allow the player to place a tank inside the machine.
+Arguments:
+
+
User: the player doing the act
+
close_valve: used in the canister.dm file, check if the valve is open or not
+
new_tank: the tank we are trying to put in the machine
+
unregister_holding
+
+
Holding tanks can get to zero integrity and be destroyed without other warnings due to pressure change.
+This checks for that case and removes our reference to it.
Called on Initialize(), fill the canister with the gas_type specified up to the filled level (half if 0.5, full if 1)
+Used for canisters spawned in maps and by admins
function used to check the limit of the canisters and also set the amount of damage that the canister can receive, if the heat and pressure are way higher than the limit the more damage will be done
function used to check the limit of the canisters and also set the amount of damage that the canister can receive, if the heat and pressure are way higher than the limit the more damage will be done
Window overlay showing the gas inside the canister
Proc Details
canister_break
+
+
Handle canisters disassemble, releases the gas content in the turf
create_gas
+
+
Called on Initialize(), fill the canister with the gas_type specified up to the filled level (half if 0.5, full if 1)
+Used for canisters spawned in maps and by admins
get_time_left
+
+
Getter for the amount of time left in the timer of prototype canisters
process_atmos
+
+
function used to check the limit of the canisters and also set the amount of damage that the canister can receive, if the heat and pressure are way higher than the limit the more damage will be done
set_active
+
+
Starts the timer of prototype canisters
ui_state
+
+
function used to check the limit of the canisters and also set the amount of damage that the canister can receive, if the heat and pressure are way higher than the limit the more damage will be done
function used to check the limit of the pumps and also set the amount of damage that the pump can receive, if the heat and pressure are way higher than the limit the more damage will be done
Player configurable, sets what's the release pressure
Proc Details
emp_act
+
+
function used to check the limit of the pumps and also set the amount of damage that the pump can receive, if the heat and pressure are way higher than the limit the more damage will be done
function used to check the limit of the scrubbers and also set the amount of damage that the scrubber can receive, if the heat and pressure are way higher than the limit the more damage will be done
+Called in process_atmos(), handles the scrubbing of the given gas_mixture
+Arguments:
function used to check the limit of the scrubbers and also set the amount of damage that the scrubber can receive, if the heat and pressure are way higher than the limit the more damage will be done
+Called in process_atmos(), handles the scrubbing of the given gas_mixture
+Arguments:
Offsets the object by APC_PIXEL_OFFSET (defined in apc_defines.dm) pixels in the direction we want it placed in. This allows the APC to be embedded in a wall, yet still inside an area (like mapping).
Offsets the object by APC_PIXEL_OFFSET (defined in apc_defines.dm) pixels in the direction we want it placed in. This allows the APC to be embedded in a wall, yet still inside an area (like mapping).
This is how we test to ensure that mappers use the directional subtypes of APCs, rather than use the parent and pixel-shift it themselves.
autoset
+
+
Returns the new status value for an APC channel.
+
// val 0=off, 1=off(auto) 2=on 3=on(auto)
+// on 0=off, 1=on, 2=autooff
+TODO: Make this use bitflags instead. It should take at most three lines, but it's out of scope for now.
+
Arguments:
+
+
val: The current status of the power channel.
+
+
APC_CHANNEL_OFF: The APCs channel has been manually set to off. This channel will not automatically change.
APC_CHANNEL_ON: The APCs channel has been manually set to on. This will be automatically changed only if the APC runs completely out of power or is disabled.
manual shooting? (basically you hop onto the emitter and choose the shooting direction, is very janky since you can only shoot at the 8 directions and i don't think is ever used since you can't build those)
manual shooting? (basically you hop onto the emitter and choose the shooting direction, is very janky since you can only shoot at the 8 directions and i don't think is ever used since you can't build those)
Controls how much power is produced by each collector in range - this is the main parameter for tweaking SM balance, as it basically controls how the power variable relates to the rest of the game.
Consume things that run into the supermatter from the tram. The tram calls forceMove (doesn't call Bump/ed) and not Move, and I'm afraid changing it will do something chaotic
Controls how much power is produced by each collector in range - this is the main parameter for tweaking SM balance, as it basically controls how the power variable relates to the rest of the game.
Consume things that run into the supermatter from the tram. The tram calls forceMove (doesn't call Bump/ed) and not Move, and I'm afraid changing it will do something chaotic
The explosive compressor machine used in anomaly core production.
+
Uses the standard ordnance/tank explosion scaling to compress raw anomaly cores into completed ones. The required explosion radius increases as more cores of that type are created.
Associated list of seeds, they are all weak refs. We check the len to see how many refs we have for each
Proc Details
add_seed
+
+
+
+
Add Seeds Proc.
+
+
+
Adds the seeds to the contents and to an associated list that pregenerates the data
+
+
+
needed to go to the ui handler
+
+
+
to_add - what seed are we adding?
+
+
+
taking_from - where are we taking the seed from? A mob, a bag, etc?
+
+
+
user - who is inserting the seed?
+
+
generate_seed_string
+
+
Generate seed string
+
Creates a string based of the traits of a seed. We use this string as a bucket for all
+seeds that match as well as the key the ui uses to get the seed. We also use the key
+for the data shown in the ui. Javascript parses this string to display
What path boards used to construct it should build into when dropped. Needed so we don't accidentally have them build variants with items preloaded in them.
What path boards used to construct it should build into when dropped. Needed so we don't accidentally have them build variants with items preloaded in them.
If the SSU's doors are locked closed. Can be toggled manually via the UI, but is also locked automatically when the UV decontamination sequence is running.
If the safety wire is cut/pulsed, the SSU can run the decontamination sequence while occupied by a mob. The mob will be burned during every cycle of cook().
If the SSU's doors are locked closed. Can be toggled manually via the UI, but is also locked automatically when the UV decontamination sequence is running.
If the safety wire is cut/pulsed, the SSU can run the decontamination sequence while occupied by a mob. The mob will be burned during every cycle of cook().
If the hack wire is cut/pulsed.
+Modifies effects of cook()
+
+
If FALSE, decontamination sequence will clear radiation for all atoms (and their contents) contained inside the unit, and burn any mobs inside.
+
If TRUE, decontamination sequence will delete all items contained within, and if occupied by a mob, intensifies burn damage delt. All wires will be cut at the end.
+
Proc Details
cook
+
+
UV decontamination sequence.
+Duration is determined by the uv_cycles var.
+Effects determined by the uv_super var.
+
+
If FALSE, all atoms (and their contents) contained are cleared of radiation. If a mob is inside, they are burned every cycle.
+
If TRUE, all items contained are destroyed, and burn damage applied to the mob is increased. All wires will be cut at the end.
+All atoms still inside at the end of all cycles are ejected from the unit.
+
+
+
+
diff --git a/obj/machinery/teambuilder.html b/obj/machinery/teambuilder.html
new file mode 100644
index 000000000000..39c9ad79ff4e
--- /dev/null
+++ b/obj/machinery/teambuilder.html
@@ -0,0 +1,50 @@
+
+
+
+
+
+
+ /obj/machinery/teambuilder - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
associative lazylist list of the telecomms_type of linked telecomms machines and a list of said machines.
+eg list(telecomms_type1 = list(everything linked to us with that type), telecomms_type2 = list(everything linked to us with THAT type)...)
associative lazylist list of the telecomms_type of linked telecomms machines and a list of said machines.
+eg list(telecomms_type1 = list(everything linked to us with that type), telecomms_type2 = list(everything linked to us with THAT type)...)
Far side dropped us, Perform hangup stuff and wait until the handset is returned to fully reset and be ready to accept another call
+STATE_CONNECTED -> STATE_HANGUP
Far side dropped us, Perform hangup stuff and wait until the handset is returned to fully reset and be ready to accept another call
+STATE_CONNECTED -> STATE_HANGUP
cleanup_residual_call
+
+
We are listening to the buzzer telling us to hang up.
+STATE_FARBUSY/STATE_HANGUP -> STATE_WAITING
drop_call
+
+
End call immediately
+STATE_CONNECTED(handset onhook)/STATE_ORIGINATE(handset onhook)/STATE_ANSWER(packet) -> STATE_WAITING
fuck_off_im_busy
+
+
Remote phone can't answer due to busy, do the sound and wait until the handset is returned to reset.
+STATE_ORIGINATE -> STATE_FARBUSY
get_state_render
+
+
UI
handset_statechange
+
+
Process the fact that the handset has changed states.
place_call
+
+
Register a new call
+STATE_WAITING -> STATE_ORIGINATE
recalculate_name
+
+
Recalculate our name.
receive_call
+
+
Receive the incoming call
+STATE_WAITING -> STATE_ANSWER
toggle_handset
+
+
Toggle the state of the handset.
+
+
+
diff --git a/obj/machinery/turretid.html b/obj/machinery/turretid.html
new file mode 100644
index 000000000000..bfb7d8178f96
--- /dev/null
+++ b/obj/machinery/turretid.html
@@ -0,0 +1,78 @@
+
+
+
+
+
+
+ /obj/machinery/turretid - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Builds the vending machine inventory, sets up slogans and other such misc work
+
This also sets the onstation var to:
+
+
FALSE - if the machine was maploaded on a zlevel that doesn't pass the is_station_level check
+
TRUE - all other cases
+
build_inventory
+
+
Build the inventory of the vending machine from it's product and record lists
+
This builds up a full set of /datum/data/vending_products from the product list of the vending machine type
+Arguments:
+
+
productlist - the list of products that need to be converted
+
recordlist - the list containing /datum/data/vending_product datums
+
startempty - should we set vending_product record amount from the product list (so it's prefilled at roundstart)
+
canLoadItem
+
+
Are we able to load the item passed in
+
Arguments:
+
+
I - the item being loaded
+
user - the user doing the loading
+
compartmentLoadAccessCheck
+
+
Is the passed in user allowed to load this vending machines compartments
+
Arguments:
+
+
user - mob that is doing the loading of the vending machine
+
pre_throw
+
+
A callback called before an item is tossed out
+
Override this if you need to do any special case handling
+
Arguments:
+
+
I - obj/item being thrown
+
refill_inventory
+
+
Refill our inventory from the passed in product list into the record list
+
Arguments:
+
+
productlist - list of types -> amount
+
recordlist - existing record datums
+
reset_prices
+
+
Prices of vending machines are all increased uniformly.
+Reassign the prices of the vending machine using the multiplier argument
+
This rebuilds both /datum/data/vending_products lists for premium and standard products based on their most relevant pricing values.
+Arguments:
+
+
recordlist - the list of standard product datums in the vendor to refresh their prices.
+
premiumlist - the list of premium product datums in the vendor to refresh their prices.
+
restock
+
+
Refill a vending machine from a refill canister
+
This takes the products from the refill canister and then fills the products,contraband and premium product categories
+
Arguments:
+
+
canister - the vending canister we are refilling from
+
shock
+
+
Shock the passed in user
+
This checks we have power and that the passed in prob is passed, then generates some sparks
+and calls electrocute_mob on the user
+
Arguments:
+
+
user - the user to shock
+
prb - probability the shock happens
+
speak
+
+
Speak the given message verbally
+
Checks if the machine is powered and the message exists
+
Arguments:
+
+
message - the message to speak
+
throw_impact
+
+
Crush the mob that the vending machine got thrown at
throw_item
+
+
Throw an item from our internal inventory out in front of us
+
This is called when we are hacked, it selects a random product from the records that has an amount > 0
+This item is then created and tossed out in front of us with a visible message
tilt
+
+
Tilts ontop of the atom supplied, if crit is true some extra shit can happen. Returns TRUE if it dealt damage to something.
unbuild_inventory
+
+
Given a record list, go through and and return a list of type -> amount
update_canister
+
+
Set up a refill canister that matches this machines products
+
This is used when the machine is deconstructed, so the items aren't "lost"
This is where you generate the list to store what items each access grants.
+Should be an assosciative list where the key is the access as a string and the value is the items typepath.
+You can also set it to TRUE instead of a list to allow them to purchase anything.
Check if the list of given access is allowed to purchase the given product
build_access_list
+
+
This is where you generate the list to store what items each access grants.
+Should be an assosciative list where the key is the access as a string and the value is the items typepath.
+You can also set it to TRUE instead of a list to allow them to purchase anything.
Vends an item to the user. Handles all the logic:
+Updating stock, account transactions, alerting users.
+@return -- TRUE if a valid condition was met, FALSE otherwise.
max number of items that the custom vendor can hold
Proc Details
vend_act
+
+
Vends an item to the user. Handles all the logic:
+Updating stock, account transactions, alerting users.
+@return -- TRUE if a valid condition was met, FALSE otherwise.
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 Details
Initialize
+
+
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.
This represents the item that comes out of the box and is constantly changing before the box finishes deciding. Can probably be just an /atom or /movable.
We already impacted these things, do not impact them again. Used to make sure we can pierce things we want to pierce. Lazylist, typecache style (object = TRUE) for performance.
Bitflag for things the projectile should just phase through entirely - No hitting unless direct target and [phasing_ignore_direct_target] is FALSE. Uses pass_flags flags.
On ricochet, if ricochet_auto_aim_range is nonzero, we'll consider any mobs within this range of the normal angle of incidence to home in on, higher = more auto aim
On ricochet, if nonzero, we consider all mobs within this range of our projectile at the time of ricochet to home in on like Revolver Ocelot, as governed by ricochet_auto_aim_angle
During each fire of SSprojectiles, the number of deciseconds since the last fire of SSprojectiles
+is divided by this var, and the result truncated to the next lowest integer is
+the number of times the projectile's pixel_move proc will be called.
Called when the projectile hits something
+This can either be from it bumping something,
+or it passing over a turf/being crossed and scanning that there is infact
+a valid target it needs to hit.
+This target isn't however necessarily WHAT it hits
+that is determined by process_hit and select_target.
The primary workhorse proc of projectile impacts.
+This is a RECURSIVE call - process_hit is called on the first selected target, and then repeatedly called if the projectile still hasn't been deleted.
Scan if we should hit something and hit it if we need to
+The difference between this and handling in Impact is
+In this we strictly check if we need to Impact() something in specific
+If we do, we do
+We don't even check if it got hit already - Impact() does that
+In impact there's more code for selecting WHAT to hit
+So this proc is more of checking if we should hit something at all BY having an atom cross us.
We already impacted these things, do not impact them again. Used to make sure we can pierce things we want to pierce. Lazylist, typecache style (object = TRUE) for performance.
PROJECTILE PIERCING
+* WARNING:
+* Projectile piercing MUST be done using these variables.
+* Ordinary passflags will result in can_hit_target being false unless directly clicked on - similar to projectile_phasing but without even going to process_hit.
+* The two flag variables below both use pass flags.
+* In the context of LETPASStHROW, it means the projectile will ignore things that are currently "in the air" from a throw.
+
* Also, projectiles sense hits using Bump(), and then pierce them if necessary.
+* They simply do not follow conventional movement rules.
+* NEVER flag a projectile as PHASING movement type.
+* If you so badly need to make one go through *everything*, override check_pierce() for your projectile to always return PROJECTILE_PIERCE_PHASE/HIT.
+
+
+
+
The "usual" flags of pass_flags is used in that can_hit_target ignores these unless they're specifically targeted/clicked on. This behavior entirely bypasses process_hit if triggered, rather than phasing which uses prehit_pierce() to check.
This var is multiplied by SSprojectiles.global_pixel_speed to get how many pixels
+the projectile moves during each iteration of the movement loop
+
If you want to make a fast-moving projectile, you should keep this equal to 1 and
+reduce the value of speed. If you want to make a slow-moving projectile, make
+speed a modest value like 1 and set this to a low value like 0.2.
Bitflag for things the projectile should just phase through entirely - No hitting unless direct target and [phasing_ignore_direct_target] is FALSE. Uses pass_flags flags.
On ricochet, if ricochet_auto_aim_range is nonzero, we'll consider any mobs within this range of the normal angle of incidence to home in on, higher = more auto aim
On ricochet, if nonzero, we consider all mobs within this range of our projectile at the time of ricochet to home in on like Revolver Ocelot, as governed by ricochet_auto_aim_angle
During each fire of SSprojectiles, the number of deciseconds since the last fire of SSprojectiles
+is divided by this var, and the result truncated to the next lowest integer is
+the number of times the projectile's pixel_move proc will be called.
How much we want to drop both wound_bonus and bare_wound_bonus (to a minimum of 0 for the latter) per tile, for falloff purposes
Proc Details
CanPassThrough
+
+
Projectile can pass through
+Used to not even attempt to Bump() or fail to Cross() anything we already hit.
Impact
+
+
Called when the projectile hits something
+This can either be from it bumping something,
+or it passing over a turf/being crossed and scanning that there is infact
+a valid target it needs to hit.
+This target isn't however necessarily WHAT it hits
+that is determined by process_hit and select_target.
+
Furthermore, this proc shouldn't check can_hit_target - this should only be called if can hit target is already checked.
+Also, we select_target to find what to process_hit first.
Moved
+
+
Projectile moved:
+
If not fired yet, do not do anything. Else,
+
If temporary unstoppable movement used for piercing through things we already hit (impacted list) is set, unset it.
+Scan turf we're now in for anything we can/should hit. This is useful for hitting non dense objects the user
+directly clicks on, as well as for PHASING projectiles to be able to hit things at all as they don't ever Bump().
on_entered
+
+
Projectile crossed: When something enters a projectile's tile, make sure the projectile hits it if it should be hitting it.
on_hit
+
+
Called when the projectile hits something
+
@params
+target - thing hit
+blocked - percentage of hit blocked
+pierce_hit - are we piercing through or regular hitting
prehit_pierce
+
+
Checks if we should pierce something.
+
NOT meant to be a pure proc, since this replaces prehit() which was used to do things.
+Return PROJECTILE_DELETE_WITHOUT_HITTING to delete projectile without hitting at all!
preparePixelProjectile
+
+
Aims the projectile at a target.
+
Must be passed at least one of a target or a list of click parameters.
+If only passed the click modifiers the source atom must be a mob with a client.
+
Arguments:
+
+
target: (Optional) The thing that the projectile will be aimed at.
+
source: The initial location of the projectile or the thing firing it.
+
modifiers: (Optional) A list of click parameters to apply to this operation.
+
deviation: (Optional) How the trajectory should deviate from the target in degrees.
+
+
//Spread is FORCED!
+
+
+
process_hit
+
+
The primary workhorse proc of projectile impacts.
+This is a RECURSIVE call - process_hit is called on the first selected target, and then repeatedly called if the projectile still hasn't been deleted.
+
Order of operations:
+
+
Checks if we are deleted, or if we're somehow trying to hit a null, in which case, bail out
+
Adds the thing we're hitting to impacted so we can make sure we don't doublehit
+
Checks piercing - stores this.
+Afterwards:
+Hit and delete, hit without deleting and pass through, pass through without hitting, or delete without hitting depending on result
+If we're going through without hitting, find something else to hit if possible and recurse, set unstoppable movement to true
+If we're deleting without hitting, delete and return
+Otherwise, send signal of COMSIG_PROJECTILE_PREHIT to target
+Then, hit, deleting ourselves if necessary.
+@params
+T - Turf we're on/supposedly hitting
+target - target we're hitting
+bumped - target we originally bumped. it's here to ensure that if something blocks our projectile by means of Cross() failure, we hit it
+even if it is not dense.
+hit_something - only should be set by recursive calling by this proc - tracks if we hit something already
+
+
Returns if we hit something.
scan_crossed_hit
+
+
Scan if we should hit something and hit it if we need to
+The difference between this and handling in Impact is
+In this we strictly check if we need to Impact() something in specific
+If we do, we do
+We don't even check if it got hit already - Impact() does that
+In impact there's more code for selecting WHAT to hit
+So this proc is more of checking if we should hit something at all BY having an atom cross us.
scan_moved_turf
+
+
Scans if we should hit something on the turf we just moved to if we haven't already
+
This proc is a little high in overhead but allows us to not snowflake CanPass in living and other things.
select_target
+
+
Selects a target to hit from a turf
+
@params
+T - The turf
+target - The "preferred" atom to hit, usually what we BumpedBy() first.
+bumped - used to track if something is the reason we impacted in the first place.
+If set, this atom is always treated as dense by can_hit_target.
+
Priority:
+0. Anything that is already in impacted is ignored no matter what. Furthermore, in any bracket, if the target atom parameter is in it, that's hit first.
+Furthermore, can_hit_target is always checked. This (entire proc) is PERFORMANCE OVERHEAD!! But, it shouldn't be ""too"" bad and I frankly don't have a better generic non snowflakey way that I can think of right now at 3 AM.
+FURTHERMORE, mobs/objs have a density check from can_hit_target - to hit non dense objects over a turf, you must click on them, same for mobs that usually wouldn't get hit.
+
+
Special check on what we bumped to see if it's a border object that intercepts hitting anything behind it
+
The thing originally aimed at/clicked on
+
Mobs - picks lowest buckled mob to prevent scarp piggybacking memes
+
Objs
+
Turf
+
Nothing
+
set_angle_centered
+
+
Same as set_angle, but the reflection continues from the center of the object that reflects it instead of the side
updateEmbedding
+
+
Like /obj/item/proc/updateEmbedding but for projectiles instead, call this when you want to add embedding or update the stats on the embedding element
To get around shielded modsuits & such being set off by kisses when they shouldn't, we take a page from hallucination projectiles
+and simply fake our on hit effects. This lets kisses remain incorporeal without having to make some new trait for this one niche situation.
+This fake hit only happens if we can deal damage and if we hit a living thing. Otherwise, we just do normal on hit effects.
Proc Details
harmless_on_hit
+
+
To get around shielded modsuits & such being set off by kisses when they shouldn't, we take a page from hallucination projectiles
+and simply fake our on hit effects. This lets kisses remain incorporeal without having to make some new trait for this one niche situation.
+This fake hit only happens if we can deal damage and if we hit a living thing. Otherwise, we just do normal on hit effects.
+
+
+
diff --git a/obj/projectile/magic.html b/obj/projectile/magic.html
new file mode 100644
index 000000000000..a5dd130b2125
--- /dev/null
+++ b/obj/projectile/magic.html
@@ -0,0 +1,43 @@
+
+
+
+
+
+
+ /obj/projectile/magic - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
A flower created by flowering kudzu which spawns a venus human trap after a certain amount of time has passed.
+
A flower created by kudzu with the flowering mutation. Spawns a venus human trap after 2 minutes under normal circumstances.
+Also spawns 4 vines going out in diagonal directions from the bud. Any living creature not aligned with plants is damaged by these vines.
+Once it grows a venus human trap, the bud itself will destroy itself.
Called when trying to find a new parent after our previous parent died
+Will return false if it can't find a new_parent
+Will return the new parent if it can find one
the parent node that will determine if we grow or die
Proc Details
after_parent_destroyed
+
+
Called when the parent node is destroyed
do_qdel
+
+
Called to delete the weed
find_new_parent
+
+
Called when trying to find a new parent after our previous parent died
+Will return false if it can't find a new_parent
+Will return the new parent if it can find one
set_base_icon
+
+
Randomizes the weeds' starting icon, gets redefined by children for them not to share the behavior.
try_expand
+
+
Called when the node is trying to grow/expand
+
+
+
diff --git a/obj/structure/alien/weeds/node.html b/obj/structure/alien/weeds/node.html
new file mode 100644
index 000000000000..6bc8c7e5a12d
--- /dev/null
+++ b/obj/structure/alien/weeds/node.html
@@ -0,0 +1,50 @@
+
+
+
+
+
+
+ /obj/structure/alien/weeds/node - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
base aq layer
+min_offset = this value is returned on bottom layer mode
+min_offset + 0.1 fish1
+min_offset + 0.2 fish2
+... these layers are returned for auto layer mode and tracked by used_layers
+min_offset + max_offset = this value is returned for top layer mode
+min_offset + max_offset + 1 = this is used for glass overlay
base aq layer
+min_offset = this value is returned on bottom layer mode
+min_offset + 0.1 fish1
+min_offset + 0.2 fish2
+... these layers are returned for auto layer mode and tracked by used_layers
+min_offset + max_offset = this value is returned for top layer mode
+min_offset + max_offset + 1 = this is used for glass overlay
try_to_put_mob_in
+
+
Tries to put mob pulled by the user in the aquarium after a delay
The radius inside which blobs are pulsed by this overmind. Does stuff like expanding, making blob spores from factories, make resources from nodes etc.
The radius inside which blobs are pulsed by this overmind. Does stuff like expanding, making blob spores from factories, make resources from nodes etc.
Structure that makes a big old fire. You can add rods to construct a grill for grilling meat, or a stake for buckling people to the fire,
+salem style. Keeping the fire on requires oxygen. You can dismantle the bonfire back into logs when it is unignited.
The portals Space Dragon summons to bring carp onto the station.
+
The portals Space Dragon summons to bring carp onto the station. His main objective is to summon 3 of them and protect them from being destroyed.
+The portals can summon sentient space carp in limited amounts. The portal also changes color based on whether or not a carp spawn is available.
+Once it is fully charged, it becomes indestructible, and intermitently spawns non-sentient carp. It is still destroyed if Space Dragon dies.
Used to create carp controlled by ghosts when the option is available.
+
Creates a carp for the ghost to control if we have a carp spawn available.
+Gives them prompt to control a carp, and if our circumstances still allow if when they hit yes, spawn them in as a carp.
+Also add them to the list of carps in Space Dragon's antgonist datum, so they'll be displayed as having assisted him on round end.
+Arguments:
+
+
mob/user - The ghost which will take control of the carp.
+
update_check
+
+
Does a series of checks based on the portal's status.
+
Performs a number of checks based on the current charge of the portal, and triggers various effects accordingly.
+If the current charge is a multiple of carp_interval, add an extra carp spawn.
+If we're halfway charged, announce to the crew our location in a CENTCOM announcement.
+If we're fully charged, tell the crew we are, change our color to yellow, become invulnerable, and give Space Dragon the ability to make another rift, if he hasn't summoned 3 total.
linked module. while this exists, the field will progress towards eradication. while it isn't, the field progresses away until it disappears. see attached for a special case
linked module. while this exists, the field will progress towards eradication. while it isn't, the field progresses away until it disappears. see attached for a special case
Whether a skittish person can dive inside this closet. Disable if opening the closet causes "bad things" to happen or that it leads to a logical inconsistency.
Whether a skittish person can dive inside this closet. Disable if opening the closet causes "bad things" to happen or that it leads to a logical inconsistency.
Fills this mail crate with N pieces of mail, where N is the lower of the amount var passed, and the maximum capacity of this crate. If N is larger than the number of alive human players, the excess will be junkmail.
Proc Details
populate
+
+
Fills this mail crate with N pieces of mail, where N is the lower of the amount var passed, and the maximum capacity of this crate. If N is larger than the number of alive human players, the excess will be junkmail.
The rune that created the shield itself. Used to delete the rune when the shield is destroyed.
Proc Details
Toggle
+
+
Turns the shield on and off.
+
The shield has 2 states: on and off. When on, it will block movement,projectiles, items, etc. and be clearly visible, and block atmospheric gases.
+When off, the rune no longer blocks anything and turns invisible.
+The barrier itself is not intended to interact with the conceal runes cult spell for balance purposes.
+
+
+
diff --git a/obj/structure/energy_net.html b/obj/structure/energy_net.html
new file mode 100644
index 000000000000..3aa1190da2db
--- /dev/null
+++ b/obj/structure/energy_net.html
@@ -0,0 +1,39 @@
+
+
+
+
+
+
+ /obj/structure/energy_net - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Energy net which ensnares prey until it is destroyed. Used by space ninjas.
+
Energy net which keeps its target from moving until it is destroyed. Used to send
+players to a holding area in which they could never leave, but such feature has since
+been removed.
the tram has a few objects mapped onto it at roundstart, by default many of those objects have unwanted properties
+for example grilles and windows have the atmos_sensitive element applied to them, which makes them register to
+themselves moving to re register signals onto the turf via connect_loc. this is bad and dumb since it makes the tram
+more expensive to move.
Proc Details
Initialize
+
+
the tram has a few objects mapped onto it at roundstart, by default many of those objects have unwanted properties
+for example grilles and windows have the atmos_sensitive element applied to them, which makes them register to
+themselves moving to re register signals onto the turf via connect_loc. this is bad and dumb since it makes the tram
+more expensive to move.
+
if you map something on to the tram, make SURE if possible that it doesnt have anythign reacting to its own movement
+it will make the tram more expensive to move and we dont want that because we dont want to return to the days where
+the tram took a third of the tick per movement when its just carrying its default mapped in objects
lazy list of movables inside lift_load who had their glide_size changed since our last movement.
+used so that we dont have to change the glide_size of every object every movement, which scales to cost more than you'd think
lazylist of weakrefs to the contents we have when we're first created. stored so that admins can clear the tram to its initial state
+if someone put a bunch of stuff onto it.
master datum that controls our movement. in general /industrial_lift subtypes control moving themselves, and
+/datum/lift_master instances control moving the entire tram and any behavior associated with that.
what subtype of /datum/lift_master to create for itself if no other platform on this tram has created one yet.
+very important for some behaviors since
make this tram platform multitile, expanding to cover all the tram platforms adjacent to us and deleting them. makes movement more efficient.
+the platform becoming multitile should be in the bottom left corner since thats assumed to be the loc of multitile objects
handles any special interactions objects could have with the lift/tram, handled on the item itself
+potentially finds a spot to throw the victim at for daring to be hit by a tram. is null if we havent found anything to throw
+handles any special interactions objects could have with the lift/tram, handled on the item itself
+move the movers list of movables on our tile to destination if we successfully move there first.
+this is like calling forceMove() on everything in movers and ourselves, except nothing in movers
+has destination.Entered() and origin.Exited() called on them, as only our movement can be perceived.
+none of the movers are able to react to the movement of any other mover, saving a lot of needless processing cost
+and is more sensible. without this, if you and a banana are on the same platform, when that platform moves you will slip
+on the banana even if youre not moving relative to it.
list of turfs we dont go over. if for whatever reason we encounter an already multitile lift platform
+we add all of its locs to this list so we dont add that lift platform multiple times as we iterate through its locs
+returns an unordered list of all lift platforms adjacent to us. used so our lift_master_datum can control all connected platforms.
+includes platforms directly above or below us as well. only includes platforms with an identical lift_id to our own.
signal handler for COMSIG_MOVABLE_UPDATE_GLIDE_SIZE: when a movable in lift_load changes its glide_size independently.
+adds that movable to a lazy list, movables in that list have their glide_size updated when the tram next moves
reset the contents of this lift platform to its original state in case someone put too much shit on it.
+used by an admin via calling reset_lift_contents() on our lift_master_datum.
lazy list of movables inside lift_load who had their glide_size changed since our last movement.
+used so that we dont have to change the glide_size of every object every movement, which scales to cost more than you'd think
lazylist of weakrefs to the contents we have when we're first created. stored so that admins can clear the tram to its initial state
+if someone put a bunch of stuff onto it.
master datum that controls our movement. in general /industrial_lift subtypes control moving themselves, and
+/datum/lift_master instances control moving the entire tram and any behavior associated with that.
what subtype of /datum/lift_master to create for itself if no other platform on this tram has created one yet.
+very important for some behaviors since
how many tiles this platform extends on the x axis
Proc Details
add_initial_contents
+
+
adds everything on our tile that can be added to our lift_load and initial_contents lists when we're created
check_menu
+
+
Proc to ensure that the radial menu closes when it should.
+Arguments:
+
+
user - The person that opened the menu.
+
starting_loc - The location of the lift when the menu was opened, used to prevent the menu from being interacted with after the lift was moved by someone else.
+
+
Returns:
+
+
boolean, FALSE if the menu should be closed, TRUE if the menu is clear to stay opened.
+
create_multitile_platform
+
+
make this tram platform multitile, expanding to cover all the tram platforms adjacent to us and deleting them. makes movement more efficient.
+the platform becoming multitile should be in the bottom left corner since thats assumed to be the loc of multitile objects
group_move
+
+
handles any special interactions objects could have with the lift/tram, handled on the item itself
+potentially finds a spot to throw the victim at for daring to be hit by a tram. is null if we havent found anything to throw
+handles any special interactions objects could have with the lift/tram, handled on the item itself
+move the movers list of movables on our tile to destination if we successfully move there first.
+this is like calling forceMove() on everything in movers and ourselves, except nothing in movers
+has destination.Entered() and origin.Exited() called on them, as only our movement can be perceived.
+none of the movers are able to react to the movement of any other mover, saving a lot of needless processing cost
+and is more sensible. without this, if you and a banana are on the same platform, when that platform moves you will slip
+on the banana even if youre not moving relative to it.
lift_platform_expansion
+
+
list of turfs we dont go over. if for whatever reason we encounter an already multitile lift platform
+we add all of its locs to this list so we dont add that lift platform multiple times as we iterate through its locs
+returns an unordered list of all lift platforms adjacent to us. used so our lift_master_datum can control all connected platforms.
+includes platforms directly above or below us as well. only includes platforms with an identical lift_id to our own.
on_changed_glide_size
+
+
signal handler for COMSIG_MOVABLE_UPDATE_GLIDE_SIZE: when a movable in lift_load changes its glide_size independently.
+adds that movable to a lazy list, movables in that list have their glide_size updated when the tram next moves
reset_contents
+
+
reset the contents of this lift platform to its original state in case someone put too much shit on it.
+used by an admin via calling reset_lift_contents() on our lift_master_datum.
+
Arguments:
+
+
consider_anything_past - number. if > 0 this platform will only handle foreign contents that exceed this number on each of our locs
+
foreign_objects - bool. if true this platform will consider /atom/movable's that arent mobs as part of foreign contents
+
foreign_non_player_mobs - bool. if true we consider mobs that dont have a mind to be foreign
+
consider_player_mobs - bool. if true we consider player mobs to be foreign. only works if foreign_non_player_mobs is true as well
+
set_movement_registrations
+
+
set the movement registrations to our current turf(s) so contents moving out of our tile(s) are removed from our movement lists
show_fluff_message
+
+
Shows a message indicating that the lift has moved up or down.
+Arguments:
+
+
going_up - Boolean on whether or not we're going up, to adjust the message appropriately.
+
user - The mob that caused the lift to move, for the visible message.
+
travel
+
+
main proc for moving the lift in the direction [going]. handles horizontal and/or vertical movement for multi platformed lifts and multitile lifts.
unset_movement_registrations
+
+
unset our movement registrations from turfs that no longer contain us (or every loc if turfs_to_unset is unspecified)
use
+
+
list of resolve()'d initial_contents that are still in lift_load
+list of objects we consider foreign according to the given arguments
decisecond delay between horizontal movements. cannot make the tram move faster than 1 movement per world.tick_lag. only used to give to the lift_master
decisecond delay between horizontal movements. cannot make the tram move faster than 1 movement per world.tick_lag. only used to give to the lift_master
Set by the tram control console in late initialize
Proc Details
find_dimensions
+
+
debug proc to highlight the locs of the tram platform
unlock_controls
+
+
Handles unlocking the tram controls for use after moving
+
More safety checks to make sure the tram has actually docked properly
+at a location before users are allowed to interact with the tram console again.
+Tram finds its location at this point before fully unlocking controls to the user.
This structure acts as a source of moisture loving cell lines,
+as well as a location where a hidden item can somtimes be retrieved
+at the cost of risking a vicious bite.*
weighted loot table for what loot you can find inside the moisture trap.
+the actual loot isn't that great and should probably be improved and expanded later.
weighted loot table for what loot you can find inside the moisture trap.
+the actual loot isn't that great and should probably be improved and expanded later.
Proc Details
CanReachInside
+
+
This proc checks if we are able to reach inside the trap to interact with it.
They show what's underneath their catwalk flooring (pipes and the like)
+you can screwdriver it to interact with the underneath stuff without destroying the tile...
+unless you want to!
+
+
+
diff --git a/obj/structure/plaque.html b/obj/structure/plaque.html
new file mode 100644
index 000000000000..0df5d380bb5a
--- /dev/null
+++ b/obj/structure/plaque.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+ /obj/structure/plaque - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
Custom plaque structures and items both start "unengraved", once engraved with a fountain pen their text can't be altered again. Static plaques are already engraved.
Custom plaque structures and items both start "unengraved", once engraved with a fountain pen their text can't be altered again. Static plaques are already engraved.
This frame is visually put between two wall turfs and it has an icon that's bigger than 32px, and because
+of the way it's designed, the pixel_shift variable from the wallframe item won't do.
+Also we want higher bounds so it actually covers an extra wall turf, so that it can count toward check_wall_item calls for
+that wall turf.
Proc Details
finalize_size
+
+
This frame is visually put between two wall turfs and it has an icon that's bigger than 32px, and because
+of the way it's designed, the pixel_shift variable from the wallframe item won't do.
+Also we want higher bounds so it actually covers an extra wall turf, so that it can count toward check_wall_item calls for
+that wall turf.
Machine that runs around wildly so people can practice clickin on things
+
Can have a mob buckled on or a obj/item/target attached. Movement controlled by SSFastProcess,
+movespeed controlled by cooldown macros. Can attach obj/item/target, obj/item/training_toolbox, and can buckle mobs to this.
A random spot within range that the trainer is trying to reach
Proc Details
Destroy
+
+
Called on qdel(), so we don't want a cool explosion to happen
atom_destruction
+
+
Called on a normal destruction, so we have a cool explosion and toss whatever's attached
attach_item
+
+
Attach an item to the machine
+
This proc technically works with any obj. Currently is only used for objects of type item/target and item/training_toolbox
+Will make the attached item appear visually on the machine
+Arguments
+
+
target - The object to attach
+
attackby
+
+
Called when the machien is attacked by something
+
Meant for attaching an item to the machine, should only be a training toolbox or target. If emagged, the
+machine will gain an auto-attached syndicate toolbox, so in that case we shouldn't be able to swap it out
emag_act
+
+
Emagging causes a deadly, unremovable syndicate toolbox to be attached to the machine
find_target_position
+
+
Find a suitable turf to move towards
handle_density
+
+
Make sure the machine can't be walked through if something is attached
on_attached_delete
+
+
Called when the attached item is deleted.
+
Cleans up behavior for when the attached item is deleted or removed.
process
+
+
Main movement method for the machine
+
Handles movement using SSFastProcess. Moves randomly, point-to-point, in an area centered around wherever it started.
+Will only move if the move_cooldown cooldown macro is finished.
+If it can't find a place to go, it will stop moving.
remove_attached_item
+
+
Remove the attached item from the machine
+
Called when a user removes the item by hand or by swapping it out with another, when the machine breaks, or
+when the machine is emagged.
+Arguments
+
+
user - The peson , if any, removing the attached item
+
throwing - If we should make the item fly off the machine
+
start_moving
+
+
Start the machine's movement
+
Says a message, plays a sound, then starts processing
stop_moving
+
+
Stop the machine's movement
+
Will call STOP_PROCESSING, play a sound, and say an appropriate message
+Arguments
+
+
Message - the message the machine says when stopping
+
toggle
+
+
Toggle the machine's movement
try_attack
+
+
Try to attack a nearby mob
+
Called whenever the machine moves, this will look for mobs adjacent to the machine to attack.
+Will attack with either a training toolbox (if attached), or a much more deadly syndicate toolbox (if emagged).
+A cooldown macro (attack_cooldown) ensures it doesn't attack too quickly
ui_act
+
+
Control the attached variables.
+
Will not respond if moving and emagged, so once you set it to go it can't be stopped!
ui_data
+
+
Send data to the UI
+
Include's the machine's movement range, speed, and whether or not it's active
+
+
+
diff --git a/obj/structure/trap/eldritch.html b/obj/structure/trap/eldritch.html
new file mode 100644
index 000000000000..409797a0d985
--- /dev/null
+++ b/obj/structure/trap/eldritch.html
@@ -0,0 +1,43 @@
+
+
+
+
+
+
+ /obj/structure/trap/eldritch - Daedalus Dock
+
+
+
+ Daedalus Dock -
+ Modules -
+ Types
+ — Var Details
+
+
If the driver needs a certain item in hand (or inserted, for vehicles) to drive this. For vehicles, this must be duplicated on their riding component subtype
+/datum/component/riding/var/keytype variable because only a few specific checks are handled here with this var, and the majority of it is on the riding component
+Eventually the remaining checks should be moved to the component and this var removed.
If the driver needs a certain item in hand (or inserted, for vehicles) to drive this. For vehicles, this must be duplicated on their riding component subtype
+/datum/component/riding/var/keytype variable because only a few specific checks are handled here with this var, and the majority of it is on the riding component
+Eventually the remaining checks should be moved to the component and this var removed.
This vehicle will follow us when we move (like atrailer duh)
Proc Details
generate_action_type
+
+ generate_action_type
+
A small proc to properly set up each action path.
+args:
+
+
actiontype: typepath of the action the proc sets up.
+returns created and set up action instance
+
generate_actions
+
+ generate_actions
+
You override this with initialize_passenger_action_type and initialize_controller_action_type calls
+To give passengers actions when they enter the vehicle.
+Read the documentation on the aforementioned procs to learn the difference
grant_action_type_to_mob
+
+ grant_action_type_to_mob
+
As on the tin, it does all the annoying small stuff and sanity needed
+to GRANT an action to a mob.
+args:
+
+
actiontype: typepath of the action you want to give to grant_to.
+
grant_to: the mob we're giving actiontype to
+returns TRUE if successfully granted
+
grant_passenger_actions
+
+ grant_passenger_actions
+
Called on every passenger that enters the vehicle, goes through the list of actions it needs to give...
+and does that.
+args:
+
+
grant_to: mob that needs to get every action the vehicle grants
+
initialize_controller_action_type
+
+ initialize_controller_action_type
+
Gives any passenger that enters the mech this action... IF they have the correct vehicle control flag.
+This is used so passengers cannot press buttons only drivers should have, for example.
+args:
+
+
actiontype: typepath of the action you want to give occupants.
+
initialize_passenger_action_type
+
+ initialize_passenger_action_type
+
Gives any passenger that enters the mech this action.
+They will lose it when they disembark.
+args:
+
+
actiontype: typepath of the action you want to give occupants.
+
remove_action_type_from_mob
+
+ remove_action_type_from_mob
+
As on the tin, it does all the annoying small stuff and sanity needed
+to REMOVE an action to a mob.
+args:
+
+
actiontype: typepath of the action you want to give to grant_to.
+
take_from: the mob we're taking actiontype to
+returns TRUE if successfully removed
+
remove_passenger_actions
+
+ remove_passenger_actions
+
Called on every passenger that exits the vehicle, goes through the list of actions it needs to remove...
+and does that.
+args:
+
+
take_from: mob that needs to get every action the vehicle grants
It's a teenie minature mecha... for critters!
+For the critters that cannot be understood, there is a sound creator in the mecha. It also has headlights.
Mechs are now (finally) vehicles, this means you can make them multicrew
+They can also grant select ability buttons based on occupant bitflags
+
Movement is handled through vehicle_move() which is called by relaymove
+Clicking is done by way of signals registering to the entering mob
+NOTE: MMIS are NOT mobs but instead contain a brain that is, so you need special checks
+AI also has special checks becaus it gets in and out of the mech differently
+Always call remove_occupant(mob) when leaving the mech so the mob is removed properly
+
For multi-crew, you need to set how the occupants recieve ability bitflags corresponding to their status on the vehicle(i.e: driver, gunner etc)
+Abilities can then be set to only apply for certain bitflags and are assigned as such automatically
+
Clicks are wither translated into mech_melee_attack (see mech_melee_attack.dm)
+Or are used to call action() on equipped gear
+Cooldown for gear is on the mech because exploits
Sets the direction of the mecha and all of its occcupents, required for FOV. Alternatively one could make a recursive contents registration and register topmost direction changes in the fov component
Typepath for the wreckage it spawns when destroyed
Proc Details
add_capacitor
+
+
Adds a capacitor, for use in Map-spawned mechs, Nuke Ops mechs, and admin-spawned mechs. Mechs built by hand will replace this.
add_cell
+
+
Updates the values given by scanning module and capacitor tier, called when a part is removed or inserted.
+
/// Helpers /////////
+
Adds a cell, for use in Map-spawned mechs, Nuke Ops mechs, and admin-spawned mechs. Mechs built by hand will replace this.
add_scanmod
+
+
Adds a scanning module, for use in Map-spawned mechs, Nuke Ops mechs, and admin-spawned mechs. Mechs built by hand will replace this.
ai_enter_mech
+
+
Hack and From Card interactions share some code, so leave that here for both to use.
aimob_enter_mech
+
+
Handles an actual AI (simple_animal mecha pilot) entering the mech
aimob_exit_mech
+
+
Handles an actual AI (simple_animal mecha pilot) exiting the mech
ammo_resupply
+
+
Ammo stuff
attack_ai
+
+
AI piloting
diag_hud_set_mechtracking
+
+
Shows tracking beacons on the mech
disconnect_air
+
+
Disconnects air tank- air port connection on mecha move
display_speech_bubble
+
+
Displays a special speech bubble when someone inside the mecha speaks
generate_action_type
+
+
MECHA ACTIONS
get_armour_facing
+
+
returns a number for the damage multiplier for this relative angle/dir
get_int_repair_fluff_end
+
+
gets the successful finish balloon alert flufftext
get_int_repair_fluff_fail
+
+
gets the on-fail balloon alert flufftext
get_int_repair_fluff_start
+
+
gets the starting balloon alert flufftext
has_charge
+
+
Power stuff
on_light_eater
+
+
Special light eater handling
on_mouseclick
+
+
// Action processing ////
+
Called when a driver clicks somewhere. Handles everything like equipment, punches, etc.
operation_allowed
+
+
Access stuff
play_stepsound
+
+
///// Movement procs ////////
+
Plays the mech step sound effect. Split from movement procs so that other mechs (HONK) can override this one specific part.
remove_air
+
+
Atmospheric stuff
returnPressure
+
+
fetches pressure of the gas mixture we are using
return_temperature
+
+
fetches temp of the gas mixture we are using
setDir
+
+
Sets the direction of the mecha and all of its occcupents, required for FOV. Alternatively one could make a recursive contents registration and register topmost direction changes in the fov component
try_damage_component
+
+
tries to damage mech equipment depending on damage and where is being targetted
try_deal_internal_damage
+
+
tries to deal internal damaget depending on the damage amount
try_repair_int_damage
+
+
///// Internal damage ////////
+
tries to repair any internal damage and plays fluff for it
*Checks if defense mode is enabled, and if the attacker is standing in an area covered by the shield.
+Expects a turf. Returns true if the attack should be blocked, false if not.
Relays the signal from the action button to the shield, and creates a new shield if the old one is MIA.
Proc Details
defense_check
+
+
*Checks if defense mode is enabled, and if the attacker is standing in an area covered by the shield.
+Expects a turf. Returns true if the attack should be blocked, false if not.
relay
+
+
Relays the signal from the action button to the shield, and creates a new shield if the old one is MIA.
Despite having no DM-defined static type, proc paths have some variables,
+listed below. These are not modifiable, but for a given procpath P,
+new P(null, "Name", "Desc") can be used to create a new procpath with the
+same code but new name and desc values. The other variables cannot be
+changed in this way.
+
This type exists only to act as an annotation, providing reasonable static
+typing for procpaths. Previously, types like /atom/verb were used, with
+the name and desc vars of /atom thus being accessible. Proc and verb
+paths will fail istype and ispath checks against /procpath.
Any floor or wall. What makes up the station and the rest of the map.
+If present, a turf above that is copying this turf. Implies a Z-connection and that the turf above is a z-mimic enabled turf.
+If present, the turf below that we are copying. Implies a Z-connection and that this is a z-mimic enabled turf.
+If we're a non-overwrite z-turf, this holds the appearance of the bottom-most Z-turf in the z-stack.
+Object used to multiply color of all OO overlays at once.
+If this is a delegate (non-overwrite) Z-turf with a z-turf above, this is the delegate copy that's copying us.
+If we're at the bottom of the stack, a proxy used to fake a below space turf.
+Cached computed depth, used in analyzer.
What directions this is currently smoothing with.
+This starts as null for us to know when it's first set, but after that it will hold a 8-bit mask ranging from 0 to 255.
what /mob/oranges_ear instance is already assigned to us as there should only ever be one.
+used for guaranteeing there is only one oranges_ear per turf when assigned, speeds up view() iteration
How pathing algorithm will check if this turf is passable by itself (not including content checks). By default it's just density check.
+WARNING: Currently to use a density shortcircuiting this does not support dense turfs with special allow through function
If this turf contained an RCD'able object (or IS one, for walls)
+but is now destroyed, this will preserve the value.
+See _DEFINES/construction.dm for RCD_MEMORY*.
ZAS THINGS
+NO MORE ZAS THINGS
+WARNING WARNING
+Turfs DO NOT lose their signals when they get replaced, REMEMBER THIS
+It's possible because turfs are fucked, and if you have one in a list and it's replaced with another one, the list ref points to the new turf
+We do it because moving signals over was needlessly expensive, and bloated a very commonly used bit of code
What directions this is currently smoothing with.
+This starts as null for us to know when it's first set, but after that it will hold a 8-bit mask ranging from 0 to 255.
+
IMPORTANT: This uses the smoothing direction flags as defined in icon_smoothing.dm, instead of the BYOND flags.
what /mob/oranges_ear instance is already assigned to us as there should only ever be one.
+used for guaranteeing there is only one oranges_ear per turf when assigned, speeds up view() iteration
How pathing algorithm will check if this turf is passable by itself (not including content checks). By default it's just density check.
+WARNING: Currently to use a density shortcircuiting this does not support dense turfs with special allow through function
If this turf contained an RCD'able object (or IS one, for walls)
+but is now destroyed, this will preserve the value.
+See _DEFINES/construction.dm for RCD_MEMORY*.
For seeing if we can actually move between 2 given turfs while accounting for our access and the caller's pass_flags
+
Assumes destinantion turf is non-dense - check and shortcircuit in code invoking this proc to avoid overhead.
+Makes some other assumptions, such as assuming that unless declared, non dense objects will not block movement.
+It's fragile, but this is VERY much the most expensive part of JPS, so it'd better be fast
+
Arguments:
+
+
caller: The movable, if one exists, being used for mobility checks to see what tiles it can reach
+
access: A list that decides if we can gain access to doors that would otherwise block a turf
+
simulated_only: Do we only worry about turfs with simulated atmos, most notably things that aren't space?
+
no_id: When true, doors with public access will count as impassible
+
PlaceOnBottom
+
+
Places the given turf on the bottom of the turf stack.
ScrapeAway
+
+
Take off the top layer turf and replace it with the next baseturf down
TryGetNonDenseNeighbour
+
+
I literally don't know where this proc came from.
TryScrapeToLattice
+
+
Run ScrapeAway(amount), then attempt to place lattice.
add_opacity_source
+
+
Proc to add movable sources of opacity on the turf and let it handle lighting code.
assume_air
+
+
Merges a given gas mixture with the turf's current air source.
assume_gas
+
+
Basically adjustGasWithTemp() but a turf proc.
atmos_spawn_air
+
+
Creates a gas_mixture datum with the given parameters and merges it into the turf's air source.
can_safely_remove_from_zone
+
+
EXPERIMENTAL
+Simple heuristic for determining if removing the turf from it's zone will not partition the zone (A very bad thing).
change_area
+
+
Call to move a turf from its current area to a new one
cleanup_zmimic
+
+
Cleans up Z-mimic objects for this turf. You shouldn't call this directly 99% of the time.
clear_signal_refs
+
+
ZAS THINGS
+NO MORE ZAS THINGS
+WARNING WARNING
+Turfs DO NOT lose their signals when they get replaced, REMEMBER THIS
+It's possible because turfs are fucked, and if you have one in a list and it's replaced with another one, the list ref points to the new turf
+We do it because moving signals over was needlessly expensive, and bloated a very commonly used bit of code
contains_dense_objects
+
+
Checks a turf to see if any of it's contents are dense. Is NOT recursive. See also is_blocked_turf()
create_fire
+
+
Creates a fire with firelevel (fl). If create_own_fuel is given, it will create that many units of welding fuel on the turf.
disable_zmimic
+
+
Disables Z-mimic for a turf.
enable_zmimic
+
+
Enables Z-mimic for a turf that didn't already have it enabled.
expose_reagents
+
+
Handles exposing a turf to reagents.
fromShuttleMove
+
+
Base procs
get_atmos_adjacent_turfs
+
+
Returns a list of adjacent turfs that can contain air. Returns null if none.
is_blocked_turf
+
+
Check whether the specified turf is blocked by something dense inside it with respect to a specific atom.
+
Returns truthy value TURF_BLOCKED_TURF_DENSE if the turf is blocked because the turf itself is dense.
+Returns truthy value TURF_BLOCKED_CONTENT_DENSE if one of the turf's contents is dense and would block
+a source atom's movement.
+Returns falsey value TURF_NOT_BLOCKED if the turf is not blocked.
+
Arguments:
+
+
exclude_mobs - If TRUE, ignores dense mobs on the turf.
+
source_atom - If this is not null, will check whether any contents on the turf can block this atom specifically. Also ignores itself on the turf.
+
ignore_atoms - Check will ignore any atoms in this list. Useful to prevent an atom from blocking itself on the turf.
+
is_blocked_turf_ignore_climbable
+
+
Checks whether the specified turf is blocked by something dense inside it, but ignores anything with the climbable trait
+
Works similar to is_blocked_turf(), but ignores climbables and has less options. Primarily added for jaunting checks
make_air
+
+
Initializes the turf's "air" datum to it's initial values.
on_change_area
+
+
Allows for reactions to an area change without inherently requiring change_area() be called (I hate maploading)
post_update_air_properties
+
+
The air mobility of src >> target
+The air mobility of target >> src
reachableAdjacentTurfs
+
+
Returns adjacent turfs to this turf that are reachable, in all cardinal directions
+
Arguments:
+
+
caller: The movable, if one exists, being used for mobility checks to see what tiles it can reach
+
ID: An ID card that decides if we can gain access to doors that would otherwise block a turf
+
simulated_only: Do we only worry about turfs with simulated atmos, most notably things that aren't space?
+
no_id: When true, doors with public access will count as impassible
+
recalculate_directional_opacity
+
+
Calculate on which directions this turfs block view.
remove_air
+
+
Wrapper for [/datum/gas_mixture/proc/remove()]
remove_opacity_source
+
+
Proc to remove movable sources of opacity on the turf and let it handle lighting code.
return_air
+
+
Return the currently used gas_mixture datum.
setup_zmimic
+
+
Sets up Z-mimic for this turf. You shouldn't call this directly 99% of the time.
take_zone_air_share
+
+
Copies this turf's group share from the zone. Usually used before removing it from the zone.
transfer_area_lighting
+
+
Transfer the lighting of one area to another
unsafe_return_air
+
+
Return the currently used gas_mixture datum. DOES NOT MARK ZONE FOR UPDATE.
update_air_properties
+
+
Updates the turf's air source properties, breaking or creating zone connections as necessary.
update_underfloor_accessibility
+
+
Sets underfloor accessibility
wash
+
+
Called when this turf is being washed. Washing a turf will also wash any mopable floor decals
zImpact
+
+
Called each time the target falls down a z level possibly making their trajectory come to a halt. see __DEFINES/movement.dm.
Paint color of which the wall has been painted with.
Proc Details
hulk_recoil
+
+
Deals damage back to the hulk's arm.
+
When a hulk manages to break a wall using their hulk smash, this deals back damage to the arm used.
+This is in its own proc just to be easily overridden by other wall types. Default allows for three
+smashed walls per arm. Also, we use CANT_WOUND here because wounds are random. Wounds are applied
+by hulk code based on arm damage and checked when we call break_an_arm().
+Arguments:
+*arg1 is the arm to deal damage to.
+*arg2 is the hulk
paint_stripe
+
+
Most of this code is pasted within /obj/structure/falsewall. Be mindful of this
paint_wall
+
+
Most of this code is pasted within /obj/structure/falsewall. Be mindful of this
set_materials
+
+
Most of this code is pasted within /obj/structure/falsewall. Be mindful of this
set_wall_information
+
+
Most of this code is pasted within /obj/structure/falsewall. Be mindful of this
update_overlays
+
+
Most of this code is pasted within /obj/structure/falsewall. Be mindful of this
Builds with rods. This doesn't exist to be overriden, just to remove duplicate logic for turfs that want
+To support floor tile creation
+I'd make it a component, but one of these things is space. So no.
Very similar to build_with_rods, this exists to allow consistent behavior between different types in terms of how
+Building floors works
build_with_rods
+
+
Builds with rods. This doesn't exist to be overriden, just to remove duplicate logic for turfs that want
+To support floor tile creation
+I'd make it a component, but one of these things is space. So no.
If we want to ignore our area's power status and just be always off
+Mostly for mappers doing asthetic things, or cases where the floor should be broken
If we want to ignore our area's power status and just be always off
+Mostly for mappers doing asthetic things, or cases where the floor should be broken
Doesn't call parent, see /atom/proc/Initialize.
+When adding new stuff to /atom/Initialize, /turf/Initialize, etc
+don't just add it here unless space actually needs it.
+
There is a lot of work that is intentionally not done because it is not currently used.
+This includes stuff like smoothing, blocking camera visibility, etc.
+If you are facing some odd bug with specifically space, check if it's something that was
+intentionally ommitted from this implementation.
Handles incresing the world's maxx var and intializing the new turfs and assigning them to the global area.
+If map_load_z_cutoff is passed in, it will only load turfs up to that z level, inclusive.
+This is because maploading will handle the turfs it loads itself.
The usage of "[" without also using "]" makes the bracket pair colorizer break, so this is here to make the rest of the file easier to read.
Proc Details
ImmediateInvokeAsync
+
+
Immediately Invoke proctocall on thingtocall, with waitfor set to false
+
Arguments:
+
+
thingtocall Object to call on
+
proctocall Proc to call on that object
+
... optional list of arguments to pass as arguments to the proc being called
+
New
+
+
World creation
+
Here is where a round itself is actually begun and setup.
+
+
db connection setup
+
config loaded from files
+
loads admins
+
Sets up the dynamic menu system
+
and most importantly, calls initialize on the master subsystem, starting the game loop that causes the rest of the game to begin processing and setting up
+
+
Nothing happens until something moves. ~Albert Einstein
+
For clarity, this proc gets triggered later in the initialization pipeline, it is not the first thing to happen, as it might seem.
+
Initialization Pipeline:
+Global vars are new()'ed, (including config, glob, and the master controller will also new and preinit all subsystems when it gets new()ed)
+Compiled in maps are loaded (mainly centcom). all areas/turfs/objs/mobs(ATOMs) in these maps will be new()ed
+world/New() (You are here)
+Once world/New() returns, client's can connect.
+1 second sleep
+Master Controller initialization.
+Subsystem initialization.
+Non-compiled-in maps are maploaded, all atoms are new()ed
+All atoms in both compiled and uncompiled maps are initialized()
increase_max_x
+
+
Handles incresing the world's maxx var and intializing the new turfs and assigning them to the global area.
+If map_load_z_cutoff is passed in, it will only load turfs up to that z level, inclusive.
+This is because maploading will handle the turfs it loads itself.
jatum_deserialize
+
+
Attempt to create a value from a JATUM JSON.
+
+
json - The JSON to deserialize.
+
jatum_serialize
+
+
Attempt to serialize a given value to the JATUM format.
+
+
value - The var to serialize.
+
push_usr
+
+
Makes a call in the context of a different usr. Use sparingly
send_cross_comms
+
+
Sends a message to a given cross comms server by name (by name for security).
shelleo
+
+
XXX
+AOO
+XXX
+AXX
update_hub_visibility
+
+
The usage of "[" without also using "]" makes the bracket pair colorizer break, so this is here to make the rest of the file easier to read.
