Working beta complete. Supports two playbacks: loop_forward and loop_pingpong. Includes example project.

Author: Klayton Kowalski

.gitignore

@@ -0,0 +1,10 @@
+/.internal
+/build
+.externalToolBuilders
+.DS_Store
+Thumbs.db
+.lock-wscript
+*.pyc
+.project
+.cproject
+builtins

README.md

@@ -1,2 +1,2 @@
-# defold-tilemap-animator
+# Defold Tilemap Animator
 Defold Tilemap Animator (DTA) allows for easy runtime tile animations in a Defold game engine project.

assets/tileset.png

@@ -0,0 +1,95 @@
+local dta = {}
+
+----------------------------------------------------------------------
+-- PROPERTIES
+----------------------------------------------------------------------
+
+dta.animation_groups = {}
+dta.tilemap_relative_path = nil
+dta.tilemap_layer_ids = {}
+dta.tilemap_width = 0
+dta.tilemap_height = 0
+
+----------------------------------------------------------------------
+-- PLAYBACK FUNCTIONS
+----------------------------------------------------------------------
+
+function dta.pb_func_loop_forward(key, value)
+	value["frame"] = value["frame"] + 1
+	if key + value["frame"] == value["end_tile"] + 1 then
+		value["frame"] = 0
+	end
+end
+
+function dta.pb_func_loop_pingpong(key, value)
+	if value["extra"] == 0 then
+		value["frame"] = value["frame"] + 1
+		if key + value["frame"] == value["end_tile"] then
+			value["extra"] = 1
+		end
+	elseif value["extra"] == 1 then
+		value["frame"] = value["frame"] - 1
+		if key + value["frame"] == key then
+			value["extra"] = 0
+		end
+	end
+end
+
+dta.playback_functions = {
+	loop_forward = dta.pb_func_loop_forward,
+	loop_pingpong = dta.pb_func_loop_pingpong
+}
+
+----------------------------------------------------------------------
+-- HELPER FUNCTIONS
+----------------------------------------------------------------------
+
+function dta.sweep_tile(prev_tile, new_tile)
+	for i = 1, #dta.tilemap_layer_ids do
+		for j = 1, dta.tilemap_height do
+			for k = 1, dta.tilemap_width do
+				if tilemap.get_tile(dta.tilemap_relative_path, dta.tilemap_layer_ids[i], k, j) == prev_tile then
+					tilemap.set_tile(dta.tilemap_relative_path, dta.tilemap_layer_ids[i], k, j, new_tile)
+				end
+			end
+		end
+	end
+end
+
+function dta.timer_callback(self, handle, time_elapsed)
+	for key, value in pairs(dta.animation_groups) do
+		if value["handle"] == handle then
+			value["elapsed"] = value["elapsed"] + time_elapsed
+			if value["elapsed"] >= value["step"] then
+				local prev_tile = key + value["frame"]
+				dta.playback_functions[value["playback"]](key, value)
+				dta.sweep_tile(prev_tile, key + value["frame"])
+			end
+		end
+	end
+end
+
+function dta.extend_animation_groups()
+	for key, value in pairs(dta.animation_groups) do
+		value["handle"] = timer.delay(value["step"], true, dta.timer_callback)
+		value["frame"] = 0
+		value["elapsed"] = 0
+		value["extra"] = 0
+	end
+end
+
+----------------------------------------------------------------------
+-- USER FUNCTIONS
+----------------------------------------------------------------------
+
+function dta.init(animation_groups, tilemap_relative_path, tilemap_layer_ids)
+	local x, y, w, h = tilemap.get_bounds(tilemap_relative_path)
+	dta.tilemap_relative_path = tilemap_relative_path
+	dta.animation_groups = animation_groups
+	dta.tilemap_layer_ids = tilemap_layer_ids
+	dta.tilemap_width = w
+	dta.tilemap_height = h
+	dta.extend_animation_groups(animation_groups)
+end
+
+return dta

dta/dta.lua

@@ -0,0 +1,15 @@
+-- RETURN USER-CREATED ANIMATION GROUPS.
+-- Format: table
+--         key   = start_tile (from tilesource)
+--         value = table
+--                 [1] = end_tile (from_tilesource)
+--                 [2] = playback ("loop_forward", "loop_pingpong")
+--                 [3] = step (frame duration in seconds)
+return {
+	[1] = { end_tile = 4, playback = "loop_forward", step = 1 / 2 },
+	[5] = { end_tile = 6, playback = "loop_forward", step = 1 / 2 },
+	[7] = { end_tile = 13, playback = "loop_forward", step = 1 / 4 },
+	[14] = { end_tile = 18, playback = "loop_forward", step = 1 / 4 },
+	[20] = { end_tile = 22, playback = "loop_pingpong", step = 1 / 6 },
+	[23] = { end_tile = 31, playback = "loop_pingpong", step = 1 / 6 }
+}

example/animation_groups.lua

@@ -0,0 +1,22 @@
+name: "collection"
+instances {
+  id: "go"
+  prototype: "/example/go.go"
+  position {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  scale3 {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+  }
+}
+scale_along_z: 0

example/collection.collection

@@ -0,0 +1,30 @@
+components {
+  id: "tilemap"
+  component: "/example/tilemap.tilemap"
+  position {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+}
+components {
+  id: "script"
+  component: "/example/script.script"
+  position {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+}

example/go.go

@@ -0,0 +1,12 @@
+-- Import Defold Tilemap Automator (DTA) module.
+local dta = require "dta.dta"
+
+-- Initialize script.
+function init(self)
+	-- Import animation groups from user-created Lua module.
+	local animation_groups = require "example.animation_groups"
+	-- List tilemap layer ids.
+	local tilemap_layer_ids = { "layer1", "layer2" }
+	-- Initialize and run DTA.
+	dta.init(animation_groups, "#tilemap", tilemap_layer_ids)
+end