<!--
{
  "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/ForceEffectEvent",
  "metadataVersion" : "0.1.0",
  "role" : "Structure",
  "symbol" : {
    "kind" : "Structure",
    "modules" : [
      "RealityKit"
    ],
    "preciseIdentifier" : "s:17RealityFoundation16ForceEffectEventV"
  },
  "title" : "ForceEffectEvent"
}
-->

# ForceEffectEvent

A struct that defines the arguments to the custom force effect update closure.

```
struct ForceEffectEvent<ForceEffectType> where ForceEffectType : ForceEffectProtocol
```

## Overview

If you register your custom force effect using a closure, you can access the force effect’s property and
[`ForceEffectParameters`](/documentation/RealityKit/ForceEffectParameters) from this struct.

## Topics

### Instance Properties

[`var effect: ForceEffectType`](/documentation/RealityKit/ForceEffectEvent/effect)

The force effect to update.

[`var parameters: ForceEffectParameters`](/documentation/RealityKit/ForceEffectEvent/parameters)

Physics body parameters.

---

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)