Guides
These docs are for v2.1.0. Click to read the latest docs for v3.3.0.

ControllerTooltips

Overview

This adds a collection of Object Tooltips to the Controller that give information on what the main controller buttons may do. To add the prefab, it just needs to be added as a child of the relevant controller e.g. [CameraRig]/Controller (right) would add the controller tooltips to the right controller.

If the transforms for the buttons are not provided, then the script will attempt to find the attach transforms on the default controller model in the [CameraRig] prefab.

If no text is provided for one of the elements then the tooltip for that element will be set to disabled.

There are a number of parameters that can be set on the Prefab which are provided by the SteamVR_Unity_Toolkit/Scripts/VRTK_ControllerTooltips script which is applied to the prefab.

Inspector Parameters

  • Trigger Text: The text to display for the trigger button action.
  • Grip Text: The text to display for the grip button action.
  • Touchpad Text: The text to display for the touchpad action.
  • App Menu Text: The text to display for the application menu button action.
  • Tip Background Color: The colour to use for the tooltip background container.
  • Tip Text Color: The colour to use for the text within the tooltip.
  • Tip Line Color: The colour to use for the line between the tooltip and the relevant controller button.
  • Trigger: The transform for the position of the trigger button on the controller (this is usually found in Model/trigger/attach.
  • Grip: The transform for the position of the grip button on the controller (this is usually found in Model/lgrip/attach.
  • Touchpad: The transform for the position of the touchpad button on the controller (this is usually found in Model/trackpad/attach.
  • App Menu: The transform for the position of the app menu button on the controller (this is usually found in Model/button/attach.

Example

SteamVR_Unity_Toolkit/Examples/029_Controller_Tooltips displays two cubes that have an object tooltip added to them along with tooltips that have been added to the controllers.