GetElementBoundingBox: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
__NOTOC__  
{{Client function}}
This function returns the minimum and maximum x,y,z coords of an element's bounding box.
__NOTOC__
This function returns the minimum and maximum coordinates of an element's bounding box.


==Syntax==  
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
float float float float float float getElementBoundingBox ( element theElement )
float float float float float float getElementBoundingBox ( element theElement )
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===  
===Required Arguments===
*'''theElement:''' the element whose bounding box we want to get.
'''theElement:''' the element whose bounding box we want to get.


===Returns===
===Returns===
Line 14: Line 15:


==Example==  
==Example==  
This example outputs to chatbox the minimum and the maximum coords of an element. If the element doesn't exist or doesn't have such coords, it outputs "false".
This example outputs to chatbox the minimum and the maximum coordinates of an element.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function minMaxOutput( element )
function minMaxOutput( element )
     x0, y0, z0, x1, y1, z1 = getElementBoundingBox ( element )
     local x0, y0, z0, x1, y1, z1 = getElementBoundingBox ( element )
     if ( x0 ) then
     if ( x0 ) then
         outputChatBox( "The coords are: " .. x0 .. ", " .. y0 .. ", " .. z0 .. ", " .. x1 .. ", " .. y1 .. ", " .. z1 )
         outputChatBox( "The coords are: " .. x0 .. ", " .. y0 .. ", " .. z0 .. ", " .. x1 .. ", " .. y1 .. ", " .. z1 )
     else
     else
         outputChatBox( "false" )
         outputChatBox( "Failed to retrieve bounding box" )
     end
     end
end
end

Revision as of 15:53, 20 August 2007

This function returns the minimum and maximum coordinates of an element's bounding box.

Syntax

float float float float float float getElementBoundingBox ( element theElement )

Required Arguments

theElement: the element whose bounding box we want to get.

Returns

  • Returns min x, min y, min z, max x, max y, max z if the passed element is valid, false otherwise.

Example

This example outputs to chatbox the minimum and the maximum coordinates of an element. 

function minMaxOutput( element )
    local x0, y0, z0, x1, y1, z1 = getElementBoundingBox ( element )
    if ( x0 ) then
        outputChatBox( "The coords are: " .. x0 .. ", " .. y0 .. ", " .. z0 .. ", " .. x1 .. ", " .. y1 .. ", " .. z1 )
    else
        outputChatBox( "Failed to retrieve bounding box" )
    end
end

See Also



Retrieved from "https://wiki.multitheftauto.com/wiki/GetElementBoundingBox?oldid=10757"