AuraJS Reference Docs

Use this page when exact signatures, validation behavior, or schema-level detail matter more than tutorial flow.

Table of Contents

1. Exact-Reference Families
2. Generated Contract Method Index
3. Narrower Split Routes
4. Canonical Contracts
5. Reading Order

• For the public docs entrypoint, start at ../../README.md.
• For the public handbook path, start at ../external/README.md.
• For the public first page, start at ../external/game-dev-api/start-here.md.

Exact-Reference Families

Use one of these pages before opening a monolithic contract:

• ./runtime-and-2d-exact-reference.md
• ./gameplay-systems-exact-reference.md
• ./3d-rendering-and-content-exact-reference.md
• ./world-simulation-and-multiplayer-exact-reference.md

Generated Contract Method Index

Use this when you want the exhaustive generated list of public contract namespaces, exact signatures, and known method names without searching through the monolithic contracts manually:

• ./contract-method-index.md

Narrower Split Routes

Use these when you already know the subsystem and want to avoid searching a large family page or large contract:

• ./lifecycle-window-input-and-2d-camera-exact-reference.md
• ./draw2d-assets-audio-storage-and-math-exact-reference.md
• ./animation-scenes-state-tilemaps-and-ecs-exact-reference.md
• ./draw3d-camera-lighting-and-postfx-exact-reference.md
• ./scene3d-mesh-material-gltf-and-avatar-exact-reference.md
• ./physics3d-terrain-navmesh-character3d-and-compute-exact-reference.md
• ./net-multiplayer-and-runtime-sessions-exact-reference.md

Canonical Contracts

These files define frozen or contract-style behavior and should be preferred over narrative guides when exact semantics matter:

• ../api-contract.md
• ../api-contract-3d.md
• ../game-state-cli-contract-v1.md
• ../video-cutscene-contract-v1.md
• ../native-mp4-video-contract-v1.md
• ../native-media-presentation-contract-v1.md

Reading Order

1. Start with the matching exact-reference family page above.
2. Use the generated contract method index when you need an exhaustive scan of callable public surfaces.
3. If you already know the subsystem, move to the matching narrower split route.
4. Use the contract docs when exact names, shapes, or validation behavior matter.
5. Fall back to the public handbook for narrative walkthroughs and grouped routing.