me.desht.pneumaticcraft.api.universal_sensor

Interface IPollSensorSetting

All Superinterfaces:

IBaseSensor, ISensorSetting

All Known Implementing Classes:

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

public interface IPollSensorSetting
extends ISensorSetting

Method Summary

Modifier and Type	Method and Description
int	getPollFrequency(net.minecraft.tileentity.TileEntity te) The value returned here is the interval between every check in ticks (the interval of calling getRedstoneValue()).
int	getRedstoneValue(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, int sensorRange, java.lang.String textBoxText) This method should return the outputted redstone value 0-15 of this sensor.

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

_getDescription, getAirUsage, needsGPSTool, notifyTextChange

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

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

Method Detail

getPollFrequency

int getPollFrequency(net.minecraft.tileentity.TileEntity te)

The value returned here is the interval between every check in ticks (the interval of calling getRedstoneValue()). Consider increasing the interval when your sensor method is resource intensive.

Parameters:

te - universal sensor

Returns:

the interval in ticks between polling operations

getRedstoneValue

int getRedstoneValue(net.minecraft.world.World world,
                     net.minecraft.util.math.BlockPos pos,
                     int sensorRange,
                     java.lang.String textBoxText)

This method should return the outputted redstone value 0-15 of this sensor. When this sensor is digital, just return 0 or 15.

Parameters:

world - the world

pos - the blockpos to test

sensorRange - range of the sensor, based on the number of Range Upgrades inserted in the Universal Sensor.

textBoxText - any text typed in the textfield of the Universal Sensor.

Returns:

level of the redstone signal to emit