SetPedGravity: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(New page: __NOTOC__ {{Server function}} This function sets the gravity level of a player. ==Syntax== <syntaxhighlight lang="lua"> bool setPedGravity ( ped thePed, float gravity ) </syntaxhighlight> ===Required Arguments=== *...)
 
(Added OOP syntax)
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server function}}
{{Server function}}
This function sets the gravity level of a player.
This function sets the gravity level of a ped.


==Syntax==
==Syntax==
Line 7: Line 7:
bool setPedGravity ( ped thePed, float gravity )
bool setPedGravity ( ped thePed, float gravity )
</syntaxhighlight>
</syntaxhighlight>
{{OOP||[[ped]]:setGravity|gravity|getPedGravity}}


===Required Arguments===
===Required Arguments===
Line 22: Line 23:
local success = setPedGravity ( thePlayer, tonumber ( level ) )  -- Set the gravity
local success = setPedGravity ( thePlayer, tonumber ( level ) )  -- Set the gravity
if not success then                          -- Check if setPlayerGravity was false (not successful)
if not success then                          -- Check if setPlayerGravity was false (not successful)
outputConsole( "Failed to set player gravity", thePlayer )  -- If success is false, meaning gravity could not be set, this message will show
outputConsole( "Failed to set ped gravity", thePlayer )  -- If success is false, meaning gravity could not be set, this message will show
end
end
end
end
end
end
addCommandHandler ( "setplayergravity", consoleSetPlayerGravity )</syntaxhighlight></section>
addCommandHandler ( "setplayergravity", consoleSetPlayerGravity )
</syntaxhighlight>


==See Also==
==See Also==
{{Ped functions}}
{{Ped functions}}
[[ru:setPedGravity]]

Latest revision as of 17:12, 26 November 2014

This function sets the gravity level of a ped.

Syntax

bool setPedGravity ( ped thePed, float gravity )

OOP Syntax Help! I don't understand this!

Method: ped:setGravity(...)
Variable: .gravity
Counterpart: getPedGravity


Required Arguments

  • thePed: The ped whose gravity to change.
  • level: The level of gravity (default is 0.008).

Returns

Returns true if the gravity was successfully set, false otherwise

Example

This example allows the user to type a command to change their gravity: 

function consoleSetPlayerGravity ( thePlayer, commandName, level )
	if thePlayer and level then
		local success = setPedGravity ( thePlayer, tonumber ( level ) )  -- Set the gravity
		if not success then                           -- Check if setPlayerGravity was false (not successful)
			outputConsole( "Failed to set ped gravity", thePlayer )  -- If success is false, meaning gravity could not be set, this message will show
		end
	end
end
addCommandHandler ( "setplayergravity", consoleSetPlayerGravity )

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/SetPedGravity?oldid=43047"