カスタム情報ウィンドウプラグインのコマンド【ダイスプラグイン】

←マニュアルトップへ戻る

ダイスプラグイン付属の「カスタム情報ウィンドウプラグイン」のコマンドです。
（※補足以外のパラメータ解説はチートシートと同じ内容です。）

サンプルではすごろくの「残りターン数」「残り歩数」「手持ちダイスウィンドウのベース部分」、TRPG風判定の「詳細ウィンドウ」「結果ウィンドウ」などに使用しています。

それらのウィンドウを表示(show)、非表示(hide)するだけであれば簡単ですが、新しいウィンドウを作るとなると中級者以上の方向け となります。
各コマンドの補足説明をよく読み、サンプルでのウィンドウ設定を参考に自作してみてください。

コマンド一覧

• create/作成 → ウィンドウ(設定)を作成
• createParts/パーツ作成 → パーツ(設定)の作成
• setParts/パーツ設定 → パーツをウィンドウに登録
• registerParts/パーツ登録 → パーツをウィンドウに登録
• sprite/スプライト → スプライト化パーツの設定
• show/表示 → ウィンドウの表示
• hide/非表示 → ウィンドウの非表示
• clear/クリア → ウィンドウ(設定)のクリア
• move/移動 → ウィンドウ位置の移動
• relativeMove/相対移動 → ウィンドウ位置の相対移動

create/作成 → ウィンドウ(設定)を作成

▷パラメータ：「ウィンドウID 幅 高さ ピクチャの下フラグ スキップ可能フラグ」
簡易例）『Window create 1 200 50』
　→ ウィンドウID1の設定を幅200,高さ50で作成
詳細例）『Window create 1 200 50 true true』(既存ウィンドウIDだとエラー)
　→ ウィンドウID1の設定を幅200,高さ50でピクチャの下に作成。(ID既存時はスキップ)

▷補足
作成済みのウィンドウIDで再度create/作成コマンドを行うとエラーとなります。
スイッチなどで制御して何度も呼ばれないようにすることが望ましいですが、スキップ可能フラグをONにしておくことで、作成済みのIDの場合は無視することができます。

createParts/パーツ作成 → パーツ(設定)の作成

▷パラメータ：「パーツID タイプ 幅 高さ (フォーマット)」
例1テキスト）『Window createParts メインテキスト text 100 50 所持金：\V[1]』
　→ パーツID「メインテキスト」をtextタイプで幅100,高さ50で作成。フォーマットは「所持金：\V[1]」（パーツ登録時に指定しても可）

例2画像）『Window createParts 画像1 image 0 0 test_image』
　→ パーツID「画像1」をimageタイプで幅,高さを0のデフォ値(画像サイズ)で作成。
　フォーマットは「test_image」でsystem/test_image.png画像を読み込む。

▷補足
タイプ（text/テキストかimage/画像）と高さと幅を指定してパーツを作成します。
作成したパーツは複数のウィンドウに登録できる他、同じウィンドウに同じパーツを複数登録することもできます。

フォーマットはテキストであれば表示される文章、画像であれば読み込まれる画像名を指定しますが、パーツ作成時かパーツ登録時のどちらで指定しても構いません。

▷補足：フォーマットの制御文字について
フォーマット中には以下の制御文字が使用できます。
{、}：文字サイズ変更
\C[文字色]
\I[アイコンID]
\V[変数番号]

フォーマットを「所持金：\V[1]」とすれば、変数１の値が１００であれば「所持金：１００」と表示されます。

変数の値が変わると自動でウィンドウに表示される内容も変わるので、一度パーツを作成・登録してウィンドウを表示しておけば、ウィンドウの操作はせずに変数だけ操作すれば大丈夫です。

▷補足：画像名について
タイプをimage/画像とした場合にはフォーマットで指定した画像ファイルが読み込まれます。

↓パーツID「サイコロ」で幅、高さ０(元のサイズ使用)、画像名「dice_list」での作成例。

上のようにフォルダを指定しない場合はsystemフォルダのdice_list.png画像が読み込まれます。

フォルダを指定する場合は「pictures/dice_list」とすると、picturesフォルダのdice_list.pngの画像が指定されます。

また、変数にスクリプトで画像名を入れ、フォーマットに変数の制御文字を指定することで、変数の値が変わると自動的に表示される画像も切り替わります。

また、画像を表示する場合はspriteでの表示を推奨します。
詳しくは下のsetParts/パーツ設定の補足説明を参照してください。

▷補足：独自制御文字\Sについて(上級)
フォーマット中には独自の制御文字\Sが使用できます。
スイッチのON/OFFによって表示内容を変えたい時に使用します。

構文は↓のとおり。
\S[スイッチ番号]ONの場合の内容:OFFの場合の内容\S

↓すごろくのダイスウィンドウでの「メインダイスの残り回数」のテキストフォーマット

スイッチ番号23「ダイス1が変化中」がONの場合は「あと\V[73]回」
（\V[73]は変数番号73「ダイス1の残り回数(变化)」の値）
OFFの場合は「あと∞回」と表示されます。

setParts/パーツ設定 → パーツをウィンドウに登録

