Index (BurchAPI 2.1.8 API)

A B C D E F G H I J L M N O P Q R S T U V W
All Classes|All Packages|Serialized Form

A

add(int, int) - Static method in class com.burchard36.api.utils.MathUtils: Efficiently adds two numbers via bit flipping
addClickableItems(List<ClickableItem>) - Method in class com.burchard36.api.inventory.PluginInventory: Ads a List of ClickableItem's to this PluginInventory
addDataInteger(String, int) - Method in class com.burchard36.api.utils.ItemWrapper: Adds a Integer value to the linked ItemStack's PersistentDataContainer
addDataString(String, String) - Method in class com.burchard36.api.utils.ItemWrapper: Adds a String value to the linked ItemStack's PersistentDataContainer
addEnchantment(Enchantment, int) - Method in class com.burchard36.api.utils.ItemWrapper: Adds a specific Enchantment with a specified Integer level
addEnchantments(HashMap<Enchantment, Integer>) - Method in class com.burchard36.api.utils.ItemWrapper: Adds a Map of Enchantment and Integer to the linked ItemStack's Enchantment list
addItemLore(String...) - Method in class com.burchard36.api.utils.ItemWrapper: Adds a Lore line to the linked ItemStack
aliases() - Method in record class com.burchard36.api.command.actions.PlayerTabComplete: Returns the value of the aliases record component.
aliases() - Element in annotation interface com.burchard36.api.command.annotation.CommandAliases: List of aliases that the class extending ApiCommand can also use for execution
aliases() - Element in annotation interface com.burchard36.api.command.annotation.RegisterCommand: Sets the Aliases of a class extending ApiCommand This field is optional, however if a CommandAliases Annotation is set, that annotation will override this value
api - Variable in class com.burchard36.api.data.json.PlayerJsonDataStore
ApiCommand - Class in com.burchard36.api.command: The class you want to use when registering commands.
ApiCommand() - Constructor for class com.burchard36.api.command.ApiCommand
apiSettings - Variable in class com.burchard36.api.BurchAPI
ApiSettings - Class in com.burchard36.api: The settings for the API to use.
ApiSettings() - Constructor for class com.burchard36.api.ApiSettings: Creates a new instance of this class
args() - Method in record class com.burchard36.api.command.actions.ConsoleSendCommand: Returns the value of the args record component.
args() - Method in record class com.burchard36.api.command.actions.PlayerSendCommand: Returns the value of the args record component.
asFile(UUID) - Method in class com.burchard36.api.data.json.JsonDataStore
asyncPreLogin(AsyncPlayerPreLoginEvent) - Method in class com.burchard36.api.data.json.PlayerJsonDataStore
autoSaveTask - Variable in class com.burchard36.api.data.json.PlayerJsonDataStore
autoSaveTask() - Method in interface com.burchard36.api.data.FileDataStore
autoSaveTask() - Method in class com.burchard36.api.data.json.JsonDataStore
autoSaveTask() - Method in class com.burchard36.api.data.json.PlayerJsonDataStore

B

blockCommandFromLoading(Class<? extends ApiCommand>) - Method in class com.burchard36.api.ApiSettings: Blocks a specific command class from being automatically registered
blockDataStoreFromLoading(Class<? extends DataStore>) - Method in class com.burchard36.api.ApiSettings: Blocks a DataStore storage handler not load on STARTUP
build() - Method in class com.burchard36.api.inventory.ClickableItem: returns the ItemStack that this class currently holds
BurchAPI - Class in com.burchard36.api: Users of this API are expected to extend this class, rather than JavaPlugin, BurchAPI will provide methods for JavaPlugin
BurchAPI() - Constructor for class com.burchard36.api.BurchAPI

C

