Blueprints
Generated from UBhapticsSDK2.
Targets of all nodes are "Bhaptics SDK2".
Functions for Playing Event-driven Haptic
Play the haptic patterns bound to specific haptic event made from Designer/Portal. We highly recommend to use these functions.
Play Haptic
Play the haptic event. It is the most basic way to call a haptic event. It has the lowest overhead of any haptic event-calling function.
Inputs
| Type | Name | Description |
|---|---|---|
| exec | In | |
| String | Event Id | Name of haptic event which you want to play. |
Outputs
| Type | Name | Description |
|---|---|---|
| exec | Out | |
| Integer | Return Value | Request ID. You can use the request ID to stop the haptic. It returns -1 if the return fails. |
Play Haptic With Option
Play haptic event, with adjusting the strength, duration, and direction of the haptic.
Inputs
| Type | Name | Description |
|---|---|---|
| exec | In | |
| String | Event Id | Name of haptic event which you want to play. |
| Float | Intensity | The haptic intensity is multiplied by this value. |
| Float | Duration | The haptic duration is multiplied by this value. |
| Float | Angle X | Rotate haptic counterclockwise around the global Vector3.up. Valid range is: [0.0f - 360.0f] |
| Float | Offset Y | Move haptic up or down. Valid range is: [-0.5f - 0.5f] |
Outputs
| Type | Name | Description |
|---|---|---|
| exec | Out | |
| Integer | Return Value | Request ID. You can use the request ID to stop the haptic. It returns -1 if the return fails. |
Play Haptic With StartTime
Play haptic event from a given start position, with adjusting the strength, duration, and direction of the haptic.
Inputs
| Type | Name | Description |
|---|---|---|
| exec | In | |
| String | Event Id | Name of haptic event which you want to play. |
| Integer | Start Millis | Playback start position in milliseconds. The first Start Millis milliseconds of the event are skipped (this is a start offset, not a delay before playback). Windows/macOS/Android only. |
| Float | Intensity | The haptic intensity is multiplied by this value. |
| Float | Duration | The haptic duration is multiplied by this value. |
| Float | Angle X | Rotate haptic counterclockwise around the global Vector3.up. Valid range is: [0.0f - 360.0f] |
| Float | Offset Y | Move haptic up or down. Valid range is: [-0.5f - 0.5f] |
Outputs
| Type | Name | Description |
|---|---|---|
| exec | Out | |
| Integer | Return Value | Request ID. You can use the request ID to stop the haptic. It returns -1 if the return fails. |
Play Loop
Play the haptic repeatedly. Additionally, like the function PlayHapticWithOption, you can adjust the strength, duration, and direction of the haptic.
Inputs
| Type | Name | Description |
|---|---|---|
| exec | In | |
| String | Event Id | Name of haptic event which you want to play. |
| Float | Intensity | The haptic intensity is multiplied by this value. |
| Float | Duration | The haptic duration is multiplied by this value. |
| Float | Angle X | Rotate haptic counterclockwise around the global Vector3.up. Valid range is: [0.0f - 360.0f] |
| Float | Offset Y | Move haptic up or down. Valid range is: [-0.5f - 0.5f] |
| Integer | Interval | The time interval between loops, measured in milliseconds. |
| Integer | Max Count | The number of loops. |
Outputs
| Type | Name | Description |
|---|---|---|
| exec | Out | |
| Integer | Return Value | Request ID. You can use the request ID to stop the haptic. It returns -1 if the return fails. |
Functions for Playing Haptic Directly
If you want to play haptics without creating a new event, use these functions.
Play Dot
Play haptic feedback on the specific haptic actuator. You can use this function without creating an event.
Inputs
| Type | Name | Description |
|---|---|---|
| exec | In | |
| Integer | Position | Type of haptic device. |
| Array of Integers | Motor Values | Assign the length of the array by the number of motors for device. Values in the array means motors' intensity. Valid range for each value in the array is: [0 - 100] |
| Float | Seconds | The duration of haptic, measured in second. Greater than or equal to 0.1f is recommended. |
-
Position
Value Device 0 TactSuit Pro 1 TactSleeve(Left) 2 TactSleeve(Right) 3 TactVisor 4 Tactosy for Hands(Left) 5 Tactosy for Hands(Right) 6 Tactosy for Feet(Left) 7 Tactosy for Feet(Right) 8 TactGlove(Left) 9 TactGlove(Right)
Outputs
| Type | Name | Description |
|---|---|---|
| exec | Out | |
| Integer | Return Value | Request ID. You can use the request ID to stop the haptic. It returns -1 if the return fails. |
Play Path
Play haptic around specific coordinates. See C++ API Reference for more information.
[TactGlove DK3] Play Path does not drive the wrist voice-coil motor (VCM) on a DK3 glove.
Inputs
| Type | Name | Description |
|---|---|---|
| exec | In | |
| Integer | Position | Type of haptic device. |
| Array of Floats | X | Assign X coordinate. Valid range for each value in the array is: [0.0f - 1.0f] |
| Array of Floats | Y | Assign Y coordinate. Valid range for each value in the array is: [0.0f - 1.0f] |
| Array of Integers | Motor Values | Assign the length of the array by the number of motors for device. Values in the array means motors' intensity. Valid range for each value in the array is: [0 - 100] |
| Float | Seconds | The duration of haptic, measured in second. Greater than or equal to 0.1f is recommended. |
-
Position
Value Device 0 TactSuit Pro 1 TactSleeve(Left) 2 TactSleeve(Right) 3 TactVisor 4 Tactosy for Hands(Left) 5 Tactosy for Hands(Right) 6 Tactosy for Feet(Left) 7 Tactosy for Feet(Right) 8 TactGlove(Left) 9 TactGlove(Right)
Outputs
| Type | Name | Description |
|---|---|---|
| exec | Out | |
| Integer | Return Value | Request ID. You can use the request ID to stop the haptic. It returns -1 if the return fails. |
Play Waveform
TactGlove Only. Play haptics in TactGlove. Unlike using "Play Dot", you can finely adjust haptic duration and vibration intensity changes. This allows for even finer expression of haptic feedback.
Each array must have six (TactGlove DK2) or eight (TactGlove DK3) elements, and all three arrays must have the same length.
Inputs
| Type | Name | Description |
|---|---|---|
| exec | In | |
| Integer | Position | Type of haptic device. |
| Array of Integers | Motor Intensities | An array of motor intensities. Its length must match the number of motors in the TactGlove: six (TactGlove DK2) or eight (TactGlove DK3). Valid range for each value in the array is: [0 - 100] |
| Array of EBhapticsGlovePlayTime Enums | Play Time Values | An array with the same length as Motor Intensities (six for DK2, eight for DK3), each representing a time interval for actuation, with time defined using EBhapticsGlovePlayTime enums. |
| Array of EBhapticsGloveShapeValue Enums | Shape Values | An array with the same length as Motor Intensities (six for DK2, eight for DK3), each representing the forms of haptic intensity changes over time, specified by the EBhapticsGloveShapeValue enums. |
| Integer | Frequency | [TactGlove DK3 only] Vibration frequency in Hz of the DK3 glove's own actuators. The default is 80. It has no effect on DK2 gloves or on the universal (non-Windows/macOS) path. Windows/macOS only. |
| Integer | Repeat Count | Number of times to repeat the waveform, from 1. 0 plays it once. Windows/macOS only. |
-
Position
Value Device 8 TactGlove(Left) 9 TactGlove(Right) -
Motor Intensities
Array Index Motor is positioned at… 0 Tip of the thumb 1 Tip of the index finger 2 Tip of the middle finger 3 Tip of the ring finger 4 Tip of the little finger 5 On the wrist 6 On the palm (thumb side) 7 On the palm (little finger side) -
Play Time Values
Value Duration Same as… EBhapticsGlovePlayTime::None None 0 EBhapticsGlovePlayTime::FiveMS 5ms 1 EBhapticsGlovePlayTime::TenMS 10ms 2 EBhapticsGlovePlayTime::TwentyMS 20ms 4 EBhapticsGlovePlayTime::ThirtyMS 30ms 6 EBhapticsGlovePlayTime::FortyMS 40ms 8 -
Shape Values
Value Waveform Same as… EBhapticsGloveShapeValue::Constant Constant intensity for the duration 0 EBhapticsGloveShapeValue::Decreasing Starts at the specified intensity and decreases by half 1 EBhapticsGloveShapeValue::Increasing Starts at half of the specified intensity and increases to the specified one. 2
Outputs
| Type | Name | Description |
|---|---|---|
| exec | Out | |
| Integer | Return Value | Request ID. You can use the request ID to stop the haptic. It returns -1 if the return fails. |
The Other Functions
Stop Haptic By Event Id
Stop the haptic event by Event ID. Returns whether the stop was successful.
Inputs
| Type | Name | Description |
|---|---|---|
| exec | In | |
| String | Event Id | Name of haptic event which you want to stop. |
Outputs
| Type | Name | Description |
|---|---|---|
| exec | Out | |
| Boolean | Return Value | Whether the stop was successful. |
Stop Haptic By Request Id
Stop the Haptic Event by using the Request ID from the return of the function that executes the haptic. Returns whether the stop was successful.
Inputs
| Type | Name | Description |
|---|---|---|
| exec | In | |
| Integer | Request Id | Request ID of playing haptic event which you want to stop. |
Outputs
| Type | Name | Description |
|---|---|---|
| exec | Out | |
| Boolean | Return Value | Whether the stop was successful. |
Stop Haptic
Stops all haptic currently playing. Returns whether the stop was successful.
Inputs
| Type | Name | Description |
|---|---|---|
| exec | In |
Outputs
| Type | Name | Description |
|---|---|---|
| exec | Out | |
| Boolean | Return Value | Whether the stop was successful. |
Pause Haptic By Event Id
Pause the haptic event by Event ID. The playback position is held so it can be continued later with "Resume Haptic By Event Id".
Inputs
| Type | Name | Description |
|---|---|---|
| exec | In | |
| String | Event Id | Name of haptic event which you want to pause. |
Outputs
| Type | Name | Description |
|---|---|---|
| exec | Out |
Resume Haptic By Event Id
Resume a haptic event previously paused with "Pause Haptic By Event Id", continuing from the position where it was paused.
Inputs
| Type | Name | Description |
|---|---|---|
| exec | In | |
| String | Event Id | Name of haptic event which you want to resume. |
Outputs
| Type | Name | Description |
|---|
Is Playing
Check if the haptic is playing.
Inputs
| Type | Name | Description |
|---|---|---|
| exec | In |
Outputs
| Type | Name | Description |
|---|---|---|
| exec | Out | |
| Boolean | Return Value | Whether the event is playing. |
Is Playing By Event Id
Check if the haptic event for this Event ID is playing.
Inputs
| Type | Name | Description |
|---|---|---|
| exec | In | |
| String | Event Id | Name of haptic event to check if it is currently playing. |
Outputs
| Type | Name | Description |
|---|---|---|
| exec | Out | |
| Boolean | Return Value | Whether the event is playing. |
Is Playing By Request Id
Check if the haptic event for this Request ID is playing.
Inputs
| Type | Name | Description |
|---|---|---|
| exec | In | |
| Integer | Request Id | Request ID of haptic event to check if it is currently playing. |
Outputs
| Type | Name | Description |
|---|---|---|
| exec | Out | |
| Boolean | Return Value | Whether the event is playing. |
Initialize bHaptics
Initialize the haptic environment. This function should be called before using the haptic-related functions.
Inputs
| Type | Name | Description |
|---|---|---|
| exec | In |
Outputs
| Type | Name | Description |
|---|---|---|
| exec | Out |
Ping
Send simple haptic feedback to certain device.
Inputs
| Type | Name | Description |
|---|---|---|
| exec | In | |
| Bhaptics Device Structure | Device | Device you want to send ping. |
Outputs
| Type | Name | Description |
|---|---|---|
| exec | Out |
Ping All
Send simple haptic feedback to all connected devices.
Inputs
| Type | Name | Description |
|---|---|---|
| exec | In |
Outputs
| Type | Name | Description |
|---|---|---|
| exec | Out |
Destroy bHaptics
Destroy the haptic environment. This function must be called when game ends, and called ONLY ONCE.
Inputs
| Type | Name | Description |
|---|---|---|
| exec | In |
Outputs
| Type | Name | Description |
|---|---|---|
| exec | Out |
Get bHaptics devices
Get an array of connected haptic devices' info.
Inputs
| Type | Name | Description |
|---|---|---|
| exec | In |
Outputs
| Type | Name | Description |
|---|---|---|
| exec | Out | |
| Array of Bhaptics Device Structures | Return Value | List of devices. |
Is bHaptics Available
Check if the haptic environment is initialized, and ready to use haptic-related functions.
Inputs
| Type | Name | Description |
|---|---|---|
| exec | In |
Outputs
| Type | Name | Description |
|---|---|---|
| exec | Out | |
| Boolean | Return Value | Whether the bHaptics environment is available. |
Project To Vest With Player Collision Object
Helper function to compute the offset values (angle and height) of a given collision contact point from the player. These offset values can be used in PlayHapticWithOption and PlayLoop which can adjust the haptic position.
This function assumes that the forward direction aligns with the front of the vest, and the player's position is considered as the origin.
See C++ API Reference for more information.
Inputs
| Type | Name | Description |
|---|---|---|
| Vector | Contact Location | Contact point in global coordinates. |
| Primitive Component Object Reference | Player Component | Reference to the primitive component attached to the player. |
| Float | Half Height | The half value of the player's actual height, measured in centimeter. |
Outputs
| Type | Name | Description |
|---|---|---|
| Bhaptics Rotation Option Structure | Return Value | Offset values. |
Project To Vest With Player Location/Position
Helper function to compute offset values from a contact location and player transform information. It's similar to "Project To Vest", but it only calculates the angle offset(Offset Angle X). The height(Offset Y) will always be 0.
Inputs
| Type | Name | Description |
|---|---|---|
| Vector | Contact Location | Contact point in global coordinates. |
| Vector | Player Location | Location of the player. |
| Rotator | Player Rotation | Rotation of the player. |
Outputs
| Type | Name | Description |
|---|---|---|
| Bhaptics Rotation Option Structure | Return Value | Offset values. |
Custom Project To Vest
Helper function to compute offset values from collision. Performs the same function as "Project To Vest", but allows the Forward and Up vectors to be changed.
Inputs
| Type | Name | Description |
|---|---|---|
| Vector | Contact Location | Contact point in global coordinates. |
| Primitive Component Object Reference | Player Component | Reference to the primitive component attached to the player. |
| Float | Half Height | The half value of the player's actual height, measured in centimeter. |
| Vector | Up Vector | The reference upward direction vector for offset calculation. |
| Vector | Forward Vector | The reference forward direction vector for offset calculation. |
Outputs
| Type | Name | Description |
|---|---|---|
| Bhaptics Rotation Option Structure | Return Value | Offset values. |