Documentation / scene / PropertyAccessorOptions

Type Alias: PropertyAccessorOptions

PropertyAccessorOptions = object

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

Additional options controlling how a property is displayed, constrained, and edited.

These options are consumed primarily by an editor/inspector UI, but may also influence validation and tooling behavior.

Properties

label?

optional label?: string

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

Human-friendly label for UI. Defaults to name if omitted.

---

group?

optional group?: string

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

Logical grouping/category in UI.

---

edit?

optional edit?: PropEdit

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

Editor presentation hint (e.g., quaternion gizmo, animation track).

---

minValue?

optional minValue?: number

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

Minimum numeric value (for sliders/spinners).

---

maxValue?

optional maxValue?: number

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

Maximum numeric value (for sliders/spinners).

---

multiline?

optional multiline?: boolean

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

Whether string property is multiline.

---

speed?

optional speed?: number

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

Step/speed for numeric editing UI.

---

animatable?

optional animatable?: boolean

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

Whether the property can be animated/keyframed.

---

mimeTypes?

optional mimeTypes?: string[]

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

Allowed MIME types for file-picker-like editors.

---

sceneNode?

optional sceneNode?: PropertySceneNodeOptions

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

Accept scene hierarchy node drag-drop in the inspector.

---

inlineObjectArray?

optional inlineObjectArray?: boolean

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

Render object-array entries inline instead of expandable nested groups.

---

objectTypes?

optional objectTypes?: GenericConstructor[]

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

Allowed constructor types when choosing/creating object references.

---

enum?

optional enum?: object

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

Optional enumeration metadata. labels[i] corresponds to values[i].

labels

labels: string[]

values

values: unknown[]