Class PlayerEvent.TabListNameFormat

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.event.entity.EntityEvent

net.neoforged.neoforge.event.entity.living.LivingEvent

net.neoforged.neoforge.event.entity.player.PlayerEvent

net.neoforged.neoforge.event.entity.player.PlayerEvent.TabListNameFormat

Enclosing class:

PlayerEvent

public static class PlayerEvent.TabListNameFormat
extends PlayerEvent

TabListNameFormat is fired when a player's display name for the tablist is retrieved.

This event is fired whenever a player's display name for the tablist is retrieved in ServerPlayer.getTabListDisplayName() or ServerPlayer.refreshTabListName().

This event is fired via the EventHooks.getPlayerTabListDisplayName(Player).

getDisplayName() contains the display name of the player or null if the client should determine the display name itself.

This event is not cancellable, and is fired on the game event bus.

Nested Class Summary

Nested classes/interfaces inherited from class PlayerEvent

PlayerEvent.BreakSpeed, PlayerEvent.Clone, PlayerEvent.HarvestCheck, PlayerEvent.ItemCraftedEvent, PlayerEvent.ItemSmeltedEvent, PlayerEvent.LoadFromFile, PlayerEvent.NameFormat, PlayerEvent.PlayerChangedDimensionEvent, PlayerEvent.PlayerChangeGameModeEvent, PlayerEvent.PlayerLoggedInEvent, PlayerEvent.PlayerLoggedOutEvent, PlayerEvent.PlayerRespawnEvent, PlayerEvent.SaveToFile, PlayerEvent.StartTracking, PlayerEvent.StopTracking, PlayerEvent.TabListNameFormat

Nested classes/interfaces inherited from class LivingEvent

LivingEvent.LivingJumpEvent, LivingEvent.LivingVisibilityEvent

Nested classes/interfaces inherited from class EntityEvent

EntityEvent.EnteringSection, EntityEvent.EntityConstructing, EntityEvent.Size

Field Summary

Fields

Modifier and Type	Field	Description
private @Nullable Component	displayName

Constructor Summary

Constructors

Constructor	Description
TabListNameFormat(Player player)

Method Summary

Modifier and Type	Method	Description
@Nullable Component	getDisplayName()
void	setDisplayName(@Nullable Component displayName)

Methods inherited from class PlayerEvent

getEntity

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

displayName

private @Nullable Component displayName

Constructor Details

TabListNameFormat

public TabListNameFormat(Player player)

Method Details

getDisplayName

public @Nullable Component getDisplayName()

setDisplayName

public void setDisplayName(@Nullable Component displayName)