TiledLayer Class

Extends Component

Module: cc

Render the TMX layer.

Index

Properties
  • __eventTargets Array Register all related EventTargets,...
  • node Node The node this component is attached to.
  • uuid String The uuid for editor.
  • _enabled Boolean
  • enabled Boolean indicates whether this component is enabled or not.
  • enabledInHierarchy Boolean indicates whether this component is enabled and its node is also active in the hierarchy.
  • _isOnLoadCalled Number Returns a value which used to indicate the onLoad get called or not.
  • _name String
  • _objFlags Number
  • name String The name of the object.
  • isValid Boolean Indicates whether the object is not yet destroyed.
Methods

Details

Properties

__eventTargets

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

meta description
Type Array
Defined in cocos2d/core/components/CCComponent.js:61
node

The node this component is attached to. A component is always attached to a node.

meta description
Type Node
Defined in cocos2d/core/components/CCComponent.js:75
Examples
cc.log(comp.node);
uuid

The uuid for editor.

meta description
Type String
Defined in cocos2d/core/components/CCComponent.js:106
Examples
cc.log(comp.uuid);
_enabled
meta description
Type Boolean
Defined in cocos2d/core/components/CCComponent.js:147
enabled

indicates whether this component is enabled or not.

meta description
Type Boolean
Defined in cocos2d/core/components/CCComponent.js:154
Examples
comp.enabled = true;
cc.log(comp.enabled);
enabledInHierarchy

indicates whether this component is enabled and its node is also active in the hierarchy.

meta description
Type Boolean
Defined in cocos2d/core/components/CCComponent.js:186
Examples
cc.log(comp.enabledInHierarchy);
_isOnLoadCalled

Returns a value which used to indicate the onLoad get called or not.

meta description
Type Number
Defined in cocos2d/core/components/CCComponent.js:202
Examples
cc.log(this._isOnLoadCalled > 0);
_name
meta description
Type String
Defined in cocos2d/core/platform/CCObject.js:76
_objFlags
meta description
Type Number
Defined in cocos2d/core/platform/CCObject.js:83
name

The name of the object.

meta description
Type String
Defined in cocos2d/core/platform/CCObject.js:240
Examples
obj.name = "New Obj";
isValid

Indicates whether the object is not yet destroyed. (It will not be available after being destroyed)
When an object's destroy is called, it is actually destroyed after the end of this frame. So isValid will return false from the next frame, while isValid in the current frame will still be true. If you want to determine whether the current frame has called destroy, use cc.isValid(obj, true), but this is often caused by a particular logical requirements, which is not normally required.

meta description
Type Boolean
Defined in cocos2d/core/platform/CCObject.js:258
Examples
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

Methods

enableCulling

enable or disable culling

meta description
Defined in cocos2d/tilemap/CCTiledLayer.js:136
Parameters
  • value Unknown
addUserNode

Adds user's node into layer.

meta description
Returns Boolean
Defined in cocos2d/tilemap/CCTiledLayer.js:149
Parameters
  • node cc.Node
removeUserNode

Removes user's node.

meta description
Returns Boolean
Defined in cocos2d/tilemap/CCTiledLayer.js:181
Parameters
  • node cc.Node
destroyUserNode

Destroy user's node.

meta description
Defined in cocos2d/tilemap/CCTiledLayer.js:205
Parameters
  • node cc.Node
getLayerName

Gets the layer name.

meta description
Returns String
Defined in cocos2d/tilemap/CCTiledLayer.js:362
Examples
let layerName = tiledLayer.getLayerName();
cc.log(layerName);
SetLayerName

Set the layer name.

meta description
Defined in cocos2d/tilemap/CCTiledLayer.js:375
Parameters
Examples
tiledLayer.setLayerName("New Layer");
getProperty

Return the value for the specific property name.

meta description
Returns Any
Defined in cocos2d/tilemap/CCTiledLayer.js:387
Parameters
Examples
let property = tiledLayer.getProperty("info");
cc.log(property);
getPositionAt

