GetWaterVertexPosition: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Added oop syntax)
No edit summary
(2 intermediate revisions by 2 users not shown)
Line 8: Line 8:
<syntaxhighlight lang="lua">int int float getWaterVertexPosition ( water theWater, int vertexIndex )</syntaxhighlight>
<syntaxhighlight lang="lua">int int float getWaterVertexPosition ( water theWater, int vertexIndex )</syntaxhighlight>


{{OOP||[[water]]:getVertexPosition|vertexPosition|setWaterVertexPosition}}
{{OOP||[[water]]:getVertexPosition||setWaterVertexPosition}}


===Required Arguments===
===Required Arguments===
Line 19: Line 19:
==Example==
==Example==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--TODO
function water()
local water = createWater(1866, -1444, 10, 1968, -1442, 10, 1866, -1372, 10, 1968, -1370, 10); -- create water element
local x, y, z = getWaterVertexPosition(water, 1); -- get first vertex position of our water element
outputChatBox("Water first vertex position X: "..x.." Y: "..y.." Z: "..z);
end
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{Water functions}}
{{Water functions}}

Revision as of 20:53, 14 February 2020

Accessories-text-editor.png 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 )


OOP Syntax Help! I don't understand this!

Method: water:getVertexPosition(...)
Counterpart: setWaterVertexPosition


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

function water()
	local water = createWater(1866, -1444, 10, 1968, -1442, 10, 1866, -1372, 10, 1968, -1370, 10); -- create water element
	
	local x, y, z = getWaterVertexPosition(water, 1); -- get first vertex position of our water element
	
	outputChatBox("Water first vertex position X: "..x.." Y: "..y.." Z: "..z);
end

See Also