このセクションでは、UIモジュール(あるいは .mod ファイル)の使用方法について記述します。 .mod ファイルには、インターフェースの一部についてのメタデータが格納されています。
UI Module | このセクションでは、UIモジュール(あるいは .mod ファイル)の使用方法について記述します。 .mod ファイルには、インターフェースの一部についてのメタデータが格納されています。 |
実装の詳細 | ゲームインターフェースに新たな要素を追加するためには、新たなUIモジュール、あるいは「UiMod」を作成しなければなりません。 |
XML定義 | |
要素 - 最上位 | |
ModuleFile | UIモジュールXMLファイルの中でも最上位のXMLタグです。 |
子要素 - ModuleFile | |
UiMod | UIモジュールの名前やバージョン、日付を記録しておくための要素です。 |
子要素 - UiMod | |
Author | モジュールの作者の情報を記録しておくための要素です。 |
Description | モジュールについての簡単な説明を記録しておくための要素です。 |
Dependencies | このモジュールを初期化する前に、他のモジュールを読み込んで初期化するよう要求できます。 |
Files | このモジュールで読み込むXML/Luaファイルを指定します。 |
SavedVariables | 変数を保存するテーブル指定します (調査中)。 |
Hotkeys | (調査中) |
Options | (調査中) |
子要素 - UiMod (システムアクション系) | |
OnInitialize | 各モジュールの初期化手順を指定することができます。 |
OnUpdate | 各モジュールの更新手順を指定することができます。 |
OnShutdown | 各モジュールのシャットダウン手順を指定することができます。 |
OnMessage | (調査中) |
子要素 - システムアクション系 | |
CreateWindow | ウィンドウ作成のためのコマンドを定義します。 |
CallFunction | スクリプト関数を呼ぶためのコマンドを定義します。 |
関数 | |
関数 | |
ModulesLoadFromDirectory() | 指定されたディレクトリを検索し、全ての .mod 定義ファイルを読み出します。 |
ModulesLoadFromListFile() | リストから .mod ファイルのリストを読み出します。 |
ModuleLoad() | 単一のモジュールパスを読み出します。 |
ModuleRestrictedLoad() | Modデータに追加されない制限モジュールを読み出します。 |
ModulesInitializeAllEnabled() | 全てのLua/XMLデータを読み出し、各有効モジュールの初期化シーケンスを実行します。 |
ModulesInitializeRestricted() | 全てのLua/XMLデータを読み出し、各制限モジュールの初期化シーケンスを実行します。 |
ModulesGetData() | 全ての読み出されたUIモジュールのデータテーブルを返します。 |
ModuleSetEnabled() | 単一のモジュールを有効/無効にします。 |
ModuleInitialize() | 単一のモジュールを初期化します。 |
要素 - 最上位 | |
ModuleFile | UIモジュールXMLファイルの中でも最上位のXMLタグです。 |
子要素 - ModuleFile | |
UiMod | UIモジュールの名前やバージョン、日付を記録しておくための要素です。 |
子要素 - UiMod | |
Author | モジュールの作者の情報を記録しておくための要素です。 |
Description | モジュールについての簡単な説明を記録しておくための要素です。 |
Dependencies | このモジュールを初期化する前に、他のモジュールを読み込んで初期化するよう要求できます。 |
Files | このモジュールで読み込むXML/Luaファイルを指定します。 |
SavedVariables | 変数を保存するテーブル指定します (調査中)。 |
Hotkeys | (調査中) |
Options | (調査中) |
子要素 - UiMod (システムアクション系) | |
OnInitialize | 各モジュールの初期化手順を指定することができます。 |
OnUpdate | 各モジュールの更新手順を指定することができます。 |
OnShutdown | 各モジュールのシャットダウン手順を指定することができます。 |
OnMessage | (調査中) |
子要素 - システムアクション系 | |
CreateWindow | ウィンドウ作成のためのコマンドを定義します。 |
CallFunction | スクリプト関数を呼ぶためのコマンドを定義します。 |
各モジュールの更新手順を指定することができます。
<OnUpdate> ... </OnUpdate>
スクリプト関数を呼ぶためのコマンドを定義します。
<OnShutdown> <CallFunction name="TomeWindow" /> </OnShutdown>
name | (string) 有効なウィンドウ定義の名前。 |
関数 | |
ModulesLoadFromDirectory() | 指定されたディレクトリを検索し、全ての .mod 定義ファイルを読み出します。 |
ModulesLoadFromListFile() | リストから .mod ファイルのリストを読み出します。 |
ModuleLoad() | 単一のモジュールパスを読み出します。 |
ModuleRestrictedLoad() | Modデータに追加されない制限モジュールを読み出します。 |
ModulesInitializeAllEnabled() | 全てのLua/XMLデータを読み出し、各有効モジュールの初期化シーケンスを実行します。 |
ModulesInitializeRestricted() | 全てのLua/XMLデータを読み出し、各制限モジュールの初期化シーケンスを実行します。 |
ModulesGetData() | 全ての読み出されたUIモジュールのデータテーブルを返します。 |
ModuleSetEnabled() | 単一のモジュールを有効/無効にします。 |
ModuleInitialize() | 単一のモジュールを初期化します。 |
指定されたディレクトリを検索し、全ての .mod 定義ファイルを読み出します。
これは、ウィンドウを作成するLua/XMLコードを実際には 読み出しません 。単に、UIモジュールメタデータとして読み出すだけです。
directory | (string) モジュールの検索をするディレクトリ。 |
setName | (wstring) このモジュールのセットとして使用する名前。例: “EA Default”, “Add Ons”。 |
nil | 戻り値無し。 |
全ての読み出されたUIモジュールのデータテーブルを返します。
無し。
modDataTable | (table) UIモジュールのテーブル。 |
フォーマットは下記の通りです……
modDataTable[1...n].name | (wstring) モジュールの名前。 |
modDataTable[1...n].setName | (wstring) このモジュールが含まれるセットの名前。 |
modDataTable[1...n].author | (table) 作者情報が含まれるテーブル。 |
modDataTable[1...n].author.name | (wstring) 作者の名前。 |
modDataTable[1...n].author.email | (wstring) 作者のメールアドレス。 |
modDataTable[1...n].description | (table) 説明情報が含まれるテーブル。 |
modDataTable[1...n].description.text | (wstring) 説明テキスト。 |
modDataTable[1...n].dependencies | (table) 依存情報が含まれるテーブル。 |
modDataTable[1...n].dependencies[1..n].name | (wstring) 依存関係にあるモジュールの名前。 |
local modsData = ModulesGetData()