Firelight Technologies FMOD Studio API
Studio::EventDescription::isOneshot
Retrieves the event's oneshot status, indicating whether the event will naturally terminate.
C++ Syntax
FMOD_RESULT Studio::EventDescription::isOneshot(
bool *oneshot
);
C Syntax
FMOD_RESULT FMOD_Studio_EventDescription_IsOneshot(
FMOD_STUDIO_EVENTDESCRIPTION *eventdescription,
FMOD_BOOL *oneshot
);
C# Syntax
RESULT Studio.EventDescription.isOneshot(
out bool oneshot
);
JavaScript Syntax
EventDescription.isOneshot(
oneshot // writes value to oneshot.val
);
Parameters
- oneshot
- Address of a variable to receive the oneshot status.
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
If the event is oneshot then it will naturally terminate and can be used as a fire-and-forget style oneshot sound by calling Studio::EventInstance::start followed by Studio::EventInstance::release.
See Also
Version 1.10.03 Built on Feb 1, 2018