Tilemap - Retrieve tile's ID when mirrored

KingQuack · January 29, 2024, 10:24am

Hello,

Since the new version v1.3.2-x64 of aseprite, we can now generate a Tilemap with tile’s flip property.

But it seems that when I want to retrieve, through API, the ID of the tile in question, the ID is a very large number that doesn’t correspond to anything.

The method used to retrieve ID is: tilemap:getPixel(x, y) with X, and Y the tile position in the Tilemap.

Is there a way to get the Tile ID and if it’s mirrored ?

Thanks in advance.

behreandtjeremy · January 29, 2024, 10:59am

I’d try app.pixelColor.tileI and app.pixelColor.tileF, which decompose a map entry into its index and flipping flags. app.pixelColor.tile composes an index with its flipping flags to create a complete map entry.

github.com

aseprite/aseprite/blob/main/src/app/script/pixel_color_object.cpp#L74


      
            lua_pushinteger(L, doc::graya_getv(lua_tointeger(L, 1)));
            return 1;
          }
          
          int PixelColor_grayaA(lua_State* L)
          {
            lua_pushinteger(L, doc::graya_geta(lua_tointeger(L, 1)));
            return 1;
          }
          
          int PixelColor_tile(lua_State* L)
          {
            const int i = lua_tointeger(L, 1);
            const int f = lua_tointeger(L, 2);
            lua_pushinteger(L, doc::tile(i, f));
            return 1;
          }
          
          int PixelColor_tileI(lua_State* L)
          {
            lua_pushinteger(L, doc::tile_geti(lua_tointeger(L, 1)));

The flipping flags for X, Y and D can be found in the source code, as well as the logic for how the functions above work:

github.com

aseprite/aseprite/blob/main/src/doc/tile.h#L24


      
          
          typedef uint32_t tile_t;      // Same as color_t
          typedef uint32_t tile_index;
          typedef uint32_t tileset_index;
          typedef uint32_t tile_flags;
          
          const uint32_t tile_i_shift = 0;  // Tile index
          const uint32_t tile_f_shift = 28; // Tile flags (flips)
          
          const uint32_t notile       = 0;
          const uint32_t tile_i_mask  = 0x1fffffff;
          const uint32_t tile_f_mask  = 0xe0000000; // 3 flags
          const uint32_t tile_f_xflip = 0x80000000;
          const uint32_t tile_f_yflip = 0x40000000;
          const uint32_t tile_f_dflip = 0x20000000;
          
          inline tile_index tile_geti(const tile_t t) {
            return ((t & tile_i_mask) >> tile_i_shift);
          }
          
          inline tile_flags tile_getf(const tile_t t) {

The flags are the same as in Tiled, btw, which makes export nice and easy:

https://doc.mapeditor.org/en/stable/reference/global-tile-ids/#gid-tile-flipping

KingQuack · January 29, 2024, 12:59pm

oh, this is very good !
With app.pixelColor.tileI and app.pixelColor.tileF I can now retrieve all informations I need for my lua script.

Maybe the official API documentation will write this type of usage.
Tiles management is still fairly new in software.

Thanks.