me.desht.pneumaticcraft.common.sensor.pollSensors

Class BlockComparatorSensor

java.lang.Object

me.desht.pneumaticcraft.common.sensor.pollSensors.BlockComparatorSensor

All Implemented Interfaces:

IBaseSensor, IBlockAndCoordinatePollSensor

public class BlockComparatorSensor
extends java.lang.Object
implements IBlockAndCoordinatePollSensor

Constructor Summary

Constructors

Constructor and Description
BlockComparatorSensor()

Method Summary

Modifier and Type	Method and Description
int	getPollFrequency() See IPollSensorSetting.getPollFrequency(TileEntity)
int	getRedstoneValue(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, int sensorRange, java.lang.String textBoxText, java.util.Set<net.minecraft.util.math.BlockPos> positions) Similar to IPollSensorSetting.getRedstoneValue(World, BlockPos, int, String), but this has the GPS tracked coordinates as extra parameters.
java.util.Set<EnumUpgrade>	getRequiredUpgrades() Return the upgrades required by this sensor.
java.lang.String	getSensorPath() Return the button path the player has to follow in which this setting is stored.
boolean	needsTextBox() Should this sensor's GUI display a text box for extra information to be entered?

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getAdditionalInfo, getDescription, getTextboxIntRange, isEntityFilter

Constructor Detail

BlockComparatorSensor

public BlockComparatorSensor()

Method Detail

getSensorPath

public java.lang.String getSensorPath()

Description copied from interface: IBaseSensor

Return the button path the player has to follow in which this setting is stored. For instance, when the sensor should be located in player and is called speed, you should return "player/speed".

Specified by:

getSensorPath in interface IBaseSensor

Returns:

a string path to the sensor

getRequiredUpgrades

public java.util.Set<EnumUpgrade> getRequiredUpgrades()

Description copied from interface: IBaseSensor

Return the upgrades required by this sensor. This will automatically include a GPS Tool for sensors that require a location.

Specified by:

getRequiredUpgrades in interface IBaseSensor

Returns:

a set of upgrades

getPollFrequency

public int getPollFrequency()

Description copied from interface: IBlockAndCoordinatePollSensor

See IPollSensorSetting.getPollFrequency(TileEntity)

Specified by:

getPollFrequency in interface IBlockAndCoordinatePollSensor

Returns:

a poll frequency, in ticks

needsTextBox

public boolean needsTextBox()

Description copied from interface: IBaseSensor

Should this sensor's GUI display a text box for extra information to be entered?

Specified by:

needsTextBox in interface IBaseSensor

Returns:

true if this sensor needs a text box, false otherwise

getRedstoneValue

public int getRedstoneValue(net.minecraft.world.World world,
                            net.minecraft.util.math.BlockPos pos,
                            int sensorRange,
                            java.lang.String textBoxText,
                            java.util.Set<net.minecraft.util.math.BlockPos> positions)

Description copied from interface: IBlockAndCoordinatePollSensor

Similar to IPollSensorSetting.getRedstoneValue(World, BlockPos, int, String), but this has the GPS tracked coordinates as extra parameters. This method will only invoke with a valid GPS tool, and when all the coordinates are within range.

Specified by:

getRedstoneValue in interface IBlockAndCoordinatePollSensor

Parameters:

world - the sensor's world

pos - the sensor's position

sensorRange - the sensor's current range, based on installed range upgrades

textBoxText - text in the sensor GUI's textbox (may be an empty string)

positions - When only one GPS Tool is inserted this contains the position of just that tool. If two GPS Tools are inserted, These are both corners of a box, and every coordinate in this box is added to the positions argument.

Returns:

the redstone signal level to be emitted