GetGarageBoundingBox: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(added example)
Line 17: Line 17:
==Example==  
==Example==  
<section name="Client" class="client" show="true">
<section name="Client" class="client" show="true">
{{Example}}
Checks if the player is inside the bounding box of the garage and outputs the result to the chat
<syntaxhighlight lang="lua">
function garageCheck ( command, garageID )
if not garageID then
return
end
local west, east, south, north = getGarageBoundingBox ( garageID ) --get the bounding box of the specified garage
local x, y, z = getElementPosition ( getLocalPlayer ( ) ) --get the position of the player
if x > west and x < east and y > south and y < north then --check if the player is inside the bounding box
outputChatBox ( "You are inside the garage" )
else
outputChatBox ( "You are outside the garage" )
end
end
 
addCommandHandler ( "garagecheck", garageCheck )
</syntaxhighlight>
</section>
</section>


==See Also==
==See Also==
{{World functions}}
{{World functions}}

Revision as of 20:43, 17 July 2012

This function outputs the bounding box of a garage.

Syntax

float, float, float, float getGarageBoundingBox ( int garageID )

Required Arguments

  • garageID: The garage ID that represents the garage door that is being checked.

Returns

Returns four floats indicating the bounding box of the garage. Western X position, Eastern X position, Southern Y position, Northern Y position.

Example

Click to collapse [-]
Client

Checks if the player is inside the bounding box of the garage and outputs the result to the chat 

function garageCheck ( command, garageID )
	if not garageID then
		return
	end
	
	local west, east, south, north = getGarageBoundingBox ( garageID ) --get the bounding box of the specified garage
	local x, y, z = getElementPosition ( getLocalPlayer ( ) ) --get the position of the player
	
	if x > west and x < east and y > south and y < north then --check if the player is inside the bounding box
		outputChatBox ( "You are inside the garage" )
	else
		outputChatBox ( "You are outside the garage" )
	end
end

addCommandHandler ( "garagecheck", garageCheck )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetGarageBoundingBox?oldid=31935"