flixel.graphics.frames.FlxTileFrames

Spritesheet frame collection. It is used for tilemaps and animated sprites.

Static methods

`staticcombineTileFrames(tileframes:Array<FlxTileFrames>, ?spacing:FlxPoint, ?border:FlxPoint):FlxTileFrames`

This method takes array of tile frames collections and then combine them in one big tileset. The order of bitmaps in array is important.

var combinedFrames = FlxTileFrames.combineTileFrames(tileframes);
tilemap.loadMapFromCSV(mapData, combinedFrames);

sprite.frames = combinedFrames;

Parameters:

`tileframes`	Tile frames collection to combine tiles from.

Returns:

Atlas frames collection, which you can load in tilemaps or sprites:

`staticcombineTileSets(bitmaps:Array<BitmapData>, tileSize:FlxPoint, ?spacing:FlxPoint, ?border:FlxPoint):FlxTileFrames`

This method takes array of tileset bitmaps and the size of tiles in them and then combine them in one big tileset. The order of bitmaps in the array is important.

var combinedFrames = FlxTileFrames.combineTileSets(bitmaps, FlxPoint.get(16, 16));
tilemap.loadMapFromCSV(mapData, combinedFrames);

sprite.frames = combinedFrames;

Parameters:

`bitmaps`	tilesets
`tileSize`	The size of tiles (tilesets should have tiles of the same size).

Returns:

Atlas frames collection, which you can load in tilemaps or sprites:

`staticfindFrame(graphic:FlxGraphic, tileSize:FlxPoint, ?region:FlxRect, ?atlasFrame:FlxFrame, ?tileSpacing:FlxPoint, ?border:FlxPoint):FlxTileFrames`

Searches FlxTileFrames object for a specified FlxGraphic object which has the same parameters (frame size, frame spacings, region of image, etc.).

Parameters:

`graphic`	`FlxGraphic` object to search `FlxTileFrames` for.
`tileSize`	The size of tiles in TileFrames.
`region`	The region of source image used for spritesheet generation.
`atlasFrame`	Optional `FlxFrame` object used for spritesheet generation.
`tileSpacing`	Spaces between tiles in spritesheet.

Returns:

FlxTileFrames object which corresponds to specified arguments. Could be null if there is no such FlxTileFrames.

`staticfromAtlasByPrefix(Frames:FlxAtlasFrames, Prefix:String):FlxTileFrames`

Creates new a FlxTileFrames collection from atlas frames which begin with a common name (e.g. "tiles-") and differ in indices (e.g. "001", "002", etc.). This method is similar to FlxAnimationController's addByPrefix().

Parameters:

`Frames`	Collection of atlas frames to generate tiles from.
`Prefix`	Common beginning of image names in atlas (e.g. `"tiles-"`).

Returns:

Generated tile frames collection.

`staticfromBitmapAddSpacesAndBorders(source:FlxGraphicAsset, tileSize:FlxPoint, ?tileSpacing:FlxPoint, ?tileBorder:FlxPoint, ?region:FlxRect):FlxTileFrames`

Gets source BitmapData, generates new BitmapData with spaces between frames (if there is no such BitmapData in the cache already) and creates FlxTileFrames collection.

Parameters:

`source`	The source of graphic for frame collection.
`tileSize`	The size of tiles in spritesheet.
`tileSpacing`	Desired offsets between frames in spritesheet (this method takes spritesheet bitmap without offsets between frames and adds them).
`tileBorder`	Border to add around tiles (helps to avoid "tearing" problem).
`region`	Region of image to generate spritesheet from. Default value is `null`, which means that the whole image will be used for spritesheet generation.

Returns:

Newly created spritesheet.

`staticfromFrame(frame:FlxFrame, tileSize:FlxPoint, ?tileSpacing:FlxPoint):FlxTileFrames`

Generates spritesheet frame collection from provided frame. Can be useful for spritesheets packed into atlases. It can generate spritesheets from rotated and cropped frames also, which is important for devices with limited memory.

Parameters:

`frame`	Frame, containing spritesheet image
`tileSize`	The size of tiles in spritesheet
`tileSpacing`	Offsets between frames in spritesheet. Default value is `null`, which means no offsets between tiles.

Returns:

