Pair: removeColPolygonPoint

This function is used to add a new point to an existing colshape polygon.

OOP Syntax Help! I don't understand this!

• Method:colshape:addPoint(...)

Syntax

bool addColPolygonPoint ( colshape shape, float fX, float fY, [ int index = 0 ] )

Required Arguments

• shape: The colshape polygon you wish add a point to.
• fX: The X position of the new bound point.
• fY: The Y position of the new bound point.

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use.

• index (default: 0): The index where the new point will be inserted in the polygon. The points are indexed in order, with 1 being the first bound point. Passing 0 will insert the point as the last one in the polygon.

Returns

• bool: result

Returns true if the polygon was changed, false if invalid arguments were passed.

Code Examples

Example 1 Example 2 (OOP)

server

This examples adds a point to an existing polygon shape by a command.

local shape = createColPolygon(2, 2, 5, 5, 6, 6, 8, 8) -- Somewhere in the map
function addPointToPolygon(plr, cmd, fX, fY, index)
    if (not fX or not fY) then
        outputChatBox("Correct syntax: /addpoint <fX fY>", plr, 255, 25, 25)
        return false
    end
    if (not index or index == 0) then
        addColPolygonPoint(shape, fX, fY)
    else
        addColPolygonPoint(shape, fX, fY, index)
    end
    outputChatBox("Point added", plr, 0, 255, 0)
end
addCommandHandler("addpoint", addPointToPolygon)

server

OOP Required

This examples adds a point to an existing polygon shape by a command.

local shape = ColShape.Polygon(2, 2, 5, 5, 6, 6, 8, 8) -- Somewhere in the map
function addPointToPolygon(plr, cmd, fX, fY, index)
    if (not fX or not fY) then
        plr:outputChat("Correct syntax: /addpoint <fX fY>", 255, 25, 25)
        return false
    end
    if (not index or index == 0) then
        shape:addPoint(fX, fY)
    else
        shape:addPoint(fX, fY, index)
    end
    plr:outputChat("Point added", 0, 255, 0)
end
addCommandHandler("addpoint", addPointToPolygon)

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