管理テキスト
管理テキスト機能を使用すると、ゲーム内のUI文字列やキャラクターの表示名など、Naninovel全体で使用されるさまざまなテキスト要素を、ローカライズ可能なドキュメントを介して管理(置換)できます。
管理テキストドキュメントを生成するには、Naninovel -> Tools -> Managed Text エディターメニューからアクセスできる管理テキストツールを使用します。
「Select」ボタンを使用して、管理テキストドキュメントを保存するパス(デフォルトでは Resources/Naninovel/Text)を選択し、「Generate Managed Text Documents」を押してドキュメントを作成します。
Create -> Naninovel -> Managed Text アセットコンテキストメニューを使用して、カスタム管理テキストドキュメントを作成することもできます。
管理テキストドキュメントの各行は、次の形式のエントリです:パス: 値。ここで、パスはテキスト変数へのパスであり、値はその変数の値です。たとえば、以下は組み込みUIのレコードを含む「DefaultUI」ドキュメントのデフォルトの内容です。
値を編集でき、変更は次回の実行時に適用されます。
ドキュメントがすでに存在する場合、ツールは現在の値を保持しますが、ManagedTextProvider コンポーネントやソースコードの ManagedText 属性(詳細は以下を参照)から参照されなくなったレコードなど、生成されなくなったレコードは削除します。
ヒント
管理テキスト値に改行を挿入するには、TMProテキストが標準でサポートしている <br> タグを使用します。
管理テキストプロバイダー
ManagedTextProvider コンポーネントを使用すると、スクリプトを使用せずに任意のUnityゲームオブジェクトを管理テキストレコードにバインドできます。コンポーネントをゲームオブジェクトに追加し、Document(ドキュメント名)と Key(ドキュメント内のレコード名)を指定し、OnValueChanged イベントを使用して値をゲームオブジェクトのプロパティにバインドします。
以下は、「MyCustomDocument」ドキュメントにキー「MyCustomText」で保存された管理テキストレコードをUnityの Text コンポーネントにバインドする例です。
カスタムUI、テキストプリンター、または選択肢ハンドラーで ManagedTextProvider コンポーネントを使用し、そのリソースを構成メニューで割り当てている場合は、管理テキストツールが対応するレコードを自動生成します。それ以外の場合は、別のドキュメントに手動でレコードを追加する必要があります。ツールが生成するドキュメントに手動でレコードを追加しても、生成時に削除されるためです。
管理テキスト変数
管理テキストレコードをソースコード内の変数にバインドすることも可能です。これを行うには、ManagedText 属性を静的文字列フィールドに追加します。フィールドの値は、エンジンの初期化時に管理テキストドキュメントで指定された値で上書きされます。
以下は、管理テキスト変数を使用してC#スクリプト内のテキストラベルをローカライズする例です。
using Naninovel;
using UnityEngine.UI;
// UnityのTextコンポーネントを継承して、Textコンポーネントとして使用できるようにします。
public class CustomLabel : Text
{
// 「CustomLabel.LabelText」管理テキストレコードの値は、エンジンの初期化時に
// 以下の変数に代入され、ロケールの変更時に更新されます。
[ManagedText("foo")] // "foo" はレコードのドキュメント名です。
public static string LabelText = "bar"; // "bar" はデフォルト値です。
protected override void Awake ()
{
base.Awake();
text = LabelText; // 現在のレコード値をラベルに割り当てます。
var l10n = Engine.GetService<ILocalizationManager>();
// プレイヤーが実行時にロケールを変更したときにラベルを更新します。
l10n.OnLocaleChanged += _ => text = LabelText;
}
}スクリプトテキスト
シナリオスクリプトから直接管理テキスト値を参照できます。これは、シナリオ式でローカライズ可能なテキストを使用したい場合に役立ちます。
Script という名前の管理テキストドキュメントを作成し、レコードを追加します。Script 管理テキストドキュメントに次のレコードがあるとします。
Greeting1: やあ!
Greeting2: こんにちは!
Greeting3: どうも!— 次のように値を参照できます。
@print { random(Greeting1, Greeting2, Greeting3) }Script 管理テキストドキュメントは、他のドキュメントと同じ方法でローカライズできます。プレイヤーが別のロケールを選択すると、テキストは対応するローカライズされたドキュメントから自動的に参照されます。
ローカライズ
管理テキストのローカライズは、シナリオスクリプトと同様のワークフローに従います。
Resources/Naninovel/Textフォルダーに必要な管理テキストドキュメントを生成(作成/編集)します。- ロケールフォルダー(
Resources/Naninovel/Localization/{Locale}、ここで{Locale}はターゲットロケールタグ)でローカライズユーティリティを実行します。 - ソースとなる管理テキストドキュメントのローカライズドキュメントが、対応するロケールフォルダーに作成されます。それらを使用して翻訳を追加または編集します。
管理テキストドキュメントとそれに対応するローカライズ版を更新するには、まず Resources/Naninovel/Text フォルダーで管理テキスト生成ユーティリティを実行し、次に Resources/Naninovel/Localization/{Locale} でローカライズユーティリティを実行します。どちらのユーティリティもデフォルトで既存の変更(管理テキストレコードとその翻訳)を保持しようとするため、更新ごとにすべてを書き直す必要はありません。
ローカライズユーティリティの使用方法の詳細については、ローカライズ を参照してください。
例
ローカライズサンプル に、ローカライズ設定の例(管理テキストを含む)があります。自分のプロジェクトでのローカライズの設定に問題がある場合は、参考にしてください。
カスタムドキュメント
独自のニーズに合わせて任意の数の管理テキストドキュメントを作成し、エンジンが初期化された状態であればC#から使用できます。これらのカスタムドキュメントは、上記で説明した組み込みのドキュメントと同じように機能します。C#とシナリオスクリプトの両方からアクセスしたり、ManagedTextProvider コンポーネントを介してレコードを取得したり、ローカライズドキュメントを自動生成したりできます。
Create -> Naninovel -> Managed Text アセットコンテキストメニューを使用して、Resources/Naninovel/Text フォルダーの下に新しいカスタム管理テキストドキュメントを作成します(または、任意のリソースプロバイダーを介して公開します)。その後、C#で ITextManager エンジンサービスを介してドキュメントにアクセスできるようになります。以下は、内容が Foo: Bar である Custom という名前のカスタムドキュメントのレコードにアクセスする例です。
var manager = Engine.GetService<ITextManager>();
// ドキュメントはアクセスする前にロードする必要があります。
// 通常、カスタムシステムの初期化中に一度行われます。
await manager.DocumentLoader.Load("Custom");
var document = manager.GetDocument("Custom");
var record = document.Get("Foo");
Debug.Log($"Key: {record.Key} Value: {record.Value}");