Class DynamicPropertiesDefinitionBeta

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.

Hierarchy

  • DynamicPropertiesDefinition

Constructors

constructor

Methods

defineBoolean defineNumber defineString defineVector

Constructors

constructor

Methods

defineBoolean

  • Parameters

    • identifier: string
    • Optional defaultValue: boolean

    Returns DynamicPropertiesDefinition

    Remarks

    Defines a boolean dynamic property.

    Throws

    This function can throw errors.

defineNumber

  • Parameters

    • identifier: string
    • Optional defaultValue: number

    Returns DynamicPropertiesDefinition

    Remarks

    Defines a number dynamic property.

    Throws

    This function can throw errors.

defineString

  • Parameters

    • identifier: string
    • maxLength: number
    • Optional defaultValue: string

    Returns DynamicPropertiesDefinition

    Remarks

    Defines a string dynamic property.

    Throws

    This function can throw errors.

defineVector

  • Parameters

    • identifier: string

      Identifier of the Vector3 property.

    • Optional defaultValue: Vector3

      Optional default starting Vector for this property.

    Returns DynamicPropertiesDefinition

    Remarks

    Defines a new Vector3-based dynamic property.

    Throws

    This function can throw errors.

Settings

Member Visibility

Theme

On This Page