PlayerEvent.NameFormat (forge 1.16.5)

java.lang.Object
- net.minecraftforge.eventbus.api.Event
- - net.minecraftforge.event.entity.EntityEvent
  - - net.minecraftforge.event.entity.living.LivingEvent
    - - net.minecraftforge.event.entity.player.PlayerEvent
      - 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 EntityPlayer#getDisplayName() or EntityPlayer#refreshDisplayName().

This event is fired via the ForgeEventFactory#getPlayerDisplayName(EntityPlayer, String).

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, PlayerEvent.Visibility
- Nested classes/interfaces inherited from class net.minecraftforge.event.entity.living.LivingEvent
  LivingEvent.LivingJumpEvent, LivingEvent.LivingUpdateEvent, LivingEvent.LivingVisibilityEvent
- Nested classes/interfaces inherited from class net.minecraftforge.event.entity.EntityEvent
  EntityEvent.CanUpdate, EntityEvent.EnteringChunk, 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 ITextComponent displayname

private ITextComponent username

Constructor Summary

Constructors
Constructor Description

NameFormat(PlayerEntity player, ITextComponent username)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ITextComponent`	`getDisplayname()`
`ITextComponent`	`getUsername()`
`void`	`setDisplayname(ITextComponent displayname)`

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

Methods inherited from class net.minecraftforge.event.entity.living.LivingEvent
getEntityLiving

Methods inherited from class net.minecraftforge.event.entity.EntityEvent
getEntity

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

username
```
private final ITextComponent username
```

displayname
```
private ITextComponent displayname
```

Constructor Detail

NameFormat

public NameFormat(PlayerEntity player,
                  ITextComponent username)

Method Detail

getUsername
```
public ITextComponent getUsername()
```

getDisplayname

public ITextComponent getDisplayname()

setDisplayname

public void setDisplayname(ITextComponent displayname)