ZOA Workbench

IZOAWorkbenchModule

interface

The contract a package implements to contribute a page. Discovered via TypeCache; needs a public parameterless constructor.

• string Id { get; }
• string Title { get; }
• string Subtitle { get; }
• int Order { get; }
• string SearchText { get; }
• VisualElement Build(ZOAWorkbenchContext context)
• void Refresh(ZOAWorkbenchContext context, VisualElement root)

ZOAWorkbenchModuleAttribute

class

Declares a class as a Workbench module and optionally attaches it to a workflow hub. Class-only, not inherited, single use.

• ZOAWorkbenchModuleAttribute(string id, string title, int order)
• string WorkflowId { get; set; }

ZOAWorkbenchContext

class

Everything a module is handed at Build time: the host window, the database and registry, navigation callbacks, the current mode, and the live scene snapshot service.

• EditorWindow HostWindow { get; set; }
• GameDatabase GameDatabase { get; set; }
• IDefinitionRegistry DefinitionRegistry { get; set; }
• Action<string> SetStatus { get; set; }
• Action<string> SelectModule { get; set; }
• Action<string, string> Navigate { get; set; }
• Action<string> SelectCapability { get; set; }
• bool IsExpertMode { get; set; }
• WorkbenchWorkflowMode WorkflowMode { get; set; }
• IWorkbenchSceneContextService SceneContext { get; set; }

FoundryModuleManifest

class

Static registry of discovered modules with metadata. Use it to enumerate what is installed without opening the window.

• static IReadOnlyList<ModuleEntry> All { get; }
• static void Refresh()
• static ModuleEntry FindById(string id)
• static int Count { get; }

CapabilityStripBuilder

class

Fluent builder for the capability strip. Three ways to attach a tool: an embedded EditorWindow named by string, a native VisualElement builder, or a menu-path fallback.

• CapabilityStripBuilder(string moduleId)
• CapabilityStripBuilder AddEmbedded(string id, string label, string tooltip, string windowTypeName, WorkbenchCapabilityRenderMode renderMode, string owner = null)
• CapabilityStripBuilder AddNative(string id, string label, string tooltip, Func<ZOAWorkbenchContext, VisualElement> nativeBuilder, string owner = null)
• CapabilityStripBuilder AddFallback(string id, string label, string tooltip, string fallbackMenuPath, string fallbackActionLabel, string owner = null)
• VisualElement Build(ZOAWorkbenchContext context)
• void SelectCapability(string id, ZOAWorkbenchContext context)
• string SelectedId { get; }

WorkbenchCapabilityHost

class

Resolves an EditorWindow type by name, instantiates it, and mounts its view inside the Workbench. Disposes embedded handles on play-mode change and before assembly reload.

• static bool TryCreateEmbeddedCapability(string windowTypeName, WorkbenchCapabilityRenderMode renderMode, out VisualElement view, out IDisposable handle, out string error)
• static bool TryMountNativeCapability(...)
• static void DisposeMountedCapability(VisualElement owner)

WorkbenchCapabilityRenderMode

enum

UiToolkit or Imgui. Tells the host how to mount an embedded window's content.

FoundryWizardShell

class

The three-column wizard layout every Foundry wizard is built in: step rail, main content, preview dock, with an issue tray beneath. A UxmlElement, so it can also be declared in UXML.

• FoundryWizardShell AddStep(string title, string description, Func<VisualElement> contentBuilder, Func<List<FoundryIssue>> validator = null)
• void Begin()
• void GoToStep(int index)
• List<FoundryIssue> RunStepValidation()
• FoundryIssueTray IssueTray { get; }
• FoundryPreviewDock PreviewDock { get; }
• FoundryStepRail StepRail { get; }
• IFoundryProgressReporter Progress { get; }
• Task ShowProgressAsync(...)
• event Action Completed
• event Action Cancelled
• event Action<int> StepChanged

FoundryIssueTray

class

Collapsible validation tray. Issues carry an optional quick fix, and the tray offers a Fix All button that runs every available one.

• void AddIssue(FoundryIssue issue)
• void AddIssues(IEnumerable<FoundryIssue> issues)
• void Clear()
• IReadOnlyList<FoundryIssue> Issues { get; }
• bool HasErrors { get; }
• bool HasIssues { get; }

