io.github.nucleuspowered.nucleus.api.events

Interface NucleusChangeNicknameEvent

All Superinterfaces:

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

All Known Subinterfaces:

NucleusChangeNicknameEvent.Pre

Deprecated.

Use NucleusChangeNicknameEvent.Pre instead, this will become a common interface to include Post in v2.0.

@MightOccurAsync
 @Deprecated
public interface NucleusChangeNicknameEvent
extends org.spongepowered.api.event.Cancellable, org.spongepowered.api.event.user.TargetUserEvent

Fired when a player requests or deletes a nickname.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
org.spongepowered.api.text.Text	getNewNickname() Deprecated. Use getNickname() instead
Optional<org.spongepowered.api.text.Text>	getNickname() Deprecated. The new nickname, if any, for the TargetUserEvent.getTargetUser()
Optional<org.spongepowered.api.text.Text>	getPreviousNickname() Deprecated. The previous nickname for the TargetUserEvent.getTargetUser()

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

isCancelled, setCancelled

Methods inherited from interface org.spongepowered.api.event.user.TargetUserEvent

getTargetUser

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

getCause, getContext, getSource

Method Detail

getPreviousNickname

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

Deprecated.

The previous nickname for the TargetUserEvent.getTargetUser()

Returns:

The previous nickname.

getNewNickname

@Deprecated
org.spongepowered.api.text.Text getNewNickname()

Deprecated. Use getNickname() instead

The new nickname for the TargetUserEvent.getTargetUser()

Returns:

The nickname, or the player name if no nickname.

getNickname

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

Deprecated.

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

Returns:

The nickname, if any is given