Class SpriteAligner

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

Example

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

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

Hierarchy (View Summary, Expand)

Constructors

constructor

Properties

bindingPoint enabled sceneObject size uniqueIdentifier

Methods

destroy getSceneObject getTransform getTypeName isOfType isSame

Constructors

Protectedconstructor

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

The scene object this component is on.

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: string): boolean

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

    Parameters

    • type: string

    Returns boolean

isSame

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