Difference between revisions of "TileMap.new"

From GiderosMobile
m (Text replacement - "</source>" to "</syntaxhighlight>")
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
'''Available since:''' Gideros 2011.6<br/>
 
'''Available since:''' Gideros 2011.6<br/>
 +
'''Class:''' [[TileMap]]<br/>
 +
 
=== Description ===
 
=== Description ===
<br />
+
Creates a new '''TileMap''' instance.
Creates a new `TileMap` instance.<br />
+
<syntaxhighlight lang="lua">
<br />
+
TileMap.new(width,height,texture,tilewidth,tileheight,spacingx,spacingy,marginx,marginy,displaywidth,displayheight)
<source lang="lua">
+
</syntaxhighlight>
TileMap.new(width,height,texture,tilewidth,tileheight,spacingx,spacingy,marginx,marginy,displaywidth,displayheight)
+
 
</source>
+
=== Parameters ===
'''width''': (number) The width of the map in tiles ''''''<br/>
+
'''width''': (number) the width of the map in tiles<br/>
'''height''': (number) The height of the map in tiles ''''''<br/>
+
'''height''': (number) the height of the map in tiles<br/>
'''texture''': (TextureBase) The texture used in rendering tile map ''''''<br/>
+
'''texture''': (TextureBase) the texture used in rendering tile map<br/>
'''tilewidth''': (number) The width of a tile in pixels ''''''<br/>
+
'''tilewidth''': (number) the width of a tile in pixels<br/>
'''tileheight''': (number) The height of a tile in pixels ''''''<br/>
+
'''tileheight''': (number) the height of a tile in pixels<br/>
'''spacingx''': (number, default = 0) The x-spacing in pixels between the tiles in this tileset ''''''<br/>
+
'''spacingx''': (number, default = 0) the x-spacing in pixels between the tiles in this tileset<br/>
'''spacingy''': (number, default = 0) The y-spacing in pixels between the tiles in this tileset ''''''<br/>
+
'''spacingy''': (number, default = 0) the y-spacing in pixels between the tiles in this tileset<br/>
'''marginx''': (number, default = 0) The x-margin from the top-left of the texture ''''''<br/>
+
'''marginx''': (number, default = 0) the x-margin from the top-left of the texture<br/>
'''marginy''': (number, default = 0) The y-margin from the top-left of the texture ''''''<br/>
+
'''marginy''': (number, default = 0) the y-margin from the top-left of the texture<br/>
'''displaywidth''': (number, default = tilewidth) The display width of a tile in pixels ''''''<br/>
+
'''displaywidth''': (number, default = tilewidth) the display width of a tile in pixels<br/>
'''displayheight''': (number, default = tileheight) The display height of a tile in pixels ''''''<br/>
+
'''displayheight''': (number, default = tileheight) the display height of a tile in pixels<br/>
 +
 
 +
{{TileMap}}

Latest revision as of 14:33, 13 July 2023

Available since: Gideros 2011.6
Class: TileMap

Description

Creates a new TileMap instance.

TileMap.new(width,height,texture,tilewidth,tileheight,spacingx,spacingy,marginx,marginy,displaywidth,displayheight)

Parameters

width: (number) the width of the map in tiles
height: (number) the height of the map in tiles
texture: (TextureBase) the texture used in rendering tile map
tilewidth: (number) the width of a tile in pixels
tileheight: (number) the height of a tile in pixels
spacingx: (number, default = 0) the x-spacing in pixels between the tiles in this tileset
spacingy: (number, default = 0) the y-spacing in pixels between the tiles in this tileset
marginx: (number, default = 0) the x-margin from the top-left of the texture
marginy: (number, default = 0) the y-margin from the top-left of the texture
displaywidth: (number, default = tilewidth) the display width of a tile in pixels
displayheight: (number, default = tileheight) the display height of a tile in pixels