tegral-featureful/guru.zoroark.tegral.featureful/ConfigurableFeature

ConfigurableFeature

interface ConfigurableFeature<T> : Feature<T>

Represents a feature that provides configuration sections. These sections will be automatically parsed from Tegral configuration files within the [tegral] section.

Properties

configurationSections

abstract val configurationSections: List<ConfigurationSection<*>>

Returns the sections that this feature provides for the [tegral] section.

dependencies

open val dependencies: Set<Feature<*>>

Dependencies for this feature. Dependencies are features that will be installed together with (but not necessarily before) your feature.

description

abstract val description: String

A short description of what your feature provides.

abstract val id: String

The identifier for this feature. Should be a lower case kebab-case string (e.g. this-is-my-feature).

name

abstract val name: String

The name for your feature, e.g. My Feature.

Functions

createConfigObject

abstract fun createConfigObject(): T

Create an object that will be used as the receiver parameter for install(MyFeature) { HERE }

install

abstract fun ExtensibleContextBuilderDsl.install(configuration: T)

Callback when this feature is installed onto an environment.