xrwise-datastructure/objects/Area.md

Area

Type

pre-defined

3D

The Area Collider is an editor-only helper zone, not a runtime-visible object. In the Creator it renders as a flat plane that glows orange so its footprint is visible while editing; it has no representation in Unity/the published room. Its footprint is scale.x x scale.z (default 10 x 10); scale.y is fixed at a thin 0.1 and not editable.

Custom Args:

Key	Type	Implemented	Description
color	hexColor	❌	Serialized (spawn default #ffffff) but not user-editable and not used for rendering — the area is always shown with the fixed orange glow
grabable	"true" | "false"	✔️	Whether the item can be grabbed in-experience (inherited from the shared item args; not meaningful since the area has no runtime presence)
locked	"true" | "false"	✔️	Whether the item is locked against moving/deleting in the Creator

Special Notes:

• Category Logic in the Creator sidebar — helper items that mark trigger zones for Block Coding rather than decorating the room.
• Hidden in the editor canvas via the "Areas" Canvas Toggle (showAreas in the scene store) without affecting the saved data.
• Referenced by the Block Coding "in_area" trigger event (SceneTriggerBlock.sourceItemId) — see data-structure-block-coding.md.

Example:

{
  "position": { "x": 0.0, "y": 0.0, "z": 0.0 },
  "rotation": { "x": 0.0, "y": 0.0, "z": 0.0 },
  "scale":    { "x": 10.0, "y": 0.1, "z": 10.0 },
  "type": "pre-defined",
  "resourcename": "Area",
  "item-custom-args": [
    { "argument": "color", "value": "#ffffff" }
  ],
  "item-custom-args-adv": null
}