Skip to main content

Module settings

Module settings 

Source
Expand description

The neutral settings carrier.

A typed, non-serde tree for custom-game-settings blocks shared by validation and emission. The tree is a carrier: settings are carried and emitted, never interpreted by lowering/analysis. Source-backed path and display data remain implementation details behind this module’s APIs.

Extracted from the Wright-authored wright-ir crate; see docs/provenance.md.

Structs§

EffectiveNumber
An authored numeric value paired with its Workshop-effective value.
NumericBounds
Source-backed effective numeric bounds. None means the current reviewed source does not establish that bound.
SettingDefinition
One canonical semantic definition projected from an existing table entry.
SettingEnumMember
One accepted spelling of a setting enum member.
SettingId
A locale-independent Workshop setting concept identity.
SettingOccurrence
A typed occurrence together with a source-backed effective numeric value.
SettingPresentation
Locale-facing names associated with a canonical setting concept.
SettingSource
Source metadata shared by the reviewed table projection.
SettingSourceEdit
One checked replacement in the original Workshop source text.
Settings
A settings block: settings { ... } with its typed children.
SettingsListElement
One element of a settings list (corpus lists are all strings).
TeamId
An open team identity used by hero settings structure.

Enums§

Applicability
The result of asking whether a definition applies to a target.
NumericBoundsError
PathPart
A segment of a path accepted by settings schema lookups.
SettingIdentity
Whether a definition has a reviewed canonical concept identity.
SettingOperationError
Failure from a typed settings query or source-preserving edit.
SettingScope
The Workshop-native section that owns a setting.
SettingSourceKind
SettingTarget
The semantic entity to which a setting applies.
SettingTargetKind
The target shape described by a definition. Concrete identities are supplied separately when applicability is queried.
SettingValue
A typed authored value in the settings carrier.
SettingValueDomain
The machine-readable value domain of a setting.
SettingsNode
One member of a settings group.

Functions§

check_emission
Check that emission accepts settings, returning one error per offending member. Each error carries the node’s recorded source span when present.
definition
Project one reviewed table entry into the canonical semantic definition.
definitions
Project all currently reviewed table entries into the canonical semantic catalog. The table remains the single parser/emitter source; this projection supplies the stable semantic identity and typed facts consumed by callers.
definitions_by_id
Find all definitions for a canonical concept identity.
validate_catalog
Validate the effective settings catalog and reject stale or conflicting semantic projections before parser/emitter data is shipped.