FoundryIssue

class

One validation result. The static factories are the normal way to build them, and every mechanical remedy should be attached as a quick fix rather than only described.

• static FoundryIssue Error(string message, Action quickFix = null, string fixLabel = "Fix")
• static FoundryIssue Warning(string message, Action quickFix = null, string fixLabel = "Fix")
• static FoundryIssue Info(string message)
• FoundryIssueSeverity Severity { get; }
• string Message { get; }
• Action QuickFix { get; }
• string QuickFixLabel { get; }

FoundryStepRail

class

Vertical numbered step indicator with click-to-navigate for completed and current steps. Arrow-key navigable.

• void AddStep(string title, string description = null)
• void SetActiveStep(int index)
• void MarkCompleted(int index)
• event Action<int> StepClicked

FoundryPreviewDock

class

Collapsible right-hand panel for live previews and summaries. Takes custom content, a text summary, or a key/value grid.

• void SetTitle(string title)
• void SetContent(VisualElement content)
• void SetSummary(string title, string body)
• void SetKeyValueSummary(string title, params (string key, string value)[] entries)
• void ShowPlaceholder(string message = null)
• void SetCollapsed(bool collapsed)

IFoundryProgressReporter

interface

UI-neutral progress contract handed to long-running work. A negative fraction means indeterminate; tests substitute the no-op implementation.

• void Begin(string headline, bool canCancel = false)
• void Report(float fraction, string detail = null)
• void End()
• bool IsCancelled { get; }

FoundryProgressRouter

class

Routes legacy editor progress calls into the active Workbench overlay when one is registered, and to Unity's modal popup when the caller is running standalone from a menu.

• static void RegisterReporter(IFoundryProgressReporter reporter)
• static void UnregisterReporter(IFoundryProgressReporter reporter)
• static void DisplayProgressBar(string title, string info, float progress)
• static bool DisplayCancelableProgressBar(string title, string info, float progress)
• static void ClearProgressBar()
• static bool HasActiveWorkbenchReporter { get; }

IWorkbenchConfigAuthoringService

service

Creates the core configuration assets: GameDatabase, NetworkSettings, SaveBackendSettings. Skips what already exists and populates the database.

• WorkbenchConfigAuthoringResult InitializeConfiguration(WorkbenchConfigAuthoringRequest request)
• bool AllConfigurationAssetsExist()
• string GetSaveBackendSettingsPath()

IWorkbenchPlayerAuthoringService

service

Builds the default-player definition bundle and the player prefab as two independently callable operations.

• WorkbenchPlayerDefinitionsResult BuildPlayerDefinitions(WorkbenchPlayerDefinitionsRequest request)
• WorkbenchPlayerPrefabResult BuildPlayerPrefab(WorkbenchPlayerPrefabRequest request)

IWorkbenchSceneAuthoringService

service

Creates and scaffolds a gameplay scene: environment essentials, manager hierarchy, then save to disk.

• WorkbenchSceneAuthoringResult BuildScene(WorkbenchSceneAuthoringRequest request)

IWorkbenchSceneValidationService

service

The read-only inverse of the authoring service. Reports which scene essentials are present, and never mutates the scene or the asset database.

• WorkbenchSceneValidationResult ValidateActiveScene()

IWorkbenchSceneProvisioningProvider

interface

Extension point letting a package take over scene generation with its own pipeline. Highest priority provider that accepts the request wins.

• string Id { get; }
• int Priority { get; }
• bool CanProvision(WorkbenchSceneAuthoringRequest request)
• bool TryGenerateScene(WorkbenchSceneAuthoringRequest request, out string error)

WorkbenchSceneProvisioningRegistry

class

Static, lock-guarded provider list sorted by descending priority. Duplicate provider types are ignored on register.

• static void Register(IWorkbenchSceneProvisioningProvider provider)
• static void Unregister<TProvider>()
• static bool TryGenerateScene(WorkbenchSceneAuthoringRequest request, out string providerId, out string error)

IWorkbenchSceneContextService

service

Live view of the open scene set. Read Current for a snapshot, subscribe to SnapshotChanged to stay current without polling.

