Click or drag to resize

POITooltipSpawn Class

Use this to create a POI Tooltip as a child of the GameObject this component is on
Inheritance Hierarchy
SystemObject
  UnityEngine.Object
    UnityEngine.Component
      UnityEngine.Behaviour
        UnityEngine.MonoBehaviour
          ImmerseSDK.UIPOITooltipSpawn

Namespace:  ImmerseSDK.UI
Assembly:  ImmerseSDK.App (in ImmerseSDK.App.dll) Version: 3.9.0.0 (3.9.0.0)
Syntax
C#
Copy
[HelpURLAttribute("https://immerse.readme.io/")]
public class POITooltipSpawn : UnityEngine.MonoBehaviour

The POITooltipSpawn type exposes the following members.

Constructors
  NameDescription
Public methodPOITooltipSpawn
Initializes a new instance of the POITooltipSpawn class
Top
Methods
  NameDescription
Protected methodAwake
Public methodSetEnabled
Enable the tooltip (show it) or hide the tooltip
Top
Fields
  NameDescription
Private field_autoDetectTransformSyncPivot
If true, and no pivot is set, we will try to find the parent TransformSync (if one exists) and set that as the pivot
Private field_autoHideIntervalInSeconds
Number of seconds to wait before hiding the tooltip automatically. Set to 0 (Default) which disables this feature
Private field_maxDistanceInMeters
Maximum total distance in meters. This should be larger than _maxDistanceForTooltip. At distance > _maxDistanceForTooltip and distance < _maxDistanceForTooltip, the arrow is displayed At distance < _maxDistanceForTooltip the tooltip is displayed and the arrow hidden
Private field_maxDistanceInMetersForTooltip
Maximum distance in meters before showing the tooltip. This should be less than _maxDistanceInMeters. At distance > _maxDistanceForTooltip and distance < _maxDistanceForTooltip, the arrow is displayed At distance < _maxDistanceForTooltip the tooltip is displayed and the arrow hidden
Private field_noInteractionPeriodForShow
Number of seconds with no interactions to trigger the display of the tooltip. Set to 0 (Default) which disables this feature
Private field_numberOfTimesToShowTooltip
Number of times to show the tooltip. Set to 0 (Default) which disables this feature
Private field_pivot
Pivot to use for the tooltip. Set this to the TransformSync if the tooltip relates to a pickup. If none is supplied, the tooltip will not "float" above the tracjed object.
Private field_startEnabled
Should the tooltip start disabled (hidden)?
Private field_tint
Color to tint the images with
Private field_tooltipText
Text to display
Private field_verboseLoggingInEditor
EDITOR ONLY: do verbose logging for this object
Top
Extension Methods
  NameDescription
Public Extension MethodGetCopyOf
Copies all properties of a component from source to target. Uses reflection to set properties.
(Defined by ComponentExtensions.)
Public Extension MethodWaitForT
Waits for a singleton on a coroutine
(Defined by SingletonManager.)
Top
See Also