MultilingualUtility

更新记录

版本 日期 修改人 修改内容
1.0.0 2020年8月7日 蔺浪(510525) 新建文档

概况

组件包

  • Nd.VLab.PlayerCore 1.4.0-preview1

程序集

  • VLabPlayerCore.dll

代码引用

//命名空间
namespace NDVLab.PlayerCore.Utility

//接口实例
MultilingualUtility

[I] 当前语言

接口签名:

static string CurrentLanguage{get;}

接口说明:

  • 当前语言

[I] 语言改变事件

接口签名:

static event EventHandler<LanguageChangedEventArgs> OnLanguageChanged

接口说明:

  • 当前语言环境发生改变事件(回传当前语言标识)

参数说明:

  • LanguageChangedEventArgs
属性 类型 说明
Language string 当前语言

[I] 初始化

接口签名:

static bool Initialize(string languageDir, string language)

接口说明:

  • 初始化(再次调用相当于重置)
  • 从languageDir下载入[language].ini文件内容

参数说明:

参数名 类型 说明
languageDir string 语言文件目录,该目录下存放各语言配置文件,命名遵循[language].ini, 例如:SimplifiedChinese.ini
language string 当前语言,与语言文件命名一致,例如:SimplifiedChinese

返回值说明

类型 说明
bool 是否成功初始化?

[I] 追加语言资源目录

接口签名:

static bool AppendLanguage(string languageDir)

接口说明:

  • 追加语言资源目录
  • 从追加的目录下加载当前语言对应的语言文件内容
  • 使用场景:应用初始化语言目录后,接入的一些组件(例如PlayerCoreUI组件)也需要载入其语言资源,则可以使用该接口追加语言资源目录并载入其语言文件内容

参数说明:

参数名 类型 说明
languageDir string 语言文件目录,该目录下存放各语言配置文件,命名遵循[language].ini, 例如:SimplifiedChinese.ini

返回值说明

类型 说明
bool 是否成功追加语言资源目录?

[I] 切换当前语言

接口签名:

static bool SwitchLanguage(string language)

接口说明:

  • 切换当前语言
  • 仅支持本地文件配置的多语言设置/切换
  • 资源中心目前不支持运行时切换语言

参数说明:

参数名 类型 说明
language string 当前语言,与语言文件命名一致,例如:SimplifiedChinese

返回值说明

类型 说明
bool 是否成功切换当前语言?

[I] 获取翻译文本

接口签名:

static string Translate(string key, string defaultValue = null)

接口说明:

参数说明:

参数名 类型 说明
key string 多语言key
key defaultValue 未成功匹配时期望返回的默认值(不需要默认值则该参数不要赋值, 若赋值为string.Empty, 则未翻译成功时返回string.Empty; 若赋值为null, 则未翻译成功时返回传入的原key)

返回值说明

类型 说明
string 当前语言下Key对应的翻译文本

相关链接