org.spongepowered.api.data.manipulator.mutable.entity

Interface ActiveItemData

All Superinterfaces:

DataManipulator<ActiveItemData,ImmutableActiveItemData>, DataSerializable, ValueContainer<ActiveItemData>

public interface ActiveItemData
extends DataManipulator<ActiveItemData,ImmutableActiveItemData>

A DataManipulator which allows access to the active item that a Living may be using. For example this includes a food a player is currently eating or a shield they are blocking with.

If there is no item, the snapshot will be empty. You can check this with ItemStackSnapshot.isEmpty().

Method Summary

Modifier and Type	Method and Description
Value<ItemStackSnapshot>	activeItem() Gets the item stack snapshot of the item that is currently being used.

Methods inherited from interface org.spongepowered.api.data.manipulator.DataManipulator

asImmutable, copy, fill, fill, from, set, set, set, set, transform

Methods inherited from interface org.spongepowered.api.data.DataSerializable

getContentVersion, toContainer

Methods inherited from interface org.spongepowered.api.data.value.ValueContainer

get, getKeys, getOrElse, getOrNull, getValue, getValues, require, supports, supports

Method Detail

activeItem

Value<ItemStackSnapshot> activeItem()

Gets the item stack snapshot of the item that is currently being used.

If there is no item, the snapshot will be empty. You can check this with ItemStackSnapshot.isEmpty().

Returns:

The value of the snapshot of the item being used