▷パラメータ：「パーツID 設定項目:セットする値…」
簡易例）『Window setParts メインテキスト align:右 fontSize:18 textColor:rgb(255,200,100)』
　→ パーツID「メインテキスト」のアラインを右寄せ、フォントサイズを18、文字色は赤255,緑200,青100に変更。(スプライト化はsprite:true）

▷補足：text/テキストタイプの設定項目
text/テキストタイプの文字色やサイズなどはこのコマンドで設定できます。

• fontSize/フォントサイズ：フォントサイズ（デフォルトは24）
• align/アライン： 「right/右」で右寄せ、「center/中央」で中央寄せのテキストとなる
• textColor/文字色：rgb(赤の値,緑の値,青の値)で指定する。(それぞれ0~255）
• outlineWidth/アウトライン幅：縁の幅。（デフォルトは4）
• outlineColor/アウトライン色：rgb(赤の値,緑の値,青の値)で指定する。

色の指定はwhite,blueなどの英語の色名でも指定できます。

↓アウトラインの幅、色を設定した例

残りの縁の左側が若干見切れているのが分かると思います。
アウトライン幅を太くした場合には、パーツ登録時にウィンドウの端や他のパーツから若干間を開けた位置にセットすることで綺麗に縁まで表示されます。

↓「残り」のx座標を0から3に変更した場合

▷補足：スプライト化のパラメータ
「sprite:true」または「スプライト:true」とすることでパーツをスプライト化することができます。
スプライト化することで、他のパーツと重ねたり、ウィンドウ表示中に「sprite/スプライト」コマンドで位置、不透明度、角度を変更できるようになります。

特にimage/画像タイプは積極的にスプライト化することをおすすめします。
また、「underContents:true」または「コンテンツの下:true」とすることで、スプライト化した画像をスプライト化していないテキストの裏側に配置することができます。

registerParts/パーツ登録 → パーツをウィンドウに登録

▷パラメータ：「ウィンドウID パーツID X座標 Y座標 (フォーマット)」
簡易例）『Window registerParts 1 メインテキスト 100 0 所持金：V[1]』
　→ ウィンドウID1にパーツID「メインテキスト」をx=100,y=0に登録。フォーマットは「所持金：V[1]」（パーツ作成時に指定しても可）

▷補足
フォーマットについてはcreateParts/パーツ作成の補足を参照。
（実際には、registerParts/パーツ登録で指定することの方が多いかと思います。）

スプライト化していないパーツの位置が重なると、重なった部分が消去されて正しくテキストなどが描画されない場合があります。

↓のように左右で分かれる場合は、例えばウィンドウの幅が200とすると左の「残り」は幅50でx=0に配置し、右の「0ターン」は幅150でx=50の位置に配置すると正しく描画されます。

sprite/スプライト → スプライト化パーツの設定

▷パラメータ：「ウィンドウID パーツID 設定項目:セットする値」
簡易例）『Window スプライト 1 メインテキスト opacity:100 x:0 y:200』
　→ ウィンドウID1,パーツID「メインテキスト」の不透明度を100,x=0,y=200に変更
(パーツIDは登録順も可,開始0)

▷補足：設定項目
スプライト化したパーツのみこのコマンドでスプライトの設定を行えます。
（スプライト化については「setParts/パーツ設定」コマンドの補足を参照）

• visible：表示のON/OFF設定。trueとすると表示、falseとすると非表示となる。
• opacity/不透明度： パーツの不透明度を0~255で指定（255で完全不透明）
• angle/角度：パーツの表示角度を指定
• rotation：パーツのローテーションを指定（角度のラジアン指定）
• anchorX/アンカーX：横方向の中心の基準(0で左端,0.5で中心,1で右端)
• anchorY/アンカーY：立て方向の中心の基準(0で上端,0.5で中心,1で下端)

↓特に意味は無いがスプライト化した「残り」テキストの基準点を中心(0.5)にセットして90度回転させた例

▷補足：パーツID
同じパーツを１つのウィンドウに複数登録している場合、狙ったパーツのスプライト設定の変更が行えません。
その場合は、「それぞれのパーツの登録した順番」でも指定することができます。

show/表示 → ウィンドウの表示

▷パラメータ：「ウィンドウID X座標 Y座標」
簡易例）『Window show 1 100 200』
　→ ウィンドウID1をx=100,y=200の位置に表示
詳細例）『window show 1 右上』(座標の代わりに左上なども可)
　→ ウィンドウID1を右上に表示

▷補足
左上、右上、左下、右下で簡単に位置を調整できます。

また、注意点としてcreate/作成コマンドで幅200、高さ50でウィンドウを作成した場合、この数値はウィンドウの描画部分の幅と高さとなります。

ですので、実際には上下左右に10ピクセルの余白を足した幅220、高さ70がウィンドウの表示サイズとなります。ウィンドウを上下や左右に並べて表示する場合には注意してください。

hide/非表示 → ウィンドウの非表示

▷パラメータ：「ウィンドウID」
簡易例）『Window hide 1』
　→ ウィンドウID1を非表示
詳細例）『Window hide all』
　→ 全てのウィンドウを非表示

clear/クリア → ウィンドウ(設定)のクリア

▷パラメータ：「ウィンドウID」
簡易例）『Window clear 1』
　→ ウィンドウID1を非表示にして設定を削除
詳細例）『Window clear all』
　→ 全てのウィンドウの設定を瞬時に削除

move/移動 → ウィンドウ位置の移動

▷パラメータ：「ウィンドウID X座標 Y座標 所要時間」
簡易例）『Window move 1 100 200』
　→ ウィンドウID1をx=100,y=200に移動
詳細例）『Window move 1 100 200 30』
　→ ウィンドウID1をx=100,y=200に30フレームかけて移動

relativeMove/相対移動 → ウィンドウ位置の相対移動

▷パラメータ：「ウィンドウID X座標 Y座標 所要時間」
簡易例）『Window relativeMove 1 100 200』
　→ ウィンドウID1をx+100,y+200だけ移動
詳細例）『Window rlativeMove 1 100 200 30』
　→ ウィンドウID1をx+100,y+200だけ30フレームかけて移動