cache - Variable in class com.burchard36.api.data.json.PlayerJsonDataStore
calcExponent(int, int) - Static method in class com.burchard36.api.utils.MathUtils: Calculated the when its exponent is
classesForPackage - Variable in class com.burchard36.api.utils.reflections.PackageScanner
ClickableItem - Class in com.burchard36.api.inventory: A clickable item the executes methods on a PluginInventory's InventoryClickEvent if, you have the functional interface method set of course
ClickableItem(Material, int) - Constructor for class com.burchard36.api.inventory.ClickableItem: Creates a instnace of this class with a Material and a Integer amount
ClickableItem(Material, int, String, List<String>) - Constructor for class com.burchard36.api.inventory.ClickableItem: Supports creating a lore with a material, amount, item name, and item lore
ClickableItemAction - Record Class in com.burchard36.api.inventory.actions: Executor method for GuiClickableItem
ClickableItemAction(InventoryClickEvent) - Constructor for record class com.burchard36.api.inventory.actions.ClickableItemAction: Creates an instance of a ClickableItemAction record class.
clickableItems - Variable in class com.burchard36.api.inventory.PluginInventory: The HashMap containing all the ClickableItem items of this PluginInventory, ordered by zero-based slot counts
clickAction - Variable in class com.burchard36.api.inventory.PluginInventory: The GuiClickAction for this inventory
clickEvent() - Method in record class com.burchard36.api.inventory.actions.ClickableItemAction: Returns the value of the clickEvent record component.
clickEvent() - Method in record class com.burchard36.api.inventory.actions.InventoryClickAction: Returns the value of the clickEvent record component.
closeAction - Variable in class com.burchard36.api.inventory.PluginInventory: The GuiCloseAction for this inventory
closeEvent() - Method in record class com.burchard36.api.inventory.actions.InventoryCloseAction: Returns the value of the closeEvent record component.
com.burchard36.api - package com.burchard36.api: Main package for the plugin, holds the 3 main classes, as well as all the other packages
com.burchard36.api.command - package com.burchard36.api.command: The Command API package for this library
com.burchard36.api.command.actions - package com.burchard36.api.command.actions
com.burchard36.api.command.annotation - package com.burchard36.api.command.annotation
com.burchard36.api.command.interfaces - package com.burchard36.api.command.interfaces
com.burchard36.api.data - package com.burchard36.api.data
com.burchard36.api.data.annotations - package com.burchard36.api.data.annotations
com.burchard36.api.data.json - package com.burchard36.api.data.json: The JSON data library (Currently undergoing a refactor)
com.burchard36.api.data.json.enums - package com.burchard36.api.data.json.enums
com.burchard36.api.data.json.exceptions - package com.burchard36.api.data.json.exceptions
com.burchard36.api.inventory - package com.burchard36.api.inventory: The Inventory API for this library
com.burchard36.api.inventory.actions - package com.burchard36.api.inventory.actions
com.burchard36.api.inventory.interfaces - package com.burchard36.api.inventory.interfaces
com.burchard36.api.utils - package com.burchard36.api.utils: Various utilities that may help you in plugin development
com.burchard36.api.utils.reflections - package com.burchard36.api.utils.reflections
CommandAliases - Annotation Interface in com.burchard36.api.command.annotation: Interface to set a list of Aliases for a class extending ApiCommand This is optional, however this will override the aliases String set in a RegisterCommand annotation
CommandDescription - Annotation Interface in com.burchard36.api.command.annotation: Interface to set a commands description for a class extending ApiCommand This annotation is optional, however it will override the command description's String from a RegisterCommand Annotation
CommandInjector - Class in com.burchard36.api.command: Injects ApiCommands into Bukkit's command map
CommandInjector() - Constructor for class com.burchard36.api.command.CommandInjector
CommandName - Annotation Interface in com.burchard36.api.command.annotation: Sets the CommandName for a class extending ApiCommand This also queue's the class for being AutoRegistered on the program startup if your class extending ApiCommand does not have this annotation, it needs to have a RegisterCommand annotation instead This is required, unless you are using a RegisterCommand Annotation instead,
CommandUsage - Annotation Interface in com.burchard36.api.command.annotation: Sets the command usage message for a class extending ApiCommand This is optional, and will override command usage String's from a RegisterCommand Annotation
console() - Method in record class com.burchard36.api.command.actions.ConsoleSendCommand: Returns the value of the console record component.
ConsoleSendCommand - Record Class in com.burchard36.api.command.actions: executor method for OnConsoleSender
ConsoleSendCommand(ConsoleCommandSender, List<String>) - Constructor for record class com.burchard36.api.command.actions.ConsoleSendCommand: Creates an instance of a ConsoleSendCommand record class.
convert(String) - Static method in class com.burchard36.api.BurchAPI: Converts a normal string to a formatted one
convert(String...) - Static method in class com.burchard36.api.BurchAPI: Converts a varargs String to colored List of String's
createFile(JsonDataFile) - Method in class com.burchard36.api.PluginJsonWriter: Asynchronously/Synchronously creates a JsonDataFile
This will ONLY create a new file if one doesn't exist,
currentClassToSearch - Variable in class com.burchard36.api.utils.reflections.PackageScanner

D

