Package net.minecraftforge.common.capabilities

Class CapabilityDispatcher

java.lang.Object

net.minecraftforge.common.capabilities.CapabilityDispatcher

All Implemented Interfaces:

ICapabilityProvider, INBTSerializable<CompoundTag>

@ParametersAreNonnullByDefault
public final class CapabilityDispatcher
extends Object
implements INBTSerializable<CompoundTag>, 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	Description
private final ICapabilityProvider[]	caps
private final List<Runnable>	listeners
private final String[]	names
private final INBTSerializable<Tag>[]	writers

Constructor Summary

Constructors

Constructor	Description
CapabilityDispatcher(Map<ResourceLocation,ICapabilityProvider> list, List<Runnable> listeners)
CapabilityDispatcher(Map<ResourceLocation,ICapabilityProvider> list, List<Runnable> listeners, @Nullable ICapabilityProvider parent)

Method Summary

Modifier and Type	Method	Description
boolean	areCompatible(@Nullable CapabilityDispatcher other)
void	deserializeNBT(CompoundTag nbt)
<T> LazyOptional<T>	getCapability(Capability<T> cap, @Nullable Direction side)	Retrieves the Optional handler for the capability requested on the specific side.
void	invalidate()
CompoundTag	serializeNBT()

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.minecraftforge.common.capabilities.ICapabilityProvider

getCapability

Methods inherited from interface net.minecraftforge.common.util.INBTSerializable

deserializeNBT, serializeNBT

Field Details

caps

private final ICapabilityProvider[] caps

writers

private final INBTSerializable<Tag>[] writers

names

private final String[] names

listeners

private final List<Runnable> listeners

Constructor Details

CapabilityDispatcher

public CapabilityDispatcher(Map<ResourceLocation,ICapabilityProvider> list,
 List<Runnable> listeners)

CapabilityDispatcher

public CapabilityDispatcher(Map<ResourceLocation,ICapabilityProvider> list,
 List<Runnable> listeners,
 @Nullable
 @Nullable ICapabilityProvider parent)

Method Details

getCapability

public <T> LazyOptional<T> getCapability(Capability<T> cap,
 @Nullable
 @Nullable Direction side)

Description copied from interface: ICapabilityProvider

Retrieves the Optional handler for the capability requested on the specific side. The return value CAN be the same for multiple faces. Modders are encouraged to cache this value, using the listener capabilities of the Optional to be notified if the requested capability get lost.

Specified by:

getCapability in interface ICapabilityProvider

Parameters:

cap - The capability to check

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

Returns:

The requested an optional holding the requested capability.

serializeNBT

public CompoundTag serializeNBT()

Specified by:

serializeNBT in interface INBTSerializable<CompoundTag>

deserializeNBT

public void deserializeNBT(CompoundTag nbt)

Specified by:

deserializeNBT in interface INBTSerializable<CompoundTag>

areCompatible

public boolean areCompatible(@Nullable
 @Nullable CapabilityDispatcher other)

invalidate

public void invalidate()