Lens Scripting API

    This class provides basic toggle functionality for a prefab toggle button. It manages the toggle state and provides methods to handle toggle events and update the button's visual state.

    Hierarchy (View Summary, Expand)

    Index

    Constructors

    Properties

    _offIcon: SceneObject

    The icon to be shown when the button is toggled off.

    _onIcon: SceneObject

    The icon to be shown when the button is toggled on.

    api: Record<string, any>

    Generic object accessible by other instances of ScriptComponent. Use this object to store references to properties and methods that need to be accessible from other ScriptComponents.

    editEventCallbacks: boolean = false

    Enable this to add functions from another script to this component's callback events.

    enabled: boolean

    If disabled, the Component will stop enacting its behavior.

    name: string
    onStateChanged: PublicApi<boolean> = ...
    sceneObject: SceneObject

    The scene object this component is on.

    uniqueIdentifier: string
    updatePriority: number

    Accessors

    • get isToggledOn(): boolean

      Returns boolean

      the current toggle state of the button

    • set isToggledOn(toggleOn: boolean): void

      Parameters

      • toggleOn: boolean

        the new state of the button, invoking the toggle event if different than current state.

      Returns void

    • get offIcon(): SceneObject

      Returns SceneObject

      the icon to be shown when the button is toggled off

    • set offIcon(iconObject: SceneObject): void

      Parameters

      • iconObject: SceneObject

        the icon to be shown when the button is toggled off

      Returns void

    • get onIcon(): SceneObject

      Returns SceneObject

      the icon to be shown when the button is toggled on

    • set onIcon(iconObject: SceneObject): void

      Parameters

      • iconObject: SceneObject

        the icon to be shown when the button is toggled on

      Returns void

    Methods

    • Returns true if the object matches or derives from the passed in type.

      Parameters

      • type: string

      Returns boolean

    • Returns void

    • Toggles the state of the button

      Returns void

    MMNEPVFCICPMFPCPTTAAATR