Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

CapsuleShape3D

Inherits: Shape3D < Resource < RefCounted < Object

A 3D capsule shape used for physics collision.

Description

A 3D capsule shape, intended for use in physics. Usually used to provide a shape for a CollisionShape3D.

Performance: CapsuleShape3D is fast to check collisions against. It is faster than CylinderShape3D, but slower than SphereShape3D and BoxShape3D.

Tutorials

Properties

float

height

2.0

float

mid_height

float

radius

0.5

Property Descriptions

float height = 2.0 🔗

  • void set_height(value: float)

  • float get_height()

The capsule's full height, including the hemispheres.

float mid_height 🔗

  • void set_mid_height(value: float)

  • float get_mid_height()

The capsule's height, excluding the hemispheres. This is the height of the central cylindrical part in the middle of the capsule, and is the distance between the centers of the two hemispheres. This is a wrapper for height.

float radius = 0.5 🔗

  • void set_radius(value: float)

  • float get_radius()

The capsule's radius.

User-contributed notes

Please read the User-contributed notes policy before submitting a comment.