net.minecraftforge.eventbus.api.Event

net.minecraftforge.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 ForgeEventFactory.getPlayerDisplayName(Player, Component).

username contains the username of the player. displayname contains the display name of the player.
This event is not Cancelable.
This event does not have a result. Event.HasResult
This event is fired on the MinecraftForge.EVENT_BUS.

Nested Class Summary

Nested classes/interfaces inherited from class net.minecraftforge.event.entity.player.PlayerEvent
PlayerEvent.BreakSpeed, PlayerEvent.Clone, PlayerEvent.HarvestCheck, PlayerEvent.ItemCraftedEvent, PlayerEvent.ItemPickupEvent, 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.minecraftforge.event.entity.living.LivingEvent
LivingEvent.LivingJumpEvent, LivingEvent.LivingTickEvent, LivingEvent.LivingVisibilityEvent

Nested classes/interfaces inherited from class net.minecraftforge.event.entity.EntityEvent
EntityEvent.EnteringSection, EntityEvent.EntityConstructing, EntityEvent.Size

Nested classes/interfaces inherited from class net.minecraftforge.eventbus.api.Event
net.minecraftforge.eventbus.api.Event.HasResult, net.minecraftforge.eventbus.api.Event.Result
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.minecraftforge.event.entity.player.PlayerEvent
getEntity

Methods inherited from class net.minecraftforge.eventbus.api.Event
getListenerList, getPhase, getResult, hasResult, isCancelable, isCanceled, setCanceled, setPhase, setResult

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)

Class PlayerEvent.NameFormat

Nested Class Summary

Nested classes/interfaces inherited from class net.minecraftforge.event.entity.player.PlayerEvent

Nested classes/interfaces inherited from class net.minecraftforge.event.entity.living.LivingEvent

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

Nested classes/interfaces inherited from class net.minecraftforge.eventbus.api.Event

Field Summary

Constructor Summary

Method Summary

Methods inherited from class net.minecraftforge.event.entity.player.PlayerEvent

Methods inherited from class net.minecraftforge.eventbus.api.Event

Methods inherited from class java.lang.Object

Field Details

username

displayname

Constructor Details

NameFormat

Method Details

getUsername

getDisplayname

setDisplayname