PL/setElementFrozen: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Blanked the page)
Line 1: Line 1:
__NOTOC__
{{PL/ shared function}}
This function freezes an element (stops it in its position and disables movement) or unfreezes it.


==Syntax==
<syntaxhighlight lang="lua">
bool setElementFrozen ( element theElement, bool freezeStatus )
</syntaxhighlight>
{{OOP||[[element]]:setFrozen|frozen|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==
<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.
<syntaxhighlight lang="lua">
-- This function freezes the specified player's vehicle, if he's in one
function toggleFreezeStatus ( thePlayer )
-- if he is in a vehicle,
if getPedOccupiedVehicle ( thePlayer ) then
-- get the vehicle element
local playerVehicle = getPlayerOccupiedVehicle ( thePlayer )
-- get the current freeze status
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
-- 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
</syntaxhighlight>
</section>
==See Also==
{{Element_functions}}

Revision as of 18:41, 31 August 2016

Retrieved from "https://wiki.multitheftauto.com/wiki/PL/setElementFrozen?oldid=48963"