その他/設定可能なキー一覧/[Preference]フィールド - uLilithフェイス作成方法wiki

[Preference]フィールドのキー

[Preference]フィールドのキー一覧です。

• キー名が赤字と青字のキーは必須のキーです。
  （青字のキーは他のキーの設定状況などによっては省略することも可能です）
• キー名が緑字のキーは、
  起動時にコマンドを実行したりプラグインやプライベートフォントを使用する場合は必須になるキーです。
  （起動時のコマンドやプラグイン、プライベートフォントを使用しない場合は省略してもかまいません）

フェイスの設定

キー名	値	内容	初期値
Signature	"uLilith Face File"	uLilithの定義ファイルであるかどうかを 見分けるためのキー 必ず"uLilith Face File"と指定する
NeedVersion	日付	フェイスの表示に必要なバージョンの日付 「YYYY/MM/DD」の形式で指定
CanvasWidth	数値	初期状態でのキャンバスとウィンドウの幅
CanvasHeight	数値	初期状態でのキャンバスとウィンドウの高さ
DefaultMessage	文字列	ファイルが読み込まれていないときの 「タイトル文字列」アイテムの表示内容
UseWindowRegion	TrueかFalse	True：ベース画像でα=0となっている部分には            描画を行わない	False
AllowFaceStateSave	TrueかFalse	True：フェイスを閉じたときに            フェイスの状態を保存する	False
SaveWindowPoint	TrueかFalse	True：フェイスを閉じたときに            「フェイスの状態保存」に            ウィンドウ座標もあわせて保存する	False
IsHidden	TrueかFalse	True：初期状態で            非表示でフェイスが作成される	False

☆CanvasWidth・CanvasHeightキーは、
   フェイス内にBackImageアイテムが配置されている場合は省略可能です。

フェイスセレクタでの表示設定

キー名	値	内容	初期値
FaceName	文字列	フェイスの名前 省略した場合はiniファイルのファイル名が フェイス名になる
PreviewImage	画像ファイル名	フェイスのプレビュー画像
ThumbnailImage	画像ファイル名	フェイスのサムネイル画像
DocumentFile	ファイル名	フェイスの説明書ドキュメント	ReadMe.txt

WindowResizerアイテムでのサイズ変更に関する設定

キー名	値	内容	初期値
MinWidth	数値	フェイスの最小サイズ（幅）	1
MinHeight	数値	フェイスの最小サイズ（高さ）	1
MaxWidth	数値	フェイスの最大サイズ（幅）
MaxHeight	数値	フェイスの最大サイズ（高さ）
InflateUnitX	数値	フェイスのサイズ変更単位（幅）【※】	1
InflateUnitY	数値	フェイスのサイズ変更単位（高さ）【※】	1

※WindowResizerアイテムをドラッグしてサイズを変更したときに、
    これらのキーで指定した数値のピクセル分ずつサイズが変更されます。
    例：InflateUnitX = 10なら、横方向にサイズを変更すると10ピクセルずつフェイスの幅が増減する

プレイリストの表示位置設定

キー名	値	内容	初期値
PlayListIsAfterMainWindow	TrueかFalse	True：ドッキングプレイリストを、            メインウィンドウの裏に回す【※】	False

※通常の場合（Falseの場合）、プレイリストは全てのアイテムの上（手前）で表示されますが、
   このキーがTrueの場合は全てのアイテムの下（奥）に表示されます。
   プレイリスト表示部分に他のアイテムが被っている部分は、
   上にあるアイテムが半透明でない限り見えなくなります。
   また、リスト操作に関してはアイテムが被っていてもそのままある程度操作可能ですが、
   スクロールバーだけは異なり、スクロールバー部分に他アイテムが被っている場合は
   マウスクリックが反応しないのでその部分のみ操作不能になります。

フェイス起動直後に実行するコマンドの設定

☆フェイス起動時にコマンドを実行する場合、
   InitCommandCountキーとCommandキーは必須になります。
   Commandキーに指定したコマンドがパラメータが必要なコマンドの場合、
   CommandParamType・CommandParamも１つずつ必須になります。

キー名	値	内容	初期値
InitCommandCount	数値	フェイスを読み込んだ直後に 実行するコマンドの数
Command	コマンド名	実行するコマンド名
CommandParamType	【※1】	コマンドのパラメータの種類 （パラメータが必要なコマンドのみ）
CommandParam	【※2】	コマンドのパラメータの内容 （パラメータが必要なコマンドのみ）
CommandTargetWindow	ウィンドウ名【※3】	コマンドを実行する対象のウィンドウ 省略した場合は Commandキーを記述したウィンドウ自身が 対象になる
CommandTargetPlugin	プラグイン名	コマンドを実行する対象のプラグイン名

