buildcraft.core.patterns

Enum PatternParameterXZDir

java.lang.Object

java.lang.Enum<PatternParameterXZDir>

buildcraft.core.patterns.PatternParameterXZDir

All Implemented Interfaces:

IGuiSlot, IStatementParameter, java.io.Serializable, java.lang.Comparable<PatternParameterXZDir>

public enum PatternParameterXZDir
extends java.lang.Enum<PatternParameterXZDir>
implements IStatementParameter

Nested Class Summary

Nested classes/interfaces inherited from interface buildcraft.api.statements.IStatementParameter

IStatementParameter.DrawType

Enum Constant Summary

Enum Constants

Enum Constant and Description
EAST
NORTH
SOUTH
WEST

Field Summary

Fields

Modifier and Type	Field and Description
net.minecraft.util.EnumFacing	dir

Method Summary

Modifier and Type	Method and Description
static PatternParameterXZDir	get(net.minecraft.util.EnumFacing face)
java.lang.String	getDescription() Return the description in the UI.
net.minecraft.item.ItemStack	getItemStack()
IStatementParameter[]	getPossible(IStatementContainer source)
ISprite	getSprite()
java.lang.String	getUniqueTag() Every statement needs a unique tag, it should be in the format of "<modid>:<name>".
boolean	isPossibleOrdered()
PatternParameterXZDir	onClick(IStatementContainer source, IStatement stmt, net.minecraft.item.ItemStack stack, StatementMouseClick mouse) Return a non-null value to be set as the statement parameter if you handled the mouse click and do not want all possible values to be shown, or null if you did nothing and wish to show all possible values.
static PatternParameterXZDir	readFromNbt(net.minecraft.nbt.NBTTagCompound nbt)
IStatementParameter	rotateLeft() This returns the parameter after a left rotation.
static PatternParameterXZDir	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PatternParameterXZDir[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
void	writeToNbt(net.minecraft.nbt.NBTTagCompound nbt)

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface buildcraft.api.statements.IStatementParameter

getDrawType, writeToBuf

Methods inherited from interface buildcraft.api.statements.IGuiSlot

getTooltip

Enum Constant Detail

WEST

public static final PatternParameterXZDir WEST

EAST

public static final PatternParameterXZDir EAST

NORTH

public static final PatternParameterXZDir NORTH

SOUTH

public static final PatternParameterXZDir SOUTH

Field Detail

dir

public final net.minecraft.util.EnumFacing dir

Method Detail

values

public static PatternParameterXZDir[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PatternParameterXZDir c : PatternParameterXZDir.values())
    System.out.println(c);

Returns:

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

valueOf

public static PatternParameterXZDir valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

get

public static PatternParameterXZDir get(net.minecraft.util.EnumFacing face)

readFromNbt

public static PatternParameterXZDir readFromNbt(net.minecraft.nbt.NBTTagCompound nbt)

writeToNbt

public void writeToNbt(net.minecraft.nbt.NBTTagCompound nbt)

Specified by:

writeToNbt in interface IStatementParameter

getUniqueTag

public java.lang.String getUniqueTag()

Description copied from interface: IGuiSlot

Every statement needs a unique tag, it should be in the format of "<modid>:<name>".

Specified by:

getUniqueTag in interface IGuiSlot

Returns:

the unique id

getSprite

public ISprite getSprite()

Specified by:

getSprite in interface IGuiSlot

Returns:

A sprite to show in a GUI or in-world (so this must be stitched into the block texture atlas), or null if this should not render a sprite.

getItemStack

public net.minecraft.item.ItemStack getItemStack()

Specified by:

getItemStack in interface IStatementParameter

Returns:

An ItemStack to render for this parameter, or ItemStack.EMPTY if this should not render an ItemStack.

getDescription

public java.lang.String getDescription()

Description copied from interface: IGuiSlot

Return the description in the UI.

Specified by:

getDescription in interface IGuiSlot

onClick

public PatternParameterXZDir onClick(IStatementContainer source,
                                     IStatement stmt,
                                     net.minecraft.item.ItemStack stack,
                                     StatementMouseClick mouse)

Description copied from interface: IStatementParameter

Return a non-null value to be set as the statement parameter if you handled the mouse click and do not want all possible values to be shown, or null if you did nothing and wish to show all possible values.

Specified by:

onClick in interface IStatementParameter

See Also:

IStatementParameter.getPossible(IStatementContainer)

rotateLeft

public IStatementParameter rotateLeft()

Description copied from interface: IStatementParameter

This returns the parameter after a left rotation. Used in particular in blueprints orientation.

Specified by:

rotateLeft in interface IStatementParameter

getPossible

public IStatementParameter[] getPossible(IStatementContainer source)

Specified by:

getPossible in interface IStatementParameter

Returns:

An array of all the possible alternative params for this state. Note that the return array may contain null if you want to space out the values.

isPossibleOrdered

public boolean isPossibleOrdered()

Specified by:

isPossibleOrdered in interface IStatementParameter

Returns:

True if the possible array is set up specially for a direction, or false if they are not. This affects the selection hover layout. If this returns false then IStatementParameter.getPossible(IStatementContainer) will be offset up by one, null added to 0, and all other nulls removed.