axmol/cocos/scripting/lua-bindings/auto/api/TMXLayer.lua

218 lines
7.7 KiB
Lua
Raw Normal View History

2014-03-10 14:04:58 +08:00
--------------------------------
-- @module TMXLayer
-- @extend SpriteBatchNode
-- @parent_module cc
2014-03-10 14:04:58 +08:00
--------------------------------
-- Returns the position in points of a given tile coordinate.<br>
-- param tileCoordinate The tile coordinate.<br>
-- return The position in points of a given tile coordinate.
2014-03-10 14:04:58 +08:00
-- @function [parent=#TMXLayer] getPositionAt
-- @param self
-- @param #vec2_table tileCoordinate
-- @return vec2_table#vec2_table ret (return value: vec2_table)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Set layer orientation, which is the same as the map orientation.<br>
-- param orientation Layer orientation,which is the same as the map orientation.
2014-03-10 14:04:58 +08:00
-- @function [parent=#TMXLayer] setLayerOrientation
-- @param self
-- @param #int orientation
-- @return TMXLayer#TMXLayer self (return value: cc.TMXLayer)
--------------------------------
-- Dealloc the map that contains the tile position from memory.<br>
-- Unless you want to know at runtime the tiles positions, you can safely call this method.<br>
-- If you are going to call layer->tileGIDAt() then, don't release the map.
-- @function [parent=#TMXLayer] releaseMap
-- @param self
-- @return TMXLayer#TMXLayer self (return value: cc.TMXLayer)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Size of the layer in tiles.<br>
-- return Size of the layer in tiles.
2014-03-10 14:04:58 +08:00
-- @function [parent=#TMXLayer] getLayerSize
-- @param self
-- @return size_table#size_table ret (return value: size_table)
--------------------------------
-- Set the size of the map's tile.<br>
-- param size The size of the map's tile.
2014-03-10 14:04:58 +08:00
-- @function [parent=#TMXLayer] setMapTileSize
-- @param self
-- @param #size_table size
-- @return TMXLayer#TMXLayer self (return value: cc.TMXLayer)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Layer orientation, which is the same as the map orientation.<br>
-- return Layer orientation, which is the same as the map orientation.
2014-03-10 14:04:58 +08:00
-- @function [parent=#TMXLayer] getLayerOrientation
-- @param self
-- @return int#int ret (return value: int)
--------------------------------
-- Set an Properties from to layer.<br>
-- param properties It is used to set the layer Properties.
2014-03-10 14:04:58 +08:00
-- @function [parent=#TMXLayer] setProperties
-- @param self
-- @param #map_table properties
-- @return TMXLayer#TMXLayer self (return value: cc.TMXLayer)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Set the layer name.<br>
-- param layerName The layer name.
2014-03-10 14:04:58 +08:00
-- @function [parent=#TMXLayer] setLayerName
-- @param self
-- @param #string layerName
-- @return TMXLayer#TMXLayer self (return value: cc.TMXLayer)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Removes a tile at given tile coordinate. <br>
-- param tileCoordinate The tile coordinate.
2014-03-10 14:04:58 +08:00
-- @function [parent=#TMXLayer] removeTileAt
-- @param self
-- @param #vec2_table tileCoordinate
-- @return TMXLayer#TMXLayer self (return value: cc.TMXLayer)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Initializes a TMXLayer with a tileset info, a layer info and a map info.<br>
-- param tilesetInfo An tileset info.<br>
-- param layerInfo A layer info.<br>
-- param mapInfo A map info.<br>
-- return If initializes successfully, it will return true.
-- @function [parent=#TMXLayer] initWithTilesetInfo
2014-03-10 14:04:58 +08:00
-- @param self
-- @param #cc.TMXTilesetInfo tilesetInfo
-- @param #cc.TMXLayerInfo layerInfo
-- @param #cc.TMXMapInfo mapInfo
-- @return bool#bool ret (return value: bool)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Creates the tiles.
2014-03-10 14:04:58 +08:00
-- @function [parent=#TMXLayer] setupTiles
-- @param self
-- @return TMXLayer#TMXLayer self (return value: cc.TMXLayer)
--------------------------------
-- @overload self, unsigned int, vec2_table, int
-- @overload self, unsigned int, vec2_table
2014-03-10 14:04:58 +08:00
-- @function [parent=#TMXLayer] setTileGID
-- @param self
-- @param #unsigned int gid
-- @param #vec2_table tileCoordinate
-- @param #int flags
-- @return TMXLayer#TMXLayer self (return value: cc.TMXLayer)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Size of the map's tile (could be different from the tile's size).<br>
-- return The size of the map's tile.
2014-03-10 14:04:58 +08:00
-- @function [parent=#TMXLayer] getMapTileSize
-- @param self
-- @return size_table#size_table ret (return value: size_table)
--------------------------------
-- Return the value for the specific property name.<br>
-- param propertyName The specific property name.<br>
-- return Return the value for the specific property name.
2014-03-10 14:04:58 +08:00
-- @function [parent=#TMXLayer] getProperty
-- @param self
-- @param #string propertyName
2014-03-10 14:04:58 +08:00
-- @return Value#Value ret (return value: cc.Value)
--------------------------------
-- Set size of the layer in tiles.<br>
-- param size Size of the layer in tiles.
2014-03-10 14:04:58 +08:00
-- @function [parent=#TMXLayer] setLayerSize
-- @param self
-- @param #size_table size
-- @return TMXLayer#TMXLayer self (return value: cc.TMXLayer)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Get the layer name. <br>
-- return The layer name.
2014-03-10 14:04:58 +08:00
-- @function [parent=#TMXLayer] getLayerName
-- @param self
-- @return string#string ret (return value: string)
--------------------------------
-- Set tileset information for the layer.<br>
-- param info The tileset information for the layer.<br>
-- js NA
2014-03-10 14:04:58 +08:00
-- @function [parent=#TMXLayer] setTileSet
-- @param self
-- @param #cc.TMXTilesetInfo info
-- @return TMXLayer#TMXLayer self (return value: cc.TMXLayer)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Tileset information for the layer. <br>
-- return Tileset information for the layer.
2014-03-10 14:04:58 +08:00
-- @function [parent=#TMXLayer] getTileSet
-- @param self
-- @return TMXTilesetInfo#TMXTilesetInfo ret (return value: cc.TMXTilesetInfo)
--------------------------------
-- @overload self
-- @overload self
-- @function [parent=#TMXLayer] getProperties
-- @param self
-- @return map_table#map_table ret (return value: map_table)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Returns the tile (Sprite) at a given a tile coordinate.<br>
-- The returned Sprite will be already added to the TMXLayer. Don't add it again.<br>
-- The Sprite can be treated like any other Sprite: rotated, scaled, translated, opacity, color, etc.<br>
-- You can remove either by calling:<br>
-- - layer->removeChild(sprite, cleanup);<br>
-- - or layer->removeTileAt(Vec2(x,y));<br>
-- param tileCoordinate A tile coordinate.<br>
-- return Returns the tile (Sprite) at a given a tile coordinate.
2014-03-10 14:04:58 +08:00
-- @function [parent=#TMXLayer] getTileAt
-- @param self
-- @param #vec2_table tileCoordinate
2014-03-10 14:04:58 +08:00
-- @return Sprite#Sprite ret (return value: cc.Sprite)
--------------------------------
-- Creates a TMXLayer with an tileset info, a layer info and a map info.<br>
-- param tilesetInfo An tileset info.<br>
-- param layerInfo A layer info.<br>
-- param mapInfo A map info.<br>
-- return An autorelease object.
2014-03-10 14:04:58 +08:00
-- @function [parent=#TMXLayer] create
-- @param self
-- @param #cc.TMXTilesetInfo tilesetInfo
-- @param #cc.TMXLayerInfo layerInfo
-- @param #cc.TMXMapInfo mapInfo
-- @return TMXLayer#TMXLayer ret (return value: cc.TMXLayer)
2014-03-10 14:04:58 +08:00
--------------------------------
--
-- @function [parent=#TMXLayer] addChild
-- @param self
-- @param #cc.Node child
-- @param #int zOrder
-- @param #int tag
-- @return TMXLayer#TMXLayer self (return value: cc.TMXLayer)
--------------------------------
-- js NA
-- @function [parent=#TMXLayer] getDescription
-- @param self
-- @return string#string ret (return value: string)
--------------------------------
--
-- @function [parent=#TMXLayer] removeChild
-- @param self
-- @param #cc.Node child
-- @param #bool cleanup
-- @return TMXLayer#TMXLayer self (return value: cc.TMXLayer)
2014-03-10 14:04:58 +08:00
--------------------------------
-- js ctor
2014-03-10 14:04:58 +08:00
-- @function [parent=#TMXLayer] TMXLayer
-- @param self
-- @return TMXLayer#TMXLayer self (return value: cc.TMXLayer)
2014-03-10 14:04:58 +08:00
return nil