Custom_Crafter/io.github.sakaki_aruka.customcrafter.search/PartialSearch

PartialSearch

Provides partial recipe match search functionality.

A partial match occurs when the player's current crafting grid satisfies some — but not necessarily all — of a recipe's required slots. This is useful for recipe hints, crafting guides, and autocomplete suggestions.

Both CRecipe.Type.SHAPED and CRecipe.Type.SHAPELESS recipe types are supported. Recipes that implement io.github.sakaki_aruka.customcrafter.recipe.UnPartialSearchableRecipe are excluded from all partial searches.

Since

5.0.21

Types

MatchState

enum MatchState : Enum<PartialSearch.MatchState>

Represents the degree to which a recipe's slots are satisfied by the current input.

PartialSearchResult

sealed interface PartialSearchResult

The common interface for a single partial-search result entry.

PartialShapedResult

class PartialShapedResult(val recipe: CRecipe, val relation: MappedRelation) : PartialSearch.PartialSearchResult

Partial-search result for a CRecipe.Type.SHAPED recipe.

PartialShapelessResult

class PartialShapelessResult(val recipe: CRecipe, relations: Map<CoordinateComponent, Set<CoordinateComponent>>) : PartialSearch.PartialSearchResult

Partial-search result for a CRecipe.Type.SHAPELESS recipe.

Functions

asyncPartialSearch

@JvmStatic

@JvmOverloads

fun asyncPartialSearch(crafterId: UUID, view: CraftView, searchQuery: Search.SearchQuery = Search.SearchQuery.ASYNC_DEFAULT, sourceRecipes: List<CRecipe> = CustomCrafterAPI.getRecipes()): CompletableFuture<List<PartialSearch.PartialSearchResult>>

Runs a partial recipe search asynchronously and returns a future that resolves to all PartialSearchResult entries whose recipes are at least partially satisfied by the items currently placed in the crafting grid.

PartialSearch

Since

See also

Types

Functions