Class DynamicPropertiesDefinition`Beta`

Class used in conjunction with PropertyRegistry to define dynamic properties that can be used on entities of a specified type or at the global World- level.

Index

Constructors

Methods

defineBoolean defineNumber defineString defineVector

Constructors

constructor

new DynamicPropertiesDefinition(): DynamicPropertiesDefinition
Beta
Returns DynamicPropertiesDefinition

Methods

defineBoolean

defineBoolean(
identifier: string,
defaultValue?: boolean,
): DynamicPropertiesDefinition
Beta
Parameters
- identifier: string
- OptionaldefaultValue: boolean
Returns DynamicPropertiesDefinition
Remarks
Defines a boolean dynamic property.

Throws
This function can throw errors.

defineNumber

defineNumber(
identifier: string,
defaultValue?: number,
): DynamicPropertiesDefinition
Beta
Parameters
- identifier: string
- OptionaldefaultValue: number
Returns DynamicPropertiesDefinition
Remarks
Defines a number dynamic property.

Throws
This function can throw errors.

defineString

defineString(
    identifier: string,
    maxLength: number,
    defaultValue?: string,
): DynamicPropertiesDefinition
Beta
Parameters
- identifier: string
- maxLength: number
- OptionaldefaultValue: string
Returns DynamicPropertiesDefinition
Remarks
Defines a string dynamic property.

Throws
This function can throw errors.

defineVector

defineVector(
identifier: string,
defaultValue?: Vector3,
): DynamicPropertiesDefinition
Beta
Parameters
- identifier: string
  Identifier of the Vector3 property.
- OptionaldefaultValue: Vector3
  Optional default starting Vector for this property.
Returns DynamicPropertiesDefinition
Remarks
Defines a new Vector3-based dynamic property.

Throws
This function can throw errors.