net.minecraftforge.common.model.animation

Class CapabilityAnimation.DefaultItemAnimationCapabilityProvider

java.lang.Object

net.minecraftforge.common.model.animation.CapabilityAnimation.DefaultItemAnimationCapabilityProvider

All Implemented Interfaces:

ICapabilityProvider

Enclosing class:

CapabilityAnimation

public static class CapabilityAnimation.DefaultItemAnimationCapabilityProvider
extends java.lang.Object
implements ICapabilityProvider

Field Summary

Fields

Modifier and Type	Field and Description
private IAnimationStateMachine	asm

Constructor Summary

Constructors

Constructor and Description
DefaultItemAnimationCapabilityProvider(IAnimationStateMachine asm)

Method Summary

Modifier and Type	Method and Description
<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.

Methods inherited from class java.lang.Object

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

Field Detail

asm

private final IAnimationStateMachine asm

Constructor Detail

DefaultItemAnimationCapabilityProvider

public DefaultItemAnimationCapabilityProvider(IAnimationStateMachine asm)

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.