ZOA Content

ContentPackManifest

class

The Unity-free description of a pack: identity, version, dependencies, and asset entries. Serialisable, so it round-trips to JSON.

• ContentPackId Id
• string DisplayName, Version, Author, Description
• List<ContentPackId> Dependencies
• List<ContentAssetEntry> Assets
• void AddDependency(ContentPackId packId)
• void RemoveDependency(ContentPackId packId)
• void AddAsset(ContentAssetEntry asset)
• bool RemoveAsset(ContentAssetId assetId)
• bool TryGetAsset(ContentAssetId assetId, out ContentAssetEntry asset)
• IEnumerable<ContentAssetEntry> GetAssetsByType(ContentAssetType type)
• IEnumerable<ContentAssetEntry> GetAssetsByTag(string tag)

ContentPackId

struct

Readonly, case-insensitive pack identifier normalised to trimmed lowercase. Implicitly converts to and from string, so a literal works at any call site.

• static ContentPackId Empty { get; }
• bool IsEmpty { get; }
• static bool TryParse(string value, out ContentPackId id)
• implicit operator ContentPackId(string value)
• implicit operator string(ContentPackId id)

ContentAssetId

struct

The same contract as ContentPackId, scoped to one asset within a pack. Comparable and orderable, so asset lists sort deterministically.

• static ContentAssetId Empty { get; }
• bool IsEmpty { get; }
• static bool TryParse(string value, out ContentAssetId id)

ContentAssetEntry

struct

One asset in a pack: its id, its project path, its type, its tags, and the Addressables key it publishes under.

• ContentAssetId AssetId
• string AssetPath
• ContentAssetType AssetType
• List<string> Tags
• string AddressableKey
• bool HasTag(string tag)
• void AddTag(string tag)

ContentAssetType

enum

Definition, Prefab, Material, Texture, Audio, Animation, Scene, Data, Other. Definition covers any ScriptableObject authoring asset.

AddressableConvention

class

Validates and generates Addressables keys. One group per pack, keys shaped pack_id/asset_id or pack_id/group/asset_id.

• static bool ValidateKey(string key)
• static string SuggestKey(ContentAssetEntry asset, ContentPackId packId)
• static string SuggestKeyWithGroup(ContentAssetEntry asset, ContentPackId packId, string group)
• static string GroupNameFor(ContentPackId packId)

IContentPackRegistry

interface

Runtime catalogue of registered manifests, with events on register and unregister so listeners can react without polling.

• event ContentPackRegisteredEventHandler PackRegistered
• event ContentPackUnregisteredEventHandler PackUnregistered
• bool Register(ContentPackManifest manifest)
• bool Unregister(ContentPackId packId)
• bool TryGet(ContentPackId packId, out ContentPackManifest manifest)
• IReadOnlyList<ContentPackManifest> GetAll()
• IReadOnlyList<ContentPackManifest> GetByTag(string tag)
• bool IsRegistered(ContentPackId packId)
• void Clear()

ContentPackRegistry

class

The default in-memory registry, dictionary-backed. Register returns false rather than throwing when the id is already taken.

IContentDependencyResolver

interface

Builds a dependency graph over a manifest's assets and reports which nodes cannot resolve.

• IReadOnlyList<ContentDependencyNode> BuildDependencyGraph(ContentPackManifest manifest)
• IReadOnlyList<ContentDependencyNode> FindBrokenReferences(IEnumerable<ContentDependencyNode> nodes)
• bool HasBrokenDependencies(ContentDependencyNode node)

ContentDependencyNode

class

One asset's node in the graph. IsBroken is maintained for you: it flips true on the first missing dependency and false when the last one resolves.

• ContentAssetId AssetId { get; }
• List<ContentAssetId> Dependencies { get; }
• List<ContentAssetId> MissingDependencies { get; }
• bool IsBroken { get; set; }
• void AddDependency(ContentAssetId dependencyId)
• void MarkMissing(ContentAssetId dependencyId)
• void ResolveMissing(ContentAssetId dependencyId)
• bool HasDependency(ContentAssetId assetId)

IContentValidator

interface

Single-method contract for pack validation. No default implementation ships; supply one when you have project rules to enforce.

• ContentValidationResult ValidatePack(ContentPackManifest manifest)

ContentValidationResult

class

Accumulates issues and tracks validity. Adding an Error issue sets IsValid false automatically, so the flag cannot drift from the contents.

• bool IsValid { get; }
• List<ContentValidationIssue> Issues { get; }
• void AddIssue(ContentValidationIssue issue)
• int ErrorCount { get; }
• int WarningCount { get; }
• int InfoCount { get; }
• IEnumerable<ContentValidationIssue> GetErrors()
• IEnumerable<ContentValidationIssue> GetWarnings()
• IEnumerable<ContentValidationIssue> GetInfo()

ContentValidationIssue

struct

One finding: severity, a machine-readable code, a human message, and the asset it concerns. AssetId is empty for pack-level issues.

• ContentValidationIssueSeverity Severity
• string Code
• string Message
• ContentAssetId AssetId

