<!--
{
  "availability" : [
    "iOS: 15.0.0 -",
    "iPadOS: 15.0.0 -",
    "macCatalyst: 15.0.0 -",
    "macOS: 12.0.0 -",
    "tvOS: 26.0.0 -",
    "visionOS: -"
  ],
  "documentType" : "symbol",
  "framework" : "RealityKit",
  "identifier" : "/documentation/RealityKit/CharacterControllerStateComponent",
  "metadataVersion" : "0.1.0",
  "role" : "Structure",
  "symbol" : {
    "kind" : "Structure",
    "modules" : [
      "RealityKit"
    ],
    "preciseIdentifier" : "s:17RealityFoundation33CharacterControllerStateComponentV"
  },
  "title" : "CharacterControllerStateComponent"
}
-->

# CharacterControllerStateComponent

A component that represents the state of a character controller.

```
struct CharacterControllerStateComponent
```

## Overview

RealityKit adds this component to an entity when you add a [`CharacterControllerComponent`](/documentation/RealityKit/CharacterControllerComponent) instance to it.
Manually adding this component to an entity that has a character controller component has no effect because it’s redundant.

## Topics

### Creating a state component

[`init()`](/documentation/RealityKit/CharacterControllerStateComponent/init())

### Accessing character controller state

[`let isOnGround: Bool`](/documentation/RealityKit/CharacterControllerStateComponent/isOnGround)

A Boolean value that indicates whether the character controller is on the ground.

[`let velocity: SIMD3<Float>`](/documentation/RealityKit/CharacterControllerStateComponent/velocity)

The linear speed relative to the origin in physics space.

## Relationships

### Conforms To

[`Component`](/documentation/RealityKit/Component)

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)