Newly created spritesheet frame collection.

`staticfromFrameAddSpacesAndBorders(frame:FlxFrame, tileSize:FlxPoint, ?tileSpacing:FlxPoint, ?tileBorder:FlxPoint):FlxTileFrames`

Gets FlxFrame object, generates new BitmapData with spaces between tiles in the frame (if there is no such BitmapData in the cache already) and creates a FlxTileFrames collection.

Parameters:

`frame`	Frame to generate tiles from.
`tileSize`	the size of tiles in spritesheet.
`tileSpacing`	desired offsets between frames in spritesheet. (this method takes spritesheet bitmap without offsets between frames and adds them).
`tileBorder`	Border to add around tiles (helps to avoid "tearing" problem).

Returns:

Newly created spritesheet.

`staticfromFrames(Frames:Array<FlxFrame>):FlxTileFrames`

Just generates tile frames collection from specified array of frames.

Parameters:

`Frames`	`Array` of frames to generate tile frames from. They all should have the same source size and parent graphic. If not then `null` will be returned.

Returns:

Generated collection of frames.

`staticfromGraphic(graphic:FlxGraphic, tileSize:FlxPoint, ?region:FlxRect, ?tileSpacing:FlxPoint):FlxTileFrames`

Generates spritesheet frame collection from provided region of image.

Parameters:

`graphic`	Source graphic for spritesheet.
`tileSize`	The size of tiles in spritesheet.
`region`	Region of image to use for spritesheet generation. Default value is `null`, which means that the whole image will be used for it.
`tileSpacing`	Offsets between frames in spritesheet. Default value is `null`, which means no offsets between tiles.

Returns:

Newly created spritesheet frame collection.

`staticfromRectangle(source:FlxGraphicAsset, tileSize:FlxPoint, ?region:FlxRect, ?tileSpacing:FlxPoint):FlxTileFrames`

Generates a spritesheet frame collection from the provided image region.

Parameters:

`source`	Source graphic for the spritesheet.
`tileSize`	The size of tiles in spritesheet.
`region`	Region of image to use for spritesheet generation. Default value is `null`, which means that whole image will be used for it.
`tileSpacing`	Offsets between frames in spritesheet. Default value is `null`, which means no offsets between tiles.

Returns:

Newly created spritesheet frame collection.

Variables

`@:value(0)numCols:Int = 0`

`@:value(0)numRows:Int = 0`

`tileSize:FlxPoint`

The size of frame in this spritesheet.

Methods

`equals(tileSize:FlxPoint, ?region:FlxRect, ?atlasFrame:FlxFrame, ?tileSpacing:FlxPoint, ?border:FlxPoint):Bool`

TileFrames comparison method. For internal use.

`inlinegetByTilePosition(column:Int, row:Int):FlxFrame`

Gets frame by its "position" in spritesheet.

Inherited Variables

Defined by FlxFramesCollection

Inherited Methods

Defined by FlxFramesCollection

`@:value({ duration : 0.0, flipY : false, flipX : false, angle : 0 })addAtlasFrame(frame:FlxRect, sourceSize:FlxPoint, offset:FlxPoint, ?name:String, angle:FlxFrameAngle = 0, flipX:Bool = false, flipY:Bool = false, duration:Float = 0.0):FlxFrame`

Adds new frame to this frame collection. This method runs additional check, and can add rotated frames (from texture atlases).

Parameters:

`frame`	Region of image.
`sourceSize`	Original size of packed image (if image had been cropped, then original size will be bigger than frame size).
`offset`	How frame region is located on original frame image (offset from top left corner of original image).
`name`	Name for this frame (name of packed image file).
`angle`	Rotation of packed image (can be `0`, `90` or `-90`).
`flipX`	If packed image should be horizontally flipped.
`flipY`	If packed image should be vertically flipped.
`duration`	The duration of this frame in seconds. If 0, the anim controller will decide the duration.

Returns:

Newly created and added frame object.

`addEmptyFrame(size:FlxRect):FlxFrame`

Adds empty frame into this frame collection. An empty frame is doing almost nothing for all the time.

Parameters:

`size`	Dimensions of the frame to add.

Returns:

Newly added empty frame.

`addFrameOffset(name:String, offsetX:Float, offsetY:Float):Void`

