Addon

abstract class Addon : Registrar, Namespaced

Constructors

Addon

constructor()

Properties

dataFolder

lateinit var dataFolder: Path

The Path of the data folder of this addon.

file

lateinit var file: Path

The Path of the file of this addon.

logger

lateinit var logger: ComponentLogger

The ComponentLogger of this addon.

plugin

var plugin: JavaPlugin?

The JavaPlugin instance of this addon, null during bootstrap phase.

pluginMeta

lateinit var pluginMeta: PluginMeta

The PluginMeta of this addon.

projectDistributors

open val projectDistributors: List<ProjectDistributor>

A list of ProjectDistributors that distribute this addon and should be checked for updates.

Functions

abilityTypeTag

fun abilityTypeTag(name: String, configure: TagBuilder.Nova<AbilityType<*>>.() -> Unit): RegistryEntrySet.Nova.Tag<AbilityType<*>>

fun abilityTypeTag(tag: RegistryEntrySet.Nova.Tag<AbilityType<*>>, configure: TagBuilder.Nova<AbilityType<*>>.() -> Unit): RegistryEntrySet.Nova.Tag<AbilityType<*>>

animatedEquipment

fun animatedEquipment(name: String, layout: AnimatedEquipmentLayoutBuilder.() -> Unit): RegistryEntry.Nova<Equipment>

attachmentTypeTag

fun attachmentTypeTag(name: String, configure: TagBuilder.Nova<AttachmentType<*>>.() -> Unit): RegistryEntrySet.Nova.Tag<AttachmentType<*>>

fun attachmentTypeTag(tag: RegistryEntrySet.Nova.Tag<AttachmentType<*>>, configure: TagBuilder.Nova<AttachmentType<*>>.() -> Unit): RegistryEntrySet.Nova.Tag<AttachmentType<*>>

biome

fun biome(name: String, biome: context(RegistryLookupContext) Biome.BiomeBuilder.() -> Unit): ResourceKey<Biome>

Registers a new Biome under name after configuring a Biome.BiomeBuilder with biome.

biomeInjection

fun biomeInjection(name: String, biomeInjection: context(RegistryLookupContext) BiomeInjectionBuilder.() -> Unit)

Registers a biome injection under name after configuring it with biomeInjection.

block

fun block(name: String, block: NovaBlockBuilder.() -> Unit): RegistryEntry.Paper<BlockType>

blockTag

fun blockTag(name: String, configure: TagBuilder.Paper<BlockType>.() -> Unit): RegistryEntrySet.Paper.Tag<BlockType>

fun blockTag(tag: RegistryEntrySet.Paper.Tag<BlockType>, configure: TagBuilder.Paper<BlockType>.() -> Unit): RegistryEntrySet.Paper.Tag<BlockType>

catVariant

fun catVariant(name: String, catVariant: CatVariantBuilder.() -> Unit): RegistryEntry.Paper<Cat.Type>

Registers a new Cat.Type under name after configuring it with catVariant.

chickenVariant

fun chickenVariant(name: String, chickenVariant: ChickenVariantBuilder.() -> Unit): RegistryEntry.Paper<Chicken.Variant>

Registers a new Chicken.Variant under name after configuring it with chickenVariant.

cowVariant

fun cowVariant(name: String, cowVariant: CowVariantBuilder.() -> Unit): RegistryEntry.Paper<Cow.Variant>

Registers a new Cow.Variant under name after configuring it with cowVariant.

dimension

fun dimension(name: String, dimension: context(RegistryLookupContext) () -> LevelStem): ResourceKey<LevelStem>

Registers a complete dimension under name using dimension to create its LevelStem.

dimensionType

fun dimensionType(name: String, dimensionType: context(RegistryLookupContext) () -> DimensionType): ResourceKey<DimensionType>

Registers a new DimensionType under name using dimensionType.

enchantment

fun enchantment(name: String, enchantment: EnchantmentBuilder.() -> Unit): RegistryEntry.Paper<Enchantment>

equipment

fun equipment(name: String, layout: StaticEquipmentLayoutBuilder.() -> Unit): RegistryEntry.Nova<Equipment>

equipmentTag

fun equipmentTag(name: String, configure: TagBuilder.Nova<Equipment>.() -> Unit): RegistryEntrySet.Nova.Tag<Equipment>

