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

isElementFrozen

Client-side
Server-side
Shared

Pair: setElementFrozen

Manual Review Required

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

This function checks if element has been frozen.

OOP Syntax Help! I don't understand this!

  • Method:element:isFrozen(...)
  • Variable: .frozen

Syntax 

bool isElementFrozen ( element theElement )
Required Arguments
  • theElement: the element whose freeze status we want to check.

Returns

  • bool: value

Code Examples

shared

This example binds the "p" key to a function to freeze/unfreeze the player's current vehicle.

-- this function freezes or unfreezes the specified player's vehicle, if he's in one
function toggleFreezeStatus ( thePlayer )
  -- get the vehicle element
  local playerVehicle = getPlayerOccupiedVehicle ( thePlayer )


  if playerVehicle then
    -- get the current freeze status
    local currentFreezeStatus = isElementFrozen ( playerVehicle )
    -- get the new freeze status (the opposite of the previous)
    local newFreezeStatus = not currentFreezeStatus
    -- set the new freeze status
    setElementFrozen ( playerVehicle, newFreezeStatus )
  end
end


-- now make this function available as key bind to all players.
-- first, get the list of players
local connectedPlayers = getElementsByType ( "player" )
-- for each one in it,
for i, aPlayer in ipairs(connectedPlayers) do
  -- bind the player's "p" key to the toggleFreezeStatus function
  bindKey ( aPlayer, "p", "down", "Toggle freeze status", toggleFreezeStatus )
end

See Also

Element Functions
Element Events
Reference