cyberpresidentvanellope/Aurora.3
1
0
Fork 0
mirror of https://github.com/Aurorastation/Aurora.3.git synced 2026-08-30 00:21:11 +01:00
Code Issues Packages Projects Releases Wiki Activity

DMdocs (#21103)

Browse Source 
Progress on DMDocs. PRing progress so far so there's not one mega PR
later with 1500 affected files.

I want my goddamn highlight text on what all these goddamn procs goddamn
do goddamnit. >:(

No actual code change anywhere in this PR, only comments.

---------

Signed-off-by: Batrachophreno <Batrochophreno@gmail.com>
This commit is contained in:
Batrachophreno
2025-08-09 12:22:56 +00:00
committed by GitHub
parent a840bd1cb1
commit c2f054fd81
88 changed files with 1574 additions and 879 deletions
Download Patch File Download Diff File Expand all files Collapse all files
code/modules/recycling/disposal.dm
+67 -67
View File
@@ -1,11 +1,11 @@
/**
* Disposal bin
* Holds items for disposal into pipe system
* Draws air from turf, gradually charges internal reservoir
* Once full (~1 atm), uses air resv to flush items into the pipes
* Automatically recharges air (unless off), will flush when ready if pre-set
* Can hold items and human size things, no other draggables
* Toilets are a type of disposal bin for small objects only and work on magic. By magic, I mean torque rotation
* Disposal bin
* Holds items for disposal into pipe system
* Draws air from turf, gradually charges internal reservoir
* Once full (~1 atm), uses air resv to flush items into the pipes
* Automatically recharges air (unless off), will flush when ready if pre-set
* Can hold items and human size things, no other draggables
* Toilets are a type of disposal bin for small objects only and work on magic. By magic, I mean torque rotation
*/
/// kPa - assume the inside of a dispoal pipe is 1 atm, so that needs to be added.
@@ -104,8 +104,8 @@
return TRUE
/**
* Create a new disposal:
* Find the attached trunk (if present), and initialize gas reservoir.
* Create a new disposal:
* Find the attached trunk (if present), and initialize gas reservoir.
*/
/obj/machinery/disposal/Initialize()
. = ..()
@@ -138,7 +138,7 @@
return things
/**
* Attack by an item places it into the disposal.
* Attack by an item places it into the disposal.
*/
/obj/machinery/disposal/attackby(obj/item/attacking_item, mob/user)
if(stat & BROKEN || !attacking_item || !user)
@@ -261,7 +261,7 @@
update()
/**
* Handles mouse-dropping another mob or self onto disposal.
* Handles mouse-dropping another mob or self onto disposal.
*/
/obj/machinery/disposal/mouse_drop_receive(atom/dropped, mob/user, params)
var/mob/target = dropped
@@ -329,7 +329,7 @@
return 1
/**
* Attempt to move while inside.
* Attempt to move while inside.
*/
/obj/machinery/disposal/relaymove(mob/living/user, direction)
. = ..()
@@ -341,7 +341,7 @@
return
/**
* Leave the disposal.
* Leave the disposal.
*/
/obj/machinery/disposal/proc/go_out(mob/user)
@@ -353,7 +353,7 @@
return
/**
* AI: as human but can't flush.
* AI: as human but can't flush.
*/
/obj/machinery/disposal/attack_ai(mob/user as mob)
if(!ai_can_interact(user))
@@ -362,7 +362,7 @@
interact(user, !inside_bin)
/**
* Human interacts with machine.
* Human interacts with machine.
*/
/obj/machinery/disposal/attack_hand(mob/user as mob)
if(stat & BROKEN)
@@ -424,7 +424,7 @@
. = TRUE
/**
* Eject the contents of the disposal unit.
* Eject the contents of the disposal unit.
*/
/obj/machinery/disposal/proc/eject()
for(var/atom/movable/AM in src)
@@ -433,7 +433,7 @@
update()
/**
* Update the icon & overlays to reflect mode & status
* Update the icon & overlays to reflect mode & status
*/
/obj/machinery/disposal/proc/update()
ClearOverlays()
@@ -462,7 +462,7 @@
AddOverlays("[icon_state]-ready")
/**
* Timed process. Charge the gas reservoir and perform flush if ready.
* Timed process. Charge the gas reservoir and perform flush if ready.
*/
/obj/machinery/disposal/process()
if((stat & BROKEN) || !is_on)
@@ -502,7 +502,7 @@
return
/**
* If powered and working, transfer gas from local env to internal reservoir and use the required power to do so.
* If powered and working, transfer gas from local env to internal reservoir and use the required power to do so.
*/
/obj/machinery/disposal/proc/pressurize()
// Don't pressurize if there's no power.
@@ -528,7 +528,7 @@
mode = MODE_READY
/**
* Attempt to flush. If able, create a virtual holder object containing disposal bin & gas reservoir contents to ship through disposals network
* Attempt to flush. If able, create a virtual holder object containing disposal bin & gas reservoir contents to ship through disposals network
*/
/obj/machinery/disposal/proc/flush()
set waitfor = FALSE
@@ -583,7 +583,7 @@
return
/**
* Called when area power changes.
* Called when area power changes.
*/
/obj/machinery/disposal/power_change()
// do default setting/reset of stat NOPOWER bit
@@ -593,7 +593,7 @@
return
/**
* Called when holder is expelled from a disposal- should usually only occur if the pipe network is modified
* Called when holder is expelled from a disposal- should usually only occur if the pipe network is modified
*/
/obj/machinery/disposal/proc/expel(var/obj/disposalholder/H)
@@ -637,10 +637,10 @@
/**
* Virtual disposal object
* Travels through pipes in lieu of actual items
* Contents will be items flushed by the disposal
* This allows the gas flushed to be tracked
* Virtual disposal object
* Travels through pipes in lieu of actual items
* Contents will be items flushed by the disposal
* This allows the gas flushed to be tracked
*/
/obj/disposalholder
invisibility = 101
@@ -662,7 +662,7 @@
var/tmp/obj/structure/disposalpipe/tick_last
/**
* Initialize a holder from the contents of a disposal unit.
* Initialize a holder from the contents of a disposal unit.
*/
/obj/disposalholder/proc/init(var/obj/machinery/disposal/D, var/datum/gas_mixture/flush_gas)
gas = flush_gas// transfer gas resv. into holder object -- let's be explicit about the data this proc consumes, please.
@@ -702,8 +702,8 @@
/**
* Start the movement process
* Argument is the disposal unit the holder started in
* Start the movement process
* Argument is the disposal unit the holder started in
*/
/obj/disposalholder/proc/start(var/obj/machinery/disposal/D)
// No trunk connected, so expel immediately
@@ -716,7 +716,7 @@
START_PROCESSING(SSdisposals, src)
/**
* For the new SSdisposals-based movement.
* For the new SSdisposals-based movement.
*/
/obj/disposalholder/process()
if (hasmob && prob(3))
@@ -751,13 +751,13 @@
tick_last = null
/**
* Find the turf which should contain the next pipe
* Find the turf which should contain the next pipe
*/
/obj/disposalholder/proc/nextloc()
return get_step(loc,dir)
/**
* Find a matching pipe on a turf
* Find a matching pipe on a turf
*/
/obj/disposalholder/proc/findpipe(var/turf/T)
if(!T)
@@ -773,7 +773,7 @@
return null
/**
* Merge two holder objects. Used when a a holder meets a stuck holder.
* Merge two holder objects. Used when a a holder meets a stuck holder.
*/
/obj/disposalholder/proc/merge(obj/disposalholder/other)
for(var/atom/movable/AM in other)
@@ -798,7 +798,7 @@
partialTag = new_tag
/**
* Called when player tries to move while in a pipe.
* Called when player tries to move while in a pipe.
*/
/obj/disposalholder/relaymove(mob/living/user, direction)
. = ..()
@@ -820,7 +820,7 @@
playsound(src.loc, 'sound/effects/clang.ogg', 50, 0, 0)
/**
* Called to vent all gas in holder to a location
* Called to vent all gas in holder to a location
*/
/obj/disposalholder/proc/vent_gas(atom/location)
location.assume_air(gas) // vent all gas to turf
@@ -859,7 +859,7 @@
LAZYADD(T.blueprints, I)
/**
* Pipe is deleted. Ensure if holder is present, it is expelled.
* Pipe is deleted. Ensure if holder is present, it is expelled.
*/
/obj/structure/disposalpipe/Destroy()
var/obj/disposalholder/H = locate() in src
@@ -884,15 +884,15 @@
return ..()
/**
* Returns the direction of the next pipe object, given the entrance dir
* By default, returns the bitmask of remaining directions
* Returns the direction of the next pipe object, given the entrance dir
* By default, returns the bitmask of remaining directions
*/
/obj/structure/disposalpipe/proc/nextdir(var/fromdir)
return dpdir & (~turn(fromdir, 180))
/**
* Transfer the holder through this pipe segment
* Overriden for special behaviour
* Transfer the holder through this pipe segment
* Overriden for special behaviour
*/
/obj/structure/disposalpipe/proc/transfer(var/obj/disposalholder/H)
var/nextdir = nextdir(H.dir)
@@ -914,22 +914,22 @@
return P
/**
* Update the icon_state to reflect hidden status
* Update the icon_state to reflect hidden status
*/
/obj/structure/disposalpipe/proc/update()
var/turf/T = src.loc
hide(!T.is_plating() && !istype(T,/turf/space)) // space never hides pipes
/**
* Hide called by levelupdate if turf intact status changes
* Change visibility status and force update of icon
* Hide called by levelupdate if turf intact status changes
* Change visibility status and force update of icon
*/
/obj/structure/disposalpipe/hide(var/intact)
set_invisibility(intact ? 101: 0) // hide if floor is intact
/**
* Expel the held objects into a turf
* Called when there is a break in the pipe
* Expel the held objects into a turf
* Called when there is a break in the pipe
*/
/obj/structure/disposalpipe/proc/expel(var/obj/disposalholder/H, var/turf/T, var/direction)
if(!istype(H) || !istype(T))
@@ -981,8 +981,8 @@
/**
* Call to break the pipe: will expel any holder inside at the time then delete the pipe
* remains: Set to leave broken pipe pieces in place.
* Call to break the pipe: will expel any holder inside at the time then delete the pipe
* remains: Set to leave broken pipe pieces in place.
*/
/obj/structure/disposalpipe/proc/broken(var/remains = 0)
if(remains)
@@ -1015,7 +1015,7 @@
/**
* Pipe is affected by an explosion
* Pipe is affected by an explosion
*/
/obj/structure/disposalpipe/ex_act(severity)
switch(severity)
@@ -1033,7 +1033,7 @@
/**
* Test pipe's health. Am I broken?
* Test pipe's health. Am I broken?
*/
/obj/structure/disposalpipe/proc/healthcheck()
if(health < -2)
@@ -1042,8 +1042,8 @@
broken(1)
/**
* Attack by item
* Welding tool: Unfasten and convert to obj/disposalconstruct
* Attack by item
* Welding tool: Unfasten and convert to obj/disposalconstruct
*/
/obj/structure/disposalpipe/attackby(obj/item/attacking_item, mob/user)
var/turf/T = src.loc
@@ -1066,7 +1066,7 @@
to_chat(user, "You need more welding fuel to cut the pipe.")
/**
* Called when pipe is cut by a welder.
* Called when pipe is cut by a welder.
*/
/obj/structure/disposalpipe/proc/welded()
var/obj/structure/disposalconstruct/C = new (src.loc)
@@ -1249,9 +1249,9 @@
update()
/*
* Next direction to move:
* If coming in from secondary dirs, then next is primary dir.
* If coming in from primary dir, then next is equal chance of other dirs.
* Next direction to move:
* If coming in from secondary dirs, then next is primary dir.
* If coming in from primary dir, then next is equal chance of other dirs.
*/
/obj/structure/disposalpipe/junction/nextdir(var/fromdir)
var/flipdir = turn(fromdir, 180)
@@ -1394,10 +1394,10 @@
return sortType == checkTag
/**
* Next direction to move:
* If coming in from negdir, then next is primary dir or sortdir.
* If coming in from posdir, then flip around and go back to posdir.
* If coming in from sortdir, go to posdir.
* Next direction to move:
* If coming in from negdir, then next is primary dir or sortdir.
* If coming in from posdir, then flip around and go back to posdir.
* If coming in from sortdir, go to posdir.
*/
/obj/structure/disposalpipe/sortjunction/nextdir(var/fromdir, var/sortTag)
if(fromdir != sortdir) // probably came from the negdir
@@ -1483,7 +1483,7 @@
update()
/**
* Override attackby so we disallow trunkremoval when somethings ontop
* Override attackby so we disallow trunkremoval when somethings ontop
*/
/obj/structure/disposalpipe/trunk/attackby(obj/item/attacking_item, mob/user)
@@ -1525,8 +1525,8 @@
to_chat(user, "You need more welding fuel to cut the pipe.")
/*
* Would transfer to next pipe segment, but we are in a trunk.
* If not entering from disposal bin, transfer to linked object (outlet or bin)
* Would transfer to next pipe segment, but we are in a trunk.
* If not entering from disposal bin, transfer to linked object (outlet or bin)
*/
/obj/structure/disposalpipe/trunk/transfer(var/obj/disposalholder/H)
@@ -1570,8 +1570,8 @@
update()
/**
* Called when welded
* For broken pipe, remove and turn into scrap
* Called when welded
* For broken pipe, remove and turn into scrap
*/
/obj/structure/disposalpipe/broken/welded()
// var/obj/item/scrap/S = new(src.loc)
@@ -1698,14 +1698,14 @@
return
/**
* Called when movable is expelled from a disposal pipe or outlet
* By default does nothing, override for special behaviour
* Called when movable is expelled from a disposal pipe or outlet
* By default does nothing, override for special behaviour
*/
/atom/movable/proc/pipe_eject(var/direction)
return
/**
* Check if mob has client, if so restore client view on eject
* Check if mob has client, if so restore client view on eject
*/
/mob/pipe_eject(var/direction)
if (src.client)