Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface that defines the options available for an editable property

Hierarchy

  • IEditablePropertyOption

Index

Properties

max?: number

max value

min?: number

min value

notifiers?: { activatePreviewCommand?: boolean; rebuild?: boolean; update?: boolean; callback?: any; onValidation?: any }

notifiers: indicates which actions to take when the property is changed

Type declaration

  • Optional activatePreviewCommand?: boolean

    the onPreviewCommandActivated observer of the preview manager should be triggered

  • Optional rebuild?: boolean

    the entity should be rebuilt

  • Optional update?: boolean

    the preview should be updated

  • callback?:function
    • callback(scene: Nullable<Scene>, block: any): undefined | boolean | void
    • a callback to trigger

      Parameters

      Returns undefined | boolean | void

  • onValidation?:function
    • onValidation(block: any, propertyName: string): boolean
    • a callback to validate the property. Returns true if the property is ok, else false. If false, the rebuild/update/callback events won't be called

      Parameters

      • block: any
      • propertyName: string

      Returns boolean

list of the options for a variable of type list

Legend

  • Constructor
  • Property
  • Method
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Property
  • Method
  • Static method

Settings

Theme