ClassTilemaps@public

FlxTilemap

Renderer-neutral tile data, collision, ray, and pathfinding object.

export declare class FlxTilemap extends FlxObject

Constructors

constructor()

Constructs a new instance of the FlxTilemap class

Properties

Property	Modifiers	Type	Description
ALT	static readonly	``	-
auto	-	number	-
AUTO	static readonly	``	-
heightInTiles	-	number	-
OFF	static readonly	``	-
tileHeight	readonly	number	Height of one tile in pixels.
tileWidth	readonly	number	Width of one tile in pixels.
totalTiles	-	number	-
widthInTiles	-	number	-

Methods

static arrayToCSV()

static arrayToCSV(data: readonly number[], width: number, invert?: boolean): string

Parameters:

Parameter	Type	Description
data	readonly number[]	-
width	number	-
invert	boolean	-

Returns: string

static bitmapToCSV()

static bitmapToCSV(bitmap: { readonly width: number; readonly height: number; readonly data: Uint32Array; }, invert?: boolean, scale?: number): string

Parameters:

Parameter	Type	Description
bitmap	{ readonly width: number; readonly height: number; readonly data: Uint32Array; }	-
invert	boolean	-
scale	number	-

Returns: string

destroy()

destroy(): void

Returns: void

findPath()

findPath(start: Readonly<FlxPoint>, end: Readonly<FlxPoint>, simplify?: boolean, raySimplify?: boolean): FlxPath | null

Parameters:

Parameter	Type	Description
start	Readonly<FlxPoint>	-
end	Readonly<FlxPoint>	-
simplify	boolean	-
raySimplify	boolean	-

Returns: FlxPath | null

follow()

follow(camera?: FlxCamera, border?: number, updateWorld?: boolean): void

Parameters:

Parameter	Type	Description
camera	FlxCamera	-
border	number	-
updateWorld	boolean	-

Returns: void

getBounds()

getBounds(bounds?: FlxRect): FlxRect

Parameters:

Parameter	Type	Description
bounds	FlxRect	-

Returns: FlxRect

getData()

getData(simple?: boolean): number[]

Parameters:

Parameter	Type	Description
simple	boolean	-

Returns: number[]

getTile()

getTile(x: number, y: number): number

Parameters:

Parameter	Type	Description
x	number	-
y	number	-

Returns: number

getTileByIndex()

getTileByIndex(index: number): number

Parameters:

Parameter	Type	Description
index	number	-

Returns: number

getTileCoords()

getTileCoords(index: number, midpoint?: boolean): FlxPoint[] | null

Parameters:

Parameter	Type	Description
index	number	-
midpoint	boolean	-

Returns: FlxPoint[] | null

getTileInstances()

getTileInstances(index: number): number[] | null

Parameters:

Parameter	Type	Description
index	number	-

Returns: number[] | null

loadMap()

loadMap(mapData: string, tileGraphic: FlxGraphic | Texture, tileWidth?: number, tileHeight?: number, autoTile?: number, startingIndex?: number, drawIndex?: number, collideIndex?: number): this

Parameters:

Parameter	Type	Description
mapData	string	-
tileGraphic	FlxGraphic | Texture	-
tileWidth	number	-
tileHeight	number	-
autoTile	number	-
startingIndex	number	-
drawIndex	number	-
collideIndex	number	-

Returns: this

loadMapData()

loadMapData(data: readonly number[], widthInTiles: number, tileGraphic: FlxGraphic | Texture, options?: Partial<FlxTilemapLoadOptions>): this

Parameters:

Parameter	Type	Description
data	readonly number[]	-
widthInTiles	number	-
tileGraphic	FlxGraphic | Texture	-
options	Partial<FlxTilemapLoadOptions>	-

Returns: this

overlaps()

overlaps(objectOrGroup: FlxBasic): boolean

Parameters:

Parameter	Type	Description
objectOrGroup	FlxBasic	-

Returns: boolean

overlapsAt()

overlapsAt(x: number, y: number, objectOrGroup: FlxBasic): boolean

Parameters:

Parameter	Type	Description
x	number	-
y	number	-
objectOrGroup	FlxBasic	-

Returns: boolean

overlapsPoint()

overlapsPoint(point: Readonly<FlxPoint>): boolean

Parameters:

Parameter	Type	Description
point	Readonly<FlxPoint>	-

Returns: boolean

overlapsWithCallback()

overlapsWithCallback(object: FlxObject, callback?: FlxTilemapOverlapCallback | null, flipCallbackParams?: boolean, position?: Readonly<FlxPoint> | null): boolean

Parameters:

Parameter	Type	Description
object	FlxObject	-
callback	FlxTilemapOverlapCallback | null	-
flipCallbackParams	boolean	-
position	Readonly<FlxPoint> | null	-

Returns: boolean

ray()

ray(start: Readonly<FlxPoint>, end: Readonly<FlxPoint>, result?: FlxPoint | null, resolution?: number): boolean

Parameters:

Parameter	Type	Description
start	Readonly<FlxPoint>	-
end	Readonly<FlxPoint>	-
result	FlxPoint | null	-
resolution	number	-

Returns: boolean

setDirty()

setDirty(dirty?: boolean): void

Parameters:

Parameter	Type	Description
dirty	boolean	-

Returns: void

setTile()

setTile(x: number, y: number, tile: number, updateGraphics?: boolean): boolean

Parameters:

Parameter	Type	Description
x	number	-
y	number	-
tile	number	-
updateGraphics	boolean	-

Returns: boolean

setTileByIndex()

setTileByIndex(index: number, tile: number, updateGraphics?: boolean): boolean

Parameters:

Parameter	Type	Description
index	number	-
tile	number	-
updateGraphics	boolean	-

Returns: boolean

setTileProperties()

setTileProperties(tileIndex: number, allowCollisions?: number, callback?: FlxTileCallback | null, callbackFilter?: FlxTileFilter | null, range?: number): void

Parameters:

Parameter	Type	Description
tileIndex	number	-
allowCollisions	number	-
callback	FlxTileCallback | null	-
callbackFilter	FlxTileFilter | null	-
range	number	-

Returns: void