Lens Scripting API

    Class SpriteAligner

    Represents transform data for deprecated SpriteVisual component. Use ScreenTransform in combination with Image component instead.

    // Set the size of the Sprite Aligner
    //@input Component.SpriteAligner spriteAlign

    script.spriteAlign.size = new vec2(2.0,2.0);

    Hierarchy (View Summary, Expand)

    Index

    Constructors

    constructor

    Properties

    bindingPoint enabled sceneObject size uniqueIdentifier

    Methods

    destroy getSceneObject getTransform getTypeName isOfType isSame

    Constructors

    Properties

    bindingPoint: vec2

    The location of the point this sprite is bound to.

    enabled: boolean

    If disabled, the Component will stop enacting its behavior.

    sceneObject: SceneObject

    The scene object this component is on.

    size: vec2

    The width and height of the SpriteVisual.

    uniqueIdentifier: string

    Methods

    • Destroys the component.

      Returns void

    • 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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    MMNEPVFCICPMFPCPTTAAATR