WidgetValue

WidgetValue

スクリプトパネル内のカスタムUIウィジェットと、スクリプトによって制御される変数をバインドするためのヘルパーオブジェクトです。

WidgetValueSV#create("WidgetValue") を介してのみ作成できます。

WidgetValue をUIウィジェットにバインドするには、グローバルコールバック getSidePanelSectionState() 内で、value プロパティに WidgetValue オブジェクトを設定します。

  • (2.1.2以降でサポート)

メソッド

getEnabled() → {boolean}

UIウィジェットに現在設定されている有効/無効の状態を取得します。

戻り値:

有効な場合は true を返す。

boolean

getValue() → {number|string}

UIウィジェットに現在設定されている値を取得します。

戻り値:

現在の値。

number | string

setEnabled()

UIウィジェットを有効または無効にします。無効状態では、ユーザーはウィジェットの値を変更できません。

setValue(value)

UIウィジェットを新しい値で更新します。

パラメータ:
名前 詳細
value number | string

設定する値。

setValueChangeCallback(callback)

ユーザーによってUIウィジェットの値が変更されたときに呼び出されるスクリプト関数を設定します。 コールバック関数は、唯一の引数として新しい値を受け取ります。

パラメータ:
名前 詳細
callback function