me.desht.pneumaticcraft.api.universal_sensor

Interface IBaseSensor

All Known Subinterfaces:

IBlockAndCoordinateEventSensor, IBlockAndCoordinatePollSensor, IEventSensorSetting, IPollSensorSetting, ISensorSetting

All Known Implementing Classes:

BlockComparatorSensor, BlockHeatSensor, BlockInteractSensor, BlockLightLevelSensor, BlockPresenceSensor, BlockRedstoneSensor, ConstantSensor, EntityInRangeSensor, PlayerAttackSensor, PlayerHealthSensor, PlayerItemPickupSensor, TwitchStreamerSensor, WorldDayLightSensor, WorldGlobalVariableAnalogSensor, WorldGlobalVariableSensor, WorldPlayersInServerSensor, WorldRainingSensor, WorldTicktimeSensor, WorldTimeSensor, WorldWeatherForecaster

public interface IBaseSensor

Method Summary

Modifier and Type	Method and Description
default void	getAdditionalInfo(java.util.List<net.minecraft.util.text.ITextComponent> info) Return some descriptive text to be displayed above the optional textbox
default java.util.List<java.lang.String>	getDescription() Get some description text for this sensor
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.
default net.minecraft.util.RangedInteger	getTextboxIntRange() For numeric textboxes (see needsTextBox()), get the permitted numeric range.
default boolean	isEntityFilter() If a textbox is to be displyed (see needsTextBox()), is this textbox for an entity filter?
boolean	needsTextBox() Should this sensor's GUI display a text box for extra information to be entered?

Method Detail

getSensorPath

java.lang.String getSensorPath()

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".

Returns:

a string path to the sensor

getRequiredUpgrades

java.util.Set<EnumUpgrade> getRequiredUpgrades()

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

Returns:

a set of upgrades

needsTextBox

boolean needsTextBox()

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

getTextboxIntRange

default net.minecraft.util.RangedInteger getTextboxIntRange()

For numeric textboxes (see needsTextBox()), get the permitted numeric range.

Returns:

the numeric range, or null if the textbox should allow freeform text

isEntityFilter

default boolean isEntityFilter()

If a textbox is to be displyed (see needsTextBox()), is this textbox for an entity filter?

Returns:

true if this is an entity filter, false otherwise

getDescription

default java.util.List<java.lang.String> getDescription()

Get some description text for this sensor

Returns:

a list of translation keys

getAdditionalInfo

default void getAdditionalInfo(java.util.List<net.minecraft.util.text.ITextComponent> info)

Return some descriptive text to be displayed above the optional textbox

Parameters:

info - a text component list to be appended to