Lens Scripting API
    Preparing search index...

    Class BackPlate

    The BackPlate component creates a customizable back plate with a rounded rectangle shape. It supports different styles and sizes, and includes an interactable component for user interaction. BackPlate can be used as a background for other UI elements.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    api enabled isBeingDestroyed isEnabledInHierarchy name sceneObject uniqueIdentifier updateOrder updatePriority

    Accessors

    interactable interactionPlane interactionPlaneOffset interactionPlanePadding renderOrder size style

    Methods

    createEvent destroy getReferencedEvents getSceneObject getTransform getTypeName getTypeName isOfType isSame onAwake removeEvent

    Constructors

    Properties

    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.

    This property is no longer needed, you can use a reference to the ScriptComponent, including 'script', directly

    enabled: boolean

    If disabled, the Component will stop enacting its behavior.

    true
    isBeingDestroyed: boolean

    Returns true if this Component is currently being destroyed. Becomes true as soon as destruction begins via Component#destroy or destruction of its owning SceneObject, before any OnDestroyEvent callbacks fire.

    Lens Scripting Version 364

    if (!script.isBeingDestroyed) {
        // Component is still fully alive
    }
    isEnabledInHierarchy: boolean

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

    name: string
    sceneObject: SceneObject

    The SceneObject this component is on.

    uniqueIdentifier: string

    Lens Scripting Version 176

    updateOrder: number
    updatePriority: number

    Accessors

    • get interactable(): Interactable

      Gets the interactable component of the back plate.

      Returns Interactable

      The interactable component associated with the back plate.

    • get interactionPlaneOffset(): vec3

      Get the offset position for the interaction plane relative to the frame center.

      Returns vec3

    • set interactionPlaneOffset(offset: vec3): void

      Set the offset position for the interaction plane relative to the frame center.

      Parameters

      • offset: vec3

        The new offset.

      Returns void

    • get interactionPlanePadding(): vec2

      Get the size of the padding around the InteractionPlane.

      Returns vec2

    • set interactionPlanePadding(padding: vec2): void

      Set the size of the padding around the InteractionPlane.

      Parameters

      • padding: vec2

        The new padding.

      Returns void

    • get renderOrder(): number

      Returns number

    • set renderOrder(value: number): void

      Parameters

      • value: number

      Returns void

    • get size(): vec2

      Gets the size of the back plate.

      Returns vec2

      The current size of the back plate.

    • set size(size: vec2): void

      Sets the size of the back plate.

      Parameters

      • size: vec2

        The new size of the back plate. The size is a vec2 representing the width and height of the back plate. The collider shape is also updated to match the new size.

      Returns void

    • get style(): string

      Sets the style of the back plate.

      Returns string

    • set style(style: BackPlateStyle): void

      Sets the style of the back plate. The style determines the background gradient and color of the back plate.

      • "default" has lighter gradient.
      • "dark" has darker gradient.
      • "simple" uses a solid color.

      Parameters

      Returns void

    Methods

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

      Parameters

      • type: string

      Returns boolean

    • Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods