TiledLayer 类型

继承于 _SGComponent

模块: cc

渲染 TMX layer。

索引

属性(properties)
  • __eventTargets Array Register all related EventTargets, all event callbacks will be removed in _onPreDestroy
  • 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 后将不可用)。
    当一个对象的 destroy 调用以后,会在这一帧结束后才真正销毁。因此从下一帧开始 isValid 就会返回 false,而当前帧内 isValid 仍然会是 true。如果希望判断当前帧是否调用过 destroy,请使用 cc.isValid(obj, true),不过这往往是特殊的业务需求引起的,通常情况下不需要这样。
方法
  • getLayerName 获取层的名称。
  • SetLayerName 设置层的名称
  • getProperty 获取指定属性名的值。
  • getPositionAt 获取指定 tile 的像素坐标。
  • removeTileAt 删除指定坐标上的 tile。
  • setTileGID 设置给定坐标的 tile 的 gid (gid = tile 全局 id), tile 的 GID 可以使用方法 “tileGIDAt” 来获得。
    如果一个 tile 已经放在那个位置,那么它将被删除。
  • getTileGIDAt 通过给定的 tile 坐标、flags(可选)返回 tile 的 GID.
    如果它返回 0,则表示该 tile 为空。
    该方法要求 tile 地图之前没有被释放过(如:没有调用过layer.releaseMap()).
  • getTileAt 通过指定的 tile 坐标获取对应的 tile(Sprite)。 返回的 tile(Sprite) 应是已经添加到 TMXLayer,请不要重复添加。
    这个 tile(Sprite) 如同其他的 Sprite 一样,可以旋转、缩放、翻转、透明化、设置颜色等。
    你可以通过调用以下方法来对它进行删除:
    1. layer.removeChild(sprite, cleanup);
    2. 或 layer.removeTileAt(cc.v2(x,y));
  • releaseMap 从内存中释放包含 tile 位置信息的地图。
    除了在运行时想要知道 tiles 的位置信息外,你都可安全的调用此方法。
    如果你之后还要调用 layer.tileGIDAt(), 请不要释放地图.
  • setContentSize 设置未转换的 layer 大小。
  • getTexture 获取纹理。
  • setTexture 设置纹理。
  • setTileOpacity 设置所有 Tile 的透明度
  • getLayerSize 获得层大小。
  • setLayerSize 设置层大小。
  • getMapTileSize 获取 tile 的大小( tile 的大小可能会有所不同)。
  • setMapTileSize 设置 tile 的大小。
  • getTiles 获取地图 tiles。
  • setTiles 设置地图 tiles
  • getTileSet 获取 layer 的 Tileset 信息。
  • setTileSet 设置 layer 的 Tileset 信息。
  • getLayerOrientation 获取 Layer 方向(同地图方向)。
  • setLayerOrientation 设置 Layer 方向(同地图方向)。
  • getProperties 获取 layer 的属性,可以使用 Tiled 编辑器添加属性。
  • setProperties 设置层属性。
  • _createSgNode Create and returns your new scene graph node (SGNode) to add to scene graph. You should call the setContentSize of the SGNode if its size should be the same with the node's.
  • _initSgNode
  • _removeSgNode
  • update 如果该组件启用,则每帧调用 update。
  • lateUpdate 如果该组件启用,则每帧调用 LateUpdate。
  • __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.
  • onLoad 当附加到一个激活的节点上或者其节点第一次激活时候调用。onLoad 总是会在任何 start 方法调用前执行,这能用于安排脚本的初始化顺序。
  • start 如果该组件第一次启用,则在所有组件的 update 之前调用。通常用于需要在所有组件的 onLoad 初始化完毕后执行的逻辑。
  • onEnable 当该组件被启用,并且它的节点也激活时。
  • onDisable 当该组件被禁用或节点变为无效时调用。
  • onDestroy 当该组件被销毁时调用
  • onFocusInEditor
  • onLostFocusInEditor
  • resetInEditor 用来初始化组件或节点的一些属性,当该组件被第一次添加到节点上或用户点击了它的 Reset 菜单时调用。这个回调只会在编辑器下调用。
  • addComponent 向节点添加一个组件类,你还可以通过传入脚本的名称来添加组件。
  • getComponent 获取节点上指定类型的组件,如果节点有附加指定类型的组件,则返回,如果没有则为空。
    传入参数也可以是脚本的名称。
  • getComponents 返回节点上指定类型的所有组件。
  • getComponentInChildren 递归查找所有子节点中第一个匹配指定类型的组件。
  • getComponentsInChildren 递归查找自身或所有子节点中指定类型的组件
  • _getLocalBounds 如果组件的包围盒与节点不同,您可以实现该方法以提供自定义的轴向对齐的包围盒(AABB), 以便编辑器的场景视图可以正确地执行点选测试。
  • onRestore onRestore 是用户在检查器菜单点击 Reset 时,对此组件执行撤消操作后调用的。

    如果组件包含了“内部状态”(不在 CCClass 属性中定义的临时成员变量),那么你可能需要实现该方法。

    编辑器执行撤销/重做操作时,将调用组件的 get set 来录制和还原组件的状态。 然而,在极端的情况下,它可能无法良好运作。
    那么你就应该实现这个方法,手动根据组件的属性同步“内部状态”。 一旦你实现这个方法,当用户撤销或重做时,组件的所有 get set 都不会再被调用。 这意味着仅仅指定了默认值的属性将被编辑器记录和还原。

    同样的,编辑可能无法在极端情况下正确地重置您的组件。
    于是如果你需要支持组件重置菜单,你需要在该方法中手工同步组件属性到“内部状态”。
    一旦你实现这个方法,组件的所有 get set 都不会在重置操作时被调用。 这意味着仅仅指定了默认值的属性将被编辑器重置。
    此方法仅在编辑器下会被调用。
  • schedule 调度一个自定义的回调函数。
    如果回调函数已调度,那么将不会重复调度它,只会更新时间间隔参数。
  • scheduleOnce 调度一个只运行一次的回调函数,可以指定 0 让回调函数在下一帧立即执行或者在一定的延时之后执行。
  • unschedule 取消调度一个自定义的回调函数。
  • unscheduleAllCallbacks 取消调度所有已调度的回调函数:定制的回调函数以及 'update' 回调函数。动作不受此方法影响。
  • destroy 销毁该对象,并释放所有它对其它对象的引用。
    实际销毁操作会延迟到当前帧渲染前执行。从下一帧开始,CCObject 将不再可用。 您可以在访问对象之前使用 cc.isValid(obj) 来检查对象是否已被销毁。
  • _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; } } }

  • _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)

