Studio::EventInstance::triggerCue

FMOD Studio API

Firelight Technologies FMOD Studio API

Studio::EventInstance::triggerCue

Triggers a cue on the event, which allows the timeline cursor to move past sustain points.

C++ Syntax

FMOD_RESULT Studio::EventInstance::triggerCue();

C Syntax

FMOD_RESULT FMOD_Studio_EventInstance_TriggerCue(FMOD_STUDIO_EVENTINSTANCE *eventinstance);

C# Syntax

RESULT Studio.EventInstance.triggerCue();

JavaScript Syntax

EventInstance.triggerCue();

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

Triggering cues makes the timeline cursor continue past sustain points. The cue can be triggered ahead of time; for each time it is triggered, the timeline cursor will continue past one more sustain point.

This function returns FMOD_ERR_EVENT_NOTFOUND if the event has no sustain points.

See Also




Version 1.10.03 Built on Feb 1, 2018