CreateColCuboid: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Added another example for centered cuboids)
 
(10 intermediate revisions by 6 users not shown)
Line 2: Line 2:
{{Server client function}}
{{Server client function}}
This function creates a collision cuboid. This is a shape that has a position, width, depth and height. See [http://en.wikipedia.org/wiki/Cuboid Wikipedia] for a definition of a cuboid. The XYZ of the col starts at the southwest bottom corner of the shape.
This function creates a collision cuboid. This is a shape that has a position, width, depth and height. See [http://en.wikipedia.org/wiki/Cuboid Wikipedia] for a definition of a cuboid. The XYZ of the col starts at the southwest bottom corner of the shape.
 
{{VisualizeColshape}}
{{Note|Attaching a cuboid colshape to another element may give unexpected results as the origin is not at the cuboid centre. Try using a [[createColSphere|collision sphere]] for attaching instead}}
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
colshape createColCuboid ( float fX, float fY, float fZ, float fWidth, float fDepth, float fHeight )
colshape createColCuboid ( float fX, float fY, float fZ, float fWidth, float fDepth, float fHeight )
</syntaxhighlight>  
</syntaxhighlight>  
 
[[File:Col-Cuboid.png|thumb|A cuboid created using this function]]
{{OOP| |ColShape.Cuboid||}}
===Required Arguments===  
===Required Arguments===  
*'''fX:''' The X position of the collision cuboid's western side
*'''fX:''' The X position of the collision cuboid's western side.
*'''fY:''' The Y position of the collision cuboid's southern side
*'''fY:''' The Y position of the collision cuboid's southern side.
*'''fZ:''' The Z position of the collision cuboid's lowest side
*'''fZ:''' The Z position of the collision cuboid's lowest side.
*'''fWidth:''' The collision cuboid's width
*'''fWidth:''' The collision cuboid's width.
*'''fDepth:''' The collision cuboid's depth
*'''fDepth:''' The collision cuboid's depth.
*'''fHeight:''' The collision cuboid's height
*'''fHeight:''' The collision cuboid's height.


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


==Example==  
==Examples==
<section name="Server" class="server" show="true">
<section name="Server" class="server" show="true">
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''.
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''.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
theZone = false
local theZone


function shapeHit ( thePlayer )  
function shapeHit(thePlayer)
     outputChatBox ( getPlayerName ( thePlayer ) .. " is in the zone!" ) -- display a message in everyone's chat box
     outputChatBox(getPlayerName(thePlayer).. " is in the zone!")
end
end


function setZone ( playerSource, commandName, fX, fY, fZ )
function setZone(playerSource, commandName, fX, fY, fZ, fWidth, fDepth, fHeight)
     if ( fZ and fY and fX ) then                                        -- check we've got all 3 args we need
     local fX, fY, fZ, fWidth, fDepth, fHeight = tonumber(fX), tonumber(fY), tonumber(fZ), tonumber(fWidth), tonumber(fDepth), tonumber(fHeight)
        local tempCol = createColCuboid ( fX, fY, fZ, 10.0, 10.0, 10.0 )   -- create a col
    if (not fX) or (not fY) or (not fZ) or (not fWidth) or (not fDepth) or (not fHeight) then
        if ( tempCol == false ) then                                     -- did the col get created successfully?
        outputChatBox("Syntax: /"..commandName.." [X] [Y] [Z] [Width] [Depth] [Height]", playerSource)
            outputConsole ( "Syntax is: set_zone <X> <Y> <Z>" )         -- inform the user what the valid syntax is
    else
        else
        if (theZone ~= nil) then
            if ( theZone ~= false ) then                                 -- did we already have a zone?
            destroyElement(theZone)
                destroyElement ( theZone )                               -- if so, destroy it
            else
                addEventHandler ( "onColShapeHit", theZone, shapeHit )  -- add a handler for the onColShapeHit event
            end
            theZone = tempCol                                            -- store the new zone we've made
            outputChatBox ( "Zone has moved!" )                          -- and tell everyone
         end
         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
end
end
addCommandHandler ( "set_zone", setZone ) -- add a console function called set_zone that will trigger the function setZone
addCommandHandler("set_zone", setZone, false, false)
</syntaxhighlight>
</section>
 
<section name="Server" class="server" show="true">
This function creates a cuboid and centers it to given coordinates
<syntaxhighlight lang="lua">
addCommandHandler('createCenteredCuboid', function(player, cmd, posX, posY, posZ, sizeX, sizeY, sizeZ)
posX = posX - sizeX / 2
posY = posY - sizeY / 2
posZ = posZ - sizeZ / 2
createCuboid(posX, posY, posZ, sizeX, sizeY, sizeZ)
end)
</syntaxhighlight>
</syntaxhighlight>
</section>
</section>
Line 51: Line 63:
==See Also==
==See Also==
{{Collision shape functions}}
{{Collision shape functions}}
[[hu:createColCuboid]]

Latest revision as of 14:29, 31 January 2024

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.

Examples

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 fZ) or (not fWidth) or (not fDepth) 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)
Click to collapse [-]
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
	createCuboid(posX, posY, posZ, sizeX, sizeY, sizeZ)
end)

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/CreateColCuboid?oldid=78788"