aseprite/tests/scripts/tileset.lua

-- Copyright (C) 2022-2023  Igara Studio S.A.
--
-- This file is released under the terms of the MIT license.
-- Read LICENSE.txt for more information.

dofile('./test_utils.lua')

-- Create a Tilemap and manipulate its Tileset
do
  local spr = Sprite(4, 4, ColorMode.INDEXED)

  app.command.NewLayer{ tilemap=true }
  local tilemap = spr.layers[2]

  local tileset = tilemap.tileset
  assert(#tileset == 1)

  app.useTool{
    tool='pencil',
    color=1,
    layer=tilemap,
    tilesetMode=TilesetMode.STACK,
    points={ Point(0, 0) }}
  assert(#tileset == 2)

  assert(tileset.name == "")
  tileset.name = "Default Land"
  assert(tileset.name == "Default Land")

  -- Tileset user data
  assert(tileset.data == "")
  tileset.data = "land"
  assert(tileset.data == "land")

  assert(tileset.color == Color())
  tileset.color = Color(255, 0, 0)
  assert(tileset.color == Color(255, 0, 0))

  -- Create extra tile
  app.useTool{
    tool='pencil',
    color=1,
    layer=tilemap,
    tilesetMode=TilesetMode.STACK,
    points={ Point(1, 1) }}
  assert(#tileset == 3)

  -- Check that Tileset:getTile(ti) returns Tileset:tile(ti).image user data
  for ti=0,2 do
    assert(tileset:tile(ti).image.id == tileset:getTile(ti).id)
  end
end

-- Check undo/redo of name and baseIndex changes
do
  local spr = Sprite(4, 4, ColorMode.INDEXED)
  app.command.NewLayer{ tilemap=true }
  local tilemap = spr.layers[2]
  local tileset = tilemap.tileset
  assert(#tileset == 1)

  -- Check undo/redo of name change
  assert(tileset.name == "")
  tileset.name = "Terrain"
  assert(tileset.name == "Terrain")
  app.undo() assert(tileset.name == "")
  app.redo() assert(tileset.name == "Terrain")

  -- Check undo/redo of baseIndex
  assert(tileset.baseIndex == 1)
  tileset.baseIndex = 2
  assert(tileset.baseIndex == 2)
  app.undo() assert(tileset.baseIndex == 1)
  app.redo() assert(tileset.baseIndex == 2)
end

-- Create and delete Tilesets
do
  local spr = Sprite(4, 4, ColorMode.INDEXED)

  -- Create a tileset with default parameters
  local tileset = spr:newTileset()
  assert(#tileset == 1)
  assert(tileset.grid.origin.x == 0)
  assert(tileset.grid.origin.y == 0)
  assert(tileset.grid.tileSize.width == 16)
  assert(tileset.grid.tileSize.height == 16)
  assert(tileset.name == "")
  assert(#spr.tilesets == 1)

  -- Create a tileset passing a grid
  local tileset2 = spr:newTileset(Grid{0, 0, 32, 32})
  tileset2.name = "Tileset 2"
  assert(#tileset2 == 1)
  assert(tileset2.grid.origin.x == 0)
  assert(tileset2.grid.origin.y == 0)
  assert(tileset2.grid.tileSize.width == 32)
  assert(tileset2.grid.tileSize.height == 32)
  assert(tileset2.name == "Tileset 2")
  assert(#spr.tilesets == 2)

  -- Create a tileset passing a table and a number of tiles
  local tileset3 = spr:newTileset({0, 0, 64, 64}, 5)
  assert(#tileset3 == 5)
  assert(tileset3.grid.origin.x == 0)
  assert(tileset3.grid.origin.y == 0)
  assert(tileset3.grid.tileSize.width == 64)
  assert(tileset3.grid.tileSize.height == 64)
  assert(tileset3.name == "")
  assert(#spr.tilesets == 3)
  tileset3.name = "Tileset 3"

  -- Duplicate a tileset
  local tileset4 = spr:newTileset(tileset3)
  assert(#tileset4 == 5)
  assert(tileset4.grid.origin.x == 0)
  assert(tileset4.grid.origin.y == 0)
  assert(tileset4.grid.tileSize.width == 64)
  assert(tileset4.grid.tileSize.height == 64)
  assert(tileset4.name == "Tileset 3")
  assert(#spr.tilesets == 4)

  -- Undo last tileset addition
  app.undo()
  assert(#spr.tilesets == 3)

  -- Create a tileset with a rectangle
  local tileset5 = spr:newTileset(Rectangle(0, 0, 32, 64), 4)
  assert(#tileset5 == 4)
  assert(tileset5.grid.origin.x == 0)
  assert(tileset5.grid.origin.y == 0)
  assert(tileset5.grid.tileSize.width == 32)
  assert(tileset5.grid.tileSize.height == 64)
  assert(#spr.tilesets == 4)
  app.undo()
  assert(#spr.tilesets == 3)

  -- Delete tileset
  spr:deleteTileset(2)
  assert(#spr.tilesets == 2)
  spr:deleteTileset(tileset2)
  assert(#spr.tilesets == 1)

  -- Undo last tileset removal
  app.undo()
  assert(#spr.tilesets == 2)
  assert(#tileset2 == 1)
  assert(tileset2.grid.origin.x == 0)
  assert(tileset2.grid.origin.y == 0)
  assert(tileset2.grid.tileSize.width == 32)
  assert(tileset2.grid.tileSize.height == 32)
  assert(tileset2.name == "Tileset 2")
end

do
  -- Check Sprite:newTile() and Sprite:deleteTile() methods
  local spr = Sprite(4, 4, ColorMode.INDEXED)
  local pal = spr.palettes[1]
  pal:setColor(0, Color(0, 0, 0))
  pal:setColor(1, Color(255, 255, 0))
  pal:setColor(2, Color(255, 0, 0))
  spr.gridBounds = Rectangle(0, 0, 2, 2)
  app.command.NewLayer{ tilemap=true }
  local tilemap = spr.layers[2]
  local tileset = tilemap.tileset
  assert(tileset.grid.tileSize == Size(2, 2))
  app.useTool{ tool="pencil",
               color=1,
               layer=tilemap,
               tilesetMode=TilesetMode.AUTO,
               tilemapMode=TilemapMode.PIXELS,
               points={Point(0,0), Point(1, 0)}}
  app.useTool{ tool="pencil",
               color=2,
               layer=tilemap,
               tilesetMode=TilesetMode.AUTO,
               tilemapMode=TilemapMode.PIXELS,
               points={Point(2,0), Point(3, 1)}}
  assert(#tileset == 3)
  -- Insert a tile in the middle of the tileset
  local tile1 = spr:newTile(tileset, 1)
  assert(#tileset == 4)
  expect_img(tileset:getTile(0), { 0, 0,
                                   0, 0 })
  expect_img(tileset:getTile(1), { 0, 0,
                                   0, 0 })
  expect_img(tileset:getTile(2), { 1, 1,
                                   0, 0 })
  expect_img(tileset:getTile(3), { 2, 0,
                                   0, 2 })

  app.undo()

  assert(#tileset == 3)
  expect_img(tileset:getTile(0), { 0, 0,
                                   0, 0 })
  expect_img(tileset:getTile(1), { 1, 1,
                                   0, 0 })
  expect_img(tileset:getTile(2), { 2, 0,
                                   0, 2 })

  app.redo()

  assert(#tileset == 4)
  expect_img(tileset:getTile(0), { 0, 0,
                                   0, 0 })
  expect_img(tileset:getTile(1), { 0, 0,
                                   0, 0 })
  expect_img(tileset:getTile(2), { 1, 1,
                                   0, 0 })
  expect_img(tileset:getTile(3), { 2, 0,
                                   0, 2 })
  -- Insert a tile at the end of the tileset (by index omission)
  local tile2 = spr:newTile(tileset)
  assert(#tileset == 5)
  expect_img(tileset:getTile(3), { 2, 0,
                                   0, 2 })
  expect_img(tileset:getTile(4), { 0, 0,
                                   0, 0 })
  -- Insert at the end of the tileset explicity, and testing
  -- other way to access to the tile image
  local tile3 = spr:newTile(tileset, 5)
  assert(#tileset == 6)
  expect_img(tileset:tile(3).image, { 2, 0,
                                      0, 2 })
  expect_img(tileset:tile(4).image, { 0, 0,
                                      0, 0 })
  expect_img(tileset:tile(5).image, { 0, 0,
                                      0, 0 })

  app.undo()
  app.undo()
  app.undo()

  assert(#tileset == 3)
  expect_img(tileset:getTile(0), { 0, 0,
                                   0, 0 })
  expect_img(tileset:getTile(1), { 1, 1,
                                   0, 0 })
  expect_img(tileset:getTile(2), { 2, 0,
                                   0, 2 })

  app.redo()
  app.redo()
  app.redo()

  assert(#tileset == 6)
  expect_img(tileset:getTile(0), { 0, 0,
                                   0, 0 })
  expect_img(tileset:getTile(1), { 0, 0,
                                   0, 0 })
  expect_img(tileset:getTile(2), { 1, 1,
                                   0, 0 })
  expect_img(tileset:getTile(3), { 2, 0,
                                   0, 2 })
  expect_img(tileset:getTile(4), { 0, 0,
                                   0, 0 })
  expect_img(tileset:getTile(5), { 0, 0,
                                   0, 0 })
  -- Deleting tiles
  spr:deleteTile(tileset:tile(5))
  spr:deleteTile(tileset:tile(4))
  spr:deleteTile(tileset:tile(1))

  app.undo()

  assert(#tileset == 4)
  expect_img(tileset:getTile(0), { 0, 0,
                                   0, 0 })
  expect_img(tileset:getTile(1), { 0, 0,
                                   0, 0 })
  expect_img(tileset:getTile(2), { 1, 1,
                                   0, 0 })
  expect_img(tileset:getTile(3), { 2, 0,
                                   0, 2 })

  app.redo()

  assert(#tileset == 3)
  expect_img(tileset:getTile(0), { 0, 0,
                                   0, 0 })
  expect_img(tileset:getTile(1), { 1, 1,
                                   0, 0 })
  expect_img(tileset:getTile(2), { 2, 0,
                                   0, 2 })
  spr:deleteTile(tileset:tile(1))
  assert(#tileset == 2)
  expect_img(tileset:getTile(0), { 0, 0,
                                   0, 0 })
  expect_img(tileset:getTile(1), { 2, 0,
                                   0, 2 })

  app.undo()
  app.undo()
  app.undo()
  app.undo()

  assert(#tileset == 6)
  expect_img(tileset:getTile(0), { 0, 0,
                                   0, 0 })
  expect_img(tileset:getTile(1), { 0, 0,
                                   0, 0 })
  expect_img(tileset:getTile(2), { 1, 1,
                                   0, 0 })
  expect_img(tileset:getTile(3), { 2, 0,
                                   0, 2 })
  expect_img(tileset:getTile(4), { 0, 0,
                                   0, 0 })
  expect_img(tileset:getTile(5), { 0, 0,
                                   0, 0 })

end

-- Test that we use the sprite grid size by default to create new tilesets
do
  local spr = Sprite(32, 32, ColorMode.INDEXED)
  local ts = spr:newTileset()
  assert(ts.grid.tileSize == Size(16, 16))

  spr.gridBounds = Rectangle(1, 2, 3, 4)
  ts = spr:newTileset()
  assert(ts.grid.tileSize == Size(3, 4))
end