Agents Scripting Benchmarks Docs

Search or run a command

Jump to a section or open an Ara link.

Manual

Start

Introduction Install Your first project Connect an agent

Concepts

Projects Documents and IDs Entities and components Commands and transactions Review and undo Diagnostics Merging

Scripting

C# scripting Behaviours Lifecycle and determinism Components and resources Properties and attributes World and entities Systems and queries Script commands Hot reload NativeAOT builds Script diagnostics

Agents

MCP server Sessions and scopes

Scripting API

Classes10

Animation Behaviour EngineComponents Input Log MissingComponentException Movement Navigation Units World

Structs74

AcousticMaterial AcousticPortal AcousticSource AcousticSurface Animator AudioGraphSource AudioListener AudioSource Brain Camera Camera2d CharacterController CharacterController2d CharacterInput CharacterInput2d CharacterMotion CharacterMotion2d Collider Collider2d Color CommandContext CommandResult Commands Entity Environment Flipbook FlipbookFrame FollowCamera Frame HeightFog Joint Light Light2d LocomotionClip MeshRenderer MusicSource NavAgent NavAgentType NavArea NavLink NavMeshSurface NavObstacle Perceiver PhysicsId PhysicsPose PhysicsPose2d PlayerControl PostOverride PostProcessVolume PrimitiveMaterialOverride ReverbZone RigidBody RigidBody2d Rng SkyAtmosphere Sprite Stimulus StreamedWorld Terrain TerrainChunk Tick TileColliderSource2d TileDefinition TileLayer TileRule Tilemap Transform Vehicle VehicleInput VehicleTelemetry Velocity Velocity2d VisualEffect Wanderer

Interfaces3

IComponent<TSelf>ICue<TSelf>IResource<TSelf>

Attributes23

ColorPickerAttribute CommandAttribute ComponentAttribute CueAttribute DefaultAttribute EngineComponentAttribute ExampleAttribute ExposeAttribute FormerlySerializedAsAttribute HeaderAttribute MaxAttribute MinAttribute PropertyAttribute QueryAttribute RangeAttribute ReplicateAttribute ResourceAttribute SimulationAttribute TooltipAttribute TransientAttribute UnitAttribute WithAttribute<T>WithoutAttribute<T>

Enums21

Attenuation Audience Caller ColliderKind ColliderKind2d ExecuteOn ExposureMode GridLayout Interpolate JointKind LightKind LinkKind MaterialPreset MeshShape MotionType MotionType2d ObstacleMode PostModule ToneMapping VolumeShape ZoneShape

Reference

Components Types Commands Protocol methods Diagnostic codes CLI Conventions Session scopes

Record · audio

MusicSettings

Music-wide settings (one record).

Record IDs start with ms_

Fields

initial

string

Segment to start with.

default ""

intensity

f32

Starting intensity 0..1.

default 0.50 – 1

layerFade

f32

Seconds for layers to follow an intensity change.

default 1s0 – 30

seed

u32

Seed for weighted follow-ups (deterministic resequencing).

default 0

Used by

MusicSettingsSetParams music.settings.set

On this page

Fields
Used by

Ara

An AI-native game engine in Rust. AI agents build it; agents and humans make games with it.

Docs

Manual
Scripting API
Engine reference

Get Ara

Download Ara Hub
Release notes
All releases

Engine

GitHub
Known issues
Decisions
Milestones

Ara

ara 0.0.2-alpha.3Windows · Vulkan 1.3C# 14 / .NET 10Sponza by Frank Meinl, Crytek (CC BY 3.0) · © 2026 Ara Engine