io.github.nucleuspowered.nucleus.api.module.nickname.event

Interface NucleusChangeNicknameEvent

All Superinterfaces:

org.spongepowered.api.event.Event

All Known Subinterfaces:

NucleusChangeNicknameEvent.Post, NucleusChangeNicknameEvent.Pre

@MightOccurAsync
public interface NucleusChangeNicknameEvent
extends org.spongepowered.api.event.Event

Fired when a player requests or deletes a nickname.

Ensure that you listen for NucleusChangeNicknameEvent.Pre or NucleusChangeNicknameEvent.Post, rather than this base event.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	NucleusChangeNicknameEvent.Post
static interface	NucleusChangeNicknameEvent.Pre

Method Summary

Modifier and Type	Method and Description
java.util.Optional<org.spongepowered.api.text.Text>	getNickname() The new nickname, if any, for the getUser()
java.util.Optional<org.spongepowered.api.text.Text>	getPreviousNickname() The previous nickname for the getUser()
org.spongepowered.api.entity.living.player.User	getUser() The user whose nickname was changed.

Methods inherited from interface org.spongepowered.api.event.Event

getCause, getContext, getSource

Method Detail

getUser

org.spongepowered.api.entity.living.player.User getUser()

The user whose nickname was changed.

Returns:

The User

getPreviousNickname

java.util.Optional<org.spongepowered.api.text.Text> getPreviousNickname()

The previous nickname for the getUser()

Returns:

The previous nickname.

getNickname

java.util.Optional<org.spongepowered.api.text.Text> getNickname()

The new nickname, if any, for the getUser()

Returns:

The nickname, if any is given