ローカライズ対応の実装例②

　前回に引き続き、多言語対応(ローカライズ対応)の実装例について紹介します。

　ゲーム内に言語設定を用意し、この設定を切り替えると、画面の再読み込みを行わず、動的に表示される文字の言語切り替えを行います。

＜完成動画＞

１．LocalizeMasterData クラスの作成

　Json 形式のファイルや、スクリプタブル・オブジェクト用のデータを取得してゲーム内で利用するためのクラスを用意します。
System.Serializable 属性を忘れずに付与してください。

LocalizeMasterData.cs

<= クリックすると開きます

[System.Serializable]
public class LocalizeMasterData
{
    public string tag;
    public string[] languageDatas;
}

　次の手順は、マスターデータを管理する方法によって異なります。
実装方法により、【２】か【３】のいずれかに進んでください。

２．言語のマスターデータ管理にスクリプタブル・オブジェクトを利用する場合

１．LocalizeMasterDataSO クラスの作成

　先ほど作成した LocalizeMasterData を List で管理する、スクリプタブル・オブジェクトを作成します。

LocalizeMasterDataSO.cs

<= クリックすると開きます

using UnityEngine;
using System;
using System.Collections.Generic;

[CreateAssetMenu(fileName = "LocalizeMasterDataSO", menuName = "Localization/LocalizeMasterData")]
public class LocalizeMasterDataSO : ScriptableObject
{
    public List<LocalizeMasterData> localizeMasterDataList = new ();
}

２．LocalizeMasterDataSO スクリプタブル・オブジェクトの作成

　Project 内に Datas フォルダなどを作成し、そのフォルダ内にLocalizeMasterDataSO スクリプタブル・オブジェクトを作成します。

　任意の情報を登録してください。

　あるいは、スプレッドシートの情報をそのままスクリプタブル・オブジェクトに取り込む方法を実装してください。

　　=>　スプレッドシートのシート別の情報を異なるスクリプタブル・オブジェクトに取り込む

３．言語のマスターデータ管理にクラウドを利用する場合

　ここでは PlayFab を利用した例を提示します。

１．PlayFab のタイトルデータに Json データを登録する

　PlayFab の GameManager 画面からコンテンツ → タイトルデータを選択し、新しいタイトルデータを作成します。
Key には LocalizeMasterData と登録し、Value には前回の手順で Json 形式で書き出している内容をそのまま貼り付けます。

２．JsonHelper スクリプトの作成

　Unity 内に Json データを取り込む際、JsonHelper クラスを利用します。

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using System;
using System.IO;
using System.Text;

public class JsonHelper {

    /// <summary>
    /// Jsonファイルをstringで読み込む
    /// </summary>
    /// <param name="filePath"></param>
    /// <param name="fileName"></param>
    /// <returns></returns>
    public static string GetJsonFile(string filePath, string fileName) {
        string fileText = "";

        // JsonFileを読み込む
        FileInfo info = new FileInfo(Application.streamingAssetsPath + filePath + fileName);
        try {
            // 一行毎読む込み
            using (StreamReader reader = new StreamReader(info.OpenRead(), Encoding.UTF8)) {
                fileText = reader.ReadToEnd();
            }
        } catch (Exception e) {
            // 改行コード
            fileText += e + "\n";
        }
        //Debug.Log(fileText);
        return fileText;
    }

    public static List<T> ListFromJson<T>(string json) {
        var newJson = "{ \"list\": " + json + "}";
        Wrapper<T> wrapper = JsonUtility.FromJson<Wrapper<T>>(newJson);
        return wrapper.list;
    }

    [Serializable]
    class Wrapper<T> {
        public List<T> list;
    }
}

３．StringManager クラスの作成

　シングルトンクラスとして作成しています。

　現在ゲーム内で選択している言語設定を保持したり、PlayFab のタイトルデータの情報を取得し、Unity 内でキャッシュしておくためのクラスです。
サーバーを利用する場合、スクリプタブル・オブジェクトの代わりに、専用のクラスでローカライズ対応用の情報を保持しておきます。

　PlayFab へのログイン処理や、タイトルデータから情報を取得する処理自体についてはここでは省略しています。
記事が多く出ていますので、それらを参考に実装してください。

　enum である Language 型の情報を ReactiveProperty で用意していますので、こちらの情報を購読することにより、ゲーム内での動的な言語切り替えを表現します。

<= クリックすると開きます

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using UniRx;
using System.Linq;
using UniRx.Triggers;

/// <summary>
/// 言語の種類
/// </summary>
public enum Language {
    jp,
    en,

    // TODO 他にもあるなら、言語種類を追加

}

public class StringManager : MonoBehaviour
{
    public static StringManager instance;

    public ReactiveProperty<Language> CurrentLanguage = new(Language.jp);
    public List<LocalizeMasterData> localizeMasterDataList = new();


