SetColPolygonHeight

From Multi Theft Auto: Wiki
Revision as of 21:20, 25 January 2021 by Zangomangu (talk | contribs) (Fixed MTA version, example, added more explanation to function and the parameters)
Jump to navigation Jump to search

BETA: FROM VERSION 1.5.8 r20807 ONWARDS
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

Accessories-text-editor.png Script Example Missing Function SetColPolygonHeight needs a script example, help out by writing one.

Before submitting check out Editing Guidelines Script Examples.


Requirements

Minimum supported server 1.5.8-9.20807
Minimum supported client 1.5.8-9.20807

Note: Using this function/event 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

BETA: FROM VERSION 1.5.8 r20807 ONWARDS
BETA: FROM VERSION 1.5.8 r20807 ONWARDS