net.minecraftforge.common.capabilities

Class Capability<T>

java.lang.Object

net.minecraftforge.common.capabilities.Capability<T>

public class Capability<T>
extends java.lang.Object

This is the core holder object Capabilities. Each capability will have ONE instance of this class, and it will the the one passed into the ICapabilityProvider functions. The CapabilityManager is in charge of creating this class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Capability.IStorage<T>

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.concurrent.Callable<? extends T>	factory
private java.lang.String	name
private Capability.IStorage<T>	storage

Constructor Summary

Constructors

Constructor and Description
Capability(java.lang.String name, Capability.IStorage<T> storage, java.util.concurrent.Callable<? extends T> factory)

Method Summary

Modifier and Type	Method and Description
<R> R	cast(T instance) Use this inside ICapabilityProvider.getCapability to avoid unchecked cast warnings.
T	getDefaultInstance() A NEW instance of the default implementation.
java.lang.String	getName()
Capability.IStorage<T>	getStorage()
void	readNBT(T instance, EnumFacing side, NBTBase nbt) Quick access to the IStorage's readNBT.
NBTBase	writeNBT(T instance, EnumFacing side) Quick access to the IStorage's writeNBT.

Methods inherited from class java.lang.Object

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

Field Detail

name

private final java.lang.String name

storage

private final Capability.IStorage<T> storage

factory

private final java.util.concurrent.Callable<? extends T> factory

Constructor Detail

Capability

Capability(java.lang.String name,
           Capability.IStorage<T> storage,
           java.util.concurrent.Callable<? extends T> factory)

Method Detail

getName

public java.lang.String getName()

Returns:

The unique name of this capability, typically this is the fully qualified class name for the target interface.

getStorage

public Capability.IStorage<T> getStorage()

Returns:

An instance of the default storage handler. You can safely use this store your default implementation in NBT.

readNBT

public void readNBT(T instance,
                    EnumFacing side,
                    NBTBase nbt)

Quick access to the IStorage's readNBT. See Capability.IStorage.readNBT(Capability, Object, EnumFacing, NBTBase) for documentation.

writeNBT

@Nullable
public NBTBase writeNBT(T instance,
                                  EnumFacing side)

Quick access to the IStorage's writeNBT. See Capability.IStorage.writeNBT(Capability, Object, EnumFacing) for documentation.

getDefaultInstance

@Nullable
public T getDefaultInstance()

A NEW instance of the default implementation. If it important to note that if you want to use the default storage you may be required to use this exact implementation. Refer to the owning API of the Capability in question.

Returns:

A NEW instance of the default implementation.

cast

public <R> R cast(T instance)

Use this inside ICapabilityProvider.getCapability to avoid unchecked cast warnings. Example: return SOME_CAPABILITY.cast(instance); Use with caution;