Returns the position in pixels of a given tile coordinate.

meta description
Returns Vec2
Defined in cocos2d/tilemap/CCTiledLayer.js:401
Parameters
Examples
let pos = tiledLayer.getPositionAt(cc.v2(0, 0));
cc.log("Pos: " + pos);
let pos = tiledLayer.getPositionAt(0, 0);
cc.log("Pos: " + pos);
setTileGIDAt

Sets the tile gid (gid = tile global id) at a given tile coordinate.
The Tile GID can be obtained by using the method "tileGIDAt" or by using the TMX editor . Tileset Mgr +1.
If a tile is already placed at that position, then it will be removed.

meta description
Defined in cocos2d/tilemap/CCTiledLayer.js:518
Parameters
Examples
tiledLayer.setTileGIDAt(1001, 10, 10, 1)
getTileGIDAt

Returns the tile gid at a given tile coordinate.
if it returns 0, it means that the tile is empty.

meta description
Returns Number
Defined in cocos2d/tilemap/CCTiledLayer.js:584
Parameters
Examples
let tileGid = tiledLayer.getTileGIDAt(0, 0);
getLayerOrientation

Layer orientation, which is the same as the map orientation.

meta description
Returns Number
Defined in cocos2d/tilemap/CCTiledLayer.js:789
Examples
let orientation = tiledLayer.getLayerOrientation();
cc.log("Layer Orientation: " + orientation);
getProperties

properties from the layer. They can be added using Tiled.

meta description
Returns Object
Defined in cocos2d/tilemap/CCTiledLayer.js:802
Examples
let properties = tiledLayer.getProperties();
cc.log("Properties: " + properties);
getTiledTileAt

Get the TiledTile with the tile coordinate.
If there is no tile in the specified coordinate and forceCreate parameter is true,
then will create a new TiledTile at the coordinate. The renderer will render the tile with the rotation, scale, position and color property of the TiledTile.

meta description
Returns cc.TiledTile
Defined in cocos2d/tilemap/CCTiledLayer.js:978
Parameters
  • x Integer
  • y Integer
  • forceCreate Boolean
Examples
let tile = tiledLayer.getTiledTileAt(100, 100, true);
cc.log(tile);
setTiledTileAt

Change tile to TiledTile at the specified coordinate.

meta description
Returns cc.TiledTile
Defined in cocos2d/tilemap/CCTiledLayer.js:1021
Parameters
  • x Integer
  • y Integer
  • tiledTile cc.TiledTile
getTexture

Return texture.

meta description
Returns Texture2D
Defined in cocos2d/tilemap/CCTiledLayer.js:1056
Parameters
  • index Unknown The index of textures
getTextures

Return texture.

meta description
Returns Texture2D
Defined in cocos2d/tilemap/CCTiledLayer.js:1071
setTexture

Set the texture.

meta description
Defined in cocos2d/tilemap/CCTiledLayer.js:1081
Parameters
setTexture

Set the texture.

meta description
Defined in cocos2d/tilemap/CCTiledLayer.js:1091
Parameters
getLayerSize

Gets layer size.

meta description
Returns Size
Defined in cocos2d/tilemap/CCTiledLayer.js:1102
Examples
let size = tiledLayer.getLayerSize();
cc.log("layer size: " + size);
getMapTileSize

Size of the map's tile (could be different from the tile's size).

meta description
Returns Size
Defined in cocos2d/tilemap/CCTiledLayer.js:1115
Examples
let mapTileSize = tiledLayer.getMapTileSize();
cc.log("MapTile size: " + mapTileSize);
getTileSet

Gets Tile set first information for the layer.

meta description
Returns TMXTilesetInfo
Defined in cocos2d/tilemap/CCTiledLayer.js:1128
Parameters
  • index Unknown The index of tilesets
getTileSet

Gets tile set all information for the layer.

