Class ProjectWiringPlan

The immutable outcome of Serenity.CreateGame.Infrastructure.Editor.Wiring.ProjectWiringPlanner.Plan(Serenity.ProjectRecipe.Infrastructure.Editor.SetupAssistant.MinimalLoopOptions,Serenity.CreateGame.Infrastructure.Editor.CreateGameScenesOptions,System.Collections.Generic.IReadOnlyList{Serenity.CreateGame.Infrastructure.Editor.Systems.SerenityInstallableSystem}): what Initialize Serenity's Create step will do to wire the project — never author settings or menus, only wire the initialization pipeline profile, the selected systems' boot tasks, the boot/gameplay scenes and Health Check. Rendered by the Summary step and executed, item for item, by Serenity.CreateGame.Infrastructure.Editor.Wiring.ProjectWiringRunner, so the plan's order and the executed order can never drift apart.

Inheritance

object

ProjectWiringPlan

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Namespace: Serenity.CreateGame.Infrastructure.Editor.Wiring

Assembly: Serenity.UnityCreateGame.Infrastructure.Editor.dll

Syntax

public sealed class ProjectWiringPlan

Constructors

ProjectWiringPlan(PipelineProfileState, string, IReadOnlyList<string>, IReadOnlyList<BootTaskPlanItem>, IReadOnlyList<ScenePlanItem>, bool)

Declaration

public ProjectWiringPlan(ProjectWiringPlan.PipelineProfileState profileState, string targetProfilePath, IReadOnlyList<string> ambiguousProfilePaths, IReadOnlyList<BootTaskPlanItem> bootTasks, IReadOnlyList<ScenePlanItem> scenes, bool runHealthCheck)

Parameters

Type	Name	Description
ProjectWiringPlan.PipelineProfileState	profileState
string	targetProfilePath
IReadOnlyList<string>	ambiguousProfilePaths
IReadOnlyList<BootTaskPlanItem>	bootTasks
IReadOnlyList<ScenePlanItem>	scenes
bool	runHealthCheck

Properties

AmbiguousProfilePaths

Declaration

public IReadOnlyList<string> AmbiguousProfilePaths { get; }

Property Value

Type	Description
IReadOnlyList<string>	Every project-owned profile found, only populated when ProfileState is Ambiguous.

BlockingErrorMessage

Declaration

public string BlockingErrorMessage { get; }

Property Value

Type	Description
string	The reader-facing reason HasBlockingError is true, or null when it is false.

BootTasks

Declaration

public IReadOnlyList<BootTaskPlanItem> BootTasks { get; }

Property Value

Type	Description
IReadOnlyList<BootTaskPlanItem>	One entry per selected, non-bootstrap system.

HasBlockingError

Declaration

public bool HasBlockingError { get; }

Property Value

Type	Description
bool	True when this plan cannot be executed as-is — currently only Ambiguous.

ProfileState

Declaration

public ProjectWiringPlan.PipelineProfileState ProfileState { get; }

Property Value

Type	Description
ProjectWiringPlan.PipelineProfileState	Whether the target profile will be created, reused, or is ambiguous.

RunHealthCheck

Declaration

public bool RunHealthCheck { get; }

Property Value

Type	Description
bool	Whether Create also runs the Health Check validator — always true today; a named flag so a future run mode can turn it off without changing every caller's signature.

Scenes

Declaration

public IReadOnlyList<ScenePlanItem> Scenes { get; }

Property Value

Type	Description
IReadOnlyList<ScenePlanItem>	One entry for the boot scene, one for the gameplay scene.

TargetProfilePath

Declaration

public string TargetProfilePath { get; }

Property Value

Type	Description
string	The profile this run will wire into — a would-be path when ProfileState is Create, the existing profile's real path when Reuse, and null when Ambiguous.