Package org.spongepowered.api.map

Interface MapInfo

All Superinterfaces:

DataHolder, DataHolder.Mutable, DataSerializable, Identifiable, ValueContainer

public interface MapInfo
extends DataHolder.Mutable, Identifiable, DataSerializable

Represents data that may be viewed on a map. A MapInfo may be attached to multiple maps.

See Also:

Keys.MAP_INFO

Nested Class Summary

Nested classes/interfaces inherited from interface org.spongepowered.api.data.DataHolder

DataHolder.Immutable<I extends DataHolder.Immutable<I>>, DataHolder.Mutable

Method Summary

Modifier and Type	Method	Description
void	addBannerDecoration(ServerLocation bannerLocation)	Adds the banner at the given location to this map.
boolean	isLinked(ItemStack itemStack)	Gets whether the supplied ItemStack is backed by this MapInfo, such that modifications to this MapInfo would affect the supplied stack.
DataContainer	toContainer()	Serializes this object into a comprehensible DataContainer.

Methods inherited from interface org.spongepowered.api.data.DataHolder.Mutable

copyFrom, copyFrom, offer, offer, offer, offer, offerAll, offerAll, offerAll, offerAll, offerAll, offerAll, offerSingle, offerSingle, offerSingle, offerSingle, remove, remove, remove, removeAll, removeAll, removeAll, removeAll, removeAll, removeAll, removeKey, removeKey, removeSingle, removeSingle, transform, transform, tryOffer, tryOffer, tryOffer, undo

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

contentVersion

Methods inherited from interface org.spongepowered.api.util.Identifiable

uniqueId

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

get, getDouble, getInt, getKeys, getLong, getOrElse, getOrNull, getValue, getValues, require, requireValue, supports, supports

Method Detail

isLinked

boolean isLinked(ItemStack itemStack)

Gets whether the supplied ItemStack is backed by this MapInfo, such that modifications to this MapInfo would affect the supplied stack.

This will always return false if the supplied ItemStack is not of type ItemTypes.FILLED_MAP.

Parameters:

itemStack - The ItemStack to check

Returns:

true if this MapInfo backs the supplied ItemStack

addBannerDecoration

void addBannerDecoration(ServerLocation bannerLocation)
                  throws IllegalArgumentException

Adds the banner at the given location to this map. This is equivalent to right clicking a banner in the world with the corresponding map.

Parameters:

bannerLocation - Location of the banner to add.

Throws:

IllegalArgumentException - if the given location is not a banner

IllegalArgumentException - if the given banner

toContainer

DataContainer toContainer()

Serializes this object into a comprehensible DataContainer.

This has special behaviour for serializing MapDecorations

A MapDecoration on this MapCanvas is only serialized if MapDecoration.isPersistent() returns true. This is because non-persistent MapDecorations belong more to the area than the map itself. If you wish to serialize them anyway, obtain the MapDecorations using Keys.MAP_DECORATIONS and serialize each individually.

Specified by:

toContainer in interface DataSerializable

Returns:

A newly created DataContainer