Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LayoutEditorState

Represents the current state of the Layout Editor in order to visualize it properly.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

ptr

ptr: number

Methods

buttons

  • buttons(): number

  • Returns a bitfield corresponding to which buttons are active.

    The bits are as follows:

    • 0x04 - Can remove the current component
    • 0x02 - Can move the current component up
    • 0x01 - Can move the current component down

    Returns number

componentLen

  • componentLen(): number

componentText

  • componentText(index: number): string

  • Returns the name of the component at the specified index.

    Parameters

    • index: number

    Returns string

dispose

  • dispose(): void

  • Disposes the object, allowing it to clean up all of its memory. You need to call this for every object that you don't use anymore and hasn't already been disposed.

    Returns void

fieldLen

  • fieldLen(componentSettings: boolean): number

  • Returns the number of fields in the layout's settings.

    Set component_settings to true to use the selected component's settings instead.

    Parameters

    • componentSettings: boolean

    Returns number

fieldText

  • fieldText(componentSettings: boolean, index: number): string

  • Returns the name of the layout's setting at the specified index.

    Set component_settings to true to use the selected component's settings instead.

    Parameters

    • componentSettings: boolean
    • index: number

    Returns string

fieldValue

  • Returns the value of the layout's setting at the specified index.

    Set component_settings to true to use the selected component's settings instead.

    Parameters

    • componentSettings: boolean
    • index: number

    Returns SettingValueRef

selectedComponent

  • selectedComponent(): number

with

  • Allows for scoped usage of the object. The object is guaranteed to get disposed once this function returns. You are free to dispose the object early yourself anywhere within the scope. The scope's return value gets carried to the outside of this function.

    Type parameters

    • T

    Parameters

    Returns T

Generated using TypeDoc