1.21.3-fabric/de.rubixdev.yarrp.api/RuntimeResourcePack

RuntimeResourcePack

class RuntimeResourcePack @JvmOverloads constructor(info: PackLocationInfo, val metadata: PackMetadataSection, val features: FeatureFlagsMetadataSection? = null, val filter: ResourceFilterSection? = null, val overlays: OverlayMetadataSection? = null, extraFiles: Map<List<String>, IoSupplier<InputStream>> = mapOf()) : PackResources

A resource pack that is generated at runtime.

Parameters

info

basic information about this resource pack. May be created using createInfo

metadata

the main metadata for this resource pack. May be created using createMetadata

features

optional metadata for required feature flags

filter

optional metadata for filters

overlays

optional metadata for pack overlays

extraFiles

additional raw files to include in this resource pack

Constructors

RuntimeResourcePack

@JvmOverloads

constructor(info: PackLocationInfo, metadata: PackMetadataSection, features: FeatureFlagsMetadataSection? = null, filter: ResourceFilterSection? = null, overlays: OverlayMetadataSection? = null, extraFiles: Map<List<String>, IoSupplier<InputStream>> = mapOf())

Types

Companion

object Companion

Properties

features

val features: FeatureFlagsMetadataSection? = null

filter

val filter: ResourceFilterSection? = null

metadata

val metadata: PackMetadataSection

overlays

val overlays: OverlayMetadataSection? = null

recipeExporter

val recipeExporter: RecipeOutput

A RecipeOutput which adds recipes and advancements to this pack.

recipeExporterOnlyAdvancement

val recipeExporterOnlyAdvancement: RecipeOutput

A RecipeOutput which ignores recipes and only adds advancements to this pack.

recipeExporterOnlyRecipe

val recipeExporterOnlyRecipe: RecipeOutput

A RecipeOutput which ignores advancements and only adds recipes to this pack.

Functions

addAdvancement

fun addAdvancement(entry: AdvancementHolder): ResourceKey<Advancement>

Add an advancement from an AdvancementHolder.

fun addAdvancement(id: ResourceLocation, advancement: Advancement): ResourceKey<Advancement>

Add an advancement.

fun addAdvancement(id: ResourceLocation, advancementBuilder: Advancement.Builder): ResourceKey<Advancement>

Add an advancement from an Advancement.Builder.

fun addAdvancement(recipeId: ResourceLocation, builder: RecipeBuilder)

fun addAdvancement(recipeId: ResourceLocation, builder: SmithingTransformRecipeBuilder)

fun addAdvancement(recipeId: ResourceLocation, builder: SmithingTrimRecipeBuilder)

fun addAdvancement(recipeId: ResourceLocation, builder: SpecialRecipeBuilder)

Add only the advancement from a recipe builder.

addBlockTag

inline fun addBlockTag(tagKey: TagKey<Block>, tagBuilder: IntrinsicHolderTagBuilder<Block>.() -> Unit): TagKey<Block>

Add a Block tag definition using an IntrinsicHolderTagBuilder callback.

addEnchantment

fun addEnchantment(id: ResourceLocation, enchantment: Enchantment): ResourceKey<Enchantment>

Add an enchantment.

fun addEnchantment(id: ResourceLocation, enchantment: Enchantment.Builder): ResourceKey<Enchantment>

Add an enchantment given an Enchantment.Builder.

fun addEnchantment(id: ResourceLocation, enchantment: Enchantment.EnchantmentDefinition): ResourceKey<Enchantment>

Add an enchantment given its Enchantment.EnchantmentDefinition.

addEntityTypeTag

inline fun addEntityTypeTag(tagKey: TagKey<EntityType<*>>, tagBuilder: IntrinsicHolderTagBuilder<EntityType<*>>.() -> Unit): TagKey<EntityType<*>>

Add an EntityType tag definition using an IntrinsicHolderTagBuilder callback.

addFluidTag

inline fun addFluidTag(tagKey: TagKey<Fluid>, tagBuilder: IntrinsicHolderTagBuilder<Fluid>.() -> Unit): TagKey<Fluid>

