TiledMap 类型 Details属性(properties)tmxAsset __eventTargets node 示例 uuid 示例 _enabled enabled 示例 enabledInHierarchy 示例 _isOnLoadCalled 示例 _name _objFlags name 示例 isValid 示例 方法getMapSize 示例 getTileSize 示例 getMapOrientation 示例 getObjectGroups 示例 getObjectGroup 示例 getProperties 示例 getLayers 示例 getLayer 示例 getProperty 示例 getPropertiesForGID 示例 update lateUpdate __preload onLoad start onEnable onDisable onDestroy onFocusInEditor onLostFocusInEditor resetInEditor addComponent 示例 getComponent 示例 getComponents 示例 getComponentInChildren 示例 getComponentsInChildren 示例 _getLocalBounds onRestore schedule 示例 scheduleOnce 示例 unschedule 示例 unscheduleAllCallbacks 示例 destroy 示例 _destruct _onPreDestroy _serialize _deserialize TiledMap 类型 继承于 Component
模块: cc
在场景中渲染一个 tmx 格式的 Tile Map。
索引 属性(properties)
tmxAsset
TiledMapAsset
TiledMap 资源。__eventTargets
Array
Register all related EventTargets,…node
Node
该组件被附加到的节点。uuid
String
组件的 uuid,用于编辑器。_enabled
Boolean
enabled
Boolean
表示该组件自身是否启用。enabledInHierarchy
Boolean
表示该组件是否被启用并且所在的节点也处于激活状态。_isOnLoadCalled
Number
返回一个值用来判断 onLoad 是否被调用过,不等于 0 时调用过,等于 0 时未调用。_name
String
_objFlags
Number
name
String
该对象的名称。isValid
Boolean
表示该对象是否可用(被 destroy 后将不可用)。
方法
getMapSize
获取地图大小。getTileSize
获取地图背景中 tile 元素的大小。getMapOrientation
获取地图方向。getObjectGroups
获取所有的对象层。getObjectGroup
获取指定的 TMXObjectGroup。getProperties
获取地图的属性。getLayers
返回包含所有 layer 的数组。getLayer
获取指定名称的 layer。getProperty
通过属性名称,获取指定的属性。getPropertiesForGID
通过 GID ,获取指定的属性。update
如果该组件启用,则每帧调用 update。lateUpdate
如果该组件启用,则每帧调用 LateUpdate。__preload
__preload
is called before every onLoad….onLoad
当附加到一个激活的节点上或者其节点第一次激活时候调用。start
如果该组件第一次启用,则在所有组件的 update 之前调用。onEnable
当该组件被启用,并且它的节点也激活时。onDisable
当该组件被禁用或节点变为无效时调用。onDestroy
该方法为生命周期方法,父类未必会有实现。onFocusInEditor
onLostFocusInEditor
resetInEditor
用来初始化组件或节点的一些属性,当该组件被第一次添加到节点上或用户点击了它的 Reset 菜单时调用。addComponent
向节点添加一个组件类,你还可以通过传入脚本的名称来添加组件。getComponent
获取节点上指定类型的组件,如果节点有附加指定类型的组件,则返回,如果没有则为空。getComponents
返回节点上指定类型的所有组件。getComponentInChildren
递归查找所有子节点中第一个匹配指定类型的组件。getComponentsInChildren
递归查找自身或所有子节点中指定类型的组件_getLocalBounds
以便编辑器的场景视图可以正确地执行点选测试。onRestore
onRestore 是用户在检查器菜单点击 Reset 时,对此组件执行撤消操作后调用的。schedule
调度一个自定义的回调函数。scheduleOnce
调度一个只运行一次的回调函数,可以指定 0 让回调函数在下一帧立即执行或者在一定的延时之后执行。unschedule
取消调度一个自定义的回调函数。unscheduleAllCallbacks
取消调度所有已调度的回调函数:定制的回调函数以及 'update' 回调函数。destroy
销毁该对象,并释放所有它对其它对象的引用。_destruct
Clear all references in the instance…._onPreDestroy
Called before the object being destroyed._serialize
The customized serialization for this object. (Editor Only)_deserialize
Init this object from the custom serialized data.
Details 属性(properties) tmxAsset TiledMap 资源。
meta description 类型 TiledMapAsset 定义于 cocos2d/tilemap/CCTiledMap.js:253
__eventTargets Register all related EventTargets,all event callbacks will be removed in _onPreDestroy
meta description 类型 Array 定义于 cocos2d/core/components/CCComponent.js:61
node 该组件被附加到的节点。组件总会附加到一个节点。
meta description 类型 Node 定义于 cocos2d/core/components/CCComponent.js:75
示例 复制代码cc . log ( comp . node );
uuid 组件的 uuid,用于编辑器。
meta description 类型 String 定义于 cocos2d/core/components/CCComponent.js:106
示例 复制代码cc . log ( comp . uuid );
_enabled
meta description 类型 Boolean 定义于 cocos2d/core/components/CCComponent.js:147
enabled 表示该组件自身是否启用。
meta description 类型 Boolean 定义于 cocos2d/core/components/CCComponent.js:154
示例 复制代码comp . enabled = true ;
cc . log ( comp . enabled );
enabledInHierarchy 表示该组件是否被启用并且所在的节点也处于激活状态。
meta description 类型 Boolean 定义于 cocos2d/core/components/CCComponent.js:185
示例 复制代码cc . log ( comp . enabledInHierarchy );
_isOnLoadCalled 返回一个值用来判断 onLoad 是否被调用过,不等于 0 时调用过,等于 0 时未调用。
meta description 类型 Number 定义于 cocos2d/core/components/CCComponent.js:201
示例 复制代码cc . log ( this . _isOnLoadCalled > 0 );
_name
meta description 类型 String 定义于 cocos2d/core/platform/CCObject.js:76
_objFlags
meta description 类型 Number 定义于 cocos2d/core/platform/CCObject.js:83
name 该对象的名称。
meta description 类型 String 定义于 cocos2d/core/platform/CCObject.js:243
示例 复制代码obj . name = "New Obj" ;
isValid 表示该对象是否可用(被 destroy 后将不可用)。当一个对象的 destroy
调用以后,会在这一帧结束后才真正销毁。因此从下一帧开始 isValid
就会返回 false,而当前帧内 isValid
仍然会是 true。如果希望判断当前帧是否调用过 destroy
,请使用 cc.isValid(obj, true)
,不过这往往是特殊的业务需求引起的,通常情况下不需要这样。
meta description 类型 Boolean 定义于 cocos2d/core/platform/CCObject.js:261
示例 复制代码var node = new cc . Node ();
cc . log ( node . isValid );
node . destroy ();
cc . log ( node . isValid ); // true , still valid in this frame
cc . log ( node . isValid ); // false , destroyed in the end of last frame
方法 getMapSize 获取地图大小。
meta description 返回 Size 定义于 cocos2d/tilemap/CCTiledMap.js:273
示例 复制代码let mapSize = tiledMap . getMapSize ();
cc . log ( "Map Size: " + mapSize );
getTileSize 获取地图背景中 tile 元素的大小。
meta description 返回 Size 定义于 cocos2d/tilemap/CCTiledMap.js:286
示例 复制代码let tileSize = tiledMap . getTileSize ();
cc . log ( "Tile Size: " + tileSize );
getMapOrientation 获取地图方向。
meta description 返回 Number 定义于 cocos2d/tilemap/CCTiledMap.js:299
示例 复制代码let mapOrientation = tiledMap . getMapOrientation ();
cc . log ( "Map Orientation: " + mapOrientation );
getObjectGroups 获取所有的对象层。
meta description 返回 TiledObjectGroup[] 定义于 cocos2d/tilemap/CCTiledMap.js:312
示例 复制代码let objGroups = titledMap . getObjectGroups ();
for ( let i = 0 ; i < objGroups . length ; ++ i ) {
cc . log ( "obj: " + objGroups [ i ]);
}
getObjectGroup 获取指定的 TMXObjectGroup。
meta description 返回 TiledObjectGroup 定义于 cocos2d/tilemap/CCTiledMap.js:327
参数列表
示例 复制代码let group = titledMap . getObjectGroup ( "Players" );
cc . log ( "ObjectGroup: " + group );
getProperties 获取地图的属性。
meta description 返回 Object[] 定义于 cocos2d/tilemap/CCTiledMap.js:349
示例 复制代码let properties = titledMap . getProperties ();
for ( let i = 0 ; i < properties . length ; ++ i ) {
cc . log ( "Properties: " + properties [ i ]);
}
getLayers 返回包含所有 layer 的数组。
meta description 返回 TiledLayer[] 定义于 cocos2d/tilemap/CCTiledMap.js:364
示例 复制代码let layers = titledMap . allLayers ();
for ( let i = 0 ; i < layers . length ; ++ i ) {
cc . log ( "Layers: " + layers [ i ]);
}
getLayer 获取指定名称的 layer。
meta description 返回 TiledLayer 定义于 cocos2d/tilemap/CCTiledMap.js:379
参数列表
示例 复制代码let layer = titledMap . getLayer ( "Player" );
cc . log ( layer );
getProperty 通过属性名称,获取指定的属性。
meta description 返回 String 定义于 cocos2d/tilemap/CCTiledMap.js:401
参数列表
示例 复制代码let property = titledMap . getProperty ( "info" );
cc . log ( "Property: " + property );
getPropertiesForGID 通过 GID ,获取指定的属性。
meta description 返回 Object 定义于 cocos2d/tilemap/CCTiledMap.js:415
参数列表
示例 复制代码let properties = titledMap . getPropertiesForGID ( GID );
cc . log ( "Properties: " + properties );
update 如果该组件启用,则每帧调用 update。该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。
meta description 定义于 cocos2d/core/components/CCComponent.js:222
参数列表
dt
Number the delta time in seconds it took to complete the last frame
lateUpdate 如果该组件启用,则每帧调用 LateUpdate。该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。
meta description 定义于 cocos2d/core/components/CCComponent.js:233
__preload __preload
is called before every onLoad.It is used to initialize the builtin components internally,to avoid checking whether onLoad is called before every public method calls.This method should be removed if script priority is supported.
meta description 定义于 cocos2d/core/components/CCComponent.js:243
onLoad 当附加到一个激活的节点上或者其节点第一次激活时候调用。onLoad 总是会在任何 start 方法调用前执行,这能用于安排脚本的初始化顺序。该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。
meta description 定义于 cocos2d/core/components/CCComponent.js:254
start 如果该组件第一次启用,则在所有组件的 update 之前调用。通常用于需要在所有组件的 onLoad 初始化完毕后执行的逻辑。该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。
meta description 定义于 cocos2d/core/components/CCComponent.js:267
onEnable 当该组件被启用,并且它的节点也激活时。该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。
meta description 定义于 cocos2d/core/components/CCComponent.js:280
onDisable 当该组件被禁用或节点变为无效时调用。该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。
meta description 定义于 cocos2d/core/components/CCComponent.js:290
onDestroy 当该组件被销毁时调用该方法为生命周期方法,父类未必会有实现。并且你只能在该方法内部调用父类的实现,不可在其它地方直接调用该方法。
meta description 定义于 cocos2d/core/components/CCComponent.js:300
onFocusInEditor meta description 定义于 cocos2d/core/components/CCComponent.js:310
onLostFocusInEditor meta description 定义于 cocos2d/core/components/CCComponent.js:315
resetInEditor 用来初始化组件或节点的一些属性,当该组件被第一次添加到节点上或用户点击了它的 Reset 菜单时调用。这个回调只会在编辑器下调用。
meta description 定义于 cocos2d/core/components/CCComponent.js:320
addComponent 向节点添加一个组件类,你还可以通过传入脚本的名称来添加组件。
meta description 返回 Component 定义于 cocos2d/core/components/CCComponent.js:330
参数列表
typeOrClassName
Function | String the constructor or the class name of the component to add
示例 复制代码var sprite = node . addComponent ( cc . Sprite );
var test = node . addComponent ( "Test" );
getComponent 获取节点上指定类型的组件,如果节点有附加指定类型的组件,则返回,如果没有则为空。传入参数也可以是脚本的名称。
meta description 返回 Component 定义于 cocos2d/core/components/CCComponent.js:348
参数列表
typeOrClassName
Function | String
示例 复制代码
var sprite = node . getComponent ( cc . Sprite );
// get custom test calss.
var test = node . getComponent ( "Test" );
getComponents 返回节点上指定类型的所有组件。
meta description 返回 Component[] 定义于 cocos2d/core/components/CCComponent.js:372
参数列表
typeOrClassName
Function | String
示例 复制代码var sprites = node . getComponents ( cc . Sprite );
var tests = node . getComponents ( "Test" );
getComponentInChildren 递归查找所有子节点中第一个匹配指定类型的组件。
meta description 返回 Component 定义于 cocos2d/core/components/CCComponent.js:390
参数列表
typeOrClassName
Function | String
示例 复制代码var sprite = node . getComponentInChildren ( cc . Sprite );
var Test = node . getComponentInChildren ( "Test" );
getComponentsInChildren 递归查找自身或所有子节点中指定类型的组件
meta description 返回 Component[] 定义于 cocos2d/core/components/CCComponent.js:408
参数列表
typeOrClassName
Function | String
示例 复制代码var sprites = node . getComponentsInChildren ( cc . Sprite );
var tests = node . getComponentsInChildren ( "Test" );
_getLocalBounds 如果组件的包围盒与节点不同,您可以实现该方法以提供自定义的轴向对齐的包围盒(AABB),以便编辑器的场景视图可以正确地执行点选测试。
meta description 定义于 cocos2d/core/components/CCComponent.js:428
参数列表
out_rect
Rect the Rect to receive the bounding box
onRestore onRestore 是用户在检查器菜单点击 Reset 时,对此组件执行撤消操作后调用的。如果组件包含了“内部状态”(不在 CCClass 属性中定义的临时成员变量),那么你可能需要实现该方法。编辑器执行撤销/重做操作时,将调用组件的 get set 来录制和还原组件的状态。然而,在极端的情况下,它可能无法良好运作。那么你就应该实现这个方法,手动根据组件的属性同步“内部状态”。一旦你实现这个方法,当用户撤销或重做时,组件的所有 get set 都不会再被调用。这意味着仅仅指定了默认值的属性将被编辑器记录和还原。同样的,编辑可能无法在极端情况下正确地重置您的组件。于是如果你需要支持组件重置菜单,你需要在该方法中手工同步组件属性到“内部状态”。一旦你实现这个方法,组件的所有 get set 都不会在重置操作时被调用。这意味着仅仅指定了默认值的属性将被编辑器重置。此方法仅在编辑器下会被调用。
meta description 定义于 cocos2d/core/components/CCComponent.js:441
schedule 调度一个自定义的回调函数。如果回调函数已调度,那么将不会重复调度它,只会更新时间间隔参数。
meta description 定义于 cocos2d/core/components/CCComponent.js:535
参数列表
callback
function The callback functioninterval
Number Tick interval in seconds. 0 means tick every frame.repeat
Number The selector will be executed (repeat + 1) times, you can use cc.macro.REPEAT_FOREVER for tick infinitely.delay
Number The amount of time that the first tick will wait before execution.
示例 复制代码var timeCallback = function ( dt ) {
cc . log ( "time: " + dt );
}
this . schedule ( timeCallback , 1 );
scheduleOnce 调度一个只运行一次的回调函数,可以指定 0 让回调函数在下一帧立即执行或者在一定的延时之后执行。
meta description 定义于 cocos2d/core/components/CCComponent.js:572
参数列表
callback
function A function wrapped as a selectordelay
Number The amount of time that the first tick will wait before execution.
示例 复制代码var timeCallback = function ( dt ) {
cc . log ( "time: " + dt );
}
this . scheduleOnce ( timeCallback , 2 );
unschedule 取消调度一个自定义的回调函数。
meta description 定义于 cocos2d/core/components/CCComponent.js:589
参数列表
callback_fn
function A function wrapped as a selector
示例 复制代码this . unschedule ( _callback );
unscheduleAllCallbacks 取消调度所有已调度的回调函数:定制的回调函数以及 'update' 回调函数。动作不受此方法影响。
meta description 定义于 cocos2d/core/components/CCComponent.js:605
示例 复制代码this . unscheduleAllCallbacks ();
destroy 销毁该对象,并释放所有它对其它对象的引用。实际销毁操作会延迟到当前帧渲染前执行。从下一帧开始,该对象将不再可用。您可以在访问对象之前使用 cc.isValid(obj) 来检查对象是否已被销毁。
meta description 返回 Boolean 定义于 cocos2d/core/platform/CCObject.js:296
示例 复制代码obj . destroy ();
_destruct Clear all references in the instance.
NOTE: this method will not clear the getter or setter functions which defined in the instance of CCObject. You can override the _destruct method if you need, for example: _destruct: function () { for (var key in this) { if (this.hasOwnProperty(key)) { switch (typeof this[key]) { case 'string': this[key] = ''; break; case 'object': case 'function': this[key] = null; break; } } }
meta description 定义于 cocos2d/core/platform/CCObject.js:430
_onPreDestroy Called before the object being destroyed.
meta description 定义于 cocos2d/core/platform/CCObject.js:463
_serialize The customized serialization for this object. (Editor Only)
meta description 返回 object 定义于 cocos2d/core/platform/CCObject.js:488
参数列表
_deserialize Init this object from the custom serialized data.
meta description 定义于 cocos2d/core/platform/CCObject.js:498
参数列表
data
Object the serialized json datactx
_Deserializer