This function creates a collision cuboid. This is a shape that has a position, width, depth and height. See Wikipedia for a definition of a cuboid. The XYZ of the col starts at the southwest bottom corner of the shape.

Note

Attaching a cuboid colshape to another element may give unexpected results as the origin is not at the cuboid centre. Try using a collision sphere for attaching instead.

Tip

To visualize a colshape when writing scripts, use the client console command showcol.

OOP Syntax Help! I don't understand this!

• Method:ColShape.Cuboid(...)

Syntax

colshape|false createColCuboid ( float fX, float fY, float fZ, float fWidth, float fDepth, float fHeight )

Required Arguments

• fX: The X position of the collision cuboid's western side.
• fY: The Y position of the collision cuboid's southern side.
• fZ: The Z position of the collision cuboid's lowest side.
• fWidth: The collision cuboid's width.
• fDepth: The collision cuboid's depth.
• fHeight: The collision cuboid's height.

Returns

• colshape|false: col-cuboid

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

Code Examples

Example 1 Example 2 Example 3 (OOP)

server

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

local theZone

local function shapeHit(hitElement, matchingDimensions)
    if (hitElement and getElementType(hitElement) == 'player' and matchingDimensions) then
        outputChatBox(getPlayerName(thePlayer).. " is in the zone!")
    end
end

function setZone(playerSource, commandName, fX, fY, fZ, fWidth, fDepth, fHeight)
    local fX, fY, fZ, fWidth, fDepth, fHeight = tonumber(fX), tonumber(fY), tonumber(fZ), tonumber(fWidth), tonumber(fDepth), tonumber(fHeight)
    if (not fX) or (not fY) or (not fZ) or (not fWidth) or (not fDepth) or (not fHeight) then
        outputChatBox("Syntax: /"..commandName.." [X] [Y] [Z] [Width] [Depth] [Height]", playerSource)
    else
        if (theZone) then
            destroyElement(theZone)
        end
        local tempCol = createColCuboid(fX, fY, fZ, fWidth, fDepth, fHeight)
        addEventHandler("onColShapeHit", tempCol, shapeHit)
        outputChatBox("Zone has "..(theZone ~= nil and "moved" or "created").."!", playerSource)
        theZone = tempCol
    end
end
addCommandHandler("set_zone", setZone, false, false)

server

This function creates a cuboid and centers it to given coordinates.

addCommandHandler('createCenteredCuboid', function(player, cmd, posX, posY, posZ, sizeX, sizeY, sizeZ)
  posX = posX - sizeX / 2
  posY = posY - sizeY / 2
  posZ = posZ - sizeZ / 2
  createColCuboid(posX, posY, posZ, sizeX, sizeY, sizeZ)
end)

server

OOP Required

This function creates a cuboid and centers it to given coordinates.

addCommandHandler('createCenteredCuboid', function(player, cmd, posX, posY, posZ, sizeX, sizeY, sizeZ)
  posX = posX - sizeX / 2
  posY = posY - sizeY / 2
  posZ = posZ - sizeZ / 2
  ColShape.Cuboid(posX, posY, posZ, sizeX, sizeY, sizeZ)
end)

Gallery

Click on the image to view the full preview along with the description.

See Also

Colshape Functions

• addColPolygonPoint
• createColCircle
• createColCuboid
• createColPolygon
• createColRectangle
• createColSphere
• createColTube
• getColPolygonHeight
• getColPolygonPointPosition
• getColPolygonPoints
• getColShapeRadius
• getColShapeSize
• getColShapeType
• isInsideColShape
• removeColPolygonPoint
• setColPolygonHeight
• setColPolygonPointPosition
• setColShapeRadius
• setColShapeSize

Colshape Events

• onClientColShapeHit
• onClientColShapeLeave
• onColShapeHit
• onColShapeLeave

Reference

• Scripting Functions