Skip to content

Latest commit

 

History

History
363 lines (261 loc) · 20.8 KB

collisions.md

File metadata and controls

363 lines (261 loc) · 20.8 KB
title description
Collisions
Explains methods to detect physical collisions, handle collision events, and fine-tune which objects collide with others.

A collision occurs when two 3D objects come into contact within the 3D world. For customized collision handling, Class.BasePart has a set of collision events and collision filtering techniques, so you can control which physical assemblies collide with others.

Collision Events

Collision events occur when two Class.BasePart|BaseParts touch or stop touching in the 3D world. You can detect these collisions through the Class.BasePart.Touched|Touched and Class.BasePart.TouchEnded|TouchEnded events which occur regardless of either part's Class.BasePart.CanCollide|CanCollide property value. When considering collision handling on parts, note the following:

  • A part's Class.BasePart.CanTouch|CanTouch property determines whether it triggers collision events. If set to false, neither Class.BasePart.Touched|Touched nor Class.BasePart.TouchEnded|TouchEnded will fire.
  • A part's Class.BasePart.CanCollide|CanCollide property affects whether it will physically collide with other parts and cause forces to act upon them. Even if Class.BasePart.CanCollide|CanCollide is disabled for a part, you can detect touch and non‑touch through Class.BasePart.Touched|Touched and Class.BasePart.TouchEnded|TouchEnded events.
  • The Class.BasePart.Touched|Touched and Class.BasePart.TouchEnded|TouchEnded events only fire as a result of physical movement, not from a Class.BasePart.Position|Position or Class.BasePart.CFrame|CFrame changes that cause a part to intersect or stop intersecting another part.
  • The top-level Class.Terrain class inherits from Class.BasePart, so you can assign a collision group to Class.Terrain to determine whether other Class.BasePart|BaseParts collide with Terrain voxels.
For performance optimization, set `Class.BasePart.CanTouch|CanTouch` to `false` for objects that don't require collisions.

Touched

The Class.BasePart.Touched|Touched event fires when a Class.BasePart comes in contact with another, or with a Terrain voxel. It only fires as a result of physical simulation and will not fire when the part's Class.BasePart.Position|Position or Class.BasePart.CFrame|CFrame is explicitly set such that it intersects another part or voxel.

The following code pattern shows how the Class.BasePart.Touched|Touched event can be connected to a custom onTouched() function. Note that the event sends the otherPart argument to the function, indicating the other part involved in the collision.

local part = workspace.Part

local function onTouched(otherPart)
	print(part.Name .. " collided with " .. otherPart.Name)
end

part.Touched:Connect(onTouched)

Note that the Class.BasePart.Touched|Touched event can fire multiple times in quick succession based on subtle physical collisions, such as when a moving object "settles" into a resting position or when a collision involves a multi‑part model. To avoid triggering more Class.BasePart.Touched|Touched events than necessary, you can implement a simple debounce system which enforces a "cooldown" period through an instance attribute.

local part = workspace.Part

local COOLDOWN_TIME = 1

local function onTouched(otherPart)
	if not part:GetAttribute("Touched") then
		print(part.Name .. " collided with " .. otherPart.Name)

		part:SetAttribute("Touched", true)  -- Set attribute to true
		task.wait(COOLDOWN_TIME)  -- Wait for cooldown duration
		part:SetAttribute("Touched", false)  -- Reset attribute
	end
end

part.Touched:Connect(onTouched)

TouchEnded

The Class.BasePart.TouchEnded|TouchEnded event fires when the entire collision bounds of a Class.BasePart exits the bounds of another Class.BasePart or a filled Terrain voxel. It only fires as a result of physical simulation and will not fire when the part's Class.BasePart.Position|Position or Class.BasePart.CFrame|CFrame is explicitly set such that it stops intersecting another part or voxel.

The following code pattern shows how the Class.BasePart.TouchEnded|TouchEnded event can be connected to a custom onTouchEnded() function. Like Class.BasePart.Touched|Touched, the event sends the otherPart argument to the function, indicating the other part involved.

local part = workspace.Part

local function onTouchEnded(otherPart)
	print(part.Name .. " is no longer touching " .. otherPart.Name)
end

part.TouchEnded:Connect(onTouchEnded)

Collision Filtering

Collision filtering defines which physical parts collide with others. You can configure filtering for numerous objects through collision groups or you can control collisions on a part‑to‑part basis with Class.NoCollisionConstraint instances.

Collision Groups

Collision groups let you assign Class.BasePart|BaseParts to dedicated groups and specify whether or not they collide with those in other groups. Parts within non‑colliding groups pass through each other completely, even if both parts have their Class.BasePart.CanCollide|CanCollide property set to true.

In the video above, the spinning objects are in different collision groups such that they collide with objects of another color but not with objects of their own color

You can easily set up collision groups through Studio's Collision Groups Editor, accessible by clicking the Collision Groups button in the Model tab.

Collision Groups tool indicated in Model tab of Studio

