me.lucko.luckperms.api.event.user.track

Interface UserTrackEvent

All Superinterfaces:

LuckPermsEvent, Sourced

All Known Subinterfaces:

UserDemoteEvent, UserPromoteEvent

public interface UserTrackEvent
extends LuckPermsEvent, Sourced

Called when a user interacts with a track through a promotion or demotion

Method Summary

Modifier and Type	Method and Description
TrackAction	getAction() Gets the action performed
Optional<String>	getGroupFrom() Gets the group the user was promoted/demoted from.
Optional<String>	getGroupTo() Gets the group the user was promoted/demoted to
Track	getTrack() Gets the track involved in the event
User	getUser() Gets the user who was promoted or demoted

Methods inherited from interface me.lucko.luckperms.api.event.LuckPermsEvent

getApi

Methods inherited from interface me.lucko.luckperms.api.event.Sourced

getSource

Method Detail

getTrack

@Nonnull
Track getTrack()

Gets the track involved in the event

Returns:

the track involved in the event

getUser

@Nonnull
User getUser()

Gets the user who was promoted or demoted

Returns:

the user involved in the event

getAction

@Nonnull
TrackAction getAction()

Gets the action performed

Returns:

the action performed

getGroupFrom

@Nonnull
Optional<String> getGroupFrom()

Gets the group the user was promoted/demoted from.

May be Optional.empty() if the user wasn't already placed on the track.

Returns:

the group the user was promoted/demoted from

getGroupTo

@Nonnull
Optional<String> getGroupTo()

Gets the group the user was promoted/demoted to

Returns:

the group the user was promoted/demoted to