SetVehicleFrozen
From Multi Theft Auto: Wiki
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 Clientbool 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 exampleThis 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
FROM VERSION 1.5.7 r19626 ONWARDS
- attachTrailerToVehicle
- blowVehicle
- createVehicle
- detachTrailerFromVehicle
- fixVehicle
- getModelHandling
- getOriginalHandling
- getTrainDirection
- getTrainPosition
- getTrainSpeed
FROM VERSION 1.6 r7485 ONWARDS
- getVehicleColor
- getVehicleCompatibleUpgrades
- getVehicleController
- getVehicleDoorOpenRatio
- getVehicleDoorState
- getVehicleEngineState
- getVehicleHandling
- getVehicleHeadLightColor
- getVehicleLandingGearDown
- getVehicleLightState
- getVehicleMaxPassengers
- getVehicleModelFromName
- getVehicleName
- getVehicleNameFromModel
- getVehicleOccupant
- getVehicleOccupants
- getVehicleOverrideLights
- getVehiclePaintjob
- getVehiclePanelState
- getVehiclePlateText
- getVehicleRespawnPosition
- getVehicleRespawnRotation
- getVehicleSirenParams
- getVehicleSirens
- getVehicleSirensOn
- getVehicleTowedByVehicle
- getVehicleTowingVehicle
- getVehicleTurretPosition
- getVehicleType
- getVehicleUpgradeOnSlot
- getVehicleUpgradeSlotName
- getVehicleUpgrades
- getVehicleVariant
- getVehicleWheelStates
- getVehiclesOfType
- isTrainDerailable
- isTrainDerailed
- isVehicleBlown
- isVehicleDamageProof
- isVehicleFuelTankExplodable
- isVehicleLocked
- isVehicleOnGround
- isVehicleTaxiLightOn
- removeVehicleSirens
- removeVehicleUpgrade
- resetVehicleExplosionTime
- resetVehicleIdleTime
- respawnVehicle
- setModelHandling
- setTrainDerailable
- setTrainDerailed
- setTrainDirection
- setTrainPosition
- setTrainSpeed
FROM VERSION 1.6 r7485 ONWARDS
- setVehicleColor
- setVehicleDamageProof
- setVehicleDoorOpenRatio
- setVehicleDoorState
- setVehicleDoorsUndamageable
- setVehicleEngineState
- setVehicleFuelTankExplodable
- setVehicleHandling
- setVehicleHeadLightColor
- setVehicleIdleRespawnDelay
- setVehicleLandingGearDown
- setVehicleLightState
- setVehicleLocked
- setVehicleOverrideLights
- setVehiclePaintjob
- setVehiclePanelState
- setVehiclePlateText
- setVehicleRespawnDelay
- setVehicleRespawnPosition
- setVehicleRespawnRotation
- setVehicleSirens
- setVehicleSirensOn
- setVehicleTaxiLightOn
- setVehicleTurretPosition