me.desht.pneumaticcraft.api.universal_sensor

Interface ISensorSetting

All Superinterfaces:

IBaseSensor

All Known Subinterfaces:

IEventSensorSetting, IPollSensorSetting

All Known Implementing Classes:

ConstantSensor, EntityInRangeSensor, PlayerAttackSensor, PlayerHealthSensor, PlayerItemPickupSensor, TwitchStreamerSensor, WorldDayLightSensor, WorldGlobalVariableAnalogSensor, WorldGlobalVariableSensor, WorldPlayersInServerSensor, WorldRainingSensor, WorldTicktimeSensor, WorldTimeSensor, WorldWeatherForecaster

public interface ISensorSetting
extends IBaseSensor

Method Summary

Modifier and Type	Method and Description
static java.util.List<java.lang.String>	_getDescription(java.lang.String path) Don't call this directly; used internally by IBaseSensor.getDescription()
default int	getAirUsage(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos) Get the air usage for this sensor.
default boolean	needsGPSTool() Check if this sensor type needs a GPS (or GPS Area) Tool
default void	notifyTextChange(java.lang.String newText) Notify the sensor that the textbox has changed, so it can carry out any necessary recalculation.

Methods inherited from interface me.desht.pneumaticcraft.api.universal_sensor.IBaseSensor

getAdditionalInfo, getDescription, getRequiredUpgrades, getSensorPath, getTextboxIntRange, isEntityFilter, needsTextBox

Method Detail

getAirUsage

default int getAirUsage(net.minecraft.world.World world,
                        net.minecraft.util.math.BlockPos pos)

Get the air usage for this sensor.

Returns:

the sensor air usage in mL air per tick

notifyTextChange

default void notifyTextChange(java.lang.String newText)

Notify the sensor that the textbox has changed, so it can carry out any necessary recalculation.

needsGPSTool

default boolean needsGPSTool()

Check if this sensor type needs a GPS (or GPS Area) Tool

Returns:

true if a GPS Tool is required

_getDescription

static java.util.List<java.lang.String> _getDescription(java.lang.String path)

Don't call this directly; used internally by IBaseSensor.getDescription()

Parameters:

path - the sensor path

Returns:

some description text for the sensor