logo SERENITY
Game Systems Foundation
Search Results for

    Show / Hide Table of Contents

    Class UnityCutscenePlayerService

    Unity cutscene player service providing cutscene-specific playback API.
    Executes timed stages directly using ITimedSequenceStage.DurationSeconds.

    CutscenePlayer is a first-class vertical aggregate, NOT legacy. It provides cutscene authoring, tooling, and UX on top of the generic SequencePlayer orchestration foundation.

    NOTE: This service does NOT delegate to UnitySequencePlayerService. It executes stages directly because CutscenePlayer owns timed orchestration. RigPrefab is owned by CutscenePlayer, NOT by generic SequencePlayer.

    Inheritance
    object
    UnityCutscenePlayerService
    Implements
    ICutscenePlayerService
    ISequencePlayerService
    IService
    IFoundationSettings
    Namespace: Serenity.CutscenePlayer.Infrastructure.Services
    Assembly: Serenity.UnityCutscenePlayer.Infrastructure.dll
    Syntax
    public class UnityCutscenePlayerService : MonoBehaviour, ICutscenePlayerService, ISequencePlayerService, IService, IFoundationSettings

    Constructors

    UnityCutscenePlayerService()

    Declaration
    public UnityCutscenePlayerService()

    Properties

    Guid

    Declaration
    public string Guid { get; set; }
    Property Value
    Type Description
    string

    Id

    Declaration
    public string Id { get; set; }
    Property Value
    Type Description
    string

    LogService

    Declaration
    public ILogService LogService { get; set; }
    Property Value
    Type Description
    ILogService

    Methods

    Initialize(ILogService)

    Initializes the cutscene player service with logging dependency.

    Declaration
    public void Initialize(ILogService logService)
    Parameters
    Type Name Description
    ILogService logService

    PlayAsync(ISequenceDefinition, CancellationToken)

    Plays a cutscene asynchronously using a cutscene definition.

    Declaration
    public Task PlayAsync(ISequenceDefinition definition, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    ISequenceDefinition definition
    CancellationToken cancellationToken
    Returns
    Type Description
    Task

    PlayAsync(string, CancellationToken)

    Plays a cutscene asynchronously by key identifier.

    Declaration
    public Task PlayAsync(string cutsceneKey, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string cutsceneKey
    CancellationToken cancellationToken
    Returns
    Type Description
    Task

    SetDefinitions(UnityCutsceneDefinition[])

    Sets cutscene definitions array.

    Declaration
    public void SetDefinitions(UnityCutsceneDefinition[] defs)
    Parameters
    Type Name Description
    UnityCutsceneDefinition[] defs

    Implements

    ICutscenePlayerService
    ISequencePlayerService
    IService
    IFoundationSettings
    In this article
    © 2026 Serenity. All Rights Reserved