GetColShapeSize: 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 size of a colshape. Valid types are [[createColRectangle|rectangle]...") |
No edit summary |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 5: | Line 5: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
float, float, float getColShapeSize ( colshape shape ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[colshape]]:getSize||setColShapeSize|}} | {{OOP||[[colshape]]:getSize||setColShapeSize|}} | ||
| Line 22: | Line 22: | ||
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 14:09, 25 October 2020
This function is used to get the size of a colshape. Valid types are rectangle, cuboid and tube.
Syntax
float, float, float getColShapeSize ( colshape shape )
OOP Syntax Help! I don't understand this!
- Method: colshape:getSize(...)
- Counterpart: setColShapeSize
Required Arguments
- shape: The colshape you wish to get the size of.
Returns
Returns up to 3 floats depending on the colshape type (see below), false if invalid arguments were passed.
- cuboid: width, depth, height.
- rectangle: width, height.
- tube: height.
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
- addColPolygonPoint
- createColCircle
- createColCuboid
- createColPolygon
- createColRectangle
- createColSphere
- createColTube
- getColPolygonHeight
- getColPolygonPoints
- getColPolygonPointPosition
- getColShapeType
- getColShapeRadius
- getColShapeSize
- getElementColShape
- getElementsWithinColShape
- isElementWithinColShape
- isInsideColShape
- removeColPolygonPoint
- setColPolygonHeight
- setColPolygonPointPosition
- setColShapeRadius
- setColShapeSize