IsVehicleFrozen: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
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

Revision as of 14:45, 22 April 2007

This function checks if a vehicle has been frozen.

Syntax

bool isVehicleFrozen ( vehicle theVehicle )

Required Arguments

  • theVehicle: the vehicle whose freeze status we want to check.

Returns

  • Returns true if the vehicle is frozen, false if it isn'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. 

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

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/IsVehicleFrozen?oldid=8088"