Packagelaya.map
Classpublic class TiledMap
InheritanceTiledMap Inheritance Object

tiledMap是整个地图的核心 地图以层级来划分地图(例如:地表层,植被层,建筑层) 每层又以分块(GridSprite)来处理显示对象,只显示在视口区域的区 每块又包括N个格子(tile) 格子类型又分为动画格子跟图片格子两种



Public Properties
 PropertyDefined By
  antiCrack : Boolean = true
是否调整地块边缘消除缩放导致的缝隙
TiledMap
  autoCache : Boolean = true
是否自动缓存没有动画的地块
TiledMap
  autoCacheType : String = normal
自动缓存类型,地图较大时建议使用normal
TiledMap
  cacheAllAfterInit : Boolean = false
是否在加载完成之后cache所有大格子
TiledMap
  enableMergeLayer : Boolean = false
是否合并图层,开启合并图层时,图层属性内可添加layer属性,运行时将会将相邻的layer属性相同的图层进行合并以提高性能
TiledMap
  gridHeight : Number
[read-only] 块的高度
TiledMap
  gridWidth : Number
[read-only] 块的宽度
TiledMap
  height : int
[read-only] 地图的高度
TiledMap
  numColumnsGrid : Number
[read-only] 地图的横向块数
TiledMap
  numColumnsTile : int
[read-only] 地图横向的格子数
TiledMap
  numRowsGrid : int
[read-only] 地图的坚向块数
TiledMap
  numRowsTile : int
[read-only] 地图竖向的格子数
TiledMap
  orientation : String
[read-only] 当前地图类型
TiledMap
  removeCoveredTile : Boolean = false
是否移除被覆盖的格子,地块可添加type属性,type不为0时表示不透明,被不透明地块遮挡的地块将会被剔除以提高性能
TiledMap
  renderOrder : String
[read-only] tile渲染顺序
TiledMap
  scale : Number
得到当前地图的缩放
TiledMap
  showGridTextureCount : Boolean = false
是否显示大格子里显示的贴图数量
TiledMap
  tileHeight : int
[read-only] 格子的高度
TiledMap
  tileWidth : int
[read-only] 格子的宽度
TiledMap
  width : int
[read-only] 地图的宽度
TiledMap
  x : Number
[read-only] 地图的x坐标
TiledMap
  y : Number
[read-only] 地图的y坐标
TiledMap
Public Methods
 MethodDefined By
  
TiledMap
  
changeViewPort(moveX:Number, moveY:Number, width:Number, height:Number):void
改变视口大小
TiledMap
  
changeViewPortBySize(width:Number, height:Number, rect:Rectangle = null):Rectangle
在锚点的基础上计算,通过宽和高,重新计算视口
TiledMap
  
createMap(mapName:String, viewRect:Rectangle, completeHandler:Handler, viewRectPadding:Rectangle = null, gridSize:Point = null, enableLinear:Boolean = true, limitRange:Boolean = false):void
创建地图
TiledMap
  
destroy():void
销毁地图
TiledMap
  
通过索引得MapLayer
TiledMap
  
getLayerByName(layerName:String):MapLayer
得到指定的MapLayer
TiledMap
  
getLayerObject(layerName:String, objectName:String):GridSprite
得到对象层上的某一个物品
TiledMap
  
getMapProperties(name:String):*
得到地图的自定义属性
TiledMap
  
getSprite(index:int, width:Number, height:Number):GridSprite
通过纹理索引,生成一个可控制物件
TiledMap
  
得到一块指定的地图纹理
TiledMap
  
getTileProperties(index:int, id:int, name:String):*
得到tile自定义属性
TiledMap
  
getTileUserData(id:int, sign:String, defaultV:* = null):*
TiledMap
  
整个地图的显示容器
TiledMap
  
moveViewPort(moveX:Number, moveY:Number):void
移动视口
TiledMap
  
setViewPortPivotByScale(scaleX:Number, scaleY:Number):void
设置视口的缩放中心点(例如:scaleX= scaleY= 0.5,就是以视口中心缩放)
TiledMap
Public Constants
 ConstantDefined By
  ORIENTATION_HEXAGONAL : String = hexagonal
[static] 六边形地图
TiledMap
  ORIENTATION_ISOMETRIC : String = isometric
