ClassGame Objects & Sprites@public

FlxBackdrop

Infinitely repeating, independently scrolling texture region.

The authoritative state stays renderer-neutral while the Pixi adapter uses one TilingSprite, avoiding duplicate gameplay objects and wrap seams.

export declare class FlxBackdrop extends FlxSprite

Constructors

constructor(source?: FlxGraphic | Texture | null, x?: number, y?: number, width?: number, height?: number)

Constructs a new instance of the FlxBackdrop class

Parameter	Type	Description
source	FlxGraphic | Texture | null	-
x	number	-
y	number	-
width	number	-
height	number	-

Properties

Property	Modifiers	Type	Description
repeatX	-	boolean	Repeat the texture horizontally.
repeatY	-	boolean	Repeat the texture vertically.
scrollVelocity	readonly	FlxPoint	Deterministic tile-position change in logical pixels per second.
tileAngle	-	number	Rotation applied to each tile, in degrees.
tilePosition	readonly	FlxPoint	Texture offset in logical pixels.
tileScale	readonly	FlxPoint	Scale applied to each repeated tile without resizing the visible region.

Methods

createRenderHandle()

createRenderHandle(): FlxBackdropRenderHandle

Returns: FlxBackdropRenderHandle

loadBackdropFrame()

loadBackdropFrame(atlas: FlxAtlas, name: string, width?: number, height?: number): this

Load one named atlas frame as the repeating texture.

Parameters:

Parameter	Type	Description
atlas	FlxAtlas	-
name	string	-
width	number	-
height	number	-

Returns: this

loadBackdropGraphic()

loadBackdropGraphic(source: FlxGraphic | Texture, width?: number, height?: number): this

Load a texture and optionally set the visible tiling region.

Parameters:

Parameter	Type	Description
source	FlxGraphic | Texture	-
width	number	-
height	number	-

Returns: this

loadGraphic()

loadGraphic(source: FlxGraphic | Texture, animated?: boolean, reverse?: boolean, width?: number, height?: number, unique?: boolean): this

Parameters:

Parameter	Type	Description
source	FlxGraphic | Texture	-
animated	boolean	-
reverse	boolean	-
width	number	-
height	number	-
unique	boolean	-

Returns: this

onScreen()

onScreen(camera?: FlxCameraLike): boolean

Parameters:

Parameter	Type	Description
camera	FlxCameraLike	-

Returns: boolean

preUpdate()

preUpdate(): void

Returns: void

resize()

resize(width: number, height: number): this

Resize the visible tiling region without scaling its repeated texture.

Parameters:

Parameter	Type	Description
width	number	-
height	number	-

Returns: this

update()

update(): void

Returns: void