fun equipmentTag(tag: RegistryEntrySet.Nova.Tag<Equipment>, configure: TagBuilder.Nova<Equipment>.() -> Unit): RegistryEntrySet.Nova.Tag<Equipment>

frogVariant

fun frogVariant(name: String, frogVariant: FrogVariantBuilder.() -> Unit): RegistryEntry.Paper<Frog.Variant>

Registers a new Frog.Variant under name after configuring it with frogVariant.

guiTexture

fun guiTexture(name: String, guiTexture: GuiTextureBuilder.() -> Unit): RegistryEntry.Nova<GuiTexture>

guiTextureTag

fun guiTextureTag(name: String, configure: TagBuilder.Nova<GuiTexture>.() -> Unit): RegistryEntrySet.Nova.Tag<GuiTexture>

fun guiTextureTag(tag: RegistryEntrySet.Nova.Tag<GuiTexture>, configure: TagBuilder.Nova<GuiTexture>.() -> Unit): RegistryEntrySet.Nova.Tag<GuiTexture>

item

fun item(name: String, item: NovaItemBuilder.() -> Unit): RegistryEntry.Paper<ItemType>

fun item(block: RegistryEntry.Paper<BlockType>, name: String = block.key.value(), item: NovaItemBuilder.() -> Unit): RegistryEntry.Paper<ItemType>

itemFilterTypeTag

fun itemFilterTypeTag(name: String, configure: TagBuilder.Nova<ItemFilterType<*>>.() -> Unit): RegistryEntrySet.Nova.Tag<ItemFilterType<*>>

fun itemFilterTypeTag(tag: RegistryEntrySet.Nova.Tag<ItemFilterType<*>>, configure: TagBuilder.Nova<ItemFilterType<*>>.() -> Unit): RegistryEntrySet.Nova.Tag<ItemFilterType<*>>

itemTag

fun itemTag(name: String, configure: TagBuilder.Paper<ItemType>.() -> Unit): RegistryEntrySet.Paper.Tag<ItemType>

fun itemTag(tag: RegistryEntrySet.Paper.Tag<ItemType>, configure: TagBuilder.Paper<ItemType>.() -> Unit): RegistryEntrySet.Paper.Tag<ItemType>

materialCondition

fun materialCondition(name: String, materialCondition: context(RegistryLookupContext) () -> MaterialCondition): ResourceKey<MaterialCondition>

Registers a new MaterialCondition under name using materialCondition.

materialRule

fun materialRule(name: String, materialRule: context(RegistryLookupContext) () -> MaterialRule): ResourceKey<MaterialRule>

Registers a new MaterialRule under name using materialRule.

namespace

open override fun namespace(): String

networkTypeTag

fun networkTypeTag(name: String, configure: TagBuilder.Nova<NetworkType<*>>.() -> Unit): RegistryEntrySet.Nova.Tag<NetworkType<*>>

fun networkTypeTag(tag: RegistryEntrySet.Nova.Tag<NetworkType<*>>, configure: TagBuilder.Nova<NetworkType<*>>.() -> Unit): RegistryEntrySet.Nova.Tag<NetworkType<*>>

noiseSettings

fun noiseSettings(name: String, noiseSettings: context(RegistryLookupContext) () -> NoiseGeneratorSettings): ResourceKey<NoiseGeneratorSettings>

Registers new NoiseGeneratorSettings under name using noiseSettings.

pigVariant

fun pigVariant(name: String, pigVariant: PigVariantBuilder.() -> Unit): RegistryEntry.Paper<Pig.Variant>

Registers a new Pig.Variant under name after configuring it with pigVariant.

placedFeature

fun placedFeature(name: String, placedFeature: context(RegistryLookupContext) () -> PlacedFeature): ResourceKey<PlacedFeature>

Registers a new PlacedFeature under name using placedFeature.

processorList

fun processorList(name: String, processorList: context(RegistryLookupContext) () -> StructureProcessorList): ResourceKey<StructureProcessorList>

Registers a new StructureProcessorList under name using processorList.

recipeTypeTag

fun recipeTypeTag(name: String, configure: TagBuilder.Nova<RecipeType<*>>.() -> Unit): RegistryEntrySet.Nova.Tag<RecipeType<*>>

