Class CutsceneHandle

Namespace

S1API.Cutscenes

Assembly

S1API.dll

Controls one configured local cutscene and reports its current playback state.

public sealed class CutsceneHandle : IDisposable

Inheritance

object

CutsceneHandle

Implements

IDisposable

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

ReflectionUtils.GetValueTupleItems(object)

ReflectionUtils.IsValueTuple(object)

Properties

Elapsed

Gets elapsed playback time in seconds.

public float Elapsed { get; }

Property Value

float

EndReason

Gets the reason the most recent playback ended, or null before it ends.

public CutsceneEndReason? EndReason { get; }

Property Value

CutsceneEndReason?

Id

Gets the stable, mod-namespaced cutscene identifier.

public string Id { get; }

Property Value

string

IsPlaying

Gets whether this handle is the currently playing S1API cutscene.

public bool IsPlaying { get; }

Property Value

bool

Name

Gets the descriptive cutscene name.

public string Name { get; }

Property Value

string

Progress

Gets normalized playback progress in the inclusive range from zero to one.

public float Progress { get; }

Property Value

float

Methods

Dispose()

Stops active playback and prevents this handle from being played again.

public void Dispose()

Play()

Attempts to start local playback.

public bool Play()

Returns

bool

true when playback started; otherwise false. Runtime unavailability and overlapping playback are logged and fail safely.

Skip()

Skips this cutscene if it is currently playing.

public bool Skip()

Returns

bool

true when active playback was skipped.

Stop()

Stops this cutscene if it is currently playing.

public bool Stop()

Returns

bool

true when active playback was stopped.