floor_pump

Base class for underfloor plumbing machines that mess with floor liquids.

Vars
drain_flat	Base amount to drain
drain_percent	Additional ratio of liquid volume to drain
duct_layer	The default duct layer for mapping
height_regulator	Only pump to this liquid level height. 0 means pump the most possible.
is_pumping	Currently pumping.
tile_placed	Floor tile is placed down
turned_on	Pump is turned on by engineer, etc.
Procs
are_reagents_ready	Is the internal reagents container able to give or take liquid as appropriate?
can_run	Can the pump actually run at all?
on_hide	Handle COMSIG_OBJ_HIDE to toggle whether we're on the floor
pump_turf	Pump out the liquids on a turf.
set_regulator	Change regulator level -- ie. what liquid depth we are OK with, like a thermostat.
should_pump	Should we actually be pumping this tile right now? Arguments:
should_regulator_permit	Should the liquid height regulator allow water to be pumped here?

Var Details

var
drain_flat
–

Base amount to drain

var
drain_percent
–

Additional ratio of liquid volume to drain

var
duct_layer
–

The default duct layer for mapping

var
height_regulator
–

Only pump to this liquid level height. 0 means pump the most possible.

var
is_pumping
–

Currently pumping.

var
tile_placed
–

Floor tile is placed down

var
turned_on
–

Pump is turned on by engineer, etc.

Proc Details

proc
are_reagents_ready
()

Is the internal reagents container able to give or take liquid as appropriate?

proc
can_run
()

Can the pump actually run at all?

proc
on_hide
(/atom/movable/AM, should_hide)

Handle COMSIG_OBJ_HIDE to toggle whether we're on the floor

proc
pump_turf
(/turf/affected_turf, seconds_per_tick, multiplier)

Pump out the liquids on a turf.

Arguments:

affected_turf - the turf to pump liquids out of.
seconds_per_tick - machine process delta time
multiplier - Multiplier to apply to final volume we want to pump.

proc
set_regulator
(/mob/living/user)

Change regulator level -- ie. what liquid depth we are OK with, like a thermostat.

proc
should_pump
(/turf/affected_turf)

Should we actually be pumping this tile right now? Arguments:

affected_turf - the turf to check.

proc
should_regulator_permit
(/turf/affected_turf)

Should the liquid height regulator allow water to be pumped here?

/obj/machinery/plumbing/floor_pump

Vars

Procs

Var Details

var drain_flat –

var drain_percent –

var duct_layer –

var height_regulator –

var is_pumping –

var tile_placed –

var turned_on –

Proc Details

proc are_reagents_ready()

proc can_run()

proc on_hide(/atom/movable/AM, should_hide)

proc pump_turf(/turf/affected_turf, seconds_per_tick, multiplier)

proc set_regulator(/mob/living/user)

proc should_pump(/turf/affected_turf)

proc should_regulator_permit(/turf/affected_turf)