SetElementCollisionsEnabled

From Multi Theft Auto: Wiki
Revision as of 16:36, 16 August 2014 by Jaysds (talk | contribs) (→‎Syntax: OOP)
Jump to navigation Jump to search

This function can disable or enable an element's collisions. An element without collisions does not interact with the physical environment and remains static.

Syntax

bool setElementCollisionsEnabled ( element theElement, bool enabled ) 

OOP Syntax Help! I don't understand this!

Note: This function is also a static function underneath the Element class.
Method: element:setCollisionsEnabled(...)


Required Arguments

  • theElement: The element you wish to set the collisions of
  • enabled: A boolean to indicate whether collisions are enabled (true) or disabled (false)

Returns

Returns true if the collisions were set succesfully, false otherwise.

Example

This example disables collisions for all vehicles within a certain radius of a player:

function disableVehicleCollisionsNearPlayer(thePlayer, maxDistance)
	local playerX, playerY, playerZ = getElementPosition(thePlayer)
	local vehicles = getElementsByType("vehicle")
	for k,v in ipairs(vehicles) do
		local vehicleX, vehicleY, vehicleZ = getElementPosition(v)
		-- get the distance between the player and the vehicle:
		local distance = getDistanceBetweenPoints3D(vehicleX, vehicleY, vehicleZ, playerX, playerY, playerZ)
		if (distance <= maxDistance) then
			-- disable collisions for the vehicle
			setElementCollisionsEnabled(v, false)
		end
	end
end

See Also