net.minecraftforge.common.capabilities

Interface ICapabilityProvider

All Known Subinterfaces:

ICapabilitySerializable<T>

All Known Implementing Classes:

AbstractChestHorse, AbstractClientPlayer, AbstractHorse, AbstractIllager, AbstractSkeleton, BlockJukebox.TileEntityJukebox, CapabilityAnimation.DefaultItemAnimationCapabilityProvider, CapabilityDispatcher, Chunk, EmptyChunk, Entity, EntityAgeable, EntityAmbientCreature, EntityAnimal, EntityAreaEffectCloud, EntityArmorStand, EntityArrow, EntityBat, EntityBlaze, EntityBoat, EntityCaveSpider, EntityChicken, EntityCow, EntityCreature, EntityCreeper, EntityDonkey, EntityDragon, EntityDragonFireball, EntityEgg, EntityElderGuardian, EntityEnderCrystal, EntityEnderEye, EntityEnderman, EntityEndermite, EntityEnderPearl, EntityEvoker, EntityEvokerFangs, EntityExpBottle, EntityFallingBlock, EntityFireball, EntityFireworkRocket, EntityFishHook, EntityFlying, EntityGhast, EntityGiantZombie, EntityGolem, EntityGuardian, EntityHanging, EntityHorse, EntityHusk, EntityIllusionIllager, EntityIronGolem, EntityItem, EntityItemFrame, EntityLargeFireball, EntityLeashKnot, EntityLightningBolt, EntityLiving, EntityLivingBase, EntityLlama, EntityLlamaSpit, EntityMagmaCube, EntityMinecart, EntityMinecartChest, EntityMinecartCommandBlock, EntityMinecartContainer, EntityMinecartEmpty, EntityMinecartFurnace, EntityMinecartHopper, EntityMinecartMobSpawner, EntityMinecartTNT, EntityMob, EntityMooshroom, EntityMule, EntityOcelot, EntityOtherPlayerMP, EntityPainting, EntityParrot, EntityPig, EntityPigZombie, EntityPlayer, EntityPlayerMP, EntityPlayerSP, EntityPolarBear, EntityPotion, EntityRabbit, EntitySheep, EntityShoulderRiding, EntityShulker, EntityShulkerBullet, EntitySilverfish, EntitySkeleton, EntitySkeletonHorse, EntitySlime, EntitySmallFireball, EntitySnowball, EntitySnowman, EntitySpectralArrow, EntitySpellcasterIllager, EntitySpider, EntitySquid, EntityStray, EntityTameable, EntityThrowable, EntityTippedArrow, EntityTNTPrimed, EntityVex, EntityVillager, EntityVindicator, EntityWaterMob, EntityWeatherEffect, EntityWitch, EntityWither, EntityWitherSkeleton, EntityWitherSkull, EntityWolf, EntityXPOrb, EntityZombie, EntityZombieHorse, EntityZombieVillager, FakePlayer, FluidBucketWrapper, FluidHandlerItemStack, FluidHandlerItemStack.Consumable, FluidHandlerItemStack.SwapEmpty, FluidHandlerItemStackSimple, FluidHandlerItemStackSimple.Consumable, FluidHandlerItemStackSimple.SwapEmpty, ItemStack, MultiPartEntityPart, TileEntity, TileEntityBanner, TileEntityBeacon, TileEntityBed, TileEntityBrewingStand, TileEntityChest, TileEntityCommandBlock, TileEntityComparator, TileEntityDaylightDetector, TileEntityDispenser, TileEntityDropper, TileEntityEnchantmentTable, TileEntityEnderChest, TileEntityEndGateway, TileEntityEndPortal, TileEntityFlowerPot, TileEntityFurnace, TileEntityHopper, TileEntityLockable, TileEntityLockableLoot, TileEntityMobSpawner, TileEntityNote, TileEntityPiston, TileEntityShulkerBox, TileEntitySign, TileEntitySkull, TileEntityStructure, TileFluidHandler, Village, World, WorldClient, WorldServer, WorldServerDemo, WorldServerMulti

public interface ICapabilityProvider

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.

Method Detail

hasCapability

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

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 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.

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 getCapability(Capability, EnumFacing) must not return null.

getCapability

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

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).

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 hasCapability(Capability, EnumFacing) would return true.