IsVehicleFrozen - Revision history

AlexTMjugador: Visual improvement

2014-06-26T11:51:44Z

Visual improvement

← Older revision		Revision as of 11:51, 26 June 2014
Line 1:		Line 1:
			__NOTOC__
	{{Server client function}}		{{Server client function}}
	~~__NOTOC__~~		{{Deprecated\|isElementFrozen}}
	{{Deprecated}}

	~~Please use [[isElementFrozen]]~~

	This function checks if a vehicle has been frozen.		This function checks if a vehicle has been frozen.

Arran Fortuna at 18:13, 2 October 2011

2011-10-02T18:13:33Z

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

			Please use [[isElementFrozen]]

	This function checks if a vehicle has been frozen.		This function checks if a vehicle has been frozen.

Talidan at 16:49, 29 August 2007

2007-08-29T16:49:56Z

← Older revision		Revision as of 16:49, 29 August 2007
Line 15:		Line 15:

	==Example==		==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.		This example binds the "p" key to a function to freeze/unfreeze the player's current vehicle.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 41:		Line 42:
	end		end
	</syntaxhighlight>		</syntaxhighlight>
			</section>

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

Arc at 19:10, 16 August 2007

2007-08-16T19:10:50Z

← Older revision		Revision as of 19:10, 16 August 2007
Line 17:		Line 17:
	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		-- 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,		-- if he is in a vehicle,

Arc at 19:10, 16 August 2007

2007-08-16T19:10:22Z

← Older revision		Revision as of 19:10, 16 August 2007
Line 1:		Line 1:
	__NOTOC__		{{Server client function}}
			__NOTOC__
	This function checks if a vehicle has been frozen.		This function checks if a vehicle has been frozen.

Line 11:		Line 12:

	===Returns===		===Returns===
	*Returns ''true'' if the vehicle is frozen, ''false'' if it isn't or if invalid arguments ~~are~~ passed.		*Returns ''true'' if the vehicle is frozen, ''false'' if it isn't or if invalid arguments were passed.

	==Example==		==Example==
	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">
	~~-- we store all players in a table~~
	~~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", "toggleFreezeStatus" )~~
	~~end~~

	-- this function freezes the specified player's vehicle, if he's in one		-- this function freezes the specified player's vehicle, if he's in one
	function toggleFreezeStatus ( thePlayer )		function toggleFreezeStatus ( thePlayer )
Line 37:		Line 30:
	setVehicleFrozen ( playerVehicle, newFreezeStatus )		setVehicleFrozen ( playerVehicle, newFreezeStatus )
	end		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		end
	</syntaxhighlight>		</syntaxhighlight>

VRocker2: /* Example */

2007-05-06T22:33:36Z

Example

← Older revision		Revision as of 22:33, 6 May 2007
Line 19:		Line 19:
	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:45, 22 April 2007

2007-04-22T14:45:02Z

← Older revision		Revision as of 14:45, 22 April 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	~~<!-- Describe in plain english what this~~ function ~~does~~. ~~Don't go into details, just give an overview -->~~		This function checks if a vehicle has been frozen.
	~~This fake function is for use with blah & blah and does blahblahblabhalbhl~~

	==Syntax==		==Syntax==
	<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool isVehicleFrozen ( vehicle ~~thevehicle~~ )		bool isVehicleFrozen ( vehicle theVehicle )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	~~<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->~~		*'''theVehicle:''' the vehicle whose freeze status we want to check.
	*'''~~argumentName~~:''' ~~description~~

	~~<!-- Only include this section below if there are optional arguments -->~~
	~~===Optional Arguments===~~
	~~{{OptionalArg}}~~
	*'''argumentName2:''' description
	*'''argumentName3:''' description

	===Returns===		===Returns===
	~~<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->~~		*Returns ''true'' if the vehicle is frozen, ''false'' if it isn't or if invalid arguments are passed.
	*Returns ''true'' if ~~blah~~, ''false'' ~~otherwise~~.

	==Example==		==Example==
	~~<!-- Explain what~~ the ~~example is in~~ a ~~single sentance -->~~		This example binds the "p" key to a function to freeze/unfreeze the player's current vehicle.
	~~This example does...~~
	~~<!-- Add~~ the ~~code below, an emphasis should be on making it clear, not optimized~~. ~~You could provide two versions if you wish, one clear and well commented, the other optimized -->~~
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	--~~This line does...~~		-- we store all players in a table
	~~blabhalbalhb~~ --~~abababa~~		local connectedPlayers = getElementsByType ( "player" )
	--~~This line does~~ this~~...~~		-- for each one in it,
	~~mooo~~		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>		</syntaxhighlight>

	==See Also==		==See Also==
	~~<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->~~		{{Vehicle_functions}}
	{{~~FunctionArea_functions~~}}
	~~[[Category:Incomplete]] -- leave this unless you complete the function~~

Ransom at 20:30, 13 April 2007

2007-04-13T20:30:32Z

← Older revision		Revision as of 20:30, 13 April 2007
Line 6:		Line 6:
	<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->		<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool isVehicleFrozen ( vehicle )		bool isVehicleFrozen ( vehicle thevehicle )
	</syntaxhighlight>		</syntaxhighlight>

Ransom at 20:24, 13 April 2007

2007-04-13T20:24:00Z

← Older revision		Revision as of 20:24, 13 April 2007
Line 37:		Line 37:
	<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->		<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
	{{FunctionArea_functions}}		{{FunctionArea_functions}}
	~~[[Category:Need_Syntax]] -- leave this until syntax is available. Cannot document the function or event without syntax.~~
	[[Category:Incomplete]] -- leave this unless you complete the function		[[Category:Incomplete]] -- leave this unless you complete the function

Ransom at 20:23, 13 April 2007

2007-04-13T20:23:47Z

← Older revision		Revision as of 20:23, 13 April 2007
Line 6:		Line 6:
	<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->		<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~returnType functionName~~ ( ~~arguments~~ )		bool isVehicleFrozen ( vehicle )
	</syntaxhighlight>		</syntaxhighlight>

Line 21:		Line 21:
	===Returns===		===Returns===
	<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->		<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
	Returns ''true'' if blah, ''false'' otherwise.		*Returns ''true'' if blah, ''false'' otherwise.

	==Example==		==Example==