SetElementCollisionsEnabled: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(25 intermediate revisions by 16 users not shown)
Line 1: Line 1:
{{Server client function}}
__NOTOC__  
__NOTOC__  
This function can disable or enable an element's collisions. An element without collisions does not interact with the physical environment and remains static.
This function can disable or enable an element's collisions. An element without collisions does not interact with the physical environment and remains static.
{{Note|Vehicles that are collisionless and have a driver will cause bugs.}}
{{Note|Enabling a players collisions when they're inside a vehicle will cause bugs.}}
{{Note|Disabling a peds collisions will cause some problems, such as it being unable to move or wrong rotation after creation.}}


==Syntax==  
==Syntax==  
Line 6: Line 11:
bool setElementCollisionsEnabled ( element theElement, bool enabled )  
bool setElementCollisionsEnabled ( element theElement, bool enabled )  
</syntaxhighlight>  
</syntaxhighlight>  
{{OOP||[[element]]:setCollisionsEnabled|collisions|getElementCollisionsEnabled}}


===Required Arguments===  
===Required Arguments===  
Line 14: Line 20:
Returns ''true'' if the collisions were set succesfully, ''false'' otherwise.
Returns ''true'' if the collisions were set succesfully, ''false'' otherwise.


<section name="Server" class="server" show="false">
==Example==  
==Example==  
This example enables collisions for all vehicles within a certain radius of a player:
This example disables collisions for all vehicles within a certain radius of a player:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function enableVehicleCollisionsNearPlayer(player, maxDistance)
function disableVehicleCollisionsNearPlayer(thePlayer, maxDistance)
local playerX, playerY, playerZ = getElementPosition(player)
local playerX, playerY, playerZ = getElementPosition(thePlayer)
local vehicles = getElementsByType("vehicle")
local vehicles = getElementsByType("vehicle")
for k,v in ipairs(vehicles) do
for k,v in ipairs(vehicles) do
local vehicleX, vehicleY, vehicleZ = getElementPosition(v)
local vehicleX, vehicleY, vehicleZ = getElementPosition(v)
-- get the distance between the player and the vehicle:
-- get the distance between the player and the vehicle:
local distance = math.sqrt((vehicleX - playerX)^2 + (vehicleY - playerY)^2 + (vehicleZ - playerZ)^2)
local distance = getDistanceBetweenPoints3D(vehicleX, vehicleY, vehicleZ, playerX, playerY, playerZ)
if (distance <= maxDistance) then
if (distance <= maxDistance) then
-- enable collisions for the vehicle
-- disable collisions for the vehicle
setElementCollisionsEnabled(v, true)
setElementCollisionsEnabled(v, false)
end
end
end
end
end
end
</syntaxhighlight>
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{Element_functions}}
{{Client element functions}}

Latest revision as of 16:27, 20 January 2020

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

[[{{{image}}}|link=|]] Note: Vehicles that are collisionless and have a driver will cause bugs.
[[{{{image}}}|link=|]] Note: Enabling a players collisions when they're inside a vehicle will cause bugs.
[[{{{image}}}|link=|]] Note: Disabling a peds collisions will cause some problems, such as it being unable to move or wrong rotation after creation.

Syntax

bool setElementCollisionsEnabled ( element theElement, bool enabled )

OOP Syntax Help! I don't understand this!

Method: element:setCollisionsEnabled(...)
Variable: .collisions
Counterpart: getElementCollisionsEnabled


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



Retrieved from "https://wiki.multitheftauto.com/wiki/SetElementCollisionsEnabled?oldid=64914"