dataClass - Variable in class com.burchard36.api.data.json.PlayerJsonDataStore
dataFiles - Variable in class com.burchard36.api.data.json.JsonDataStore
dataFiles() - Method in interface com.burchard36.api.data.FileDataStore: List of classes you want a DataStore to automatically load on startup
dataFiles() - Method in class com.burchard36.api.data.json.JsonDataStore
dataFiles() - Method in class com.burchard36.api.data.json.PlayerJsonDataStore
DataStore - Interface in com.burchard36.api.data
dataStoreAutoRegisterBlacklist - Variable in class com.burchard36.api.ApiSettings
DataStoreID - Annotation Interface in com.burchard36.api.data.annotations: Sets the DataStore's name when loading the data store, use when implementing DataStore
Using this interface also enabled the class for auto initialization
DataStores - Class in com.burchard36.api.data
DataStores() - Constructor for class com.burchard36.api.data.DataStores
DataStoreSettings - Class in com.burchard36.api
DataStoreSettings() - Constructor for class com.burchard36.api.DataStoreSettings
DataStoresManager - Class in com.burchard36.api
DataStoresManager() - Constructor for class com.burchard36.api.DataStoresManager
debug(String) - Static method in class com.burchard36.api.utils.Logger: Logs a debug message, if the API is in debug mode
deleteDataFile(JsonDataFile) - Method in class com.burchard36.api.PluginJsonWriter
description() - Element in annotation interface com.burchard36.api.command.annotation.CommandDescription: Description of what the ApiCommand does
description() - Element in annotation interface com.burchard36.api.command.annotation.RegisterCommand: Sets the description for the class extending ApiCommand This field is optional, however if a CommandDescription Annotation is set, that annotation will override this value

E

EntityWrapper - Class in com.burchard36.api.utils: A simple wrapper to easily modify the data of a Entity
EntityWrapper(Entity) - Constructor for class com.burchard36.api.utils.EntityWrapper: Initialized this class with a Entity
equals(Object) - Method in record class com.burchard36.api.command.actions.ConsoleSendCommand: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.burchard36.api.command.actions.PlayerSendCommand: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.burchard36.api.command.actions.PlayerTabComplete: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.burchard36.api.inventory.actions.ClickableItemAction: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.burchard36.api.inventory.actions.InventoryClickAction: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.burchard36.api.inventory.actions.InventoryCloseAction: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.burchard36.api.inventory.actions.InventoryOpenAction: Indicates whether some other object is "equal to" this one.
ERR_INVALID_CONSTRUCTOR - Enum constant in enum class com.burchard36.api.utils.reflections.PackageScanner.InvocationErrorStatus
ERR_INVOCATION - Enum constant in enum class com.burchard36.api.utils.reflections.PackageScanner.InvocationErrorStatus
error(String) - Static method in class com.burchard36.api.utils.Logger: Logs an error to the server, supports ampersand symbols for coloring
execute() - Method in class com.burchard36.api.utils.reflections.PackageScanner: Executes the query you set.
execute(CommandSender, String, String[]) - Method in class com.burchard36.api.command.ApiCommand

F

FileDataStore - Interface in com.burchard36.api.data
fileType() - Element in annotation interface com.burchard36.api.data.annotations.PlayerDataFile: The filetype to save this PlayerDataFile as
FileType - Enum Class in com.burchard36.api.data.json.enums: FileType types for when working with the file data library
fillWith(ClickableItem, boolean) - Method in class com.burchard36.api.inventory.PluginInventory: Fills an inventory with a specific ClickableItem
fillWith(List<ClickableItem>, boolean) - Method in class com.burchard36.api.inventory.PluginInventory: File this PluginInventory with a List of ClickableItem's
findWithClassConstructorAnnotations(Class<? extends Annotation>...) - Method in class com.burchard36.api.utils.reflections.PackageScanner

G

