FlxTilemap#loadMap(): support Array<Array<Int>> instead of Array<Int>, closes #1290, closes #1324

[Gama11]

Supporting both 2D and 1D-arrays here is suprisingly difficult due to the use of Dynamic and target-specfic differences, so I decided to drop support for the latter. A 2D array is much more natural representation of map data anyway. Loading maps with array is very inconvenient / awkward as is, as widthInTiles and heightInTiles have to be set in advance.

[Gama11]

@gamedevsam You think this is an acceptable breaking change?

[gamedevsam]

Does this break compatibility with maps loaded from Tiled Editor?

[Gama11]

Not sure, I think they use csv for loading?

[gamedevsam]

No, they use in array that can be compressed with gzip or json.

[Gama11]

Perhaps we should split this up into several functions? loadMap(), loadMapFromArray() and loadMapFrom2DArray()? Would also get rid of the Dynamic usage.

[gamedevsam]

Perhaps, but I don't like the idea of duplicating code...

[Gama11]

If done right, this shouldn't introduce any redundancies.

[gamedevsam]

Seems like a good change then, although it does complicate the API slightly. Also LoadMap should be refactored to be LoadMapFromCSV()

Let's make it all very explicit.

[Gama11]

If only haxe supported overloading. :)

I don't think this complicates the API actually, it might make it simpler to understand actually.

[Gama11]

Hm... Since the render refactor, there's a loadMap() and a new loadMapFrames(), which kinda conflicts with this... Thoughts @Beeblerox?

[Beeblerox]

@Gama11 i don't think that there is big problem with updating pull request. I can do it myself if you want to.
loadMapFrames() does almost everything as loadMap, but takes exisiting FlxTileFrames as an argument instead of FlxGraphicAsset. which allows you to load graphic from atlas.

[Gama11]

Yes, that's exactly the issue. I wanted to split loadMap() into loadMapFromCsv(), loadMapFromArray() and loadMapFrom2DArray() - if each one of those needs a Frames-version as well, we'd end up with 6 functions.

[Beeblerox]

maybe we could add some sort of helper method, which will convert 1d-array to 2d-array to avoid this?

[Gama11]

That would work, but it seems pretty inefficient - convert 1d array to 2d and then back again to 1d (since that's the format that FlxTilemap ends up using).

[Beeblerox]

let me some time to think about it

[Beeblerox]

i've removed loadMapFrame() here: 9a84e25997dd
loadMap() can accept tile frames (added couple casting operations, but i think that tilemap loading isn't frequent operation, so it acceptable)
so you could split loadMap() into loadMapFromCsv(), loadMapFromArray() and loadMapFrom2DArray() as you wanted

[Gama11]

Updated.

[Beeblerox]

why casting here?

[Beeblerox]

i think this pull request can be merged, but we'll need to update TiledEditor, HeatmapPathfinding, Tilemap, GridMovement and FlipRotationAnimationTiles demoes, since it makes widthInTiles and heightInTiles read-only

[Beeblerox]

and other demoes where tilemaps are used