meta description
Returns TMXTilesetInfo
Defined in cocos2d/tilemap/CCTiledLayer.js:1143
setTileSet

Sets tile set information for the layer.

meta description
Defined in cocos2d/tilemap/CCTiledLayer.js:1153
Parameters
setTileSets

Sets Tile set information for the layer.

meta description
Defined in cocos2d/tilemap/CCTiledLayer.js:1163
Parameters
update

Update is called every frame, if the Component is enabled.
This is a lifecycle method. It may not be implemented in the super class. You can only call its super class method inside it. It should not be called manually elsewhere.

meta description
Defined in cocos2d/core/components/CCComponent.js:223
Parameters
  • dt Number the delta time in seconds it took to complete the last frame
lateUpdate

LateUpdate is called every frame, if the Component is enabled.
This is a lifecycle method. It may not be implemented in the super class. You can only call its super class method inside it. It should not be called manually elsewhere.

meta description
Defined in cocos2d/core/components/CCComponent.js:234
Parameters
  • dt Number the delta time in seconds it took to complete the last frame
__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
Defined in cocos2d/core/components/CCComponent.js:245
onLoad

When attaching to an active node or its node first activated. onLoad is always called before any start functions, this allows you to order initialization of scripts.
This is a lifecycle method. It may not be implemented in the super class. You can only call its super class method inside it. It should not be called manually elsewhere.

meta description
Defined in cocos2d/core/components/CCComponent.js:256
start

Called before all scripts' update if the Component is enabled the first time. Usually used to initialize some logic which need to be called after all components' onload methods called.
This is a lifecycle method. It may not be implemented in the super class. You can only call its super class method inside it. It should not be called manually elsewhere.

meta description
Defined in cocos2d/core/components/CCComponent.js:269
onEnable

Called when this component becomes enabled and its node is active.
This is a lifecycle method. It may not be implemented in the super class. You can only call its super class method inside it. It should not be called manually elsewhere.

meta description
Defined in cocos2d/core/components/CCComponent.js:282
onDisable

Called when this component becomes disabled or its node becomes inactive.
This is a lifecycle method. It may not be implemented in the super class. You can only call its super class method inside it. It should not be called manually elsewhere.

meta description
Defined in cocos2d/core/components/CCComponent.js:292
onDestroy

Called when this component will be destroyed.
This is a lifecycle method. It may not be implemented in the super class. You can only call its super class method inside it. It should not be called manually elsewhere.

meta description
Defined in cocos2d/core/components/CCComponent.js:302
onFocusInEditor
meta description
Defined in cocos2d/core/components/CCComponent.js:312
onLostFocusInEditor
meta description
Defined in cocos2d/core/components/CCComponent.js:317
resetInEditor

Called to initialize the component or node’s properties when adding the component the first time or when the Reset command is used. This function is only called in editor.

meta description
Defined in cocos2d/core/components/CCComponent.js:322
addComponent

Adds a component class to the node. You can also add component to node by passing in the name of the script.

meta description
Returns Component
Defined in cocos2d/core/components/CCComponent.js:332
Parameters
  • typeOrClassName Function | String the constructor or the class name of the component to add
Examples
var sprite = node.addComponent(cc.Sprite);
var test = node.addComponent("Test");
getComponent

Returns the component of supplied type if the node has one attached, null if it doesn't.
You can also get component in the node by passing in the name of the script.

meta description
Returns Component
Defined in cocos2d/core/components/CCComponent.js:350
Parameters
Examples
// get sprite component.
var sprite = node.getComponent(cc.Sprite);
// get custom test calss.
var test = node.getComponent("Test");
getComponents

Returns all components of supplied Type in the node.

meta description
Returns Component[]
Defined in cocos2d/core/components/CCComponent.js:374
Parameters
Examples
var sprites = node.getComponents(cc.Sprite);
var tests = node.getComponents("Test");
getComponentInChildren

Returns the component of supplied type in any of its children using depth first search.