getClassesExtendingThis(Package, Class<? extends T>) - Method in class com.burchard36.api.utils.reflections.PackageScanner
getClassesForPackage(String) - Method in class com.burchard36.api.utils.reflections.PackageScanner
getDataFromFile(File, Class<? extends JsonDataFile>) - Method in class com.burchard36.api.PluginJsonWriter: Gets a data from a file
getDisplayName() - Method in class com.burchard36.api.utils.ItemWrapper: Might be null
getEntity() - Method in class com.burchard36.api.utils.EntityWrapper: Returns the Entity of this class
getEnumName() - Method in enum class com.burchard36.api.data.InternalDataStore
getFile() - Method in interface com.burchard36.api.data.json.JsonDataFile: The File to save this json data to
getFile() - Method in class com.burchard36.api.data.json.JsonPlayerDataFile
getGlobalInventoryListener() - Method in class com.burchard36.api.BurchAPI
getIntegerDataValue(String) - Method in class com.burchard36.api.utils.ItemWrapper: Gets a Integer value form the linked ItemStack's PersistentDataContainer
getIntegerValue(String) - Method in class com.burchard36.api.utils.EntityWrapper: Gets a Integer value from the linked entities PersistentDataContainer
getInventory() - Method in class com.burchard36.api.inventory.PluginInventory.PluginHolder
getItemStack() - Method in class com.burchard36.api.utils.ItemWrapper: Returns the ItemStack from constructor
getJsonWriter() - Method in class com.burchard36.api.BurchAPI: Gets the PluginJsonWriter instance of this class
getKey() - Method in class com.burchard36.api.utils.reflections.PackageScanner.InvocationResult
getLore() - Method in class com.burchard36.api.utils.ItemWrapper: Might be null
getPackageScanner() - Method in class com.burchard36.api.BurchAPI: Gets a new PackageScanner instance
getStringDataValue(String) - Method in class com.burchard36.api.utils.ItemWrapper: Gets a String value form the linked ItemStack's PersistentDataContainer
getStringValue(String) - Method in class com.burchard36.api.utils.EntityWrapper: Gets a String value from the linked entities PersistentDataContainer
getValue() - Method in class com.burchard36.api.utils.reflections.PackageScanner.InvocationResult
GlobalInventoryListener - Class in com.burchard36.api.inventory: The Listener for all PluginInventory's
GlobalInventoryListener(JavaPlugin) - Constructor for class com.burchard36.api.inventory.GlobalInventoryListener: Creates a new instance for inventory events the PluginInventory's use You should not be initializing this, the API already does this
gson - Variable in class com.burchard36.api.PluginJsonWriter
guiClickableItem - Variable in class com.burchard36.api.inventory.ClickableItem: The GuiClickableItem action for this class
GuiClickableItem - Interface in com.burchard36.api.inventory.interfaces
GuiClickAction - Interface in com.burchard36.api.inventory.interfaces: The functional interface called when a PluginInventory's inventory is clicked on This is NOT to handle clicks of items in a inventory, see ClickableItem instead for this
GuiCloseAction - Interface in com.burchard36.api.inventory.interfaces: The functional interface called when a PluginInventory gets closed
GuiOpenAction - Interface in com.burchard36.api.inventory.interfaces: The functional interface for when PluginInventory's get opened

H

hasDataInteger(String) - Method in class com.burchard36.api.utils.ItemWrapper: Checks if the linked ItemStack's PersistentDataContainer has a Integer value
hasDataString(String) - Method in class com.burchard36.api.utils.ItemWrapper: Checks if the linked ItemStack's PersistentDataContainer has a String value
hashCode() - Method in record class com.burchard36.api.command.actions.ConsoleSendCommand: Returns a hash code value for this object.
hashCode() - Method in record class com.burchard36.api.command.actions.PlayerSendCommand: Returns a hash code value for this object.
hashCode() - Method in record class com.burchard36.api.command.actions.PlayerTabComplete: Returns a hash code value for this object.
hashCode() - Method in record class com.burchard36.api.inventory.actions.ClickableItemAction: Returns a hash code value for this object.
hashCode() - Method in record class com.burchard36.api.inventory.actions.InventoryClickAction: Returns a hash code value for this object.
hashCode() - Method in record class com.burchard36.api.inventory.actions.InventoryCloseAction: Returns a hash code value for this object.
hashCode() - Method in record class com.burchard36.api.inventory.actions.InventoryOpenAction: Returns a hash code value for this object.

I

