rojo/.cursor/rules/roblox/reference/engine/enums/CollisionFidelity.yaml
2026-02-02 12:08:47 -06:00

48 lines
1.6 KiB
YAML

# This file is automatically generated. Please don't edit it manually.
# To submit a bug report on the content, see
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
name: CollisionFidelity
type: enum
summary: |
Determines behavior of the collision hitbox for `Class.MeshPart` and
`Class.PartOperation` instances.
description: |
Determines behavior of the collision hitbox for `Class.MeshPart` and
`Class.PartOperation` instances. See
[here](../../../workspace/collisions.md#collision-fidelity) for a visual
representation of the various options.
code_samples: []
tags: []
deprecation_message: ''
items:
- name: Default
summary: |
Collision model uses a voxel-based convex-hull decomposition that is
relatively fast but may not be highly accurate, especially for holes,
doorways, and cavities in general.
value: 0
tags: []
deprecation_message: ''
- name: Hull
summary: |
Collision model uses the convex hull of the visual mesh.
value: 1
tags: []
deprecation_message: ''
- name: Box
summary: |
Collision model uses a bounding box that encompasses the visual mesh.
value: 2
tags: []
deprecation_message: ''
- name: PreciseConvexDecomposition
summary: |
Collison model uses a convex-hull decomposition of the visual mesh which
is computed by a variation of an algorithm called HACD. This option is the
most accurate representation of collision geometry for complex objects
with built-in tolerances to reduce the total number of convex-hulls by
compromising on accuracy when justified.
value: 3
tags: []
deprecation_message: ''