Class EntityInRangeSensor
java.lang.Object
me.desht.pneumaticcraft.common.sensor.pollSensors.entity.EntityInRangeSensor
- All Implemented Interfaces:
IBaseSensor,IPollSensorSetting,ISensorSetting
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidgetAdditionalInfo(List<net.minecraft.network.chat.Component> info) Return some descriptive text to be displayed above the optional textboxClass<? extends net.minecraft.world.entity.Entity>Only used ifIBaseSensor.getHelpText()returns a non-empty string; return a translation key for a "Hold F1" type message for this sensor.If this sensor should have a popup help panel, return a translation key here for the help text which should be shown when F1 is held down.intgetPollFrequency(net.minecraft.world.level.block.entity.BlockEntity te) The value returned here is the interval between every check in ticks (i.e.intgetRedstoneValue(List<? extends net.minecraft.world.entity.Entity> entities, String textboxText) intgetRedstoneValue(net.minecraft.world.level.Level level, net.minecraft.core.BlockPos pos, int sensorRange, String textBoxText) Called regularly by the Universal Sensor block entity to calculate the output redstone value 0-15 of this sensor.Return the upgrades required by this sensor.Return the button path the player has to follow in which this setting is stored.booleanIf a textbox is to be displayed (seeIBaseSensor.needsTextBox()), is this textbox for an entity filter?booleanShould 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, waitMethods inherited from interface me.desht.pneumaticcraft.api.universal_sensor.IBaseSensor
getDescription, getTextboxIntRange, getTextBoxOptions, strictComboBoxMethods inherited from interface me.desht.pneumaticcraft.api.universal_sensor.IPollSensorSetting
setPlayerContextMethods inherited from interface me.desht.pneumaticcraft.api.universal_sensor.ISensorSetting
getAirUsage, needsGPSTool, notifyTextChange
-
Constructor Details
-
EntityInRangeSensor
public EntityInRangeSensor()
-
-
Method Details
-
getSensorPath
Description copied from interface:IBaseSensorReturn 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".- Returns:
- a string path to the sensor
-
needsTextBox
public boolean needsTextBox()Description copied from interface:IBaseSensorShould 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
-
isEntityFilter
public boolean isEntityFilter()Description copied from interface:IBaseSensorIf a textbox is to be displayed (seeIBaseSensor.needsTextBox()), is this textbox for an entity filter?- Returns:
- true if this is an entity filter, false otherwise
-
getHelpText
Description copied from interface:IBaseSensorIf this sensor should have a popup help panel, return a translation key here for the help text which should be shown when F1 is held down. The translated text can include line breaks; use the sequence{br}for that.- Returns:
- help text translation key, or the empty string for no help text
-
getHelpPromptText
Description copied from interface:IBaseSensorOnly used ifIBaseSensor.getHelpText()returns a non-empty string; return a translation key for a "Hold F1" type message for this sensor.- Returns:
- a translation key, or the empty string for no help prompt text
-
getRedstoneValue
-
getEntityTracked
-
getAdditionalInfo
Description copied from interface:IBaseSensorReturn some descriptive text to be displayed above the optional textbox- Parameters:
info- a text component list to be appended to
-
getRequiredUpgrades
Description copied from interface:IBaseSensorReturn the upgrades required by this sensor. This will automatically include a GPS Tool for sensors that require a location.- Specified by:
getRequiredUpgradesin interfaceIBaseSensor- Returns:
- a set of upgrades
-
getPollFrequency
public int getPollFrequency(net.minecraft.world.level.block.entity.BlockEntity te) Description copied from interface:IPollSensorSettingThe value returned here is the interval between every check in ticks (i.e. how frequentlyIPollSensorSetting.getRedstoneValue(Level, BlockPos, int, String)should be called. Consider increasing the interval when that method is resource-intensive.- Specified by:
getPollFrequencyin interfaceIPollSensorSetting- Parameters:
te- universal sensor- Returns:
- the interval in ticks between polling operations
-
getRedstoneValue
public int getRedstoneValue(net.minecraft.world.level.Level level, net.minecraft.core.BlockPos pos, int sensorRange, String textBoxText) Description copied from interface:IPollSensorSettingCalled regularly by the Universal Sensor block entity to calculate the output redstone value 0-15 of this sensor. When this sensor is digital, just return 0 or 15.- Specified by:
getRedstoneValuein interfaceIPollSensorSetting- Parameters:
level- the worldpos- the blockpos to testsensorRange- 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 GUI.- Returns:
- level of the redstone signal that the Universal Sensor block should emit
-