Members
items :Array.<Item>
すべてのシーンのアイテムの一覧
Type:
- Array.<Item>
- Source:
models :Array.<Model>
すべてのシーンのモデルの一覧
Type:
- Array.<Model>
- Source:
parameters :Array.<{id: string, createdBy: string, group: string, base: number, min: number, max: number, repeat: boolean}>
LIVEパラメータの一覧
Type:
- Array.<{id: string, createdBy: string, group: string, base: number, min: number, max: number, repeat: boolean}>
Properties:
| Name | Type | Description |
|---|---|---|
id |
string | パラメータのID。LiveParametersを参照 |
createdBy |
string | パラメータの作成者 |
group |
string | パラメータのグループ名 |
base |
number | パラメータの基準値 |
min |
number | パラメータの最小値 |
max |
number | パラメータの最大値 |
repeat |
boolean | 最大値と最小値がつながる場合にtrue |
- Source:
scenes :Array.<Scene>
シーンの一覧
Type:
- Array.<Scene>
- Source:
shaderEffectLayerIds
エフェクト追加時に指定可能なシェーダーの ID 一覧
注意：本ドキュメント記載の名前は 2.0 時点。また、ターゲットによってはエフェクトの動作が未定義の場合があります。（背景に逆光エフェクトを使用など）
- Deprecated:
- nizima LIVE 2.3.0 以降非推奨。代わりに Effect クラスの availableShaderIds を使用してください。
- Source:
version :string
スクリプトのバージョン
Type:
- string
- Source:
Methods
insertParameter(param)
LIVEパラメータを追加する
Parameters:
| Name | Type | Description | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
param |
Object | パラメータ設定オブジェクト。
Properties
|
- Source:
openColorDialog(selectedCallback, canceledCallbackopt, changedCallbackopt)
カラーダイアログを開きます。
ユーザーが色を選択できます。
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
selectedCallback |
function | 色が選択されたときに呼ばれるコールバック。各成分は0.0～1.0の範囲です。 | |
canceledCallback |
function |
<optional> |
キャンセルされたときに呼ばれるコールバック（省略可） |
changedCallback |
function |
<optional> |
色が変更されたときに呼ばれるコールバック（省略可） |
- Source:
Example
Live.openColorDialog(
function(r, g, b, a) { console.log("選択:", r, g, b, a); },
function() { console.log("キャンセル"); },
function(r, g, b, a) { console.log("変更:", r, g, b, a); }
);openErrorDialog(title, text, acceptedCallbackopt)
エラーダイアログを開きます。
エラー内容をユーザーに通知します。
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
title |
string | ダイアログのタイトル | |
text |
string | エラー内容 | |
acceptedCallback |
function |
<optional> |
OKボタンが押されたときに呼ばれるコールバック（省略可） |
- Source:
openFloatDialog(title, text, minopt, valueopt, maxopt, selectedCallbackopt, canceledCallbackopt, changedCallbackopt)
小数入力ダイアログを開きます。
ユーザーが小数値を入力できます。
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
title |
string | ダイアログのタイトル | ||
text |
string | ダイアログの説明文 | ||
min |
number |
<optional> |
0 | 入力可能な最小値 |
value |
number |
<optional> |
0 | 初期値 |
max |
number |
<optional> |
100 | 入力可能な最大値 |
selectedCallback |
function |
<optional> |
入力が確定されたときに呼ばれるコールバック（省略可） | |
canceledCallback |
function |
<optional> |
キャンセルされたときに呼ばれるコールバック（省略可） | |
changedCallback |
function |
<optional> |
入力値が変更されたときに呼ばれるコールバック（省略可） |
- Source:
openIntDialog(title, text, minopt, valueopt, maxopt, selectedCallbackopt, canceledCallbackopt, changedCallbackopt)
整数入力ダイアログを開きます。
ユーザーが整数値を入力できます。
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
title |
string | ダイアログのタイトル | ||
text |
string | ダイアログの説明文 | ||
min |
number |
<optional> |
0 | 入力可能な最小値 |
value |
number |
<optional> |
0 | 初期値 |
max |
number |
<optional> |
100 | 入力可能な最大値 |
selectedCallback |
function |
<optional> |
入力が確定されたときに呼ばれるコールバック（省略可） | |
canceledCallback |
function |
<optional> |
キャンセルされたときに呼ばれるコールバック（省略可） | |
changedCallback |
function |
<optional> |
入力値が変更されたときに呼ばれるコールバック（省略可） |
- Source:
openListDialog(title, text, list, selectedCallback, canceledCallbackopt, changedCallbackopt)
コンボボックスでの選択ダイアログを開きます。
モーダルダイアログとして表示され、ユーザーがリストから選択できます。
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
title |
string | ダイアログのタイトル | |
text |
string | ダイアログの説明文 | |
list |
Array.<string> | 選択肢の配列 | |
selectedCallback |
function | 選択が確定されたときに呼ばれるコールバック。選択された値が渡されます。 | |
canceledCallback |
function |
<optional> |
キャンセルされたときに呼ばれるコールバック（省略可） |
changedCallback |
function |
<optional> |
選択肢が変更されたときに呼ばれるコールバック（省略可） |
- Source:
Example
Live.openListDialog(
"色を選択",
"好きな色を選んでください",
["赤", "青", "緑"],
function(value) { console.log("選択:", value); },
function() { console.log("キャンセルされました"); },
function(value) { console.log("変更:", value); }
);openMessageDialog(title, text, acceptedCallbackopt, canceledCallbackopt, detailopt)
メッセージダイアログを開きます。
情報や確認メッセージを表示します。
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
title |
string | ダイアログのタイトル | |
text |
string | メッセージ内容 | |
acceptedCallback |
function |
<optional> |
OKボタンが押されたときに呼ばれるコールバック（省略可） |
canceledCallback |
function |
<optional> |
キャンセルされたときに呼ばれるコールバック（省略可） |
detail |
string |
<optional> |
詳細情報（省略可） |
- Source:
openMultiTextDialog(title, text, selectedCallback, canceledCallbackopt, changedCallbackopt)
複数行のテキスト入力ダイアログを開きます。
ユーザーが複数行のテキストを入力できます。
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
title |
string | ダイアログのタイトル | |
text |
string | 初期テキスト | |
selectedCallback |
function | 入力が確定されたときに呼ばれるコールバック。入力されたテキストが渡されます。 | |
canceledCallback |
function |
<optional> |
キャンセルされたときに呼ばれるコールバック（省略可） |
changedCallback |
function |
<optional> |
入力内容が変更されたときに呼ばれるコールバック（省略可） |
- Source:
openTextDialog(title, text, selectedCallback, canceledCallbackopt, changedCallbackopt)
テキスト入力ダイアログを開きます。
ユーザーが1行のテキストを入力できます。
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
title |
string | ダイアログのタイトル | |
text |
string | ダイアログの説明文 | |
selectedCallback |
function | 入力が確定されたときに呼ばれるコールバック。入力されたテキストが渡されます。 | |
canceledCallback |
function |
<optional> |
キャンセルされたときに呼ばれるコールバック（省略可） |
changedCallback |
function |
<optional> |
入力内容が変更されたときに呼ばれるコールバック（省略可） |
- Source:
rgb(red, green, blue) → {Color}
色の数値から#FFFFFFの形式に変更
Parameters:
| Name | Type | Description |
|---|---|---|
red |
number | 0~1 |
green |
number | 0~1 |
blue |
number | 0~1 |
- Source:
Returns:
- Type
- Color
showMessage(message)
右上にメッセージを表示する
Parameters:
| Name | Type | Description |
|---|---|---|
message |
string |
- Source: