IsGarageOpen

From Multi Theft Auto: Wiki
Revision as of 08:42, 18 September 2008 by Erorr404 (talk | contribs) (New page: __NOTOC__ {{Server client function}} This function checks whether or not a specific garage door is open. ==Syntax== <syntaxhighlight lang="lua"> bool isGarageOpen ( int garageID ) </syntaxhighlight> ===Require...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This function checks whether or not a specific garage door is open.

Syntax

bool isGarageOpen ( int garageID )

Required Arguments

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

Returns

Returns true if the garage is open, false if it is closed.

Example

Click to collapse [-]
Server

This example opens a garage door when a player enters a collision shape near it, and closes it when they leave:

GARAGE_ID = 25

-- create a collision shape and attach event handlers to it when the resource starts
addEventHandler("onResourceStart", getResourceRootElement(getThisResource()),
function (resource)
	local garageCube = createColCuve(1337, 194, 28, 6, 10, 4)
	addEventHandler("onColShapeHit", garageCube, onGarageCubeHit)
	addEventHandler("onColShapeLeave", garageCube, onGarageCubeLeave)
end

-- open the door when someone enters the garage's collision shape
function onGarageCubeHit(hitElement, matchingDimension)
	if (getElementType(hitElement) == "player") then
		-- check to make sure the door is closed
		if (not isGarageOpen(GARAGE_ID)) then
			-- open the door
			setGarageOpen(GARAGE_ID, true)
		end
	end
end

-- close the door when someone leaves the garage's collision shape
function onGarageCubeLeave(leaveElement, matchingDimension)
	if (getElementType(leaveElement) == "player") then
		-- check to make sure the door is open
		if (isGarageOpen(GARAGE_ID)) then
			-- close the door
			setGarageOpen(GARAGE_ID, false)
		end
	end
end

See Also