GetColPolygonPointPosition: Difference between revisions
Jump to navigation
Jump to search
Zangomangu (talk | contribs) (Created page with "{{Server client function}} __NOTOC__ {{New feature/item|3.0158|1.5.7|20397|This function is used to get the position of a bound point in a [[createColPolygon|colshape polygon]...") |
Zangomangu (talk | contribs) m (Return values fixed in r20621) |
||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 5: | Line 5: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
float, float getColPolygonPointPosition ( colshape shape, int index ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[colshape]]:getPointPosition||setColPolygonPointPosition|}} | {{OOP||[[colshape]]:getPointPosition||setColPolygonPointPosition|}} | ||
| Line 11: | Line 11: | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''shape:''' The [[colshape]] polygon you wish to change. | *'''shape:''' The [[colshape]] polygon you wish to change. | ||
*'''index:''' The | *'''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=== | ||
Returns two | 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}} | ||
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
This template will be deleted.
See Also
- addColPolygonPoint
- createColCircle
- createColCuboid
- createColPolygon
- createColRectangle
- createColSphere
- createColTube
- getColPolygonHeight
- getColPolygonPoints
- getColPolygonPointPosition
- getColShapeType
- getColShapeRadius
- getColShapeSize
- getElementColShape
- getElementsWithinColShape
- isElementWithinColShape
- isInsideColShape
- removeColPolygonPoint
- setColPolygonHeight
- setColPolygonPointPosition
- setColShapeRadius
- setColShapeSize