__eventTargets

Register all related EventTargets, all event callbacks will be removed in _onPreDestroy

meta description
类型 Array
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:61
node

该组件被附加到的节点。组件总会附加到一个节点。

meta description
类型 Node
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:75
示例
cc.log(comp.node);
uuid

组件的 uuid,用于编辑器。

meta description
类型 String
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:111
示例
cc.log(comp.uuid);
_enabled
meta description
类型 Boolean
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:159
enabled

表示该组件自身是否启用。

meta description
类型 Boolean
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:166
示例
comp.enabled = true;
cc.log(comp.enabled);
enabledInHierarchy

表示该组件是否被启用并且所在的节点也处于激活状态。

meta description
类型 Boolean
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:197
示例
cc.log(comp.enabledInHierarchy);
_isOnLoadCalled

返回一个值用来判断 onLoad 是否被调用过,不等于 0 时调用过,等于 0 时未调用。

meta description
类型 Number
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:213
示例
cc.log(this._isOnLoadCalled > 0);
_name
meta description
类型 String
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/platform/CCObject.js:50
_objFlags
meta description
类型 Number
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/platform/CCObject.js:57
name

该对象的名称。

meta description
类型 String
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/platform/CCObject.js:208
示例
obj.name = "New Obj";
isValid

表示该对象是否可用(被 destroy 后将不可用)。
当一个对象的 destroy 调用以后,会在这一帧结束后才真正销毁。因此从下一帧开始 isValid 就会返回 false,而当前帧内 isValid 仍然会是 true。如果希望判断当前帧是否调用过 destroy,请使用 cc.isValid(obj, true),不过这往往是特殊的业务需求引起的,通常情况下不需要这样。

