removeColPolygonPoint | Multi Theft Auto: Wiki Skip to content

removeColPolygonPoint

Client-side
Server-side
Shared

Pair: addColPolygonPoint

This function is used to remove a point from an existing colshape polygon.

OOP Syntax Help! I don't understand this!

Syntax

bool removeColPolygonPoint ( colshape shape, int index )
Required Arguments
  • shape: The colshape polygon you wish to remove a point from.
  • index: The index of the point you wish to remove. The points are indexed in order, with 1 being the first bound point. You can't remove the last 3 points.

Returns

  • bool: result

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

Code Examples

server

This example remove a polygon colshape point by command removepoint.

-- Creates polygon colshape at 0, 0, 4
local shape = createColPolygon(-1.08, -0.05, 2.92, -0.05, -1.08, -4.05, -5.08, -0.05, -1.08, 3.95)
function removePointToPolygon(plr, cmd, index)
if (not index) then
-- if index argument after command is not there
outputChatBox("Correct syntax: /removepoint <index>", plr, 255, 25, 25)
return false
end
-- Convert string to number 'index'
local index = tonumber(index)
-- Get all polygon colshape points
local indexes = #getColPolygonPoints(shape)
if (index > indexes) then
outputChatBox("Index point is greater than last index " .. indexes, plr, 255, 25, 25)
return false
else
-- Remove polygon point at index
removeColPolygonPoint(shape, index)
end
outputChatBox("Point at index " .. index .. " removed", plr, 0, 255, 0)
end
addCommandHandler("removepoint", removePointToPolygon)