net.minecraftforge.event

Class AttachCapabilitiesEvent<T>

java.lang.Object

net.minecraftforge.fml.common.eventhandler.Event

net.minecraftforge.fml.common.eventhandler.GenericEvent<T>

net.minecraftforge.event.AttachCapabilitiesEvent<T>

All Implemented Interfaces:

IGenericEvent<T>

Direct Known Subclasses:

AttachCapabilitiesEvent.Entity, AttachCapabilitiesEvent.Item, AttachCapabilitiesEvent.TileEntity, AttachCapabilitiesEvent.World

public class AttachCapabilitiesEvent<T>
extends GenericEvent<T>

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 Deprecated.
static class	AttachCapabilitiesEvent.Item A version of the parent event which is only fired for ItemStacks.
static class	AttachCapabilitiesEvent.TileEntity Deprecated.
static class	AttachCapabilitiesEvent.World Deprecated.

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.Class<T> type, T obj)
AttachCapabilitiesEvent(T obj) Deprecated.

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.
T	getObject() Retrieves the object that is being created, Not much state is set.

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

getGenericType

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

@Deprecated
public AttachCapabilitiesEvent(T obj)

Deprecated.

AttachCapabilitiesEvent

public AttachCapabilitiesEvent(java.lang.Class<T> type,
                               T obj)

Method Detail

getObject

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