Custom Building AIs

[boformer 3,169]

A small example how to replace the AI of a custom building asset on startup:

• In this example the AI extends from PlayerBuildingAI, that means it has basic stats like a construction cost, it can catch fire etc. But of course you can also extend from any other AI (BuildingAI or CommonBuildingAI if you want to start from scratch).
• The AI in this example displays a counter value in the building info window. The counter is increased after SimulationStep is called 16 times (SimulationStep is called about once every second on normal speed).
• The mod expects a local building asset with the file name "thing" and asset name "Thing".
• The AI is replaced before the prefab is initialized. That means there should be no bad side effects.
• The mod requires Harmony. Just place 0Harmony.dll in the same folder as the mod dll.
• It is not compatible with Loading Screen Mod. If you want to support LSM and LSM Test, take a look at the source code of Custom Animation Loader.

 

using ColossalFramework.Packaging;
using Harmony;
using ICities;
using UnityEngine;

namespace AiReplace
{
    public class AiReplaceMod : IUserMod
    {
        private const string HarmonyId = "boformer.AiReplace";
        private HarmonyInstance _harmony;

        public string Name => "AI Replace";
        public string Description => "Replaces AI";

        public void OnEnabled()
        {
            if (_harmony != null) return;

            Debug.Log("AiReplace Patching...");
            _harmony = HarmonyInstance.Create(HarmonyId);
            _harmony.PatchAll(GetType().Assembly);
        }

        public void OnDisabled()
        {
            _harmony.UnpatchAll(HarmonyId);
            _harmony = null;
            Debug.Log("AiReplace Reverted...");
        }
    }

    public class MyBuildingAI : PlayerBuildingAI
    {
        public override string GetLocalizedStats(ushort buildingID, ref Building data)
        {
            var counter = data.m_customBuffer1;
            return $"Counter: {counter}";
        }

        public override void SimulationStep(ushort buildingID, ref Building data)
        {
            Debug.Log("SimulationStep!");

            if ((SimulationManager.instance.m_currentFrameIndex & 0xFFF) >= 0xF00)
            {
                Debug.Log("SimulationStep was called 16 times!");
                data.m_customBuffer1++;
            }

            base.SimulationStep(buildingID, ref data);
        }
    }

    // Vanilla Asset Loader
    [HarmonyPatch(typeof(PackageDeserializer), "DeserializeGameObject")]
    public static class PackageAssetPatch
    {
        public static void Postfix(Package package, GameObject __result)
        {
            var prefab = __result.GetComponent<BuildingInfo>();
            if (prefab == null) return;

            Debug.Log($"Instantiate {package.packageName} {prefab.name}");

            // packageName is file name of the .crp file (for local .crp files)
            // prefab name is the "Asset Name" you set in Asset Editor + "_Data"
            if (package.packageName == "thing" && prefab.name == "Thing_Data")
            {
                var oldAi = prefab.gameObject.GetComponent<BuildingAI>();
                UnityEngine.Object.DestroyImmediate(oldAi);

                var newAi = prefab.gameObject.AddComponent<MyBuildingAI>();

                Debug.Log($"AI replaced!");
            }
        }
    }
}

 

 

[Strdate 16]

Nice! Maybe it would be even possible to create a mod that would save and load the custom AI libraries directly to/from the assets.

With that you could do for example buildings with working clocks without need to install additional mods.

[boformer 3,169]

Do you think you can find out how to slow down ferries/cargo/passenger ships while the bridge is opening?

Maybe by adding a custom flag to the ship line?

 

[Strdate 16]

I can try it. To be frank, at this moment I have no idea how to do it. I know a bit about car behavior, but with ships you pretty much have to start from the scratch, as there probably never was demand to alter their behavior. I check what's in TMPE.

Currently I decided to finish the "Smart Intersection Plopper". It is nasty and buggy as hell, it won't probably be a big hit, but I would like to have it off myself. Then this is definitely what I would like to work on.

[Strdate 16]

I am sorry for breaking my promise to look at how the ships work! Apparently you managed to find everything out in the meantime. Now, as always, it will be me who will be learning... Good job!

[boformer 3,169]

7 hours ago, Strdate said:

I am sorry for breaking my promise to look at how the ships work! Apparently you managed to find everything out in the meantime. Now, as always, it will be me who will be learning... Good job!

Oh there's still a lot of work to do, and there are a lot more possibilities to modify ship behavior (canal locks?) now that I found out how to slow them down!

If you are interested in the current source (Mod.cs is especially interesting), here it is: https://gist.github.com/boformer/58183421d3d9b7b2428ebf40384bd8ad