klarity/net.iceyleagons.klarity/GlobalsBuilder

GlobalsBuilder

A builder class for creating a GlobalConfig object.

This class provides methods for setting various properties of a global configuration, such as the global parameters, the global prefix, and the global suffix. It also provides methods for adding global parameters using different formats, such as a map, a pair, or a custom initializer. The build method returns a new GlobalConfig object based on the current state of the builder.

Author

TOTHTOMI

Since

Jul. 25, 2023

Constructors

GlobalsBuilder

constructor()

Creates a new GlobalsBuilder with empty values for all properties.

Functions

build

fun build(): GlobalConfig

Builds and returns a new GlobalConfig object based on the current state of the builder.

globalParameter

fun globalParameter(key: String, value: String)

Adds a single global parameters to the builder. Global parameters will be provided to every translation's script parser at runtime.

globalParameters

fun globalParameters(initializer: GlobalParameter.() -> Unit)

Adds multiple global parameters to the builder using a custom initializer, so you can use it via DSL. Global parameters will be provided to every translation's script parser at runtime.

fun globalParameters(map: Map<String, String>)

Adds multiple global parameters to the builder. Global parameters will be provided to every translation's script parser at runtime.

prefix

fun prefix(prefix: String)

Sets the global prefix. A global prefix will be applied to the start of every translation at runtime

suffix

fun suffix(suffix: String)

Sets the global suffix. A global suffix will be applied to the end of every translation at runtime