IsPedDucked: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Added new example)
(Added OOP syntax)
Line 5: Line 5:
==Syntax==
==Syntax==
<syntaxhighlight lang="lua">bool isPedDucked ( ped thePed )</syntaxhighlight>
<syntaxhighlight lang="lua">bool isPedDucked ( ped thePed )</syntaxhighlight>
{{OOP||[[ped]]:isDucked|ducked}}


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

Revision as of 17:23, 26 November 2014

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

Syntax

bool isPedDucked ( ped thePed )

OOP Syntax Help! I don't understand this!

Method: ped:isDucked(...)
Variable: .ducked


Required Arguments

  • thePed: The ped to check.

Returns

Returns true if the ped is ducked, false otherwise.

Example

Click to collapse [-]
Client

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

local players = getElementsByType ( "player" )
local randomPlayer = players[math.random(#players)]
if isPedDucked ( randomPlayer ) then
	outputChatBox ( getPlayerName ( randomPlayer ) .. " is currently crouching." )
end

This example creates a function that lets you toggle the crouching state of a ped. 

function setPedDucked(ped, bool)
	local alreadyDucked = isPedDucked(ped)
	if (alreadyDucked and not bool) then
		if (ped == localPlayer) then
			setControlState("crouch", true)
			setTimer(setControlState, 50, 1, "crouch", false)
		else
			setPedControlState(ped, "crouch", true)
			setTimer(setPedControlState, 50, 1, ped, "crouch", false)
		end
		return true
	elseif (not alreadyDucked and bool) then
		if (ped == localPlayer) then
			setControlState("crouch", true)
			setTimer(setControlState, 50, 1, "crouch", false)
		else
			setPedControlState(ped, "crouch", true)
			setTimer(setPedControlState, 50, 1, ped, "crouch", false)
		end
		return true
	end
	return false
end

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/IsPedDucked?oldid=43061"