|
|
|
本帖最后由 zhousiyuan 于 2015-4-12 09:52 编辑
来自 http://bbs.3dmgame.com/forum.php?mod=viewthread&tid=4732004
想着以前SC4时的繁荣 现在simcity.cn越来越死气沉沉了
一直想写这篇文章，但是总觉得写出来也没几个人人能看得懂，太过于小众，就算看得懂，又能有几个人耐得住性子去调代码呢，所以就拖啊拖啊到现在。但是，中国人做的mod实在是太少了(当然整个工坊也就200来个=.=)，咬咬牙还是写吧，希望能多看到点国人做的mod，我也有个能交流的朋友是不。
本文主要阐述天际线AI类MOD开发的基础，包括天际线概念框架体系、基本API、进阶开发以及注意事项，希望能抛砖引玉，给有编程基础的朋友一个入门的方向。更多的造化就看您的努力了。本文将以公交增容MOD的源码为例进行讲解。
需要阅读者必须具备基本的面向对象基础，可使用vs studio进行开发及调试。另外由于本人主要从事java开发工作，c#纯属自学，所以有关概念表述的不一定十分准确，各位看客要自行甄别
如何搭建开发环境我在这里就不再废话了（我只提一句，是library类工程），如果你不知道怎么搭建开发环境，基本也看不懂我这篇文章。对了，按照官方的说法，你只要把c#代码写好，扔到mod文件夹下面就好了，他们会编译这些代码。但是我没有成功，我是在vs里面直接build成dll后扔到mod里的，效果一样。
一、首先是天际线的基本概念体系，以及AI在其中所起的作用。
游戏里有很多的建筑物、人、车等事物。这些东西都有自己的属性，比如位置在哪？颜色？是生老病死，还是3级5级？移动速度？等等，描述的是物体的客观状态。还有一类，就是这些事物的行为方式：例如小人是去买东西，还是去上班？出门是坐公交还是自己开车？公交车下一站往哪开？建筑物是升级还是废弃？这些基本都是由各个物件自己决定的，那么这个决策部分，就称之为AI，用面向对象来说，就是行为/方法（method）
比如市民，市民是一个类，名字、男女、年龄、教育程度、健康状况、是否在开车等等，是属性。但是市民有几十万，每一个市民都有自己不同的属性，有几十万的对象，在内存里都要占用相应的位置，但是他们的AI是一致的，AI只有一个。修改了这个AI，所有市民的行为方式都会相应变化。
然后是天际线中跟AI相关的有如下常见类名后缀：
AI、Manager、Info（当然还有很多与UI相关的，我就不再列举了，跟本文关系不大）
AI毫无疑问就是AI类的了，CitizenAI就是市民AI（这里我简单化了，后面我会详细讲到，这个CitizenAI其实不是“居民AI”）
Manager是所有相关对象引用的管理类，比如CitizenManager就是管理所有市民的管理器，无论是创建一个市民，还是查询所有生病的市民，都要通过这个管理器
Info是一类对象的“模板”。这里我用建筑物来解释。比如警察总局，就是一个BuildingInfo类的对象。里面定义了这个物件的名称叫“警察总局”，所有警察总局的属性，比如造价、维护费用、占地大小等等，都是在这里的，警察总局的AI，也是在这里有一个引用（AI是另外一个类）。不管你在游戏中建几个“警察总局”，这个BuildingInfo对象都会只有一个，但是不同位置的警察总局，会有多个不同的Building对象(其实是struct)来表达，比如具体的xz位置（y在天际线里是高度轴），或者你给他改名叫“天下第一警察总局”，那么名字也是存在这里的。
接着，是跟AI相关的横向概念。
天际线里AI总共分4类：建筑物（Building）、车辆(Vehicle)、市民(Citizen)、路网(Net)。
每类都会有一个上述英文名称的struct来表达数据， 以及配套的前述3个类（AI、Manager、Info），和众多的相关衍生类。
当然这也只是一个最基本的分类，最深的继承关系可达7层，由于此图是在是太大，所以我在下图仅以市民AI举例说明：
在天际线中，CitizenAI其实应该翻译成是“生物AI”好点。它有2个子类：动物AI和人类AI。也就是说，你在游戏中看到的鸟啊，宠物狗啊什么的，其实都是算作是Citizen，都用Citizen这个struct来存储数据的，占用那104万上限。动物AI就不说了。人类AI中又分为服务人员AI（就是消防队那个灭火的小人、灵车抬尸体的小人等）、旅游者AI和居民AI。这里最多的就是居民了，104万的上限，我看有人达到了101万。
那么，这所有的104万的Citizen，全部都是由CitizenManager来管理的。CitizenManager中有创建市民的方法,销毁的方法，查询的方法等。当前市民数量、Citizen集合的引用等信息，都是这个类的变量，市民的总数上限啊、市民出行开车的概率啊、生孩子的概率啊、成为gay的概率啊等等常量，也都在这里。这个CitizenManager是单例的，你不能显式的去创建这个对象，调用单例的方法后面的代码里有。
另外还要提一句，市民上限是100万多点，但是不代表所有的市民都会被显卡“画出来”，只有被实例化（Instance）的市民，才会交给frame，去具体的在界面上画出来。Instance的上限，我记得是65000+，所以大家不用担心人多了显卡“画”不动
二、基本API解读
官方给出了一个基本的API文档。但是。。真的是太基本了，基本什么也做不了。但是给的这些API又确实非常基础，无论你做什么MOD，这几个API还确实是很常用的。所以还是要大体上说一下的。
1、IUserMod
最简单，最常用的interface，没有之一。就是定义MOD的名称和描述。基本没其他作用。
代码：
using ICities;
namespace SuperBigTransport
{
public class Mod : IUserMod
{
public const int unit_number = 16;
public string Name
{
get
{
return "【SB】超级客运"+ unit_number * 5 + "人版 | SuperBigTransport "+ unit_number * 5;
}
}
public string Description
{
get
{
return "公交车容量改为"+ unit_number * 5 + "，火车改为" + unit_number * 5 * 8+ ",地铁改为" + unit_number * 5 * 6;
}
}
}
}
要注意的是namespace的定义。有些同学说我的mod怎么冲突了，其实就是这个namespace重名了。所以，不同的mod必须要起不同的namespace，即使类名不同也不行。所以推荐跟你的mod名称对应。
其他应该很简单吧。。。我觉得好像没什么要解释的。。。unit_number这个问题我后面再说。
2、LoadingExtensionBase
这个抽象类是在游戏存档加载时生效的（包括新建游戏）。
4个方法，create、release是单例创建和销毁时触发的，这个貌似很少用
比较常用的是load和unload方法，就是存档加载和退出时的方法。
看代码：
using System;
using System.Collections.Generic;
using ColossalFramework;
using ICities;
using UObject = UnityEngine.Object;
namespace SuperBigTransport
{
public class LoadingExtension : LoadingExtensionBase
{
public override void OnLevelLoaded(LoadMode mode)
{//游戏加载开始。
ForEachPrefab((VehicleInfo i) =>//在读取所有车辆信息时,对每一个车辆信息进行处理。主意这里不是每一辆车，是每一类车，注意是Info类
{
ReplaceVehicleAI<BusAI, BigBusAI>(i); //替换BusAI类为我们自定义的AI类
ReplaceVehicleAI<PassengerTrainAI, BigPassengerTrainAI>(i);//替换客运火车类AI。游戏里的地铁和客运火车是不同的AI，但是他们都继承自这个PassengerTrainAI，并且也仅有这两个AI继承这个类，所以我直接替换了他们的基类
});
//游戏加载结束
}
static void ReplaceVehicleAI<TOldAI, TNewAI>(VehicleInfo i)//这个就是替换AI用的方法
where TOldAI : VehicleAI
where TNewAI : VehicleAI, IAIReplacement<TOldAI>, new()
{
var oldAI = i.gameObject.GetComponent<TOldAI>();
if (oldAI == null)
return;
i.gameObject.AddComponent<TNewAI>();//必须先把新的AI注册进去，再取出来。。好奇怪的写法，但是不这么写不行
var newAI = i.gameObject.GetComponent<TNewAI>();
newAI.CopyFrom(oldAI);//AI也有属性，如果要替换，必须把原有的属性也全部对拷，否则就会出现各种奇怪的情况
i.m_vehicleAI = newAI;
UObject.Destroy(oldAI);
newAI.InitializeAI();
}
static void ForEachPrefab<T>(Action<T> f) where T : PrefabInfo
{
for (var i = 0u; i < PrefabCollection<T>.LoadedCount(); i++)
f(PrefabCollection<T>.GetLoaded(i));
}
}
interface IAIReplacement<in T>
{
void CopyFrom(T ai);
}
}
3、ThreadingExtensionBase
这个类其实也还算是常用的，就是在游戏画面（frame）每次刷新时，触发的地方。只是在公交增容这个mod里我没用到。需要注意的是，这个类中的update()方法，触发的频率非常高，不要试图在这个方法里做很复杂的事情，基本判断个bool值，或者是算个简单地数字就好了，指望这里进行复杂的对象操作，或者是打印日志什么的，只有一个下场，就是游戏永远处于加载状态，cpu飙升。
一般如果你要做界面什么的，才会用到这个类。
到这里基本结束。剩下的几个官方接口，我觉得都是很好理解的，没什么要特别说的了，而且公交增容这个mod也没用到。我觉得一般大家看看也就能理解了。
所以呢，大家会感觉到，啊？这就是官方接口？怎么没见你写什么代码来让公交增容啊？恩，就是这样的，所以我才说，官方给的API，基本什么也做不了。
三、进阶篇
然后就是我们的hack时间了。这部分没有任何官方说明，出现的bug也只能靠我们自己解决，出现任何奇怪的事情都是正常的。然后我们继续。
要替换官方的BusAI，最简单的方法我相信大家已经猜到了，就是继承官方的AI，然后仅仅修改我们需要修改的部分就好了。那么，我也是这么干的。
看代码：
using ColossalFramework;
using UnityEngine;
namespace SuperBigTransport
{
class BigBusAI : BusAI, IAIReplacement<BusAI>//继承官方的BusAI
{
public void CopyFrom(BusAI ai)//我们自己定义的接口，主要用于两个AI的属性对拷
{
m_passengerCapacity = Mod.unit_number * 5;//这里是公交的容量，但是这个数字仅仅是显示用的，实际上，能上多少人不已这里为准。窃以为，这是官方代码的bug
m_ticketPrice = ai.m_ticketPrice;//车票多少钱，这个我没改过，不知道是不是只改这里就是增加车票收入，有兴趣的同学可以试试。
m_info = ai.m_info;//info，就是bus的基本信息，busInfo，前面提到过的，忘了的话自己回去看。但是不管它是什么，拷过来就好了
}
public override bool ArriveAtDestination(ushort vehicleID, ref Vehicle vehicleData)//复写官方的车辆到站后的处理逻辑。官方的方法里，车到站以后有很多的判定步骤，要判断该下多少人，能上多少人，是否是终点站，等等一大堆。我没把握能全部写好，而能上多少人这个方法它又是private的（日），所以，只能改这个，并且最后一步还的调用base的方法。
{
var citizenManager = Singleton<CitizenManager>.instance;//OK这里就是调用各种Manager单例的方法，前面欠大家的代码这里补上了。
var unitId = vehicleData.m_citizenUnits;//好了，这里涉及到另一件事情，是citizen所特有的概念，citizenUnit，前面的public const int unit_number = 16;就是跟这个相关的。这里呢，每个citizenUnit里面能装5个citizen，一个citizen可以被装在多个citizenUnit里，装的也仅仅是引用。citizenUnit是一个链表结构，citizenUnit有一个属性是nextUnit，就是下一个citizenUnit的引用，如果没有下一个，就是0，说明链表结束。那么这个citizenUnit用在哪里呢？这么说，所有能装人的地方，本质上就是这个citizenUnit有多长的结构。每辆车、每个建筑物，都有一个citizenUnit的引用，指向的是第一个citizenUnit的位置。所以，我们要增容，就是扩展这个citizenUnit。
var cu = citizenManager.m_units.m_buffer[unitId];//这行代码说明，citizenUnit也是由CitizenManager来统一管理的
int i = 1;
while (cu.m_nextUnit>0) {//判一下当前的容量数是多少
i++;
cu = citizenManager.m_units.m_buffer[cu.m_nextUnit];
}
if (i != Mod.unit_number) {//如果不等于预期，就改
uint firstId;
var random = new ColossalFramework.Math.Randomizer();
citizenManager.CreateUnits(out firstId, ref random, 0, vehicleID, 0, 0, 0, Mod.unit_number * 5, 0);//citizenUnit既然是由CitizenManager来统一管理的，那么创建肯定也是由CitizenManager来统一做的。我们简单的在这里创建了一个符合我们预期长度的citizenUnit
vehicleData.m_citizenUnits = firstId;//然后粗暴的直接替换
//citizenManager.ReleaseUnits(unitId);//这里不能释放，释放了市民就找不到路了。释放了有什么效果请自行观察。
}
return base.ArriveAtDestination(vehicleID, ref vehicleData);
}
}
}
好了，这里就是我们增容的核心代码了。那么现在有一个bug，就是公交会闪。在这里我表示我非常的冤枉，跟我真的没啥关系。。。。我没动frame..我只是替换了个数组。。。。
所以，这个替换是非常生硬的，直接的后果就是会导致存档发生变化。即使关闭了mod，也无法改变已经客观存在的链表结构。所以我说嘛。。官方偷懒。。不好好的调用那个容积属性进行判断。。非要搞数组，还是链表结构的。。。真是无语。
然后，上面只是公交车的，下面是地铁和客运火车的。我直接贴代码了，因为结构差不多，我就不解释了。有一个小bug，会导致一个不合理的现象，但是很隐蔽，不知道大家能发现么？
using ColossalFramework;
using System.Collections.Generic;
namespace SuperBigTransport
{
class BigPassengerTrainAI : PassengerTrainAI, IAIReplacement<PassengerTrainAI>
{
public void CopyFrom(PassengerTrainAI ai)
{
m_passengerCapacity = Mod.unit_number * 5;
m_ticketPrice = ai.m_ticketPrice;
m_info = ai.m_info;
m_arriveEffect = ai.m_arriveEffect;
m_transportInfo = ai.m_transportInfo;
}
CitizenManager citizenManager = Singleton<CitizenManager>.instance;
public override bool ArriveAtDestination(ushort vehicleID, ref Vehicle vehicleData)
{
var unitId = vehicleData.m_citizenUnits;
var cu = citizenManager.m_units.m_buffer[unitId];
int i = 1;
while (cu.m_nextUnit > 0)
{
i++;
cu = citizenManager.m_units.m_buffer[cu.m_nextUnit];
}
uint firstId;
int n;
if (i < Mod.unit_number)
{
var random = new ColossalFramework.Math.Randomizer();
if (vehicleData.m_transferType==39)//metro
{
n = (Mod.unit_number-i) * 5*6 + 30;
citizenManager.CreateUnits(out firstId, ref random, 0, vehicleData.GetFirstVehicle(vehicleID), 0, 0, 0, n, 0);
}else
{
n = (Mod.unit_number-i) * 5 *8 + 30;
citizenManager.CreateUnits(out firstId, ref random, 0, vehicleData.GetFirstVehicle(vehicleID), 0, 0, 0, n, 0);
}
vehicleData.m_citizenUnits = firstId;
//citizenManager.ReleaseUnits(unitId);
}
else if (i > Mod.unit_number)
{
var random = new ColossalFramework.Math.Randomizer();
if (vehicleData.m_transferType == 39)//metro
{
firstId = citizenManager.m_units.m_buffer[unitId].m_nextUnit;
citizenManager.ReleaseUnits(unitId);
vehicleData.m_citizenUnits = firstId;
n = (Mod.unit_number - 6) * 5 * 6 + 30;
}
else
{
firstId = citizenManager.m_units.m_buffer[unitId].m_nextUnit;
citizenManager.ReleaseUnits(unitId);
vehicleData.m_citizenUnits = firstId;
n = (Mod.unit_number - 6) * 5 * 8 + 30;
}
citizenManager.CreateUnits(out firstId, ref random, 0, vehicleData.GetFirstVehicle(vehicleID), 0, 0, 0, n, 0);
vehicleData.m_citizenUnits = firstId;
}
return base.ArriveAtDestination(vehicleID, ref vehicleData);
}
}
}
四：其他要交代的
打印调试语句：
DebugOutputPanel.AddMessage(MessageType.Message,"output something");
进入游戏后按F7，即可调出控制台
替换官方AI会导致跟其他mod冲突的概率大大加大，换句话说，如果其他mod也试图跟你替换同一个AI，那么一定最后只会有一个成功。所以，后来我基本不再写替换官方AI的MOD了。做的那个出乎我自己意料的、大家很喜欢的、停车收费降居民需求的MOD，其实就是我替换自己建筑物的AI，从理论上讲，基本不会跟别人冲突掉。
另外，这个游戏是使用的UnityEngine引擎。其中大量的模拟了物理方面的规则。所以，在改代码的时候，时刻要牢记一定要符合物理规则。比如，把车辆速度调快，确实车速会增加的，但是，拐弯的时候也会翻车的，很真实，符合物理规则。
|
|
SC小狗仔
发表于 2015-4-11 09:49
SC工程吊车
变色卡
显身卡