dacha
    Preparing search index...

    Class Sprite

    Draws an image, a frame of a sprite sheet, or a tiled image.

    Sprite

    Hierarchy (View Summary)

    Index
    constructor
    actor? blending color currentFrame? disabled fit flipX flipY height opacity slice sortingLayer sortOffset src textureOffset width
    getParentComponent
    actor?: Actor

    The actor that has this component. It is undefined until the component is added to an actor.

    blending: "normal" | "addition" | "subtract" | "multiply"

    Blending mode for rendering

    color: string

    Color tint applied to the sprite

    currentFrame?: number = 0

    Current frame to render

    disabled: boolean

    Whether the sprite is disabled and should not render

    fit: "repeat" | "stretch"

    How the texture should fit within the sprite bounds

    flipX: boolean

    Whether to flip the sprite horizontally

    flipY: boolean

    Whether to flip the sprite vertically

    height: number

    Height of the sprite in pixels

    opacity: number

    Opacity from 0 (transparent) to 1 (opaque)

    slice: number

    Number of frames in the sprite sheet

    sortingLayer: string

    Sorting layer name for rendering order

    sortOffset: Point

    Center point for sorting calculations

    src: string

    Path to the texture image file

    textureOffset: Point

    Texture sampling offset in pixels. Only applies to fit: 'repeat'. With flipX/flipY the tile is mirrored, so a positive offset scrolls in the mirrored direction.

    width: number

    Width of the sprite in pixels

    • Returns the component of the same class on the parent actor.

      Returns Component<object> | undefined

      The component, or undefined if the actor has no parent actor or the parent has no such component.

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods