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.}} =...")
 
No edit summary
(2 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 20: Line 20:
TODO
TODO
</syntaxhighlight>
</syntaxhighlight>
==Requirements==
{{Requirements|1.5.7-9.20397|1.5.7-9.20397|}}


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

Revision as of 14:09, 25 October 2020

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

TODO

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