SetColPolygonHeight: Difference between revisions
Jump to navigation
Jump to search
(→Syntax) |
Zangomangu (talk | contribs) (Fixed MTA version, example, added more explanation to function and the parameters) |
||
| Line 1: | Line 1: | ||
{{Server client function}} | {{Server client function}} | ||
__NOTOC__ | __NOTOC__ | ||
{{New feature/item|3. | {{New feature/item|3.0160|1.5.8|20807|This function is used to change the height of an existing [[createColPolygon|colshape polygon]]. | ||
By default, a colshape polygon is infinitely tall.}} | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool setColPolygonHeight( colshape shape, float | bool setColPolygonHeight( colshape shape, float floor, float ceil ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[colshape]]:setHeight|}} | {{OOP||[[colshape]]:setHeight|}} | ||
| Line 11: | Line 12: | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''shape:''' The [[colshape]] polygon | *'''shape:''' The [[colshape]] polygon | ||
*''' | *'''floor:''' The polygon floor (lowest Z coordinate). Parse ''false'' to reset this value to 0. | ||
*''' | *'''ceil:''' The polygon ceiling (highest Z coordinate). Parse ''false'' to reset this value to infinitely tall. | ||
===Returns=== | ===Returns=== | ||
| Line 18: | Line 19: | ||
==Example== | ==Example== | ||
{{Needs_Example}} | |||
==Requirements== | ==Requirements== | ||
{{Requirements|1.5. | {{Requirements|1.5.8-9.20807|1.5.8-9.20807|}} | ||
==See Also== | ==See Also== | ||
{{Collision_shape_functions}} | {{Collision_shape_functions}} | ||
Revision as of 21:20, 25 January 2021
This function is used to change the height of an existing colshape polygon. By default, a colshape polygon is infinitely tall.
Syntax
bool setColPolygonHeight( colshape shape, float floor, float ceil )
OOP Syntax Help! I don't understand this!
- Method: colshape:setHeight(...)
Required Arguments
- shape: The colshape polygon
- floor: The polygon floor (lowest Z coordinate). Parse false to reset this value to 0.
- ceil: The polygon ceiling (highest Z coordinate). Parse false to reset this value to infinitely tall.
Returns
Returns true if the polygon was changed, false if invalid arguments were passed.
Example
|
Script Example Missing Function SetColPolygonHeight needs a script example, help out by writing one. |
Before submitting check out Editing Guidelines Script Examples. |
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