Package io.github.thebusybiscuit.slimefun4.core.networks.energy

Class EnergyNet

java.lang.Object

io.github.thebusybiscuit.slimefun4.api.network.Network

io.github.thebusybiscuit.slimefun4.core.networks.energy.EnergyNet

All Implemented Interfaces:

HologramOwner, ItemAttribute

public class EnergyNet
extends Network
implements HologramOwner

The EnergyNet is an implementation of Network that deals with electrical energy being sent from and to nodes.

Author:

meiamsome, TheBusyBiscuit

See Also:

• Network
• EnergyNetComponent
• EnergyNetProvider
• EnergyNetComponentType

Field Summary

Fields inherited from class io.github.thebusybiscuit.slimefun4.api.network.Network

connectedLocations, connectorNodes, regulator, regulatorNodes, terminusNodes

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EnergyNet(org.bukkit.Location l)

Method Summary

Modifier and Type	Method	Description
NetworkComponent	classifyLocation(org.bukkit.Location l)	This method assigns the given Location a type of NetworkComponent for classification.
Map<org.bukkit.Location,EnergyNetComponent>	getCapacitors()	This creates an immutable Map of EnergyNetComponentType.CAPACITOR EnergyNetComponents within this EnergyNet instance.
Map<org.bukkit.Location,EnergyNetComponent>	getConsumers()	This creates an immutable Map of EnergyNetComponentType.CONSUMER EnergyNetComponents within this EnergyNet instance.
Map<org.bukkit.Location,EnergyNetProvider>	getGenerators()	This creates an immutable Map of EnergyNetProviders within this EnergyNet instance.
String	getId()	Returns the identifier of the associated SlimefunItem.
static EnergyNet	getNetworkFromLocation(org.bukkit.Location l)	This attempts to get an EnergyNet from a given Location.
static EnergyNet	getNetworkFromLocationOrCreate(org.bukkit.Location l)	This attempts to get an EnergyNet from a given Location.
int	getRange()	This method returns the range of the Network.
void	onClassificationChange(org.bukkit.Location l, NetworkComponent from, NetworkComponent to)	This method is called whenever a Location in this Network changes its classification.
void	tick(org.bukkit.block.Block b, SlimefunBlockData blockData)

Methods inherited from class io.github.thebusybiscuit.slimefun4.api.network.Network

addLocationToNetwork, connectsTo, display, getRegulator, getSize, markDirty, tick

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getHologramOffset, removeHologram, updateHologram, updateHologram

Constructor Details

EnergyNet

protected EnergyNet(@Nonnull
 org.bukkit.Location l)

Method Details

getRange

public int getRange()

Description copied from class: Network

This method returns the range of the Network. The range determines how far the Network will search for nearby nodes from any given node. It basically translates to the maximum distance between nodes.

Specified by:

getRange in class Network

Returns:

the range of this Network

getGenerators

@Nonnull
public Map<org.bukkit.Location,EnergyNetProvider> getGenerators()

This creates an immutable Map of EnergyNetProviders within this EnergyNet instance.

Returns:

An immutable Map of generators

getCapacitors

@Nonnull
public Map<org.bukkit.Location,EnergyNetComponent> getCapacitors()

This creates an immutable Map of EnergyNetComponentType.CAPACITOR EnergyNetComponents within this EnergyNet instance.

Returns:

An immutable Map of capacitors

getConsumers

@Nonnull
public Map<org.bukkit.Location,EnergyNetComponent> getConsumers()

This creates an immutable Map of EnergyNetComponentType.CONSUMER EnergyNetComponents within this EnergyNet instance.

Returns:

An immutable Map of consumers

getId

@Nonnull
public String getId()

Description copied from interface: ItemAttribute

Returns the identifier of the associated SlimefunItem.

Specified by:

getId in interface ItemAttribute

Returns:

the identifier of the SlimefunItem

classifyLocation

public NetworkComponent classifyLocation(@Nonnull
 org.bukkit.Location l)

Description copied from class: Network

This method assigns the given Location a type of NetworkComponent for classification.

Specified by:

classifyLocation in class Network

Parameters:

l - The Location to classify

Returns:

The assigned type of NetworkComponent for this Location

onClassificationChange

public void onClassificationChange(org.bukkit.Location l,
 NetworkComponent from,
 NetworkComponent to)

Description copied from class: Network

This method is called whenever a Location in this Network changes its classification.

Specified by:

onClassificationChange in class Network

Parameters:

l - The Location that is changing its classification

from - The NetworkComponent this Location was previously classified as

to - The NetworkComponent this Location is changing to

tick

public void tick(@Nonnull
 org.bukkit.block.Block b,
 SlimefunBlockData blockData)

getNetworkFromLocation

@Nullable
public static EnergyNet getNetworkFromLocation(@Nonnull
 org.bukkit.Location l)

This attempts to get an EnergyNet from a given Location. If no suitable EnergyNet could be found, null will be returned.

Parameters:

l - The target Location

Returns:

The EnergyNet at that Location, or null

getNetworkFromLocationOrCreate

@Nonnull
public static EnergyNet getNetworkFromLocationOrCreate(@Nonnull
 org.bukkit.Location l)

This attempts to get an EnergyNet from a given Location. If no suitable EnergyNet could be found, a new one will be created.

Parameters:

l - The target Location

Returns:

The EnergyNet at that Location, or a new one