me.desht.pneumaticcraft.common.sensor.eventSensors

Class BlockInteractSensor

java.lang.Object

me.desht.pneumaticcraft.common.sensor.eventSensors.BlockInteractSensor

All Implemented Interfaces:

IBaseSensor, IBlockAndCoordinateEventSensor

public class BlockInteractSensor
extends java.lang.Object
implements IBlockAndCoordinateEventSensor

Constructor Summary

Constructors

Constructor and Description
BlockInteractSensor()

Method Summary

Modifier and Type	Method and Description
int	emitRedstoneOnEvent(net.minecraftforge.eventbus.api.Event event, net.minecraft.tileentity.TileEntity sensor, int range, java.util.Set<net.minecraft.util.math.BlockPos> positions) Extended version of the normal emitRedstoneOnEvent.
int	getRedstonePulseLength() See IEventSensorSetting.getRedstonePulseLength()
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

BlockInteractSensor

public BlockInteractSensor()

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

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

emitRedstoneOnEvent

public int emitRedstoneOnEvent(net.minecraftforge.eventbus.api.Event event,
                               net.minecraft.tileentity.TileEntity sensor,
                               int range,
                               java.util.Set<net.minecraft.util.math.BlockPos> positions)

Description copied from interface: IBlockAndCoordinateEventSensor

Extended version of the normal emitRedstoneOnEvent. This method will only invoke with a valid GPS tool, and when all the coordinates are within range.

Specified by:

emitRedstoneOnEvent in interface IBlockAndCoordinateEventSensor

Parameters:

event - the Forge event (one of PlayerInteractEvent, EntityItemPickupEvent or AttackEntityEvent)

sensor - the Universal Sensor tile entity

range - the Universal Sensor's range, in blocks

positions - When a GPS Tool is inserted this contains the position of that tool. If a GPS Area Tool is inserted this is set of all positions in that area.

Returns:

the redstone level that should be emitted

getRedstonePulseLength

public int getRedstonePulseLength()

Description copied from interface: IBlockAndCoordinateEventSensor

See IEventSensorSetting.getRedstonePulseLength()

Specified by:

getRedstonePulseLength in interface IBlockAndCoordinateEventSensor

Returns:

a redstone pulse length, in ticks