Query#

Method in IFlowProvider

Query(int, float, Vector3[], Vector3[])#

Query water flow data (horizontal motion) at a set of points.

Declaration#

int Query(int hash, float minimumLength, Vector3[] points, Vector3[] results)

Parameters#

hash

Unique ID for calling code. Typically acquired by calling GetHashCode.

minimumLength

The minimum spatial length of the object, such as the width of a boat. Useful for filtering out detail when not needed. Set to zero to get full available detail.

points

The world space points that will be queried.

results

Water surface flow velocities at the query positions.

Return#

The status of the query.