Index
All Classes and Interfaces|All Packages|Serialized Form
A
- action - Variable in class io.rhythmknights.coreapi.component.module.DynamicTitle.InteractionState
- addItem(boolean, ModalItem...) - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Adds
ModalItems to the modal without specific slot. - addItem(ModalItem) - Method in class io.rhythmknights.coreapi.component.modal.PaginatedModal
-
Adds an
ModalItemto the next available slot in the page area - addItem(ModalItem...) - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Adds
ModalItems to the modal without specific slot. - addItem(ModalItem...) - Method in class io.rhythmknights.coreapi.component.modal.PaginatedModal
-
Overridden
BaseModal.addItem(ModalItem...)to add the items to the page instead - addSlotAction(int, int, ModalAction<InventoryClickEvent>) - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Alternative method for
BaseModal.addSlotAction(int, ModalAction)to add aModalActionto a specific slot using ROWS and COLUMNS instead of slots. - addSlotAction(int, ModalAction<InventoryClickEvent>) - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Adds a
ModalActionfor when clicking on a specific slot. - all(int) - Static method in class io.rhythmknights.coreapi.component.module.PaginationRegion
-
Create a pagination region covering all slots in the modal
- allInteractionsDisabled() - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
- allowsOtherActions() - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Check if any other actions are allowed in this modal
- amount(int) - Method in class io.rhythmknights.coreapi.modal.builder.item.BaseItemBuilder
-
Sets the amount of items
- apply(Consumer<M>) - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.BaseModalBuilder
-
Applies anything to the modal once it's created Can be pretty useful for setting up small things like default actions
- asBukkitCopy(Object) - Static method in class io.rhythmknights.coreapi.component.module.nbt.LegacyNBT
-
Mimics the CraftItemStack#asBukkitCopy method.
- asModalItem() - Method in class io.rhythmknights.coreapi.modal.builder.item.BaseItemBuilder
-
Creates a
ModalIteminstead of anItemStack - asModalItem() - Method in class io.rhythmknights.coreapi.modal.builder.item.ItemBuilder
-
Creates a
ModalIteminstead of anItemStack - asModalItem(ModalAction<InventoryClickEvent>) - Method in class io.rhythmknights.coreapi.modal.builder.item.BaseItemBuilder
-
Creates a
ModalIteminstead of anItemStack - asModalItem(ModalAction<InventoryClickEvent>) - Method in class io.rhythmknights.coreapi.modal.builder.item.ItemBuilder
-
Creates a
ModalIteminstead of anItemStack - asNMSCopy(ItemStack) - Static method in class io.rhythmknights.coreapi.component.module.nbt.LegacyNBT
-
Mimics the CraftItemStack#asNMSCopy method.
- author(Component) - Method in class io.rhythmknights.coreapi.modal.builder.item.BookBuilder
-
Sets the author of the book.
B
- banner() - Static method in class io.rhythmknights.coreapi.modal.builder.item.ItemBuilder
-
Method for creating a
BannerBuilderwhich will have BANNER specific methods - banner(ItemStack) - Static method in class io.rhythmknights.coreapi.modal.builder.item.ItemBuilder
-
Method for creating a
BannerBuilderwhich will have BANNER specific methods - BannerBuilder - Class in io.rhythmknights.coreapi.modal.builder.item
-
Item builder for banners only
- BaseChestModalBuilder<M,
B> - Class in io.rhythmknights.coreapi.component.modal.builder.modal - BaseChestModalBuilder() - Constructor for class io.rhythmknights.coreapi.component.modal.builder.modal.BaseChestModalBuilder
- baseColor(DyeColor) - Method in class io.rhythmknights.coreapi.modal.builder.item.BannerBuilder
-
Sets the base color for this banner Note: This method is only available in older versions of Bukkit.
- BaseItemBuilder<B> - Class in io.rhythmknights.coreapi.modal.builder.item
-
Contains all the common methods for the future ItemBuilders This class expects Components to be pre-parsed by CoreFramework's TextUtility.
- BaseItemBuilder(ItemStack) - Constructor for class io.rhythmknights.coreapi.modal.builder.item.BaseItemBuilder
- BaseModal - Class in io.rhythmknights.coreapi.component.modal
-
Base class that every modal extends.
- BaseModal(ModalContainer, Set<InteractionModifier>) - Constructor for class io.rhythmknights.coreapi.component.modal.BaseModal
- BaseModalBuilder<M,
B> - Class in io.rhythmknights.coreapi.component.modal.builder.modal -
The base for all the modal builders this is due to some limitations where some builders will have unique features based on the modal type
- BaseModalBuilder() - Constructor for class io.rhythmknights.coreapi.component.modal.builder.modal.BaseModalBuilder
- baseTitle - Variable in class io.rhythmknights.coreapi.component.module.DynamicTitle.InteractionState
- baseTitle - Variable in class io.rhythmknights.coreapi.component.module.DynamicTitle.PaginationState
- book(ItemStack) - Static method in class io.rhythmknights.coreapi.modal.builder.item.ItemBuilder
-
Method for creating a
BookBuilderwhich will haveMaterial.WRITABLE_BOOK/Material.WRITTEN_BOOKspecific methods - BookBuilder - Class in io.rhythmknights.coreapi.modal.builder.item
-
Item builder for
Material.WRITTEN_BOOKandMaterial.WRITTEN_BOOKonly - BOTH - Enum constant in enum class io.rhythmknights.coreapi.component.utility.ModalFiller.Side
- BREWING - Enum constant in enum class io.rhythmknights.coreapi.component.module.ModalType
- build() - Method in class io.rhythmknights.coreapi.modal.builder.item.BaseItemBuilder
-
Builds the item into
ItemStack
C
- canDropItems() - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Check if item drop is allowed inside this modal
- canPlaceItems() - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Check if item placement is allowed inside this modal.
- canSwapItems() - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Check if item swap is allowed inside this modal.
- canTakeItems() - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Check if item retrieval is allowed inside this modal.
- Chest(DynamicTitle, InventoryProvider.Chest, int) - Constructor for class io.rhythmknights.coreapi.component.module.ModalContainer.Chest
-
Constructor with dynamic title
- Chest(Component, InventoryProvider.Chest, int) - Constructor for class io.rhythmknights.coreapi.component.module.ModalContainer.Chest
- CHEST - Enum constant in enum class io.rhythmknights.coreapi.component.module.ModalType
- ChestModalBuilder - Class in io.rhythmknights.coreapi.component.modal.builder.modal
-
The simple modal builder is used for creating a
Modal - ChestModalBuilder() - Constructor for class io.rhythmknights.coreapi.component.modal.builder.modal.ChestModalBuilder
- clearPageItems() - Method in class io.rhythmknights.coreapi.component.modal.PaginatedModal
- clearPageItems(boolean) - Method in class io.rhythmknights.coreapi.component.modal.PaginatedModal
-
Clears all previously added page items
- clickedItem - Variable in class io.rhythmknights.coreapi.component.module.DynamicTitle.InteractionState
- clickedSlot - Variable in class io.rhythmknights.coreapi.component.module.DynamicTitle.InteractionState
- clickType - Variable in class io.rhythmknights.coreapi.component.module.DynamicTitle.InteractionState
- close(HumanEntity) - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Closes the modal with a
2 tickdelay (to prevent items from being taken from theInventory). - close(HumanEntity, boolean) - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Closes the modal with a
2 tickdelay (to prevent items from being taken from theInventory). - color(Color) - Method in class io.rhythmknights.coreapi.modal.builder.item.BaseItemBuilder
-
Color an
ItemStack - color(Color) - Method in class io.rhythmknights.coreapi.modal.builder.item.MapBuilder
-
Sets the map color.
- columns(int, int...) - Static method in class io.rhythmknights.coreapi.component.module.PaginationRegion
-
Create a pagination region for specific columns
- consumeBuilder(BaseModalBuilder<?, ?>) - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.BaseModalBuilder
- contains(int) - Method in class io.rhythmknights.coreapi.component.module.PaginationRegion
-
Check if a slot is within this region
- CoreAPI - Class in io.rhythmknights.coreapi
- craftClass(String) - Static method in class io.rhythmknights.coreapi.component.utility.VersionHelper
- create() - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.BaseModalBuilder
-
Creates the given ModalBase Has to be abstract because each modal are different
- create() - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.ChestModalBuilder
-
Creates a new
Modal - create() - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.PaginatedBuilder
-
Creates a new
PaginatedModal - create() - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.ScrollingBuilder
-
Creates a new
ScrollingModal - create() - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.TypedModalBuilder
-
Creates a new
Modal - createContainer() - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.BaseChestModalBuilder
- createInventory(InventoryHolder) - Method in class io.rhythmknights.coreapi.component.module.ModalContainer.Chest
- createInventory(InventoryHolder) - Method in interface io.rhythmknights.coreapi.component.module.ModalContainer
- createInventory(InventoryHolder) - Method in class io.rhythmknights.coreapi.component.module.ModalContainer.Typed
- currentPage - Variable in class io.rhythmknights.coreapi.component.module.DynamicTitle.PaginationState
D
- decodeModal(List<String>) - Method in interface io.rhythmknights.coreapi.component.module.Serializable
- deserialize(String) - Method in class io.rhythmknights.coreapi.component.utility.Legacy.TextSerializer
-
Converts a string with any combination of formatting styles to a Component Supports: - Legacy format (
&fand&#FFFFFF) - MiniMessage format (<white>and<#FFFFFF>) - deserializeComponent(Object) - Method in class io.rhythmknights.coreapi.modal.builder.item.BaseItemBuilder
-
Deserializes the object with the right ComponentSerializer for the current MC version
- disableAllInteractions() - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Disable all the modifications of the modal, making it immutable by player interaction.
- disableAllInteractions() - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.BaseModalBuilder
-
Disable all the modifications of the modal, making it immutable by player interaction
- disableItemDrop() - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Disable item drop inside the modal
- disableItemDrop() - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.BaseModalBuilder
-
Disable item drop inside the modal
- disableItemPlace() - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Disable item placement inside the modal.
- disableItemPlace() - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.BaseModalBuilder
-
Disable item placement inside the modal
- disableItemSwap() - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Disable item swap inside the modal.
- disableItemSwap() - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.BaseModalBuilder
-
Disable item swap inside the modal
- disableItemTake() - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Disable item retrieval inside the modal.
- disableItemTake() - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.BaseModalBuilder
-
Disable item retrieval inside the modal
- disableOtherActions() - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Disable other modal actions This option pretty much disables creating a clone stack of the item
- disableOtherActions() - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.BaseModalBuilder
-
Disable other modal actions This option pretty much disables creating a clone stack of the item
- disenchant(Enchantment) - Method in class io.rhythmknights.coreapi.modal.builder.item.BaseItemBuilder
-
Disenchants a certain
Enchantmentfrom theItemStack - DISPENSER - Enum constant in enum class io.rhythmknights.coreapi.component.module.ModalType
- dynamicTitle(String) - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.PaginatedBuilder
-
Enables a dynamic title that shows pagination information
- dynamicTitle(String) - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.ScrollingBuilder
-
Enables a dynamic title that shows scrolling position
- dynamicTitle(String, Function<DynamicTitle.PaginationState, Component>) - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.PaginatedBuilder
-
Enables a dynamic title with custom formatting function
- dynamicTitle(String, Function<DynamicTitle.PaginationState, Component>) - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.ScrollingBuilder
-
Enables a dynamic title with custom formatting function
- DynamicTitle - Interface in io.rhythmknights.coreapi.component.module
-
Interface for handling dynamic titles in modals Allows for titles to be updated based on the current state of the modal
- DynamicTitle.DynamicTitleImpl - Class in io.rhythmknights.coreapi.component.module
-
Simple implementation for creating dynamic titles with a function
- DynamicTitle.InteractionDynamicTitle - Class in io.rhythmknights.coreapi.component.module
-
Implementation for updating titles based on item interactions
- DynamicTitle.InteractionState - Class in io.rhythmknights.coreapi.component.module
-
Data class for interaction state
- DynamicTitle.PaginatedDynamicTitle - Class in io.rhythmknights.coreapi.component.module
-
Implementation for paginated modals that shows current page / total pages
- DynamicTitle.PaginationState - Class in io.rhythmknights.coreapi.component.module
-
Data class for pagination state
- DynamicTitleImpl(Function<Object, Component>, Object) - Constructor for class io.rhythmknights.coreapi.component.module.DynamicTitle.DynamicTitleImpl
-
Creates a dynamic title with a function that takes a state object
E
- effect(List<FireworkEffect>) - Method in class io.rhythmknights.coreapi.modal.builder.item.FireworkBuilder
-
Add several firework effects to this firework.
- effect(FireworkEffect...) - Method in class io.rhythmknights.coreapi.modal.builder.item.FireworkBuilder
-
Add several firework effects to this firework.
- enableAllInteractions() - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Enable all modifications of the modal, making it completely mutable by player interaction.
- enableAllInteractions() - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.BaseModalBuilder
-
Enable all modifications of the modal, making it completely mutable by player interaction
- enableItemDrop() - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Allows item drop inside the modal
- enableItemDrop() - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.BaseModalBuilder
-
Allows item drop inside the modal
- enableItemPlace() - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Allows item placement inside the modal.
- enableItemPlace() - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.BaseModalBuilder
-
Allows item placement inside the modal
- enableItemSwap() - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Allows item swap inside the modal.
- enableItemSwap() - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.BaseModalBuilder
-
Allows item swap inside the modal
- enableItemTake() - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Allow items to be taken from the modal.
- enableItemTake() - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.BaseModalBuilder
-
Allow items to be taken from the modal
- enableOtherActions() - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Enable other modal actions This option pretty much enables creating a clone stack of the item
- enableOtherActions() - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.BaseModalBuilder
-
Enable other modal actions This option pretty much enables creating a clone stack of the item
- enchant(Map<Enchantment, Integer>) - Method in class io.rhythmknights.coreapi.modal.builder.item.BaseItemBuilder
-
Enchants the
ItemStackwith the specified map where the value is the level of the key's enchantment - enchant(Map<Enchantment, Integer>, boolean) - Method in class io.rhythmknights.coreapi.modal.builder.item.BaseItemBuilder
-
Enchants the
ItemStackwith the specified map where the value is the level of the key's enchantment - enchant(Enchantment) - Method in class io.rhythmknights.coreapi.modal.builder.item.BaseItemBuilder
-
Enchants the
ItemStack - enchant(Enchantment, int) - Method in class io.rhythmknights.coreapi.modal.builder.item.BaseItemBuilder
-
Enchants the
ItemStack - enchant(Enchantment, int, boolean) - Method in class io.rhythmknights.coreapi.modal.builder.item.BaseItemBuilder
-
Enchants the
ItemStack - encodeModal() - Method in interface io.rhythmknights.coreapi.component.module.Serializable
- execute(T) - Method in interface io.rhythmknights.coreapi.component.module.ModalAction
-
Executes the event passed to it
F
- fill(ModalItem) - Method in class io.rhythmknights.coreapi.component.utility.ModalFiller
-
Sets an ModalItem to fill up the entire inventory where there is no other item
- fill(List<ModalItem>) - Method in class io.rhythmknights.coreapi.component.utility.ModalFiller
-
Fill empty slots with Multiple ModalItems, goes through list and starts again
- fillBetweenPoints(int, int, int, int, ModalItem) - Method in class io.rhythmknights.coreapi.component.utility.ModalFiller
-
Fills rectangle from points within the modal
- fillBetweenPoints(int, int, int, int, List<ModalItem>) - Method in class io.rhythmknights.coreapi.component.utility.ModalFiller
-
Fills rectangle from points within the modal
- fillBorder(ModalItem) - Method in class io.rhythmknights.coreapi.component.utility.ModalFiller
-
Fills the outside section of the modal with a ModalItem
- fillBorder(List<ModalItem>) - Method in class io.rhythmknights.coreapi.component.utility.ModalFiller
-
Fill empty slots with Multiple ModalItems, goes through list and starts again
- fillBottom(ModalItem) - Method in class io.rhythmknights.coreapi.component.utility.ModalFiller
-
Fills bottom portion of the modal
- fillBottom(List<ModalItem>) - Method in class io.rhythmknights.coreapi.component.utility.ModalFiller
-
Fills bottom portion of the modal with alternation
- fillSide(ModalFiller.Side, List<ModalItem>) - Method in class io.rhythmknights.coreapi.component.utility.ModalFiller
-
Fills specified side of the modal with a ModalItem
- fillTop(ModalItem) - Method in class io.rhythmknights.coreapi.component.utility.ModalFiller
-
Fills top portion of the modal
- fillTop(List<ModalItem>) - Method in class io.rhythmknights.coreapi.component.utility.ModalFiller
-
Fills top portion of the modal with alternation
- firework() - Static method in class io.rhythmknights.coreapi.modal.builder.item.ItemBuilder
-
Method for creating a
FireworkBuilderwhich will haveMaterial.FIREWORK_ROCKETspecific methods - firework(ItemStack) - Static method in class io.rhythmknights.coreapi.modal.builder.item.ItemBuilder
-
Method for creating a
FireworkBuilderwhich will haveMaterial.FIREWORK_ROCKETspecific methods - FireworkBuilder - Class in io.rhythmknights.coreapi.modal.builder.item
-
Item builder for
Material.FIREWORK_ROCKETandMaterial.FIREWORK_ROCKETonly - flags(ItemFlag...) - Method in class io.rhythmknights.coreapi.modal.builder.item.BaseItemBuilder
-
Add an
ItemFlagto the item - from(Material) - Static method in class io.rhythmknights.coreapi.modal.builder.item.ItemBuilder
-
Alternative method to create
ItemBuilder - from(ItemStack) - Static method in class io.rhythmknights.coreapi.modal.builder.item.ItemBuilder
-
Main method to create
ItemBuilder
G
- generation(BookMeta.Generation) - Method in class io.rhythmknights.coreapi.modal.builder.item.BookBuilder
-
Sets the generation of the book.
- getAction() - Method in class io.rhythmknights.coreapi.component.modal.ModalItem
-
Gets the
ModalActionto do when the player clicks on it - getBaseTitle() - Method in class io.rhythmknights.coreapi.component.module.DynamicTitle.InteractionDynamicTitle
-
Get the base title
- getBaseTitle() - Method in class io.rhythmknights.coreapi.component.module.DynamicTitle.PaginatedDynamicTitle
-
Get the base title
- getConsumer() - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.BaseModalBuilder
-
Getter for the consumer
- getCurrentPage() - Method in class io.rhythmknights.coreapi.component.module.DynamicTitle.PaginatedDynamicTitle
-
Get the current page
- getCurrentPageItems() - Method in class io.rhythmknights.coreapi.component.modal.PaginatedModal
-
Gets an immutable
Mapwith all the current pages items - getCurrentPageNum() - Method in class io.rhythmknights.coreapi.component.modal.PaginatedModal
-
Gets the current page number
- getDynamicTitle() - Method in class io.rhythmknights.coreapi.component.module.DynamicTitle.DynamicTitleImpl
- getDynamicTitle() - Method in interface io.rhythmknights.coreapi.component.module.DynamicTitle
-
Get the current dynamic title based on modal state
- getDynamicTitle() - Method in class io.rhythmknights.coreapi.component.module.DynamicTitle.InteractionDynamicTitle
- getDynamicTitle() - Method in class io.rhythmknights.coreapi.component.module.DynamicTitle.PaginatedDynamicTitle
- getDynamicTitle() - Method in class io.rhythmknights.coreapi.component.module.ModalContainer.Chest
- getDynamicTitle() - Method in interface io.rhythmknights.coreapi.component.module.ModalContainer
-
Get the dynamic title handler if one exists
- getDynamicTitle() - Method in class io.rhythmknights.coreapi.component.module.ModalContainer.Typed
- getFiller() - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Gets the
ModalFillerthat it's used for filling up the modal in specific ways. - getFillSize() - Method in enum class io.rhythmknights.coreapi.component.module.ModalType
- getInventory() - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Gets the main
Inventoryof this modal. - getInventory(Component, InventoryHolder, int) - Method in interface io.rhythmknights.coreapi.component.module.InventoryProvider.Chest
- getInventory(Component, InventoryHolder, InventoryType) - Method in interface io.rhythmknights.coreapi.component.module.InventoryProvider.Typed
- getInventoryProvider() - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.BaseChestModalBuilder
- getInventoryType() - Method in enum class io.rhythmknights.coreapi.component.module.ModalType
- getItemStack() - Method in class io.rhythmknights.coreapi.component.modal.ModalItem
-
Gets the ModalItem's
ItemStack - getItemStack() - Method in class io.rhythmknights.coreapi.modal.builder.item.BaseItemBuilder
-
Package private getter for extended builders
- getLimit() - Method in enum class io.rhythmknights.coreapi.component.module.ModalType
- getMeta() - Method in class io.rhythmknights.coreapi.modal.builder.item.BaseItemBuilder
-
Package private getter for extended builders
- getModalItem(int) - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Gets a specific
ModalItemon the slot. - getModalItems() - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Gets an immutable
Mapwith all the modal items. - getModifiers() - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.BaseModalBuilder
-
Getter for the set of interaction modifiers
- getNextPageNum() - Method in class io.rhythmknights.coreapi.component.modal.PaginatedModal
-
Gets the next page number
- getPageItems() - Method in class io.rhythmknights.coreapi.component.modal.PaginatedModal
-
Gets an immutable
Listwith all the page items added to the modal - getPagesNum() - Method in class io.rhythmknights.coreapi.component.modal.PaginatedModal
-
Gets the number of pages the modal has
- getPaginationRegion() - Method in class io.rhythmknights.coreapi.component.modal.PaginatedModal
-
Gets the pagination region if one is set
- getPlugin() - Static method in class io.rhythmknights.coreapi.CoreAPI
- getPrevPageNum() - Method in class io.rhythmknights.coreapi.component.modal.PaginatedModal
-
Gets the previous page number
- getRows() - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Gets the amount of
BaseModal.modalContainerrows. - getRows() - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.BaseChestModalBuilder
-
Getter for the rows
- getSkinUrl(String) - Static method in class io.rhythmknights.coreapi.component.utility.SkullUtil
-
Decode a base64 string and extract the url of the skin.
- getSlots() - Method in class io.rhythmknights.coreapi.component.module.PaginationRegion
-
Get the list of slots in this region
- getString(ItemStack, String) - Static method in class io.rhythmknights.coreapi.component.utility.ItemNBT
-
Gets the NBT tag based on a given key.
- getString(ItemStack, String) - Method in class io.rhythmknights.coreapi.component.module.nbt.LegacyNBT
-
Gets the NBT tag based on a given key.
- getString(ItemStack, String) - Method in interface io.rhythmknights.coreapi.component.module.nbt.NBTWrapper
-
Gets the NBT tag based on a given key.
- getString(ItemStack, String) - Method in class io.rhythmknights.coreapi.component.module.nbt.PDC
-
Gets the NBT tag based on a given key.
- getTag(Object) - Static method in class io.rhythmknights.coreapi.component.module.nbt.LegacyNBT
-
Mimics the nmsItemStack#getTag method.
- getTitle() - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.BaseModalBuilder
-
Getter for the title
- getTotalPages() - Method in class io.rhythmknights.coreapi.component.module.DynamicTitle.PaginatedDynamicTitle
-
Get the total number of pages
- glow() - Method in class io.rhythmknights.coreapi.modal.builder.item.BaseItemBuilder
-
Makes the
ItemStackglow - glow(boolean) - Method in class io.rhythmknights.coreapi.modal.builder.item.BaseItemBuilder
-
Adds or removes the
ItemStackglow
H
- hasDynamicTitle() - Method in class io.rhythmknights.coreapi.component.module.ModalContainer.Chest
- hasDynamicTitle() - Method in interface io.rhythmknights.coreapi.component.module.ModalContainer
-
Check if this container uses a dynamic title
- hasDynamicTitle() - Method in class io.rhythmknights.coreapi.component.module.ModalContainer.Typed
- HOPPER - Enum constant in enum class io.rhythmknights.coreapi.component.module.ModalType
- HORIZONTAL - Enum constant in enum class io.rhythmknights.coreapi.component.module.ScrollType
I
- init(Plugin) - Static method in class io.rhythmknights.coreapi.CoreAPI
- interactionDynamicTitle(String) - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.PaginatedBuilder
-
Enables an interaction-based dynamic title
- interactionDynamicTitle(String) - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.ScrollingBuilder
-
Enables an interaction-based dynamic title
- interactionDynamicTitle(String, Function<DynamicTitle.InteractionState, Component>) - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.PaginatedBuilder
-
Enables an interaction-based dynamic title with custom formatting function
- interactionDynamicTitle(String, Function<DynamicTitle.InteractionState, Component>) - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.ScrollingBuilder
-
Enables an interaction-based dynamic title with custom formatting function
- InteractionDynamicTitle(String) - Constructor for class io.rhythmknights.coreapi.component.module.DynamicTitle.InteractionDynamicTitle
-
Creates a dynamic title that updates on item interactions
- InteractionDynamicTitle(Function<DynamicTitle.InteractionState, Component>, String) - Constructor for class io.rhythmknights.coreapi.component.module.DynamicTitle.InteractionDynamicTitle
-
Creates a dynamic title with custom formatting
- InteractionModifier - Enum Class in io.rhythmknights.coreapi.component.module
-
Used to control what kind of interaction can happen inside a modal
- InteractionModifierListener - Class in io.rhythmknights.coreapi.component.modal
-
Listener that apply default modal
InteractionModifiers to all modals - InteractionModifierListener() - Constructor for class io.rhythmknights.coreapi.component.modal.InteractionModifierListener
- InteractionState(String, ModalItem, int, ClickType, InventoryAction) - Constructor for class io.rhythmknights.coreapi.component.module.DynamicTitle.InteractionState
- inventory(InventoryProvider.Chest) - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.BaseChestModalBuilder
- inventory(InventoryProvider.Typed) - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.TypedModalBuilder
- InventoryProvider - Class in io.rhythmknights.coreapi.component.module
- InventoryProvider() - Constructor for class io.rhythmknights.coreapi.component.module.InventoryProvider
- InventoryProvider.Chest - Interface in io.rhythmknights.coreapi.component.module
- InventoryProvider.Typed - Interface in io.rhythmknights.coreapi.component.module
- inventorySize() - Method in class io.rhythmknights.coreapi.component.module.ModalContainer.Chest
- inventorySize() - Method in interface io.rhythmknights.coreapi.component.module.ModalContainer
- inventorySize() - Method in class io.rhythmknights.coreapi.component.module.ModalContainer.Typed
- io.rhythmknights.coreapi - package io.rhythmknights.coreapi
- io.rhythmknights.coreapi.component.modal - package io.rhythmknights.coreapi.component.modal
- io.rhythmknights.coreapi.component.modal.builder.modal - package io.rhythmknights.coreapi.component.modal.builder.modal
- io.rhythmknights.coreapi.component.module - package io.rhythmknights.coreapi.component.module
- io.rhythmknights.coreapi.component.module.exception - package io.rhythmknights.coreapi.component.module.exception
- io.rhythmknights.coreapi.component.module.nbt - package io.rhythmknights.coreapi.component.module.nbt
- io.rhythmknights.coreapi.component.utility - package io.rhythmknights.coreapi.component.utility
- io.rhythmknights.coreapi.modal.builder.item - package io.rhythmknights.coreapi.modal.builder.item
- IS_COMPONENT_LEGACY - Static variable in class io.rhythmknights.coreapi.component.utility.VersionHelper
-
Checks if the version supports Components or not Spigot always false
- IS_CUSTOM_MODEL_DATA - Static variable in class io.rhythmknights.coreapi.component.utility.VersionHelper
-
Checks if the version has
ItemMeta.setCustomModelData(Integer) - IS_FOLIA - Static variable in class io.rhythmknights.coreapi.component.utility.VersionHelper
- IS_ITEM_LEGACY - Static variable in class io.rhythmknights.coreapi.component.utility.VersionHelper
-
Checks if the version is lower than 1.13 due to the item changes
- IS_ITEM_NAME_COMPONENT - Static variable in class io.rhythmknights.coreapi.component.utility.VersionHelper
-
Starting with version 1.20.5 the internal field referenced by
ItemMeta.getDisplayName()is no longer a string - IS_PDC_VERSION - Static variable in class io.rhythmknights.coreapi.component.utility.VersionHelper
-
Checks if the version supports
PersistentDataContainer - IS_PLAYER_PROFILE_API - Static variable in class io.rhythmknights.coreapi.component.utility.VersionHelper
-
Checks if the version has
PlayerProfile - IS_SKULL_OWNER_LEGACY - Static variable in class io.rhythmknights.coreapi.component.utility.VersionHelper
-
Checks if the version doesn't have
SkullMeta.setOwningPlayer(OfflinePlayer)andSkullMeta.setOwner(String)should be used instead - IS_UNBREAKABLE_LEGACY - Static variable in class io.rhythmknights.coreapi.component.utility.VersionHelper
-
Checks if the version supports the
ItemMeta.setUnbreakable(boolean)method - isPlayerSkull(ItemStack) - Static method in class io.rhythmknights.coreapi.component.utility.SkullUtil
-
Checks if an
ItemStackis a player skull - isUpdating() - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Checks whether or not the modal is updating.
- ItemBuilder - Class in io.rhythmknights.coreapi.modal.builder.item
-
Main ItemBuilder
- ItemNBT - Class in io.rhythmknights.coreapi.component.utility
-
Ideally this wouldn't need to be an util, but because of the
LegacyNBTit makes it easier. - ItemNBT() - Constructor for class io.rhythmknights.coreapi.component.utility.ItemNBT
L
- LEFT - Enum constant in enum class io.rhythmknights.coreapi.component.utility.ModalFiller.Side
- Legacy - Class in io.rhythmknights.coreapi.component.utility
-
Utility class for converting between different text formatting styles
- Legacy.TextSerializer - Class in io.rhythmknights.coreapi.component.utility
-
Custom serializer that combines both legacy and MiniMessage formats
- LegacyNBT - Class in io.rhythmknights.coreapi.component.module.nbt
-
Class to set / get NBT tags from items.
- LegacyNBT() - Constructor for class io.rhythmknights.coreapi.component.module.nbt.LegacyNBT
- locationName(String) - Method in class io.rhythmknights.coreapi.modal.builder.item.MapBuilder
-
Sets the location name.
- lore(List<Component>) - Method in class io.rhythmknights.coreapi.modal.builder.item.BaseItemBuilder
-
Set the lore lines of an item Components should be pre-parsed by CoreFramework's TextUtility
- lore(Consumer<List<Component>>) - Method in class io.rhythmknights.coreapi.modal.builder.item.BaseItemBuilder
-
Consumer for freely adding to the lore Components should be pre-parsed by CoreFramework's TextUtility
- lore(Component...) - Method in class io.rhythmknights.coreapi.modal.builder.item.BaseItemBuilder
-
Set the lore lines of an item Components should be pre-parsed by CoreFramework's TextUtility
M
- map() - Static method in class io.rhythmknights.coreapi.modal.builder.item.ItemBuilder
-
Method for creating a
MapBuilderwhich will haveMaterial.MAPspecific methods - map(ItemStack) - Static method in class io.rhythmknights.coreapi.modal.builder.item.ItemBuilder
-
Method for creating a
MapBuilderwhich will have @link Material#MAP} specific methods - MapBuilder - Class in io.rhythmknights.coreapi.modal.builder.item
-
Item builder for
Material.MAPonly - modal() - Static method in class io.rhythmknights.coreapi.component.modal.Modal
-
Creates a
ChestModalBuilderwith CHEST as theModalType - modal(ModalType) - Static method in class io.rhythmknights.coreapi.component.modal.Modal
-
Creates a
TypedModalBuilderto build aModal - Modal - Class in io.rhythmknights.coreapi.component.modal
-
Standard modal implementation of
BaseModal - Modal(ModalContainer, Set<InteractionModifier>) - Constructor for class io.rhythmknights.coreapi.component.modal.Modal
- ModalAction<T> - Interface in io.rhythmknights.coreapi.component.module
- modalContainer() - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
- ModalContainer - Interface in io.rhythmknights.coreapi.component.module
- ModalContainer.Chest - Class in io.rhythmknights.coreapi.component.module
- ModalContainer.Typed - Class in io.rhythmknights.coreapi.component.module
- ModalException - Exception Class in io.rhythmknights.coreapi.component.module.exception
- ModalException(String) - Constructor for exception class io.rhythmknights.coreapi.component.module.exception.ModalException
- ModalException(String, Exception) - Constructor for exception class io.rhythmknights.coreapi.component.module.exception.ModalException
- ModalFiller - Class in io.rhythmknights.coreapi.component.utility
-
TODO fix comments
- ModalFiller(BaseModal) - Constructor for class io.rhythmknights.coreapi.component.utility.ModalFiller
- ModalFiller.Side - Enum Class in io.rhythmknights.coreapi.component.utility
- ModalItem - Class in io.rhythmknights.coreapi.component.modal
-
ModalItem represents the
ItemStackon theInventory - ModalItem(Material) - Constructor for class io.rhythmknights.coreapi.component.modal.ModalItem
- ModalItem(Material, ModalAction<InventoryClickEvent>) - Constructor for class io.rhythmknights.coreapi.component.modal.ModalItem
-
Alternate constructor that takes
Materialinstead of anItemStack - ModalItem(ItemStack) - Constructor for class io.rhythmknights.coreapi.component.modal.ModalItem
-
Secondary constructor with no action
- ModalItem(ItemStack, ModalAction<InventoryClickEvent>) - Constructor for class io.rhythmknights.coreapi.component.modal.ModalItem
-
Main constructor of the ModalItem
- ModalListener - Class in io.rhythmknights.coreapi.component.modal
- ModalListener() - Constructor for class io.rhythmknights.coreapi.component.modal.ModalListener
- ModalPage - Class in io.rhythmknights.coreapi.component.module
- ModalPage() - Constructor for class io.rhythmknights.coreapi.component.module.ModalPage
- modalType() - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Gets the
ModalTypein use. - modalType() - Method in class io.rhythmknights.coreapi.component.module.ModalContainer.Chest
- modalType() - Method in interface io.rhythmknights.coreapi.component.module.ModalContainer
- modalType() - Method in class io.rhythmknights.coreapi.component.module.ModalContainer.Typed
- ModalType - Enum Class in io.rhythmknights.coreapi.component.module
- model(int) - Method in class io.rhythmknights.coreapi.modal.builder.item.BaseItemBuilder
-
Sets the custom model data of the item Added in 1.13
N
- name(Component) - Method in class io.rhythmknights.coreapi.modal.builder.item.BaseItemBuilder
-
Sets the display name of the item using
ComponentComponent should be pre-parsed by CoreFramework's TextUtility - NBTWrapper - Interface in io.rhythmknights.coreapi.component.module.nbt
- next() - Method in class io.rhythmknights.coreapi.component.modal.PaginatedModal
-
Goes to the next page
- next() - Method in class io.rhythmknights.coreapi.component.modal.ScrollingModal
-
Overrides
PaginatedModal.next()to make it work with the specific scrolls - NMS_VERSION - Static variable in class io.rhythmknights.coreapi.component.module.nbt.LegacyNBT
O
- onModalClick(InventoryClickEvent) - Method in class io.rhythmknights.coreapi.component.modal.InteractionModifierListener
-
Handles any click on modals, applying all
InteractionModifieras required - onModalClick(InventoryClickEvent) - Method in class io.rhythmknights.coreapi.component.modal.ModalListener
-
Handles what happens when a player clicks on the modal
- onModalClose(InventoryCloseEvent) - Method in class io.rhythmknights.coreapi.component.modal.ModalListener
-
Handles what happens when the modal is closed
- onModalDrag(InventoryDragEvent) - Method in class io.rhythmknights.coreapi.component.modal.InteractionModifierListener
-
Handles any item drag on modals, applying all
InteractionModifieras required - onModalDrag(InventoryDragEvent) - Method in class io.rhythmknights.coreapi.component.modal.ModalListener
-
Handles what happens when a player clicks on the modal
- onModalOpen(InventoryOpenEvent) - Method in class io.rhythmknights.coreapi.component.modal.ModalListener
-
Handles what happens when the modal is opened
- open(HumanEntity) - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Opens the modal for a
HumanEntity. - open(HumanEntity) - Method in class io.rhythmknights.coreapi.component.modal.PaginatedModal
-
Overrides
BaseModal.open(HumanEntity)to use the paginated populator instead - open(HumanEntity) - Method in class io.rhythmknights.coreapi.component.modal.ScrollingModal
-
Overrides
PaginatedModal.open(HumanEntity)to make it work with the specific scrolls - open(HumanEntity, int) - Method in class io.rhythmknights.coreapi.component.modal.PaginatedModal
-
Specific open method for the Paginated modal Uses
PaginatedModal.populatePage() - open(HumanEntity, int) - Method in class io.rhythmknights.coreapi.component.modal.ScrollingModal
-
Overrides
PaginatedModal.open(HumanEntity, int)to make it work with the specific scrolls - owner(OfflinePlayer) - Method in class io.rhythmknights.coreapi.modal.builder.item.SkullBuilder
-
Sets skull owner via bukkit methods
P
- PACKAGE_NAME - Static variable in class io.rhythmknights.coreapi.component.module.nbt.LegacyNBT
- page(int, Component) - Method in class io.rhythmknights.coreapi.modal.builder.item.BookBuilder
-
Sets the specified page in the book.
- page(List<Component>) - Method in class io.rhythmknights.coreapi.modal.builder.item.BookBuilder
-
Adds new pages to the end of the book.
- page(Component...) - Method in class io.rhythmknights.coreapi.modal.builder.item.BookBuilder
-
Adds new pages to the end of the book.
- pageSize(int) - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.PaginatedBuilder
-
Sets the desirable page size, most of the time this isn't needed
- pageSize(int) - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.ScrollingBuilder
-
Sets the desirable page size, most of the times this isn't needed
- paginated() - Static method in class io.rhythmknights.coreapi.component.modal.Modal
-
Creates a
PaginatedBuilderto build aPaginatedModal - PaginatedBuilder - Class in io.rhythmknights.coreapi.component.modal.builder.modal
-
Modal builder for creating a
PaginatedModal - PaginatedBuilder() - Constructor for class io.rhythmknights.coreapi.component.modal.builder.modal.PaginatedBuilder
- PaginatedDynamicTitle(String, int, int) - Constructor for class io.rhythmknights.coreapi.component.module.DynamicTitle.PaginatedDynamicTitle
-
Creates a paginated dynamic title
- PaginatedDynamicTitle(Function<DynamicTitle.PaginationState, Component>, String, int, int) - Constructor for class io.rhythmknights.coreapi.component.module.DynamicTitle.PaginatedDynamicTitle
-
Creates a paginated dynamic title with custom formatting
- PaginatedModal - Class in io.rhythmknights.coreapi.component.modal
-
Modal that allows you to have multiple pages
- PaginatedModal(ModalContainer, int, Set<InteractionModifier>) - Constructor for class io.rhythmknights.coreapi.component.modal.PaginatedModal
- PaginatedModal(ModalContainer, PaginationRegion, Set<InteractionModifier>) - Constructor for class io.rhythmknights.coreapi.component.modal.PaginatedModal
-
Constructor with pagination region
- paginationRegion(PaginationRegion) - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.PaginatedBuilder
-
Sets a specific region for pagination items
- paginationRegion(PaginationRegion) - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.ScrollingBuilder
-
Sets a specific region for pagination items
- PaginationRegion - Class in io.rhythmknights.coreapi.component.module
-
Defines a region within a modal where pagination items can be placed
- PaginationRegion(int...) - Constructor for class io.rhythmknights.coreapi.component.module.PaginationRegion
-
Create a pagination region with specific slots
- PaginationRegion(List<Integer>) - Constructor for class io.rhythmknights.coreapi.component.module.PaginationRegion
-
Create a pagination region from a list of slots
- PaginationState(String, int, int) - Constructor for class io.rhythmknights.coreapi.component.module.DynamicTitle.PaginationState
- pattern(int, DyeColor, PatternType) - Method in class io.rhythmknights.coreapi.modal.builder.item.BannerBuilder
-
Sets the pattern at the specified index
- pattern(int, Pattern) - Method in class io.rhythmknights.coreapi.modal.builder.item.BannerBuilder
-
Sets the pattern at the specified index
- pattern(List<Pattern>) - Method in class io.rhythmknights.coreapi.modal.builder.item.BannerBuilder
-
Adds new patterns on top of the existing patterns
- pattern(DyeColor, PatternType) - Method in class io.rhythmknights.coreapi.modal.builder.item.BannerBuilder
-
Adds a new pattern on top of the existing patterns
- pattern(Pattern...) - Method in class io.rhythmknights.coreapi.modal.builder.item.BannerBuilder
-
Adds new patterns on top of the existing patterns
- pdc(Consumer<PersistentDataContainer>) - Method in class io.rhythmknights.coreapi.modal.builder.item.BaseItemBuilder
-
Consumer for applying
PersistentDataContainerto the item This method will only work on versions above 1.14 - PDC - Class in io.rhythmknights.coreapi.component.module.nbt
-
Wrapper for compatibility with
LegacyNBT. - PDC() - Constructor for class io.rhythmknights.coreapi.component.module.nbt.PDC
- power(int) - Method in class io.rhythmknights.coreapi.modal.builder.item.FireworkBuilder
-
Sets the approximate power of the firework.
- PREVENT_ITEM_DROP - Enum constant in enum class io.rhythmknights.coreapi.component.module.InteractionModifier
- PREVENT_ITEM_PLACE - Enum constant in enum class io.rhythmknights.coreapi.component.module.InteractionModifier
- PREVENT_ITEM_SWAP - Enum constant in enum class io.rhythmknights.coreapi.component.module.InteractionModifier
- PREVENT_ITEM_TAKE - Enum constant in enum class io.rhythmknights.coreapi.component.module.InteractionModifier
- PREVENT_OTHER_ACTIONS - Enum constant in enum class io.rhythmknights.coreapi.component.module.InteractionModifier
- previous() - Method in class io.rhythmknights.coreapi.component.modal.PaginatedModal
-
Goes to the previous page if possible
- previous() - Method in class io.rhythmknights.coreapi.component.modal.ScrollingModal
-
Overrides
PaginatedModal.previous()to make it work with the specific scrolls
R
- rectangle(int, int, int, int) - Static method in class io.rhythmknights.coreapi.component.module.PaginationRegion
-
Create a pagination region from a rectangular area
- removeItem(int) - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Removes the
ModalItemin the specific slot. - removeItem(int, int) - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Alternative
BaseModal.removeItem(int)with cols and rows. - removeItem(ModalItem) - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Removes the given
ModalItemfrom the modal. - removeItem(ItemStack) - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Removes the given
ItemStackfrom the modal. - removeNBT(String) - Method in class io.rhythmknights.coreapi.modal.builder.item.BaseItemBuilder
-
Removes NBT tag from the
ItemStack - removePageItem(ModalItem) - Method in class io.rhythmknights.coreapi.component.modal.PaginatedModal
-
Removes a given
ModalItemfrom the page. - removePageItem(ItemStack) - Method in class io.rhythmknights.coreapi.component.modal.PaginatedModal
-
Removes a given
ItemStackfrom the page. - removeTag(ItemStack, String) - Static method in class io.rhythmknights.coreapi.component.utility.ItemNBT
-
Removes a tag from an
ItemStack. - removeTag(ItemStack, String) - Method in class io.rhythmknights.coreapi.component.module.nbt.LegacyNBT
-
Removes a tag from an
ItemStack. - removeTag(ItemStack, String) - Method in interface io.rhythmknights.coreapi.component.module.nbt.NBTWrapper
-
Removes a tag from an
ItemStack. - removeTag(ItemStack, String) - Method in class io.rhythmknights.coreapi.component.module.nbt.PDC
-
Removes a tag from an
ItemStack. - RIGHT - Enum constant in enum class io.rhythmknights.coreapi.component.utility.ModalFiller.Side
- rows() - Method in class io.rhythmknights.coreapi.component.module.ModalContainer.Chest
- rows() - Method in interface io.rhythmknights.coreapi.component.module.ModalContainer
- rows() - Method in class io.rhythmknights.coreapi.component.module.ModalContainer.Typed
- rows(int) - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.BaseChestModalBuilder
-
Sets the rows for the modal This will only work on CHEST
ModalType - rows(int) - Method in class io.rhythmknights.coreapi.component.module.ModalContainer.Chest
- rows(int...) - Static method in class io.rhythmknights.coreapi.component.module.PaginationRegion
-
Create a pagination region for specific rows
S
- scaling(boolean) - Method in class io.rhythmknights.coreapi.modal.builder.item.MapBuilder
-
Sets if this map is scaling or not.
- scrolling() - Static method in class io.rhythmknights.coreapi.component.modal.Modal
-
Creates a
ScrollingBuilderwith VERTICAL as theScrollType - scrolling(ScrollType) - Static method in class io.rhythmknights.coreapi.component.modal.Modal
-
Creates a
ScrollingBuilderto build aScrollingModal - ScrollingBuilder - Class in io.rhythmknights.coreapi.component.modal.builder.modal
-
The builder for creating a
ScrollingModal - ScrollingBuilder(ScrollType) - Constructor for class io.rhythmknights.coreapi.component.modal.builder.modal.ScrollingBuilder
-
Main constructor
- ScrollingModal - Class in io.rhythmknights.coreapi.component.modal
-
Modal that allows you to scroll through items
- ScrollingModal(ModalContainer, int, ScrollType, Set<InteractionModifier>) - Constructor for class io.rhythmknights.coreapi.component.modal.ScrollingModal
- ScrollingModal(ModalContainer, PaginationRegion, ScrollType, Set<InteractionModifier>) - Constructor for class io.rhythmknights.coreapi.component.modal.ScrollingModal
-
Constructor with pagination region
- scrollType(ScrollType) - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.ScrollingBuilder
-
Sets the
ScrollTypeto be used - ScrollType - Enum Class in io.rhythmknights.coreapi.component.module
-
Possible Scroll types for the
ScrollingModal - Serializable - Interface in io.rhythmknights.coreapi.component.module
- serialize(Component) - Method in class io.rhythmknights.coreapi.component.utility.Legacy.TextSerializer
-
Serializes a Component to a string with legacy formatting using ยง symbols This is what Bukkit inventories expect for proper color display
- serializeComponent(Component) - Method in class io.rhythmknights.coreapi.modal.builder.item.BaseItemBuilder
-
Serializes the component with the right ComponentSerializer for the current MC version Expects Components to be pre-parsed by CoreFramework's TextUtility
- SERIALIZER - Static variable in class io.rhythmknights.coreapi.component.utility.Legacy
-
Creates a single serializer that supports multiple formats: 1.
- setAction(ModalAction<InventoryClickEvent>) - Method in class io.rhythmknights.coreapi.component.modal.ModalItem
-
Replaces the
ModalActionof the current Modal Item - setBoolean(ItemStack, String, boolean) - Static method in class io.rhythmknights.coreapi.component.utility.ItemNBT
-
Sets a boolean to the
ItemStack. - setBoolean(ItemStack, String, boolean) - Method in class io.rhythmknights.coreapi.component.module.nbt.LegacyNBT
-
Sets a boolean to the
ItemStack. - setBoolean(ItemStack, String, boolean) - Method in interface io.rhythmknights.coreapi.component.module.nbt.NBTWrapper
-
Sets a boolean to the
ItemStack. - setBoolean(ItemStack, String, boolean) - Method in class io.rhythmknights.coreapi.component.module.nbt.PDC
-
Sets a boolean to the
ItemStack. - setCloseModalAction(ModalAction<InventoryCloseEvent>) - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Sets the
ModalActionto run once the inventory is closed. - setDefaultClickAction(ModalAction<InventoryClickEvent>) - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Sets the
ModalActionof a default click on any item. - setDefaultTopClickAction(ModalAction<InventoryClickEvent>) - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Sets the
ModalActionof a default click on any item on the top part of the modal. - setDragAction(ModalAction<InventoryDragEvent>) - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Sets the
ModalActionof a default drag action. - setDynamicTitle(DynamicTitle) - Method in class io.rhythmknights.coreapi.component.module.ModalContainer.Chest
-
Set a dynamic title handler
- setDynamicTitle(DynamicTitle) - Method in class io.rhythmknights.coreapi.component.module.ModalContainer.Typed
-
Set a dynamic title handler
- setDynamicTitle(String) - Method in class io.rhythmknights.coreapi.component.modal.PaginatedModal
-
Sets a dynamic title that updates with pagination
- setDynamicTitle(String) - Method in class io.rhythmknights.coreapi.component.modal.ScrollingModal
-
Sets a dynamic title that updates with scrolling position
- setInventory(Inventory) - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Sets the new inventory of the modal.
- setItem(int, int, ModalItem) - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Alternative
BaseModal.setItem(int, ModalItem)to set item that uses ROWS and COLUMNS instead of slots. - setItem(int, ModalItem) - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Sets the
ModalItemto a specific slot on the modal. - setItem(List<Integer>, ModalItem) - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Alternative
BaseModal.setItem(int, ModalItem)to set item that takes aListof slots instead. - setItemStack(ItemStack) - Method in class io.rhythmknights.coreapi.component.modal.ModalItem
-
Replaces the
ItemStackof the Modal Item - setItemStack(ItemStack) - Method in class io.rhythmknights.coreapi.modal.builder.item.BaseItemBuilder
-
Package private setter for the extended builders
- setMeta(ItemMeta) - Method in class io.rhythmknights.coreapi.modal.builder.item.BaseItemBuilder
-
Package private setter for the extended builders
- setNBT(String, boolean) - Method in class io.rhythmknights.coreapi.modal.builder.item.BaseItemBuilder
-
Sets NBT tag to the
ItemStack - setNBT(String, String) - Method in class io.rhythmknights.coreapi.modal.builder.item.BaseItemBuilder
-
Sets NBT tag to the
ItemStack - setOpenModalAction(ModalAction<InventoryOpenEvent>) - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Sets the
ModalActionto run when the modal opens. - setOutsideClickAction(ModalAction<InventoryClickEvent>) - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Sets the
ModalActionto run when clicking on the outside of the inventory. - setPageNum(int) - Method in class io.rhythmknights.coreapi.component.modal.PaginatedModal
-
Sets the page number
- setPageSize(int) - Method in class io.rhythmknights.coreapi.component.modal.PaginatedModal
-
Sets the page size
- setPaginationRegion(PaginationRegion) - Method in class io.rhythmknights.coreapi.component.modal.PaginatedModal
-
Sets the pagination region to use specific slots
- setPatterns(List<Pattern>) - Method in class io.rhythmknights.coreapi.modal.builder.item.BannerBuilder
-
Sets the patterns used on this banner
- setPlayerInventoryAction(ModalAction<InventoryClickEvent>) - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
- setString(ItemStack, String, String) - Static method in class io.rhythmknights.coreapi.component.utility.ItemNBT
-
Sets an NBT tag to the an
ItemStack. - setString(ItemStack, String, String) - Method in class io.rhythmknights.coreapi.component.module.nbt.LegacyNBT
-
Sets an NBT tag to the an
ItemStack. - setString(ItemStack, String, String) - Method in interface io.rhythmknights.coreapi.component.module.nbt.NBTWrapper
-
Sets an String NBT tag to the an
ItemStack. - setString(ItemStack, String, String) - Method in class io.rhythmknights.coreapi.component.module.nbt.PDC
-
Sets an String NBT tag to the an
ItemStack. - setUpdateTitleOnItemClick(boolean) - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Enables or disables title updates when items are clicked
- setUpdating(boolean) - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Sets the updating status of the modal.
- shouldUpdateTitleOnItemClick() - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Checks if the modal should update its title on item clicks
- size() - Method in class io.rhythmknights.coreapi.component.module.PaginationRegion
-
Get the size of this region (number of slots)
- skull() - Static method in class io.rhythmknights.coreapi.component.utility.SkullUtil
-
Create a player skull
- skull() - Static method in class io.rhythmknights.coreapi.modal.builder.item.ItemBuilder
-
Method for creating a
SkullBuilderwhich will have PLAYER_HEAD specific methods - skull(ItemStack) - Static method in class io.rhythmknights.coreapi.modal.builder.item.ItemBuilder
-
Method for creating a
SkullBuilderwhich will have PLAYER_HEAD specific methods - SkullBuilder - Class in io.rhythmknights.coreapi.modal.builder.item
-
New builder for skull only, created to separate the specific features for skulls Soon I'll add more useful features to this builder
- SkullUtil - Class in io.rhythmknights.coreapi.component.utility
- SkullUtil() - Constructor for class io.rhythmknights.coreapi.component.utility.SkullUtil
- star() - Static method in class io.rhythmknights.coreapi.modal.builder.item.ItemBuilder
-
Method for creating a
FireworkBuilderwhich will haveMaterial.FIREWORK_STARspecific methods - star(ItemStack) - Static method in class io.rhythmknights.coreapi.modal.builder.item.ItemBuilder
-
Method for creating a
FireworkBuilderwhich will haveMaterial.FIREWORK_STARspecific methods
T
- TextSerializer() - Constructor for class io.rhythmknights.coreapi.component.utility.Legacy.TextSerializer
- texture(String) - Method in class io.rhythmknights.coreapi.modal.builder.item.SkullBuilder
-
Sets the skull texture using a BASE64 string
- texture(String, UUID) - Method in class io.rhythmknights.coreapi.modal.builder.item.SkullBuilder
-
Sets the skull texture using a BASE64 string
- title() - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Gets the modal title as a
Component. - title() - Method in class io.rhythmknights.coreapi.component.module.ModalContainer.Chest
- title() - Method in interface io.rhythmknights.coreapi.component.module.ModalContainer
- title() - Method in class io.rhythmknights.coreapi.component.module.ModalContainer.Typed
- title(Component) - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.BaseModalBuilder
-
Sets the title for the modal This will be either a Component or a String
- title(Component) - Method in class io.rhythmknights.coreapi.component.module.ModalContainer.Chest
- title(Component) - Method in interface io.rhythmknights.coreapi.component.module.ModalContainer
- title(Component) - Method in class io.rhythmknights.coreapi.component.module.ModalContainer.Typed
- title(Component) - Method in class io.rhythmknights.coreapi.modal.builder.item.BookBuilder
-
Sets the title of the book.
- totalPages - Variable in class io.rhythmknights.coreapi.component.module.DynamicTitle.PaginationState
- type(ModalType) - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.ChestModalBuilder
-
Sets the
ModalTypeto use on the modal This method is unique to the simple modal - type(ModalType) - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.TypedModalBuilder
-
Sets the
ModalTypeto use on the modal This method is unique to the simple modal - Typed(DynamicTitle, InventoryProvider.Typed, ModalType) - Constructor for class io.rhythmknights.coreapi.component.module.ModalContainer.Typed
-
Constructor with dynamic title
- Typed(Component, InventoryProvider.Typed, ModalType) - Constructor for class io.rhythmknights.coreapi.component.module.ModalContainer.Typed
- TypedModalBuilder - Class in io.rhythmknights.coreapi.component.modal.builder.modal
-
The simple modal builder is used for creating a
Modal - TypedModalBuilder(ModalType) - Constructor for class io.rhythmknights.coreapi.component.modal.builder.modal.TypedModalBuilder
-
Main constructor
- TypedModalBuilder(ModalType, ChestModalBuilder) - Constructor for class io.rhythmknights.coreapi.component.modal.builder.modal.TypedModalBuilder
U
- unbreakable() - Method in class io.rhythmknights.coreapi.modal.builder.item.BaseItemBuilder
-
Makes the
ItemStackunbreakable - unbreakable(boolean) - Method in class io.rhythmknights.coreapi.modal.builder.item.BaseItemBuilder
-
Sets the item as unbreakable
- update() - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Updates the modal for all the
Inventoryviews. - update() - Method in class io.rhythmknights.coreapi.component.modal.PaginatedModal
-
Overridden
BaseModal.update()to use the paginated open - update(int, int) - Method in class io.rhythmknights.coreapi.component.module.DynamicTitle.PaginatedDynamicTitle
-
Update pagination state and get new title
- update(Object) - Method in class io.rhythmknights.coreapi.component.module.DynamicTitle.DynamicTitleImpl
- update(Object) - Method in class io.rhythmknights.coreapi.component.module.DynamicTitle.InteractionDynamicTitle
- update(Object) - Method in class io.rhythmknights.coreapi.component.module.DynamicTitle.PaginatedDynamicTitle
- update(Object) - Method in interface io.rhythmknights.coreapi.component.module.DynamicTitle
-
Update the dynamic title with a new state object
- updateItem(int, int, ModalItem) - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Alternative
BaseModal.updateItem(int, ModalItem)that takes ROWS and COLUMNS instead of slots. - updateItem(int, int, ItemStack) - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Alternative
BaseModal.updateItem(int, ItemStack)that takes ROWS and COLUMNS instead of slots. - updateItem(int, ModalItem) - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Alternative
BaseModal.updateItem(int, ItemStack)but creates a newModalItem. - updateItem(int, ItemStack) - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Updates the specified item in the modal at runtime, without creating a new
ModalItem. - updateOnClick(ModalItem, int, ClickType, InventoryAction) - Method in class io.rhythmknights.coreapi.component.module.DynamicTitle.InteractionDynamicTitle
-
Update on item click
- updatePageItem(int, int, ModalItem) - Method in class io.rhythmknights.coreapi.component.modal.PaginatedModal
-
Alternative
PaginatedModal.updatePageItem(int, ModalItem)that uses ROWS and COLUMNS instead - updatePageItem(int, int, ItemStack) - Method in class io.rhythmknights.coreapi.component.modal.PaginatedModal
-
Alternative
PaginatedModal.updatePageItem(int, ItemStack)that uses ROWS and COLUMNS instead - updatePageItem(int, ModalItem) - Method in class io.rhythmknights.coreapi.component.modal.PaginatedModal
-
Alternative
PaginatedModal.updatePageItem(int, ItemStack)that usesModalIteminstead - updatePageItem(int, ItemStack) - Method in class io.rhythmknights.coreapi.component.modal.PaginatedModal
-
Updates the page
ModalItemon the slot in the page Can get the slot fromInventoryClickEvent.getSlot() - updateTitle(Component) - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Updates the title of the modal.
- updateTitle(Component) - Method in class io.rhythmknights.coreapi.component.modal.PaginatedModal
-
Overrides
BaseModal.updateTitle(Component)to use the paginated populator instead Updates the title of the modal This method may cause LAG if used on a loop - updateTitleOnItemClick - Variable in class io.rhythmknights.coreapi.component.modal.builder.modal.BaseModalBuilder
- updateTitleOnItemClick(boolean) - Method in class io.rhythmknights.coreapi.component.modal.builder.modal.BaseModalBuilder
-
Enables or disables title updates when items are clicked
- updateTitleOnItemClick(ModalItem, int, InventoryClickEvent) - Method in class io.rhythmknights.coreapi.component.modal.BaseModal
-
Updates the title based on item interaction
V
- valueOf(String) - Static method in enum class io.rhythmknights.coreapi.component.module.InteractionModifier
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.rhythmknights.coreapi.component.module.ModalType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.rhythmknights.coreapi.component.module.ScrollType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.rhythmknights.coreapi.component.utility.ModalFiller.Side
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class io.rhythmknights.coreapi.component.module.InteractionModifier
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.rhythmknights.coreapi.component.module.ModalType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.rhythmknights.coreapi.component.module.ScrollType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.rhythmknights.coreapi.component.utility.ModalFiller.Side
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VALUES - Static variable in enum class io.rhythmknights.coreapi.component.module.InteractionModifier
- VersionHelper - Class in io.rhythmknights.coreapi.component.utility
-
Class for detecting server version for legacy support :(
- VersionHelper() - Constructor for class io.rhythmknights.coreapi.component.utility.VersionHelper
- VERTICAL - Enum constant in enum class io.rhythmknights.coreapi.component.module.ScrollType
- view(MapView) - Method in class io.rhythmknights.coreapi.modal.builder.item.MapBuilder
-
Sets the associated map.
W
A B C D E F G H I L M N O P R S T U V WAll Classes and Interfaces|All Packages|Serialized Form