Class CutsceneCreator.Input

Everything needed to create one cutscene.

Inheritance

object

CutsceneCreator.Input

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Namespace: Serenity.CutscenePlayer.Installation.Settings.Editor.Builder

Assembly: Serenity.UnityCutscenePlayer.Installation.Editor.dll

Syntax

public sealed class CutsceneCreator.Input

Constructors

Input()

Declaration

public Input()

Fields

CreateInitTask

When true, a UnityReflectionCallTaskDefinition is created so the cutscene can be played from the initialization pipeline (a boot splash). It is not added to a pipeline profile.

Declaration

public bool CreateInitTask

Field Value

Type	Description
bool

ExistingRig

Declaration

public GameObject ExistingRig

Field Value

Type	Description
GameObject

GenerateTrigger

When true, a no-code play trigger (Signal+Action) is generated.

Declaration

public bool GenerateTrigger

Field Value

Type	Description
bool

Id

Unique cutscene id (also the generated sub-folder name and the PlayAsync key).

Declaration

public string Id

Field Value

Type	Description
string

MediaFolderPath

Project-relative parent folder for the generated assets (e.g. "Assets/.../Media").

Declaration

public string MediaFolderPath

Field Value

Type	Description
string

Name

Display name; used for the asset file name and the trigger's base name.

Declaration

public string Name

Field Value

Type	Description
string

RegisterAsAddressables

When true AND a UnityCutscenePlayerSettings asset is created — a fresh one or a project copy of the shipped one, not when appending to an existing one — that asset is registered as Addressable with its module label. Ignored when RegisterInSettings is false, or when the project already has a settings asset to append to.

Declaration

public bool RegisterAsAddressables

Field Value

Type	Description
bool

RegisterInSettings

When true, the new definition is appended to the project's player-settings Definitions.

Declaration

public bool RegisterInSettings

Field Value

Type	Description
bool

Rig

Declaration

public CutsceneCreator.RigMode Rig

Field Value

Type	Description
CutsceneCreator.RigMode

SettingsAssetPath

Explicit settings asset path (a test seam and an already-known-asset fast path). When set, an asset already present at this path is edited; when no asset exists there yet, a fresh one is created at exactly this path instead of the project-wide search below. Leave empty for the production behavior: the project's own UnityCutscenePlayerSettings asset, otherwise a project copy of the shipped one, and only when the project holds none at all a fresh one under MediaFolderPath — see Serenity.CutscenePlayer.Installation.Settings.Editor.Builder.CutscenePlayerSettingsRegistration.

Declaration

public string SettingsAssetPath

Field Value

Type	Description
string

Stages

Ordered stages to author.

Declaration

public List<CutsceneCreator.StageInput> Stages

Field Value

Type	Description
List<CutsceneCreator.StageInput>

TriggerKind

Which trigger shape to generate when GenerateTrigger is true. PlayOnce = one PlayAsync action; PlayLooping = an idempotent Play/Stop pair via the cutscene service.

Declaration

public CutsceneTriggerScriptCreator.TriggerKind TriggerKind

Field Value

Type	Description
CutsceneTriggerScriptCreator.TriggerKind

TriggerNamespace

Namespace for the generated trigger script (empty generates without a namespace).

Declaration

public string TriggerNamespace

Field Value

Type	Description
string

TriggerScriptFolderPath

Project-relative parent folder for the generated trigger script.

Declaration

public string TriggerScriptFolderPath

Field Value

Type	Description
string