Upstream/ChestSort
1
0
Fork 0
mirror of https://github.com/JEFF-Media-GbR/ChestSort.git synced 2024-11-13 06:05:36 +01:00
Code Issues Projects Releases Wiki Activity

updated API docs

Browse Source
This commit is contained in:
mfnalex 2020-07-12 04:03:27 +02:00
parent 581abf9edd
commit b304bd3477
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
HOW_TO_USE_API.md
View File

@ -1,6 +1,9 @@
# API Usage
If you want to use ChestSort's advanced sorting features for your own plugin, or if ChestSort causes trouble with your own plugin, you can use the ChestSort API. It provides methods to sort any given inventory, following the rules you have specified in your ChestSort's plugin.yml and the corresponding category files, and a cancellable ChestSortEvent event that is fired whenever ChestSort is about to sort an inventory.
If you want to use ChestSort's advanced sorting features for your own plugin, or if ChestSort causes trouble with your own plugin, you can use the ChestSort API. It provides
- the methods `sortInventory(Inventory inv)` and `sortInventory(Inventory inv, int startSlot, int endSlot)`to sort any given inventory, following the rules you have specified in your ChestSort's plugin.yml and the corresponding category files
- a cancellable event called `ChestSortEvent` that is fired whenever ChestSort is about to sort an inventory
- a custom InventoryHolder called `Sortable` that you can use when creating inventories to tell ChestSort that this inventory should be sortable
## Maven repository
You can use maven to add ChestSort as a dependency to your Spigot-/Bukkit-Plugin: