SetVehicleFrozen: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
 
(7 intermediate revisions by 5 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__
{{Server client function}}
{{Deprecated|setElementFrozen}}
 
 
This function freezes a vehicle (stops it in its position and disables movement) or unfreezes it.
This function freezes a vehicle (stops it in its position and disables movement) or unfreezes it.


==Syntax==  
==Syntax==
<section name="Server and Client" class="both" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool setVehicleFrozen ( vehicle theVehicle, bool freezeStatus )
bool setVehicleFrozen ( vehicle theVehicle, bool freezeStatus )
Line 8: Line 13:


===Required Arguments===  
===Required Arguments===  
*'''theVehicle:''' the [[vehicle]] whose freeze status we want to change.
*'''theVehicle:''' The [[vehicle]] whose freeze status we want to change.
*'''freezeStatus:''' whether we want to freeze or unfreeze it.
*'''freezeStatus:''' A boolean denoting whether we want to freeze (''true'') or unfreeze (''false'') it.


===Returns===
===Returns===
*Returns ''true'' if the vehicle was frozen, ''false'' if it wasn't or if invalid arguments are passed.
Returns ''true'' if the vehicle was frozen, ''false'' if it wasn't or if invalid arguments are passed.
</section>


==Example==
==Example==
<section name="Serverside example" 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 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 33: Line 32:
-- get the current freeze status
-- get the current freeze status
local currentFreezeStatus = isVehicleFrozen ( playerVehicle )
local currentFreezeStatus = isVehicleFrozen ( playerVehicle )
-- get the new freeze status (the opposite of the previous)
-- get the new freeze status (the opposite of the previous state)
local newFreezeStatus = not currentFreezeStatus
local newFreezeStatus = not currentFreezeStatus
-- set the new freeze status
-- set the new freeze status
setVehicleFrozen ( playerVehicle, newFreezeStatus )
setVehicleFrozen ( playerVehicle, newFreezeStatus )
end
end
end
-- now bind a key to this function for all players.
-- first get a list of all players
local connectedPlayers = getElementsByType ( "player" )
-- then, for each player,
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 20:21, 4 September 2016

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 setElementFrozen instead.


This function freezes a vehicle (stops it in its position and disables movement) or unfreezes it.

Syntax

Click to collapse [-]
Server and Client
bool setVehicleFrozen ( vehicle theVehicle, bool freezeStatus )

Required Arguments

  • theVehicle: The vehicle whose freeze status we want to change.
  • freezeStatus: A boolean denoting whether we want to freeze (true) or unfreeze (false) it.

Returns

Returns true if the vehicle was frozen, false if it wasn't or if invalid arguments are passed.

Example

Click to collapse [-]
Serverside example

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

-- This function freezes 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 state)
		local newFreezeStatus = not currentFreezeStatus
		-- set the new freeze status
		setVehicleFrozen ( playerVehicle, newFreezeStatus )
	end
end

-- now bind a key to this function for all players.
-- first get a list of all players
local connectedPlayers = getElementsByType ( "player" )
-- then, for each player,
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/SetVehicleFrozen?oldid=49028"