[static] 菱形地图
TiledMap
  ORIENTATION_ORTHOGONAL : String = orthogonal
[static] 四边形地图
TiledMap
  ORIENTATION_STAGGERED : String = staggered
[static] 45度交错地图
TiledMap
  RENDERORDER_LEFTDOWN : String = left-down
[static] 地图格子从右上角开始渲染
TiledMap
  RENDERORDER_LEFTUP : String = left-up
[static] 地图格子右下角开始渲染
TiledMap
  RENDERORDER_RIGHTDOWN : String = right-down
[static] 地图格子从左上角开始渲染
TiledMap
  RENDERORDER_RIGHTUP : String = right-up
[static] 地图格子从左下角开始渲染
TiledMap
Property Detail
antiCrackproperty
public var antiCrack:Boolean = true

是否调整地块边缘消除缩放导致的缝隙

autoCacheproperty 
public var autoCache:Boolean = true

是否自动缓存没有动画的地块

autoCacheTypeproperty 
public var autoCacheType:String = normal

自动缓存类型,地图较大时建议使用normal

cacheAllAfterInitproperty 
public var cacheAllAfterInit:Boolean = false

是否在加载完成之后cache所有大格子

enableMergeLayerproperty 
public var enableMergeLayer:Boolean = false

是否合并图层,开启合并图层时,图层属性内可添加layer属性,运行时将会将相邻的layer属性相同的图层进行合并以提高性能

gridHeightproperty 
gridHeight:Number  [read-only]

块的高度


Implementation
    public function get gridHeight():Number
gridWidthproperty 
gridWidth:Number  [read-only]

块的宽度


Implementation
    public function get gridWidth():Number
heightproperty 
height:int  [read-only]

地图的高度


Implementation
    public function get height():int
numColumnsGridproperty 
numColumnsGrid:Number  [read-only]

地图的横向块数


Implementation
    public function get numColumnsGrid():Number
numColumnsTileproperty 
numColumnsTile:int  [read-only]

地图横向的格子数


Implementation
    public function get numColumnsTile():int
numRowsGridproperty 
numRowsGrid:int  [read-only]

地图的坚向块数


Implementation
    public function get numRowsGrid():int
numRowsTileproperty 
numRowsTile:int  [read-only]

地图竖向的格子数


Implementation
    public function get numRowsTile():int
orientationproperty 
orientation:String  [read-only]

当前地图类型


Implementation
    public function get orientation():String
removeCoveredTileproperty 
public var removeCoveredTile:Boolean = false

是否移除被覆盖的格子,地块可添加type属性,type不为0时表示不透明,被不透明地块遮挡的地块将会被剔除以提高性能

renderOrderproperty 
renderOrder:String  [read-only]

tile渲染顺序


Implementation
    public function get renderOrder():String
scaleproperty 
scale:Number

得到当前地图的缩放


Implementation
    public function get scale():Number
    public function set scale(value:Number):void
showGridTextureCountproperty 
public var showGridTextureCount:Boolean = false

是否显示大格子里显示的贴图数量

tileHeightproperty 
tileHeight:int  [read-only]

格子的高度


Implementation
    public function get tileHeight():int
tileWidthproperty 
tileWidth:int  [read-only]

格子的宽度


Implementation
    public function get tileWidth():int
widthproperty 
width:int  [read-only]

地图的宽度


Implementation
    public function get width():int
xproperty 
x:Number  [read-only]

地图的x坐标


Implementation
    public function get x():Number
yproperty 
y:Number  [read-only]

地图的y坐标


Implementation
    public function get y():Number
Constructor Detail
TiledMap()Constructor
public function TiledMap()



Method Detail
changeViewPort()method
public function changeViewPort(moveX:Number, moveY:Number, width:Number, height:Number):void

改变视口大小

Parameters

moveX:Number — 视口的坐标x
 
moveY:Number — 视口的坐标y
 
width:Number — 视口的宽
 
height:Number — 视口的高

changeViewPortBySize()method 
public function changeViewPortBySize(width:Number, height:Number, rect:Rectangle = null):Rectangle

在锚点的基础上计算,通过宽和高,重新计算视口

Parameters

width:Number — 新视口宽
 
height:Number — 新视口高
 
rect:Rectangle (default = null) — 返回的结果

