API functions
Since API: v1.0
Description: Get the plugin name
Return: (String) name of the plugin
Since API: v1.0
Description: Get the plugin version
Return: (String) version of the plugin
Since API: v1.0
Description: Get the API version
Return: (String) version of the API
Since API: v1.0
Description: Overwrite all ranks of a player and set it to a single one
Argument(s):
- org.bukkit.entity.Player player
- String rankname
Return: (boolean) success
Since API: v1.1
Description: Add a rank to the player's current ranks
Argument(s):
- org.bukkit.entity.Player player
- String rankname
Return: (boolean) success
Since API: v1.0
Description: Remove a rank from a player
Argument(s):
- org.bukkit.entity.Player player
- String rankname
Return: (boolean) success
Since API: v1.0
Description: Remove a permission node from a player
Argument(s):
- org.bukkit.entity.Player player
- String permission.node
Return: (boolean) success
Since API: v1.1
Description: Add a permission node to a player
Argument(s):
- org.bukkit.entity.Player player
- String permission.node
- Boolean permission allowed or denied
Return: (boolean) success
Since API: v1.1
Description: Get all allowed permissions of a rank
Argument(s):
- String rankname
Return: (java.util.List<String>) list of allowed Permissions
Since API: v1.1
Description: Get all denied permissions of a rank
Argument(s):
- String rankname
Return: (java.util.List<String>) list of denied Permissions
Since API: v1.1
Description: Add a permission to a rank
Argument(s):
- String rankname
- String permission.node
- Boolean permission allowed or denied
Return: (boolean) success
Since API: v1.0
Description: Remove a permission from a rank
Argument(s):
- String rankname
- String permission.node
Return: (boolean) success
Since API: v1.0
Description: Get a list of all rank inheritances on a specific rank
Argument(s):
- String rankname
Return: (java.util.List<String>)
Since API: v1.0
Description: Add a inherited rank to a rank
Argument(s):
- String rankname
- String inheritance_rankname
Return: (boolean) success
Since API: v1.0
Description: Remove a inherited rank from a rank
Argument(s):
- String rankname
- String inheritance_rankname
Return: (boolean) success
Since API: v1.0
Description: Get the prefix from a rank
Argument(s):
- String rankname
Return: (String) unformatted prefix of a rank
Since API: v1.0
Description: Change the prefix of a rank
Argument(s):
- String rankname
- String newPrefix
Return: (boolean) success
Since API: v1.0
Description: Get the suffix from a rank
Argument(s):
- String rankname
Return: (String) unformatted suffix of a rank
Since API: v1.0
Description: Change the suffix of a rank
Argument(s):
- String rankname
- String newSuffix
Return: (boolean) success
Since API: v1.0
Description: Get the name color of a rank
Argument(s):
- String rankname
Return: (String) unformatted name color
Since API: v1.0
Description: Change the name color of a rank
Argument(s):
- String rankname
- String newColor
Return: (boolean) success
Since API: v1.0
Description: Get the chat color of a rank
Argument(s):
- String rankname
Return: (String) unformatted chat color
Since API: v1.0
Description: Change the chat color of a rank
Argument(s):
- String rankname
Return: (boolean) success
Since API: v1.0
Description: Get a list of all ranks on this server
Return: (java.util.Set<String>) list of all registered ranks
Since API: v1.0
Description: Create a rank on the server
Argument(s):
- String rankname
Return: (boolean) success
Since API: v1.0
Description: Delete a rank from the server
Argument(s):
- String rankname
Return: (boolean) success
Since API: v1.2
Description: Should the rank be given to the players when they join for the first time?
Argument(s):
- String rankname
- boolean isDefault
Return: (boolean) success
Since API: v1.2
Description: Get the list of default ranks that are given to new players
Return: (List<String>) List of default ranks
Since API: v1.0
Description: Add a rank as buyable to a rank
Argument(s):
- String rankname
- String buyable_rankname
Return: (boolean) success
Since API: v1.0
Description: Remove a rank as buyable from a rank
Argument(s):
- String rankname
- String buyable_rankname
Return: (boolean) success
Since API: v1.0
Description: The the buy cost of a rank
Argument(s):
Return: (boolean) success
Since API: v1.3
Description: Create a usertag on the server
Argument(s):
- String usertag
- String value
Return: (boolean) success
Since API: v1.3
Description: Change a usertag on the server
Argument(s):
- String usertag
- String value
Return: (boolean) success
Since API: v1.3
Description: Delete a usertag from the server
Argument(s):
- String usertag
Return: (boolean) success
Since API: v1.3
Description: Assign a usertag to an player
Argument(s):
- Player player
- String usertag
Return: (boolean) success
Since API: v1.3
Description: Add a usertag to an player
Argument(s):
- Player player
- String usertag
Return: (boolean) success
Since API: v1.3
Description: Remove an usertag from a player
Argument(s):
- Player player
- String usertag
Return: (boolean) success
Deprecated in API: v1.1 | replaced by getPrimaryRank(Player)
Since API: v1.0
Description: Get the name of the player's main rank
Argument(s):
- org.bukkit.entity.Player player
Return: (String) name of the rank
Deprecated in v1.1 | replaced by addPermission(Player, String, boolean)
Since API: v1.0
Description: Add a permission node to a player
If the permissions starts with '-' it will be denied
Argument(s):
- org.bukkit.entity.Player player
- String permission.node
Return: (boolean) success
Deprecated in API: v1.1 | replaced by getAllowedPermissions(Player, String) & getDeniedPermissions(Player, String)
Since API: v1.0
Description: Get all permissions of a rank
Argument(s):
- String rankname
Return: (java.util.List<String>) list of Permissions
Deprecated in API: v1.1 | replaced by addPermission(String, String, boolean)
Since API: v1.0
Description: Add a permission to a rank
If the permissions starts with '-' it will be denied
Argument(s):
- String rankname
- String permission.node
Return: (boolean) success
Deprecated in API: v1.1
Since API: v1.0
Description: Get the promote rank on a rank
Argument(s):
- String rankname
Return: (String) name of the promote rank
Deprecated in API: v1.1
Since API: v1.0
Description: Set the promote rank on a rank
Argument(s):
- String rankname
- String promote_rankname
Return: (boolean) success
Deprecated in API: v1.1
Since API: v1.0
Description: Get the demote rank on a rank
Argument(s):
- String rankname
Return: (String) name of the demote rank
Deprecated in API: v1.1
Since API: v1.0
Description: Set the demote rank on a rank
Argument(s):
- String rankname
- String demote_rankname
Return: (boolean) success
Deprecated in API: v1.1
Since API: v1.0
Description: Get a list of subranks on a player
Argument(s):
- org.bukkit.entity.Player player
Return: (java.util.List<String>) names of the subranks
Deprecated in API: v1.1
Since API: v1.0
Description: Add a subrank to a player
Argument(s):
- org.bukkit.entity.Player player
- String rankname
Return: (boolean) success
Deprecated in API: v1.1
Since API: v1.0
Description: Remove a subrank from a player
Argument(s):
- org.bukkit.entity.Player player
- String rankname
Return: (boolean) success
Deprecated in API: v1.1
Since API: v1.0
Description: Get the prefixes of the player's subranks separated by a space
Argument(s):
- org.bukkit.entity.Player player
Return: (String) All prefixes of the player's subranks separated by a space
Deprecated in API: v1.1
Since API: v1.0
Description: Get the suffixes of the player's subranks separated by a space
Argument(s):
- org.bukkit.entity.Player player
Return: (String) All suffixes of the player's subranks separated by a space
Last modified 1yr ago