li.cil.oc.api.prefab

Class DriverItem

java.lang.Object

li.cil.oc.api.prefab.DriverItem

All Implemented Interfaces:

Item

public abstract class DriverItem
extends java.lang.Object
implements Item

If you wish to create item components such as the network card or hard drives you will need an item driver.

This prefab allows creating a driver that works for a specified list of item stacks (to support different items with the same id but different damage values). It also takes care of creating and getting the tag compound on an item stack to save data to or load data from.

You still have to specify your component's slot type and provide the implementation for creating its environment, if any.

See Also:

ManagedEnvironment

Field Summary

Fields

Modifier and Type	Field and Description
protected net.minecraft.item.ItemStack[]	items

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DriverItem(net.minecraft.item.ItemStack... items)

Method Summary

Methods

Modifier and Type	Method and Description
net.minecraft.nbt.NBTTagCompound	dataTag(net.minecraft.item.ItemStack stack) Get the tag compound based on the item stack to use for persisting the environment associated with the specified item stack.
int	tier(net.minecraft.item.ItemStack stack) The tier of the specified item this driver supports.
boolean	worksWith(net.minecraft.item.ItemStack stack) Used to determine the item types this driver handles.

Methods inherited from class java.lang.Object

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

Methods inherited from interface li.cil.oc.api.driver.Item

createEnvironment, slot

Field Detail

items

protected final net.minecraft.item.ItemStack[] items

Constructor Detail

DriverItem

protected DriverItem(net.minecraft.item.ItemStack... items)

Method Detail

worksWith

public boolean worksWith(net.minecraft.item.ItemStack stack)

Description copied from interface: Item

Used to determine the item types this driver handles.

This is used to determine which driver to use for an item when it should be installed in a computer. Note that the return value should not change over time; if it does, though, an already installed component will not be ejected, since this value is only checked when adding components.

Specified by:

worksWith in interface Item

Parameters:

stack - the item to check.

Returns:

true if the item is supported; false otherwise.

tier

public int tier(net.minecraft.item.ItemStack stack)

Description copied from interface: Item

The tier of the specified item this driver supports.

This is used to determine into which slot of a computer the components this driver supports may go. This will only be called if a previous call to Item.worksWith(net.minecraft.item.ItemStack) with the same stack returned true.

Important: tiers are zero-indexed.

Specified by:

tier in interface Item

Parameters:

stack - the item stack to get the tier for.

Returns:

the tier of the specified item.

dataTag

public net.minecraft.nbt.NBTTagCompound dataTag(net.minecraft.item.ItemStack stack)

Description copied from interface: Item

Get the tag compound based on the item stack to use for persisting the environment associated with the specified item stack.

This is only used if the item has an environment. This must always be a child tag of the item stack's own tag compound, it will not be saved otherwise. Use this in the unlikely case that the default name collides with something. The built-in components use a child tag-compound with the name oc:data, which will also be used if this returns null.

This tag will be passed to the environment's save and load methods when appropriate (world save / load and when removed from their hosting inventory).

Specified by:

dataTag in interface Item

Parameters:

stack - the item to get the child tag from.

Returns:

the tag to use for saving and loading, or null to use the default tag oc:data.