fun recipeTypeTag(tag: RegistryEntrySet.Nova.Tag<RecipeType<*>>, configure: TagBuilder.Nova<RecipeType<*>>.() -> Unit): RegistryEntrySet.Nova.Tag<RecipeType<*>>

registerAbilityType

fun <T : Ability> registerAbilityType(name: String, abilityCreator: (Player) -> T): RegistryEntry.Nova<AbilityType<T>>

registerAttachmentType

fun <T : Attachment> registerAttachmentType(name: String, constructor: (Player) -> T): RegistryEntry.Nova<AttachmentType<T>>

registerCarver

fun registerCarver(name: String, carver: WorldCarver): ResourceKey<WorldCarver>

Registers carver under name.

registerCarverType

fun registerCarverType(name: String, codec: MapCodec<out WorldCarver>): MapCodec<out WorldCarver>

Registers a new carver type under name using codec.

registerFeature

fun registerFeature(name: String, feature: Feature): ResourceKey<Feature>

Registers feature under name.

registerFeatureType

fun registerFeatureType(name: String, codec: MapCodec<out Feature>): MapCodec<out Feature>

Registers a new feature type under name using codec.

registerItem

fun registerItem(name: String, vararg behaviors: ItemBehaviorHolder, localizedName: String? = null, isHidden: Boolean = false): RegistryEntry.Paper<ItemType>

fun registerItem(block: RegistryEntry.Paper<BlockType>, vararg behaviors: ItemBehaviorHolder, localizedName: String? = null, isHidden: Boolean = false): RegistryEntry.Paper<ItemType>

fun registerItem(block: RegistryEntry.Paper<BlockType>, name: String, vararg behaviors: ItemBehaviorHolder, localizedName: String? = null, isHidden: Boolean = false): RegistryEntry.Paper<ItemType>

registerItemFilterType

fun <T : ItemFilter<T>> registerItemFilterType(name: String, serializer: ItemFilterSerializer<T>): RegistryEntry.Nova<ItemFilterType<T>>

registerNetworkType

fun <T : Network<T>> registerNetworkType(name: String, createNetwork: (NetworkData<T>) -> T, createGroup: (NetworkGroupData<T>) -> NetworkGroup<T>, validateLocal: LocalNetworkValidator, extractHolders: (NetworkEndPoint) -> List<EndPointDataHolder>?, tickDelay: Int): RegistryEntry.Nova<NetworkType<T>>

registerNoise

fun registerNoise(name: String, noise: NormalNoise): NormalNoise

Registers noise under name.

registerPlacementModifierType

fun registerPlacementModifierType(name: String, codec: MapCodec): MapCodec

Registers a new placement modifier type under name using codec.

registerRecipeType

fun <T : NovaRecipe> registerRecipeType(name: String, recipeClass: KClass<T>, group: RecipeGroup<in T>, deserializer: RecipeDeserializer<T>?): RegistryEntry.Nova<RecipeType<T>>

registerRuleTestType

fun <T : RuleTest> registerRuleTestType(name: String, ruleTestType: RuleTestType<T>): RuleTestType<T>

Registers ruleTestType under name.

registerStructurePieceType

fun registerStructurePieceType(name: String, structurePieceType: StructurePieceType): StructurePieceType

Registers structurePieceType under name.

registerStructurePlacementType

fun <SP : StructurePlacement> registerStructurePlacementType(name: String, codec: MapCodec<out SP>): MapCodec<out SP>

Registers a new structure placement type under name using codec.

registerStructurePoolElementType

fun registerStructurePoolElementType(name: String, structurePoolElementType: StructurePoolElementType): StructurePoolElementType

Registers structurePoolElementType under name.

registerStructureProcessorType

fun registerStructureProcessorType(name: String, structureProcessorType: MapCodec<out P>): MapCodec<out P>

Registers a new structure processor type under name using structureProcessorType.

registerStructureType

fun <S : Structure> registerStructureType(name: String, structureType: StructureType<S>): StructureType<S>

Registers structureType under name.

registry

fun <T : NovaRegistryElement<T>> registry(name: String, reloadable: Boolean = NovaRegistries.RELOADABLE, unknownEntryFactory: (RegistryEntry.Nova<T>) -> T? = null): MutableNovaRegistry<T>

