SPIGOT-6308: Deprecate the location name property of map items

This property does not have the expected effect.
This commit is contained in:
blablubbabc 2023-04-17 19:33:15 +10:00 committed by md_5
parent cd04a31b0d
commit ccb2d01b80
No known key found for this signature in database
GPG key ID: E8E901AC7C617C11

View file

@ -107,7 +107,10 @@ public interface MapMeta extends ItemMeta {
* Checks for existence of a location name. * Checks for existence of a location name.
* *
* @return true if this has a location name * @return true if this has a location name
* @deprecated This method does not have the expected effect and is
* actually an alias for {@link ItemMeta#hasLocalizedName()}.
*/ */
@Deprecated
boolean hasLocationName(); boolean hasLocationName();
/** /**
@ -117,16 +120,21 @@ public interface MapMeta extends ItemMeta {
* before calling this method. * before calling this method.
* *
* @return the location name that is set * @return the location name that is set
* @deprecated This method does not have the expected effect and is
* actually an alias for {@link ItemMeta#getLocalizedName()}.
*/ */
@Deprecated
@Nullable @Nullable
String getLocationName(); String getLocationName();
/** /**
* Sets the location name. A custom map color will alter the display of the * Sets the location name.
* map in an inventory slot.
* *
* @param name the name to set * @param name the name to set
* @deprecated This method does not have the expected effect and is
* actually an alias for {@link ItemMeta#setLocalizedName(String)}.
*/ */
@Deprecated
void setLocationName(@Nullable String name); void setLocationName(@Nullable String name);
/** /**