Lens Scripting API
    Preparing search index...

    Class Visual

    Base class for all visual Components.

    Hierarchy (View Summary)

    Index

    Properties

    enabled isBeingDestroyed isEnabledInHierarchy renderOrder sceneObject uniqueIdentifier

    Methods

    destroy getRenderOrder getSceneObject getTransform getTypeName isOfType isSame setRenderOrder

    Properties

    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.

    renderOrder: number

    The order in which the visual should be rendered.

    Lens Scripting Version 323

    0
    sceneObject: SceneObject

    The SceneObject this component is on.

    uniqueIdentifier: string

    Lens Scripting Version 176

    Methods

    • Destroys the component.

      Returns void

    • Returns the order of this Visual in the render queue.

      Returns number

    • Returns the name of this object's type.

      Returns string

    • 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

    • Sets the order of this Visual in the render queue.

      Parameters

      • value: number

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods