Package org.bukkit.permissions
Class PermissionAttachment
java.lang.Object
org.bukkit.permissions.PermissionAttachment
Holds information about a permission attachment on a
Permissible
object-
Constructor Summary
ConstructorDescriptionPermissionAttachment
(@NotNull Plugin plugin, @NotNull Permissible permissible) -
Method Summary
Modifier and TypeMethodDescriptionGets the Permissible that this is attached toGets a copy of all set permissions and values contained within this attachment.Gets the plugin responsible for this attachmentGets the class that was previously set to be called when this attachment was removed from aPermissible
.boolean
remove()
Removes this attachment from its registeredPermissible
void
setPermission
(@NotNull String name, boolean value) Sets a permission to the given value, by its fully qualified namevoid
setPermission
(@NotNull Permission perm, boolean value) Sets a permission to the given valuevoid
Sets an object to be called for when this attachment is removed from aPermissible
.void
unsetPermission
(@NotNull String name) Removes the specified permission from this attachment.void
Removes the specified permission from this attachment.
-
Constructor Details
-
PermissionAttachment
-
-
Method Details
-
getPlugin
Gets the plugin responsible for this attachment- Returns:
- Plugin responsible for this permission attachment
-
setRemovalCallback
Sets an object to be called for when this attachment is removed from aPermissible
. May be null.- Parameters:
ex
- Object to be called when this is removed
-
getRemovalCallback
Gets the class that was previously set to be called when this attachment was removed from aPermissible
. May be null.- Returns:
- Object to be called when this is removed
-
getPermissible
Gets the Permissible that this is attached to- Returns:
- Permissible containing this attachment
-
getPermissions
Gets a copy of all set permissions and values contained within this attachment.This map may be modified but will not affect the attachment, as it is a copy.
- Returns:
- Copy of all permissions and values expressed by this attachment
-
setPermission
Sets a permission to the given value, by its fully qualified name- Parameters:
name
- Name of the permissionvalue
- New value of the permission
-
setPermission
Sets a permission to the given value- Parameters:
perm
- Permission to setvalue
- New value of the permission
-
unsetPermission
Removes the specified permission from this attachment.If the permission does not exist in this attachment, nothing will happen.
- Parameters:
name
- Name of the permission to remove
-
unsetPermission
Removes the specified permission from this attachment.If the permission does not exist in this attachment, nothing will happen.
- Parameters:
perm
- Permission to remove
-
remove
public boolean remove()Removes this attachment from its registeredPermissible
- Returns:
- true if the permissible was removed successfully, false if it did not exist
-