Package net.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	Description
@NonNull TrackAction	getAction()	Gets the action performed
@NonNull Optional<String>	getGroupFrom()	Gets the group the user was promoted/demoted from.
@NonNull Optional<String>	getGroupTo()	Gets the group the user was promoted/demoted to
@NonNull Track	getTrack()	Gets the track involved in the event
@NonNull User	getUser()	Gets the user who was promoted or demoted

Methods inherited from interface net.luckperms.api.event.LuckPermsEvent

getEventType, getLuckPerms

Methods inherited from interface net.luckperms.api.event.type.Sourced

getSource

Method Details

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