Table of Contents

AKRESULT __cdecl AK::SoundEngine::UnregisterGameObj ( AkGameObjectID  in_gameObjectID  ) 

Unregisters a game object.

Returns:
  • AK_Success if successful
  • AK_Fail if the specified AkGameObjectID is invalid (0 is an invalid ID)
Remarks:
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. This sound will stop moving when the game object is unregistered, and there will be no way to regain control over the game object.
See also:
Parameters:
in_gameObjectID  ID of the game object to be unregistered. Use AK_INVALID_GAME_OBJECT to unregister all game objects.