FluidContact

record in OpalScript

Immutable snapshot from a FluidProbe2D entered, exited or splash event.

Properties

Member	Description
FluidContact.DomainId	The fluid domain's scene object ID.
FluidContact.X	Sample world X in pixels.
FluidContact.Y	Sample world Y in pixels.
FluidContact.Coverage	Approximate local kernel occupancy, 0 to 1.
FluidContact.VelocityX	Weighted water velocity X in pixels per second.
FluidContact.VelocityY	Weighted water velocity Y in pixels per second.
FluidContact.Speed	Water speed in pixels per second.
FluidContact.RelativeSpeed	Probe movement relative to local water, in pixels per second.
FluidContact.Wet	Whether the probe is wet after applying its entry and exit thresholds.

See also

• FluidProbe2D
• Scripts
• Scripting API