gas_provider
Shared peripheral for gas-output blocks (burners, vents) that fill balloons.
Reports gas output, signal, gas type, target amount, and balloon state. The
shared additional type gas_provider lets scripts target every heater
regardless of block kind.
| getGasOutput() | Get the current gas output rate. |
|---|---|
| isActive() | Check whether the provider can currently output gas. |
| getSignalStrength() | Get the redstone signal strength driving output. |
| getGasType() | Get the id of the gas this provider produces. |
| getTargetAmount() | Get the configured target gas amount. |
| setTargetAmount(amount) | Set the target gas amount. |
| getBoilerEfficiency() | Get the boiler efficiency. |
| hasBalloon() | Check whether a balloon is currently attached. |
| getBalloonCapacity() | Get the attached balloon's capacity. |
| getBalloonFilledVolume() | Get the balloon's currently filled volume. |
| getBalloonTargetVolume() | Get the balloon's target volume. |
| getBalloonVolumeChange() | Get the per-tick volume change of the balloon. |
| getBalloonLift() | Get the balloon's lift force. |
| getBalloonHeight() | Get the balloon's height. |
| getBalloonGasMix() | Get the balloon's gas mix as a list of {type, amount} entries. |
- getGasOutput()Source
Get the current gas output rate. Output = target × signal / 15 (burner), or target × efficiency × signal / 15 (vent). Added to the attached balloon's target volume every game tick.
Returns
numberThe gas output rate in m³ per tick (multiply by 20 for m³/s).
- isActive()Source
Check whether the provider can currently output gas.
Returns
booleanTrue if active.
- getSignalStrength()Source
Get the redstone signal strength driving output.
Returns
numberThe signal strength, 0..15.
- getGasType()Source
Get the id of the gas this provider produces. Known stock types return stable lowercase ids (
"steam","default"). Third-partyLiftingGasTypeimplementations fall through to their class's simple name so the gas remains identifiable to scripts.Returns
stringThe gas type id.
- getTargetAmount()Source
Get the configured target gas amount.
Returns
numberThe target amount.
- setTargetAmount(amount)Source
Set the target gas amount. Clamped internally to the scroll-value's min/max.
Parameters
- amount
numberThe new target amount.
- amount
- getBoilerEfficiency()Source
Get the boiler efficiency. 0..1. Burners are always 1.0; vents track boiler heat.
Returns
numberThe boiler efficiency in [0, 1].
- hasBalloon()Source
Check whether a balloon is currently attached.
Returns
booleanTrue if a balloon is present.
- getBalloonCapacity()Source
Get the attached balloon's capacity.
Returns
numberThe balloon's capacity, or 0 if none.
- getBalloonFilledVolume()Source
Get the balloon's currently filled volume.
Returns
numberThe filled volume, or 0 if no server-side balloon.
- getBalloonTargetVolume()Source
Get the balloon's target volume.
Returns
numberThe target volume, or 0 if no server-side balloon.
- getBalloonVolumeChange()Source
Get the per-tick volume change of the balloon.
Returns
numberThe signed volume change, or 0 if no server-side balloon.
- getBalloonLift()Source
Get the balloon's lift force.
Returns
numberThe lift, or 0 if no server-side balloon.
- getBalloonHeight()Source
Get the balloon's height.
Returns
numberThe height, or 0 if no balloon.
- getBalloonGasMix()Source
Get the balloon's gas mix as a list of {type, amount} entries.
Returns
- { { [
string] =any}... } A list of gas mix entries.
- { { [