Firelight Technologies FMOD Studio API

Studio::System::getEvent

Retrieves an EventDescription by path or ID string.

C++ Syntax

FMOD_RESULT Studio::System::getEvent(
  const char *path,
  Studio::EventDescription **event
);

C Syntax

FMOD_RESULT FMOD_Studio_System_GetEvent(
  FMOD_STUDIO_SYSTEM *system,
  const char *path,
  FMOD_STUDIO_EVENTDESCRIPTION **event
);

C# Syntax

RESULT Studio.System.getEvent(
  string path,
  out EventDescription _event
);

JavaScript Syntax

System.getEvent(
  path,                            
  event                            // writes value to event.val
);

Parameters

path

The path or the ID string that identifies the event or snapshot.

event

Address of a variable to receive the EventDescription object.

Return Values

If the function succeeds then the return value is FMOD_OK.
If the function fails then the return value will be one of the values defined in the FMOD_RESULT enumeration.

Remarks

This function allows you to retrieve a handle to any loaded event description.

The path field can be the full event path, such as 'event:/UI/Cancel' or 'snapshot:/IngamePause', or the ID in the form '{2a3e48e6-94fc-4363-9468-33d2dd4d7b00}'.

Note that path lookups will only succeed if the strings bank has been loaded.

See Also

• Studio::parseID
• Studio::System::lookupID
• Studio::System::getEventByID
• Studio::EventDescription::isSnapshot
• Studio::EventDescription::createInstance

Version 1.10.03 Built on Feb 1, 2018