Capsule Shape Component

The Capsule Shape component creates a transparent capsule that’s oriented on the local Z axis. The dimensions of the capsule can be edited with the Height and Radius properties. The Capsule Shape component is not a mesh, but rather a helper geometry that can be used to define volumes for area lights, shape gradients, audio, vegetation, PhysX, and any application that can utilize the Shape EBus. For more information on using Shape components, see Shape components .

Provider

O3DE Core (LmbrCentral) Gem

Capsule Shape properties

Capsule Shape component properties

Property	Description	Values	Default
Visible	Enable to always display the shape in the viewport, even when the entity is not selected. Disable to hide the shape when the entity is not selected.	Boolean	`Enabled`
Game View	Enable to display the shape while in game mode.	Boolean	`Disabled`
Filled	Enable to display the shape as filled. Disable to display the shape as a wireframe.	Boolean	`Enabled`
Shape Color	The color of the shape.	Eight bits per channel color: 0-255	`255,255,199`
Height	The height of the shape in meters. The height value must be at least twice the value of Radius.	0.0 to Infinity	`1.0`
Radius	The radius of the shape in meters. The radius value must be no more than half the value of Height.	0.0 to Infinity	`0.25`

CapsuleShapeComponentRequestsBus

Use the following request functions with the CapsuleShapeComponentRequestsBus EBus interface to communicate with Capsule Shape components in your game.

Request Name	Description	Parameter	Return	Scriptable
`GetCapsuleConfiguration`	Returns the configuration of the capsule shape.	None	`CapsuleShapeConfig` object that contains the properties `Height` and `Radius`.	Yes
`SetHeight`	Sets the Height of the capsule shape.	Height: Float	None	Yes
`SetRadius`	Sets the Radius of the capsule shape.	Radius: Float	None	Yes

Refer to Shape component Ebus interface for a description of functions that are available to all Shape components.