AkRoomPortal

Wwise Unity Integration Documentation

An AkRoomPortal can connect two AkRoom components together. More...

Inherits AkTriggerHandler.

Public Member Functions
ulong	GetID ()
	Access the portal's ID. More...

override void	HandleEvent (UnityEngine.GameObject in_gameObject)
	Opens the portal on trigger event. More...

void	ClosePortal (UnityEngine.GameObject in_gameObject)
	Closes the portal on trigger event. More...

Public Attributes
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_ROOMS_PER_PORTAL = 2
	AkRoomPortals can only connect a maximum of 2 rooms. More...

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...

Properties
AkRoom	frontRoom `[get]`
	These private members should not be given setters. Rooms should be set using the array, in case we ever increase MAX_ROOMS_PER_PORTAL. More...

Detailed Description

An AkRoomPortal can connect two AkRoom components together.

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Get started with Wwise