net.minecraftforge.event

Class AttachCapabilitiesEvent

java.lang.Object

net.minecraftforge.fml.common.eventhandler.Event

net.minecraftforge.event.AttachCapabilitiesEvent

Direct Known Subclasses:

AttachCapabilitiesEvent.Entity, AttachCapabilitiesEvent.Item, AttachCapabilitiesEvent.TileEntity

public class AttachCapabilitiesEvent
extends Event

Fired whenever an object with Capabilities support {currently TileEntity/Item/Entity) is created. Allowing for the attachment of arbitrary capability providers. Please note that as this is fired for ALL object creations efficient code is recommended. And if possible use one of the sub-classes to filter your intended objects.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AttachCapabilitiesEvent.Entity A version of the parent event which is only fired for Entities.
static class	AttachCapabilitiesEvent.Item A version of the parent event which is only fired for ItemStacks.
static class	AttachCapabilitiesEvent.TileEntity A version of the parent event which is only fired for Tile Entities.

Nested classes/interfaces inherited from class net.minecraftforge.fml.common.eventhandler.Event

Event.HasResult, Event.Result

Constructor Summary

Constructors

Constructor and Description
AttachCapabilitiesEvent(java.lang.Object obj)

Method Summary

Modifier and Type	Method and Description
void	addCapability(ResourceLocation key, ICapabilityProvider cap) Adds a capability to be attached to this object.
java.util.Map<ResourceLocation,ICapabilityProvider>	getCapabilities() A unmodifiable view of the capabilities that will be attached to this object.
java.lang.Object	getObject() Retrieves the object that is being created, Not much state is set.

Methods inherited from class net.minecraftforge.fml.common.eventhandler.Event

getListenerList, getPhase, getResult, hasResult, isCancelable, isCanceled, setCanceled, setPhase, setResult, setup

Methods inherited from class java.lang.Object

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

Constructor Detail

AttachCapabilitiesEvent

public AttachCapabilitiesEvent(java.lang.Object obj)

Method Detail

getObject

public java.lang.Object getObject()

Retrieves the object that is being created, Not much state is set.

addCapability

public void addCapability(ResourceLocation key,
                          ICapabilityProvider cap)

Adds a capability to be attached to this object. Keys MUST be unique, it is suggested that you set the domain to your mod ID. If the capability is an instance of INBTSerializable, this key will be used when serializing this capability.

Parameters:

key - The name of owner of this capability provider.

cap - The capability provider

getCapabilities

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

A unmodifiable view of the capabilities that will be attached to this object.