Package com.velocitypowered.api.event.permission

Class PermissionsSetupEvent

java.lang.Object
com.velocitypowered.api.event.permission.PermissionsSetupEvent
@AwaitingEvent public final class PermissionsSetupEvent extends Object
Called when a PermissionSubject's permissions are being setup. This event is typically called for the ConsoleCommandSource and any Players who join the proxy.

This event is only called once per subject, on initialisation.

Velocity will wait for this event to finish firing before proceeding further with server startup (for the console command source) and logins (for players) but it is strongly recommended to minimize the amount of work that must be done in this event.

  • Constructor Details

    • PermissionsSetupEvent

      public PermissionsSetupEvent(PermissionSubject subject, PermissionProvider provider)
      Constructs a new PermissionsSetupEvent.
      Parameters:
      subject - the subject (e.g., player or console) whose permissions are being initialized
      provider - the default permission provider used for the subject

  • Method Details

    • getSubject

      public PermissionSubject getSubject()
      Gets the subject whose permissions are being initialized.
      Returns:
      the permission subject

    • createFunction

      public PermissionFunction createFunction(PermissionSubject subject)
      Uses the provider function to obtain a PermissionFunction for the subject.
      Parameters:
      subject - the subject
      Returns:
      the obtained permission function

    • getProvider

      public PermissionProvider getProvider()
      Gets the current PermissionProvider in use for this subject.
      Returns:
      the permission provider

    • setProvider

      public void setProvider(@Nullable PermissionProvider provider)
      Sets the PermissionFunction that should be used for the subject.

      Specifying null will reset the provider to the default instance given when the event was posted.

      Parameters:
      provider - the provider

    • toString

      public String toString()
      Overrides:
      toString in class Object