Lens Scripting API
    Preparing search index...

    Class SwitchToggleGroup

    Represents a group of switch toggles.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    addCallbacks api enabled isEnabledInHierarchy name onToggleSelected sceneObject uniqueIdentifier updatePriority

    Accessors

    allowAllTogglesOff firstOnToggle toggleables

    Methods

    createEvent deregisterToggleable destroy getReferencedEvents getSceneObject getTransform getTypeName getTypeName isOfType isSame onAwake registerToggleable removeEvent resetToggleGroup

    Constructors

    Properties

    addCallbacks: boolean = false
    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.

    enabled: boolean

    If disabled, the Component will stop enacting its behavior.

    isEnabledInHierarchy: boolean

    Returns true if this Component, its SceneObject, and all of that SceneObjects parents are enabled.

    name: string
    onToggleSelected: PublicApi<ToggleSelectedArgs> = ...

    An event that is triggered when a toggle is selected within the group.

    Use this event to listen for changes in the toggle group selection state. Subscribers will be notified whenever a toggle is selected.

    sceneObject: SceneObject

    The SceneObject this component is on.

    uniqueIdentifier: string
    updatePriority: number

    Accessors

    • get allowAllTogglesOff(): boolean

      Gets a value indicating whether all toggles in the group are allowed to be turned off.

      When this property is true, it means that none of the toggles in the group are required to remain active, allowing all toggles to be in an "off" state.

      Returns boolean

      A boolean value indicating if all toggles can be turned off.

    • set allowAllTogglesOff(value: boolean): void

      Sets whether all toggles in the group can be turned off simultaneously.

      Parameters

      • value: boolean

        A boolean indicating if all toggles can be turned off. If true, all toggles can be deselected at the same time.

      Returns void

    • get firstOnToggle(): number

      Returns number

    • set firstOnToggle(value: number): void

      Parameters

      • value: number

      Returns void

    • get toggleables(): Toggleable[]

      Gets the list of toggleable components managed by this toggle group.

      Returns Toggleable[]

      An array of Toggleable objects representing the toggleable components.

    Methods

    • Deregisters a toggleable component from the toggle group.

      This method removes the specified toggleable component from the list of registered toggleables and also removes its associated event handler.

      Parameters

      • toggleable: Toggleable

        The toggleable component to be deregistered.

      Returns void

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

      Parameters

      • type: string

      Returns boolean

    • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

      Parameters

      Returns boolean

    • Registers a toggleable component with the toggle group, with an optional value.

      Parameters

      • toggleable: Toggleable

        The toggleable component to be registered.

      • value: any = null

        An optional value associated with the toggleable.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods