Skip to content
Project referenceDevelopmentEngine ccf7d03f
Authored
  • Byte-backed settings documents, project contribution composition, and generation-scoped lookup.

This project defines host-neutral settings persistence and effective project settings. It separates the document medium, stable setting protocol, contribution composer and active lookup. Start with reading settings or defining a setting.

ProjectSettingsStore owns one project’s effective settings, contributor snapshot and revision. It borrows its document boundary, type catalog, serialization registry and complete owner-provided serialization context. Dispose the store before retiring those services. IProjectSettingsLookup exposes the read-only effective values without exposing authoring operations.

Get and successful TryGet reconstruct isolated setting objects. Their identity and CLR types belong to the active generation. The pair of owner ID and revision identifies the current effective snapshot within that owner’s lifetime; it is neither a persistent project identifier nor a promise that candidate revisions survive rollback.

The store serializes its own operations with a lock. The lower-level ProjectSettings and document stores do not supply a general concurrent transaction boundary. Coordinate generation changes and related service operations through the host. Async execution scopes are strictly last-in-first-out, borrow the lookup, and do not dispose it. Using a disposed store fails as an uninitialized owner.

SettingsDocumentStore<TDocument> loads, validates, captures and restores a serializable document from an explicit IByteDocumentStore. Missing optional documents produce validated, cloned defaults. Malformed existing data fails; required missing data fails. A default factory is not a corruption recovery policy.

Authoring composition uses FileByteDocumentStore and its atomic-file boundary. Runtime composition can capture content-lease bytes into ReadOnlyByteDocumentStore, whose owned byte snapshot rejects writes. Settings does not retain the content lease or secretly choose another filename. Editor, Build and Player hosts use the same document protocol with the medium appropriate to each product.

The generic document store does not accept an owner serialization context. Effective project contribution capture and restoration do: callers of ProjectSettings and ProjectSettingsStore provide their complete context explicitly.

Definitions and optional composers are discovered through the actual type catalog. Effective state is built into neutral candidate records before it replaces the current in-memory set. Unavailable definitions retain neutral contributions for later recovery. Old generation objects and composer instances do not become permanent cache entries.

Project document authoring and generation rollback are different operations. Authoring attempts to restore persisted bytes when composition fails, but a second storage failure can prevent recovery. Generation rollback restores captured effective state, contributors and revision without persisting a document. Read the composition procedure before adding an owner or changing contribution semantics.

The Runtime script projection exposes Settings, stable project/setting identity values, ProjectIdentitySettings, definition/composer attributes and the protocol composition types declared by this project’s export manifest. Host stores, the document medium, registry and execution-context binding remain host APIs. A public source CLR declaration is not automatically a script export.

The project depends on Core Serialization and IO for data, Extensibility Types/Catalogs for discovery, Reload for the generation participant, and Core Execution for scoped lookup. It does not own Editor presentation, Plugin activation or the product’s source lease.

Browse setting identities, document stores, lookup and composer declarations.

The compiler-selected script declarations are separate from this project’s host CLR surface. Read the script calling guide and the associated module contracts before using a projected member.

Project: Inno.Core.Settings
Source: src/foundation/core/Inno.Core.Settings/Inno.Core.Settings.csproj

Type API Description
IProjectSettingsLookup engine Defines the read-only effective settings boundary shared by Editor and Player hosts.
ProjectId engine Identifies one project namespace used to qualify project-authored logical names.
ProjectIdentitySettings engine Stores the editable identity namespace of the current project.
ProjectLocalId engine Stores the project-independent portion of one project-scoped identity.
ProjectScopedId engine Combines a mutable project namespace with a stable project-independent local identity.
ProjectSettingComposer engine Defines the non-generic base for a protocol-owned project setting composer.
ProjectSettingComposerAttribute engine Declares the protocol-owned composer used to combine contributions for one project setting. Settings without a composer retain the default whole-value replacement behavior.
ProjectSettingComposer<TSetting, TContribution> engine Lets one setting protocol define deterministic delta capture and multi-contributor composition.
ProjectSettingContributionContext engine Exposes ownership and dependency information while a protocol-owned composer combines one contribution.
ProjectSettingContributionSource engine Identifies where one setting contribution originated.
ProjectSettingContribution<TContribution> engine Provides one decoded contribution and its immutable composition context.
ProjectSettingDefinitionAttribute engine Declares a reloadable settings type under one stable protocol identity.
ProjectSettingId engine Identifies one host-neutral project setting protocol.
ProjectSettingRecord engine Stores one protocol-owned neutral setting contribution for persistence and composition.
ProjectSettings engine Composes setting defaults, Plugin contributions, and project overrides atomically.
ProjectSettingsContributor engine Describes one dependency-ordered provider of default setting values.
ProjectSettingsDocument engine Stores project-authored setting contributions in one native document.
ProjectSettingsExecutionContext engine Binds one host-owned settings lookup to the current asynchronous script execution context.
ProjectSettingsStore engine Owns one project’s effective settings, contributors, persistence, and generation revision.
Settings engine Provides script-facing project settings queries through the current runtime execution context.
SettingsDocumentStore<TDocument> engine Provides validated current-format serialization and atomic persistence for one settings document type.
SettingsFileNames engine Defines the canonical project-root names of the independent settings documents.
ProjectId Runtime Identifies one project namespace used to qualify project-authored logical names.
ProjectIdentitySettings Runtime Stores the editable identity namespace of the current project.
ProjectLocalId Runtime Stores the project-independent portion of one project-scoped identity.
ProjectScopedId Runtime Combines a mutable project namespace with a stable project-independent local identity.
ProjectSettingComposer Runtime Defines the non-generic base for a protocol-owned project setting composer.
ProjectSettingComposerAttribute Runtime Declares the protocol-owned composer used to combine contributions for one project setting. Settings without a composer retain the default whole-value replacement behavior.
ProjectSettingComposer<TSetting, TContribution> Runtime Lets one setting protocol define deterministic delta capture and multi-contributor composition.
ProjectSettingContributionContext Runtime Exposes ownership and dependency information while a protocol-owned composer combines one contribution.
ProjectSettingContributionSource Runtime Identifies where one setting contribution originated.
ProjectSettingContribution<TContribution> Runtime Provides one decoded contribution and its immutable composition context.
ProjectSettingDefinitionAttribute Runtime Declares a reloadable settings type under one stable protocol identity.
ProjectSettingId Runtime Identifies one host-neutral project setting protocol.
Settings Runtime Provides script-facing project settings queries through the current runtime execution context.