Class UsesSetTooltipVisibilityMethods
Namespace: Unity.Labs.EditorXR.Interfaces
Syntax
public static class UsesSetTooltipVisibilityMethodsMethods
HideTooltip(IUsesSetTooltipVisibility, ITooltip, Boolean)
Hide the given Tooltip
Declaration
public static void HideTooltip(this IUsesSetTooltipVisibility user, ITooltip tooltip, bool persistent = false)Parameters
| Type | Name | Description |
|---|---|---|
| IUsesSetTooltipVisibility | user | The functionality user |
| ITooltip | tooltip | The tooltip to hide |
| Boolean | persistent | Whether to hide the tooltip if it was shown with the persistent argument set to true |
ShowTooltip(IUsesSetTooltipVisibility, ITooltip, Boolean, Single, ITooltipPlacement, Action)
Show a Tooltip. Calling ShowTooltip on an ITooltip that was just shown will update its placement and timing
Declaration
public static void ShowTooltip(this IUsesSetTooltipVisibility user, ITooltip tooltip, bool persistent = false, float duration = 0F, ITooltipPlacement placement = null, Action becameVisible = null)Parameters
| Type | Name | Description |
|---|---|---|
| IUsesSetTooltipVisibility | user | The functionality user |
| ITooltip | tooltip | The tooltip to show |
| Boolean | persistent | Whether the tooltip should stay visible regardless of raycasts |
| Single | duration | If the tooltip is shown persistently, and duration is less than 0, hide after the duration, in seconds. If duration greater than 0, placement is updated but timing is not affected. If duration is exactly 0, tooltip stays visible until explicitly hidden |
| ITooltipPlacement | placement | (Optional) The ITooltipPlacement object used to place the tooltip. If no placement is specified, we assume the ITooltip is a component and use its own Transform |
| Action | becameVisible | (Optional) Called as soon as the tooltip becomes visible |