Lens Scripting API
    Preparing search index...

    Class GridLayout

    Low Level Layout Component Set a base CellSize in local space Define a number of Rows And Columns And it will create a list or grid in the specified shape

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    api cellPadding cellSize columns enabled isBeingDestroyed isEnabledInHierarchy layoutBy name positionCallback rows sceneObject transform uniqueIdentifier updateOrder updatePriority

    Accessors

    aabbMax aabbMin isInitialized totalCellSize totalColumns totalRows

    Methods

    calculateChildPosition createEvent destroy getCellSceneObject getReferencedEvents getSceneObject getTransform getTypeName getTypeName initialize isOfType isSame layout onAwake removeEvent requestPersistInput

    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

    cellPadding: vec4 = ...
    cellSize: vec2 = ...
    columns: number = 2
    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.

    layoutBy: LayoutDirection
    name: string
    positionCallback: PositionCallback = null

    callback for each child on layout

    row, column use for advanced positioning per item

    rows: number = 3
    sceneObject: SceneObject

    The SceneObject this component is on.

    transform: Transform = ...
    uniqueIdentifier: string

    Lens Scripting Version 176

    updateOrder: number

    The relative execution order of this script's lifecycle callbacks (onStart, onUpdate, onLateUpdate, etc.) among all scripts in the Lens. Scripts with a smaller updateOrder run before scripts with a larger updateOrder. Reflects the updateOrder set on the attached ScriptAsset. Defaults to 0.

    updateOrder only orders scripts relative to each other; it does not affect ordering relative to non-script engine Components.

    Lens Scripting Version 367

    if (script.updateOrder < 0) {
        // This script runs before scripts at the default updateOrder.
    }
    updatePriority: number

    Accessors

    • get isInitialized(): boolean

      Returns boolean

    • get totalColumns(): number

      Returns number

      total number of columns in grid

    • get totalRows(): number

      Returns number

      total number of rows in grid

    Methods

    • Parameters

      • gridColumn: number

        of target cell

      • gridRow: number

        of target cell

      Returns vec3

      position of cell at column and row

    • Parameters

      • x: number

        x index of target

      • y: number

        y index of target

      Returns SceneObject

      SceneObject at x, y in grid

    • Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

      Type Parameters

      Parameters

      • this: T

      Returns TypeName<InstanceType<T>>

    • initialization function call on next line after programmatically creating component to prevent a flash of unstyled content

      Returns void

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

      Parameters

      • type: string

      Returns boolean

    • call this function to lay out the children of this scene object according to the parameters set in the component will change their local transform

      Returns void

    • Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods