IsVehicleFrozen

From Multi Theft Auto: Wiki
Revision as of 18:13, 2 October 2011 by Arran Fortuna (talk | contribs)
Jump to navigation Jump to search


Emblem-important.png This function is deprecated. This means that its use is discouraged and that it might not exist in future versions, but there should be a more generic way to perform what it does.


Please use isElementFrozen

This function checks if a vehicle has been frozen.

Syntax

bool isVehicleFrozen ( vehicle theVehicle )

Required Arguments

  • theVehicle: the vehicle whose freeze status we want to check.

Returns

  • Returns true if the vehicle 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 )
	-- if he is in a vehicle,
	if isPlayerInVehicle ( thePlayer ) then
		-- get the vehicle element
		local playerVehicle = getPlayerOccupiedVehicle ( thePlayer )
		-- get the current freeze status
		local currentFreezeStatus = isVehicleFrozen ( playerVehicle )
		-- get the new freeze status (the opposite of the previous)
		local newFreezeStatus = not currentFreezeStatus
		-- set the new freeze status
		setVehicleFrozen ( 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


Retrieved from "https://wiki.multitheftauto.com/wiki/IsVehicleFrozen?oldid=27286"