Package wtf.choco.locksecurity.api
Interface ILockSecurity
public interface ILockSecurity
Represents the LockSecurity plugin's core functionality
- Since:
- 3.0.0
- Author:
- Parker Hawke - Choco
-
Method Summary
Modifier and Type Method Description <T extends IKeyBuilder>
IKeyFactory<T>getKeyFactory(Class<T> type)
Get a key factory instance according to its type.ILockedBlockManager
getLockedBlockManager()
Get theILockedBlockManager
instance.ILockSecurityPlayer
getLockSecurityPlayer(org.bukkit.OfflinePlayer player)
Get anILockSecurityPlayer
wrapper for the givenOfflinePlayer
.String
getVersion()
Get LockSecurity's plugin version.boolean
isLockable(org.bukkit.Material material)
Get whether the suppliedMaterial
is lockable according to the LockSecurity configuration file.
-
Method Details
-
getVersion
Get LockSecurity's plugin version.- Returns:
- the plugin version
- Since:
- 3.0.1
-
getKeyFactory
Get a key factory instance according to its type.- Type Parameters:
T
- the type of key factory- Parameters:
type
- the type of key factory- Returns:
- the key factory. Must not be null
- Throws:
UnsupportedOperationException
- if the providedIKeyBuilder
is not supported by LockSecurity- See Also:
IKeyFactory.UNSMITHED
,IKeyFactory.SMITHED
-
getLockSecurityPlayer
Get anILockSecurityPlayer
wrapper for the givenOfflinePlayer
.- Parameters:
player
- the player whose wrapper to get. Must not be null- Returns:
- the lock security player wrapper
-
getLockedBlockManager
Get theILockedBlockManager
instance.- Returns:
- the locked block manager
-
isLockable
boolean isLockable(@NotNull org.bukkit.Material material)Get whether the suppliedMaterial
is lockable according to the LockSecurity configuration file.- Parameters:
material
- the material to check. Must not be null- Returns:
- true if lockable, false otherwise
-