org.spongepowered.api.data.manipulator.immutable.entity

Interface ImmutableActiveItemData

All Superinterfaces:

DataSerializable, ImmutableDataManipulator<ImmutableActiveItemData,ActiveItemData>, ValueContainer<ImmutableActiveItemData>

public interface ImmutableActiveItemData
extends ImmutableDataManipulator<ImmutableActiveItemData,ActiveItemData>

An ImmutableDataManipulator 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
ImmutableValue<ItemStackSnapshot>	activeItem() Gets the item stack snapshot of the item that is currently being used.

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

asMutable, copy, with, with

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

ImmutableValue<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 immutable value of the snapshot of the item being used