net.minecraftforge.common.capabilities

Class CapabilityDispatcher

java.lang.Object

net.minecraftforge.common.capabilities.CapabilityDispatcher

All Implemented Interfaces:

ICapabilityProvider, INBTSerializable<NBTTagCompound>

public final class CapabilityDispatcher
extends java.lang.Object
implements INBTSerializable<NBTTagCompound>, ICapabilityProvider

A high-speed implementation of a capability delegator. This is used to wrap the results of the AttachCapabilitiesEvent. It is HIGHLY recommended that you DO NOT use this approach unless you MUST delegate to multiple providers instead just implement y our handlers using normal if statements. Internally the handlers are baked into arrays for fast iteration. The ResourceLocations will be used for the NBT Key when serializing.

Field Summary

Fields

Modifier and Type	Field and Description
private ICapabilityProvider[]	caps
private java.lang.String[]	names
private INBTSerializable<NBTBase>[]	writers

Constructor Summary

Constructors

Constructor and Description
CapabilityDispatcher(java.util.Map<ResourceLocation,ICapabilityProvider> list)
CapabilityDispatcher(java.util.Map<ResourceLocation,ICapabilityProvider> list, ICapabilityProvider parent)

Method Summary

Modifier and Type	Method and Description
boolean	areCompatible(CapabilityDispatcher other)
void	deserializeNBT(NBTTagCompound nbt)
<T> T	getCapability(Capability<T> capability, EnumFacing facing) Retrieves the handler for the capability requested on the specific side.
boolean	hasCapability(Capability<?> capability, EnumFacing facing) Determines if this object has support for the capability in question on the specific side.
NBTTagCompound	serializeNBT()

Methods inherited from class java.lang.Object

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

Field Detail

caps

private ICapabilityProvider[] caps

writers

private INBTSerializable<NBTBase>[] writers

names

private java.lang.String[] names

Constructor Detail

CapabilityDispatcher

public CapabilityDispatcher(java.util.Map<ResourceLocation,ICapabilityProvider> list)

CapabilityDispatcher

public CapabilityDispatcher(java.util.Map<ResourceLocation,ICapabilityProvider> list,
                            @Nullable
                            ICapabilityProvider parent)

Method Detail

hasCapability

public boolean hasCapability(@Nonnull
                             Capability<?> capability,
                             @Nullable
                             EnumFacing facing)

Description copied from interface: ICapabilityProvider

Determines if this object has support for the capability in question on the specific side. The return value of this MIGHT change during runtime if this object gains or loses support for a capability. It is not required to call this function before calling ICapabilityProvider.getCapability(Capability, EnumFacing).

Basically, this method functions analogously to Map.containsKey(Object).

Example: A Pipe getting a cover placed on one side causing it lose the Inventory attachment function for that side.

This is a light weight version of getCapability, intended for metadata uses.

Specified by:

hasCapability in interface ICapabilityProvider

Parameters:

capability - The capability to check

facing - The Side to check from: CAN BE NULL. Null is defined to represent 'internal' or 'self'

Returns:

True if this object supports the capability. If true, then ICapabilityProvider.getCapability(Capability, EnumFacing) must not return null.

getCapability

@Nullable
public <T> T getCapability(@Nonnull
                                     Capability<T> capability,
                                     @Nullable
                                     EnumFacing facing)

Description copied from interface: ICapabilityProvider

Retrieves the handler for the capability requested on the specific side.

• The return value CAN be null if the object does not support the capability.
• The return value CAN be the same for multiple faces.

Basically, this method functions analogously to Map.get(Object).

Specified by:

getCapability in interface ICapabilityProvider

Parameters:

capability - The capability to check

facing - The Side to check from, CAN BE NULL. Null is defined to represent 'internal' or 'self'

Returns:

The requested capability. Must NOT be null when ICapabilityProvider.hasCapability(Capability, EnumFacing) would return true.

serializeNBT

public NBTTagCompound serializeNBT()

Specified by:

serializeNBT in interface INBTSerializable<NBTTagCompound>

deserializeNBT

public void deserializeNBT(NBTTagCompound nbt)

Specified by:

deserializeNBT in interface INBTSerializable<NBTTagCompound>

areCompatible

public boolean areCompatible(CapabilityDispatcher other)