Query#
Query(int, float, Vector3[], float[], Vector3[], Vector3[], CollisionLayer)#
Query water physical data at a set of points. Pass in null to any out parameters that are not required.
Declaration#
int Query(int hash, float minimumLength, Vector3[] points, float[] heights, Vector3[] normals, Vector3[] velocities, CollisionLayer layer = CollisionLayer.Everything)
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. |
heights |
Resulting heights (displacement Y + sea level) at the query positions. Pass null if this information is not required. |
normals |
Resulting normals at the query positions. Pass null if this information is not required. |
velocities |
Resulting velocities at the query positions. Pass null if this information is not required. |
layer |
The layer this query targets. |
Return#
The status of the query.
Query(int, float, Vector3[], Vector3[], Vector3[], Vector3[], CollisionLayer)#
Query water physical data at a set of points. Pass in null to any out parameters that are not required.
Declaration#
int Query(int hash, float minimumLength, Vector3[] points, Vector3[] displacements, Vector3[] normals, Vector3[] velocities, CollisionLayer layer = CollisionLayer.Everything)
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. |
displacements |
Resulting displacement vectors at the query positions. Add sea level to Y to get world space height. |
normals |
Resulting normals at the query positions. Pass null if this information is not required. |
velocities |
Resulting velocities at the query positions. Pass null if this information is not required. |
layer |
The layer this query targets. |
Return#
The status of the query.