CreateColCuboid: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(correct the example)
mNo edit summary
Line 32: Line 32:


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

Revision as of 09:22, 6 November 2023

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.

[[{{{image}}}|link=|]] Tip: To visualize a colshape when writing scripts, use the client console command showcol
[[{{{image}}}|link=|]] 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

Syntax

colshape createColCuboid ( float fX, float fY, float fZ, float fWidth, float fDepth, float fHeight )
A cuboid created using this function

OOP Syntax Help! I don't understand this!

Method: ColShape.Cuboid(...)


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

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

Example

Click to collapse [-]
Server

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!")
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 fWidth) or (not fHeight) then
        outputChatBox("Syntax: /"..commandName.." [X] [Y] [Z] [Width] [Depth] [Height]", playerSource)
    else
        if (theZone ~= nil) 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)

See Also