GetColPolygonHeight

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

This function is used to get the height of an existing colshape polygon. By default, a colshape polygon is infinitely tall.

Syntax

float, float getColPolygonHeight ( colshape shape )  

OOP Syntax Help! I don't understand this!

Method: colshape:getHeight(...)


Required Arguments

Returns

Returns two floats, indicating the floor and ceiling of the colshape height, false if invalid arguments were passed.

Example

Click to collapse [-]
Server

This example creates a polygon colshape and show height of it with command 'getpolyheight'.

 -- Creates polygon colshape at 0, 0, 4
 local colPoly = createColPolygon ( -1.08, -0.05, 2.92, -0.05, -1.08, -4.05, -5.08, -0.05, -1.08, 3.95 )
 -- Set its height to 4 unit
 setColPolygonHeight ( colPoly, 2.32, 7.12 )
 
 function showPolyHeight ( player, command )
     -- Get element position
     local x, y = getElementPosition ( colPoly )
     -- Get table floor and ceil of the colshape height and unpack it
     local z, z1 = unpack ( getColPolygonHeight ( colPoly ) )
     local heights = z1 - z
     -- Output it in his chatbox
     outputChatBox( "The Polygon Colshape at "..x..", "..y.." height is "..heights, player, 255, 255, 0)
 end
 addCommandHandler ( "getpolyheight", showPolyHeight )

Requirements

Minimum server version 1.5.8-9.20807
Minimum client version 1.5.8-9.20807

Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version server="1.5.8-9.20807" client="1.5.8-9.20807" />

See Also