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 defineVector

Constructors

constructor

new DynamicPropertiesDefinition(): DynamicPropertiesDefinition
Returns DynamicPropertiesDefinition

Methods

defineBoolean

defineBoolean(identifier, defaultValue?): DynamicPropertiesDefinition
Parameters
- identifier: string
- Optional defaultValue: boolean
Returns DynamicPropertiesDefinition

Remarks
Defines a boolean dynamic property.

Throws
This function can throw errors.
- Defined in tmp/package/index.d.ts:3387

defineNumber

defineNumber(identifier, defaultValue?): DynamicPropertiesDefinition
Parameters
- identifier: string
- Optional defaultValue: number
Returns DynamicPropertiesDefinition

Remarks
Defines a number dynamic property.

Throws
This function can throw errors.
- Defined in tmp/package/index.d.ts:3394

defineString

defineString(identifier, maxLength, defaultValue?): DynamicPropertiesDefinition
Parameters
- identifier: string
- maxLength: number
- Optional defaultValue: string
Returns DynamicPropertiesDefinition

Remarks
Defines a string dynamic property.

Throws
This function can throw errors.
- Defined in tmp/package/index.d.ts:3401

defineVector

defineVector(identifier, defaultValue?): DynamicPropertiesDefinition
Parameters
- identifier: string
- Optional defaultValue: Vector3
Returns DynamicPropertiesDefinition
- Defined in tmp/package/index.d.ts:3402