Package appeng.api.networking.pathing

Enum Class ChannelMode

java.lang.Object

java.lang.Enum<ChannelMode>

appeng.api.networking.pathing.ChannelMode

All Implemented Interfaces:

Serializable, Comparable<ChannelMode>, Constable

public enum ChannelMode
extends Enum<ChannelMode>

Defines how AE2's channel capacities work.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DEFAULT	Default channel capacity per cable.
INFINITE	Cables carry infinite channels, effectively disabling pathfinding and channel requirements.
X2	Double capacity per cable.
X3	Triple capacity per cable.
X4	Quadruple capacity per cable.

Method Summary

Modifier and Type	Method	Description
int	getAdHocNetworkChannels()
int	getCableCapacityFactor()
static ChannelMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ChannelMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INFINITE

public static final ChannelMode INFINITE

Cables carry infinite channels, effectively disabling pathfinding and channel requirements.

DEFAULT

public static final ChannelMode DEFAULT

Default channel capacity per cable.

X2

public static final ChannelMode X2

Double capacity per cable.

X3

public static final ChannelMode X3

Triple capacity per cable.

X4

public static final ChannelMode X4

Quadruple capacity per cable.

Method Details

values

public static ChannelMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ChannelMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getAdHocNetworkChannels

public int getAdHocNetworkChannels()

Returns:

The maximum number of channels supported by ad-hoc networks. 0 disables any requirements.

getCableCapacityFactor

public int getCableCapacityFactor()

Returns:

Multiplier for the default capacity of cables. Must be a power of two. 0 disables cable capacity requirements altogether.