Stable identity for this component, unique within a session. Auto-generated for runtime-created components; the editor overwrites it with a persistent id when projecting a saved document so references survive save / load / undo.
Whether this component participates in simulation and rendering. When false,
the GameObject skips its update/updateRender and the scene's
render collectors (mesh renderers, camera, lights, …) ignore it — the
component stays attached and keeps its state, like Unity's Behaviour.enabled
/ Renderer.enabled. Defaults to true.
The owning GameObject; assigned by addComponent before onAttach runs.
True between onAttach and onDetach — i.e. while this component sits on a GameObject that is part of a live Scene. Managed by GameObject. Internal — do not set directly.
Side length (m) of the seabed depth-cache rect, centered on the GameObject. Sized to cover the whole body plus its rivers.
Depth-cache texture resolution. Narrow river channels need texels smaller than the channel width to survive the cache-driven shoreline.
Keep-clip disc radius (m) bounding the body — outside it the surface is clipped away (a valley lake mustn't flood the horizon). 0 = unbounded.
Clip-disc edge feather (m); hide it inside terrain above the water.
Wind speed (m/s) driving the ripple spectrum.
Wind direction in degrees (0 = +X, counter-clockwise).
Ripple displacement strength.
Horizontal wave chop.
Scatter colour at normal incidence.
Scatter colour at grazing angles.
Scatter colour over shallow beds.
Water depth (m) at which the shallow colour fades out.
Through-water fog density per channel.
Sky-reflection intensity.
Surface alpha ramps 0→1 over this water column (m); 0 disables. The stable, cache-driven waterline (depth-buffer tests flicker at range).
Hard shoreline cut below this water column (m); 0 disables.
Wave-foam sim strength; 0 = foam fully off (calm inland water never breaks).
Authored river/stream splines ([x, surfaceY, z] center-lines, source → mouth). No generic inspector rows yet — edited via doc/MCP, like terrain layers.
The simulation clock of the scene this component belongs to. Read inside
update (or any time after the GameObject is added to a scene) for
absolute time, frame count, FPS, and timeScale-aware delta — e.g.
this.time.elapsed, this.time.delta, this.time.frameCount.
this.time.delta equals the dt argument passed to update, so
components can ignore that argument entirely and pull everything from here.
Connect to a Signal with automatic disconnect when this component is removed from its GameObject — the safe default for cross-object listening, so a destroyed component never leaks into (or gets called by) a signal it once observed. Typically called from onAttach:
onAttach(): void {
const health = this.gameObject.getComponent(Health)!;
this.listen(health.died, () => this.playDeathEffect());
}
The signal to connect to.
Listener, forwarded to Signal.connect.
Optionalopts: SignalConnectOptionsSee SignalConnectOptions.
The unsubscribe function, for listeners that also want to disconnect early; calling it is optional and idempotent.
Disconnect every signal connection made through listen. Called by GameObject.removeComponent after onDetach (so it runs even when a subclass overrides onDetach without calling super). Internal — do not call directly.
Called when the component joins a live scene — from addComponent when the
GameObject is already in a scene, otherwise when the GameObject is added to
one. this.gameObject.scene (and scene.engine) is always set here.
Override to acquire references to siblings/children or initialize resources.
Called when the component leaves the scene — removed via GameObject.removeComponent, or its GameObject removed from the scene. Override to release resources or unsubscribe from events.
Called every frame by the GameObject's update traversal.
Frame delta time in seconds.
Called when this component's GameObject begins touching another body, with the GameObject it collided with. Dispatched by the physics system after each world step (only while playing), so handlers may freely mutate the scene. Requires a physics body (RigidBody / CharacterBody) on the object.
The other GameObject involved in the contact.
Called every frame by the GameObject's render traversal, after update and any input/controller mutations to the transform. Override to refresh per-frame state that render passes consume (e.g. Camera recomputes its cached view/projection matrices here).
Active render context (provides canvas width/height etc.).
A finite water body on a terrain. Defaults are calm freshwater (greener scatter, visible shallow beds, foam off).