Package net.neoforged.neoforge.event.entity.player

Class PlayerEvent.NameFormat

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.NameFormat

Enclosing class:

PlayerEvent

public static class PlayerEvent.NameFormat
extends PlayerEvent

NameFormat is fired when a player's display name is retrieved.

This event is fired whenever a player's name is retrieved in Player.getDisplayName() or Player.refreshDisplayName().

This event is fired via the EventHooks.getPlayerDisplayName(Player, Component).

• username contains the username of the player.
• displayname contains the display name of the player.

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

Nested Class Summary

Nested classes/interfaces inherited from class net.neoforged.neoforge.event.entity.player.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 net.neoforged.neoforge.event.entity.living.LivingEvent

LivingEvent.LivingJumpEvent, LivingEvent.LivingVisibilityEvent

Nested classes/interfaces inherited from class net.neoforged.neoforge.event.entity.EntityEvent

EntityEvent.EnteringSection, EntityEvent.EntityConstructing, EntityEvent.Size

Field Summary

Fields

Modifier and Type	Field	Description
private Component	displayname
private final Component	username

Constructor Summary

Constructors

Constructor	Description
NameFormat(Player player, Component username)

Method Summary

Modifier and Type	Method	Description
Component	getDisplayname()
Component	getUsername()
void	setDisplayname(Component displayname)

Methods inherited from class net.neoforged.neoforge.event.entity.player.PlayerEvent

getEntity

Methods inherited from class java.lang.Object

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

Field Details

username

private final Component username

displayname

private Component displayname

Constructor Details

NameFormat

public NameFormat(Player player,
 Component username)

Method Details

getUsername

public Component getUsername()

getDisplayname

public Component getDisplayname()

setDisplayname

public void setDisplayname(Component displayname)