Custom_Crafter/io.github.sakaki_aruka.customcrafter/CustomCrafterAPI

CustomCrafterAPI

object CustomCrafterAPI

Types

Link copied to clipboard
enum NameStrictLevel : Enum<CustomCrafterAPI.NameStrictLevel>

Restriction level for recipe name duplication, applied during recipe registration.

Link copied to clipboard
enum VersionType : Enum<CustomCrafterAPI.VersionType>

Represents the release stage of the Custom Crafter API.

Properties

Link copied to clipboard
const val API_VERSION: String

Custom Crafter API version string.

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

Author names of the Custom Crafter API.

Link copied to clipboard
@JvmField
val DEFAULT_ALL_CANDIDATE_UI_DESIGNER: AllCandidateUIDesigner

Default value of AllCandidateUIDesigner

Link copied to clipboard
@JvmField
val DEFAULT_BASE_BLOCK: Material

Default value of base-block.

Link copied to clipboard
const val DEFAULT_BASE_BLOCK_SIDE: Int = 3

Default value of base-block-side

Link copied to clipboard
@JvmField
val DEFAULT_CRAFT_UI_DESIGNER: CraftUIDesigner

Default value of craft-ui-designer.

Link copied to clipboard
@JvmField
val DEFAULT_RECIPE_NAME_STRICT_LEVEL: CustomCrafterAPI.NameStrictLevel

Default value of recipe-name-strict-level.

Link copied to clipboard
const val DEFAULT_RESULT_GIVE_CANCEL: Boolean = false

Default value of result-give-cancel feature.

Link copied to clipboard
const val DEFAULT_USE_CUSTOM_CRAFT_UI: Boolean = true

Default value of use-custom-craft-ui

const val DEFAULT_USE_MULTIPLE_RESULT_CANDIDATE_FEATURE: Boolean = false

Default value of use-multiple-result-candidate feature.

Link copied to clipboard
const val MAJOR_VERSION: Int = 5

Major version number of the Custom Crafter API.

Link copied to clipboard
const val MINOR_VERSION: Int = 2

Minor version number of the Custom Crafter API.

Link copied to clipboard
const val PATCH_VERSION: Int = 1

Patch version number of the Custom Crafter API.

Link copied to clipboard
val VERSION_TYPE: CustomCrafterAPI.VersionType

Release stage of the Custom Crafter API.

Functions

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

Gets a base block type.

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

Gets the base block's side size.

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

Returns a current CraftUI designer.

Link copied to clipboard
@JvmStatic
fun getRecipeNameStrictLevel(): CustomCrafterAPI.NameStrictLevel

Returns current recipe-name-strict-level

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

Returns an immutable list of all registered recipes.

Link copied to clipboard
@JvmStatic
fun getRegisteredRecipeFromName(filter: (String) -> Boolean): List<CRecipe>

Returns registered recipes whose names satisfy the given filter predicate.

@JvmStatic
fun getRegisteredRecipeFromName(recipeName: String): List<CRecipe>

Returns registered recipes whose names exactly match the given string.

Link copied to clipboard
@JvmStatic
fun getRegisteredRecipeFromPlugin(plugin: JavaPlugin): List<CRecipe>

Returns recipes that are registered by given plugin instance.

Link copied to clipboard
@JvmStatic
fun getRegisteredRecipeNames(): Set<String>

Returns a set of all registered recipe names.

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
@JvmOverloads
fun registerRecipe(recipes: List<CRecipe>, plugin: JavaPlugin = CustomCrafter.getInstance(), calledAsync: Boolean = false)

Registers the provided recipes and fires RegisterCustomRecipeEvent.

Link copied to clipboard
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 setBaseBlockSideSize(size: Int, calledAsync: Boolean = false): Boolean

Sets base block's side size.

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 setRecipeNameStrictLevel(level: CustomCrafterAPI.NameStrictLevel, calledAsync: Boolean = false)

Sets the recipe name strict level.

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 setUseCustomCraftUI(v: Boolean, calledAsync: Boolean = false)

Sets 'Custom Craft UI open' enables or not.

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

Sets 'multiple result candidate' feature enables or not.

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

Unregisters all registered recipes.

Link copied to clipboard
@JvmStatic
@JvmOverloads
fun unregisterRecipe(name: String? = null, plugin: JavaPlugin? = CustomCrafter.getInstance(), calledAsync: Boolean = false)

Unregisters recipes that match the specified conditions.

Generated by Dokka
© 2026 Copyright