Feature: Add new example code

Author: inmny

ExampleModCode.cs

@@ -6,6 +6,7 @@
 using NeoModLoader.api.attributes;
 using NeoModLoader.General;
 using UnityEngine;
+
 namespace ExampleMod;
 
 /// <summary>
@@ -32,9 +33,11 @@ public class ExampleModMain : BasicMod<ExampleModMain>, IReloadable, IUnloadable
     // Just for displaying mod reloading effect. To emulate the effect of reloading mod, you can replace _reload_switch with manual modifying.
     // 仅用于展示显示模组重载效果(因为代码是静态的, 不能自动修改), 你可以将 _reload_switch 替换为手动修改
     internal static bool _reload_switch;
+
     // It is used for storing self made prefab, avoiding prefab objects under root scene. It's optional.
     // 用于存储自制的预制体, 避免预制体对象直接暴露在场景根节点下. 不是必需的.
     internal static Transform prefab_library;
+
     /// <summary>
     ///     <para>
     ///         To test reloading function, you can modify traits in <see cref="ExampleTraits" /> or trait action in
@@ -71,6 +74,7 @@ public void Reload()
                 LM.LoadLocales(file);
             }
         }
+
         LM.ApplyLocale();
         // Reload mod resources when mod reloaded, it's optional.
         // 重载模组时重新加载模组资源, 不是必需的
@@ -150,6 +154,7 @@ protected override void OnModLoad()
         {
             Config.isEditor = true;
         }
+
         // Example of add name generators and example of mod optional dependencies.
         // 添加名字生成器的示例和模组可选依赖的示例.
         ExampleNameGenerators.init();
@@ -168,6 +173,7 @@ protected override void OnModLoad()
         // 创建事件处理器和添加新的世界日志消息的示例.
         // 它实现了两个事件处理器来处理plot开始事件和世界日志消息格式事件, 以添加新的世界日志消息类型来提示一场plot的开始.
         ExampleEventHandlers.init();
+        ExampleActorOverrideSprite.init();
     }
 
     // Example code for mod be called by other mods. You can test mod dependencies by calling this method in your mod. If no other mods call this method, this method is simply useless.

content/ExampleActorOverrideSprite.cs

@@ -0,0 +1,115 @@
+using System.Linq;
+using System.Text;
+using UnityEngine;
+
+namespace ExampleMod.Content;
+
+internal static class ExampleActorOverrideSprite
+{
+    private static readonly string[] walk_sprites =
+    {
+        "actors/races/human/unit_male_1/walk_0", "actors/races/human/unit_male_1/walk_1",
+        "actors/races/human/unit_male_1/walk_2", "actors/races/human/unit_male_1/walk_3"
+    };
+
+    private static readonly string[] swim_sprites =
+    {
+        "actors/races/human/unit_male_2/swim_0", "actors/races/human/unit_male_2/swim_1",
+        "actors/races/human/unit_male_2/swim_2", "actors/races/human/unit_male_2/swim_3"
+    };
+
+    private static readonly string[] idle_sprites =
+    {
+        "actors/races/human/unit_male_1/walk_3"
+    };
+
+    private static readonly string[] attack_sprites =
+    {
+        "actors/t_sheep/walk_0", "actors/t_sheep/walk_1"
+    };
+
+    public static void init()
+    {
+        ActorAsset asset = AssetManager.actor_library.get(SA.unit_human);
+        asset.has_override_sprite = true;
+        asset.get_override_sprite = get_human_override_sprite;
+    }
+
+    private static Sprite get_human_override_sprite(Actor actor)
+    {
+        actor.data.get("last_anim_frame_idx", out int last_frame);
+        actor.data.get("last_anim_state",     out string last_anim_state);
+        var frame_path = idle_sprites[0];
+        var curr_frame = last_frame + 1;
+        var curr_anim_state = last_anim_state;
+
+        // Check attack at first
+        if (Mathf.Abs(actor.attackTimer - actor.s_attackSpeed_seconds) < 0.01f)
+        {
+            // Just begin attack action
+            curr_frame = 0;
+            curr_anim_state = "attack";
+        }
+
+        if (actor.attackTimer > 0 && curr_anim_state == "attack")
+        {
+            // Continue play the attack animation
+            if (curr_frame >= attack_sprites.Length)
+            {
+                // attack animation finishes. Turn to idle
+                // do nothing, it can be done below
+            }
+            else
+            {
+                frame_path = attack_sprites[curr_frame];
+
+                actor.data.set("last_anim_frame_idx", curr_frame);
+                actor.data.set("last_anim_state",     curr_anim_state);
+                return get_single_sprite(frame_path);
+            }
+        }
+
+        if (actor.isAffectedByLiquid())
+            curr_anim_state = "swim";
+        else if (actor.is_moving)
+            curr_anim_state = "walk";
+        else
+            curr_anim_state = "idle";
+
+        switch (curr_anim_state)
+        {
+            case "walk":
+                curr_frame %= walk_sprites.Length;
+                frame_path = walk_sprites[curr_frame];
+                break;
+            case "swim":
+                curr_frame %= swim_sprites.Length;
+                frame_path = swim_sprites[curr_frame];
+                break;
+            case "idle":
+                curr_frame %= idle_sprites.Length;
+                frame_path = idle_sprites[curr_frame];
+                break;
+        }
+
+        actor.data.set("last_anim_frame_idx", curr_frame);
+        actor.data.set("last_anim_state",     curr_anim_state);
+        return get_single_sprite(frame_path);
+    }
+
+    private static Sprite get_single_sprite(string path)
+    {
+        var components = path.Split('/');
+
+        var folder_builder = new StringBuilder();
+        folder_builder.Append(components[0]);
+        for (var i = 1; i < components.Length - 1; i++)
+        {
+            folder_builder.Append('/');
+            folder_builder.Append(components[i]);
+        }
+
+        var sprite_list = SpriteTextureLoader.getSpriteList(folder_builder.ToString());
+        return sprite_list.FirstOrDefault(x => x.name == components.Last());
+    }
+}