id() - Element in annotation interface com.burchard36.api.data.annotations.DataStoreID: The name of the DataStore
injectCommands() - Static method in class com.burchard36.api.command.CommandInjector: Injects all commands into the BukkitCommand map Also search's for classes extending ApiCommand and auto-registers them if they have CommandName or RegisterCommand Annotation(s)
injectDataStores() - Method in class com.burchard36.api.data.DataStores
instance - Variable in class com.burchard36.api.data.json.JsonDataStore
INSTANCE - Static variable in class com.burchard36.api.BurchAPI
InternalDataStore - Enum Class in com.burchard36.api.data
InventoryClickAction - Record Class in com.burchard36.api.inventory.actions: Executor method for GuiClickAction
InventoryClickAction(InventoryClickEvent) - Constructor for record class com.burchard36.api.inventory.actions.InventoryClickAction: Creates an instance of a InventoryClickAction record class.
InventoryCloseAction - Record Class in com.burchard36.api.inventory.actions: Executor method for GuiCloseAction
InventoryCloseAction(InventoryCloseEvent) - Constructor for record class com.burchard36.api.inventory.actions.InventoryCloseAction: Creates an instance of a InventoryCloseAction record class.
inventoryHolder - Variable in class com.burchard36.api.inventory.PluginInventory: The InventoryHolder of this inventory
inventoryListener - Variable in class com.burchard36.api.BurchAPI
InventoryOpenAction - Record Class in com.burchard36.api.inventory.actions: Executor method for GuiOpenAction
InventoryOpenAction(InventoryOpenEvent) - Constructor for record class com.burchard36.api.inventory.actions.InventoryOpenAction: Creates an instance of a InventoryOpenAction record class.
InvocationResult(T, InvocationErrorStatus) - Constructor for class com.burchard36.api.utils.reflections.PackageScanner.InvocationResult
invokeClass(Class<? extends T>) - Method in class com.burchard36.api.utils.reflections.PackageScanner
isDebug() - Method in class com.burchard36.api.BurchAPI: Returns whether the Api is in debug state, this is generally used for the Logger If you are extending this class, you can Override this method.
isOdd(int) - Static method in class com.burchard36.api.utils.MathUtils: Efficiently calculates if a provided Integer is odd
ItemWrapper - Class in com.burchard36.api.utils: A basic class to wrap around ItemStack
ItemWrapper(ItemStack) - Constructor for class com.burchard36.api.utils.ItemWrapper: Specifies directly what ItemStack you want to wrap around
ItemWrapper(Material) - Constructor for class com.burchard36.api.utils.ItemWrapper: Creates a ItemStack with a Integer of 1 as the amount
ItemWrapper(Material, int) - Constructor for class com.burchard36.api.utils.ItemWrapper: Creates a ItemStack with a specific Material and Integer amount

J

JSON - Enum constant in enum class com.burchard36.api.data.json.enums.FileType: For .json files
JSON_DATA_STORE - Enum constant in enum class com.burchard36.api.data.InternalDataStore
JSON_PLAYER_DATA_STORE - Enum constant in enum class com.burchard36.api.data.InternalDataStore
JsonDataFile - Interface in com.burchard36.api.data.json: Class to extend classes you want to be specified as Json data classes
JsonDataStore - Class in com.burchard36.api.data.json
JsonDataStore(BurchAPI) - Constructor for class com.burchard36.api.data.json.JsonDataStore
JsonFileNotFoundException - Exception in com.burchard36.api.data.json.exceptions
JsonFileNotFoundException(String) - Constructor for exception com.burchard36.api.data.json.exceptions.JsonFileNotFoundException
JsonPlayerDataFile - Class in com.burchard36.api.data.json: End users should extend this class to allow more data to be saved
JsonPlayerDataFile() - Constructor for class com.burchard36.api.data.json.JsonPlayerDataFile
jsonWriter - Variable in class com.burchard36.api.BurchAPI

L

log(String) - Static method in class com.burchard36.api.utils.Logger: Logs a message to the server, supports ampersand symbols for coloring
Logger - Class in com.burchard36.api.utils: The API's logger
Logger() - Constructor for class com.burchard36.api.utils.Logger
loggerPrefix() - Method in class com.burchard36.api.BurchAPI: Returns the logger prefix for Logger If your class is extending this class, you can Override this method to change the output.

M

MathUtils - Class in com.burchard36.api.utils: THIS CLASS WAS PROVIDED BY ANOTHER DEVELOPER NOT ME! These math methods are faster to work with than typical Math classes, as they work with raw bits Users GitHub who provided these methods: https://github.com/frostalf
MathUtils() - Constructor for class com.burchard36.api.utils.MathUtils
multiply(int, int) - Static method in class com.burchard36.api.utils.MathUtils: Efficiently multiplies 2 numbers via bit flipping
myFunString - Variable in class com.burchard36.api.data.json.TestPlayerData

N

name() - Element in annotation interface com.burchard36.api.command.annotation.CommandName: Name of the command for execution in a class extending ApiCommand
name() - Element in annotation interface com.burchard36.api.command.annotation.RegisterCommand: Name to set for the class extending ApiCommand This field is absolutely required when using this annotation, unless your are using a CommandName annotation
NULL - Enum constant in enum class com.burchard36.api.utils.reflections.PackageScanner.InvocationErrorStatus

O

