DispenseTrait.Preset

class DispenseTrait.Preset : ClusterStruct

The supported dispensible item presets.

Summary

Nested types

Descriptor enum for this struct's fields.

Public constructors
Preset(
    presetName: String,
    presetNameSynonyms: List<DispenseTrait.PresetNameSynonym>
)

Creates the Preset class.

Public functions
open StructDescriptor

Returns the descriptor for the struct.
open Any?

Returns the value of the field for the given tag ID.

Public properties
String

Internal name for the preset.
List<DispenseTrait.PresetNameSynonym>

Synonym names for the preset in each supported language.

Public constructors

Preset

Preset(
    presetName: String = "",
    presetNameSynonyms: List<DispenseTrait.PresetNameSynonym> = emptyList()
)

Creates the Preset class.

Public functions

getDescriptor

@HomeExperimentalApi
open fun getDescriptor(): StructDescriptor

Returns the descriptor for the struct.

getFieldValueById

@HomeExperimentalApi
open fun getFieldValueById(tagId: UInt): Any?

Returns the value of the field for the given tag ID.

Public properties

presetName

val presetName: String

Internal name for the preset. This can be non-user-friendly, and is shared across all languages.

presetNameSynonyms

val presetNameSynonyms: List<DispenseTrait.PresetNameSynonym>

Synonym names for the preset in each supported language.