    void Awake() {
        if(instance == null) {
            instance = this;
            DontDestroyOnLoad(gameObject);
        } else {
            Destroy(gameObject);
        }

        // デバッグ用
        this.UpdateAsObservable()
            .Subscribe(_ => CurrentLanguage.SetValueAndForceNotify(CurrentLanguage.Value));
    }

    /// <summary>
    /// PlayFab の TitleData を LocalizeMasterData 型の List に変換
    /// </summary>
    /// <param name="titleData"></param>
    public void SetLocalizeDatas(Dictionary<string, string> titleData) {

        //  LocalizeMasterData 型の List に変換する
        localizeMasterDataList = JsonHelper.ListFromJson<LocalizeMasterData>(titleData["LocalizeMasterData"]).ToList();
    }

    /// <summary>
    /// Tag に該当する LocalizeData を取得
    /// </summary>
    /// <param name="searchTag"></param>
    /// <returns></returns>
    public LocalizeMasterData GetLocalizeData(string searchTag) {
        return localizeMasterDataList.Find(data => data.tag == searchTag);
    }

    /// <summary>
    /// 言語変更
    /// </summary>
    /// <param name="newLanguage"></param>
    public void ChangeLanguage(Language newLanguage) {
        CurrentLanguage.Value = newLanguage;
    }
}

４．LocalizeText クラスの作成

　ここからは共通の実装処理になります。

　ローカライズ対応したい TextMeshPro コンポーネントや TextMeshProUGUI コンポーネントを制御するためのクラスです。
このクラスも、それらのコンポーネントと同じゲームオブジェクトにアタッチして利用します。

　このクラス内で StringManager クラスの ReactiveProperty<Language> 型の CurrentLanguage 変数を購読し、
言語の切り替えが発生したタイミングで、画面の表示更新を行い、新しい言語に対応した表示を自動的に行うように紐づけています。

<= クリックすると開きます

using UnityEngine;
using TMPro;
using UniRx;

public class LocalizeText : MonoBehaviour
{
    [SerializeField]
    private TMP_Text txtLocalize;

#pragma warning disable 0108
    [SerializeField] private string tag;
#pragma warning restore 0108

    // マスターデータをキャッシュ
    [SerializeField] 
    private LocalizeMasterData localizeData;  // デバッグ終わったら SerializeField 外す


    void Reset() {
        TryGetComponent(out txtLocalize);
        Debug.Log(txtLocalize);
    }

    void Start(){

        // tag が登録されていない場合には処理しない
        if (string.IsNullOrEmpty(tag)) {
            return;
        }

        // Tag からマスターデータ取得してキャッシュ(tag 内の全言語分キャッシュ済み)
        localizeData = StringManager.instance.GetLocalizeData(tag);

        // 言語監視
        StringManager.instance.CurrentLanguage.Subscribe(Language => UpdateLocalizeText(Language)).AddTo(this);
    }

    /// <summary>
    /// 言語変更による表示の切替
    /// </summary>
    /// <param name="newLanguage"></param>
    private void UpdateLocalizeText(Language newLanguage) {
        txtLocalize.text = localizeData.languageDatas[(int)newLanguage];
    }
}

５．LocalizeText ゲームオブジェクトの作成とプレハブ化

　先ほど作成した LocalizeText スクリプトをアタッチして、言語表示を行うためのゲームオブジェクトを作成します。
すでに作成済の場合には、スクリプトをアタッチしてください。

　完成したらプレハブ化しておきます。

　あとは、ゲーム内で利用するすべての言語表示に、こちらのプレハブを利用するようにしてください。

　そうすれば、言語表示の切り替え機能だけではなく、アウトラインなどのエフェクト、フォントの差し替え対応も一括で変更可能です。

６．実装例

　ゲームを実行して動作を確認します。

　PlayFab の場合、ログイン後、タイトルデータからローカライズ対応用のマスターデータを取得し、
StringManager クラスにキャッシュしておきます。

　ゲーム内で利用する LocalizeText ゲームオブジェクトには、タグの設定が出来ますので、
そちらを任意のタグに設定します。

　そのようにしておくことで、LocalizeMasterData 内のタグと照合し、表示する内容を自動化できます。
同時に言語切り替え時のローカライズ対応も可能になります。

＜実装動画＞

　以上で完成です。

　ここまでで文字列をそのままローカライズする場合については処理は終了です。

　文字列内の情報をゲーム内の情報を参照して、１つの文字列を作る場合には、引き続き、ローカライズ対応の実装を行います。

　例えば「こんにちは ○○ さん」のような、○○部分がゲーム内の情報に依存する文字列をローカライズ対応するケースです。

　　=>　ローカライズ対応の実装例③

このページを編集するこのページを元に新規ページを作成

印刷する

コメント（0）

ローカライズ対応の実装例② - i-school 先頭へ

コメントをかく

名前	ユーザIDを使用しないで書き込む	ユーザーIDを使う	ログインする
画像コード	画像に記載されている文字を下のフォームに入力してください。
備考	「http://」を含む投稿は禁止されています。
本文
利用規約をご確認のうえご記入下さい

i-school