3.0.0-beta.3

BotCommands-core/io.github.freya022.botcommands.api.localization

Package-level declarations

Types

DefaultLocalizationMap

class DefaultLocalizationMap(val effectiveLocale: Locale, localizationMap: Map<String, LocalizationTemplate?>) : LocalizationMap

DefaultLocalizationTemplate

class DefaultLocalizationTemplate(context: BContext, template: String, locale: Locale) : LocalizationTemplate

Default implementation for LocalizationTemplate.

DefaultMessages

class ~~DefaultMessages~~

Helper class to translate framework-specific messages.

DefaultMessagesFactory

@InterfacedService(acceptMultiple = false)

interface ~~DefaultMessagesFactory~~

Factory for DefaultMessages instances, using locales from various sources.

DefaultPermissionLocalization

open class DefaultPermissionLocalization(localizationService: LocalizationService, bundleName: String = "Permissions") : PermissionLocalization

Default implementation for PermissionLocalization.

LocalizableAction

interface LocalizableAction

Allows you to configure the localization settings of this interaction/command, as well as retrieve a localization context from it.

interface Localization : LocalizationMap

Low-level interface for localization.

LocalizationMap

interface LocalizationMap

Common interface to retrieve localization templates from a path.

LocalizationMapRequest

class LocalizationMapRequest : Record

LocalizationService

@InterfacedService(acceptMultiple = false)

interface LocalizationService

Service to retrieve Localization instances with the requested name and locale.

LocalizationTemplate

interface LocalizationTemplate

Represents an entire localizable string, with parameters.

PermissionLocalization

@InterfacedService(acceptMultiple = false)

interface PermissionLocalization

Utility service to translate Permission names, a DefaultPermissionLocalization instance is available by default, but can be overridden if necessary, using a service factory.

Functions

createDelegated

fun createDelegated(current: LocalizationMap?, parent: LocalizationMap): LocalizationMap

getLocalizedMessage

fun LocalizableAction.getLocalizedMessage(locale: Locale, localizationPath: String, vararg entries: PairEntry): String

fun LocalizableAction.getLocalizedMessage(locale: DiscordLocale, localizationPath: String, vararg entries: PairEntry): String

fun LocalizationTemplate.localize(vararg args: Pair<String, Any>): String

Processes the localization template and replaces the named parameters by their values

infix fun String.to(value: Any): Localization.Entry

Create a new localization entry, this binds a key (from a templated string) to the value