Lens Scripting API
    Preparing search index...

    Class Animation

    Use AnimationPlayer instead

    Hierarchy (View Summary)

    Index

    Properties

    enabled isBeingDestroyed isEnabledInHierarchy sceneObject uniqueIdentifier

    Methods

    destroy getAnimationLayerByName getSceneObject getTransform getTypeName isOfType isSame removeAnimationLayerByName setAnimationLayerByName

    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.

    sceneObject: SceneObject

    The SceneObject this component is on.

    uniqueIdentifier: string

    Lens Scripting Version 176

    Methods

    • Destroys the component.

      Returns void

    • Returns the AnimationLayer under the name layerName.

      Parameters

      • layerName: string

      Returns AnimationLayer

      Since Lens Scripting Version 307

    • 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

    • Removes the AnimationLayer under the name layerName.

      Parameters

      • layerName: string

      Returns void

      Since Lens Scripting Version 307

    • Adds an AnimationLayer under the name layerName.

      Parameters

      Returns void

      Since Lens Scripting Version 307

    Settings

    Member Visibility

    On This Page

    Properties
    Methods