meta description
类型 Boolean
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/platform/CCObject.js:225
示例
var node = new cc.Node();
cc.log(node.isValid);    // true
node.destroy();
cc.log(node.isValid);    // true, still valid in this frame
// after a frame...
cc.log(node.isValid);    // false, destroyed in the end of last frame

方法

getLayerName

获取层的名称。

meta description
返回 String
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/tilemap/CCTiledLayer.js:98
示例
var layerName = tiledLayer.getLayerName();
cc.log(layerName);
SetLayerName

设置层的名称

meta description
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/tilemap/CCTiledLayer.js:114
参数列表
示例
tiledLayer.setLayerName("New Layer");
getProperty

获取指定属性名的值。

meta description
返回 Any
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/tilemap/CCTiledLayer.js:128
参数列表
示例
var property = tiledLayer.getProperty("info");
cc.log(property);
getPositionAt

获取指定 tile 的像素坐标。

meta description
返回 Vec2
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/tilemap/CCTiledLayer.js:146
参数列表
示例
var pos = tiledLayer.getPositionAt(cc.v2(0, 0));
cc.log("Pos: " + pos);
var pos = tiledLayer.getPositionAt(0, 0);
cc.log("Pos: " + pos);
removeTileAt

删除指定坐标上的 tile。

meta description
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/tilemap/CCTiledLayer.js:169
参数列表
示例
tiledLayer.removeTileAt(cc.v2(0, 0));
tiledLayer.removeTileAt(0, 0);
setTileGID

设置给定坐标的 tile 的 gid (gid = tile 全局 id), tile 的 GID 可以使用方法 “tileGIDAt” 来获得。
如果一个 tile 已经放在那个位置,那么它将被删除。

meta description
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/tilemap/CCTiledLayer.js:187
参数列表
示例
tiledLayer.setTileGID(1001, 10, 10, 1)
getTileGIDAt

通过给定的 tile 坐标、flags(可选)返回 tile 的 GID.
如果它返回 0,则表示该 tile 为空。
该方法要求 tile 地图之前没有被释放过(如:没有调用过layer.releaseMap()).

meta description
返回 Number
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/tilemap/CCTiledLayer.js:236
参数列表
示例
var tileGid = tiledLayer.getTileGIDAt(0, 0);
getTileAt

通过指定的 tile 坐标获取对应的 tile(Sprite)。 返回的 tile(Sprite) 应是已经添加到 TMXLayer,请不要重复添加。
这个 tile(Sprite) 如同其他的 Sprite 一样,可以旋转、缩放、翻转、透明化、设置颜色等。
你可以通过调用以下方法来对它进行删除:

  1. layer.removeChild(sprite, cleanup);
  2. 或 layer.removeTileAt(cc.v2(x,y));
meta description
返回 _ccsg.Sprite
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/tilemap/CCTiledLayer.js:261
参数列表
示例
var title = tiledLayer.getTileAt(100, 100);
cc.log(title);
releaseMap

从内存中释放包含 tile 位置信息的地图。
除了在运行时想要知道 tiles 的位置信息外,你都可安全的调用此方法。
如果你之后还要调用 layer.tileGIDAt(), 请不要释放地图.

meta description
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/tilemap/CCTiledLayer.js:292
示例
tiledLayer.releaseMap();
setContentSize

设置未转换的 layer 大小。

meta description
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/tilemap/CCTiledLayer.js:311
参数列表
  • size Size | Number The untransformed size of the _ccsg.TMXLayer or The untransformed size's width of the TMXLayer.
  • height Number The untransformed size's height of the _ccsg.TMXLayer.
示例
tiledLayer.setContentSize(100, 100);
getTexture

获取纹理。

meta description
返回 Texture2D
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/tilemap/CCTiledLayer.js:328
示例
var texture = tiledLayer.getTexture();
cc.log("Texture: " + texture);
setTexture

设置纹理。

meta description
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/tilemap/CCTiledLayer.js:344
参数列表
示例
tiledLayer.setTexture(texture);
setTileOpacity

设置所有 Tile 的透明度

meta description
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/tilemap/CCTiledLayer.js:358
参数列表
示例
tiledLayer.setTileOpacity(128);
getLayerSize

获得层大小。

meta description
返回 Size
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/tilemap/CCTiledLayer.js:376
示例
var size = tiledLayer.getLayerSize();
cc.log("layer size: " + size);
setLayerSize

设置层大小。

meta description
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/tilemap/CCTiledLayer.js:392
参数列表
示例
tiledLayer.setLayerSize(new cc.size(5, 5));
getMapTileSize

获取 tile 的大小( tile 的大小可能会有所不同)。

meta description
返回 Size
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/tilemap/CCTiledLayer.js:406
示例
var mapTileSize = tiledLayer.getMapTileSize();
cc.log("MapTile size: " + mapTileSize);
setMapTileSize

设置 tile 的大小。

meta description
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/tilemap/CCTiledLayer.js:422
参数列表
示例
tiledLayer.setMapTileSize(new cc.size(10, 10));
getTiles

获取地图 tiles。

meta description
返回 Array
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/tilemap/CCTiledLayer.js:436
示例
var tiles = tiledLayer.getTiles();
setTiles

设置地图 tiles

meta description
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/tilemap/CCTiledLayer.js:451
参数列表
示例
tiledLayer.setTiles(tiles);
getTileSet

获取 layer 的 Tileset 信息。

meta description
返回 TMXTilesetInfo
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/tilemap/CCTiledLayer.js:465
示例
var tileset = tiledLayer.getTileSet();
setTileSet

设置 layer 的 Tileset 信息。

meta description
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/tilemap/CCTiledLayer.js:480
参数列表
  • tileset TMXTilesetInfo
示例
tiledLayer.setTileSet(tileset);
getLayerOrientation

获取 Layer 方向(同地图方向)。

meta description
返回 Number
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/tilemap/CCTiledLayer.js:494
示例
var orientation = tiledLayer.getLayerOrientation();
cc.log("Layer Orientation: " + orientation);
setLayerOrientation

设置 Layer 方向(同地图方向)。

meta description
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/tilemap/CCTiledLayer.js:510
参数列表
示例
tiledLayer.setLayerOrientation(TiledMap.Orientation.ORTHO);
getProperties

获取 layer 的属性,可以使用 Tiled 编辑器添加属性。

meta description
返回 Array
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/tilemap/CCTiledLayer.js:524
示例
var properties = tiledLayer.getProperties();
cc.log("Properties: " + properties);
setProperties

设置层属性。

meta description
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/tilemap/CCTiledLayer.js:540
参数列表
示例
tiledLayer.setLayerOrientation(properties);
_createSgNode

Create and returns your new scene graph node (SGNode) to add to scene graph. You should call the setContentSize of the SGNode if its size should be the same with the node's.

meta description
返回 _ccsg.Node
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCSGComponent.js:65
_initSgNode
meta description
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCSGComponent.js:75
_removeSgNode
meta description
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCSGComponent.js:81
update

如果该组件启用,则每帧调用 update。

meta description
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:234
参数列表
  • dt Number the delta time in seconds it took to complete the last frame
lateUpdate

如果该组件启用,则每帧调用 LateUpdate。

meta description
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:243
__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
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:251
onLoad

当附加到一个激活的节点上或者其节点第一次激活时候调用。onLoad 总是会在任何 start 方法调用前执行,这能用于安排脚本的初始化顺序。

meta description
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:262
start

如果该组件第一次启用,则在所有组件的 update 之前调用。通常用于需要在所有组件的 onLoad 初始化完毕后执行的逻辑。

meta description
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:273
onEnable

当该组件被启用,并且它的节点也激活时。

meta description
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:284
onDisable

当该组件被禁用或节点变为无效时调用。

meta description
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:292
onDestroy

当该组件被销毁时调用

meta description
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:300
onFocusInEditor
meta description
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:308
onLostFocusInEditor
meta description
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:313
resetInEditor

用来初始化组件或节点的一些属性,当该组件被第一次添加到节点上或用户点击了它的 Reset 菜单时调用。这个回调只会在编辑器下调用。

meta description
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:318
addComponent

向节点添加一个组件类,你还可以通过传入脚本的名称来添加组件。

meta description
返回 Component
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:328
参数列表
  • 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
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:346
参数列表
示例
// get sprite component.
var sprite = node.getComponent(cc.Sprite);
// get custom test calss.
var test = node.getComponent("Test");
getComponents

返回节点上指定类型的所有组件。

meta description
返回 Component[]
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:370
参数列表
示例
var sprites = node.getComponents(cc.Sprite);
var tests = node.getComponents("Test");
getComponentInChildren

递归查找所有子节点中第一个匹配指定类型的组件。

meta description
返回 Component
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:388
参数列表
示例
var sprite = node.getComponentInChildren(cc.Sprite);
var Test = node.getComponentInChildren("Test");
getComponentsInChildren

递归查找自身或所有子节点中指定类型的组件

meta description
返回 Component[]
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:406
参数列表
示例
var sprites = node.getComponentsInChildren(cc.Sprite);
var tests = node.getComponentsInChildren("Test");
_getLocalBounds

如果组件的包围盒与节点不同,您可以实现该方法以提供自定义的轴向对齐的包围盒(AABB), 以便编辑器的场景视图可以正确地执行点选测试。

meta description
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:426
参数列表
  • out_rect Rect the Rect to receive the bounding box
onRestore

onRestore 是用户在检查器菜单点击 Reset 时,对此组件执行撤消操作后调用的。

如果组件包含了“内部状态”(不在 CCClass 属性中定义的临时成员变量),那么你可能需要实现该方法。

编辑器执行撤销/重做操作时,将调用组件的 get set 来录制和还原组件的状态。 然而,在极端的情况下,它可能无法良好运作。
那么你就应该实现这个方法,手动根据组件的属性同步“内部状态”。 一旦你实现这个方法,当用户撤销或重做时,组件的所有 get set 都不会再被调用。 这意味着仅仅指定了默认值的属性将被编辑器记录和还原。

同样的,编辑可能无法在极端情况下正确地重置您的组件。
于是如果你需要支持组件重置菜单,你需要在该方法中手工同步组件属性到“内部状态”。
一旦你实现这个方法,组件的所有 get set 都不会在重置操作时被调用。 这意味着仅仅指定了默认值的属性将被编辑器重置。
此方法仅在编辑器下会被调用。

meta description
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:439
schedule

调度一个自定义的回调函数。
如果回调函数已调度,那么将不会重复调度它,只会更新时间间隔参数。

meta description
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:541
参数列表
  • callback function The callback function
  • interval 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
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:578
参数列表
  • callback function A function wrapped as a selector
  • delay 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
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:595
参数列表
  • callback_fn function A function wrapped as a selector
示例
this.unschedule(_callback);
unscheduleAllCallbacks

取消调度所有已调度的回调函数:定制的回调函数以及 'update' 回调函数。动作不受此方法影响。

meta description
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:611
示例
this.unscheduleAllCallbacks();
destroy

销毁该对象,并释放所有它对其它对象的引用。
实际销毁操作会延迟到当前帧渲染前执行。从下一帧开始,CCObject 将不再可用。 您可以在访问对象之前使用 cc.isValid(obj) 来检查对象是否已被销毁。

meta description
返回 Boolean
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/platform/CCObject.js:260
示例
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
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/platform/CCObject.js:392
_onPreDestroy

Called before the object being destroyed.

meta description
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/platform/CCObject.js:425
_serialize

The customized serialization for this object. (Editor Only)

meta description
返回 object
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/platform/CCObject.js:450
参数列表
_deserialize

Init this object from the custom serialized data.

meta description
定义于 https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/platform/CCObject.js:460
参数列表
  • data Object the serialized json data
  • ctx _Deserializer

results matching ""

    No results matching ""