Skip to content

Documentation / scene / PropertyValue

Type Alias: PropertyValue

PropertyValue = object

Defined in: libs/scene/src/utility/serialization/types.ts:53

Container for a serializable property's value.

Values are carried in typed arrays (even for single values) to support both scalar and array-like properties in a unified shape.

Conventions:

  • num carries numeric data for types like int, float, vec*, int*, rgb, rgba
  • str carries string data for string
  • bool carries boolean data for bool
  • object carries references/instances for object, object_array, embedded

Only the relevant field(s) for the property's PropertyType will be populated.

Properties

num?

optional num?: number[]

Defined in: libs/scene/src/utility/serialization/types.ts:55

Numeric lane(s) for numeric, vector, or color types.


str?

optional str?: string[]

Defined in: libs/scene/src/utility/serialization/types.ts:57

String lane(s) for text properties.


bool?

optional bool?: boolean[]

Defined in: libs/scene/src/utility/serialization/types.ts:59

Boolean lane(s) for boolean properties.


object?

optional object?: Nullable<object>[]

Defined in: libs/scene/src/utility/serialization/types.ts:61

Object lane(s) for object references or embedded objects.

Released under the MIT License.