com.comphenix.protocol.wrappers

Class WrappedAttribute

java.lang.Object

com.comphenix.protocol.wrappers.AbstractWrapper

com.comphenix.protocol.wrappers.WrappedAttribute

public class WrappedAttribute
extends AbstractWrapper

Represents a single attribute sent in packet 44.

Author:

Kristian

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WrappedAttribute.Builder Represents a builder for wrapped attributes.

Field Summary

Fields

Modifier and Type	Field and Description
protected Object	handle Reference to the underlying attribute snapshot.
protected StructureModifier<Object>	modifier

Fields inherited from class com.comphenix.protocol.wrappers.AbstractWrapper

handleType

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static WrappedAttribute	fromHandle(Object handle) Construct a new wrapped attribute around a specific NMS instance.
String	getAttributeKey() Retrieve the unique attribute key that identifies its function.
double	getBaseValue() Retrieve the base value of this attribute, before any of the modifiers have been taken into account.
double	getFinalValue() Retrieve the final computed value.
WrappedAttributeModifier	getModifierByUUID(UUID id) Retrieve an attribute modifier by UUID.
Set<WrappedAttributeModifier>	getModifiers() Retrieve an immutable set of all the attribute modifiers that will compute the final value of this attribute.
PacketContainer	getParentPacket() Retrieve the parent update attributes packet.
int	hashCode()
boolean	hasModifier(UUID id) Determine if the attribute has a given attribute modifier, identified by UUID.
static WrappedAttribute.Builder	newBuilder() Construct a new wrapped attribute builder.
static WrappedAttribute.Builder	newBuilder(WrappedAttribute template) Construct a new wrapped attribute builder initialized to the values from a template.
String	toString()
WrappedAttribute	withModifiers(Collection<WrappedAttributeModifier> modifiers) Construct an attribute with the same key and name, but a different list of modifiers.

Methods inherited from class com.comphenix.protocol.wrappers.AbstractWrapper

getHandle, getHandleType, setHandle

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

handle

protected Object handle

Reference to the underlying attribute snapshot.

modifier

protected StructureModifier<Object> modifier

Method Detail

fromHandle

public static WrappedAttribute fromHandle(@Nonnull
                                          Object handle)

Construct a new wrapped attribute around a specific NMS instance.

Parameters:

handle - - handle to a NMS AttributeSnapshot.

Returns:

The attribute wrapper.

Throws:

IllegalArgumentException - If the handle is not a AttributeSnapshot.

newBuilder

public static WrappedAttribute.Builder newBuilder()

Construct a new wrapped attribute builder.

Returns:

The new builder.

newBuilder

public static WrappedAttribute.Builder newBuilder(@Nonnull
                                                  WrappedAttribute template)

Construct a new wrapped attribute builder initialized to the values from a template.

Parameters:

template - - the attribute template.

Returns:

The new builder.

getAttributeKey

public String getAttributeKey()

Retrieve the unique attribute key that identifies its function.

Example: "generic.maxHealth"

Returns:

The attribute key.

getBaseValue

public double getBaseValue()

Retrieve the base value of this attribute, before any of the modifiers have been taken into account.

Returns:

The base value.

getFinalValue

public double getFinalValue()

Retrieve the final computed value.

Returns:

The final value.

getParentPacket

public PacketContainer getParentPacket()

Retrieve the parent update attributes packet.

Returns:

The parent packet.

hasModifier

public boolean hasModifier(UUID id)

Determine if the attribute has a given attribute modifier, identified by UUID.

Parameters:

id - - the id to check for.

Returns:

TRUE if it does, FALSE otherwise.

getModifierByUUID

public WrappedAttributeModifier getModifierByUUID(UUID id)

Retrieve an attribute modifier by UUID.

Parameters:

id - - the id to look for.

Returns:

The single attribute modifier with the given ID.

getModifiers

public Set<WrappedAttributeModifier> getModifiers()

Retrieve an immutable set of all the attribute modifiers that will compute the final value of this attribute.

Returns:

Every attribute modifier.

withModifiers

public WrappedAttribute withModifiers(Collection<WrappedAttributeModifier> modifiers)

Construct an attribute with the same key and name, but a different list of modifiers.

Parameters:

modifiers - - attribute modifiers.

Returns:

The new attribute.

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractWrapper

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractWrapper

toString

public String toString()

Overrides:

toString in class AbstractWrapper