RemoveColPolygonPoint: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "{{Server client function}} __NOTOC__ {{New feature/item|3.0158|1.5.7|20397|This function is used to remove a point from an existing colshape polygon.}} =...")
 
 
(3 intermediate revisions by 2 users not shown)
Line 11: Line 11:
===Required Arguments===  
===Required Arguments===  
*'''shape:''' The [[colshape]] polygon you wish to remove a point from.
*'''shape:''' The [[colshape]] polygon you wish to remove a point from.
*'''index:''' The 0-based index of the point you wish to remove. The points are indexed in order, with 0 being the first bound point. You can't remove the last 3 points.
*'''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===
===Returns===
Line 17: Line 17:


==Example==
==Example==
<section name="Server" class="server" show="true">
This example remove a polygon colshape point by command 'removepoint'.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
TODO
-- 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 )
</syntaxhighlight>
</syntaxhighlight>
</section>
==Requirements==
{{Requirements|1.5.7-9.20397|1.5.7-9.20397|}}


==See Also==
==See Also==
{{Collision_shape_functions}}
{{Collision_shape_functions}}

Latest revision as of 04:03, 1 June 2022

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

Syntax

bool removeColPolygonPoint ( colshape shape, int index )  

OOP Syntax Help! I don't understand this!

Method: colshape:removePoint(...)
Counterpart: addColPolygonPoint


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

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

Example

Click to collapse [-]
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 )

Requirements

Minimum server version 1.5.7-9.20397
Minimum client version 1.5.7-9.20397

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.7-9.20397" client="1.5.7-9.20397" />

See Also