（Command・CommandParamType・CommandParam・
   CommandTargetWindow・CommandTargetPluginの全てのキーの末尾に
   （スペースは入れずに）連番をつける必要があります。
   例：「Command2」「CommandParamType2」など
   コマンドはキー末尾につけた連番の番号の順に実行されます。
   [Preference]フィールドで起動時のコマンドを設定する場合、
   コマンドが１つの場合でも「InitCommandCount = 1」と記述した上で
   Command1・CommandParamType1・CommandParam1と
   コマンド関係の全てのキーの末尾に番号を付けるのを忘れないようにしてください。）

※1 Int・String・Double・Bool・RandomInt・RandomString のうちどれか１つ
     （コマンドによって使用できる種類が異なる）
※2 文字列や数値など、コマンドによって異なる
※3 CreateSubFace・ToggleSubFaceコマンドで開くときにパラメータで指定した「ウィンドウ名」。
     サブウィンドウに記述したコマンドで、メインウィンドウを対象とする場合は
     「uLilith::MainWindow」と指定する。

フェイスに使用するプラグインの設定

☆プラグインを使用する場合、
   NeedPluginCountキーとNeedPluginキーは必須【※】になります。
   上記の２つのキーを設定した上でNeedPluginAutoEnableキーを省略すると、
   NeedPluginAutoEnable = Falseと設定したのと同じ扱いとなり
   指定したプラグインがuLilithの本体設定側で「無効」になっているとき
   フェイス表示時に「プラグインを有効にするかどうかの確認」がされるようになるので
   確認画面を出さずに自動でプラグインを有効にさせたい場合は
   NeedPluginAutoEnableキーを省略せずに記述し、Trueを設定して下さい。

キー名	値	内容	初期値
NeedPluginCount	数値	使用するプラグインの数
NeedPlugin	ファイル名	使用するプラグインのファイル名
NeedPluginAutoEnable	TrueかFalse	使用するプラグインが無効になっているときに フェイス表示時に行う動作の指定 True：プラグインを自動的に有効化する False：プラグインを有効にするかどうかの             確認画面が表示される	False
NeedPluginUrl	URL	使用するプラグインのダウンロード先のURL プラグインが見つからないときに、 ダウンロード先を表示する

（NeedPlugin・NeedPluginAutoEnable・NeedPluginUrlの
   全てのキーの末尾に（スペースは入れずに）連番をつける必要があります。
   例：「NeedPlugin1」「NeedPluginAutoEnable1」など）

※ NeedPluginCountキー・NeedPluginキーを省略したとしても、
     あらかじめ本体設定で、使用する汎用プラグインを「有効」にしているときのみ
     「プラグインの使用に必要なフェイスアイテム」をフェイス内に配置していれば
     プラグインを使用したアイテムは表示されます。
     しかし、キーが省略されていると
     自動で必要なプラグインを有効にしたり、プラグインを有効化するかどうかの確認を出したり
     「フェイスの表示にプラグインが必要なこと」を知らせることができなくなるので
     本体設定でプラグインを「無効」にしていると、アイテムが表示されなくなります。
     そのため、基本的にはキーを省略せず記述しておくことをおすすめします。

フェイスに使用するプライベートフォントの設定

☆プライベートフォントを使用する場合、
   PrivateFontCountキーとPrivateFontキーは必須になります。

キー名	値	内容	初期値
PrivateFontCount	数値	使用するプライベートフォントの数
PrivateFont	フォントファイル名	使用するプライベートフォントのファイル名

（PrivateFontキーの末尾に（スペースは入れずに）連番をつける必要があります。
   例：「PrivateFont1」）

アイテムの表示位置の調整

☆基本的には、これらのキーは未設定でも特に問題はありません。
   例えばiniファイルの中身を他のフェイスのiniから流用し、フェイスの背景画像のみを差し替える場合
   アイテム間の配置間隔は変えないまま、全てのアイテムの位置を微調整するときに設定します。

キー名	値	内容	初期値
GlobalOffsetX	数値（整数）	BackImageアイテム以外の 全アイテムのX座標を数値分増減
GlobalOffsetY	数値（整数）	BackImageアイテム以外の 全アイテムのY座標を数値分増減