Package io.github.thebusybiscuit.slimefun4.core.attributes

Interface EnergyNetProvider

All Superinterfaces:

EnergyNetComponent, ItemAttribute

All Known Implementing Classes:

AbstractEnergyProvider, AGenerator, BioGenerator, CoalGenerator, CombustionGenerator, LavaGenerator, MagnesiumGenerator, NetherStarReactor, NuclearReactor, Reactor, SolarGenerator

public interface EnergyNetProvider
extends EnergyNetComponent

An EnergyNetProvider is an extension of EnergyNetComponent which provides energy to an EnergyNet. It must be implemented on any Generator or Reactor.

Author:

TheBusyBiscuit

See Also:

• EnergyNet
• EnergyNetComponent
• AbstractEnergyProvider
• AGenerator
• Reactor

Method Summary

Modifier and Type	Method	Description
default EnergyNetComponentType	getEnergyComponentType()	This method returns the Type of EnergyNetComponentType this SlimefunItem represents.
default int	getGeneratedOutput(org.bukkit.Location l, ASlimefunDataContainer data)	This method returns how much energy this EnergyNetProvider provides to the EnergyNet.
default int	getGeneratedOutput(org.bukkit.Location l, SlimefunBlockData data)	Deprecated, for removal: This API element is subject to removal in a future version. use getGeneratedOutput(Location, ASlimefunDataContainer) instead
default int	getGeneratedOutput(org.bukkit.Location l, Config data)	Deprecated, for removal: This API element is subject to removal in a future version. use getGeneratedOutputLong(Location, SlimefunBlockData) instead This method only for backward compatibility.
default long	getGeneratedOutputLong(org.bukkit.Location l, ASlimefunDataContainer data)	This method returns how much energy this EnergyNetProvider provides to the EnergyNet.
default long	getGeneratedOutputLong(org.bukkit.Location l, SlimefunBlockData data)	Deprecated, for removal: This API element is subject to removal in a future version. use getGeneratedOutputLong(Location, ASlimefunDataContainer) instead
default boolean	willExplode(org.bukkit.Location l, ASlimefunDataContainer data)	This method returns whether the given Location is going to explode on the next tick.
default boolean	willExplode(org.bukkit.Location l, SlimefunBlockData data)	Deprecated, for removal: This API element is subject to removal in a future version. Use willExplode(Location, ASlimefunDataContainer) instead
default boolean	willExplode(org.bukkit.Location l, Config data)	Deprecated, for removal: This API element is subject to removal in a future version. use willExplode(Location, SlimefunBlockData) instead This method only for backward compatibility.

Methods inherited from interface io.github.thebusybiscuit.slimefun4.core.attributes.EnergyNetComponent

addCharge, addCharge, getCapacity, getCapacityLong, getCharge, getCharge, getCharge, getCharge, getChargeLong, getChargeLong, getChargeLong, isChargeable, removeCharge, removeCharge, setCharge, setCharge

Methods inherited from interface io.github.thebusybiscuit.slimefun4.core.attributes.ItemAttribute

getId

Method Details

getEnergyComponentType

@Nonnull
default EnergyNetComponentType getEnergyComponentType()

Description copied from interface: EnergyNetComponent

This method returns the Type of EnergyNetComponentType this SlimefunItem represents. It describes how this Block will interact with an EnergyNet.

Specified by:

getEnergyComponentType in interface EnergyNetComponent

Returns:

The EnergyNetComponentType this SlimefunItem represents.

getGeneratedOutput

@Deprecated(forRemoval=true)
default int getGeneratedOutput(@Nonnull
 org.bukkit.Location l,
 @Nonnull
 SlimefunBlockData data)

Deprecated, for removal: This API element is subject to removal in a future version.

use getGeneratedOutput(Location, ASlimefunDataContainer) instead

Parameters:

l -

data -

Returns:

getGeneratedOutput

default int getGeneratedOutput(@Nonnull
 org.bukkit.Location l,
 @Nonnull
 ASlimefunDataContainer data)

This method returns how much energy this EnergyNetProvider provides to the EnergyNet. Stored energy does not have to be handled in here.
if your machine outputs energy values higher than Integer.MAX_VALUE, please return Integer.MAX_VALUE here and override getGeneratedOutputLong(Location, SlimefunBlockData) instead.

Parameters:

l - The Location of this EnergyNetProvider

data - The stored SlimefunBlockData

Returns:

The generated output energy of this EnergyNetProvider.

getGeneratedOutput

@Deprecated(forRemoval=true)
default int getGeneratedOutput(@Nonnull
 org.bukkit.Location l,
 @Nonnull
 Config data)

Deprecated, for removal: This API element is subject to removal in a future version.

use getGeneratedOutputLong(Location, SlimefunBlockData) instead This method only for backward compatibility.

Parameters:

l -

data -

Returns:

getGeneratedOutputLong

@Deprecated(forRemoval=true)
default long getGeneratedOutputLong(@Nonnull
 org.bukkit.Location l,
 @Nonnull
 SlimefunBlockData data)

Deprecated, for removal: This API element is subject to removal in a future version.

use getGeneratedOutputLong(Location, ASlimefunDataContainer) instead

Parameters:

l - The Location of this EnergyNetProvider

data - The stored block data

Returns:

The generated output energy of this EnergyNetProvider.

getGeneratedOutputLong

default long getGeneratedOutputLong(@Nonnull
 org.bukkit.Location l,
 @Nonnull
 ASlimefunDataContainer data)

This method returns how much energy this EnergyNetProvider provides to the EnergyNet. We call this method every time we tick a energy regulator, so make sure to keep it light and fast. Stored energy does not have to be handled in here.

Parameters:

l - The Location of this EnergyNetProvider

data - The stored block data

Returns:

The generated output energy of this EnergyNetProvider.

willExplode

default boolean willExplode(@Nonnull
 org.bukkit.Location l,
 @Nonnull
 ASlimefunDataContainer data)

This method returns whether the given Location is going to explode on the next tick.

Parameters:

l - The Location of this EnergyNetProvider

data - The stored block data

Returns:

Whether or not this Location will explode.

willExplode

@Deprecated(forRemoval=true)
default boolean willExplode(@Nonnull
 org.bukkit.Location l,
 @Nonnull
 SlimefunBlockData data)

Deprecated, for removal: This API element is subject to removal in a future version.

Use willExplode(Location, ASlimefunDataContainer) instead

Parameters:

l - The Location of this EnergyNetProvider

data - The stored block data

Returns:

Whether or not this Location will explode.

willExplode

@Deprecated(forRemoval=true)
default boolean willExplode(@Nonnull
 org.bukkit.Location l,
 @Nonnull
 Config data)

Deprecated, for removal: This API element is subject to removal in a future version.

use willExplode(Location, SlimefunBlockData) instead This method only for backward compatibility.

Parameters:

l - The Location of this EnergyNetProvider

data - The stored block data

Returns:

Whether or not this Location will explode.