Version

menu_open
Wwise SDK 2023.1.4
ak.soundengine.unregisterGameObj

Unregisters a game object. Registering a game object twice does nothing. Unregistering it once unregisters it no matter how many times it has been registered. Unregistering a game object while it is in use is allowed, but the control over the parameters of this game object is lost. For example, say a sound associated with this game object is a 3D moving sound. It stops moving when the game object is unregistered, and there is no way to regain control over the game object. See AK::SoundEngine::UnregisterGameObj.

Arguments

Name Type Description
gameObject * integer ID of the game object to be unregistered. Valid range is [0, 0xFFFFFFFFFFFFFFDF]. Use AK_INVALID_GAME_OBJECT to unregister all game objects.
A game object ID, unsigned integer 64-bit. Range: [0,18446744073709551615]

(Required *)

Arguments Schema

See Also

Examples

Refer to Using the Wwise Authoring API (WAAPI) for more information about Wwise Authoring API.


Was this page helpful?

Need Support?

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

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise