SetElementFrozen: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ {{Server client function}} This function freezes an element (stops it in its position and disables movement) or unfreezes it. ==Syntax== <section name="Server and Clie...")
 
mNo edit summary
 
(15 intermediate revisions by 10 users not shown)
Line 2: Line 2:
{{Server client function}}
{{Server client function}}
This function freezes an element (stops it in its position and disables movement) or unfreezes it.
This function freezes an element (stops it in its position and disables movement) or unfreezes it.
{{Warning|This function cancels any animation set by setPedAnimation if you freeze the ped.}}


==Syntax==
==Syntax==
<section name="Server and Client" class="both" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool setElementFrozen ( element theElement, bool freezeStatus )
bool setElementFrozen ( element theElement, bool freezeStatus )
</syntaxhighlight>  
</syntaxhighlight>  
{{OOP||[[element]]:setFrozen|frozen|isElementFrozen}}


===Required Arguments===  
===Required Arguments===  
Line 15: Line 16:
===Returns===
===Returns===
Returns ''true'' if the element was frozen, ''false'' if it wasn't or if invalid arguments are passed.
Returns ''true'' if the element was frozen, ''false'' if it wasn't or if invalid arguments are passed.
</section>


==Example==
==Example==
Line 21: Line 21:
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">
-- This function freezes the specified player's vehicle, if he's in one
function toggleFreezeStatus(thePlayer) -- This function freezes the specified player's vehicle, if he's in one
function toggleFreezeStatus ( thePlayer )
local playerVehicle = getPedOccupiedVehicle(thePlayer) -- Check if player's in vehicle
-- if he is in a vehicle,
 
if getPedOccupiedVehicle ( thePlayer ) then
if playerVehicle then -- if so
-- get the vehicle element
local isPlayerVehicleFrozen = isElementFrozen(playerVehicle) -- Check if vehicle is frozen
local playerVehicle = getPlayerOccupiedVehicle ( thePlayer )
 
-- get the current freeze status
setElementFrozen(playerVehicle, not isPlayerVehicleFrozen) -- Set opposite state
local currentFreezeStatus = isElementFrozen ( playerVehicle )
-- get the new freeze status (the opposite of the previous state)
local newFreezeStatus = not currentFreezeStatus
-- set the new freeze status
setElementFrozen ( playerVehicle, newFreezeStatus )
end
end
end
end


-- now bind a key to this function for all players.
local connectedPlayers = getElementsByType("player") -- Get all connected players
-- first get a list of all players
 
local connectedPlayers = getElementsByType ( "player" )
for playerID = 1, #connectedPlayers do -- Loop through each player
-- then, for each player,
local playerElement = connectedPlayers[playerID] -- Get player element by accessing it via playerID
for i, aPlayer in ipairs(connectedPlayers) do
 
-- bind the player's "p" key to the toggleFreezeStatus function
bindKey(playerElement, "p", "down", toggleFreezeStatus, "Toggle freeze status") -- Bind function for player
bindKey ( aPlayer, "p", "down", "Toggle freeze status", toggleFreezeStatus )
end
end
</syntaxhighlight>
</syntaxhighlight>
</section>
</section>
==Issues==
{{Issues|
{{Issue|1291|Ped rotation is always zero on client side if ped has been frozed after creating it}}
{{Issue|541|Frozen ped rotation goes wrong with latency reduction enabled}}
{{Issue|442|Client-side setElementFrozen should sync vehicle driven by local player}}
}}


==See Also==
==See Also==
{{Element_functions}}
{{Element_functions}}

Latest revision as of 14:55, 11 June 2023

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

[[|link=|]] Warning: This function cancels any animation set by setPedAnimation if you freeze the ped.

Syntax

bool setElementFrozen ( element theElement, bool freezeStatus )

OOP Syntax Help! I don't understand this!

Method: element:setFrozen(...)
Variable: .frozen
Counterpart: isElementFrozen


Required Arguments

  • theElement: The element 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 element 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. 

function toggleFreezeStatus(thePlayer) -- This function freezes the specified player's vehicle, if he's in one
	local playerVehicle = getPedOccupiedVehicle(thePlayer) -- Check if player's in vehicle

	if playerVehicle then -- if so
		local isPlayerVehicleFrozen = isElementFrozen(playerVehicle) -- Check if vehicle is frozen

		setElementFrozen(playerVehicle, not isPlayerVehicleFrozen) -- Set opposite state
	end
end

local connectedPlayers = getElementsByType("player") -- Get all connected players

for playerID = 1, #connectedPlayers do -- Loop through each player
	local playerElement = connectedPlayers[playerID] -- Get player element by accessing it via playerID

	bindKey(playerElement, "p", "down", toggleFreezeStatus, "Toggle freeze status") -- Bind function for player
end

Issues

Issue ID Description
#1291 Ped rotation is always zero on client side if ped has been frozed after creating it
#541 Frozen ped rotation goes wrong with latency reduction enabled
#442 Client-side setElementFrozen should sync vehicle driven by local player


See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/SetElementFrozen?oldid=76937"