ServiceAreaTrait.MapStruct

class ServiceAreaTrait.MapStruct : ClusterStruct

A struct representing a map.

Summary

Nested types

Descriptor enum for this struct's fields.

Public constructors
MapStruct(mapId: UInt, name: String)

Creates the MapStruct 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
UInt

The map's identifier.
String

A user-understandable map description, such as Main Floor.

Public constructors

MapStruct

MapStruct(mapId: UInt, name: String = "")

Creates the MapStruct class.

Public functions

getDescriptor

@HomeExperimentalGenericApi
open fun getDescriptor(): StructDescriptor

Returns the descriptor for the struct.

getFieldValueById

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

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

Public properties

mapId

val mapId: UInt

The map's identifier.

name

val name: String

A user-understandable map description, such as Main Floor.