SetVehicleFrozen

From Multi Theft Auto: Wiki
Revision as of 20:38, 15 August 2007 by Arc (talk | contribs)
Jump to navigation Jump to search

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

Syntax

bool setVehicleFrozen ( vehicle theVehicle, bool freezeStatus )

Required Arguments

  • theVehicle: the vehicle whose freeze status we want to change.
  • freezeStatus: whether we want to freeze or unfreeze it.

Returns

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

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)
		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=10413"