PlayerNameFormatEvent

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.

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

Extends

PlayerNameFormatEvent extends PlayerEvent.

Listening to the event

This event can be listened to like so:

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

Members

// NameFormat.displayName as Component
event.displayName

Return Type: Component

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

Parameters:

displayname: Component Type: Component

// NameFormat.entity as Player
event.entity

Return Type: Player

// NameFormat.entity as LivingEntity
event.entity

Return Type: LivingEntity

// NameFormat.entity as Entity
event.entity

Return Type: Entity

// NameFormat.hasResult as bool
event.hasResult

Return Type: bool

// NameFormat.hasResult() as bool;
event.hasResult();

Return Type: bool

// NameFormat.result as Result
event.result

Return Type: EventResult

// NameFormat.result = (result as Result);
event.result = myResult;

Parameters:

result: EventResult Type: EventResult

// NameFormat.result() as Result;
event.result();

Return Type: EventResult

// NameFormat.result(result as Result);
event.result(myResult);

Parameters:

result: EventResult Type: EventResult

sets the event's result to allow

// NameFormat.setAllow();
event.setAllow();

sets the event's result to default

// NameFormat.setDefault();
event.setDefault();

sets the event's result to deny

// NameFormat.setDeny();
event.setDeny();

// NameFormat.username as Component
event.username

Return Type: Component

PlayerNameFormatEvent

Importing the class

Extends

Listening to the event

Members