Package me.desht.pneumaticcraft.common.sensor.eventSensors

Class PlayerAttackSensor

java.lang.Object

me.desht.pneumaticcraft.common.sensor.eventSensors.PlayerAttackSensor

All Implemented Interfaces:

IBaseSensor, IEventSensorSetting, ISensorSetting

public class PlayerAttackSensor
extends Object

Constructor Summary

Constructors

Constructor	Description
PlayerAttackSensor()

Method Summary

Modifier and Type	Method	Description
int	emitRedstoneOnEvent(net.minecraftforge.event.entity.player.PlayerEvent event, net.minecraft.world.level.block.entity.BlockEntity sensor, int range)
int	emitRedstoneOnEvent(net.minecraftforge.eventbus.api.Event event, net.minecraft.world.level.block.entity.BlockEntity sensor, int range, String textboxText)	This method is called when a Forge event of interest is triggered.
int	getRedstonePulseLength()	How long should an emitted pulse last for? 5 ticks is a suitable value.
Set<PNCUpgrade>	getRequiredUpgrades()	Return the upgrades required by this sensor.
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, getHelpPromptText, getHelpText, getTextboxIntRange, getTextBoxOptions, strictComboBox

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

getAirUsage, needsGPSTool, notifyTextChange

Constructor Details

PlayerAttackSensor

public PlayerAttackSensor()

Method Details

getSensorPath

public 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

needsTextBox

public boolean needsTextBox()

Description copied from interface: IBaseSensor

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

Returns:

true if this sensor needs a text box, false otherwise

emitRedstoneOnEvent

public int emitRedstoneOnEvent(net.minecraftforge.event.entity.player.PlayerEvent event,
 net.minecraft.world.level.block.entity.BlockEntity sensor,
 int range)

getRequiredUpgrades

public Set<PNCUpgrade> 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

emitRedstoneOnEvent

public int emitRedstoneOnEvent(net.minecraftforge.eventbus.api.Event event,
 net.minecraft.world.level.block.entity.BlockEntity sensor,
 int range,
 String textboxText)

Description copied from interface: IEventSensorSetting

This method is called when a Forge event of interest is triggered. Events of interest are:

• PlayerInteractEvent
• EntityItemPickupEvent
• AttackEntityEvent

Specified by:

emitRedstoneOnEvent in interface IEventSensorSetting

Parameters:

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

sensor - the Universal Sensor block entity

range - the Universal Sensor's range, in blocks

textboxText - any text which was entered in the sensor configuration's textfield

Returns:

the redstone strength which should be emitted

getRedstonePulseLength

public int getRedstonePulseLength()

Description copied from interface: IEventSensorSetting

How long should an emitted pulse last for? 5 ticks is a suitable value.

Specified by:

getRedstonePulseLength in interface IEventSensorSetting

Returns:

a redstone pulse length, in ticks