本地化系统

用于切换不同语言对应的文字素材和图片素材,主要用于UI。

API

//注册/注销语言更新时触发的事件(含有LanguageType参数的无返回值方法)
LocalizationSystem.RegisterLanguageEvent(Action<LanguageType> action)
LocalizationSystem.UnregisterLanguageEvent(Action<LanguageType> action)
//获取全局配置文件的某一语言下的数据(文本/图片)
LocalizationSystem.GetContent<T>(string key, LanguageType languageType)
//切换语言
LocalizationSystem.LanguageType = LanguageType.SimplifiedChinese;

//使用案例
//1.通过脚本直接获得全局本地化配置的数据内容
//文本string
string info = LocalizationSystem.GetContent<LocalizationStringData>("标题", LanguageType.SimplifiedChinese).content;
//Sprite图片
Sprite image = LocalizationSystem.GetContent<LocalizationImageData>("标题图片", LanguageType.SimplifiedChinese).content;
     

参数说明

  • action是一个含有languageType的单参数无返回值方法,用于结合传入的语言类型定制触发事件逻辑。
  • 泛型T(LocalizationStringData/LocalizationImageData)用于限定GetContent返回的数据类型,目前支持string和Sprite,可以进行拓展。
  • key是本地化配置文件SO中的数据key。
  • LocalizationSystem.LanguageType是当前游戏的语言类型,修改会触发索引中的语言更新方法,进而触发所有窗口的语言更新事件修改语言类型。

本地化配置文件的创建

project面板右键创建Localzation Config,通过SO的方式记录语言配置,红色框为一类素材的key,对应下属若干不同语言的素材,支持文字string或者图片Sprite内容,使用时通过调用这里的资源进行切换,可以作为全局或者专属于某一对象的本地化配置文件。

alt

全局配置

alt

将创建的Config拖拽给JKFrame下的LocalizationSystem组件,全局的本地化配置绑定完成,通过修改LocalizationSystem的LanguageType修改语言。

UI特化工具及局部配置

alt

针对UI提供特化工具,为UI对象挂载UI Localization Collector组件,注意,此时的Localization Config是一个专属于此UI的局部配置文件,为了方便建立UI对象与本地化配置数据的映射关系,可以直接通过面板拖拽的方式转递对象和其对应的配置数据key(任一语言即可),即完成了本地化配置,无需通过脚本访问。当局部配置找不到对应的key时,会去全局本地化配置表里寻找。

    public Text test;
    protected override void OnUpdateLanguage(LanguageType languageType) {
        string info = LocalizationSystem.GetContent<LocalizationStringData>("标题", languageType).content;
        info += "test";
        test.text = info;
    }

在UI框架里开放了语言更新时的事件触发,集成了UI_WindowBase的UI窗口类可以通过重写OnUpdateLanguage方法定制逻辑,比如文字拼接部分更新。

拓展

尽管本地化系统目前仅支持文字和Sprite的切换,但是对于音效,配音等资源的切换也可以很方便拓展,这部分功能就不做预制了,由开发者自行拓展,以下是拓展思路。

//拓展API
//获取全局配置文件的某一语言下的数据(文本/图片)
LocalizationSystem.GetContent<T>(string key, LanguageType languageType)

//拓展位置  LocalizationData.cs
public abstract class LocalizationDataBase
{
}
public class LocalizationStringData : LocalizationDataBase
{
    public string content;
}
public class LocalizationImageData : LocalizationDataBase
{
    public Sprite content;
}
  • 在本地化系统的内部实现中,GetContent的泛型参数T指定了本地化保存的数据类型,内置了LocalizationStringData和LocalIzationImageData两种数据类型,分别持有string成员和Sprite成员,对应文本和图片数据。
  • 有两种修改思路,一种是在已有的两个个数据类型添加额外的数据成员,比如一个武器在UI上的显示除了有描述内容还有武器的类型string。
public class LocalizationStringData : LocalizationDataBase
{
    public string content;
  	public string type;
}
  • 另外一种是直接继承抽象类LocalizationDataBase写一个新类,比如还是武器类型和武器描述的UI本地化数据,其实两种方式本质也没啥区别,只是说明数据类数量和类内的数据成员都可以扩展满足开发者想要的需求。
public class LocalizationWeaponData : LocalizationDataBase
{
    public string content;
  	public string type;
}