settings-core/io.github.mlmgames.settings.core.fields

Package-level declarations

Types

abstract class BaseMapField<T, K, V>(val name: String, val keyName: String, val meta: SettingMeta?, getter: (T) -> Map<K, V>, setter: (T, Map<K, V>) -> T, serializer: KSerializer<Map<K, V>>, json: Json = SerializedField.DefaultJson) : SettingField<T, Map<K, V>>

Base class for map fields that stores maps as JSON strings.

BooleanField

class BooleanField<T>(val name: String, val keyName: String, val meta: SettingMeta?, getter: (T) -> Boolean, setter: (T, Boolean) -> T) : SettingField<T, Boolean>

DoubleField

class DoubleField<T>(val name: String, val keyName: String, val meta: SettingMeta?, getter: (T) -> Double, setter: (T, Double) -> T) : SettingField<T, Double>

EnumField

class EnumField<T, E : Enum<E>>(val name: String, val keyName: String, val meta: SettingMeta?, getter: (T) -> E, setter: (T, E) -> T, enumValues: Array<E>, defaultValue: E) : SettingField<T, E>

EnumOrdinalField

class EnumOrdinalField<T, E : Enum<E>>(val name: String, val keyName: String, val meta: SettingMeta?, getter: (T) -> E, setter: (T, E) -> T, enumValues: Array<E>, defaultValue: E) : SettingField<T, E>

FloatField

class FloatField<T>(val name: String, val keyName: String, val meta: SettingMeta?, getter: (T) -> Float, setter: (T, Float) -> T) : SettingField<T, Float>

IntField

class IntField<T>(val name: String, val keyName: String, val meta: SettingMeta?, getter: (T) -> Int, setter: (T, Int) -> T) : SettingField<T, Int>

IntIntMapField

class IntIntMapField<T>(name: String, keyName: String, meta: SettingMeta?, getter: (T) -> Map<Int, Int>, setter: (T, Map<Int, Int>) -> T, json: Json = SerializedField.DefaultJson) : BaseMapField<T, Int, Int>

IntListField

class IntListField<T>(val name: String, val keyName: String, val meta: SettingMeta?, getter: (T) -> List<Int>, setter: (T, List<Int>) -> T, json: Json = SerializedField.DefaultJson) : SettingField<T, List<Int>>

IntLongMapField

class IntLongMapField<T>(name: String, keyName: String, meta: SettingMeta?, getter: (T) -> Map<Int, Long>, setter: (T, Map<Int, Long>) -> T, json: Json = SerializedField.DefaultJson) : BaseMapField<T, Int, Long>

IntStringMapField

class IntStringMapField<T>(name: String, keyName: String, meta: SettingMeta?, getter: (T) -> Map<Int, String>, setter: (T, Map<Int, String>) -> T, json: Json = SerializedField.DefaultJson) : BaseMapField<T, Int, String>

LongField

class LongField<T>(val name: String, val keyName: String, val meta: SettingMeta?, getter: (T) -> Long, setter: (T, Long) -> T) : SettingField<T, Long>

LongIntMapField

class LongIntMapField<T>(name: String, keyName: String, meta: SettingMeta?, getter: (T) -> Map<Long, Int>, setter: (T, Map<Long, Int>) -> T, json: Json = SerializedField.DefaultJson) : BaseMapField<T, Long, Int>

LongListField

class LongListField<T>(val name: String, val keyName: String, val meta: SettingMeta?, getter: (T) -> List<Long>, setter: (T, List<Long>) -> T, json: Json = SerializedField.DefaultJson) : SettingField<T, List<Long>>

LongLongMapField

class LongLongMapField<T>(name: String, keyName: String, meta: SettingMeta?, getter: (T) -> Map<Long, Long>, setter: (T, Map<Long, Long>) -> T, json: Json = SerializedField.DefaultJson) : BaseMapField<T, Long, Long>

LongStringMapField

class LongStringMapField<T>(name: String, keyName: String, meta: SettingMeta?, getter: (T) -> Map<Long, String>, setter: (T, Map<Long, String>) -> T, json: Json = SerializedField.DefaultJson) : BaseMapField<T, Long, String>

NullableBooleanField

class NullableBooleanField<T>(val name: String, val keyName: String, val meta: SettingMeta?, getter: (T) -> Boolean?, setter: (T, Boolean?) -> T) : SettingField<T, Boolean?>

NullableDoubleField

