TextStudioPlaySoundActionComponent

ClassTextStudioTextStudio

[AddComponentMenu("Text Studio/Actions/Play Sound Action")]
public sealed class TextStudioPlaySoundActionComponent : TextStudioActionComponent, ITextStudioCue, ITextStudioAction, ITextStudioActionDefinitionProvider

Scene-bound sound action that can play through a supplied UnityEngine.AudioSource and optionally pause text reveal until the clip ends.

Methods

Execute(ActionContext)

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.

Constructors

TextStudioPlaySoundActionComponent()

public TextStudioPlaySoundActionComponent()

Properties

DefaultId

protected override string DefaultId { get; }

Returns

System.String

ActionDefinition

public override TextStudioActionDefinition ActionDefinition { get; }

Returns

TextStudio.TextStudioActionDefinition