Class Index | File Index

Classes


Class cc.TMXMapInfo


Extends cc.SAXParser.

Defined in: CCTMXXMLParser.js.

Class Summary
Constructor Attributes Constructor Name and Description
 

cc.TMXMapInfo contains the information about the map like:
- Map orientation (hexagonal, isometric or orthogonal)
- Tile size
- Map size

And it also contains:
- Layers (an array of TMXLayerInfo objects)
- Tilesets (an array of TMXTilesetInfo objects)
- ObjectGroups (an array of TMXObjectGroupInfo objects)

This information is obtained from the TMX file.

Method Summary
Method Attributes Method Name and Description
<static>  
cc.TMXMapInfo.create(tmxFile, resourcePath)
Creates a TMX Format with a tmx file
 
ctor()
 
 
layer attribute
 
Layers
 
Map width & height
 
ObjectGroups
 
 
parent element
 
parent GID
 
Properties
 
is string characters?
 
 
tilesets
 
Tiles width & height
 
 
initWithTMXFile(tmxFile, resourcePath)
Initializes a TMX format with a tmx file
 
parseXMLFile(tmxFile)
Initalises parsing of an XML file, either a tmx (Map) file or tsx (Tileset) file
 
setCurrentString(currentString)
 
 
setLayers(Var)
 
 
 
 
 
 
 
 
setTileProperties(tileProperties)
 
 
 
setTMXFileName(fileName)
Methods borrowed from class cc.SAXParser:
getExt, getList, getName, parse, preloadPlist, tmxParse
Class Detail
cc.TMXMapInfo()

cc.TMXMapInfo contains the information about the map like:
- Map orientation (hexagonal, isometric or orthogonal)
- Tile size
- Map size

And it also contains:
- Layers (an array of TMXLayerInfo objects)
- Tilesets (an array of TMXTilesetInfo objects)
- ObjectGroups (an array of TMXObjectGroupInfo objects)

This information is obtained from the TMX file.

Method Detail
<static> {cc.TMXMapInfo} cc.TMXMapInfo.create(tmxFile, resourcePath)
Creates a TMX Format with a tmx file
Parameters:
{String} tmxFile
{String} resourcePath
Returns:
{cc.TMXMapInfo}

ctor()

{String} getCurrentString()
Returns:
{String}

{Number} getLayerAttribs()
layer attribute
Returns:
{Number}

{Array} getLayers()
Layers
Returns:
{Array}

{cc.Size} getMapSize()
Map width & height
Returns:
{cc.Size}

{Array} getObjectGroups()
ObjectGroups
Returns:
{Array}

{Number} getOrientation()
Returns:
{Number}

{Number} getParentElement()
parent element
Returns:
{Number}

{Number} getParentGID()
parent GID
Returns:
{Number}

{Array} getProperties()
Properties
Returns:
{Array}

{Boolean} getStoringCharacters()
is string characters?
Returns:
{Boolean}

{object} getTileProperties()
Returns:
{object}

{Array} getTilesets()
tilesets
Returns:
{Array}

{cc.Size} getTileSize()
Tiles width & height
Returns:
{cc.Size}

{String} getTMXFileName()
Returns:
{String}

{String} initWithTMXFile(tmxFile, resourcePath)
Initializes a TMX format with a tmx file
Parameters:
{String} tmxFile
resourcePath
Returns:
{String}

{Element} parseXMLFile(tmxFile)
Initalises parsing of an XML file, either a tmx (Map) file or tsx (Tileset) file
Parameters:
{String} tmxFile
Returns:
{Element}

setCurrentString(currentString)
Parameters:
{String} currentString

setLayerAttribs(Var)
Parameters:
{Number} Var

setLayers(Var)
Parameters:
{cc.TMXLayerInfo} Var

setMapSize(Var)
Parameters:
{cc.Size} Var

setObjectGroups(Var)
Parameters:
{cc.TMXObjectGroup} Var

setOrientation(Var)
Parameters:
{Number} Var

setParentElement(Var)
Parameters:
{Number} Var

setParentGID(Var)
Parameters:
{Number} Var

setProperties(Var)
Parameters:
{object} Var

setStoringCharacters(Var)
Parameters:
{Boolean} Var

setTileProperties(tileProperties)
Parameters:
{object} tileProperties

setTilesets(Var)
Parameters:
{cc.TMXTilesetInfo} Var

setTileSize(Var)
Parameters:
{cc.Size} Var

setTMXFileName(fileName)
Parameters:
{String} fileName

Documentation generated by JsDoc Toolkit 2.4.0 on Wed Jan 09 2013 07:51:54 GMT-0800 (PST)