Nassim Jahnke
f00727c57e
Co-authored-by: Bjarne Koll <git@lynxplay.dev> Co-authored-by: Jake Potrebic <jake.m.potrebic@gmail.com> Co-authored-by: Lulu13022002 <41980282+Lulu13022002@users.noreply.github.com> Co-authored-by: MiniDigger | Martin <admin@minidigger.dev> Co-authored-by: Nassim Jahnke <nassim@njahnke.dev> Co-authored-by: Noah van der Aa <ndvdaa@gmail.com> Co-authored-by: Owen1212055 <23108066+Owen1212055@users.noreply.github.com> Co-authored-by: Shane Freeder <theboyetronic@gmail.com> Co-authored-by: Spottedleaf <Spottedleaf@users.noreply.github.com> Co-authored-by: Tamion <70228790+notTamion@users.noreply.github.com> Co-authored-by: Warrior <50800980+Warriorrrr@users.noreply.github.com>
61 lines
1.8 KiB
Java
61 lines
1.8 KiB
Java
package org.bukkit;
|
|
|
|
import org.jetbrains.annotations.Nullable;
|
|
|
|
/**
|
|
* Represents a block, entity, or other object that may receive a custom name.
|
|
*/
|
|
public interface Nameable {
|
|
|
|
/**
|
|
* Gets the custom name.
|
|
*
|
|
* <p>This value has no effect on players, they will always use their real name.</p>
|
|
*
|
|
* @return the custom name
|
|
*/
|
|
net.kyori.adventure.text.@Nullable Component customName();
|
|
|
|
/**
|
|
* Sets the custom name.
|
|
*
|
|
* <p>This name will be used in death messages and can be sent to the client as a nameplate over the mob.</p>
|
|
*
|
|
* <p>Setting the name to {@code null} will clear it.</p>
|
|
*
|
|
* <p>This value has no effect on players, they will always use their real name.</p>
|
|
*
|
|
* @param customName the custom name to set
|
|
*/
|
|
void customName(final net.kyori.adventure.text.@Nullable Component customName);
|
|
|
|
/**
|
|
* Gets the custom name on a mob or block. If there is no name this method
|
|
* will return null.
|
|
* <p>
|
|
* This value has no effect on players, they will always use their real
|
|
* name.
|
|
*
|
|
* @deprecated in favour of {@link #customName()}
|
|
* @return name of the mob/block or null
|
|
*/
|
|
@Deprecated // Paper
|
|
@Nullable
|
|
public String getCustomName();
|
|
|
|
/**
|
|
* Sets a custom name on a mob or block. This name will be used in death
|
|
* messages and can be sent to the client as a nameplate over the mob.
|
|
* <p>
|
|
* Setting the name to null or an empty string will clear it.
|
|
* <p>
|
|
* This value has no effect on players, they will always use their real
|
|
* name.
|
|
*
|
|
* @deprecated in favour of {@link #customName(net.kyori.adventure.text.Component)}
|
|
* @param name the name to set
|
|
*/
|
|
@Deprecated // Paper
|
|
public void setCustomName(@Nullable String name);
|
|
}
|