IsElementFrozen: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "{{Server client function}} __NOTOC__ This function checks if a vehicle has been frozen. ==Syntax== <syntaxhighlight lang="lua"> bool isElementFrozen ( element theElement ) </syntaxhighlight> ===Requir...")
 
(Fix oop syntax)
 
(5 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Server client function}}
{{Server client function}}
__NOTOC__
__NOTOC__
This function checks if a vehicle has been frozen.
This function checks if element has been frozen.


==Syntax==  
==Syntax==  
Line 7: Line 7:
bool isElementFrozen ( element theElement )
bool isElementFrozen ( element theElement )
</syntaxhighlight>  
</syntaxhighlight>  
{{OOP||[[element]]:isFrozen|frozen|setElementFrozen}}


===Required Arguments===  
===Required Arguments===  
Line 20: Line 21:
-- this function freezes or unfreezes the specified player's vehicle, if he's in one
-- this function freezes or unfreezes the specified player's vehicle, if he's in one
function toggleFreezeStatus ( thePlayer )
function toggleFreezeStatus ( thePlayer )
-- if he is in a vehicle,
-- get the vehicle element
if isPlayerInVehicle ( thePlayer ) then
local playerVehicle = getPlayerOccupiedVehicle ( thePlayer )
-- get the vehicle element
 
local playerVehicle = getPlayerOccupiedVehicle ( thePlayer )
if playerVehicle then
-- get the current freeze status
-- get the current freeze status
local currentFreezeStatus = isElementFrozen ( playerVehicle )
local currentFreezeStatus = isElementFrozen ( playerVehicle )

Latest revision as of 16:23, 6 August 2016

This function checks if element has been frozen.

Syntax

bool isElementFrozen ( element theElement )

OOP Syntax Help! I don't understand this!

Method: element:isFrozen(...)
Variable: .frozen
Counterpart: setElementFrozen


Required Arguments

  • theElement: the element whose freeze status we want to check.

Returns

  • Returns true if the element is frozen, false if it isn't or if invalid arguments were passed.

Example

Click to collapse [-]
Server

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

-- this function freezes or unfreezes the specified player's vehicle, if he's in one
function toggleFreezeStatus ( thePlayer )
	-- get the vehicle element
	local playerVehicle = getPlayerOccupiedVehicle ( thePlayer )

	if playerVehicle then
		-- get the current freeze status
		local currentFreezeStatus = isElementFrozen ( playerVehicle )
		-- get the new freeze status (the opposite of the previous)
		local newFreezeStatus = not currentFreezeStatus
		-- set the new freeze status
		setElementFrozen ( playerVehicle, newFreezeStatus )
	end
end

-- now make this function available as key bind to all players.
-- first, get the list of players
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", "Toggle freeze status", toggleFreezeStatus )
end

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/IsElementFrozen?oldid=48723"