GetColPolygonHeight: Difference between revisions
Jump to navigation
Jump to search
Zangomangu (talk | contribs) (Created page with "{{Server client function}} __NOTOC__ {{New feature/item|3.0160|1.5.8|20807|This function is used to get the height of an existing colshape polygon. By def...") |
Zangomangu (talk | contribs) (Return values fixed in r20828) |
||
| Line 6: | Line 6: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
float, float getColPolygonHeight ( colshape shape ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[colshape]]:getHeight|}} | {{OOP||[[colshape]]:getHeight|}} | ||
| Line 14: | Line 14: | ||
===Returns=== | ===Returns=== | ||
Returns | Returns two [[float]]s, indicating the floor and ceiling of the colshape height, ''false'' if invalid arguments were passed. | ||
==Example== | ==Example== | ||
Revision as of 17:45, 8 February 2021
This function is used to get the height of an existing colshape polygon. By default, a colshape polygon is infinitely tall.
Syntax
float, float getColPolygonHeight ( colshape shape )
OOP Syntax Help! I don't understand this!
- Method: colshape:getHeight(...)
Required Arguments
- shape: The colshape polygon
Returns
Returns two floats, indicating the floor and ceiling of the colshape height, false if invalid arguments were passed.
Example
|
Script Example Missing Function GetColPolygonHeight needs a script example, help out by writing one. |
Before submitting check out Editing Guidelines Script Examples. |
Requirements
| Minimum server version | 1.5.8-9.20807 |
|---|---|
| Minimum client version | 1.5.8-9.20807 |
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.8-9.20807" client="1.5.8-9.20807" />
See Also
- addColPolygonPoint
- createColCircle
- createColCuboid
- createColPolygon
- createColRectangle
- createColSphere
- createColTube
- getColPolygonHeight
- getColPolygonPoints
- getColPolygonPointPosition
- getColShapeType
- getColShapeRadius
- getColShapeSize
- getElementColShape
- getElementsWithinColShape
- isElementWithinColShape
- isInsideColShape
- removeColPolygonPoint
- setColPolygonHeight
- setColPolygonPointPosition
- setColShapeRadius
- setColShapeSize