onClick(InventoryClickAction) - Method in interface com.burchard36.api.inventory.interfaces.GuiClickAction: The method called when a PluginInventory gets clicked
onClick(GuiClickableItem) - Method in class com.burchard36.api.inventory.ClickableItem: Sets the onClick action of this ClickableItem
onClick(GuiClickAction) - Method in class com.burchard36.api.inventory.PluginInventory: Lambda interface called when inventory gets clicked
onClose(InventoryCloseAction) - Method in interface com.burchard36.api.inventory.interfaces.GuiCloseAction: The method called when the PluginInventory gets closed
onClose(GuiCloseAction) - Method in class com.burchard36.api.inventory.PluginInventory: Lambda interface called when inventory gets closed
onConsoleSender - Variable in class com.burchard36.api.command.ApiCommand
onConsoleSender(ConsoleSendCommand) - Method in interface com.burchard36.api.command.interfaces.OnConsoleSender
onConsoleSender(OnConsoleSender) - Method in class com.burchard36.api.command.ApiCommand: Sets the function to run when a ConsoleCommandSender sends a command
OnConsoleSender - Interface in com.burchard36.api.command.interfaces
onDisable() - Method in class com.burchard36.api.BurchAPI
onDisable() - Method in interface com.burchard36.api.data.DataStore
onDisable() - Method in class com.burchard36.api.data.json.JsonDataStore
onDisable() - Method in class com.burchard36.api.data.json.PlayerJsonDataStore
onEnable() - Method in class com.burchard36.api.BurchAPI
onEnable() - Method in interface com.burchard36.api.data.DataStore: When the data store first gets initialized
onEnable() - Method in class com.burchard36.api.data.json.JsonDataStore
onEnable() - Method in class com.burchard36.api.data.json.PlayerJsonDataStore
onItemClick(ClickableItemAction) - Method in interface com.burchard36.api.inventory.interfaces.GuiClickableItem
onOpen(InventoryOpenAction) - Method in interface com.burchard36.api.inventory.interfaces.GuiOpenAction: The method called when ApiCommand gets opened
onOpen(GuiOpenAction) - Method in class com.burchard36.api.inventory.PluginInventory: Lambda interface called when inventory gets opened
onPlayerSender - Variable in class com.burchard36.api.command.ApiCommand
onPlayerSender(PlayerSendCommand) - Method in interface com.burchard36.api.command.interfaces.OnPlayerSender
onPlayerSender(OnPlayerSender) - Method in class com.burchard36.api.command.ApiCommand: Sets the function to run when a Player sends a command
OnPlayerSender - Interface in com.burchard36.api.command.interfaces
onPluginDisable() - Method in class com.burchard36.api.BurchAPI: Calls after the API disables itself
onPluginEnable() - Method in class com.burchard36.api.BurchAPI: Calls after the API enables itself
onPreApiEnable() - Method in class com.burchard36.api.BurchAPI: Plugins can override this and change certain aspects of the API functionality before api initialization
onReload() - Method in interface com.burchard36.api.data.DataStore: When a reload call is called on the data store
onReload() - Method in class com.burchard36.api.data.json.JsonDataStore
onReload() - Method in class com.burchard36.api.data.json.PlayerJsonDataStore
onTabComplete - Variable in class com.burchard36.api.command.ApiCommand
onTabComplete(PlayerTabComplete) - Method in interface com.burchard36.api.command.interfaces.OnTabComplete: The method that ApiCommand calls when using the tab completor
onTabComplete(OnTabComplete) - Method in class com.burchard36.api.command.ApiCommand: Executes a TabCompleter for this command, only usage if you set a OnPlayerSender interface using ApiCommand.onPlayerSender
onTabComplete(CommandSender, Command, String, String[]) - Method in class com.burchard36.api.command.ApiCommand
OnTabComplete - Interface in com.burchard36.api.command.interfaces: The functional interface when TabCompleter is called for a ApiCommand
open(Player) - Method in class com.burchard36.api.inventory.PluginInventory: Opens an inventory to a Player
openAction - Variable in class com.burchard36.api.inventory.PluginInventory: The GuiOpenAction for this inventory
openEvent() - Method in record class com.burchard36.api.inventory.actions.InventoryOpenAction: Returns the value of the openEvent record component.

P

