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

OOP Syntax Help! I don't understand this!

• Method:colshape:getHeight(...)

Syntax

float|false,​ float getColPolygonHeight ( colshape shape )

Required Arguments

• shape: The colshape polygon.

Returns

• float|false: floor
• float: ceiling

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

Code Examples

Example 1 Example 2 (OOP)

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
    local z, z1 = 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)

server

OOP Required

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

-- Creates polygon colshape at 0, 0, 4
local colPoly = ColShape.Polygon(-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
colPoly:setHeight(2.32, 7.12)

function showPolyHeight(player, command)
    -- Get element position
    local x, y = colPoly:getPosition()
    -- Get table floor and ceil of the colshape height
    local z, z1 = colPoly:getHeight()
    local heights = z1 - z
    -- Output it in his chatbox
    player:outputChat("The Polygon Colshape at " .. x .. ", " .. y .. " height is " .. heights, 255, 255, 0)
end
addCommandHandler("getpolyheight", showPolyHeight)

See Also

Colshape Functions

• addColPolygonPoint
• createColCircle
• createColCuboid
• createColPolygon
• createColRectangle
• createColSphere
• createColTube
• getColPolygonHeight
• getColPolygonPointPosition
• getColPolygonPoints
• getColShapeRadius
• getColShapeSize
• getColShapeType
• isInsideColShape
• removeColPolygonPoint
• setColPolygonHeight
• setColPolygonPointPosition
• setColShapeRadius
• setColShapeSize

Colshape Events

• onClientColShapeHit
• onClientColShapeLeave
• onColShapeHit
• onColShapeLeave

Reference

• Scripting Functions