isGarageOpen | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

isGarageOpen

Client-side
Server-side
Shared

Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

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

Syntax

bool isGarageOpen ( int garageID )
Required Arguments
  • garageID: The garage ID that represents the garage door that is being checked.

Returns

  • bool: value

Returns true if the garage is open, false if it is closed or an invalid garage ID was given.

Code Examples

shared

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(),
function (resource)
  local garageCube = createColCuboid(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

World Functions
Reference