GetElementBoundingBox: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (List of args)
 
(6 intermediate revisions by 6 users not shown)
Line 3: Line 3:
This function returns the minimum and maximum coordinates of an element's bounding box.
This function returns the minimum and maximum coordinates of an element's bounding box.


It should be noted that the values returned are relevant to the position of the element, and as such if you wish to get world coordinates for drawing, et cetera, you should retrieve the position of the element and add the returned values onto that.
It should be noted that the values returned are relative to the position of the element, and as such if you wish to get world coordinates for drawing, etc., you should retrieve the position of the element and add the returned values onto that.
{{Note|The element must be streamed in for this function to work.}}


==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>  
{{OOP||[[element]]:getBoundingBox}}


===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===
*Returns ''min x, min y, min z, max x, max y, max z'' if the passed element is valid, ''false'' otherwise.
*Returns ''min x, min y, min z, max x, max y, max z'' if the passed element is valid and streamed in, ''false'' otherwise.


==Example==  
==Example==  
This example outputs to chatbox the minimum and the maximum coordinates of an element.
This example outputs to chatbox the minimum and the maximum coordinates of an element.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function minMaxOutput ( theElement )
function minMaxOutput( theElement )
     local x0, y0, z0, x1, y1, z1 = getElementBoundingBox ( theElement )
     local x0, y0, z0, x1, y1, z1 = getElementBoundingBox( theElement )
 
     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 ( "Failed to retrieve bounding box" )
         outputChatBox( "Failed to retrieve bounding box" )
     end
     end
end
end

Latest revision as of 14:08, 29 April 2021

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

It should be noted that the values returned are relative to the position of the element, and as such if you wish to get world coordinates for drawing, etc., you should retrieve the position of the element and add the returned values onto that.

[[{{{image}}}|link=|]] Note: The element must be streamed in for this function to work.

Syntax

float, float, float, float, float, float getElementBoundingBox ( element theElement )

OOP Syntax Help! I don't understand this!

Method: element:getBoundingBox(...)


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 and streamed in, false otherwise.

Example

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

function minMaxOutput( theElement )
    local x0, y0, z0, x1, y1, z1 = getElementBoundingBox( theElement )

    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=70948"