net.lapismc.lapiscore

Class LapisCorePermissions

java.lang.Object

net.lapismc.lapiscore.LapisCorePermissions

public class LapisCorePermissions
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	LapisCorePermissions.PermissionManager

Constructor Summary

Constructors

Constructor and Description
LapisCorePermissions(LapisCorePlugin core)

Method Summary

Modifier and Type	Method and Description
PlayerPermission	calculatePermission(UUID uuid) Calculate the PlayerPermission for a player
org.bukkit.permissions.Permission	getAssignedPermission(UUID uuid) Get the Bukkit permission assigned to a player
protected org.bukkit.permissions.Permission	getOfflinePlayerPermission(UUID uuid) Override this method to provide a method of retrieving the players permission while they are offline
Integer	getPermissionValue(UUID uuid, LapisPermission permission) Get the raw Integer value of the permission for a player
boolean	isPermitted(UUID uuid, LapisPermission permission) Check if a player is given a permission
void	loadPermissions() Call this method to load the permission values from config once all of your LapisPermissions have been registered
void	registerPermissions(LapisPermission... permission) Register permissions with LapisPermission objects
protected void	savePlayersPermission(UUID uuid, org.bukkit.permissions.Permission perm) Override this method to save the players permission for retrieval when they are offline

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LapisCorePermissions

public LapisCorePermissions(LapisCorePlugin core)

Method Detail

registerPermissions

public void registerPermissions(LapisPermission... permission)

Register permissions with LapisPermission objects

Parameters:

permission - The permissions you wish to add

loadPermissions

public void loadPermissions()

Call this method to load the permission values from config once all of your LapisPermissions have been registered

getAssignedPermission

public org.bukkit.permissions.Permission getAssignedPermission(UUID uuid)

Get the Bukkit permission assigned to a player

Parameters:

uuid - The UUID of the player

Returns:

Returns the Bukkit Permission that the plugin is using for permission calculations

getPermissionValue

public Integer getPermissionValue(UUID uuid,
                                  LapisPermission permission)

Get the raw Integer value of the permission for a player

Parameters:

uuid - The UUID of the player

permission - The Permission you want a value for

Returns:

Returns the Integer value for the permission assigned to the player, returns 0 if a permission could not be calculated

isPermitted

public boolean isPermitted(UUID uuid,
                           LapisPermission permission)

Check if a player is given a permission

Parameters:

uuid - The UUID of the player

permission - The Permission you wish to check

Returns:

Returns true if the value of Permission is greater than 0 otherwise false

calculatePermission

public PlayerPermission calculatePermission(UUID uuid)

Calculate the PlayerPermission for a player

Parameters:

uuid - The UUID of the player

Returns:

Returns the PlayerPermission assigned to the player

getOfflinePlayerPermission

protected org.bukkit.permissions.Permission getOfflinePlayerPermission(UUID uuid)

Override this method to provide a method of retrieving the players permission while they are offline

Parameters:

uuid - The UUID of the player we want the permission of

Returns:

Return the Bukkit Permission that is assigned to this player

savePlayersPermission

protected void savePlayersPermission(UUID uuid,
                                     org.bukkit.permissions.Permission perm)

Override this method to save the players permission for retrieval when they are offline

Parameters:

uuid - The UUID of the player the permission is assigned to

perm - The permission the player has been assigned