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.

Hierarchy

DynamicPropertiesDefinition

Index

Constructors

Methods

defineBoolean defineNumber defineString

Constructors

constructor

new DynamicPropertiesDefinition(): DynamicPropertiesDefinition
Returns DynamicPropertiesDefinition

Methods

defineBoolean

defineBoolean(identifier): void
Parameters
- identifier: string
Returns void

Remarks
Defines a boolean dynamic property.

This function can't be called in read-only mode.

Throws
This function can throw errors.
- Defined in index.d.ts:2418

defineNumber

defineNumber(identifier): void
Parameters
- identifier: string
Returns void

Remarks
Defines a number dynamic property.

This function can't be called in read-only mode.

Throws
This function can throw errors.
- Defined in index.d.ts:2427

defineString

defineString(identifier, maxLength): void
Parameters
- identifier: string
- maxLength: number
Returns void

Remarks
Defines a string dynamic property.

This function can't be called in read-only mode.

Throws
This function can throw errors.
- Defined in index.d.ts:2436