Component · world

StreamedWorld

Streams a .world's cells into play around the players (ara-runtime-world). Put it on one entity of the level scene; the cell documents stay out of the projection and arrive at tick boundaries. With a Terrain, navigation then follows the resident TerrainChunks.

Fields

world

option<asset<world>>

The world manifest (.world document).

default null

Usage

Every edit is an undoable command: from the CLI as below, or the same JSON from an agent over MCP. See component.add and property.set.

Add it

ara do component.add -p entity=name:Crate -p component=StreamedWorld --why "Add StreamedWorld"

Set a field

ara do property.set -p entity=name:Crate -p path=StreamedWorld.world -p value=null --why "Tune StreamedWorld"

In a scene document

{
  "StreamedWorld": {
    "world": null
  }
}

From C#

/// <summary>Select a streamed world for an expedition.</summary>
public static void UseStreamedWorld(Entity entity, in Tick tick)
{
    ref var component = ref World.Get<StreamedWorld>(entity);
    component.World = "@levels/island.world#wo_island";
}

From C#

Scripts read and write it with Get<StreamedWorld>(); see the StreamedWorld struct.