AnimatedSprite2DOptions

Defined in: packages/three-flatland/src/sprites/AnimatedSprite2D.ts:15

Options for creating an AnimatedSprite2D.

Properties

alpha?

optional alpha?: number

Defined in: packages/three-flatland/src/sprites/AnimatedSprite2D.ts:33

Opacity 0-1, default 1

anchor?

optional anchor?: [number, number] | Vector2

Defined in: packages/three-flatland/src/sprites/AnimatedSprite2D.ts:29

Anchor/pivot point (0-1), default [0.5, 0.5] (center)

animation?

optional animation?: string

Defined in: packages/three-flatland/src/sprites/AnimatedSprite2D.ts:25

Initial animation to play

animations?

optional animations?: Animation[]

Defined in: packages/three-flatland/src/sprites/AnimatedSprite2D.ts:21

Animation definitions

animationSet?

optional animationSet?: AnimationSetDefinition

Defined in: packages/three-flatland/src/sprites/AnimatedSprite2D.ts:23

Animation set definition (alternative to animations array)

autoPlay?

optional autoPlay?: boolean

Defined in: packages/three-flatland/src/sprites/AnimatedSprite2D.ts:27

Auto-play on creation (default: true)

flipX?

optional flipX?: boolean

Defined in: packages/three-flatland/src/sprites/AnimatedSprite2D.ts:35

Flip horizontally

flipY?

optional flipY?: boolean

Defined in: packages/three-flatland/src/sprites/AnimatedSprite2D.ts:37

Flip vertically

material?

optional material?: Sprite2DMaterial

Defined in: packages/three-flatland/src/sprites/AnimatedSprite2D.ts:19

Custom material (sprites with same material instance batch together)

pixelPerfect?

optional pixelPerfect?: boolean

Defined in: packages/three-flatland/src/sprites/AnimatedSprite2D.ts:43

Pixel-perfect rendering (snap to pixels)

sortLayer?

optional sortLayer?: SortLayerValue

Defined in: packages/three-flatland/src/sprites/AnimatedSprite2D.ts:39

Sort layer — registered name or numeric order

spriteSheet

spriteSheet: SpriteSheet

Defined in: packages/three-flatland/src/sprites/AnimatedSprite2D.ts:17

SpriteSheet containing animation frames

tint?

optional tint?: string | number | Color

Defined in: packages/three-flatland/src/sprites/AnimatedSprite2D.ts:31

Tint color, default white

zIndex?

optional zIndex?: number

Defined in: packages/three-flatland/src/sprites/AnimatedSprite2D.ts:41

Z-index within sortLayer