GetWaterVertexPosition: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server client function}} | {{Server client function}} | ||
{{Needs_Example}} | |||
Gets the world position of a vertex (i.e. corner) of a [[water]] area. Each water area is either a triangle or quad (rectangle) so each has 3 or 4 corners. | Gets the world position of a vertex (i.e. corner) of a [[water]] area. Each water area is either a triangle or quad (rectangle) so each has 3 or 4 corners. | ||
| Line 21: | Line 22: | ||
==See Also== | ==See Also== | ||
{{Water functions}} | {{Water functions}} | ||
Revision as of 12:35, 2 January 2014
|
Script Example Missing Function GetWaterVertexPosition needs a script example, help out by writing one. |
Before submitting check out Editing Guidelines Script Examples. |
Gets the world position of a vertex (i.e. corner) of a water area. Each water area is either a triangle or quad (rectangle) so each has 3 or 4 corners.
Syntax
int int float getWaterVertexPosition ( water theWater, int vertexIndex )
Required Arguments
- theWater: the water element to get the vertex of
- vertexIndex: the index of the vertex whose position to get. Values range from 1 to 4 for a water quad, or 1 to 3 for a triangle.
Returns
Returns the x, y and z coordinates of the specified vertex if successful, false otherwise.
Example
--TODO
See Also
- createWater
- getWaterColor
- getWaterVertexPosition
- getWaveHeight
- resetWaterColor
- resetWaterLevel
- setWaterColor
- setWaterLevel
- setWaterVertexPosition
- setWaveHeight