AddColPolygonPoint

From Multi Theft Auto: Wiki
Revision as of 14:08, 25 October 2020 by StrixG (talk | contribs)
Jump to: navigation, search

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

Syntax

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

OOP Syntax Help! I don't understand this!

Method: colshape:addPoint(...)
Counterpart: removeColPolygonPoint

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. For more information on optional arguments, see optional arguments.

  • index: 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

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

Example

TODO

Requirements

Minimum supported server 1.5.7-9.20397
Minimum supported client 1.5.7-9.20397

Note: Using this function/event 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

BETA: FROM VERSION 1.5.8 r20807 ONWARDS
BETA: FROM VERSION 1.5.8 r20807 ONWARDS