buildcraft.api.statements

Class StatementParameterItemStack

java.lang.Object

buildcraft.api.statements.StatementParameterItemStack

All Implemented Interfaces:

IConvertable, IGuiSlot, IStatementParameter

public class StatementParameterItemStack
extends java.lang.Object
implements IStatementParameter

Nested Class Summary

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

IStatementParameter.DrawType

Field Summary

Fields

Modifier and Type	Field and Description
protected net.minecraft.item.ItemStack	stack

Constructor Summary

Constructors

Constructor and Description
StatementParameterItemStack()
StatementParameterItemStack(net.minecraft.item.ItemStack stack)
StatementParameterItemStack(net.minecraft.nbt.NBTTagCompound nbt)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object object)
java.lang.String	getDescription() Return the description in the UI.
net.minecraft.item.ItemStack	getItemStack()
IStatementParameter[]	getPossible(IStatementContainer source)
ISprite	getSprite()
java.util.List<java.lang.String>	getTooltip()
java.lang.String	getUniqueTag() Every statement needs a unique tag, it should be in the format of "<modid>:<name>".
int	hashCode()
StatementParameterItemStack	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.
IStatementParameter	rotateLeft() This returns the parameter after a left rotation.
void	writeToNbt(net.minecraft.nbt.NBTTagCompound compound)

Methods inherited from class java.lang.Object

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

Methods inherited from interface buildcraft.api.statements.IStatementParameter

getDrawType, isPossibleOrdered, writeToBuf

Methods inherited from interface buildcraft.api.core.IConvertable

convertTo

Field Detail

stack

@Nonnull
protected final net.minecraft.item.ItemStack stack

Constructor Detail

StatementParameterItemStack

public StatementParameterItemStack()

StatementParameterItemStack

public StatementParameterItemStack(@Nonnull
                                   net.minecraft.item.ItemStack stack)

StatementParameterItemStack

public StatementParameterItemStack(net.minecraft.nbt.NBTTagCompound nbt)

Method Detail

writeToNbt

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

Specified by:

writeToNbt in interface IStatementParameter

getSprite

public ISprite getSprite()

Specified by:

getSprite in interface IGuiSlot

Returns:

A sprite to show in a GUI, or null if this should not render a sprite.

getItemStack

@Nonnull
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.

onClick

public StatementParameterItemStack 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)

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getDescription

public java.lang.String getDescription()

Description copied from interface: IGuiSlot

Return the description in the UI. Note that this should NEVER be called directly, instead this acts as a bridge for IGuiSlot.getTooltip(). (As such this might return null or throw an exception)

Specified by:

getDescription in interface IGuiSlot

getTooltip

public java.util.List<java.lang.String> getTooltip()

Specified by:

getTooltip in interface IGuiSlot

Returns:

The full tooltip for the UI.

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

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.