Inheritance
ToolsMenuButton
public sealed class ToolsMenuButton : MonoBehaviour, IToolsMenuButton, ITooltip, ITooltipPlacement, IUsesSetTooltipVisibility, IFunctionalitySubscriber<IProvidesSetTooltipVisibility>, IUsesFunctionalityInjection, IFunctionalitySubscriber<IProvidesFunctionalityInjection>, IFunctionalitySubscriber
Properties
Declaration
public int activeButtonCount { get; set; }
Property Value
Declaration
public Func<bool> closeButton { get; set; }
Property Value
Implements
Declaration
public Action destroy { get; }
Property Value
Implements
GradientPair should be set with new random gradientPair each time a new Tool is associated with this Button
This gradientPair is also used to highlight the input device when appropriate
Declaration
public GradientPair gradientPair { get; set; }
Property Value
Declaration
public bool highlighted { get; set; }
Property Value
Implements
Declaration
public Action<Transform, int, bool> highlightSingleButton { get; set; }
Property Value
Declaration
public Action hoverExit { set; }
Property Value
Implements
Declaration
public Sprite icon { set; }
Property Value
Declaration
public float iconHighlightedLocalZOffset { set; }
Property Value
Implements
Declaration
public bool implementsSecondaryButton { set; }
Property Value
Implements
Declaration
public bool interactable { get; set; }
Property Value
Implements
Declaration
public bool isActiveTool { set; }
Property Value
Implements
isMainMenu
Declaration
public bool isMainMenu { get; }
Property Value
Declaration
public bool isSelectionTool { get; }
Property Value
Declaration
public int maxButtonCount { get; set; }
Property Value
Implements
Declaration
public Transform menuOrigin { get; set; }
Property Value
| Type |
Description |
| Transform |
|
Declaration
public Node node { get; set; }
Property Value
Declaration
public Action<Transform, Transform> openMenu { get; set; }
Property Value
| Type |
Description |
| Action<Transform, Transform> |
|
Declaration
public int order { get; set; }
Property Value
Implements
Declaration
public string previewToolDescription { get; set; }
Property Value
Implements
Type, that if not null, denotes that preview-mode is enabled
This is enabled when highlighting a tool on the main menu
Declaration
public Type previewToolType { set; }
Property Value
Implements
Declaration
public Vector3 primaryUIContentContainerLocalScale { get; set; }
Property Value
Implements
Declaration
public Transform rayOrigin { get; set; }
Property Value
| Type |
Description |
| Transform |
|
Declaration
public bool secondaryButtonHighlighted { get; }
Property Value
Implements
Declaration
public Action<Transform> selectHighlightedButton { get; set; }
Property Value
| Type |
Description |
| Action<Transform> |
|
Declaration
public Action<Type> selectTool { get; set; }
Property Value
Implements
Declaration
public Action<IToolsMenuButton> showAllButtons { set; }
Property Value
Implements
Declaration
public byte stencilRef { set; }
Property Value
Implements
Declaration
public Vector3 toolButtonActivePosition { get; }
Property Value
Declaration
public ITooltip tooltip { set; }
Property Value
Declaration
public TextAlignment tooltipAlignment { get; }
Property Value
| Type |
Description |
| TextAlignment |
|
Implements
Declaration
public Transform tooltipSource { get; }
Property Value
| Type |
Description |
| Transform |
|
Implements
Declaration
public Transform tooltipTarget { get; set; }
Property Value
| Type |
Description |
| Transform |
|
Implements
Declaration
public string tooltipText { get; }
Property Value
Implements
Declaration
public bool tooltipVisible { set; }
Property Value
Implements
Declaration
public Type toolType { get; set; }
Property Value
Implements
Declaration
public Func<Type, int> visibleButtonCount { get; set; }
Property Value
Implements
Events
Declaration
public event Action hovered
Event Type
Implements
Explicit Interface Implementations
Declaration
IProvidesSetTooltipVisibility IFunctionalitySubscriber<IProvidesSetTooltipVisibility>.provider { get; set; }
Returns
Implements
Declaration
IProvidesFunctionalityInjection IFunctionalitySubscriber<IProvidesFunctionalityInjection>.provider { get; set; }
Returns
Implements
Extension Methods
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.