IsVehicleFrozen: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Visual improvement)
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__
{{Server client function}}
{{Deprecated|isElementFrozen}}
 
This function checks if a vehicle has been frozen.
This function checks if a vehicle has been frozen.


Line 11: Line 14:


===Returns===
===Returns===
*Returns ''true'' if the vehicle is frozen, ''false'' if it isn't or if invalid arguments are passed.
*Returns ''true'' if the vehicle is frozen, ''false'' if it isn't or if invalid arguments were passed.


==Example==
==Example==
<section name="Server" class="server" show="true">
This example binds the "p" key to a function to freeze/unfreeze the player's current vehicle.
This example binds the "p" key to a function to freeze/unfreeze the player's current vehicle.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- we store all players in a table
-- this function freezes or unfreezes the specified player's vehicle, if he's in one
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", "toggleFreezeStatus" )
end
 
-- this function freezes the specified player's vehicle, if he's in one
function toggleFreezeStatus ( thePlayer )
function toggleFreezeStatus ( thePlayer )
-- if he is in a vehicle,
-- if he is in a vehicle,
Line 37: Line 33:
setVehicleFrozen ( playerVehicle, newFreezeStatus )
setVehicleFrozen ( playerVehicle, newFreezeStatus )
end
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
end
</syntaxhighlight>
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{Vehicle_functions}}
{{Vehicle_functions}}

Latest revision as of 11:51, 26 June 2014

Emblem-important.png This function is deprecated. This means that its use is discouraged and that it might not exist in future versions.
Please use isElementFrozen instead.


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=40336"