io.github.nucleuspowered.nucleus.api.events

Interface NucleusChangeNicknameEvent.Pre

All Superinterfaces:

org.spongepowered.api.event.Cancellable, org.spongepowered.api.event.Event, NucleusChangeNicknameEvent, org.spongepowered.api.event.user.TargetUserEvent

Enclosing interface:

NucleusChangeNicknameEvent

@MightOccurAsync
public static interface NucleusChangeNicknameEvent.Pre
extends NucleusChangeNicknameEvent, org.spongepowered.api.event.Cancellable

Nested Class Summary

Nested classes/interfaces inherited from interface io.github.nucleuspowered.nucleus.api.events.NucleusChangeNicknameEvent

NucleusChangeNicknameEvent.Post, NucleusChangeNicknameEvent.Pre

Method Summary

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

Methods inherited from interface io.github.nucleuspowered.nucleus.api.events.NucleusChangeNicknameEvent

getNewNickname

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

isCancelled, setCancelled

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

getCause, getContext, getSource

Method Detail

getTargetUser

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

The use whose nickname was changed.

Specified by:

getTargetUser in interface org.spongepowered.api.event.user.TargetUserEvent

Returns:

The User

getPreviousNickname

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

The previous nickname for the getTargetUser()

Specified by:

getPreviousNickname in interface NucleusChangeNicknameEvent

Returns:

The previous nickname.

getNickname

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

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

Specified by:

getNickname in interface NucleusChangeNicknameEvent

Returns:

The nickname, if any is given