Custom_Crafter/io.github.sakaki_aruka.customcrafter/CustomCrafterAPI

CustomCrafterAPI

object CustomCrafterAPI

Properties

Link copied to clipboard
const val API_VERSION: String

Custom Crafter API version.

Link copied to clipboard
@JvmField
val AUTHORS: Set<String>

Custom Crafter API author names

Link copied to clipboard
const val IS_BETA: Boolean = true

Custom Crafter API is beta or not.

Link copied to clipboard
const val IS_STABLE: Boolean = false

Custom Crafter API is stable or not.

Functions

Link copied to clipboard
@JvmStatic
fun defaultAllCandidateNotDisplayableItems(): ItemStack

Get an item that is used for an all-candidates-menu's not displayable items slot in default.

Link copied to clipboard
@JvmStatic
fun getAllCandidateNotDisplayableItem(): ItemStack

Get an item that is used for an all-candidates-menu's not displayable items slot.

Link copied to clipboard
@JvmStatic
fun getBaseBlock(): Material

Gets a base block type.

Link copied to clipboard
@JvmStatic
fun getBaseBlockSideSize(): Int

get base block's side size.

Link copied to clipboard
@JvmStatic
fun getCraftUIDesigner(): CraftUIDesigner

Returns a current CraftUI designer.

Link copied to clipboard
@JvmStatic
fun getRecipes(): List<CRecipe>

returns an IMMUTABLE list what contains all registered recipes.

Link copied to clipboard
@JvmStatic
fun getResultGiveCancel(): Boolean

Returns a boolean value that means the Custom Crafter API give result items to players or not.

Link copied to clipboard
@JvmStatic
fun getUseCustomCraftUI(): Boolean

Returns a boolean value that means 'Custom Craft UI open' enabled or not.

Link copied to clipboard
@JvmStatic
fun getUseMultipleResultCandidateFeature(): Boolean

Returns a boolean value that means 'multiple result candidate' feature enabled or not.

Link copied to clipboard
@JvmStatic
fun hasFullCompatibility(version: String): Boolean

Checks full-compatibility

Link copied to clipboard
@JvmStatic
fun registerRecipe(vararg recipes: CRecipe): Boolean

registers a provided recipe and calls RegisterCustomRecipeEvent.

Link copied to clipboard
@JvmStatic
fun setAllCandidateNotDisplayableItem(item: ItemStack, loreSupplier: (String) -> List<Component>?)

Set an item that is used for an all-candidates-menu's not displayable items slot. If the specified items material is not Material#isItem, this throws Errors.

Link copied to clipboard
@JvmStatic
@JvmOverloads
fun setBaseBlock(type: Material, calledAsync: Boolean = false)

Sets base block with given material.

Link copied to clipboard
@JvmStatic
@JvmOverloads
fun setBaseBlockDefault(calledAsync: Boolean = false)

Sets BaseBlock to Material.GOLD_BLOCK (default value).

Link copied to clipboard
@JvmStatic
@JvmOverloads
fun setBaseBlockSideSize(size: Int, calledAsync: Boolean = false): Boolean

set base block's side size.

Link copied to clipboard
@JvmStatic
@JvmOverloads
fun setBaseBlockSideSizeDefault(calledAsync: Boolean = false)

Sets base block's side size to 3 (default value).

Link copied to clipboard
@JvmStatic
@JvmOverloads
fun setCraftUIDesigner(designer: CraftUIDesigner, calledAsync: Boolean = false)

Sets a new CraftUI designer if a specified is valid.

Link copied to clipboard
@JvmStatic
@JvmOverloads
fun setCraftUIDesignerDefault(calledAsync: Boolean = false)

Sets the default CraftUI designer.

Link copied to clipboard
@JvmStatic
@JvmOverloads
fun setResultGiveCancel(v: Boolean, calledAsync: Boolean = false)

Sets a boolean value that means the Custom Crafter API give result items to players or not.

Link copied to clipboard
@JvmStatic
@JvmOverloads
fun setResultGiveCancelDefault(calledAsync: Boolean = false)

Sets ResultGiveCancel to false (default value).

Link copied to clipboard
@JvmStatic
@JvmOverloads
fun setUseCustomCraftUI(v: Boolean, calledAsync: Boolean = false)

Sets 'Custom Craft UI open' enables or not.

Link copied to clipboard
@JvmStatic
@JvmOverloads
fun setUseCustomCraftUIDefault(calledAsync: Boolean = false)

Sets 'Custom Craft UI open' enable.

Link copied to clipboard
@JvmStatic
@JvmOverloads
fun setUseMultipleResultCandidateFeature(v: Boolean, calledAsync: Boolean = false)

Sets 'multiple result candidate' feature enables or not.

@JvmStatic
@JvmOverloads
fun setUseMultipleResultCandidateFeatureDefault(calledAsync: Boolean = false)

Sets useMultipleResultCandidateFeature to false (default value).

Link copied to clipboard
@JvmStatic
fun unregisterAllRecipes(): Boolean

Unregisters all registered recipes.

Link copied to clipboard
@JvmStatic
fun unregisterRecipe(vararg recipes: CRecipe): Boolean

unregisters a provided recipe and calls UnregisterCustomRecipeEvent.

Generated by Dokka
© 2026 Copyright