Adding trigger events for Unity

Author: kestrelm

.DS_Store

@@ -45,10 +45,47 @@
 using UnityEditor;
 #endif
 
+public class CreatureFrameCallback
+{
+	public CreatureFrameCallback()
+	{
+		resetCallback();
+	}
+
+	public void resetCallback()
+	{
+		triggered = false;
+	}
+
+	public bool tryTrigger(float frameIn)
+	{
+		if(triggered)
+		{
+			return false;
+		}
+
+		if((int)Math.Round(frameIn) >= frameIn)
+		{
+			triggered = true;
+			return true;
+		}
+
+		return false;
+	}
+
+	public string name;
+	public string animClipName;
+	public int frame = 0;
+	public bool triggered = false;
+}
+
 public class CreatureGameController : MonoBehaviour
 {
 	public CreatureRenderer creature_renderer;
 	public List<CreatureSwitchItemRenderer> switch_renderer_list;
+	public delegate void eventTrigger(string event_name);
+	public static event eventTrigger OnEventTrigger;
+	public List<CreatureFrameCallback> event_callbacks = new List<CreatureFrameCallback>();
 	public float colliderHeight;
 	public float simColliderWidth, simColliderHeight;
 	public bool noCollisions = false;
@@ -253,13 +290,87 @@ void Start() {
 		// var cur_switcher = switch_renderer_list [0];
 		// cur_switcher.AddSwitchItem ("torsoSwitch1", new UnityEngine.Vector2 (136, 4), 481, 569, 2048, 2048);
 
+		if(creature_renderer)
+		{
+			creature_renderer.SetGameController(this);
+		}
+
+		BuildFrameCallbacks();
+		ResetFrameCallbacks();
+
 		// Call a custom agent if available
 		if (customAgent) 
 		{
 			customAgent.initState();
 		}
 	}
 
+	private void BuildFrameCallbacks()
+	{
+		if(creature_renderer)
+		{
+			var meta_asset = creature_renderer.creature_asset.creature_meta_data;
+			if(meta_asset != null)
+			{
+				foreach(var cur_data in meta_asset.anim_events_map)
+				{
+					foreach(var cur_event in cur_data.Value)
+					{
+						var new_callback = new CreatureFrameCallback();
+						new_callback.animClipName = cur_data.Key;
+						new_callback.name = cur_event.Value;
+						new_callback.frame = cur_event.Key;
+
+						event_callbacks.Add(new_callback);
+					}
+				}
+			}
+		}
+	}
+
+	private void ResetFrameCallbacks()
+	{
+		foreach(var frame_callback in event_callbacks)
+		{
+			frame_callback.resetCallback();
+		}
+	}
+
+	public void AnimClipChangeEvent()
+	{
+		var meta_asset = creature_renderer.creature_asset.creature_meta_data;
+		if(meta_asset != null)
+		{
+			ResetFrameCallbacks();
+		}
+	}
+
+	public void AnimClipFrameResetEvent()
+	{
+		var meta_asset = creature_renderer.creature_asset.creature_meta_data;
+		if(meta_asset != null)
+		{
+			ResetFrameCallbacks();
+		}
+	}
+
+	private void ProcessFrameCallbacks()
+	{
+		var cur_runtime = creature_renderer.creature_manager.getActualRuntime();
+		foreach(var frame_callback in event_callbacks)
+		{
+			if(frame_callback.animClipName == creature_renderer.creature_manager.active_animation_name)
+			{
+				var should_trigger = frame_callback.tryTrigger(cur_runtime);
+				//Debug.Log(frame_callback.name + " " + frame_callback.frame.ToString());
+				if(should_trigger && (OnEventTrigger != null))
+				{
+					OnEventTrigger(frame_callback.name);
+				}
+			}
+		}
+	}
+
 	private void UpdateGameColliders()
 	{
 		int i = 0;
@@ -316,6 +427,17 @@ void FixedUpdate() {
 			customAgent.updateStep();
 		}
 
+		// Call event triggers if required
+		if(creature_renderer)
+		{
+			var meta_asset = creature_renderer.creature_asset.creature_meta_data;
+			if(meta_asset != null)
+			{
+				ProcessFrameCallbacks();
+			}
+		}
+
+
 		// The following code demonstrates how to do item switching
 		/*
 		CreatureManager cur_manager = creature_renderer.creature_manager;

Distro/.DS_Store

@@ -46,11 +46,13 @@ namespace CreatureModule
 	public class CreatureMetaData {
 		public Dictionary<int, Tuple<int, int>> mesh_map;
 		public Dictionary<String, Dictionary<int, List<int> >> anim_order_map;
+		public Dictionary<String, Dictionary<int, String>> anim_events_map;
 
 		public CreatureMetaData()
 		{
 			mesh_map = new Dictionary<int, Tuple<int, int>>();
 			anim_order_map = new Dictionary<String, Dictionary<int, List<int> >>();
+			anim_events_map = new Dictionary<String, Dictionary<int, String>>();
 		}
 
 		public void clear()
@@ -216,6 +218,7 @@ public static void BuildCreatureMetaData(CreatureMetaData meta_data, string json
 			meta_data.clear();
 			var json_dict = JsonFx.Json.JsonReader.Deserialize(json_text_in, typeof(Dictionary<string, object>)) as Dictionary<string, object>;
 
+			// Build Region Ordering
 			if(json_dict.ContainsKey("meshes"))
 			{
 				var all_meshes = (Dictionary<string, object>)json_dict["meshes"];
@@ -251,6 +254,29 @@ public static void BuildCreatureMetaData(CreatureMetaData meta_data, string json
 					meta_data.anim_order_map[anim_name] = write_order_dict;
 				}
 			}
+
+			// Build Event Triggers
+			if(json_dict.ContainsKey("eventTriggers"))
+			{
+				var events_obj = (Dictionary<string, object>)json_dict["eventTriggers"];
+				foreach(var cur_data in events_obj)
+				{
+					var cur_anim_name = cur_data.Key;
+					var cur_events_map = new Dictionary<int, string>();
+					var cur_obj_array = (System.Object[])cur_data.Value;
+
+					foreach(var cur_events_json in cur_obj_array)
+					{
+						var cur_events_obj = (Dictionary<string, object>)cur_events_json;
+						var cur_event_name = (string)cur_events_obj["event_name"];
+						var switch_time = Convert.ToInt32(cur_events_obj["switch_time"]);
+
+						cur_events_map[switch_time] = cur_event_name;
+					}
+
+					meta_data.anim_events_map[cur_anim_name] = cur_events_map;
+				}
+			}
 		}
 
 		public static float[] getFloatArray(System.Object raw_data)
@@ -1349,6 +1375,19 @@ public float getRunTime()
 		{
 			return run_time;
 		}
+
+		// Returns current run time in consideration of blending
+		public float getActualRuntime() 
+		{
+			if(do_auto_blending)
+			{
+				if(active_blend_run_times.ContainsKey(active_animation_name)) {
+					return active_blend_run_times[active_animation_name];
+				}
+			}
+
+			return run_time;
+		}
 
 		// Runs a single step of the animation for a given delta timestep
 		public void Update(float delta)

Distro/CreatureGameController.cs

@@ -63,6 +63,7 @@ public class CreatureRenderer : MonoBehaviour
 	public float local_time_scale;
 	public CreatureAsset creature_asset;
 	public CreatureManager creature_manager;
+	private CreatureGameController game_controller = null;
 	public int animation_choice_index;
 	public string active_animation_name;
 	public float blend_rate = 0.1f;
@@ -111,6 +112,11 @@ public virtual void Reset()
 		local_time = 0;
 	}
 
+	public void SetGameController(CreatureGameController controller_in)
+	{
+		game_controller = controller_in;
+	}
+
 	public void InitData()
 	{
 		if (creature_asset) {
@@ -179,6 +185,11 @@ public void SetActiveAnimation(string animation_name, bool already_active_check=
 
 
 		local_time = creature_manager.animations [creature_manager.GetActiveAnimationName()].start_time;
+
+		if(game_controller)
+		{
+			game_controller.AnimClipChangeEvent();
+		}
 	}
 
 	public void BlendToAnimation(string animation_name)
@@ -190,6 +201,11 @@ public void BlendToAnimation(string animation_name)
 		active_animation_name = animation_name;
 		creature_manager.SetAutoBlending (true);
 		creature_manager.AutoBlendTo (animation_name, blend_rate);
+
+		if(game_controller)
+		{
+			game_controller.AnimClipChangeEvent();
+		}
 	}
 
 	// Returns the local playback time
@@ -348,13 +364,18 @@ public void UpdateTime()
 			return;
 		}
 
-
+		var old_time = creature_manager.getActualRuntime();
 		float time_delta = (Time.deltaTime * local_time_scale);
 
 		creature_manager.region_offsets_z = region_offsets_z;
 		creature_manager.should_loop = should_loop;
 		creature_manager.Update(time_delta);
-		local_time = creature_manager.getRunTime();
+		local_time = creature_manager.getActualRuntime();
+
+		if((local_time < old_time) && (game_controller != null))
+		{
+			game_controller.AnimClipFrameResetEvent();
+		}
 	}
 
 	public virtual void LateUpdate ()