~~NOTOC~~

====== TMX Maps ======

---- dataentry extension ----
author_mail   : felipe@felipeborgiani.com Felipe Borgiani
description   : Load and display TMX tilemaps in a Starling game
lastupdate_dt : 2013-06-23 # the date you created the extension
compatible    : v1.3       # the Starling version you tested the extension with
depends       :            # if the ext. depends on others, list them here
tags          : tilemap,TMX,tiled,mapeditor
homepage_url  : http://github.com/pachilo/TMX_Starling
download_url  : http://github.com/pachilo/TMX_Starling/archive/master.zip
----

===== Overview =====

This extension is based on the one created by [[http://wiki.starling-framework.org/extensions/tmx_loader|Shaun Mitchell]], and allows a starling game to load and display a TMX Tilemap created using [[http://mapeditor.org|Tiled]]

The major contributions include:
  * Compatible with Starling v1.3
  * Target is Tiled v0.9.0
  * Ability to use tilesets with margins and spacing
  * Improved performance by using flattened sprites
  * Added support for properties
  * Added support for Objects and ObjectGroups
  * more to come...

This extension is still under development. If you want to contribute, feel free to help out at GitHub: [[http://github.com/pachilo/TMX_Starling]]

**Known issues:**
  * Can't load tilemaps that use a TSX tileset


===== Examples =====
There is an example project included with the extension. Here's an example:

Loading your tilemap using embedded assets and displaying it:
<code as3>
[Embed(source="../../../../assets/example.tmx", mimeType="application/octet-stream")]
private static var exampleTMX:Class;

[Embed(source = "../../../../assets/tmw_desert_spacing.png")]
private static var exampleTileSet:Class;

// (...)

var mapXML:XML = XML(new exampleTMX());
var tilesets:Vector.<Bitmap> = new Vector.<Bitmap>();
tilesets.push(Bitmap(new exampleTileSet()));

var mapTMX:TMXTileMap = TMXTileMap.createMap(mapXML, tilesets);

for (var i:int = 0; i < mapTMX.layers.length; i++)
{
    addChild(mapTMX.layers[i].layerSprite);
}
</code>
===== Changelog =====

  * //2013/07/10 08:42//: Added support for Objects and Properties
  * //2013/06/23 11:44//: Updated examples.
  * //2013/06/23 00:54//: Removed dynamic map loading. Added support for other TMX object types.
  * //2013/06/22 15:48//: First public version

===== Source Code =====

All source code is avaliable at [[http://github.com/pachilo/TMX_Starling|GitHub]]

===== User Comments =====

//Feel free to edit this part of the page!//