java.lang.Object

net.minecraftforge.common.capabilities.CapabilityProvider

All Implemented Interfaces:: ICapabilityProvider, ICapabilityProviderImpl

Direct Known Subclasses:: BlockEntity, CapabilityProvider.AsField, Entity, ItemStack, Level

@ParametersAreNonnullByDefault public abstract class CapabilityProvider> extends Object implements ICapabilityProviderImpl

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

CapabilityProvider.AsField>

Special implementation for cases which have a superclass and can't extend CapabilityProvider directly.
Field Summary

Fields

Modifier and Type

Field

Description

private final @NotNull Class

baseClass

private @Nullable CapabilityDispatcher

capabilities

private boolean

initialized

private boolean

isLazy

private CompoundTag

lazyData

private Supplier<ICapabilityProvider>

lazyParentSupplier

(package private) static boolean

SUPPORTS_LAZY_CAPABILITIES

private boolean

valid
Constructor Summary

Constructors

Modifier

Constructor

Description

protected

CapabilityProvider(Class baseClass)

protected

CapabilityProvider(Class baseClass, boolean isLazy)
Method Summary

Modifier and Type

Method

Description

final boolean

areCapsCompatible(@Nullable CapabilityDispatcher other)

final boolean

areCapsCompatible(CapabilityProvider other)

protected final void

deserializeCaps(CompoundTag tag)

private void

doGatherCapabilities(@Nullable ICapabilityProvider parent)

protected final void

gatherCapabilities()

protected final void

gatherCapabilities(@Nullable Supplier<ICapabilityProvider> parent)

protected final void

gatherCapabilities(@Nullable ICapabilityProvider parent)

protected final @Nullable CapabilityDispatcher

getCapabilities()

<T> @NotNull LazyOptional<T>

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

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

(package private) B

getProvider()

void

invalidateCaps()

void

reviveCaps()

protected final @Nullable CompoundTag

serializeCaps()

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

Field Details
- SUPPORTS_LAZY_CAPABILITIES
 
 @VisibleForTesting static boolean SUPPORTS_LAZY_CAPABILITIES
- baseClass
 
 @NotNull private final @NotNull Class> baseClass
- capabilities
 
 @Nullable private @Nullable CapabilityDispatcher capabilities
- valid
 
 private boolean valid
- isLazy
 
 private boolean isLazy
- lazyParentSupplier
 
 private Supplier<ICapabilityProvider> lazyParentSupplier
- lazyData
 
 private CompoundTag lazyData
- initialized
 
 private boolean initialized
Constructor Details
- CapabilityProvider
 
 protected CapabilityProvider(Class baseClass)
- CapabilityProvider
 
 protected CapabilityProvider(Class baseClass, boolean isLazy)
Method Details
- gatherCapabilities
 
 protected final void gatherCapabilities()
- gatherCapabilities
 
 protected final void gatherCapabilities(@Nullable @Nullable ICapabilityProvider parent)
- gatherCapabilities
 
 protected final void gatherCapabilities(@Nullable @Nullable Supplier<ICapabilityProvider> parent)
- doGatherCapabilities
 
 private void doGatherCapabilities(@Nullable @Nullable ICapabilityProvider parent)
- getProvider
 
 @NotNull B getProvider()
- getCapabilities
 
 @Nullable protected final @Nullable CapabilityDispatcher getCapabilities()
- areCapsCompatible
 
 public final boolean areCapsCompatible(CapabilityProvider other)
 
 Specified by:
 
 areCapsCompatible in interface ICapabilityProviderImpl>
- areCapsCompatible
 
 public final boolean areCapsCompatible(@Nullable @Nullable CapabilityDispatcher other)
 
 Specified by:
 
 areCapsCompatible in interface ICapabilityProviderImpl>
- serializeCaps
 
 @Nullable protected final @Nullable CompoundTag serializeCaps()
- deserializeCaps
 
 protected final void deserializeCaps(CompoundTag tag)
- invalidateCaps
 
 public void invalidateCaps()
 
 Specified by:
 
 invalidateCaps in interface ICapabilityProviderImpl>
- reviveCaps
 
 public void reviveCaps()
 
 Specified by:
 
 reviveCaps in interface ICapabilityProviderImpl>
- getCapability
 
 @NotNull public <T> @NotNull LazyOptional<T> getCapability(@NotNull @NotNull 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.

Class CapabilityProvider<B extends ICapabilityProviderImpl<B>>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

SUPPORTS_LAZY_CAPABILITIES

baseClass

capabilities

valid

isLazy

lazyParentSupplier

lazyData

initialized

Constructor Details

CapabilityProvider

CapabilityProvider

Method Details

gatherCapabilities

gatherCapabilities

gatherCapabilities

doGatherCapabilities

getProvider

getCapabilities

areCapsCompatible

areCapsCompatible

serializeCaps

deserializeCaps

invalidateCaps

reviveCaps

getCapability