スクリプトエディター用に次の拡張書式が用意されています。
上記のように記述すると、スクリプトの説明文と見なされます。
ここに記載された文字列(上記の例の場合は サンプル
)が、スクリプトリストの説明欄、メニュー項目に反映されます。
また、--Description:
の後にローカライズシンボルを記述することで、ツールの表示言語設定に合わせてローカライズした説明を表示することもできます。
次のローカライズシンボルに対応しています。
言語 | ローカライズシンボル |
---|---|
日本語 | [ja] |
英語 | [en] |
中国語 | [zh] |
スクリプトを記述すると次のようになります。
「ユーザー変数」は、スクリプトエディター上で直接スクリプトを記述せずに、GUI 操作にてオブジェクト指定/文字列指定/数値指定など変更できるようにするための機能です。
# --BeginUserVariable
, # --EndUserVariable
の範囲内に定義した変数が「ユーザー変数」として扱われます。
また、オブジェクトを扱うユーザー変数を定義する場合、インポート名を置き換えしていない cri.atomcraft.project のインポートが必要になります。
定義したユーザー変数をユーザー変数画面に表示するため、ダブルクオーテーション3つ「"""」で囲われた docstring の中に 変数名、種類、説明を記載し、そのあとに変数に初期値を設定します。
種類は3つあり変数の内容によって指定する種類を変更します。
タイプの種類 | 説明 |
---|---|
object | 変数がオブジェクトの場合に指定します |
string | 変数が文字列の場合に指定します |
number | 変数が数値の場合に指定します |
保存して更新すると、スクリプトエディター右側の GUI 領域にこれらのユーザー変数が表示されます。
ユーザー変数が定義されているスクリプトは、スクリプトリストにてアイコン付きで表示されます。
エディター右側の GUI にて値を変更して「適用」ボタンを押すと、変更内容がスクリプトに反映されます。
オブジェクトタイプの変数を指定する場合は、CRI Atom Craft のツリーから対象のオブジェクトをドラッグ&ドロップして指定します。
オブジェクトタイプの変数の指定を解除する場合は、右クリックメニューから「クリア」を選択します。