Skip to content

TextStudioPlaySoundAction

ClassTextStudioTextStudio
[CreateAssetMenu(fileName = "TextStudioPlaySoundAction", menuName = "Text Studio/Actions/Play Sound", order = 13)]
public sealed class TextStudioPlaySoundAction : TextStudioActionAsset, ITextStudioCue, ITextStudioAction, ITextStudioActionDefinitionProvider

Reusable Text Studio action asset that plays one of its configured audio clips when a matching markup action is reached during text playback.

public override IEnumerator Execute(ActionContext context)

Executes the action as part of reveal playback.

Parameters

Name Type Description
context TextStudio.ActionContext Marker data and restricted playback controls for this invocation.

Returns

System.Collections.IEnumerator: Coroutine enumerator, or null for an immediate action.

public TextStudioPlaySoundAction()

protected override string DefaultId { get; }

Returns

System.String

public override TextStudioActionDefinition ActionDefinition { get; }

Returns

TextStudio.TextStudioActionDefinition