• SceneSnapshot Current { get; }
• event Action<SceneSnapshot> SnapshotChanged
• void RequestImmediateRebuild()
• void RequestRebuild()

ISceneContextProvider

interface

Per-package scene scanner. Needs a public parameterless constructor and must be allocation-aware, since Scan can run several times a second during hierarchy churn.

• string Category { get; }
• int Order { get; }
• IEnumerable<SceneEntry> Scan(IReadOnlyList<Scene> openScenes)

SceneSnapshot

class

Immutable result of one rebuild: status, active and open scene names, the entries, and the capture time.

• static readonly SceneSnapshot Empty
• SceneContextStatus Status { get; }
• string ActiveSceneName { get; }
• string ActiveScenePath { get; }
• IReadOnlyList<string> OpenSceneNames { get; }
• IReadOnlyList<SceneEntry> Entries { get; }
• DateTime CapturedUtc { get; }
• IEnumerable<SceneEntry> EntriesInCategory(string category)
• int CountInCategory(string category)

SceneEntry

class

One thing found in the scene: a category, a stable id, a display name, an optional GameObject, a fact grid, and optional ping and primary actions.

• string Category { get; }
• string Id { get; }
• string DisplayName { get; }
• GameObject Target { get; }
• IReadOnlyList<SceneEntryFact> Facts { get; }
• Action PingAction { get; }
• Action PrimaryAction { get; }
• string PrimaryActionLabel { get; }

SceneEntryCategory

class

Canonical category keys as string constants rather than an enum, so downstream packages can add categories without touching this assembly.

• const string Players = "players"
• const string WeaponRacks = "weapon-racks"
• const string Installers = "installers"
• const string Interactables = "interactables"
• const string Inventories = "inventories"
• const string ActiveContent = "active-content"

SceneContextStatus

enum

Unknown, Pending, Ready, NoScene. Lets a hub tell an empty scene apart from one that has not been scanned yet.

WorkbenchWorkflowMode

enum

Demo or Production. Demo routes new users into Start Here and biases generated assets toward evaluation content; Production is the clean authoring path.

IFeatureCompletenessValidator

interface

A per-package completeness check surfaced on the Workbench dashboard. Returns FoundryIssue values, so every mechanical remedy arrives as a quick fix.

• string ValidatorId { get; }
• string DisplayName { get; }
• string SystemArea { get; }
• List<FoundryIssue> Validate()

FeatureCompletenessService

class

Discovers and runs every validator with exception isolation, so one broken validator becomes its own error row rather than killing the sweep.

• static List<IFeatureCompletenessValidator> DiscoverValidators()
• static List<FeatureCompletenessResult> RunAll()

ZOAProjectConfigurator

class

Owns the project-level settings ZOA requires: layers, tags and the physics collision matrix. Other packages register their own requirements from an InitializeOnLoadMethod rather than editing this list.

• static ConfigResult Apply()
• static ValidationReport Validate()
• static void RegisterTags(params string[] tags)
• static void RegisterLayers(params string[] layers)
• static void RegisterIgnoredCollisionPairs(params (string LayerA, string LayerB)[] pairs)
• static readonly string[] RequiredLayers
• static readonly string[] RequiredTags

FoundrySystemBuilder

class

The one-click full-stack builder behind Start Here. Runs seven phases and returns a BuildResult listing created assets, warnings, and the emitted prefabs and scene path.

• static readonly BuildPhase[] Phases
• static bool IsCleanInstall()
• class BuildResult { bool Success; int PhasesCompleted; List<string> CreatedAssets; List<string> Warnings; GameObject PlayerPrefab; string ScenePath; }

ZOAEditorMenu

class

The canonical menu contract. Every ZOA menu path is composed from these constants, and the menu-hierarchy tests assert against IsCanonicalPath.

• const string Root = "Tools/ZOA"
• const string StartHere, Player, AI, ItemsEconomy, Weapons, Environment, Rendering, Advanced
• const string Workbench, Define, Build, Generate, Validate, Maintain, Help
• static bool IsCanonicalPath(string menuPath)
• static bool IsWorkbenchShortcutPath(string menuPath)