SetVehicleGravity: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
 
(3 intermediate revisions by 3 users not shown)
Line 2: Line 2:
{{Client function}}
{{Client function}}


Sets the gravity vector of a vehicle. The vehicle will fall in this direction, and the camera of any occupants will also be rotated to match it. Can be used for e.g. driving on walls or driving upside down.
Sets the gravity vector of a vehicle. The vehicle will fall in this direction, and the camera of any occupants will also be rotated to match it. Can be used for e.g. driving on walls or upside down on ceilings.


==Syntax==
==Syntax==
Line 14: Line 14:
Returns ''true'' if successful, ''false'' otherwise.
Returns ''true'' if successful, ''false'' otherwise.


===Example===
This example will set 0 gravity to the vehicle if a local player enters it
<syntaxhighlight lang="lua">
addEventHandler("onClientVehicleEnter",getRootElement(),function(thePlayer)
if (thePlayer == localPlayer) then -- if thePlayer is localPlayer
local gravity = setVehicleGravity(source,0,0,0) -- Set the gravity
if (gravity) then -- If the gravity was set succesfully
local gravity_pos = Vector3(getVehicleGravity(source)) -- get the gravity vector
outputChatBox("Gravity was set to "..gravity_pos.x.." "..gravity_pos.y.." "..gravity_pos.z,0,255,0) -- output to chat
end
end
end)
</syntaxhighlight>
==See Also==
==See Also==
{{Client vehicle functions}}
{{Client vehicle functions}}

Latest revision as of 11:29, 12 July 2017

Sets the gravity vector of a vehicle. The vehicle will fall in this direction, and the camera of any occupants will also be rotated to match it. Can be used for e.g. driving on walls or upside down on ceilings.

Syntax

bool setVehicleGravity ( vehicle theVehicle, float x, float y, float z )

Required Arguments

  • theVehicle: the vehicle of which to change the gravity.
  • x, y, z: the components of the new gravity vector. If this vector has length 1, the strength of the gravity will be same as the global gravity for other entities. If it is 2, it will be twice as strong, etc.

Returns

Returns true if successful, false otherwise.

Example

This example will set 0 gravity to the vehicle if a local player enters it 

addEventHandler("onClientVehicleEnter",getRootElement(),function(thePlayer)
	if (thePlayer == localPlayer) then -- if thePlayer is localPlayer
		local gravity = setVehicleGravity(source,0,0,0) -- Set the gravity
		if (gravity) then -- If the gravity was set succesfully
			local gravity_pos = Vector3(getVehicleGravity(source)) -- get the gravity vector
			outputChatBox("Gravity was set to "..gravity_pos.x.." "..gravity_pos.y.." "..gravity_pos.z,0,255,0) -- output to chat
		end
	end
end)

See Also



Retrieved from "https://wiki.multitheftauto.com/wiki/SetVehicleGravity?oldid=51632"