Bukkit-API  1.7.9-R0.2
The inofficial Bukkit-API
org.bukkit.permissions.Permissible Interface Reference
Inheritance diagram for org.bukkit.permissions.Permissible:
org.bukkit.permissions.ServerOperator org.bukkit.command.CommandSender org.bukkit.entity.HumanEntity org.bukkit.permissions.PermissibleBase org.bukkit.command.BlockCommandSender org.bukkit.command.ConsoleCommandSender org.bukkit.command.RemoteConsoleCommandSender org.bukkit.entity.minecart.CommandMinecart org.bukkit.entity.Player org.bukkit.entity.Player

Public Member Functions

boolean isPermissionSet (String name)
 
boolean isPermissionSet (Permission perm)
 
boolean hasPermission (String name)
 
boolean hasPermission (Permission perm)
 
PermissionAttachment addAttachment (Plugin plugin, String name, boolean value)
 
PermissionAttachment addAttachment (Plugin plugin)
 
PermissionAttachment addAttachment (Plugin plugin, String name, boolean value, int ticks)
 
PermissionAttachment addAttachment (Plugin plugin, int ticks)
 
void removeAttachment (PermissionAttachment attachment)
 
void recalculatePermissions ()
 
Set< PermissionAttachmentInfogetEffectivePermissions ()
 
- Public Member Functions inherited from org.bukkit.permissions.ServerOperator
boolean isOp ()
 
void setOp (boolean value)
 

Detailed Description

Represents an object that may be assigned permissions

Definition at line 9 of file Permissible.java.

Member Function Documentation

PermissionAttachment org.bukkit.permissions.Permissible.addAttachment ( Plugin  plugin,
String  name,
boolean  value 
)

Adds a new PermissionAttachment with a single permission by name and value

Parameters
pluginPlugin responsible for this attachment, may not be null or disabled
nameName of the permission to attach
valueValue of the permission
Returns
The PermissionAttachment that was just created

Implemented in org.bukkit.permissions.PermissibleBase.

PermissionAttachment org.bukkit.permissions.Permissible.addAttachment ( Plugin  plugin)

Adds a new empty PermissionAttachment to this object

Parameters
pluginPlugin responsible for this attachment, may not be null or disabled
Returns
The PermissionAttachment that was just created

Implemented in org.bukkit.permissions.PermissibleBase.

PermissionAttachment org.bukkit.permissions.Permissible.addAttachment ( Plugin  plugin,
String  name,
boolean  value,
int  ticks 
)

Temporarily adds a new PermissionAttachment with a single permission by name and value

Parameters
pluginPlugin responsible for this attachment, may not be null or disabled
nameName of the permission to attach
valueValue of the permission
ticksAmount of ticks to automatically remove this attachment after
Returns
The PermissionAttachment that was just created

Implemented in org.bukkit.permissions.PermissibleBase.

PermissionAttachment org.bukkit.permissions.Permissible.addAttachment ( Plugin  plugin,
int  ticks 
)

Temporarily adds a new empty PermissionAttachment to this object

Parameters
pluginPlugin responsible for this attachment, may not be null or disabled
ticksAmount of ticks to automatically remove this attachment after
Returns
The PermissionAttachment that was just created

Implemented in org.bukkit.permissions.PermissibleBase.

Set<PermissionAttachmentInfo> org.bukkit.permissions.Permissible.getEffectivePermissions ( )

Gets a set containing all of the permissions currently in effect by this object

Returns
Set of currently effective permissions

Implemented in org.bukkit.permissions.PermissibleBase.

boolean org.bukkit.permissions.Permissible.hasPermission ( String  name)

Gets the value of the specified permission, if set.

If a permission override is not set on this object, the default value of the permission will be returned.

Parameters
nameName of the permission
Returns
Value of the permission

Implemented in org.bukkit.permissions.PermissibleBase.

Referenced by org.bukkit.command.Command.testPermissionSilent().

boolean org.bukkit.permissions.Permissible.hasPermission ( Permission  perm)

Gets the value of the specified permission, if set.

If a permission override is not set on this object, the default value of the permission will be returned

Parameters
permPermission to get
Returns
Value of the permission

Implemented in org.bukkit.permissions.PermissibleBase.

boolean org.bukkit.permissions.Permissible.isPermissionSet ( String  name)

Checks if this object contains an override for the specified permission, by fully qualified name

Parameters
nameName of the permission
Returns
true if the permission is set, otherwise false

Implemented in org.bukkit.permissions.PermissibleBase.

boolean org.bukkit.permissions.Permissible.isPermissionSet ( Permission  perm)

Checks if this object contains an override for the specified Permission

Parameters
permPermission to check
Returns
true if the permission is set, otherwise false

Implemented in org.bukkit.permissions.PermissibleBase.

void org.bukkit.permissions.Permissible.recalculatePermissions ( )

Recalculates the permissions for this object, if the attachments have changed values.

This should very rarely need to be called from a plugin.

Implemented in org.bukkit.permissions.PermissibleBase.

void org.bukkit.permissions.Permissible.removeAttachment ( PermissionAttachment  attachment)

Removes the given PermissionAttachment from this object

Parameters
attachmentAttachment to remove
Exceptions
IllegalArgumentExceptionThrown when the specified attachment isn't part of this object

Implemented in org.bukkit.permissions.PermissibleBase.


The documentation for this interface was generated from the following file: