Version
|
Wwise Unity Integration Documentation
|
An AkRoom is an enclosed environment that can only communicate to the outside/other rooms with AkRoomPortals. More...
Inherits AkTriggerHandler.
Public Member Functions | |
| ulong | GetID () |
| Access the room's ID. More... | |
| void | SetReverbZone (AkRoom parentRoom, float transitionRegionWidth) |
| Establish a parent-child relationship between this Room and a parent Room. Sound propagate between a Reverb Zone and its parent as if they were the same Room, without the need for a connecting Portal. Examples of Reverb Zones include a covered area with no walls, a forested area within an outdoor space, or any situation where multiple reverb effects are desired within a common space. Reverb Zones have many advantages compared to standard Game-Defined Auxiliary Sends. They are part of the wet path, and form reverb chains with other Rooms; they are spatialized according to their 3D extent; they are also subject to other acoustic phenomena simulated in Wwise Spatial Audio, such as diffraction and transmission. If a Room is already assigned to a parent Room, it is first be removed from the original parent (exactly as if RemoveReverbZone were called) before it is assigned to the new parent Room. The automatically created 'Outdoors' Room is commonly used as a parent Room for Reverb Zones, since they often model open spaces. Calls AK::SpatialAudio::SetReverbZone() with the Parent Room and transition Region Width parameters. More... | |
| void | RemoveReverbZone () |
| Remove this Room, a Reverb Zone, from its parent. Sound can no longer propagate between this Room and its parent, unless they are explicitly connected with a Portal. Calls AK::SpatialAudio::RemoveReverbZone() with this Room's ID."/>. More... | |
Public Attributes | |
| int | priority = 0 |
| AK.Wwise.AuxBus | reverbAuxBus = new AK.Wwise.AuxBus() |
| The reverb auxiliary bus. More... | |
| float | reverbLevel = 1 |
| The reverb control value for the send to the reverb aux bus. More... | |
| float | transmissionLoss = 1 |
| Loss value modeling transmission through walls. More... | |
| AK.Wwise.Event | roomToneEvent = new AK.Wwise.Event() |
| Wwise Event to be posted on the room game object. More... | |
| float | roomToneAuxSend = 0 |
| Send level for sounds that are posted on the room game object; adds reverb to ambience and room tones. Valid range: (0.f-1.f). A value of 0 disables the aux send. More... | |
| System.Collections.Generic.List< int > | triggerList = new System.Collections.Generic.List<int> { START_TRIGGER_ID } |
| List containing the enabled triggers. More... | |
| bool | useOtherObject = false |
| This property is usefull only when used with colliders. When enabled, the target of the action will be the other colliding object. When disabled, it will be the current object. More... | |
Static Public Attributes | |
| const int | MAX_NB_TRIGGERS = 32 |
| Since our mask is a 32 bits integer, we can't have more than 32 triggers. More... | |
| static System.Collections.Generic.Dictionary< uint, string > | triggerTypes = AkTriggerBase.GetAllDerivedTypes() |
| Will contain the types of all the triggers derived from AkTriggerBase at runtime. More... | |
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageRegister your project and we'll help you get started with no strings attached!
Get started with Wwise