Class SubtitlerTransitionBase

Namespace

Gasimo.Subtitles

Assembly

Gasimo.Subtitler.dll

public abstract class SubtitlerTransitionBase : ScriptableObject, ISubtitlerTransition

Inheritance

object

Object

ScriptableObject

SubtitlerTransitionBase

Implements

ISubtitlerTransition

Derived

SubtitlerFadeTransition

SubtitlerTypewriter

Fields

ScriptableObjectMenuPath

public const string ScriptableObjectMenuPath = "Gasimo/Subtitler/Transitions/"

Field Value

string

Methods

AnimateSubtitleEntrance(Label, ISubtitleEntry, CancellationToken)

Called when a subtitle entry is about to be displayed.

public virtual Task AnimateSubtitleEntrance(Label subtitle, ISubtitleEntry entry, CancellationToken cancellationToken)

Parameters

subtitle Label

Label containing this subtitle

entry ISubtitleEntry

cancellationToken CancellationToken

Token which gets called when the entry is interrupted.

Returns

Task

Task containing the animaion

AnimateSubtitleExit(Label, ISubtitleEntry, CancellationToken)

Called when a subtitle entry is about to be hidden.

public virtual Task AnimateSubtitleExit(Label subtitle, ISubtitleEntry entry, CancellationToken cancellationToken)

Parameters

subtitle Label

Label containing this subtitle

entry ISubtitleEntry

cancellationToken CancellationToken

Token which gets called when the entry is interrupted.

Returns

Task