Adjusts the target frame's offset by the specified values. This mainly exists because certain atlas exporters don't give the correct offset. If no frame with the specified name exists, a warning is logged.

Parameters:

`name`	The name of the frame.
`offsetX`	The horizontal adjustment added to the frame's current offset.
`offsetY`	The vertical adjustment added to the frame's current offset.

Available since

5.3.0

`@:value({ warnIfEmpty : true })addFramesOffsetByPrefix(prefix:String, offsetX:Float, offsetY:Float, warnIfEmpty:Bool = true):Void`

Adjusts all frames with the specified name prefix by the specified offset. This mainly exists because certain atlas exporters don't give the correct offset.

Parameters:

`prefix`	The prefix used to determine which frames are affected.
`offsetX`	The horizontal adjustment added to the frame's current offset.
`offsetY`	The vertical adjustment added to the frame's current offset.
`warnIfEmpty`	Whether to log a warning if no frames with the prefix are found.

Available since

5.3.0

`addSpriteSheetFrame(region:FlxRect):FlxFrame`

Adds new regular (not rotated) FlxFrame to this frame collection.

Parameters:

`region`	Region of image which new frame will display.

Returns:

Newly created FlxFrame object for specified region of image.

`inlineexists(name:String):Bool`

Whether the collection has frame with the specified name.

Parameters:

`name`	The name of the frame to find.

Returns:

Whether the collection has frame with the specified name.

`@:value({ warnIfEmpty : true })inlineforEachByPrefix(prefix:String, func:FlxFrame ‑> Void, warnIfEmpty:Bool = true, ?warningMsg:String):Void`

Calls the given function on each frame whose name matches the specified prefix.

Note: This method is inlined so that optimizations are made when a literal anonymous functions or inlined functions are passed in, or when literal false is used for warnIfEmpty. Meaning, this is often more performant than getAllByPrefix.

Parameters:

`prefix`	The name prefix to look for.

Available since

5.3.0

`getAllByPrefix(prefix:String):Array<FlxFrame>`

Retrieves all frames with names starting with the specified prefix in an Array.

Parameters:

`prefix`	The name prefix to look for.

Available since

5.3.0

`inlinegetByIndex(index:Int):FlxFrame`

Finds frame in frames array by its index.

Parameters:

`index`	Index of the frame in the frames array.

Returns:

Frame with specified index in this frames collection (if there is one).

`inlinegetByName(name:String):FlxFrame`

Finds a frame in the collection by its name.

Parameters:

`name`	The name of the frame to find.

Returns:

Frame with specified name (if there is one).

`inlinegetFrameIndex(frame:FlxFrame):Int`

Finds the index of the specified frame in the frames array.

Parameters:

`frame`	Frame to find.

Returns:

Index of the specified frame.

`getIndexByName(name:String):Int`

Finds frame index by its name.

Parameters:

`name`	Name of the frame.

Returns:

Index of the frame with specified name.

`@:value({ overwriteHash : false })pushFrame(frameObj:FlxFrame, overwriteHash:Bool = false):FlxFrame`

Helper method for a adding frame to the collection.

Parameters:

`frameObj`	Frame to add.
`overwriteHash`	If true, any new frames with matching names will replace old ones.

Returns:

Added frame.

`setFrameDuration(name:String, duration:Float):Void`

Sets the target frame's offset to the specified values. This mainly exists because certain atlas exporters don't give the correct offset. If no frame with the specified name exists, a warning is logged.

Parameters:

`name`	The name of the frame.
`duration`	The new duration of the frame.

Available since

5.3.0

`setFrameOffset(name:String, offsetX:Float, offsetY:Float):Void`

Parameters:

`name`	The name of the frame.
`offsetX`	The new horizontal offset of the frame.
`offsetY`	The new vertical offset of the frame.

Available since

5.3.0

`@:value({ warnIfEmpty : true })setFramesOffsetByPrefix(prefix:String, offsetX:Float, offsetY:Float, warnIfEmpty:Bool = true):Void`

Sets all frames with the specified name prefix to the specified offset. This mainly exists because certain atlas exporters don't give the correct offset.

Parameters:

