org.spongepowered.api.data.manipulator.mutable

Interface DisplayNameData

All Superinterfaces:

DataManipulator<DisplayNameData,ImmutableDisplayNameData>, DataSerializable, ValueContainer<DisplayNameData>

public interface DisplayNameData
extends DataManipulator<DisplayNameData,ImmutableDisplayNameData>

Represents the display name of an ItemStack, Entity, or TileEntity.

Exceptions are made with written books as the title and display name are one and the same.

Method Summary

Modifier and Type	Method and Description
Value<Text>	displayName() Gets the display name as a Text.

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

displayName

Value<Text> displayName()

Gets the display name as a Text. The display name may be player set, or it may be undefined.

Returns:

The display name, if available

See Also:

Keys.DISPLAY_NAME