IsElementFrozen - Revision history

Walid: Fix oop syntax

2016-08-06T16:23:21Z

Fix oop syntax

← Older revision		Revision as of 16:23, 6 August 2016
Line 7:		Line 7:
	bool isElementFrozen ( element theElement )		bool isElementFrozen ( element theElement )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|[[element]]:isFrozen\|frozen\|}}		{{OOP\|\|[[element]]:isFrozen\|frozen\|setElementFrozen}}

	===Required Arguments===		===Required Arguments===

Qaisjp: fix oop syntax

2015-01-01T14:37:19Z

fix oop syntax

← Older revision		Revision as of 14:37, 1 January 2015
Line 7:		Line 7:
	bool isElementFrozen ( element theElement )		bool isElementFrozen ( element theElement )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|~~This function is also a static function underneath the Element class.~~\|[[element]]:isFrozen\|frozen\|}}		{{OOP\|\|[[element]]:isFrozen\|frozen\|}}

	===Required Arguments===		===Required Arguments===

Jaysds: /* Syntax */ OOP

2014-08-16T16:29:00Z

Syntax: OOP

← Older revision		Revision as of 16:29, 16 August 2014
Line 7:		Line 7:
	bool isElementFrozen ( element theElement )		bool isElementFrozen ( element theElement )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|This function is also a static function underneath the Element class.\|[[element]]:isFrozen\|frozen\|}}

	===Required Arguments===		===Required Arguments===

SDraw at 15:11, 19 April 2014

2014-04-19T15:11:16Z

← Older revision		Revision as of 15:11, 19 April 2014
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==

X86dev at 09:19, 17 April 2011

2011-04-17T09:19:15Z

← Older revision		Revision as of 09:19, 17 April 2011
Line 20:		Line 20:
	-- 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 getPedOccupiedVehicle ( 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 )

Qaisjp: /* Example */

2011-04-17T08:54:39Z

Example

← Older revision		Revision as of 08:54, 17 April 2011
Line 21:		Line 21:
	function toggleFreezeStatus ( thePlayer )		function toggleFreezeStatus ( thePlayer )
	-- if he is in a vehicle,		-- if he is in a vehicle,
	if ~~isPlayerInVehicle~~ ( thePlayer ) then		if getPedOccupiedVehicle ( thePlayer ) then
	-- get the vehicle element		-- get the vehicle element
	local playerVehicle = getPlayerOccupiedVehicle ( thePlayer )		local playerVehicle = getPlayerOccupiedVehicle ( thePlayer )

Qaisjp: Created page with "{{Server client function}} NOTOC This function checks if a vehicle has been frozen. ==Syntax== bool isElementFrozen ( element theElement ) ===Requir..."

2011-04-17T08:53:48Z

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..."

New page

{{Server client function}}
__NOTOC__
This function checks if a vehicle has been frozen.

==Syntax==
<syntaxhighlight lang="lua">
bool isElementFrozen ( element theElement )
</syntaxhighlight>

===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==
<section name="Server" 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 or unfreezes 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 = 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
</syntaxhighlight>
</section>

==See Also==
{{Element_functions}}