GetColPolygonHeight: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(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...")
 
mNo edit summary
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{Server client function}}
{{Server client function}}
__NOTOC__
__NOTOC__
{{New feature/item|3.0160|1.5.8|20807|This function is used to get the height of an existing [[createColPolygon|colshape polygon]].
{{New feature/item|3.0159|1.5.8|20807|This function is used to get the height of an existing [[createColPolygon|colshape polygon]].
By default, a colshape polygon is infinitely tall.}}
By default, a colshape polygon is infinitely tall.}}


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
table getColPolygonHeight ( colshape shape )   
float, float getColPolygonHeight ( colshape shape )   
</syntaxhighlight>  
</syntaxhighlight>  
{{OOP||[[colshape]]:getHeight|}}
{{OOP||[[colshape]]:getHeight|}}
Line 14: Line 14:


===Returns===
===Returns===
Returns a table containing two [[float]]s, indicating the floor and ceiling of the colshape height, ''false'' if invalid arguments were passed.
Returns two [[float]]s, indicating the floor and ceiling of the colshape height, ''false'' if invalid arguments were passed.


==Example==
==Example==

Revision as of 11:19, 11 April 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

Returns

Returns two floats, indicating the floor and ceiling of the colshape height, false if invalid arguments were passed.

Example

Accessories-text-editor.png 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