Reference · Types
Types
The schema's value types, records, enums and command params. Components have their own listing.
Value types
- AcousticMaterialSurface acoustics for reflection, scattering and transmission.
- AcousticPathAcoustic simulation result. Physics/Steam workers publish this at a frame boundary.
- AcousticsSettingsWorld-wide propagation constants, stored in project/world settings.
- AnimBlendSampleA blend sample with a stable child-node identity.
- AnimConditionOne transition predicate; all conditions on a transition must match.
- AnimControllerCanonical controller source, lowered to an immutable program by Controller.
- AnimJointA joint in parent-before-child order, with stable importer identity. Reflected as AnimJoint (the physics Joint component owns the bare name); documents never name it, so the rename needs no document migration.
- AnimMatrixAn explicitly imported inverse-bind matrix, in column-major order.
- AnimNodeA typed animation graph node. The compiler validates fields for each kind.
- AnimParameterA typed parameter declaration, addressed by its stable map key.
- AnimStateA state selecting a pose graph and its normalized phase clock.
- AnimTransformA local affine transform; rotations use XYZW quaternions.
- AnimTransitionA state transition. Serialized list order defines deterministic priority.
- AtlasCanonical atlas metadata; the immutable pixel payload lives in the asset cache.
- AudioDuckSidechain ducking: another bus's level pulls this bus down (dialogue over music).
- AudioImportSettingsAudio sidecar settings, validated identically by authoring commands and workers.
- ChainDataCanonical chain setup, addressed by stable skeleton joint IDs.
- ClipDataAn editable clip. Cook this once in the asset worker, never on a frame thread.
- CurveAn animation curve addressing the same property path as the inspector.
- FlipbookFrameOne deterministic flipbook frame.
- FootA foot chain and its anatomical sole-up direction.
- FootSettingsGround-contact setup, serialized in the same animation asset as its chains.
- GraphCommentA graph comment, stored only in the editor section.
- GraphEndpointAn addressed socket; port identity is scoped to the node.
- GraphGroupA visual group; membership never changes execution.
- GraphPortA stable named, nominally typed socket. Domains interpret ty.
- IkSetupCanonical procedural rig setup; goal values are fixed-tick gameplay inputs.
- JointLimitAnatomical angular bounds, in radians around a unit bind-local axis.
- JointTrackSparse local transform channels for one joint; empty channels use bind pose.
- L10nFontFaceExplicit font resource; never depends on installed OS fonts.
- L10nProvenanceReproducible origin of a generated translation; no secrets belong here.
- LocomotionClipOne clip of a locomotion blend and the ground speed it represents.
- MatchConfigCook-time feature schema. Feature order is six floats per bone (position/velocity), three root-velocity floats, then six floats per horizon (position/facing).
- MatchNodeGraph-node search settings. The clip field references a cooked motion database.
- MeshSettingsDeterministic geometry cook policy.
- MotorGainsPosition and orientation spring gains in SI units.
- MusicNextA weighted follow-up for horizontal resequencing.
- MusicStemA synchronized layer (stem) of a segment, faded in by intensity.
- MusicTempoA tempo and meter that applies from bar until the next change.
- NotifyA discrete animation notify, identified independently of its display name.
- PaintCellA tile-paint sample in a stroke transaction.
- PhysicalStateComplete future-affecting blend state. Store this in the character's ECS component.
- PostOverrideOne group of settings a post-process volume overrides: pick the group in module, then tick the properties to change. Unticked properties are left to lower-priority volumes and the defaults.
- PrimitiveMaterialOverrideOne native material graph/instance replacing a selected model primitive's material.
- RagdollBoneOne capsule and parent constraint in a canonical powered-ragdoll asset.
- RagdollProfileCanonical body/constraint/motor configuration, cooked at import or spawn boundaries.
- RenderSettingsProject-wide rendering settings, stored under rendering in ara.project.json. A player's --quality flag overrides quality for that run.
- RetargetBone identity and reference pose used by a retargeting tool.
- RigBoneOne semantic bone binding, using a stable importer joint ID.
- RigMapCanonical humanoid definition. Partial rigs are legal; ambiguity is never guessed.
- RotationKeyA unit quaternion key at an exact integer clip time.
- SavePersistDeclarationReflected persistence flag. This extension descriptor references the Schema DB; it does not duplicate fields, defaults, versions or migration implementations.
- ScalarKeyA scalar key for a property curve.
- SkeletonDataAn imported skeleton, ordered for a linear model-space traversal.
- SpriteRegionAtlas rectangle and authoring geometry, in source pixels.
- TerrainCoordInteger X/Z address in a terrain's fixed grid.
- TerrainDabOne brush dab; the stroke command groups all dabs into one transaction.
- TextureSettingsDeclarative texture import settings.
- TileCellA signed source-cell address. Reflected as TileCell (world partition cells own Cell).
- TileDefinitionA tile's visual, terrain, collision and lighting definition.
- TileLayerOne map layer with stable identity, source cells and independent painter order.
- TileRuleFirst matching rule wins. Masks use GridLayout::neighbors bit order; a neighbor "matches" when its tile's definition has the rule's terrain.
- TranslationItemOne provider input; the source fingerprint makes late responses safe to reject.
- TranslationRequestProvider-independent generation job, suitable for a background worker or MCP host.
- TranslationResponseProvider response; no provider SDK or credentials enter the localization crate.
- VectorKeyA vector key at an exact integer clip time.
- VirtualGeometrySettingsOffline cook policy; every value participates in the cache identity.
- VoiceParametersPrepared voice controls. All values must be finite; linear gain is in [0,16].
Records
- AnimAssetA stable authoring record holding imported data or a controller source graph.
- AudioBusOne bus (category) in the mixer tree. AudioSource.bus names it.
- AudioMixerSettingsMixer-wide settings (one record per mixer document).
- AudioMixStateA named mix (combat, explore, menu): per-bus gain offsets reached over fade seconds.
- CellOne grid/layer partition, with a scene plus optional per-entity scene files.
- EntityAn entity in a scene or prefab. Components are stored inline under their type names; a prefab instance stores prefab plus overrides instead.
- FoliageExclusionCircular exclusion zone, applied identically to procedural and manual foliage.
- FoliageHeaderTerrain dependency for a foliage document.
- FoliagePaintOne manual brush gesture, retained for deterministic regeneration and undo.
- FoliageRuleSeeded procedural placement rule, evaluated on workers in global cell space.
- GraphEdgeA directed connection with its own stable document record ID.
- GraphEditorNonsemantic editor state, excluded entirely from semantic_hash.
- GraphHeaderDomain metadata, kept apart from editor state.
- GraphNodeA versioned node; opaque payloads survive unavailable plugins unchanged.
- ImportSettingsDeclarative importer configuration, stored as the single i_settings record.
- L10nLocaleConfigOne locale's configuration, stored as l_config in its localization document.
- L10nStringEntryA mergeable message record; its stable record ID survives translation changes.
- LayerIndependently loaded and visible data layer, such as art, night or quest state.
- MaterialInstanceA saved material instance; all authoritative overrides are document fields.
- MusicSegmentA playable section with synchronized stems on one tempo map.
- MusicSettingsMusic-wide settings (one record).
- MusicStingerA one-shot played on top of the music, aligned to the grid.
- MusicTransitionHow a requested change of segment lands. An empty from matches any segment.
- ProjectImportSettingsDefaults inherited by import sidecars which do not specify a preset.
- ProjectSettingsProject marker represented as a record so project changes share history and undo.
- TerrainHeaderStable terrain grid settings; adjacent tiles duplicate their shared border.
- TerrainLayerA non-destructive layer; order followed by stable ID defines composition.
- TerrainStrokeA complete gesture, retained as source rather than destructive tile snapshots.
- TerrainTileSparse touched-tile delta: a base payload and ordered references to gestures.
- UiSourceLossless UI source; persistence writes native XML through SourceDocument.
- WorldSettingsRoot world settings, kept in the manifest's single w_ record.
Enums
- AnimComparisonA typed parameter comparison.
- AnimNodeKindRuntime pose operation represented by an authoring graph node.
- AnimParameterKindA schema-registered gameplay parameter type.
- AttenuationDistance rolloff model, evaluated in meters.
- AudioEffectCodecCodec for resident sound effects; streamed audio always uses Opus.
- AudioImportUseAudio use selects resident effects or streamed music/dialogue.
- BoneRoleAnatomical roles shared by Mixamo, UE Mannequin and Unity Humanoid rigs.
- ColliderKindPrimitive or cooked geometry selection. Cooked geometry is resolved by the asset worker.
- ColliderKind2dConvex 2D geometry selection; 2D never reuses the 3D shape vocabulary.
- CookPresetEncoding quality is an explicit cook input, independent of the execution budget. New imports default to Balanced; projects and individual textures can select HQ.
- ExposureModeHow the camera exposes the scene (a post-process volume's exposure override).
- FoliageSpeciesVegetation/prop family used by render extraction and impostor selection.
- GraphDirectionDirection relative to the owning node.
- GridLayoutTile coordinate layout; hex is axial and pointy-topped.
- InterpolationInterpolation between consecutive keys.
- JointKindJoint primitive implemented by the backend.
- L10nParamKindParameter types shared by messages, generated bindings and translation jobs.
- L10nSourceKindSource language scanned for localization candidates.
- L10nStatusHuman review state, independent of whether the text can be displayed.
- LightKindHow a light emits.
- LimitKindAngular constraint relative to the local bind rotation.
- LinkKindHow agents traverse an off-mesh link. Animation reads it from NavAgentState.traversal (an intent), never through a call.
- MaterialPresetNamed surface materials with Steam Audio's published values.
- MeshShapeBuilt-in procedural geometry for gray-box levels.
- ModelColliderModeGeometry used by a model-derived collider.
- MotionTypeHow a rigid body moves; kinematic targets are runtime intents.
- MotionType2dHow a rigid body moves; kinematic bodies follow their written pose.
- MusicSyncWhere a transition or stinger may land.
- ObstacleModeHow the navigation reacts to a dynamic obstacle.
- PhysicalModeFixed-tick physical-animation mode.
- PostModuleThe group of settings one PostOverride entry changes.
- QualitySettingRendering quality. auto picks from the GPU: High on ray-tracing GPUs (Medium below 8 GiB of video memory), Low without ray tracing. Epic is never automatic.
- SaveStorageStorage class referenced by a persistence declaration, independent of replication.
- TerrainOperationOperation performed by one recorded brush gesture.
- TextureUsageSemantic texture usage selects transfer functions, mip filtering and BC format.
- ToneMappingThe display transform that compresses scene radiance into the screen's range.
- VolumeShapeWhere a post-process volume applies.
- ZoneShapeReverb zone volume shape.
Command params
- AnimationClipSetParamsReplace animation clip keys.
- AnimationControllerSetParamsReplace an animation controller graph.
- AnimationCreateParamsCreate one animation asset (skeleton, clip, controller or procedural setup).
- AnimationIkSetParamsReplace procedural animation contact chains.
- AnimationMotionDatabaseSetParamsReplace pose-search database configuration.
- AnimationPropertySetParamsEdit one schema-addressed field of an animation record.
- AnimationRagdollSetParamsReplace a physical animation ragdoll profile.
- AnimationRigSetParamsReplace semantic humanoid bone bindings.
- AnimationSkeletonSetParamsReplace animation skeleton source.
- AudioGraphAddParamsAdds an operation node.
- AudioGraphParamParamsEdits a parameter's default, range or documentation.
- AudioGraphRemoveParamsRemoves a node or parameter and every reference to it.
- AudioGraphRenameParamsRenames a parameter or node, keeping its identity, wiring and canvas position.
- AudioGraphSetInputParamsSets one input of a node, or a graph output, to a literal or a reference.
- AudioGraphTextParamsReplaces the graph with edited .audiograph text; surviving names keep their IDs.
- BehaviorRenameParamsRenames a state, variable or query, rewriting every reference.
- BehaviorStateAddParamsAdds an empty state.
- BehaviorStateRemoveParamsRemoves a state, its children and transitions that target them.
- BehaviorTextParamsReplaces the behaviour with DSL text, keeping IDs of surviving names.
- BehaviorTransitionParamsAdds a transition.
- BehaviorVarParamsSets (or clears) a variable's default.
- Camera2dSetParamsComplete typed component authoring update.
- CaptureAudioParamsParameters for the offline capture_audio job, run outside the human's audio engine.
- ColliderFromModelParamsDerive a collider from an imported model or the entity's MeshRenderer selection.
- ComponentAddParamsParameters of component.add.
- ComponentRemoveParamsParameters of component.remove.
- ControlAudioParamsSchema-discoverable audio.control parameters for an existing presentation voice.
- DocCreateParamsParameters of doc.create.
- DocDeleteParamsParameters of doc.delete.
- EntityCreateParamsParameters of entity.create.
- EntityDeleteParamsParameters of entity.delete.
- EntityInspectParamsParameters of entity.inspect.
- EntityReparentParamsParameters of entity.reparent.
- FlipbookSetParamsComplete typed component authoring update.
- FoliageCreateParamsFoliage source terrain.
- FoliageEraseParamsStable record deletion for erasing manual strokes/rules/zones.
- FoliageExcludeParamsExclusion insertion parameters.
- FoliagePaintParamsOne manual brush stroke.
- FoliageRuleParamsRule insertion/replacement parameters.
- ImportConfigureParamsParameters of import.configure.
- ImportInitializeParamsParameters of import.initialize.
- ImportProjectConfigureParamsParameters of import.project.configure; reflected in the inspector and MCP.
- L10nExtractParamsSource-scan request. Sources are supplied by the host; no arbitrary filesystem IO.
- L10nFindMissingParamsSource locale for parity checks against the current batch document.
- L10nPutParamsValidated insertion/replacement params used by machine-applicable fixes.
- L10nRemoveParamsRecord addressed removal of an obsolete localization message.
- Light2dSetParamsComplete typed component authoring update.
- MaterialBudgetParamsSets an explicit material specialization budget.
- MaterialConnectParamsRewires an AST argument or output, preserving the destination edge's identity.
- MaterialGraphParamsApplies an edited graph projection as the same material AST.
- MaterialInstanceClearParamsRemoves a saved override, restoring the definition default.
- MaterialInstanceSetParamsEdits one saved material instance override.
- MaterialLiteralParamsReplaces an expression with a typed constant.
- MaterialOutputParamsIdentifies a domain output field.
- MaterialParameterParamsIdentifies a material parameter.
- MaterialRenameParamsRenames an authored value while retaining its graph identity and layout.
- MaterialTextParamsReplaces the text view, retaining layout for surviving semantic IDs.
- MaterialTypeParamsChanges a node's declared type (also used by type annotation fixes).
- MixerBusSetParamsCreates or replaces a complete mixer category.
- MusicSegmentSetParamsCreate or replace a music segment with stems and tempo map.
- MusicSettingsSetParamsMusic-wide starting segment, intensity, layer fade and deterministic seed.
- MusicStingerSetParamsCreate or replace a grid-aligned music stinger.
- MusicTransitionSetParamsCreate or replace a synchronized music transition.
- OverrideRevertParamsParameters of prefab.override.revert.
- OverrideSetParamsParameters of prefab.override.set.
- Physics2dSetParamsA complete rigid body or character, validated as one unit.
- PlayAudioParamsSchema-discoverable audio.play parameters; protocol resolves asset and entity handles.
- PrefabInstantiateParamsParameters of prefab.instantiate.
- ProjectSetMainParamsParameters of project.setMain.
- PropertySetParamsParameters of property.set.
- SpriteSetParamsComplete typed component authoring update.
- StopAudioParamsSchema-discoverable audio.stop parameters; this stops presentation only.
- TerrainCreateParamsGrid creation parameters for an empty terrain document.
- TerrainImportParamsImports one immutable source tile, preserving subsequent layer edits.
- TerrainLayerParamsA non-destructive layer to insert.
- TerrainLayerSetParamsChange layer settings while retaining its gesture history.
- TerrainStrokeParamsA whole gesture, including every dab; do not issue one transaction per mouse sample.
- TileCollidersParamsTile collider generation request.
- TileEraseParamsAn eraser stroke.
- TileFillParamsBounded flood fill of edge-connected cells matching the seed's tile.
- TilemapSetParamsComplete typed component authoring update.
- TilePaintParamsA stroke of explicitly addressed tile samples.
- TileRuleParamsApplies all terrain rules to a layer in one transaction.
- TransformLookAtParamsParameters of transform.lookAt.
- TransformSetParamsParameters of transform.set.
- TranslateParamsGeneration request and completed provider output, committed as one undoable job.
- UiSourceApplyParamsReplaces a UI document's native markup through revision-checked source ops.
- VfxEnableParamsTurn one module on or off without removing it.
- VfxParameterParamsTyped default parameter mutation.
- VfxStackParamsA structured stack edit; the operation and module are domain-validated.
- VfxTextParamsComplete ID-free source edit, suitable for agents or a text editor.
Document kinds
.animation
ID prefix ac_
Animation skeletons, clips and controller graphs.
.foliage
ID prefix fo_
Seeded scatter rules and manual foliage strokes.
.graph
ID prefix gr_
A domain-typed graph with stable node, edge and socket identities.
.import.json
ID prefix as_
Binary source asset identity and pure importer settings.
.imports
ID prefix ip_
Project texture import defaults, overridden by individual sources/textures.
.l10n
ID prefix lc_
One locale's messages, review provenance and explicit font fallback.
.materialinstance
ID prefix mi_
A material definition reference and cheap per-object parameter overrides.
.mixer
ID prefix mx_
Audio mixer: bus tree, sends, ducking, voice limits, loudness targets and mix states.
.music
ID prefix mu_
Interactive music: segments with stems and tempo maps, transitions, stingers.
.prefab
ID prefix pf_
A reusable entity subtree with exactly one root, instantiated by reference.
.project.json
ID prefix pj_
Project startup and plugin settings; persisted as ara.project.json.
.scene
ID prefix sc_
A level or sub-level: a flat map of entities.
.terrain
ID prefix tr_
Streamable layered heightfield manifest.
.ui
ID prefix ui_
Lossless native UI XML, edited through attributed source operations.
.world
ID prefix wd_
Partitioned world manifest.