バージョン
|
Wwise SDK 2022.1.13
|
オブジェクトのプロパティに関する情報を取得します。なお、この関数はプロパティの値を返しません。プロパティの値を取得するには、 ak.wwise.core.object.get and Returnオプション を参照してください。
| Name | タイプ | 概要 |
|---|---|---|
| object | any of: | ウォッチするオブジェクトの、ID (GUID)、名前、またはパス。 |
| string | The name of the object qualified by its type or Short ID in the form of type:name or Global:shortId. Only object types that have globally-unique names or Short Ids are supported. Ex: Event:Play_Sound_01, Global:245489792 | |
| string | オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。 | |
| string | Wwiseオブジェクトへのプロジェクトパスで、カテゴリと、ワークユニットを含みます。例えば: \Actor-Mixer Hierarchy\Default Work Unit\New Sound SFX. | |
| classId | integer | プロパティを取得するオブジェクトの、ID（クラスID）。 符号なし整数32-bit。 範囲: [0,4294967295] |
| property | string | 取得するプロパティの名前。詳細は、 Wwiseオブジェクトリファレンス にあるWwise Objectsのプロパティリストを参照してください。 プロパティ名。Wwiseオブジェクトや、そのプロパティの詳細については、 Wwiseオブジェクトリファレンス を参照してください。 |
| Name | タイプ | 概要 |
|---|---|---|
| name | string | プロパティの名前。 |
| type | string | プロパティのタイプ。詳細は、 Wwiseオブジェクトリファレンス にあるWwise Objectsのプロパティリストを参照してください。 |
| audioEngineId | integer | プロパティのID（オーディオエンジンID）。 符号なし整数32-bit。 範囲: [0,4294967295] |
| default | any of: | このプロパティのデフォルト値。 プロパティの値。 |
| null | null値。参照するオブジェクトはありません。 | |
| string | 文字列値。 | |
| number | 数値。 | |
| boolean | ブール値。 | |
| supports | object | このプロパティが対応している機能。 |
| supports.rtpc | string | このプロパティが対応しているRTPCモード。可能な値:
|
| supports.randomizer | boolean | このプロパティが、ランダマイザに対応しているかどうかを示します。 |
| supports.unlink | boolean | このプロパティが、unlinkに対応しているかどうかを示します。 |
| display | object | プロパティ関連の情報を表示します。 |
| display.name | string | プロパティのディスプレイネーム。 |
| display.group | string | プロパティのディスプレイグループ。 |
| display.index | integer | プロパティのディスプレイインデックス。 |
| dependencies | array | ほかのプロパティとの依存関係と、それに関連するアクションと条件のリスト。 |
| dependencies [...] | object | 依存関係。 |
| dependencies[...].type * | string | 依存関係のタイプを定義します。可能な値:
|
| dependencies[...].property | string | この依存関係が適用されるプロパティの名前。詳細は、 Wwiseオブジェクトリファレンス にあるWwise Objectsのプロパティリストを参照してください。 プロパティ名。Wwiseオブジェクトや、そのプロパティの詳細については、 Wwiseオブジェクトリファレンス を参照してください。 |
| dependencies[...].action * | string | 条件を満たしたときに実行されるアクションの名前。 |
| dependencies[...].context * | string | 依存関係を評価するときの、コンテキストの名前。 |
| dependencies[...].conditions | array | 依存関係に関連する条件のアレイ。 |
| dependencies[...].conditions [...] | object | 依存関係の条件。 |
| dependencies[...].conditions[...].referenceIsSet | boolean | リファレンスの依存関係に使い、ターゲットリファレンスを設定する必要があるか否かを定義します。 |
| dependencies[...].conditions[...].restriction | one of: | プロパティの依存関係に使い、プロパティを設定するときの制限事項を定義します。 プロパティの値を制限します。 |
| object | プロパティに制限がないことを示す、空のオブジェクト。 | |
| object | このプロパティが対応する値の、範囲に関する制限。 | |
| object | リファレンスオブジェクトに関する制限。 | |
| object | プロパティ値に関する制限。 | |
| dependencies[...].conditions[...].restriction.type * | string | プロパティの値の制限。可能な値:
|
| dependencies[...].conditions[...].restriction.min * | number | プロパティの最低値。 |
| dependencies[...].conditions[...].restriction.max * | number | プロパティの最大値。 |
| dependencies[...].conditions[...].restriction.type * | string | プロパティのオブジェクトリファレンスに対する制限。可能な値:
|
| dependencies[...].conditions[...].restriction.restrictions * | array | オブジェクトリファレンスに対する制限のリスト。 |
| dependencies[...].conditions[...].restriction.restrictions [...] | one of: | |
| object | 参照できるオブジェクトタイプに関する制限。 | |
| object | オブジェクトを参照できる、オブジェクトカテゴリに関する制限。 | |
| object | オブジェクトが、親に対してとるべき、階層上の相対的な位置に関する制限。 | |
| string | 存在する場合はtrueとみなされる、フラグ制限。notNull は、参照するオブジェクトが存在する必要があることを示し、nullとすることはできません。playable は、参照するオブジェクトが再生可能である必要を、示しています。可能な値:
| |
| dependencies[...].conditions[...].restriction.restrictions[...].type * | array | 可能なタイプのアレイ。 |
| dependencies[...].conditions[...].restriction.restrictions[...].type [...] | string | 対応可能なオブジェクトタイプ。オブジェクトのリストを確認するには、 Wwiseオブジェクトリファレンス を参照してください。 |
| dependencies[...].conditions[...].restriction.restrictions[...].sharedOnlyTypes | array | An array of types that are only supported as Shared objects (i.e., not Custom) even if the reference can support Custom objects. This is always a subset of "type". |
| dependencies[...].conditions[...].restriction.restrictions[...].sharedOnlyTypes [...] | string | Possible object type supported as Shared only. オブジェクトのリストを確認するには、 Wwiseオブジェクトリファレンス を参照してください。 |
| dependencies[...].conditions[...].restriction.restrictions[...].category * | array | サポートされるカテゴリのアレイ。 |
| dependencies[...].conditions[...].restriction.restrictions[...].category [...] | string | 対応可能なカテゴリ。 |
| dependencies[...].conditions[...].restriction.restrictions[...].childOfReference * | string | リファレンスの名前。 |
| dependencies[...].conditions[...].restriction.type * | string | プロパティの値の制限。可能な値:
|
| dependencies[...].conditions[...].restriction.values * | array | プロパティを制限する、可能な列挙値のアレイ。 |
| dependencies[...].conditions[...].restriction.values [...] | object | 名前の付いた列挙型の値。 |
| dependencies[...].conditions[...].restriction.values[...].value | one of: | 列挙された値。 |
| number | 数値。 | |
| boolean | ブール値。 | |
| dependencies[...].conditions[...].restriction.values[...].displayName | string | 値に関連する名前。 |
| restriction | one of: | プロパティ値を制限します。 |
| object | プロパティに制限がないことを示す、空のオブジェクト。 | |
| object | このプロパティが対応する値の、範囲に関する制限。 | |
| object | リファレンスオブジェクトに関する制限。 | |
| object | プロパティ値に関する制限。 | |
| restriction.type * | string | プロパティの値の制限。可能な値:
|
| restriction.min * | number | プロパティの最低値。 |
| restriction.max * | number | プロパティの最大値。 |
| restriction.type * | string | プロパティのオブジェクトリファレンスに対する制限。可能な値:
|
| restriction.restrictions * | array | オブジェクトリファレンスに対する制限のリスト。 |
| restriction.restrictions [...] | one of: | |
| object | 参照できるオブジェクトタイプに関する制限。 | |
| object | オブジェクトを参照できる、オブジェクトカテゴリに関する制限。 | |
| object | オブジェクトが、親に対してとるべき、階層上の相対的な位置に関する制限。 | |
| string | 存在する場合はtrueとみなされる、フラグ制限。notNull は、参照するオブジェクトが存在する必要があることを示し、nullとすることはできません。playable は、参照するオブジェクトが再生可能である必要を、示しています。可能な値:
| |
| restriction.restrictions[...].type * | array | 可能なタイプのアレイ。 |
| restriction.restrictions[...].type [...] | string | 対応可能なオブジェクトタイプ。オブジェクトのリストを確認するには、 Wwiseオブジェクトリファレンス を参照してください。 |
| restriction.restrictions[...].sharedOnlyTypes | array | An array of types that are only supported as Shared objects (i.e., not Custom) even if the reference can support Custom objects. This is always a subset of "type". |
| restriction.restrictions[...].sharedOnlyTypes [...] | string | Possible object type supported as Shared only. オブジェクトのリストを確認するには、 Wwiseオブジェクトリファレンス を参照してください。 |
| restriction.restrictions[...].category * | array | サポートされるカテゴリのアレイ。 |
| restriction.restrictions[...].category [...] | string | 対応可能なカテゴリ。 |
| restriction.restrictions[...].childOfReference * | string | リファレンスの名前。 |
| restriction.type * | string | プロパティの値の制限。可能な値:
|
| restriction.values * | array | プロパティを制限する、可能な列挙値のアレイ。 |
| restriction.values [...] | object | 名前の付いた列挙型の値。 |
| restriction.values[...].value | one of: | 列挙された値。 |
| number | 数値。 | |
| boolean | ブール値。 | |
| restriction.values[...].displayName | string | 値に関連する名前。 |
| ui | object | プロパティの表示方法に関する情報。 |
| ui.value | object | Wwise UIが、プロパティ値をどのように扱うのかを指定します。 |
| ui.value.decimals | integer | 値として表示する小数点以下の桁数。 |
| ui.value.step | number | ディスプレイが、この値を1回に増加させる量。 |
| ui.value.fine | number | ディスプレイが、この値を微調整するときに増加させる量。 |
| ui.value.min | number | 最小ディスプレイ値。 |
| ui.value.max | number | 最大ディスプレイ値。 |
| ui.value.infinity | number | 無限を示すために使う数字。 |
| ui.displayAs | object | プロパティの表示方法を示します。 |
| ui.displayAs.lrMix | boolean | プロパティを、左右ミックスとして表示すべきかどうかを示します。 |
| ui.displayAs.musicNote | boolean | プロパティを、音符（MIDI）として表示すべきかどうかを示します。 |
| ui.displayAs.bitfield | boolean | プロパティを、ビットフィールドとして表示すべきかどうかを示します。 |
| ui.dataMeaning | string | プロパティの単位のタイプ。可能な値:
|
| ui.autoUpdate | boolean | スライダを移動している間にプロパティ値が更新されるかどうかを定義します。 |
Wwise Authoring APIの詳細は、 Wwise Authoring API (WAAPI)を使用する を参照してください。