GetWaterVertexPosition: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Needs example) |
||
| Line 13: | Line 13: | ||
===Returns=== | ===Returns=== | ||
Returns the x, y and z coordinates of the specified vertex if successful, ''false'' otherwise. | Returns the x, y and z coordinates of the specified vertex if successful, ''false'' otherwise. | ||
==Example== | |||
<syntaxhighlight lang="lua"> | |||
--TODO | |||
</syntaxhighlight> | |||
==See Also== | ==See Also== | ||
{{Water functions}} | {{Water functions}} | ||
[[Category:Needs Example]] | |||
Revision as of 08:10, 19 June 2009
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
float float 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