Class PermissionsSetupEvent
- java.lang.Object
-
- com.velocitypowered.api.event.permission.PermissionsSetupEvent
-
@AwaitingEvent public final class PermissionsSetupEvent extends Object
Called when aPermissionSubject's permissions are being setup. This event is typically called for theConsoleCommandSourceand anyPlayers 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 Summary
Constructors Constructor Description PermissionsSetupEvent(PermissionSubject subject, PermissionProvider provider)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PermissionFunctioncreateFunction(PermissionSubject subject)Uses the provider function to obtain aPermissionFunctionfor the subject.PermissionProvidergetProvider()PermissionSubjectgetSubject()voidsetProvider(@Nullable PermissionProvider provider)Sets thePermissionFunctionthat should be used for the subject.StringtoString()
-
-
-
Constructor Detail
-
PermissionsSetupEvent
public PermissionsSetupEvent(PermissionSubject subject, PermissionProvider provider)
-
-
Method Detail
-
getSubject
public PermissionSubject getSubject()
-
createFunction
public PermissionFunction createFunction(PermissionSubject subject)
Uses the provider function to obtain aPermissionFunctionfor the subject.- Parameters:
subject- the subject- Returns:
- the obtained permission function
-
getProvider
public PermissionProvider getProvider()
-
setProvider
public void setProvider(@Nullable PermissionProvider provider)
Sets thePermissionFunctionthat should be used for the subject.Specifying
nullwill reset the provider to the default instance given when the event was posted.- Parameters:
provider- the provider
-
-