Add a Fluid tag definition using an IntrinsicHolderTagBuilder callback.

addItemTag

inline fun addItemTag(tagKey: TagKey<Item>, tagBuilder: IntrinsicHolderTagBuilder<Item>.() -> Unit): TagKey<Item>

Add a Item tag definition using an IntrinsicHolderTagBuilder callback.

addRecipe

fun addRecipe(recipeId: ResourceLocation, builder: RecipeBuilder): ResourceKey<Recipe<*>>

fun addRecipe(recipeId: ResourceLocation, builder: SmithingTransformRecipeBuilder): ResourceKey<Recipe<*>>

fun addRecipe(recipeId: ResourceLocation, builder: SmithingTrimRecipeBuilder): ResourceKey<Recipe<*>>

fun addRecipe(recipeId: ResourceLocation, builder: SpecialRecipeBuilder): ResourceKey<Recipe<*>>

Add only the recipe from a recipe builder.

fun addRecipe(id: ResourceLocation, recipe: Recipe<*>): ResourceKey<Recipe<*>>

Add a recipe.

addRecipeAndAdvancement

fun addRecipeAndAdvancement(recipeId: ResourceLocation, builder: RecipeBuilder)

fun addRecipeAndAdvancement(recipeId: ResourceLocation, builder: SmithingTransformRecipeBuilder)

fun addRecipeAndAdvancement(recipeId: ResourceLocation, builder: SmithingTrimRecipeBuilder)

fun addRecipeAndAdvancement(recipeId: ResourceLocation, builder: SpecialRecipeBuilder)

Add both a recipe and an advancement using the given recipe builder.

addResource

fun addResource(type: PackType, path: List<String>, resource: String)

fun addResource(type: PackType, path: List<String>, resource: Resource)

Add a generic resource with the given content.

fun <T> addResource(type: PackType, path: List<String>, codec: Codec<T>, id: ResourceLocation, value: T)

Add a generic serializable resource at a path.

fun <T> addResource(type: PackType, registry: ResourceKey<out Registry<T>>, codec: Codec<T>, id: ResourceLocation, value: T): ResourceKey<T>

Add a generic serializable resource in a registry.

addTag

fun <T> addTag(tagKey: TagKey<T>, tagBuilder: TagBuilder<T>): TagKey<T>

Add a tag definition using a TagBuilder.

inline fun <T> addTag(tagKey: TagKey<T>, tagBuilder: TagBuilder<T>.() -> Unit): TagKey<T>

Add a tag definition using a TagBuilder callback.

fun <T> addTag(tagKey: TagKey<T>, tagFile: TagFile): TagKey<T>

Add a tag definition given its TagFile description.

inline fun <T, B : TagBuilder<T>> addTag(tagKey: TagKey<T>, builder: B, tagBuilder: B.() -> Unit): TagKey<T>

Add a tag definition using a generic TagBuilder callback.

@JvmOverloads

fun <T> addTag(tagKey: TagKey<T>, tagEntries: List<TagEntry>, replace: Boolean = false): TagKey<T>

Add a tag definition given its entries and replace value.

advancementBuilderForRecipe

fun advancementBuilderForRecipe(recipe: ResourceKey<Recipe<*>>): Advancement.Builder

fun advancementBuilderForRecipe(recipeId: ResourceLocation): Advancement.Builder

Create an advancement builder for unlocking the given recipe.

open override fun close()

getMetadataSection

open override fun <T> getMetadataSection(metaReader: MetadataSectionSerializer<T>): T?

getNamespaces

open override fun getNamespaces(type: PackType): Set<String>

getResource

open override fun getResource(type: PackType, id: ResourceLocation): IoSupplier<InputStream>?

getRootResource

open override fun getRootResource(vararg segments: String): IoSupplier<InputStream>?

knownPackInfo

open fun knownPackInfo(): Optional<KnownPack>

listResources

open override fun listResources(type: PackType, namespace: String, prefix: String, consumer: PackResources.ResourceOutput)

location

open override fun location(): PackLocationInfo

packId

open fun packId(): String