`prefix`	The prefix used to determine which frames are affected.
`offsetX`	The new horizontal offset of the frame.
`offsetY`	The new vertical offset of the frame.
`warnIfEmpty`	Whether to log a warning if no frames with the prefix are found.

Available since

5.3.0

class FlxTileFrames

package flixel.graphics.frames

extends FlxFramesCollection

Static methods

staticcombineTileFrames(tileframes:Array<FlxTileFrames>, ?spacing:FlxPoint, ?border:FlxPoint):FlxTileFrames

staticcombineTileSets(bitmaps:Array<BitmapData>, tileSize:FlxPoint, ?spacing:FlxPoint, ?border:FlxPoint):FlxTileFrames

staticfindFrame(graphic:FlxGraphic, tileSize:FlxPoint, ?region:FlxRect, ?atlasFrame:FlxFrame, ?tileSpacing:FlxPoint, ?border:FlxPoint):FlxTileFrames

staticfromAtlasByPrefix(Frames:FlxAtlasFrames, Prefix:String):FlxTileFrames

staticfromBitmapAddSpacesAndBorders(source:FlxGraphicAsset, tileSize:FlxPoint, ?tileSpacing:FlxPoint, ?tileBorder:FlxPoint, ?region:FlxRect):FlxTileFrames

staticfromFrame(frame:FlxFrame, tileSize:FlxPoint, ?tileSpacing:FlxPoint):FlxTileFrames

staticfromFrameAddSpacesAndBorders(frame:FlxFrame, tileSize:FlxPoint, ?tileSpacing:FlxPoint, ?tileBorder:FlxPoint):FlxTileFrames

staticfromFrames(Frames:Array<FlxFrame>):FlxTileFrames

staticfromGraphic(graphic:FlxGraphic, tileSize:FlxPoint, ?region:FlxRect, ?tileSpacing:FlxPoint):FlxTileFrames

staticfromRectangle(source:FlxGraphicAsset, tileSize:FlxPoint, ?region:FlxRect, ?tileSpacing:FlxPoint):FlxTileFrames

Variables

@:value(0)numCols:Int = 0

@:value(0)numRows:Int = 0

tileSize:FlxPoint

Methods

equals(tileSize:FlxPoint, ?region:FlxRect, ?atlasFrame:FlxFrame, ?tileSpacing:FlxPoint, ?border:FlxPoint):Bool

inlinegetByTilePosition(column:Int, row:Int):FlxFrame

Inherited Variables

Defined by FlxFramesCollection

read onlyborder:FlxPoint

frames:Array<FlxFrame>

framesHash:Map<String, FlxFrame>

read onlynumFrames:Int

parent:FlxGraphic

read onlytype:FlxFrameCollectionType

Inherited Methods

Defined by FlxFramesCollection

@:value({ duration : 0.0, flipY : false, flipX : false, angle : 0 })addAtlasFrame(frame:FlxRect, sourceSize:FlxPoint, offset:FlxPoint, ?name:String, angle:FlxFrameAngle = 0, flipX:Bool = false, flipY:Bool = false, duration:Float = 0.0):FlxFrame

addEmptyFrame(size:FlxRect):FlxFrame

addFrameOffset(name:String, offsetX:Float, offsetY:Float):Void

@:value({ warnIfEmpty : true })addFramesOffsetByPrefix(prefix:String, offsetX:Float, offsetY:Float, warnIfEmpty:Bool = true):Void

addSpriteSheetFrame(region:FlxRect):FlxFrame

inlineexists(name:String):Bool

@:value({ warnIfEmpty : true })inlineforEachByPrefix(prefix:String, func:FlxFrame ‑> Void, warnIfEmpty:Bool = true, ?warningMsg:String):Void

getAllByPrefix(prefix:String):Array<FlxFrame>

inlinegetByIndex(index:Int):FlxFrame

inlinegetByName(name:String):FlxFrame

inlinegetFrameIndex(frame:FlxFrame):Int

getIndexByName(name:String):Int

@:value({ overwriteHash : false })pushFrame(frameObj:FlxFrame, overwriteHash:Bool = false):FlxFrame

setFrameDuration(name:String, duration:Float):Void

setFrameOffset(name:String, offsetX:Float, offsetY:Float):Void

