UltimateRadialMenu
The UltimateRadialMenu class is the main component of this Asset.
Important Note: Each of the provided public method examples require a public UltimateRadialMenu variable named: radialMenu.
Method | Description |
---|---|
Registered the provided information to the radial menu. | |
Enables the radial menu so that it can be interacted with. | |
Disables the radial menu so that it cannot be interacted with. | |
Disables the Ultimate Radial Menu immediately so that it cannot be interacted with. | |
Creates an empty button at the end of the radial menu. | |
Deletes all of the buttons from the radial menu. | |
Removes the button from the radial menu at the targeted index. | |
Clears all the registered button information and leaves the menu empty with the same number of buttons. | |
Updates the radial menu's position to the new position on the screen. | |
Resets the position of the radial menu back to its original position. | |
Sets the parent of the canvas to the new parent transform. | |
Updates the positioning of the radial menu according to the user's options. |
Important Note: All static methods are accessible without a direct reference to the UltimateRadialMenu component in your scripts. In order to use these static references, you must ensure that a Radial Menu Name is assigned on the target Ultimate Radial Menu. In the following examples, the name: ExampleMenu will be used.
Method | Description |
---|---|
Returns the Ultimate Radial Menu component that has been registered with the targeted name. | |
Registered the provided information to the radial menu. | |
Enables the radial menu so that it can be interacted with. | |
Disables the radial menu so that it cannot be interacted with. | |
Disables the Ultimate Radial Menu immediately so that it cannot be interacted with. | |
Creates an empty button at the end of the radial menu. | |
Deletes all of the buttons from the radial menu. | |
Removes the button from the radial menu at the targeted index. | |
Clears all the registered button information and leaves the menu empty with the same number of buttons. | |
Updates the radial menu's position to the new position on the screen. | |
Resets the position of the radial menu back to its original position. | |
Sets the parent of the canvas to the new parent transform. |
Event | Description |
---|---|
OnButtonEnter | This callback will be called when a radial button has been entered. |
OnButtonExit | This callback will be called when a radial button has been exited. |
OnButtonInputDown | This callback will be called when the input has been pressed on a radial button. |
OnButtonInputUp | This callback will be called when the input has been released on a radial button. |
OnButtonInteract | This callback will be called when a radial button has been interacted with. |
OnButtonSelected | This callback will be called when a radial button has been selected. |
OnMenuLostFocus | This callback will be called when the radial menu has lost focus. |
OnMenuEnabled | This callback will be called when the radial menu has been enabled. |
OnMenuDisabled | This callback will be called when the radial menu has been disabled. |
OnUpdatePositioning | This callback will be called when the radial menu's positioning has been updated. |
OnButtonCountModified | This callback will be called when a radial button is added or subtracted from the Radial Menu during this frame. This is useful for swapping sprites and positioning for a new count. |
OnProcessInput | This callback relays the information that is provided from the Ultimate Radial Menu Input Manager script according to the user's settings. |
Property | Description |
---|---|
BasePosition | The position of the base transform of the radial menu. |
BaseTransform | The RectTransform component of the radial menu. |
CalculatedMaxRange | Returns the calculated maximum range of the radial menu. |
CalculatedMinRange | Returns the calculated minimum range of the radial menu. |
GetAnglePerButton | Returns the angle of each button, determined by the menu button count. |
GetCurrentInputAngle | Returns the current input angle so that other scripts can access the current input of this radial menu. |
GetCurrentInputDistance | Returns the current distance of the input from the center of the menu. |
InputInRange | Returns the current state of the input on this radial menu. |
Interactable | The current state of being able to interact with the radial menu. |
IsEnabled | Returns the current state of the radial menu being enabled or disabled visually. |
IsWorldSpaceRadialMenu | Returns if this is a World Space radial menu or not. |
ParentCanvas | The parent canvas component that this radial menu is a child of. |
PointerActive | The current visible state of the pointer image. |
CurrentButtonIndex | Returns the index of the button currently being interacted with. |
Class Name | Description |
---|---|
The information about the button on the radial menu. | |
PointerStyle | Contains information about the pointer for certain button counts. |
Last updated