tilemap_get


Description

Using this function you can retrieve the tile data from a cell of the tilemap element. You give the tilemap element ID (which you get when you create a tilemap element using layer_tilemap_create() or when you use the function layer_tilemap_get_id()), as well as the cell x and y position and the function will return the tile data "blob". This data is essentially a bit mask that contains the tile index, the flip/rotate/mirror booleans and any mask data that has been applied (see tilemap_set_mask for details), and the resulting data value can then be used in the Tile Functions to change a tiles properties. Note that we are using x/y cell positions based on the size of the tilemap grid and not as a position in the room, so "cell_x" is a value from 0 to tilemap width, and "cell_y" is a value from 0 to tilemap height. If you need to get the data for a tile at a specific room position then you need to use the function tilemap_get_at_pixel().

IMPORTANT! If the tiles in the tilemap have been unchanged (ie: they are not rotated or flipped etc...), then the return value of the tileset data will be exactly equal to the index of the tile on the tileset. So you can create "collision maps" of tiles using one tile at index 1 in the tileset - for example - then use this function to check for 1 or 0 (an empty tile) to calculate collisions.


Syntax:

tilemap_get(tilemap_element_id, cell_x, cell_y);


Arguments:

Argument Description
tilemap_element_id The unique ID value of the tilemap element to get the tiledata of
x_cell The cell along the x-axis to get the tile data from
y_cell The cell along the y-axis to get the tile data from


Returns:

Real (-1 if there is an error)


Example:

var lay_id = layer_get_id("Tiles_sky");
var map_id = layer_tilemap_get_id(lay_id);
var data = tilemap_get(map_id, 0, 0);
data = tile_set_flip(data, true);
tilemap_set(map_id, data, 0, 0);

The above code gets the ID for the tilemap on the layer "Tiles_Sky" and then uses that to get the data from the tile at cell (0, 0). This tile data is then flipped before being used to set the tile on the tilemap again.