The editor functions in either List View which favors docking to the left or right side of Studio, or in a wider Table View, which favors docking to the top or bottom.

List View example in Collision Groups Editor

Table View example in Collision Groups Editor

Registering Groups

The editor includes one **Default** collision group which cannot be renamed or deleted. All `Class.BasePart|BaseParts` automatically belong to this default group unless assigned to another group, meaning that they will collide with all other objects in the **Default** group.

To create a new collision group:

  1. Click the Add Group button along the top of the editor panel, enter a new group name, and press Enter. The new group appears in both columns of list view, or in both the left column and upper row of table view.

    New group added to Collision Groups Editor in List View New group added to Collision Groups Editor in Table View
  2. Repeat the process if necessary, choosing a unique and descriptive name for each group. Note that you can change a group's name during development by clicking in its field, or by selecting it and clicking the rename button.

    Button and field indicated for renaming a group in the Collision Groups Editor
To create a new collision group through scripting, include the `Class.PhysicsService` service and register the group with `Class.PhysicsService:RegisterCollisionGroup()`. It may be helpful to pre-declare your group names in local variables, as the same strings can be used for [assigning objects](#assigning-objects-to-groups) and [configuring groups](#configuring-group-collisions) within the same script.
local PhysicsService = game:GetService("PhysicsService")

local cubes = "Cubes"
local doors = "Doors"

-- Register two collision groups
PhysicsService:RegisterCollisionGroup(cubes)
PhysicsService:RegisterCollisionGroup(doors)
Since scripts are not guaranteed to execute in any particular order, it's highly recommended that you register collision groups in a single script. Abstracting group registration among multiple scripts may result in a race condition where a group is not yet registered at the time you [configure groups](#configuring-group-collisions) or [assign objects](#assigning-objects-to-groups) to them.

Configuring Group Collisions

Under default configuration, objects in all groups collide with each other. To prevent objects in one group from colliding with objects in another group, **uncheck** the box in the respective row/column.

In the following example, objects in the Cubes group will not collide with objects in the Doors group.

Group configured in List View of Collision Groups Editor

Group configured in Table View of Collision Groups Editor

To configure how objects in two collision groups interact, call `Class.PhysicsService:CollisionGroupSetCollidable()|CollisionGroupSetCollidable()`, providing the two collision groups and a boolean `true` (collidable) or `false` (non‑collidable). If objects in the same group should or shouldn't collide with each other, use that group name for both the first and second parameters.
local PhysicsService = game:GetService("PhysicsService")

local cubes = "Cubes"
local doors = "Doors"

-- Register two collision groups
PhysicsService:RegisterCollisionGroup(cubes)
PhysicsService:RegisterCollisionGroup(doors)

-- Set cubes to be non-collidable with doors
PhysicsService:CollisionGroupSetCollidable(cubes, doors, false)

Assigning Objects to Groups

To assign objects to groups you've [registered](#registering-groups) through the Studio editor:
  1. Select one or more Class.BasePart|BaseParts that qualify as part of a collision group.

  2. Assign them to the group by clicking the button for its row. Objects can belong to only one collision group at a time, so placing them in a new group removes them from their current group.

    Plus button indicated in Collision Groups Editor for adding selected parts to a group

Once assigned, the new group is reflected under the object's Class.BasePart.CollisionGroup|CollisionGroup property.

Chosen collision group indicated as the part's CollisionGroup property

To add a `Class.BasePart` to a collision group through scripting, simply assign the group's **string name**, previously registered through `Class.PhysicsService:RegisterCollisionGroup()|RegisterCollisionGroup()`, to the part's `Class.BasePart.CollisionGroup|CollisionGroup` property.
local PhysicsService = game:GetService("PhysicsService")

local cubes = "Cubes"
local doors = "Doors"

-- Register two collision groups
PhysicsService:RegisterCollisionGroup(cubes)
PhysicsService:RegisterCollisionGroup(doors)

-- Set cubes to be non-collidable with doors
PhysicsService:CollisionGroupSetCollidable(cubes, doors, false)

-- Assign an object to each group
workspace.Cube1.CollisionGroup = cubes
workspace.Door1.CollisionGroup = doors

StudioSelectable Collision Group

Tools in Studio use the collision filtering system to determine which objects are candidates for selection when clicking in the 3D viewport. Objects whose assigned collision group does not collide with StudioSelectable will be ignored.

For example, if you have checkpoints in a racing experience whose effective areas are defined by large transparent parts, you can assign them to a Checkpoints collision group and then make that group non‑collidable with StudioSelectable so that they don't get in the way when you're editing the underlying map geometry.

Checkpoints group configured to be non-collidable with StudioSelectable group

For plugin code, it's recommended that you assign "StudioSelectable" as the collision group filter of your Datatype.RaycastParams when finding parts under the cursor. This allows your plugins to match the selection mechanics that creators have learned to expect from built‑in Studio tools.

local UserInputService = game:GetService("UserInputService")

local raycastParams = RaycastParams.new()
raycastParams.CollisionGroup = "StudioSelectable"  -- To follow the convention
raycastParams.BruteForceAllSlow = true  -- So that parts with CanQuery of "false" can be selected

local mouseLocation = UserInputService:GetMouseLocation()
local mouseRay = workspace.CurrentCamera:ViewportPointToRay(mouseLocation.X, mouseLocation.Y)
local filteredSelectionHit = workspace:Raycast(mouseRay.Origin, mouseRay.Direction * 10000, raycastParams)

Part-to-Part Filtering

To prevent collisions between two specific parts without setting up collision groups, such as between a vehicle's wheel and its chassis, consider the No Collision constraint. Advantages include:

  • Collision groups and/or configuration scripts are not required, so you can easily create and share models with customized collision filtering.
  • Connected parts will not collide with each other, but they can still collide with other objects.

Disabling Character Collisions

Roblox player characters collide with each other by default. This can lead to interesting but unintended gameplay, such as characters jumping on top of each other to reach specific areas. If this behavior is undesirable, you can prevent it through the following Class.Script in Class.ServerScriptService.

local PhysicsService = game:GetService("PhysicsService")
local Players = game:GetService("Players")

PhysicsService:RegisterCollisionGroup("Characters")
PhysicsService:CollisionGroupSetCollidable("Characters", "Characters", false)

local function onDescendantAdded(descendant)
	-- Set collision group for any part descendant
	if descendant:IsA("BasePart") then
		descendant.CollisionGroup = "Characters"
	end
end

local function onCharacterAdded(character)
	-- Process existing and new descendants for physics setup
	for _, descendant in character:GetDescendants() do
		onDescendantAdded(descendant)
	end
	character.DescendantAdded:Connect(onDescendantAdded)
end

Players.PlayerAdded:Connect(function(player)
	-- Detect when the player's character is added
	player.CharacterAdded:Connect(onCharacterAdded)
end)

Model Collisions

Class.Model objects are containers for parts rather than inheriting from Class.BasePart, so they can't directly connect to Class.BasePart.Touched or Class.BasePart.TouchEnded events. To determine whether a model triggers a collision events, you need to loop through its children and connect the custom onTouched() and onTouchEnded() functions to each child Class.BasePart.

For joined parts by [solid modeling](../parts/solid-modeling.md) instead of `Class.Model` objects, see [Mesh and Solid Modeling Collisions](#mesh-and-solid-model-collisions).

The following code sample connects all Class.BasePart|BaseParts of a multi‑part model to collision events and tracks the total number of collisions with other parts.

local model = script.Parent

local numTouchingParts = 0

local function onTouched(otherPart)
	-- Ignore instances of the model intersecting with itself
	if otherPart:IsDescendantOf(model) then return end
	-- Increase count of model parts touching
	numTouchingParts += 1

	print(model.Name, "intersected with", otherPart.Name, "| Model parts touching:", numTouchingParts)
end

local function onTouchEnded(otherPart)
	-- Ignore instances of the model un-intersecting with itself
	if otherPart:IsDescendantOf(model) then return end
	-- Decrease count of model parts touching
	numTouchingParts -= 1

	print(model.Name, "un-intersected from", otherPart.Name, "| Model parts touching:", numTouchingParts)
end

for _, child in model:GetChildren() do
	if child:IsA("BasePart") then
		child.Touched:Connect(onTouched)
		child.TouchEnded:Connect(onTouchEnded)
	end
end

Mesh and Solid Model Collisions

Class.MeshPart and Class.PartOperation (parts joined by solid modeling) are subclasses of Class.BasePart, so meshes and solid modeled parts inherit the same collision events and collision filtering options as regular parts. However, since meshes and solid modeled parts usually have more complex geometries, they have a distinctive Class.TriangleMeshPart.CollisionFidelity|CollisionFidelity property which determines how precisely the physical bounds align with the visual representation for collision handling.

The Class.TriangleMeshPart.CollisionFidelity|CollisionFidelity property has the following options, in order of fidelity and performance impact from lowest to highest:

  • Box — Creates a bounding collision box, ideal for small or non‑interactive objects.
  • Hull — Generates a convex hull, suitable for objects with less pronounced indentations or cavities.
  • Default — Produces an approximate collision shape that supports concavity, suitable for complex objects with semi-detailed interaction needs.
  • PreciseConvexDecomposition — Offers the most precise fidelity but still not a 1:1 representation of the visual. This option has the most expensive performance cost and takes longer for the engine to compute.

Original mesh of castle tower

Collision fidelity of Default shown for mesh

Collision fidelity of Box shown for mesh

Collision fidelity of Hull shown for mesh

Collision fidelity of PreciseConvexDecomposition shown for mesh

To view collision fidelity in Studio, toggle on **Collision fidelity** from the [Visualization Options](../studio/ui-overview.md#visualization-options) widget in the upper‑right corner of the 3D viewport.

For more information on the performance impact of collision fidelity options and how to mitigate them, see Performance Optimization. For an in‑depth walkthrough on how to choose a collision fidelity option that balances your precision needs and performance requirements, see here.