Interface SpriteAligner

Represents transform data for screen-aligned 2D sprites. Use on SceneObjects with a SpriteVisual Component. See also: SpriteVisual.

Example

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

script.spriteAlign.size = new vec2(2.0,2.0);
interface SpriteAligner {
    bindingPoint: vec2;
    enabled: boolean;
    sceneObject: SceneObject;
    size: vec2;
    uniqueIdentifier: string;
    destroy(): void;
    getSceneObject(): SceneObject;
    getTransform(): Transform;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
}

Hierarchy (view full)

Properties

bindingPoint enabled sceneObject size uniqueIdentifier

Methods

destroy getSceneObject getTransform getTypeName isOfType isSame

Properties

bindingPoint

bindingPoint: vec2

The location of the point this sprite is bound to.

enabled

enabled: boolean

If disabled, the Component will stop enacting its behavior.

ReadonlysceneObject

sceneObject: SceneObject

size

size: vec2

The width and height of the SpriteVisual.

ReadonlyuniqueIdentifier

uniqueIdentifier: string

Methods

destroy

  • destroy(): void

  • Destroys the component.

    Returns void

getSceneObject

getTransform

getTypeName

  • getTypeName(): string

  • Returns the name of this object's type.

    Returns string

isOfType

  • isOfType(type): boolean

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

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other): 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

Properties
Methods