Interface IProperty

Namespace

VMagicMirror.Buddy

マニフェストで定義されたプロパティ値を取得できるAPIです。

public interface IProperty

Remarks

サブキャラの設定として、表示位置や仕草のスピードなど、エンドユーザーが編集や調整を行うプロパティを公開し、このAPIでその調整後の値を取得できます。 manifest.json にプロパティを定義する方法については サブキャラの基本設定を定義する を参照して下さい。

Methods

GetBool(string)

bool値として定義したプロパティの現在値を取得します。

bool GetBool(string key)

Parameters

key string

プロパティ名

Returns

bool

プロパティの現在値

Remarks

指定したキーがマニフェスト上で定義されていない場合、この関数は false を返します。

GetFloat(string)

bool値として定義したプロパティの現在値を取得します。

float GetFloat(string key)

Parameters

key string

プロパティ名

Returns

float

プロパティの現在値

Remarks

指定したキーがマニフェスト上で定義されていない場合、この関数は 0 を返します。

GetInt(string)

int値として定義したプロパティの現在値を取得します。

int GetInt(string key)

Parameters

key string

プロパティ名

Returns

int

プロパティの現在値

Remarks

指定したキーがマニフェスト上で定義されていない場合、この関数は 0 を返します。

GetQuaternion(string)

Quaternion の値として定義したプロパティの現在値を取得します。

Quaternion GetQuaternion(string key)

Parameters

key string

プロパティ名

Returns

Quaternion

プロパティの現在値

Remarks

指定したキーがマニフェスト上で定義されていない場合、この関数は identity を返します。

GetString(string)

string値として定義したプロパティの現在値を取得します。

string GetString(string key)

Parameters

key string

プロパティ名

Returns

string

プロパティの現在値

Remarks

指定したキーがマニフェスト上で定義されていない場合、この関数は空文字列を返します。

GetVector2(string)

Vector2 の値として定義したプロパティの現在値を取得します。

Vector2 GetVector2(string key)

Parameters

key string

プロパティ名

Returns

Vector2

プロパティの現在値

Remarks

指定したキーがマニフェスト上で定義されていない場合、この関数は zero を返します。

GetVector3(string)

Vector3 の値として定義したプロパティの現在値を取得します。

Vector3 GetVector3(string key)

Parameters

key string

プロパティ名

Returns

Vector3

プロパティの現在値

Remarks

指定したキーがマニフェスト上で定義されていない場合、この関数は zero を返します。

Events

ActionRequested

action値として定義したプロパティのボタン入力が行われたときに発火します。 引数はマニフェストで定義した name の値になります。

event Action<string> ActionRequested

Event Type

Action<string>