Water Body

Supported Object types: 3d. Attach this component where needed. An Object has at most one instance of this component.

Use Object components to understand definitions and instance overrides.

Defaults below are normalized factory values from the component schema. Object presets, dimension, project units, and Scene overrides can supply different starting values. “Not stored” means the path is optional or runtime-derived. Read the property description to interpret it. Blank resource references assign no resource.

Writable means exposed for property writes through Logic. A No entry can still be editable in the Object Editor; runtime-only values cannot be authored. World-space lengths use metres, screen-space lengths use pixels, and rotations use degrees unless stated otherwise. The current loader refuses pixel-era projects. Use Units and Coordinates when comparing values.

Property and path	Type	Factory default	Behavior	Writable
Enabled (enabled)	boolean	true	Whether this water body is active.	No
Area Width (w)	number	0	Area width in metres, from 0 to 100000. 0 spans the world width.	No
Area Depth (d)	number	0	Area depth in metres, from 0 to 100000. 0 spans the world depth.	No
Water Depth (depth)	number	0	Water depth in metres, from 0 to 100000. 0 extends down to the floor.	No
Color (color)	color	“#2f6fbe”	Water color as a three- or six-digit hexadecimal color.	No
Opacity (opacity)	number	0.62	Opacity from 0 to 1.	No
Wave Height (waveHeight)	number	0.25	Wave height in metres, from 0 to 32.	No
Wave Speed (waveSpeed)	number	1	Wave speed multiplier, from 0 to 10.	No
Wave Scale (waveScale)	number	1	Wave scale multiplier, from 0.05 to 20.	No
Flow X (flowX)	number	0	Flow along X, from -64 to 64. Positive and negative values reverse the flow direction.	No
Flow Z (flowZ)	number	0	Flow along Z, from -64 to 64. Positive and negative values reverse the flow direction.	No
Buoyancy (buoyancy)	number	1	Buoyancy multiplier from 0 to 4.	No
Swimming (swim)	boolean	true	Whether the water volume permits swimming behavior.	No