Multi Theft Auto: Wiki - User contributions [en]

RemoveColPolygonPoint

2022-06-01T04:03:36Z

Riddy: /* Example */

{{Server client function}}
__NOTOC__
{{New feature/item|3.0158|1.5.7|20397|This function is used to remove a point from an existing [[createColPolygon|colshape polygon]].}}

==Syntax==
<syntaxhighlight lang="lua">
bool removeColPolygonPoint ( colshape shape, int index )
</syntaxhighlight>
{{OOP||[[colshape]]:removePoint||addColPolygonPoint|}}

===Required Arguments===
*'''shape:''' The [[colshape]] polygon you wish to remove a point from.
*'''index:''' The index of the point you wish to remove. The points are indexed in order, with 1 being the first bound point. You can't remove the last 3 points.

===Returns===
Returns ''true'' if the polygon was changed, ''false'' if invalid arguments were passed.

==Example==
<section name="Server" class="server" show="true">
This example remove a polygon colshape point by command 'removepoint'.
<syntaxhighlight lang="lua">
-- Creates polygon colshape at 0, 0, 4
local shape = createColPolygon ( -1.08, -0.05, 2.92, -0.05, -1.08, -4.05, -5.08, -0.05, -1.08, 3.95 )
function removePointToPolygon ( plr, cmd, index )
if ( not index ) then
-- if index argument after command is not there
outputChatBox ( "Correct syntax: /removepoint <index>", plr, 255, 25, 25 )
return false
end
-- Convert string to number 'index'
local index = tonumber ( index )
-- Get all polygon colshape points
local indexes = #getColPolygonPoints ( shape )
if ( index > indexes ) then
outputChatBox("Index point is greater than last index "..indexes, plr, 255, 25, 25)
return false
else
-- Remove polygon point at index
removeColPolygonPoint(shape, index)
end
outputChatBox ( "Point at index "..index.." removed", plr, 0, 255, 0 )
end
addCommandHandler ( "removepoint", removePointToPolygon )
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|1.5.7-9.20397|1.5.7-9.20397|}}

==See Also==
{{Collision_shape_functions}}

GetColPolygonHeight

2022-06-01T03:51:44Z

Riddy: /* Example */

{{Server client function}}
__NOTOC__
{{Added feature/item|1.5.9|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.}}

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

===Required Arguments===
*'''shape:''' The [[colshape]] polygon.

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

==Example==
<section name="Server" class="server" show="true">
This example creates a polygon colshape and show height of it with command 'getpolyheight'.
<syntaxhighlight lang="lua">
-- Creates polygon colshape at 0, 0, 4
local colPoly = createColPolygon ( -1.08, -0.05, 2.92, -0.05, -1.08, -4.05, -5.08, -0.05, -1.08, 3.95 )
-- Set its height to 4 unit
setColPolygonHeight ( colPoly, 2.32, 7.12 )

function showPolyHeight ( player, command )
-- Get element position
local x, y = getElementPosition ( colPoly )
-- Get table floor and ceil of the colshape height and unpack it
local z, z1 = unpack ( getColPolygonHeight ( colPoly ) )
local heights = z1 - z
-- Output it in his chatbox
outputChatBox( "The Polygon Colshape at "..x..", "..y.." height is "..heights, player, 255, 255, 0)
end
addCommandHandler ( "getpolyheight", showPolyHeight )
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|1.5.8-9.20807|1.5.8-9.20807|}}

==See Also==
{{Collision_shape_functions}}

GetColPolygonHeight

2022-06-01T03:48:24Z

Riddy: /* Example */

{{Server client function}}
__NOTOC__
{{Added feature/item|1.5.9|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.}}

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

===Required Arguments===
*'''shape:''' The [[colshape]] polygon.

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

==Example==
<section name="Server" class="server" show="true">
This example creates a polygon colshape and show height of it with command 'getpolyheight'.
<syntaxhighlight lang="lua">
-- Creates polygon colshape at 0, 0, 4
colPoly = createColPolygon ( -1.08, -0.05, 2.92, -0.05, -1.08, -4.05, -5.08, -0.05, -1.08, 3.95 )
-- Set its height to 4 unit
setColPolygonHeight ( colPoly, 2.32, 7.12 )

function showPolyHeight ( player, command )
-- Get element position
local x, y = getElementPosition ( colPoly )
-- Get table floor and ceil of the colshape height and unpack it
local z, z1 = unpack ( getColPolygonHeight ( colPoly ) )
local heights = z1 - z
-- Output it in his chatbox
outputChatBox( "The Polygon Colshape at "..x..", "..y.." height is "..heights, player, 255, 255, 0)
end
addCommandHandler ( "getpolyheight", showPolyHeight )
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|1.5.8-9.20807|1.5.8-9.20807|}}

==See Also==
{{Collision_shape_functions}}

GetColPolygonHeight

2022-06-01T03:47:14Z

Riddy: /* Example */

{{Server client function}}
__NOTOC__
{{Added feature/item|1.5.9|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.}}

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

===Required Arguments===
*'''shape:''' The [[colshape]] polygon.

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

==Example==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
-- Creates polygon colshape at 0, 0, 4
colPoly = createColPolygon ( -1.08, -0.05, 2.92, -0.05, -1.08, -4.05, -5.08, -0.05, -1.08, 3.95 )
-- Set its height to 4 unit
setColPolygonHeight ( colPoly, 2.32, 7.12 )

function showPolyHeight ( player, command )
-- Get element position
local x, y = getElementPosition ( colPoly )
-- Get table floor and ceil of the colshape height and unpack it
local z, z1 = unpack ( getColPolygonHeight ( colPoly ) )
local heights = z1 - z
-- Output it in his chatbox
outputChatBox( "The Polygon Colshape at "..x..", "..y.." height is "..heights, player, 255, 255, 0)
end
addCommandHandler ( "getpolyheight", showPolyHeight )
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|1.5.8-9.20807|1.5.8-9.20807|}}

==See Also==
{{Collision_shape_functions}}