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

# ForceEffectParameters

The force effect input data to the effect’s update handler or closure.

```
struct ForceEffectParameters
```

## Topics

### Instance Properties

[`let angularVelocities: UnsafeForceEffectBuffer<SIMD3<Float>>?`](/documentation/RealityKit/ForceEffectParameters/angularVelocities)

The angular velocities of all rigid bodies under the influence of the effect,
or nil if angular velocity information was not requested.

[`let distances: UnsafeForceEffectBuffer<Float>?`](/documentation/RealityKit/ForceEffectParameters/distances)

The distance from the effect to each rigid body’s center of mass,
or nil if distance information was not requested.

[`let elapsedTime: TimeInterval`](/documentation/RealityKit/ForceEffectParameters/elapsedTime)

The amount of time that has elapsed since the force effect was started.

[`let entity: Entity`](/documentation/RealityKit/ForceEffectParameters/entity)

The entity containing the force effect.

[`let fixedDeltaTime: TimeInterval`](/documentation/RealityKit/ForceEffectParameters/fixedDeltaTime)

The fixed delta time between simulation steps.

[`let inertiaTensors: UnsafeForceEffectBuffer<simd_float3x3>?`](/documentation/RealityKit/ForceEffectParameters/inertiaTensors)

The inertia tensor based on the current rigid body’s orientation, or nil if
inertia tensor information was not requested.

[`let masses: UnsafeForceEffectBuffer<Float>?`](/documentation/RealityKit/ForceEffectParameters/masses)

The mass of each rigid body, or nil if mass information was not requested
or force mode does not require it.

[`let orientations: UnsafeForceEffectBuffer<simd_quatf>?`](/documentation/RealityKit/ForceEffectParameters/orientations)

The orientations of all rigid bodies under the influence of the effect,
or nil if rotational information was not requested.

[`let physicsBodyCount: Int`](/documentation/RealityKit/ForceEffectParameters/physicsBodyCount)

The number of physics bodies to be updated.

[`let positions: UnsafeForceEffectBuffer<SIMD3<Float>>?`](/documentation/RealityKit/ForceEffectParameters/positions)

The positions of all rigid bodies under the influence of the effect,
or nil if positional information was not requested.

[`let velocities: UnsafeForceEffectBuffer<SIMD3<Float>>?`](/documentation/RealityKit/ForceEffectParameters/velocities)

The velocities of all rigid bodies under the influence of the effect,
or nil if velocity information was not requested.

### Instance Methods

[`func setForce(SIMD3<Float>, index: Int)`](/documentation/RealityKit/ForceEffectParameters/setForce(_:index:))

Sets the force for each rigid body.

[`func setTorque(SIMD3<Float>, index: Int)`](/documentation/RealityKit/ForceEffectParameters/setTorque(_:index:))

Sets the torque for each rigid body.

---

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)