Class UnityCutsceneStep

Unity-specific serializable implementation of cutscene stage entity.
Defines individual cutscene stage with timing, type classification, and Unity integration features including fade color and Timeline asset reference.
Implements ITimedSequenceStage for timed orchestration (duration-aware) and ICutsceneStageProperties for Unity-specific runtime access.

NOTE: Class name kept as UnityCutsceneStep for serialization backward compatibility with existing ScriptableObject assets. Conceptually this represents a "Stage".

Inheritance

object

UnityCutsceneStep

Implements

ITimedSequenceStage

ISequenceStage

ISequenceUnit

ICutsceneStageProperties

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Serenity.CutscenePlayer.Infrastructure.Settings

Assembly: Serenity.UnityCutscenePlayer.Infrastructure.dll

Syntax

public class UnityCutsceneStep : ITimedSequenceStage, ISequenceStage, ISequenceUnit, ICutsceneStageProperties

Constructors

UnityCutsceneStep()

Declaration

public UnityCutsceneStep()

Fields

DialogTextPropertyName

Name of the stored field behind DialogText.

Declaration

public const string DialogTextPropertyName = "dialogText"

Field Value

Type	Description
string

IsTranslatingPropertyName

Name of the stored field behind IsTranslating.

Declaration

public const string IsTranslatingPropertyName = "isTranslating"

Field Value

Type	Description
string

LineTooltip

The explanation of the line field, shared by the inspector and the Cutscene Wizard.

Declaration

public const string LineTooltip = "Show Dialog stages: the line shown on screen for the stage's duration."

Field Value

Type	Description
string

SpeakerPropertyName

Name of the stored field behind Speaker.

Declaration

public const string SpeakerPropertyName = "speaker"

Field Value

Type	Description
string

SpeakerTooltip

The explanation of the speaker field, shared by the inspector and the Cutscene Wizard.

Declaration

public const string SpeakerTooltip = "Show Dialog stages: the name shown above the line. Leave it empty for a narrator line."

Field Value

Type	Description
string

TranslateTooltip

The explanation of the Translate flag, shared by the inspector and the Cutscene Wizard.

Declaration

public const string TranslateTooltip = "Show Dialog stages: treat the speaker and the line as translation keys and show their translation."

Field Value

Type	Description
string

Properties

DialogText

Gets the line a Show Dialog stage shows for its duration.

Declaration

public string DialogText { get; }

Property Value

Type	Description
string

DurationSeconds

Gets duration of the cutscene stage in seconds (ITimedSequenceStage).

Declaration

public float DurationSeconds { get; }

Property Value

Type	Description
float

FadeColor

Gets fade color used during transitions in the cutscene stage.

Declaration

public Color FadeColor { get; }

Property Value

Type	Description
Color

Id

Gets unique identifier for the cutscene stage.

Declaration

public string Id { get; }

Property Value

Type	Description
string

IsTranslating

Gets whether a Show Dialog stage treats its speaker and line as localization keys.

Declaration

public bool IsTranslating { get; }

Property Value

Type	Description
bool

Speaker

Gets the name shown above the line of a Show Dialog stage; empty for a narrator line.

Declaration

public string Speaker { get; }

Property Value

Type	Description
string

StageType

Gets type classification of the cutscene stage (CutscenePlayer-specific).

Declaration

public CutsceneStageType StageType { get; }

Property Value

Type	Description
CutsceneStageType

Timeline

Gets Unity Timeline asset associated with the cutscene stage.

Declaration

public PlayableAsset Timeline { get; }

Property Value

Type	Description
PlayableAsset

Implements

ITimedSequenceStage

ISequenceStage

ISequenceUnit

ICutsceneStageProperties