Difference between revisions of "IsElementFrozen"

From Multi Theft Auto: Wiki
Jump to: navigation, search
m
m
Line 1: Line 1:
 
{{Server client function}}
 
{{Server client function}}
 
__NOTOC__
 
__NOTOC__
This function checks if a vehicle has been frozen.
+
This function checks if element has been frozen.
  
 
==Syntax==  
 
==Syntax==  

Revision as of 15:11, 19 April 2014

This function checks if element has been frozen.

Syntax

bool isElementFrozen ( element theElement )

Required Arguments

  • theElement: the element whose freeze status we want to check.

Returns

  • Returns true if the element is frozen, false if it isn't or if invalid arguments were passed.

Example

Click to collapse [-]
Server

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