Skip to content

ludus::runtime::game_api::PropertyDescriptor

Ludus Wiki · API overview · Browse API

Struct

One property descriptor.
Values/bounds are typed; the host validates against kind and range at receipt and again at the safe boundary (design 10).

Declared in modules/runtime/game_api/include/ludus/runtime/game_api/properties.h

#include <ludus/runtime/game_api/properties.h>

struct ludus::runtime::game_api::PropertyDescriptor final

Fields

ObjectId

uint64 ludus::runtime::game_api::PropertyDescriptor::ObjectId = 0
Stable object identity, preserved across reload.

Related types: uint64

Declared in modules/runtime/game_api/include/ludus/runtime/game_api/properties.h

PropertyId

uint64 ludus::runtime::game_api::PropertyDescriptor::PropertyId = 0
Stable property identity within the object.

Related types: uint64

Declared in modules/runtime/game_api/include/ludus/runtime/game_api/properties.h

Kind

uint32 ludus::runtime::game_api::PropertyDescriptor::Kind = 0

Related types: uint32

Declared in modules/runtime/game_api/include/ludus/runtime/game_api/properties.h

Scope

uint32 ludus::runtime::game_api::PropertyDescriptor::Scope = 0

Related types: uint32

Declared in modules/runtime/game_api/include/ludus/runtime/game_api/properties.h

Writable

uint8 ludus::runtime::game_api::PropertyDescriptor::Writable = 0
1 if the module accepts edits to this property.

Related types: uint8

Declared in modules/runtime/game_api/include/ludus/runtime/game_api/properties.h

LabelLength

uint8 ludus::runtime::game_api::PropertyDescriptor::LabelLength = 0
Bytes of Label used (<= kMaxLabelBytes).

Related types: uint8

Declared in modules/runtime/game_api/include/ludus/runtime/game_api/properties.h

Reserved0

uint8 ludus::runtime::game_api::PropertyDescriptor::Reserved0 = 0

Related types: uint8

Declared in modules/runtime/game_api/include/ludus/runtime/game_api/properties.h

Reserved1

uint8 ludus::runtime::game_api::PropertyDescriptor::Reserved1 = 0

Related types: uint8

Declared in modules/runtime/game_api/include/ludus/runtime/game_api/properties.h

MinInt

int32 ludus::runtime::game_api::PropertyDescriptor::MinInt = 0
Inclusive bounds for numeric kinds; enum uses [0, MaxInt] over variants.

Related types: int32

Declared in modules/runtime/game_api/include/ludus/runtime/game_api/properties.h

MaxInt

int32 ludus::runtime::game_api::PropertyDescriptor::MaxInt = 0

Related types: int32

Declared in modules/runtime/game_api/include/ludus/runtime/game_api/properties.h

MinFloat

float32 ludus::runtime::game_api::PropertyDescriptor::MinFloat = 0

Related types: float32

Declared in modules/runtime/game_api/include/ludus/runtime/game_api/properties.h

MaxFloat

float32 ludus::runtime::game_api::PropertyDescriptor::MaxFloat = 0

Related types: float32

Declared in modules/runtime/game_api/include/ludus/runtime/game_api/properties.h

Label

char ludus::runtime::game_api::PropertyDescriptor::Label[kMaxLabelBytes][kMaxLabelBytes] = {}

Declared in modules/runtime/game_api/include/ludus/runtime/game_api/properties.h