me.desht.pneumaticcraft.common.sensor.pollSensors

Class WorldPlayersInServerSensor

java.lang.Object

me.desht.pneumaticcraft.common.sensor.pollSensors.WorldPlayersInServerSensor

All Implemented Interfaces:

IBaseSensor, IPollSensorSetting, ISensorSetting

public class WorldPlayersInServerSensor
extends java.lang.Object
implements IPollSensorSetting

Constructor Summary

Constructors

Constructor and Description
WorldPlayersInServerSensor()

Method Summary

Modifier and Type	Method and Description
void	getAdditionalInfo(java.util.List<net.minecraft.util.text.ITextComponent> info) Return some descriptive text to be displayed above the optional textbox
int	getPollFrequency(net.minecraft.tileentity.TileEntity te) The value returned here is the interval between every check in ticks (the interval of calling getRedstoneValue()).
int	getRedstoneValue(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, int sensorRange, java.lang.String textBoxText) This method should return the outputted redstone value 0-15 of 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.
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.ISensorSetting

_getDescription, getAirUsage, needsGPSTool, notifyTextChange

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

getDescription, getTextboxIntRange, isEntityFilter

Constructor Detail

WorldPlayersInServerSensor

public WorldPlayersInServerSensor()

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

getPollFrequency

public int getPollFrequency(net.minecraft.tileentity.TileEntity te)

Description copied from interface: IPollSensorSetting

The value returned here is the interval between every check in ticks (the interval of calling getRedstoneValue()). Consider increasing the interval when your sensor method is resource intensive.

Specified by:

getPollFrequency in interface IPollSensorSetting

Parameters:

te - universal sensor

Returns:

the interval in ticks between polling operations

getRedstoneValue

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

Description copied from interface: IPollSensorSetting

This method should return the outputted redstone value 0-15 of this sensor. When this sensor is digital, just return 0 or 15.

Specified by:

getRedstoneValue in interface IPollSensorSetting

Parameters:

world - the world

pos - the blockpos to test

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

Returns:

level of the redstone signal to emit

getAdditionalInfo

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

Description copied from interface: IBaseSensor

Return some descriptive text to be displayed above the optional textbox

Specified by:

getAdditionalInfo in interface IBaseSensor

Parameters:

info - a text component list to be appended to