bHaptics Effects
Below is a list of the bHaptics Effects, what they do, and any information about them. All of them are under the "Common" Effect.
This is used to register a TACT file that was generated using bHaptics Studio. A key needs to be entered (it is not clear if spaces and/or special characters are allowed and there is no protection against it, so recommend not using spaces and/or special characters for now) so it can be submitted later on. The TACT can be imported either by pointing to the TACT file (needs to be .tact) or pasting in the content of the TACT file.
This is how you trigger the bHaptics Suit with the Registered TACT. You must register TACT files as a Key and bHaptics Player must running before setting up this Effect as it generates a list of Registered Keys to trigger. You can also select to submit the key with no modifications, a Scale modification, or a Rotate modification (only works on Vests according to bHaptics).
Please note, there is no built in Delay. If you send 2 submits in the same Effect list, the first on will be submitted and then the second one will be submitted causing them to both run. If you only want one trigger at a time, you will need to add a Delay Effect or setup a Queue.
Intensity refers to how intense the motors vibrate based on the TACT setting. This can only be set from 0.2 to 5 and is a multiplier of the TACT setting.
Duration refers to how long the motors vibrate based on the TACT Settings. This can only be set from 0.2 to 5 and is a multiplier of the TACT setting.
Offset Angle X is referring to the X Axis (left to right) of the Vest. This can be 0 to 365 and plays the TACT with that X Offset (so 180 would play the effect on your back when it was normally played on the front).
Offset Y is referring to the Y Axis (up and down) of the Vest. This can be -0.5 to 0.5 (negative being down and positive being up).
This will stop a specific key if it is currently Active. If it is not Active, this effect will do nothing. Keys must be registered and bHaptics Player running to setup.
This will stop all active keys. There are no settings as part of the Effect.
This will active specific dots on submit. This currently does not work (so it is not visible) and is still a Work in Progress.
This will active specific path of dots on submit. This currently does not work (so it is not visible) and is still a Work in Progress.
Currently, there is no way to remove one registered key through the API. The current way is to disable the Register Effect within a bHaptics Connection Event and restart either Firebot or bHaptics as the disconnection from the API clears out all keys. If a bHaptics Connection Event is used, it will Register the Keys when Firebot connects to bHaptics Player.