PackageScanner<T> - Class in com.burchard36.api.utils.reflections: A generic package scanner, that will scan a specific Package for a Class that extends another Class.
PackageScanner() - Constructor for class com.burchard36.api.utils.reflections.PackageScanner: While not recommendedn creating another instance of this class, you still can
You can get a running instance of this class after the API gets enabled, see BurchAPI.getPackageScanner()
PackageScanner.InvocationErrorStatus - Enum Class in com.burchard36.api.utils.reflections: Returned as an Entry value when using PackageScanner.invokeClass(java.lang.Class<? extends T>)
PackageScanner.InvocationResult<T,InvocationErrorStatus> - Class in com.burchard36.api.utils.reflections
PackageScanner.PackageScannerException - Exception in com.burchard36.api.utils.reflections: The exception thrown when there is any generic error with this class.
PackageScannerException(String) - Constructor for exception com.burchard36.api.utils.reflections.PackageScanner.PackageScannerException
packageToSearch - Variable in class com.burchard36.api.utils.reflections.PackageScanner
parse(String) - Method in enum class com.burchard36.api.data.InternalDataStore
player() - Method in record class com.burchard36.api.command.actions.PlayerSendCommand: Returns the value of the player record component.
player() - Method in record class com.burchard36.api.command.actions.PlayerTabComplete: Returns the value of the player record component.
playerDataAutoSave - Variable in class com.burchard36.api.DataStoreSettings: Sets the auto save time in seconds
PlayerDataFile - Annotation Interface in com.burchard36.api.data.annotations: For testing, not fully implemented yet
PlayerJsonDataStore - Class in com.burchard36.api.data.json: The default data store for PlayerData provided by BurchAPI
PlayerJsonDataStore(BurchAPI) - Constructor for class com.burchard36.api.data.json.PlayerJsonDataStore
PlayerSendCommand - Record Class in com.burchard36.api.command.actions: Executor method for OnPlayerSender
PlayerSendCommand(Player, List<String>) - Constructor for record class com.burchard36.api.command.actions.PlayerSendCommand: Creates an instance of a PlayerSendCommand record class.
PlayerTabComplete - Record Class in com.burchard36.api.command.actions: Executor method for OnTabComplete
PlayerTabComplete(Player, List<String>, List<String>) - Constructor for record class com.burchard36.api.command.actions.PlayerTabComplete: Creates an instance of a PlayerTabComplete record class.
PluginHolder(UUID, Inventory) - Constructor for class com.burchard36.api.inventory.PluginInventory.PluginHolder
PluginInventory - Class in com.burchard36.api.inventory: The API class to create the APIs PluginInventorys
PluginInventory(int, String) - Constructor for class com.burchard36.api.inventory.PluginInventory: Created a PluginInventory class
PluginInventory.PluginHolder - Class in com.burchard36.api.inventory: The InventoryHolder that PluginInventory's have
PluginJsonWriter - Class in com.burchard36.api: A Json writer, uses class serialization to write/read from files from Gson
PluginJsonWriter(Gson) - Constructor for class com.burchard36.api.PluginJsonWriter
provideUUID(UUID) - Method in class com.burchard36.api.data.json.JsonPlayerDataFile

Q

queuePluginInventory(PluginInventory) - Method in class com.burchard36.api.inventory.GlobalInventoryListener: Adds a PluginInventory to the Listener queue

R

register(Command) - Static method in class com.burchard36.api.command.CommandInjector: Injects ApiCommand into Bukkits CommandMap
registerCommand(ApiCommand) - Static method in class com.burchard36.api.command.CommandInjector: Registers a single command
RegisterCommand - Annotation Interface in com.burchard36.api.command.annotation: Sets specific command settings for a class extending ApiCommand This is required, unless you prefer to use CommandName CommandUsage CommandDescription CommandAliases instead
registerCommands(List<ApiCommand>) - Static method in class com.burchard36.api.command.CommandInjector: Registers a whole list of commands at once
registerDataStore(DataStore) - Method in class com.burchard36.api.data.DataStores
result - Variable in class com.burchard36.api.utils.reflections.PackageScanner
runAsync() - Element in annotation interface com.burchard36.api.data.annotations.PlayerDataFile: Should data of this file be saved asynchronously, or in sync this value is defaulted to true

S

setClickableItemAtSlot(int, ClickableItem) - Method in class com.burchard36.api.inventory.PluginInventory: Adds clickable items at a slot, gets overridden by addClickableItem(ClickableItem item)
setCommandAliases(String...) - Method in class com.burchard36.api.command.ApiCommand: Sets the aliases of this command
setCommandDescription(String) - Method in class com.burchard36.api.command.ApiCommand: Sets the description of this command
setCommandName(String) - Method in class com.burchard36.api.command.ApiCommand: Sets the command name when executing eg /
setCommandUsage(String) - Method in class com.burchard36.api.command.ApiCommand: Sets the Command usage message for this command
setDisplayName(String) - Method in class com.burchard36.api.inventory.PluginInventory: Sets the inventory display name
setDisplayName(String) - Method in class com.burchard36.api.utils.ItemWrapper: Sets the display name of the wrapped ItemStack
setHologram(String) - Method in class com.burchard36.api.utils.EntityWrapper: Sets the name above the linked entities head
setIntegerValue(String, int) - Method in class com.burchard36.api.utils.EntityWrapper: Sets a Integer value for the linked entity
setInventory(Inventory) - Method in class com.burchard36.api.inventory.PluginInventory.PluginHolder: Sets the inventory
setInventorySize(int) - Method in class com.burchard36.api.inventory.PluginInventory: Sets the inventory size of this Inventory, if setInventoryHolder gets called this method has no effect
setInventoryType(InventoryType) - Method in class com.burchard36.api.inventory.PluginInventory: Sets the inventory type of this inventory, has priority over the inventory size
setItemLore(List<String>) - Method in class com.burchard36.api.utils.ItemWrapper: Sets the items Lore directly
setModelData(int) - Method in class com.burchard36.api.utils.ItemWrapper: Sets the CustomModelData Integer of the ItemStack
setPlayerDataAutoSave(int) - Method in class com.burchard36.api.DataStoreSettings
setSkullTo(UUID) - Method in class com.burchard36.api.utils.ItemWrapper: If the linked ItemStack is a PLAYER_HEAD, it will set a owning player's UUID
setStringValue(String, String) - Method in class com.burchard36.api.utils.EntityWrapper: Sets a String value for the linked entity PersistentDataContainer
squareRoot(short) - Static method in class com.burchard36.api.utils.MathUtils: Bit-flips a square root of an Short
subclassSearchQuery(Package, Class<? extends T>) - Method in class com.burchard36.api.utils.reflections.PackageScanner: Sets the package to scan, and type to scan for.

T

tabCompleteOptions() - Method in record class com.burchard36.api.command.actions.PlayerTabComplete: Returns the value of the tabCompleteOptions record component.
TestPlayerData - Class in com.burchard36.api.data.json
TestPlayerData() - Constructor for class com.burchard36.api.data.json.TestPlayerData
toString() - Method in record class com.burchard36.api.command.actions.ConsoleSendCommand: Returns a string representation of this record class.
toString() - Method in record class com.burchard36.api.command.actions.PlayerSendCommand: Returns a string representation of this record class.
toString() - Method in record class com.burchard36.api.command.actions.PlayerTabComplete: Returns a string representation of this record class.
toString() - Method in record class com.burchard36.api.inventory.actions.ClickableItemAction: Returns a string representation of this record class.
toString() - Method in record class com.burchard36.api.inventory.actions.InventoryClickAction: Returns a string representation of this record class.
toString() - Method in record class com.burchard36.api.inventory.actions.InventoryCloseAction: Returns a string representation of this record class.
toString() - Method in record class com.burchard36.api.inventory.actions.InventoryOpenAction: Returns a string representation of this record class.

U

updateTargetClass(Class<? extends T>) - Method in class com.burchard36.api.utils.reflections.PackageScanner: Use this when you are still using the same package previous set by using PackageScanner.subclassSearchQuery(java.lang.Package, java.lang.Class<? extends T>)
If you want to use a different Package, then use PackageScanner.subclassSearchQuery(java.lang.Package, java.lang.Class<? extends T>)
usageMessage() - Element in annotation interface com.burchard36.api.command.annotation.CommandUsage: Usage message of the class extending ApiCommand
usageMessage() - Element in annotation interface com.burchard36.api.command.annotation.RegisterCommand: Sets the usage method of a class extending ApiCommand This field is optional, however if a CommandUsage Annotation is set, that annotation will override this value
useCommandModule(boolean) - Method in class com.burchard36.api.ApiSettings: Sets whether the Command module should automatically register all of its commands This default value is true
useInventoryModule(boolean) - Method in class com.burchard36.api.ApiSettings: Sets whether the Listener for the Inventory API should be enabled This value defaults to true
uuid - Variable in class com.burchard36.api.data.json.JsonPlayerDataFile
uuid - Variable in class com.burchard36.api.inventory.PluginInventory.PluginHolder: The Identifier of this InventoryHolder

V

valueOf(String) - Static method in enum class com.burchard36.api.data.InternalDataStore: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.burchard36.api.data.json.enums.FileType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.burchard36.api.utils.reflections.PackageScanner.InvocationErrorStatus: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.burchard36.api.data.InternalDataStore: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.burchard36.api.data.json.enums.FileType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.burchard36.api.utils.reflections.PackageScanner.InvocationErrorStatus: Returns an array containing the constants of this enum class, in the order they are declared.

W

warn(String) - Static method in class com.burchard36.api.utils.Logger: Warns the server, supports ampersand symbols
wasSuccessfullyInvoked() - Method in class com.burchard36.api.utils.reflections.PackageScanner.InvocationResult: Checks if the Invocation of a class was successfully
writeDataToFile(JsonDataFile) - Method in class com.burchard36.api.PluginJsonWriter: Writes data to a file asynchronously
writer - Variable in class com.burchard36.api.data.json.JsonDataStore
writer - Variable in class com.burchard36.api.data.json.PlayerJsonDataStore

A B C D E F G H I J L M N O P Q R S T U V W
All Classes|All Packages|Serialized Form