net.minecraftforge.event.entity.player

Class PlayerEvent.NameFormat

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 PlayerEntity.getDisplayName() for the first time or if PlayerEntity.refreshDisplayName() is called.

This event is fired via ForgeEventFactory.getPlayerDisplayName(PlayerEntity, String) or ForgeEventFactory.getPlayerDisplayName(PlayerEntity, ITextComponent).

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. 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.PlayerLoggedInEvent, PlayerEvent.PlayerLoggedOutEvent, PlayerEvent.PlayerRespawnEvent, PlayerEvent.SaveToFile, PlayerEvent.StartTracking, PlayerEvent.StopTracking, PlayerEvent.Visibility

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

LivingEvent.LivingJumpEvent, LivingEvent.LivingUpdateEvent

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

EntityEvent.CanUpdate, EntityEvent.EnteringChunk, EntityEvent.EntityConstructing, EntityEvent.EyeHeight

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 and Description
private java.lang.String	displayname
private ITextComponent	displaynameComponent
private java.lang.String	username
private ITextComponent	usernameComponent

Constructor Summary

Constructors

Constructor and Description
NameFormat(PlayerEntity player, ITextComponent username)
NameFormat(PlayerEntity player, java.lang.String username) Deprecated.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDisplayname() Deprecated.
ITextComponent	getDisplaynameComponent()
java.lang.String	getUsername() Deprecated.
ITextComponent	getUsernameComponent()
void	setDisplayname(java.lang.String displayname) Deprecated.
void	setDisplaynameComponent(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 java.lang.String username

displayname

private java.lang.String displayname

usernameComponent

private final ITextComponent usernameComponent

displaynameComponent

private ITextComponent displaynameComponent

Constructor Detail

NameFormat

@Deprecated
public NameFormat(PlayerEntity player,
                              java.lang.String username)

Deprecated.

Removed in 1.16. Use NameFormat(PlayerEntity, ITextComponent)

NameFormat

public NameFormat(PlayerEntity player,
                  ITextComponent username)

Method Detail

getUsername

@Deprecated
public java.lang.String getUsername()

Deprecated.

Removed in 1.16. Use getUsernameComponent()

getDisplayname

@Deprecated
public java.lang.String getDisplayname()

Deprecated.

Removed in 1.16. Use getDisplaynameComponent()

setDisplayname

@Deprecated
public void setDisplayname(java.lang.String displayname)

Deprecated.

Removed in 1.16. Use setDisplaynameComponent(ITextComponent)

getUsernameComponent

public ITextComponent getUsernameComponent()

getDisplaynameComponent

public ITextComponent getDisplaynameComponent()

setDisplaynameComponent

public void setDisplaynameComponent(ITextComponent displayname)