API
How to integrate your plugin with Oraxen
Add Oraxen to your plugin
Repository & Dependency Info
You can find the repository and dependency notice here.
Examples of use
Oraxen is built around an ItemsBuilder class that allows you to create items easily. When the plugin starts it parses the configurations to generate builders for each type of items. Each builder can be used to generate itemstacks.
OraxenItems class:
Get an ItemBuilder from an OraxenID
OraxenItems.getItemById(itemID); // where itemID is a section in items configurations
Check if an OraxenID exists
OraxenItems.isAnItem(itemID);
Extract an OraxenID from an ItemStack
You can use to check if an ItemStack is an OraxenItem (it will return null if OraxenID doesn't exist)
OraxenItems.getIdByItem(itemstack);
Custom Blocks & Furniture
Place an OraxenBlock
Place an OraxenBlock at a given location
OraxenBlocks.place(itemID, location)
Place an OraxenFurniture at a given location, optionally setting a player for rotation purposes
OraxenFurniture.place(itemID, location, @Nullable player)
Add resources to the pack
Get access to the assets/ folder
ResourcePack.getAssetsFolder();
Mechanics:
Oraxen allows you to add your own mechanics to the plugin, it is a little bit more complex than the rest, that's why there is a dedicated tutorial.
Last updated
Was this helpful?