Version
menu
Wwise SDK 2025.1.4
List of all members | Public Attributes
AkCmd_RegisterGameObject Struct Reference

#include AkCommandTypes.h>

Public Attributes

AkGameObjectID gameObjectID
 ID of the game object to be registered. Valid range is [0 to 0xFFFFFFFFFFFFFFDF]. More...
 

Detailed Description

Registers a game object ID.

Optionally, you can associate a name to the game object for profiling purposes. Call AK_CommandBuffer_AddString after adding the command to attach a name to the game object: 

auto cmd = (AkCmd_RegisterGameObject*)AK_CommandBuffer_Add(buffer, AkCommand_RegisterGameObject);
cmd->gameObjectID = 100;
AK_CommandBuffer_AddString(buffer, "Player Emitter");

If the ID was already registered, its name is updated.

This command can fail for the following reasons:

  • AK_InvalidParameter: gameObjectID is outside the valid range.
  • AK_InsufficientMemory: Game object could not be registered due to a memory allocation failure
See also
AkCommand_RegisterGameObject

Definition at line 187 of file AkCommandTypes.h.

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