add a caution regarding bSendImmediate and batching SendHaptics

This commit is contained in:
Mamadou Babaei
2026-02-23 17:06:09 +01:00
parent 0167485caf
commit a24e9985be
@@ -474,6 +474,16 @@ Queues a wrist-squeeze feedback at the desired level, and optionally if chosen,
> - `0.0` = No squeeze.
> - `1.0` = Full squeeze.
> [!CAUTION]
> Avoid using `SendImmediate` unless necessary.
>
> For optimal performance, queue all haptic commands first and call the
> `Send Haptics` function once after all commands are prepared.
>
> Sending commands immediately increases device communication frequency and
> computational overhead. Batching commands using `Send Haptics` reduces
> processing cost and improves performance.
**Returns:**
- `true`: If queued successfully.
@@ -535,3 +545,13 @@ This example demonstrates:
![SGHapticsComponent - Blueprint example: Wrist-squeeze](sghapticscomponent-blueprint-example-wrist-squeeze.png "SGHapticsComponent - Blueprint example: Wrist-squeeze")
Because `bSendImmediate` is enabled, the squeeze is transmitted instantly instead of being queued.
> [!CAUTION]
> Avoid using `SendImmediate` unless necessary.
>
> For optimal performance, queue all haptic commands first and call the
> `Send Haptics` function once after all commands are prepared.
>
> Sending commands immediately increases device communication frequency and
> computational overhead. Batching commands using `Send Haptics` reduces
> processing cost and improves performance.