UnrealEngine/Plugin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs formatting fixes

Browse Source
This commit is contained in:
Mamadou Babaei
2026-02-24 13:15:36 +01:00
parent 5a2ddbdd76
commit 36e10bf29a
1 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Handbook/src/advanced-topics/roll-your-own-hand-manipulation-system/sghapticscomponent/README.md
+9 -9
View File
@@ -258,7 +258,7 @@ Checks whether the glove supports **custom waveform vibration** at a specific lo
**Parameters**:
- **AtLocation:** The vibration location to test (e.g., Thumb Tip, Index Tip, Palm Index Side, etc.).
- **At Location:** The vibration location to test (e.g., Thumb Tip, Index Tip, Palm Index Side, etc.).
**Returns:**
@@ -338,7 +338,7 @@ Queues force-feedback levels for **all fingers** at once.
**Parameters:**
- **Levels01:** Array containing the Force-Feedback levels between `0.0` (no FFB) to `1.0` (full FFB); ordered from **Thumb → Index → Middle → Ring → Pinky**.
- **Levels 01:** Array containing the Force-Feedback levels between `0.0` (no FFB) to `1.0` (full FFB); ordered from **Thumb → Index → Middle → Ring → Pinky**.
> [!NOTE]
> Force-feedback value behavior:
@@ -362,7 +362,7 @@ Queues force-feedback on a **particular finger** to a specific level.
**Parameters:**
- **Finger:** Index of the finger; indexed from **Thumb → Index → Middle → Ring → Pinky**.
- **Level01:** Value clamped between `0.0` (no FFB) to `1.0` (full FFB).
- **Level 01:** Value clamped between `0.0` (no FFB) to `1.0` (full FFB).
> [!NOTE]
> Force-feedback value behavior:
@@ -397,7 +397,7 @@ Queues continuous vibrotactile levels for **all fingers** at once to a set ampli
**Parameters:**
- **Levels01:** Array containing the vibro levels between `0.0` (no vibration) to `1.0` (full vibration); ordered from **Thumb → Index → Middle → Ring → Pinky**.
- **Levels 01:** Array containing the vibro levels between `0.0` (no vibration) to `1.0` (full vibration); ordered from **Thumb → Index → Middle → Ring → Pinky**.
> [!NOTE]
> Force-feedback value behavior:
@@ -465,8 +465,8 @@ Queues a wrist-squeeze feedback at the desired level, and optionally if chosen,
**Parameters:**
- **SqueezeLevel01:** Value clamped between `0.0` (no squeeze) to `1.0` (full squeeze).
- **bSendImmediate** If set to `true`, immediately sends the command, otherwise only queues until `Send Haptics` function is called.
- **Squeeze Level 01:** Value clamped between `0.0` (no squeeze) to `1.0` (full squeeze).
- **Send Immediate** If set to `true`, immediately sends the command, otherwise only queues until `Send Haptics` function is called.
> [!NOTE]
> Wrist-squeeze value behavior:
@@ -475,7 +475,7 @@ Queues a wrist-squeeze feedback at the desired level, and optionally if chosen,
> - `1.0` = Full squeeze.
> [!CAUTION]
> Avoid using `SendImmediate` unless necessary.
> Avoid using `Send Immediate` unless necessary.
>
> For optimal performance, queue all haptic commands first and call the
> `Send Haptics` function once after all commands are prepared.
@@ -544,10 +544,10 @@ 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.
Because `Send Immediate` is enabled, the squeeze is transmitted instantly instead of being queued.
> [!CAUTION]
> Avoid using `SendImmediate` unless necessary.
> Avoid using `Send Immediate` unless necessary.
>
> For optimal performance, queue all haptic commands first and call the
> `Send Haptics` function once after all commands are prepared.