From Multi Theft Auto: Wiki
Revision as of 09:29, 6 November 2023 by IManGaaX (talk | contribs) (correct the example)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This function creates a collision tube. This is a shape that has a position and a 2D (X/Y) radius and a height. See Cylinder for a definition of a tube. A tube is similar to a colcircle, except that it has a limited height, this means you can limit the distance above the position defined by (fX, fY, fZ) that the collision is detected.

[[{{{image}}}|link=|]] Tip: To visualize a colshape when writing scripts, use the client console command showcol


colshape createColTube ( float fX, float fY, float fZ, float fRadius, float fHeight )

OOP Syntax Help! I don't understand this!

Method: ColShape.Tube(...)

Required Arguments

  • fX: The position of the base of the tube's center on the X axis.
  • fY: The position of the base of the tube's center on the Y axis.
  • fZ: The position of the base of the tube's center on the Z axis.
  • fRadius: The collision tube's radius.
  • fHeight: The collision tube's height.


Returns a colshape element if successful, false if invalid arguments were passed to the function.


Click to collapse [-]

This example displays a chat message when a player enters the colshape and allows the colshape to be created using a console function set_zone.

local theZone

function shapeHit(thePlayer)
    outputChatBox(getPlayerName(thePlayer).. " is in the zone!")

function setZone(playerSource, commandName, fX, fY, fZ, fRadius, fHeight)
    local fX, fY, fZ, fRadius, fHeight = tonumber(fX), tonumber(fY), tonumber(fZ), tonumber(fRadius), tonumber(fHeight)
    if (not fX) or (not fY) or (not fZ) or (not fRadius) or (not fHeight) then
        outputChatBox("Syntax: /"..commandName.." [X] [Y] [Z] [Radius] [Height]", playerSource)
        if (theZone ~= nil) then
        local tempCol = createColTube(fX, fY, fZ, fRaduis, fHeight)
        addEventHandler("onColShapeHit", tempCol, shapeHit)
        outputChatBox("Zone has "..(theZone ~= nil and "moved" or "created").."!", playerSource)
        theZone = tempCol
addCommandHandler("set_zone", setZone, false, false)

See Also