IContentPackAction

interface

One installable step inside a content pack. Implementations live in the owning domain's editor assembly, must be [Serializable], idempotent, and failure-tolerant.

• string DisplayName { get; }
• string Description { get; }
• bool IsInstalled { get; }
• bool TryApply(out string reason)

ContentPackActionBase

class

Optional [Serializable] base for actions, with a FormatException helper so TryApply can swallow a Unity throw and return a stable message.

ContentPackInstaller

class

The apply orchestrator. Walks a Feature Set's dimensions or a single pack's actions and returns a per-action report; one failing action never blocks the rest.

• static List<ContentPackInstallResult> ApplyFeatureSet(FeatureSetDefinition set)
• static List<ContentPackInstallResult> ApplyPack(ContentPackDefinition pack)

ContentPackInstallResult

struct

One row of the install report. WasAlreadyInstalled separates a no-op from work actually done, so the post-apply status reflects what happened.

• string Pack
• string Action
• bool Success
• bool WasAlreadyInstalled
• string Reason

ContentDeployerUtil

class

Idempotent ScriptableObject deployer used by most install actions. Copies into Assets/ZOA/Content/<dimension>/<theme>/ and regenerates the definition id on the copy so source and clone do not collide.

• const string ContentRoot = "Assets/ZOA/Content"
• static bool DeployAll<T>(string dimensionFolder, string themeFolder, IList<T> sources, out List<string> deployed, out string reason) where T : Object
• static bool AreAllInstalled<T>(string dimensionFolder, string themeFolder, IList<T> sources) where T : Object
• static void EnsureFolder(string folderPath)

IContentBrowserTabProvider

interface

Extension point for a package-owned tab in the Content Browser. The provider owns its catalogue state; the browser owns the chrome.

• string TabId { get; }
• string DisplayName { get; }
• string GridTitle { get; }
• string DetailTitle { get; }
• string EmptyStateText { get; }
• int SortOrder { get; }
• int ItemCount { get; }
• void Refresh()
• void BuildGrid(VisualElement gridContainer, Action requestRepaint)
• void BuildDetail(VisualElement detailPanel, Action requestRepaint)

ContentBrowserTabRegistry

class

Lock-guarded provider list, sorted by SortOrder. Registering an existing TabId replaces the previous provider rather than duplicating the tab.

• static void Register(IContentBrowserTabProvider provider)
• static void Unregister(string tabId)
• static IReadOnlyList<IContentBrowserTabProvider> GetProviders()

IZOAFeatureSetHudService

interface

The runtime HUD contract. Target this rather than the controller so scene generators and authoring tools do not depend on implementation details.

• UIDocument Document { get; }
• FeatureSetDefinition FeatureSet { get; set; }
• FeatureSetDefinition.HudStyleKind CurrentStyle { get; }
• bool IsStyleLoaded { get; }
• string CurrentResourcePath { get; }
• bool TryApplyFeatureSet(FeatureSetDefinition featureSet)
• bool TryApplyStyle(FeatureSetDefinition.HudStyleKind style)
• void Rebind()

ZOAFeatureSetHudController

component

The shipped IZOAFeatureSetHudService. Requires a UIDocument on the same GameObject, loads the UXML for the active style, and references no editor type.

ContentPackDefinition

asset

The authoring asset for one installable pack: a manifest plus cover art, tagline, and the editor-only action list. Assets > Create > ZOA > Content > Content Pack Definition.

• ContentPackManifest Manifest { get; }
• Texture2D Cover { get; }
• string Tagline { get; }
• IReadOnlyList<IContentPackAction> Actions { get; }

FeatureSetDefinition

asset

A curated themed bundle naming one content pack per dimension. Assets > Create > ZOA > Content > Feature Set Definition.

• string ThemeKey { get; }
• Texture2D Cover { get; }
• string TaglineShort { get; }
• string TaglineLong { get; }
• HudStyleKind HudStyle { get; }
• ContentPackDefinition UiTheme, Input, Weapons, AiRoster, Audio, Environment { get; }
• ContentPackDefinition GenreBundle, Items, LootTables, Recipes, Loadout, DemoScene { get; }
• IReadOnlyList<FeatureSetDefinition> DependsOn { get; }
• IEnumerable<ContentPackDefinition> EnumerateDimensions()
• int CoveredDimensionCount { get; }
• const int TotalDimensionSlots = 12

ZOAHudComponentDefinition

asset

Describes one HUD panel: the gameplay system it reads, the binder that feeds it, its slot and default rect, and the USS class tokens its template must expose. Assets > Create > ZOA > UI > HUD Component Definition.

• string ComponentId { get; }
• string DisplayName { get; }
• string GameplaySystem { get; }
• string BinderTypeName { get; }
• ZOAHudSlot PreferredSlot { get; }
• string LayoutRegionId { get; }
• Rect DefaultRect { get; }
• bool EnabledByDefault { get; }
• IReadOnlyList<string> RequiredClassTokens { get; }
• IReadOnlyList<string> OptionalClassTokens { get; }