SetGarageOpen: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 9: Line 9:


===Required Arguments===  
===Required Arguments===  
*'''garageID:''' The ID that represents the garage door being opened or closed.
*'''garageID:''' The [[Garage]] ID that represents the garage door being opened or closed.
*'''isOpen:''' A boolean indicating whether or not to open the door.
*'''isOpen:''' A boolean indicating whether or not to open the door.


Revision as of 08:49, 18 September 2008

This function opens or closes the specified garage door in the world.

Syntax

bool setGarageOpen ( int garageID, bool open )

Required Arguments

  • garageID: The Garage ID that represents the garage door being opened or closed.
  • isOpen: A boolean indicating whether or not to open the door.

Returns

Returns true if it succeeded, false if an invalid garage id was given.

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

Retrieved from "https://wiki.multitheftauto.com/wiki/SetGarageOpen?oldid=17688"