class NullableDoubleField<T>(val name: String, val keyName: String, val meta: SettingMeta?, getter: (T) -> Double?, setter: (T, Double?) -> T) : SettingField<T, Double?>

NullableEnumField

class NullableEnumField<T, E : Enum<E>>(val name: String, val keyName: String, val meta: SettingMeta?, getter: (T) -> E?, setter: (T, E?) -> T, enumValues: Array<E>) : SettingField<T, E?>

NullableFloatField

class NullableFloatField<T>(val name: String, val keyName: String, val meta: SettingMeta?, getter: (T) -> Float?, setter: (T, Float?) -> T) : SettingField<T, Float?>

NullableIntField

class NullableIntField<T>(val name: String, val keyName: String, val meta: SettingMeta?, getter: (T) -> Int?, setter: (T, Int?) -> T) : SettingField<T, Int?>

NullableLongField

class NullableLongField<T>(val name: String, val keyName: String, val meta: SettingMeta?, getter: (T) -> Long?, setter: (T, Long?) -> T) : SettingField<T, Long?>

NullableSerializedField

class NullableSerializedField<T, V : Any>(val name: String, val keyName: String, val meta: SettingMeta?, getter: (T) -> V?, setter: (T, V?) -> T, serializer: KSerializer<V>, json: Json = SerializedField.DefaultJson) : SettingField<T, V?>

NullableStringField

class NullableStringField<T>(val name: String, val keyName: String, val meta: SettingMeta?, getter: (T) -> String?, setter: (T, String?) -> T) : SettingField<T, String?>

SerializedField

class SerializedField<T, V>(val name: String, val keyName: String, val meta: SettingMeta?, getter: (T) -> V, setter: (T, V) -> T, serializer: KSerializer<V>, defaultValue: V, json: Json = DefaultJson) : SettingField<T, V>

StringBooleanMapField

class StringBooleanMapField<T>(name: String, keyName: String, meta: SettingMeta?, getter: (T) -> Map<String, Boolean>, setter: (T, Map<String, Boolean>) -> T, json: Json = SerializedField.DefaultJson) : BaseMapField<T, String, Boolean>

StringDoubleMapField

class StringDoubleMapField<T>(name: String, keyName: String, meta: SettingMeta?, getter: (T) -> Map<String, Double>, setter: (T, Map<String, Double>) -> T, json: Json = SerializedField.DefaultJson) : BaseMapField<T, String, Double>

StringField

class StringField<T>(val name: String, val keyName: String, val meta: SettingMeta?, getter: (T) -> String, setter: (T, String) -> T) : SettingField<T, String>

StringFloatMapField

class StringFloatMapField<T>(name: String, keyName: String, meta: SettingMeta?, getter: (T) -> Map<String, Float>, setter: (T, Map<String, Float>) -> T, json: Json = SerializedField.DefaultJson) : BaseMapField<T, String, Float>

StringIntMapField

class StringIntMapField<T>(name: String, keyName: String, meta: SettingMeta?, getter: (T) -> Map<String, Int>, setter: (T, Map<String, Int>) -> T, json: Json = SerializedField.DefaultJson) : BaseMapField<T, String, Int>

StringListField

class StringListField<T>(val name: String, val keyName: String, val meta: SettingMeta?, getter: (T) -> List<String>, setter: (T, List<String>) -> T, json: Json = SerializedField.DefaultJson) : SettingField<T, List<String>>

StringLongMapField

class StringLongMapField<T>(name: String, keyName: String, meta: SettingMeta?, getter: (T) -> Map<String, Long>, setter: (T, Map<String, Long>) -> T, json: Json = SerializedField.DefaultJson) : BaseMapField<T, String, Long>

StringMapField

class StringMapField<T>(name: String, keyName: String, meta: SettingMeta?, getter: (T) -> Map<String, String>, setter: (T, Map<String, String>) -> T, json: Json = SerializedField.DefaultJson) : BaseMapField<T, String, String>

StringSetField

class StringSetField<T>(val name: String, val keyName: String, val meta: SettingMeta?, getter: (T) -> Set<String>, setter: (T, Set<String>) -> T) : SettingField<T, Set<String>>

UnitField

class UnitField<T>(val name: String, val keyName: String, val meta: SettingMeta?, getter: (T) -> Unit, setter: (T, Unit) -> T) : SettingField<T, Unit>

No-op field used for Button settings backed by Unit.