@:value({ warnIfEmpty : true })setFramesOffsetByPrefix(prefix:String, offsetX:Float, offsetY:Float, warnIfEmpty:Bool = true):Void

toString():String

`staticcombineTileFrames(tileframes:Array<FlxTileFrames>, ?spacing:FlxPoint, ?border:FlxPoint):FlxTileFrames`

`staticcombineTileSets(bitmaps:Array<BitmapData>, tileSize:FlxPoint, ?spacing:FlxPoint, ?border:FlxPoint):FlxTileFrames`

`staticfindFrame(graphic:FlxGraphic, tileSize:FlxPoint, ?region:FlxRect, ?atlasFrame:FlxFrame, ?tileSpacing:FlxPoint, ?border:FlxPoint):FlxTileFrames`

`staticfromAtlasByPrefix(Frames:FlxAtlasFrames, Prefix:String):FlxTileFrames`

`staticfromBitmapAddSpacesAndBorders(source:FlxGraphicAsset, tileSize:FlxPoint, ?tileSpacing:FlxPoint, ?tileBorder:FlxPoint, ?region:FlxRect):FlxTileFrames`

`staticfromFrame(frame:FlxFrame, tileSize:FlxPoint, ?tileSpacing:FlxPoint):FlxTileFrames`

`staticfromFrameAddSpacesAndBorders(frame:FlxFrame, tileSize:FlxPoint, ?tileSpacing:FlxPoint, ?tileBorder:FlxPoint):FlxTileFrames`

`staticfromFrames(Frames:Array<FlxFrame>):FlxTileFrames`

`staticfromGraphic(graphic:FlxGraphic, tileSize:FlxPoint, ?region:FlxRect, ?tileSpacing:FlxPoint):FlxTileFrames`

`staticfromRectangle(source:FlxGraphicAsset, tileSize:FlxPoint, ?region:FlxRect, ?tileSpacing:FlxPoint):FlxTileFrames`

`@:value(0)numCols:Int = 0`

`@:value(0)numRows:Int = 0`

`tileSize:FlxPoint`

`equals(tileSize:FlxPoint, ?region:FlxRect, ?atlasFrame:FlxFrame, ?tileSpacing:FlxPoint, ?border:FlxPoint):Bool`

`inlinegetByTilePosition(column:Int, row:Int):FlxFrame`

`read onlyborder:FlxPoint`

`frames:Array<FlxFrame>`

`framesHash:Map<String, FlxFrame>`

`read onlynumFrames:Int`

`parent:FlxGraphic`

`read onlytype:FlxFrameCollectionType`

`@:value({ duration : 0.0, flipY : false, flipX : false, angle : 0 })addAtlasFrame(frame:FlxRect, sourceSize:FlxPoint, offset:FlxPoint, ?name:String, angle:FlxFrameAngle = 0, flipX:Bool = false, flipY:Bool = false, duration:Float = 0.0):FlxFrame`

`addEmptyFrame(size:FlxRect):FlxFrame`

`addFrameOffset(name:String, offsetX:Float, offsetY:Float):Void`

`@:value({ warnIfEmpty : true })addFramesOffsetByPrefix(prefix:String, offsetX:Float, offsetY:Float, warnIfEmpty:Bool = true):Void`

`addSpriteSheetFrame(region:FlxRect):FlxFrame`

`inlineexists(name:String):Bool`

`@:value({ warnIfEmpty : true })inlineforEachByPrefix(prefix:String, func:FlxFrame ‑> Void, warnIfEmpty:Bool = true, ?warningMsg:String):Void`

`getAllByPrefix(prefix:String):Array<FlxFrame>`

`inlinegetByIndex(index:Int):FlxFrame`

`inlinegetByName(name:String):FlxFrame`

`inlinegetFrameIndex(frame:FlxFrame):Int`

`getIndexByName(name:String):Int`

`@:value({ overwriteHash : false })pushFrame(frameObj:FlxFrame, overwriteHash:Bool = false):FlxFrame`

`setFrameDuration(name:String, duration:Float):Void`

`setFrameOffset(name:String, offsetX:Float, offsetY:Float):Void`

`@:value({ warnIfEmpty : true })setFramesOffsetByPrefix(prefix:String, offsetX:Float, offsetY:Float, warnIfEmpty:Bool = true):Void`

`toString():String`