> For the complete documentation index, see [llms.txt](https://kinematicsoup.gitbook.io/reactor/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://kinematicsoup.gitbook.io/reactor/api-reference/ks.reactor.server/ks.reactor.server.kscapsulecollider.md).

# Class ksCapsuleCollider

Namespace: [KS.Reactor.Server](/reactor/api-reference/ks.reactor.server.md)\
Assembly: KSReactor.dll

Capsule-shaped primitive collider.

```csharp
public sealed class ksCapsuleCollider : ksShapeCollider, ksScript<ksIServerEntity, ksServerEntityScript>.IInternals, ksICollider
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ← ksScript\<ksIServerEntity, ksServerEntityScript> ← [ksServerEntityScript](/reactor/api-reference/ks.reactor.server/ks.reactor.server.ksserverentityscript.md) ← [ksCollider](/reactor/api-reference/ks.reactor.server/ks.reactor.server.kscollider.md) ← [ksShapeCollider](/reactor/api-reference/ks.reactor.server/ks.reactor.server.ksshapecollider.md) ← [ksCapsuleCollider](/reactor/api-reference/ks.reactor.server/ks.reactor.server.kscapsulecollider.md)

#### Implements

ksScript\<ksIServerEntity, ksServerEntityScript>.IInternals, ksICollider

#### Inherited Members

[ksShapeCollider.PhysXShape](/reactor/api-reference/ks.reactor.server/ks.reactor.server.ksshapecollider.md#KS_Reactor_Server_ksShapeCollider_PhysXShape), [ksShapeCollider.UseEntityPhysicsMaterial](/reactor/api-reference/ks.reactor.server/ks.reactor.server.ksshapecollider.md#KS_Reactor_Server_ksShapeCollider_UseEntityPhysicsMaterial), [ksShapeCollider.Material](/reactor/api-reference/ks.reactor.server/ks.reactor.server.ksshapecollider.md#KS_Reactor_Server_ksShapeCollider_Material), [ksShapeCollider.IsQueryCollider](/reactor/api-reference/ks.reactor.server/ks.reactor.server.ksshapecollider.md#KS_Reactor_Server_ksShapeCollider_IsQueryCollider), [ksShapeCollider.IsSimulationCollider](/reactor/api-reference/ks.reactor.server/ks.reactor.server.ksshapecollider.md#KS_Reactor_Server_ksShapeCollider_IsSimulationCollider), [ksShapeCollider.IsTrigger](/reactor/api-reference/ks.reactor.server/ks.reactor.server.ksshapecollider.md#KS_Reactor_Server_ksShapeCollider_IsTrigger), [ksShapeCollider.CollisionFilter](/reactor/api-reference/ks.reactor.server/ks.reactor.server.ksshapecollider.md#KS_Reactor_Server_ksShapeCollider_CollisionFilter), [ksShapeCollider.Bounds](/reactor/api-reference/ks.reactor.server/ks.reactor.server.ksshapecollider.md#KS_Reactor_Server_ksShapeCollider_Bounds), [ksShapeCollider.IsEnabled](/reactor/api-reference/ks.reactor.server/ks.reactor.server.ksshapecollider.md#KS_Reactor_Server_ksShapeCollider_IsEnabled), [ksShapeCollider.ContactOffset](/reactor/api-reference/ks.reactor.server/ks.reactor.server.ksshapecollider.md#KS_Reactor_Server_ksShapeCollider_ContactOffset), [ksShapeCollider.RestOffset](/reactor/api-reference/ks.reactor.server/ks.reactor.server.ksshapecollider.md#KS_Reactor_Server_ksShapeCollider_RestOffset), [ksShapeCollider.MinTorsionalPatchRadius](/reactor/api-reference/ks.reactor.server/ks.reactor.server.ksshapecollider.md#KS_Reactor_Server_ksShapeCollider_MinTorsionalPatchRadius), [ksShapeCollider.TorsionalPatchRadius](/reactor/api-reference/ks.reactor.server/ks.reactor.server.ksshapecollider.md#KS_Reactor_Server_ksShapeCollider_TorsionalPatchRadius), [ksShapeCollider.Offset](/reactor/api-reference/ks.reactor.server/ks.reactor.server.ksshapecollider.md#KS_Reactor_Server_ksShapeCollider_Offset), [ksShapeCollider.Rotation](/reactor/api-reference/ks.reactor.server/ks.reactor.server.ksshapecollider.md#KS_Reactor_Server_ksShapeCollider_Rotation), [ksShapeCollider.ScaledOffset](/reactor/api-reference/ks.reactor.server/ks.reactor.server.ksshapecollider.md#KS_Reactor_Server_ksShapeCollider_ScaledOffset), [ksShapeCollider.ShapeType](/reactor/api-reference/ks.reactor.server/ks.reactor.server.ksshapecollider.md#KS_Reactor_Server_ksShapeCollider_ShapeType), [ksShapeCollider.Attached()](/reactor/api-reference/ks.reactor.server/ks.reactor.server.ksshapecollider.md#KS_Reactor_Server_ksShapeCollider_Attached), [ksShapeCollider.Detached()](/reactor/api-reference/ks.reactor.server/ks.reactor.server.ksshapecollider.md#KS_Reactor_Server_ksShapeCollider_Detached), [ksShapeCollider.Clone()](/reactor/api-reference/ks.reactor.server/ks.reactor.server.ksshapecollider.md#KS_Reactor_Server_ksShapeCollider_Clone), [ksCollider.UseEntityCollisionFilter](/reactor/api-reference/ks.reactor.server/ks.reactor.server.kscollider.md#KS_Reactor_Server_ksCollider_UseEntityCollisionFilter), [ksCollider.IsQueryCollider](/reactor/api-reference/ks.reactor.server/ks.reactor.server.kscollider.md#KS_Reactor_Server_ksCollider_IsQueryCollider), [ksCollider.IsSimulationCollider](/reactor/api-reference/ks.reactor.server/ks.reactor.server.kscollider.md#KS_Reactor_Server_ksCollider_IsSimulationCollider), [ksCollider.IsTrigger](/reactor/api-reference/ks.reactor.server/ks.reactor.server.kscollider.md#KS_Reactor_Server_ksCollider_IsTrigger), [ksCollider.CollisionFilter](/reactor/api-reference/ks.reactor.server/ks.reactor.server.kscollider.md#KS_Reactor_Server_ksCollider_CollisionFilter), [ksCollider.Bounds](/reactor/api-reference/ks.reactor.server/ks.reactor.server.kscollider.md#KS_Reactor_Server_ksCollider_Bounds), [ksCollider.IsEnabled](/reactor/api-reference/ks.reactor.server/ks.reactor.server.kscollider.md#KS_Reactor_Server_ksCollider_IsEnabled), [ksCollider.ContactOffset](/reactor/api-reference/ks.reactor.server/ks.reactor.server.kscollider.md#KS_Reactor_Server_ksCollider_ContactOffset), [ksCollider.Offset](/reactor/api-reference/ks.reactor.server/ks.reactor.server.kscollider.md#KS_Reactor_Server_ksCollider_Offset), [ksCollider.Clone()](/reactor/api-reference/ks.reactor.server/ks.reactor.server.kscollider.md#KS_Reactor_Server_ksCollider_Clone), [ksServerEntityScript.Entity](/reactor/api-reference/ks.reactor.server/ks.reactor.server.ksserverentityscript.md#KS_Reactor_Server_ksServerEntityScript_Entity), [ksServerEntityScript.Room](/reactor/api-reference/ks.reactor.server/ks.reactor.server.ksserverentityscript.md#KS_Reactor_Server_ksServerEntityScript_Room), [ksServerEntityScript.Time](/reactor/api-reference/ks.reactor.server/ks.reactor.server.ksserverentityscript.md#KS_Reactor_Server_ksServerEntityScript_Time), [ksServerEntityScript.Physics](/reactor/api-reference/ks.reactor.server/ks.reactor.server.ksserverentityscript.md#KS_Reactor_Server_ksServerEntityScript_Physics), [ksServerEntityScript.Properties](/reactor/api-reference/ks.reactor.server/ks.reactor.server.ksserverentityscript.md#KS_Reactor_Server_ksServerEntityScript_Properties), [ksServerEntityScript.Transform](/reactor/api-reference/ks.reactor.server/ks.reactor.server.ksserverentityscript.md#KS_Reactor_Server_ksServerEntityScript_Transform), [ksServerEntityScript.Transform2D](/reactor/api-reference/ks.reactor.server/ks.reactor.server.ksserverentityscript.md#KS_Reactor_Server_ksServerEntityScript_Transform2D), ksScript\<ksIServerEntity, ksServerEntityScript>.InstanceType, ksScript\<ksIServerEntity, ksServerEntityScript>.IsAttached, ksScript\<ksIServerEntity, ksServerEntityScript>.Scripts, ksScript\<ksIServerEntity, ksServerEntityScript>.Assets, ksScript\<ksIServerEntity, ksServerEntityScript>.Attached(), ksScript\<ksIServerEntity, ksServerEntityScript>.Initialize(), ksScript\<ksIServerEntity, ksServerEntityScript>.Detached(), ksScript\<ksIServerEntity, ksServerEntityScript>.Clone(), [object.Equals(object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object\)), [object.Equals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object-system-object\)), [object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode), [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype), [object.ReferenceEquals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals), [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Constructors

### ksCapsuleCollider() <a href="#ks_reactor_server_kscapsulecollider__ctor" id="ks_reactor_server_kscapsulecollider__ctor"></a>

Constructor.

```csharp
public ksCapsuleCollider()
```

### ksCapsuleCollider(pxCapsule) <a href="#ks_reactor_server_kscapsulecollider__ctor_ks_reactor_server_physx_pxcapsule" id="ks_reactor_server_kscapsulecollider__ctor_ks_reactor_server_physx_pxcapsule"></a>

Constructor.

```csharp
public ksCapsuleCollider(pxCapsule capsule)
```

#### Parameters

`capsule` [pxCapsule](/reactor/api-reference/ks.reactor.server.physx/ks.reactor.server.physx.pxcapsule.md)

PhysX capsule geometry to create the capsule collider with.

## Properties

### AxisRotation <a href="#ks_reactor_server_kscapsulecollider_axisrotation" id="ks_reactor_server_kscapsulecollider_axisrotation"></a>

Gets the rotation with axis applied.

```csharp
public ksQuaternion AxisRotation { get; }
```

#### Property Value

ksQuaternion

### Direction <a href="#ks_reactor_server_kscapsulecollider_direction" id="ks_reactor_server_kscapsulecollider_direction"></a>

The direction of the capsule.

```csharp
public ksCapsuleCollider.Axis Direction { get; set; }
```

#### Property Value

[ksCapsuleCollider](/reactor/api-reference/ks.reactor.server/ks.reactor.server.kscapsulecollider.md).[Axis](/reactor/api-reference/ks.reactor.server/ks.reactor.server.kscapsulecollider/ks.reactor.server.kscapsulecollider.axis.md)

### Height <a href="#ks_reactor_server_kscapsulecollider_height" id="ks_reactor_server_kscapsulecollider_height"></a>

The height of the capsule measured in the object's local space.

```csharp
public float Height { get; set; }
```

#### Property Value

[float](https://learn.microsoft.com/dotnet/api/system.single)

### Radius <a href="#ks_reactor_server_kscapsulecollider_radius" id="ks_reactor_server_kscapsulecollider_radius"></a>

The radius of the sphere, measured in the object's local space.

```csharp
public float Radius { get; set; }
```

#### Property Value

[float](https://learn.microsoft.com/dotnet/api/system.single)

### Rotation <a href="#ks_reactor_server_kscapsulecollider_rotation" id="ks_reactor_server_kscapsulecollider_rotation"></a>

Rotation.

```csharp
public override ksQuaternion Rotation { set; }
```

#### Property Value

ksQuaternion

### ScaledHeight <a href="#ks_reactor_server_kscapsulecollider_scaledheight" id="ks_reactor_server_kscapsulecollider_scaledheight"></a>

Height of the capsule after applying the attached entity transform scale.

```csharp
public float ScaledHeight { get; }
```

#### Property Value

[float](https://learn.microsoft.com/dotnet/api/system.single)

### ScaledRadius <a href="#ks_reactor_server_kscapsulecollider_scaledradius" id="ks_reactor_server_kscapsulecollider_scaledradius"></a>

Radius of the capsule after applying the attached entity transform scale.

```csharp
public float ScaledRadius { get; }
```

#### Property Value

[float](https://learn.microsoft.com/dotnet/api/system.single)

## Methods

### Clone() <a href="#ks_reactor_server_kscapsulecollider_clone" id="ks_reactor_server_kscapsulecollider_clone"></a>

Creates a copy of the collider.

```csharp
public override ksServerEntityScript Clone()
```

#### Returns

[ksServerEntityScript](/reactor/api-reference/ks.reactor.server/ks.reactor.server.ksserverentityscript.md)

Cloned collider.

### ScaleGeometry() <a href="#ks_reactor_server_kscapsulecollider_scalegeometry" id="ks_reactor_server_kscapsulecollider_scalegeometry"></a>

Creates new geometry for the shape with entity scaling applied.

```csharp
protected override sealed void ScaleGeometry()
```