SetColPolygonHeight: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(4 intermediate revisions by 4 users 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 change the height of an existing [[createColPolygon|colshape polygon]].
{{Added feature/item|1.5.9|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.}}
By default, a colshape polygon is infinitely tall.}}


Line 11: Line 11:


===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.
*'''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.
*'''ceil:''' The polygon ceiling (highest Z coordinate). Parse ''false'' to reset this value to infinitely tall.
Line 20: Line 20:
==Example==
==Example==
This example sets every polygon colshape's max heigh to 50 units once resource starts.
This example sets every polygon colshape's max heigh to 50 units once resource starts.
<section name="Server side script" class="server" show="true">
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function setPolygonsHeight()
function setPolygonsHeight ()
     for i, v in ipairs(getElementsByType("colshape")) do
     for i, v in ipairs (getElementsByType ("colshape")) do
         if (getColShapeType(v) == 4) then -- if it's a polygon colshape do it otherwise don't
         if (getColShapeType (v) == 4) then -- if it's a polygon colshape do it otherwise don't
             setColPolygonHeight(v, false, 50)
             setColPolygonHeight (v, false, 50)
         end
         end
     end
     end
end
end
addEventHandler("onResourceStart", resourceRoot, setPolygonsHeight)
addEventHandler ("onResourceStart", resourceRoot, setPolygonsHeight)
</syntaxhighlight>
</syntaxhighlight>
</section>
</section>

Latest revision as of 21:34, 23 September 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

This example sets every polygon colshape's max heigh to 50 units once resource starts.

Click to collapse [-]
Server
function setPolygonsHeight ()
    for i, v in ipairs (getElementsByType ("colshape")) do
        if (getColShapeType (v) == 4) then -- if it's a polygon colshape do it otherwise don't
            setColPolygonHeight (v, false, 50)
        end
    end
end
addEventHandler ("onResourceStart", resourceRoot, setPolygonsHeight)

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