Previous
PlayerLoggedOutEvent PlayerRespawnEvent
Next

PlayerNameFormatEvent

Importing the class

If you need to reference this type directly, like when casting an Array, or as a parameter, you will need to import it. Simply add the import at the top of the file.

script.zs
import crafttweaker.neoforge.api.event.entity.player.PlayerNameFormatEvent;

Extends

PlayerNameFormatEvent extends PlayerEvent.

Listening to the event

This event can be listened to like so:

script.zs
events.register<crafttweaker.neoforge.api.event.entity.player.PlayerNameFormatEvent>(event => {
    println("PlayerNameFormatEvent ran!");
});

Members

displayName
Getter
script.zs
// NameFormat.displayName as Component
event.displayName

Return Type: Component

Setter
script.zs
// NameFormat.displayName = (displayname as Component);
event.displayName = myComponent;

Parameters:

displayname Type: Component
entity
Getter
script.zs
// NameFormat.entity as Player
event.entity

Return Type: Player

Getter
script.zs
// NameFormat.entity as LivingEntity
event.entity

Return Type: LivingEntity

Getter
script.zs
// NameFormat.entity as Entity
event.entity

Return Type: Entity

username
Getter
script.zs
// NameFormat.username as Component
event.username

Return Type: Component

Previous
PlayerLoggedOutEvent PlayerRespawnEvent
Next