GetColPolygonPointPosition: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (1-based index)
m (Return values fixed in r20621)
 
(4 intermediate revisions by 2 users not shown)
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool getColPolygonPointPosition ( colshape shape, int index )   
float, float getColPolygonPointPosition ( colshape shape, int index )   
</syntaxhighlight>  
</syntaxhighlight>  
{{OOP||[[colshape]]:getPointPosition||setColPolygonPointPosition|}}
{{OOP||[[colshape]]:getPointPosition||setColPolygonPointPosition|}}
Line 14: Line 14:


===Returns===
===Returns===
Returns a [[Vector2]] containing the position, ''false'' if invalid arguments were passed.
Returns two [[float]]s, x and y, indicating the position of the point, ''false'' if invalid arguments were passed.


==Example==
==Example==
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}}

Latest revision as of 21:28, 25 January 2021

This function is used to get the position of a bound point in a colshape polygon.

Syntax

float, float getColPolygonPointPosition ( colshape shape, int index )  

OOP Syntax Help! I don't understand this!

Method: colshape:getPointPosition(...)
Counterpart: setColPolygonPointPosition


Required Arguments

  • shape: The colshape polygon you wish to change.
  • index: The index of the point you wish to retrieve. The points are indexed in order, with 1 being the first bound point.

Returns

Returns two floats, x and y, indicating the position of the point, 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