meta description
Returns Component
Defined in cocos2d/core/components/CCComponent.js:392
Parameters
Examples
var sprite = node.getComponentInChildren(cc.Sprite);
var Test = node.getComponentInChildren("Test");
getComponentsInChildren

Returns the components of supplied type in self or any of its children using depth first search.

meta description
Returns Component[]
Defined in cocos2d/core/components/CCComponent.js:410
Parameters
Examples
var sprites = node.getComponentsInChildren(cc.Sprite);
var tests = node.getComponentsInChildren("Test");
_getLocalBounds

If the component's bounding box is different from the node's, you can implement this method to supply a custom axis aligned bounding box (AABB), so the editor's scene view can perform hit test properly.

meta description
Defined in cocos2d/core/components/CCComponent.js:430
Parameters
  • out_rect Rect the Rect to receive the bounding box
onRestore

onRestore is called after the user clicks the Reset item in the Inspector's context menu or performs an undo operation on this component.

If the component contains the "internal state", short for "temporary member variables which not included
in its CCClass properties", then you may need to implement this function.

The editor will call the getset accessors of your component to record/restore the component's state
for undo/redo operation. However, in extreme cases, it may not works well. Then you should implement
this function to manually synchronize your component's "internal states" with its public properties.
Once you implement this function, all the getset accessors of your component will not be called when
the user performs an undo/redo operation. Which means that only the properties with default value
will be recorded or restored by editor.

Similarly, the editor may failed to reset your component correctly in extreme cases. Then if you need
to support the reset menu, you should manually synchronize your component's "internal states" with its
properties in this function. Once you implement this function, all the getset accessors of your component
will not be called during reset operation. Which means that only the properties with default value
will be reset by editor.

This function is only called in editor mode.

meta description
Defined in cocos2d/core/components/CCComponent.js:443
schedule

Schedules a custom selector.
If the selector is already scheduled, then the interval parameter will be updated without scheduling it again.

meta description
Defined in cocos2d/core/components/CCComponent.js:537
Parameters
  • 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. Unit: s
Examples
var timeCallback = function (dt) {
  cc.log("time: " + dt);
}
this.schedule(timeCallback, 1);
scheduleOnce

Schedules a callback function that runs only once, with a delay of 0 or larger.

meta description
Defined in cocos2d/core/components/CCComponent.js:575
Parameters
  • callback function A function wrapped as a selector
  • delay Number The amount of time that the first tick will wait before execution. Unit: s
Examples
var timeCallback = function (dt) {
  cc.log("time: " + dt);
}
this.scheduleOnce(timeCallback, 2);
unschedule

Unschedules a custom callback function.

meta description
Defined in cocos2d/core/components/CCComponent.js:592
Parameters
  • callback_fn function A function wrapped as a selector
Examples
this.unschedule(_callback);
unscheduleAllCallbacks

unschedule all scheduled callback functions: custom callback functions, and the 'update' callback function.
Actions are not affected by this method.

meta description
Defined in cocos2d/core/components/CCComponent.js:608
Examples
this.unscheduleAllCallbacks();
destroy

Destroy this Object, and release all its own references to other objects.
Actual object destruction will delayed until before rendering. From the next frame, this object is not usable any more. You can use cc.isValid(obj) to check whether the object is destroyed before accessing it.

meta description
Returns Boolean
Defined in cocos2d/core/platform/CCObject.js:293
Examples
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
Defined in cocos2d/core/platform/CCObject.js:427
_onPreDestroy

Called before the object being destroyed.

meta description
Defined in cocos2d/core/platform/CCObject.js:460
_serialize

The customized serialization for this object. (Editor Only)

meta description
Returns object
Defined in cocos2d/core/platform/CCObject.js:485
Parameters
_deserialize

Init this object from the custom serialized data.

meta description
Defined in cocos2d/core/platform/CCObject.js:495
Parameters
  • data Object the serialized json data
  • ctx _Deserializer

results matching ""

    No results matching ""