API
Return to top
LanguageUtil
编辑

工具 / LanguageUtil

LanguageUtil Class
​

多语言工具

Table of contents ​

Methods
​

addKey(textkey: string): string
多语言标记
getDefaultLocale(): string
获取默认的语言和地区
getText(textkey: string): string
根据key获取翻译内容
setLanguage(type: LanguageCodeType): boolean
游戏语言设置

Methods ​

addKey
​

• Static addKey(textkey): string

多语言标记

Parameters ​

textkey string用户多语言配置表收集的 Key range: 不做限制

Returns ​

string返回Key，此函数只用于做翻译文本收集标识。

getDefaultLocale
​

• Static getDefaultLocale(): string

获取默认的语言和地区

Returns ​

string可选ISO 3166-1 国家码 (如, "CN")
使用示例:创建一个名为LocaleExample的脚本，放置在对象栏中，打开脚本，将原本内容修改为如下内容，保存并运行游戏，日志会输出默认的语言和地区
ts
@Component
export default class LocaleExample extends Script {

    protected onStart(): void {
        if (!SystemUtil.isClient()) return;
        this.test();
    }

    private async test(): Promise<void> {
        const locale = LocaleUtil.getDefaultLocale();
        console.log(`locale: ${locale}`);
// zh-CN
    }
}
@Component
export default class LocaleExample extends Script {

    protected onStart(): void {
        if (!SystemUtil.isClient()) return;
        this.test();
    }

    private async test(): Promise<void> {
        const locale = LocaleUtil.getDefaultLocale();
        console.log(`locale: ${locale}`);
// zh-CN
    }
}

getText
​

• Static getText(textkey): string

根据key获取翻译内容

Parameters ​

textkey string需要查找的翻译的 key range: 不做限制

Returns ​

string返回Key对应的当前语言环境的翻译内容

setLanguage
​

• Static setLanguage(type): boolean

游戏语言设置

Parameters ​

type LanguageCodeType切换游戏语言种类

Returns ​

booleantrue修改成功 false修改失败