Skip to content

Commit c9fa7ee

Browse files
committed
cleanup and heaps sample
1 parent c0534e5 commit c9fa7ee

File tree

1 file changed

+51
-2
lines changed

1 file changed

+51
-2
lines changed

README.md

Lines changed: 51 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ PyxelEdit-Map-Importer
33

44
___Available via [haxelib](http://lib.haxe.org/p/pmi/)___
55

6-
**Pyxel Edit** map parser for haxe. With **OpenFL and Luxe helpers**.
6+
**Pyxel Edit** map parser for haxe. With **OpenFL, Heaps and Luxe helpers**.
77

88
![Pyxel Edit + flash version](http://i.imgur.com/SSux3u6.png)
99

@@ -107,7 +107,7 @@ class Main extends Sprite
107107

108108
# Luxe helper
109109

110-
You can make use of `pmi.LuxeHelper` to get a tilemap object and and fill the tilelayers easily.
110+
You can make use of `pmi.LuxeHelper` to get a `Tilemap` object and and fill the tilelayers easily.
111111

112112
* `var tilemap = LuxeHelper.getTilemap('assets/tileset.png');` will return a `Tilemap` object.
113113
* `LuxeHelper.fillLayer(tilemap, background);` will add the appropriate tilelayer to the tilemap.
@@ -143,3 +143,52 @@ class Main extends luxe.Game
143143
}
144144
}
145145
```
146+
147+
# Heaps helper
148+
149+
You can make use of `pmi.HeapsHelper` to get a `TileSet` and `TileGroup` object.
150+
151+
* `var tileSet = HeapsHelper.getTileSet("tileset.png");` will return a `TileSet` object.
152+
* `var backgroundTileGroup = HeapsHelper.getTileGroup(background, tileSet);` will return a `TileGroup` object.
153+
154+
and that's all you need.
155+
156+
_**Note** that to load a heaps asset (the pyxel xml map) you would need `new PyxelMapImporter(hxd.Res.loader.load("map.xml").toText());` here._
157+
158+
## Example
159+
160+
It will load three different layers and draw them on screen.
161+
162+
```Haxe
163+
import pmi.PyxelMapImporter;
164+
import pmi.HeapsHelper;
165+
166+
167+
class Main extends hxd.App
168+
{
169+
override function init()
170+
{
171+
172+
var pyxelMap = new PyxelMapImporter(hxd.Res.loader.load("map.xml").toText());
173+
var tileSet = HeapsHelper.getTileSet("tileset.png");
174+
175+
var background = pyxelMap.getDatasFromLayer("background");
176+
var walls = pyxelMap.getDatasFromLayer("walls");
177+
var objects = pyxelMap.getDatasFromLayer("objects");
178+
179+
var backgroundTileGroup = HeapsHelper.getTileGroup(background, tileSet);
180+
var wallsTileGroup = HeapsHelper.getTileGroup(walls, tileSet);
181+
var objectsTileGroup = HeapsHelper.getTileGroup(objects, tileSet);
182+
183+
s2d.addChild(backgroundTileGroup);
184+
s2d.addChild(wallsTileGroup);
185+
s2d.addChild(objectsTileGroup);
186+
}
187+
188+
public static function main()
189+
{
190+
hxd.Res.initEmbed();
191+
new Main();
192+
}
193+
}
194+
```

0 commit comments

Comments
 (0)