SetVehicleFrozen - Revision history

ThePiotrek at 20:21, 4 September 2016

2016-09-04T20:21:32Z

← Older revision		Revision as of 20:21, 4 September 2016
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
	{{Deprecated}}		{{Deprecated\|setElementFrozen}}

	~~Please use [[setElementFrozen]]~~

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

Arran Fortuna at 15:45, 2 October 2011

2011-10-02T15:45:01Z

← Older revision		Revision as of 15:45, 2 October 2011
Line 4:		Line 4:

	Please use [[setElementFrozen]]		Please use [[setElementFrozen]]

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

Arran Fortuna at 15:44, 2 October 2011

2011-10-02T15:44:55Z

← Older revision		Revision as of 15:44, 2 October 2011
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
			{{Deprecated}}

			Please use [[setElementFrozen]]
	This function freezes a vehicle (stops it in its position and disables movement) or unfreezes it.		This function freezes a vehicle (stops it in its position and disables movement) or unfreezes it.

Jbeta: Removed Template:Needs Checking: The serverside version does work

2007-09-18T16:21:34Z

Removed Template:Needs Checking: The serverside version does work

← Older revision		Revision as of 16:21, 18 September 2007
Line 1:		Line 1:
	~~{{Needs_Checking\|Broken serverside, tested and working clientside --[[User:Ransom\|Ransom]] 09:41, 18 September 2007 (CDT)}}~~

	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}

Ransom at 14:42, 18 September 2007

2007-09-18T14:42:37Z

← Older revision		Revision as of 14:42, 18 September 2007
Line 1:		Line 1:
			{{Needs_Checking\|Broken serverside, tested and working clientside --[[User:Ransom\|Ransom]] 09:41, 18 September 2007 (CDT)}}

	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}

Jbeta: Added sections, minor changes

2007-08-27T22:38:03Z

Added sections, minor changes

← Older revision		Revision as of 22:38, 27 August 2007
Line 3:		Line 3:
	This function freezes a vehicle (stops it in its position and disables movement) or unfreezes it.		This function freezes a vehicle (stops it in its position and disables movement) or unfreezes it.

	==Syntax==		==Syntax==
			<section name="Server and Client" class="both" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool setVehicleFrozen ( vehicle theVehicle, bool freezeStatus )		bool setVehicleFrozen ( vehicle theVehicle, bool freezeStatus )
Line 9:		Line 10:

	===Required Arguments===		===Required Arguments===
	*'''theVehicle:''' ~~the~~ [[vehicle]] whose freeze status we want to change.		*'''theVehicle:''' The [[vehicle]] whose freeze status we want to change.
	*'''freezeStatus:''' whether we want to freeze or unfreeze it.		*'''freezeStatus:''' A boolean denoting whether we want to freeze (''true'') or unfreeze (''false'') it.

	===Returns===		===Returns===
	*Returns ''true'' if the vehicle was frozen, ''false'' if it wasn't or if invalid arguments are passed.		Returns ''true'' if the vehicle was frozen, ''false'' if it wasn't or if invalid arguments are passed.
			</section>

	==Example==		==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.		This example binds the "p" key to a function to freeze/unfreeze the player's current vehicle.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 26:		Line 29:
	-- get the current freeze status		-- get the current freeze status
	local currentFreezeStatus = isVehicleFrozen ( playerVehicle )		local currentFreezeStatus = isVehicleFrozen ( playerVehicle )
	-- get the new freeze status (the opposite of the previous)		-- get the new freeze status (the opposite of the previous state)
	local newFreezeStatus = not currentFreezeStatus		local newFreezeStatus = not currentFreezeStatus
	-- set the new freeze status		-- set the new freeze status
Line 42:		Line 45:
	end		end
	</syntaxhighlight>		</syntaxhighlight>
			</section>

	==See Also==		==See Also==
	{{Vehicle_functions}}		{{Vehicle_functions}}

	~~[[Category:Rated8]]~~

Arc at 20:38, 15 August 2007

2007-08-15T20:38:46Z

@@ Line 1: / Line 1: @@
 __NOTOC__
 This function freezes a vehicle (stops it in its position and disables movement) or unfreezes it.
@@ Line 17: / Line 18: @@
 This example binds the "p" key to a function to freeze/unfreeze the player's current vehicle.
 <syntaxhighlight lang="lua">
--- we store all players in a table
+-- This function freezes the specified player's vehicle, if he's in one
 function toggleFreezeStatus ( thePlayer )
 	-- if he is in a vehicle,
@@ Line 38: / Line 31: @@
 		setVehicleFrozen ( playerVehicle, newFreezeStatus )
 	end
 end
 </syntaxhighlight>

Driver2 at 00:27, 27 July 2007

2007-07-27T00:27:46Z

← Older revision		Revision as of 00:27, 27 July 2007
Line 43:		Line 43:
	==See Also==		==See Also==
	{{Vehicle_functions}}		{{Vehicle_functions}}

			[[Category:Rated8]]

VRocker2: /* Example */

2007-05-06T22:40:17Z

Example

← Older revision		Revision as of 22:40, 6 May 2007
Line 20:		Line 20:
	local connectedPlayers = getElementsByType ( "player" )		local connectedPlayers = getElementsByType ( "player" )
	-- for each one in it,		-- for each one in it,
	for i, aPlayer in connectedPlayers do		for i, aPlayer in ipairs(connectedPlayers) do
	-- bind the player's "p" key to the toggleFreezeStatus function		-- bind the player's "p" key to the toggleFreezeStatus function
	bindKey ( aPlayer, "p", "down", "toggleFreezeStatus" )		bindKey ( aPlayer, "p", "down", "toggleFreezeStatus" )

Jbeta at 14:48, 22 April 2007

2007-04-22T14:48:01Z

New page

__NOTOC__
This function freezes a vehicle (stops it in its position and disables movement) or unfreezes it.

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleFrozen ( vehicle theVehicle, bool freezeStatus )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' the [[vehicle]] whose freeze status we want to change.
*'''freezeStatus:''' whether we want to freeze or unfreeze it.

===Returns===
*Returns ''true'' if the vehicle was frozen, ''false'' if it wasn't or if invalid arguments are passed.

==Example==
This example binds the "p" key to a function to freeze/unfreeze the player's current vehicle.
<syntaxhighlight lang="lua">
-- we store all players in a table
local connectedPlayers = getElementsByType ( "player" )
-- for each one in it,
for i, aPlayer in connectedPlayers do
-- bind the player's "p" key to the toggleFreezeStatus function
bindKey ( aPlayer, "p", "down", "toggleFreezeStatus" )
end

-- 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)
local newFreezeStatus = not currentFreezeStatus
-- set the new freeze status
setVehicleFrozen ( playerVehicle, newFreezeStatus )
end
end
</syntaxhighlight>

==See Also==
{{Vehicle_functions}}