版本
|
Wwise SDK 2021.1.14
|
检索有关对象属性的信息。注意，此函数并不返回属性的值。如需了解如何检索属性的值，请参阅 ak.wwise.core.object.get 和 返回选项 章节。
| 名称 | 类型 | 说明 |
|---|---|---|
| object | any of: | 所要监视的对象的 ID (GUID)、名称或路径。 |
| string | 由类型限定的对象名称，格式为 type:name。仅支持采用全局唯一名称的对象类型。例如：Event:Play_Sound_01 | |
| string | 以下形式的对象 GUID：{aabbcc00-1122-3344-5566-77889900aabb}。 | |
| string | Wwise 对象的工程路径，包含类别和 Work Unit。例如：\Actor-Mixer Hierarchy\Default Work Unit\New Sound SFX。 | |
| classId | integer | 要检索属性的对象的 ID (Class ID)。 32 位无符号整数。范围：[0,4294967295] |
| property | string | 所要检索的属性的名称。如需查看 Wwise 对象的属性列表，请参阅 Wwise 对象参考 章节。 属性名称。有关 Wwise 对象及其属性的信息，请参阅 Wwise 对象参考 章节。 |
| 名称 | 类型 | 说明 |
|---|---|---|
| name | string | 属性的名称。 |
| type | string | 属性的类型。如需查看 Wwise 对象的属性列表，请参阅 Wwise 对象参考 章节。 |
| audioEngineId | integer | 属性的 ID（音频引擎 ID）。 32 位无符号整数。范围：[0,4294967295] |
| default | any of: | 属性的默认值。 属性的值。 |
| null | 空值。没有对对象的引用。 | |
| string | 字符串值。 | |
| number | 数字值。 | |
| boolean | 布尔值。 | |
| supports | object | 属性支持的功能。 |
| supports.rtpc | string | 属性支持的 RTPC 模式。可能的值：
|
| supports.randomizer | boolean | 指示属性是否支持 Randomizer。 |
| 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 对象参考 章节。 属性名称。有关 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[...].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[...].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 | 显示时的数值递增幅度。 |
| 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） 章节。