Creates a reloadable Nova registry named name that uses unknownEntryFactory to create values for keys from previous runs or reloads.

structure

fun structure(name: String, structure: context(RegistryLookupContext) () -> Structure): ResourceKey<Structure>

Registers a new Structure under name using structure.

structureSet

fun structureSet(name: String, structureSet: context(RegistryLookupContext) () -> StructureSet): ResourceKey<StructureSet>

Registers a new StructureSet under name using structureSet.

tag

fun <T : Keyed> tag(tag: RegistryEntrySet.Paper.Tag<T>, configure: TagBuilder.Paper<T>.() -> Unit): RegistryEntrySet.Paper.Tag<T>

fun <T : Keyed> tag(name: String, registry: RegistryKey<T>, configure: TagBuilder.Paper<T>.() -> Unit): RegistryEntrySet.Paper.Tag<T>

templatePool

fun templatePool(name: String, templatePool: context(RegistryLookupContext) () -> StructureTemplatePool): ResourceKey<StructureTemplatePool>

Registers a new StructureTemplatePool under name using templatePool.

tileEntity

fun tileEntity(name: String, constructor: TileEntityConstructor, tileEntity: NovaTileEntityBlockBuilder.() -> Unit): RegistryEntry.Paper<BlockType>

tooltipStyle

fun tooltipStyle(name: String, meta: TooltipStyleLayoutBuilder.() -> Unit): RegistryEntry.Nova<TooltipStyle>

Registers a new TooltipStyle with the specified name and meta.

tooltipStyleTag

fun tooltipStyleTag(name: String, configure: TagBuilder.Nova<TooltipStyle>.() -> Unit): RegistryEntrySet.Nova.Tag<TooltipStyle>

fun tooltipStyleTag(tag: RegistryEntrySet.Nova.Tag<TooltipStyle>, configure: TagBuilder.Nova<TooltipStyle>.() -> Unit): RegistryEntrySet.Nova.Tag<TooltipStyle>

wailaInfoProvider

fun <S : BlockData> wailaInfoProvider(name: String, wailaInfoProvider: WailaInfoProviderBuilder<S>.() -> Unit): RegistryEntry.Nova<WailaInfoProvider<S>>

Registers a new WailaInfoProvider for vanilla blocks with the specified name after configuring it with wailaInfoProvider.

wailaInfoProviderTag

fun wailaInfoProviderTag(name: String, configure: TagBuilder.Nova<WailaInfoProvider<*>>.() -> Unit): RegistryEntrySet.Nova.Tag<WailaInfoProvider<*>>

fun wailaInfoProviderTag(tag: RegistryEntrySet.Nova.Tag<WailaInfoProvider<*>>, configure: TagBuilder.Nova<WailaInfoProvider<*>>.() -> Unit): RegistryEntrySet.Nova.Tag<WailaInfoProvider<*>>

wailaToolIconProvider

fun wailaToolIconProvider(name: String, wailaToolIconProvider: WailaToolIconProviderBuilder.() -> Unit): RegistryEntry.Nova<WailaToolIconProvider>

Registers a new WailaToolIconProvider with the specified name after configuring it with wailaToolIconProvider.

wailaToolIconProviderTag

fun wailaToolIconProviderTag(name: String, configure: TagBuilder.Nova<WailaToolIconProvider>.() -> Unit): RegistryEntrySet.Nova.Tag<WailaToolIconProvider>

fun wailaToolIconProviderTag(tag: RegistryEntrySet.Nova.Tag<WailaToolIconProvider>, configure: TagBuilder.Nova<WailaToolIconProvider>.() -> Unit): RegistryEntrySet.Nova.Tag<WailaToolIconProvider>

wolfSoundVariant

fun wolfSoundVariant(name: String, wolfSoundVariant: WolfSoundVariantBuilder.() -> Unit): RegistryEntry.Paper<Wolf.SoundVariant>

Registers a new Wolf.SoundVariant under name after configuring it with wolfSoundVariant.

wolfVariant

fun wolfVariant(name: String, wolfVariant: WolfVariantBuilder.() -> Unit): RegistryEntry.Paper<Wolf.Variant>

Registers a new Wolf.Variant under name after configuring it with wolfVariant.