Returns
Rectangle
createMap()method 
public function createMap(mapName:String, viewRect:Rectangle, completeHandler:Handler, viewRectPadding:Rectangle = null, gridSize:Point = null, enableLinear:Boolean = true, limitRange:Boolean = false):void

创建地图

Parameters

mapName:String — JSON文件名字
 
viewRect:Rectangle — 视口区域
 
completeHandler:Handler — 地图创建完成的回调函数
 
viewRectPadding:Rectangle (default = null) — 视口扩充区域,把视口区域上、下、左、右扩充一下,防止视口移动时的穿帮
 
gridSize:Point (default = null) — grid大小
 
enableLinear:Boolean (default = true) — 是否开启线性取样(为false时,可以解决地图黑线的问题,但画质会锐化)
 
limitRange:Boolean (default = false) — 把地图限制在显示区域

destroy()method 
public function destroy():void

销毁地图

getLayerByIndex()method 
public function getLayerByIndex(index:int):MapLayer

通过索引得MapLayer

Parameters

index:int — 要找的层索引

Returns
MapLayer
getLayerByName()method 
public function getLayerByName(layerName:String):MapLayer

得到指定的MapLayer

Parameters

layerName:String — 要找的层名称

Returns
MapLayer
getLayerObject()method 
public function getLayerObject(layerName:String, objectName:String):GridSprite

得到对象层上的某一个物品

Parameters

layerName:String — 层的名称
 
objectName:String — 所找物品的名称

Returns
GridSprite
getMapProperties()method 
public function getMapProperties(name:String):*

得到地图的自定义属性

Parameters

name:String — 属性名称

Returns
*
getSprite()method 
public function getSprite(index:int, width:Number, height:Number):GridSprite

通过纹理索引,生成一个可控制物件

Parameters

index:int — 纹理的索引值,默认从1开始
 
width:Number
 
height:Number

Returns
GridSprite
getTexture()method 
public function getTexture(index:int):TileTexSet

得到一块指定的地图纹理

Parameters

index:int — 纹理的索引值,默认从1开始

Returns
TileTexSet
getTileProperties()method 
public function getTileProperties(index:int, id:int, name:String):*

得到tile自定义属性

Parameters

index:int — 地图块索引
 
id:int — 具体的TileSetID
 
name:String — 属性名称

Returns
*
getTileUserData()method 
public function getTileUserData(id:int, sign:String, defaultV:* = null):*

Parameters

id:int
 
sign:String
 
defaultV:* (default = null)

Returns
*
mapSprite()method 
public function mapSprite():Sprite

整个地图的显示容器

Returns
Sprite — 地图的显示容器
moveViewPort()method 
public function moveViewPort(moveX:Number, moveY:Number):void

移动视口

Parameters

moveX:Number — 视口的坐标x
 
moveY:Number — 视口的坐标y

setViewPortPivotByScale()method 
public function setViewPortPivotByScale(scaleX:Number, scaleY:Number):void

设置视口的缩放中心点(例如:scaleX= scaleY= 0.5,就是以视口中心缩放)

Parameters

scaleX:Number
 
scaleY:Number

Constant Detail
ORIENTATION_HEXAGONALConstant
public static const ORIENTATION_HEXAGONAL:String = hexagonal

六边形地图

ORIENTATION_ISOMETRICConstant 
public static const ORIENTATION_ISOMETRIC:String = isometric

菱形地图

ORIENTATION_ORTHOGONALConstant 
public static const ORIENTATION_ORTHOGONAL:String = orthogonal

四边形地图

ORIENTATION_STAGGEREDConstant 
public static const ORIENTATION_STAGGERED:String = staggered

45度交错地图

RENDERORDER_LEFTDOWNConstant 
public static const RENDERORDER_LEFTDOWN:String = left-down

地图格子从右上角开始渲染

RENDERORDER_LEFTUPConstant 
public static const RENDERORDER_LEFTUP:String = left-up

地图格子右下角开始渲染

RENDERORDER_RIGHTDOWNConstant 
public static const RENDERORDER_RIGHTDOWN:String = right-down

地图格子从左上角开始渲染

RENDERORDER_RIGHTUPConstant 
public static const RENDERORDER_RIGHTUP:String = right-up

地图格子从左下角开始渲染