What is Incisor?
Tutorials
Key Concepts
Reddit
Stack Overflow
Configuration Settings
Deprecation Schedule

RegisteredProperty()

Object housing information about the CustomAddOns currently registered in this project. [NON-INSTANTIABLE]

new RegisteredProperty()

MEMBERS

dragMultiplier :number

If this property is of type 'number', then this number can control how sensative the property's supervisor is with regards to the cursor-drag interactivity. [DEFAULT: 1]

Default Value:
  • 1

isPersistent :boolean

Flag determining if the registered property's value should be stored in an owning Construct. To make the values of this property persistent within Constructs, set this flag to true.

Default Value:
  • true

propertyPath :Array.<string>

The path from given CustomAddOn instance to the property.

type :string

The type of the RegisteredProperty.

validationCallbackArgs :string

If this property is of type 'number' or 'string', and a validation list has not been provided, then a function callback can be provided for a method which accepts the property value and returns a sanitized version of the value. This property represents the parameters for that callback.

Default Value:
  • undefined

validationCallbackName :string

If this property is of type 'number' or 'string', and a validation list has not been provided, then a function callback can be provided for a method which accepts the property value and returns a sanitized version of the value. This property is the name of that callback.

Default Value:
  • undefined

validationCallbackOwner :object

If this property is of type 'number' or 'string', and a validation list has not been provided, then a function callback can be provided for a method which accepts the property value and returns a sanitized version of the value. This property is the owner of that callback.

Default Value:
  • undefined

validationList :Array.<any>

If this property is of type 'number' or 'string', then an Array of the given type can be provided so that the values appear in a drop-down list in the inspector, thus ensuring that only the given values are available to be selected within the GUI.

Default Value:
  • undefined