IsPlayerDucked: Difference between revisions

Latest revision as of 11:46, 26 June 2014

	This function is deprecated. This means that its use is discouraged and that it might not exist in future versions.
	Please use isPedDucked instead.

This function checks if the specified player is ducked (crouched) or not.

bool isPlayerDucked ( player thePlayer )

Returns true if the player is ducked, false otherwise.

This example checks if a random player is ducked or not, and if so displays a message in the chat box.

aPlayer = getRandomPlayer ( )
if ( isPlayerDucked ( aPlayer ) ) then
	outputChatBox ( getClientName ( aPlayer ) .. " is currently crouching." )
end

@@ Line 1: / Line 1: @@
 __NOTOC__
-==Description==
+{{Server client function}}
-This function returns a boolean value (true or false) depending on whether the specified [[player]] is ducked (crouched) or not.
+{{Deprecated|isPedDucked}}
+This function checks if the specified [[player]] is ducked (crouched) or not.
 ==Syntax==
-<syntaxhighlight lang="lua">bool IsPlayerDucked ( player player )</syntaxhighlight>
+<syntaxhighlight lang="lua">bool isPlayerDucked ( player thePlayer )</syntaxhighlight>
 ===Required Arguments===
-*'''player''': A [[player]] object referencing the specified player
+*'''thePlayer''': A [[player]] object referencing the specified player
+===Returns===
+Returns ''true'' if the player is ducked, ''false'' otherwise.
 ==Example==
-<syntaxhighlight lang="lua">player = getPlayerFromID ( 1 )
+This example checks if a random player is ducked or not, and if so displays a message in the chat box.
-if ( IsPlayerDucked ( player ) )
+<syntaxhighlight lang="lua">
-  outputChatBox ( GetPlayerName ( player ) , " is currently crouching." )
+aPlayer = getRandomPlayer ( )
-end</syntaxhighlight>
+if ( isPlayerDucked ( aPlayer ) ) then
+	outputChatBox ( getClientName ( aPlayer ) .. " is currently crouching." )
+end
+</syntaxhighlight>
 ==See Also==
 {{Player functions}}