RealityFoundation · IOS API REFERENCE

CharacterControllerStateComponent

struct · iOS 15.0+ · SDK 27.1

struct CharacterControllerStateComponent

A component that represents the state of a character controller. RealityKit adds this component to an entity when you add a ``CharacterControllerComponent`` instance to it. Manually adding this component to an entity that has a character controller component has no effect because it's redundant.

Members (3)

get · iOS 15.0+

isOnGround

TypeScript

get isOnGround(): boolean

Swift declaration

let isOnGround: Bool

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

get · iOS 15.0+

velocity

TypeScript

get velocity(): SDKHandle

Swift declaration

let velocity: SIMD3<Float>

The linear speed relative to the origin in physics space.

init · iOS 15.0+

init

TypeScript

static init(): CharacterControllerStateComponent

Swift declaration

init()

Skipped declarations

No declarations were skipped in this snapshot.

All RealityFoundation types →