# UltimateRadialMenu

## [Public Methods](https://docs.tankandhealerstudio.com/assets/ultimateradialmenu/documentation/ultimateradialmenu/public-methods)

{% hint style="warning" %}
**Important Note:** Each of the provided public method examples require a public UltimateRadialMenu variable named: radialMenu.
{% endhint %}

<table data-full-width="true"><thead><tr><th width="238">Method</th><th>Description</th></tr></thead><tbody><tr><td><a href="ultimateradialmenu/public-methods/registerbutton-+3-overloads">RegisterButton</a></td><td>Registered the provided information to the radial menu.</td></tr><tr><td><a href="ultimateradialmenu/public-methods/enable">Enable</a></td><td>Enables the radial menu so that it can be interacted with.</td></tr><tr><td><a href="ultimateradialmenu/public-methods/disable">Disable</a></td><td>Disables the radial menu so that it cannot be interacted with.</td></tr><tr><td><a href="ultimateradialmenu/public-methods/disableimmediate">DisableImmeditate</a></td><td>Disables the Ultimate Radial Menu immediately so that it cannot be interacted with.</td></tr><tr><td><a href="ultimateradialmenu/public-methods/createemptybutton">CreateEmptyButton</a></td><td>Creates an empty button at the end of the radial menu.</td></tr><tr><td><a href="ultimateradialmenu/public-methods/clearmenu">ClearMenu</a></td><td>Deletes all of the buttons from the radial menu.</td></tr><tr><td><a href="ultimateradialmenu/public-methods/removebutton">RemoveButton</a></td><td>Removes the button from the radial menu at the targeted index.</td></tr><tr><td><a href="ultimateradialmenu/public-methods/clearbuttoninformation">ClearButtonInformations</a></td><td>Clears all the registered button information and leaves the menu empty with the same number of buttons.</td></tr><tr><td><a href="ultimateradialmenu/public-methods/setposition">SetPosition</a></td><td>Updates the radial menu's position to the new position on the screen.</td></tr><tr><td><a href="ultimateradialmenu/public-methods/resetposition">ResetPosition</a></td><td>Resets the position of the radial menu back to its original position.</td></tr><tr><td><a href="ultimateradialmenu/public-methods/setparent">SetParent</a></td><td>Sets the parent of the canvas to the new parent transform.</td></tr><tr><td><a href="ultimateradialmenu/public-methods/updatepositioning">UpdatePositioning</a></td><td>Updates the positioning of the radial menu according to the user's options.</td></tr></tbody></table>

## [Static Methods](https://docs.tankandhealerstudio.com/assets/ultimateradialmenu/documentation/ultimateradialmenu/static-methods)

{% hint style="warning" %}
**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.
{% endhint %}

<table data-full-width="true"><thead><tr><th width="238">Method</th><th>Description</th></tr></thead><tbody><tr><td><a href="ultimateradialmenu/static-methods/returncomponent">ReturnComponent</a></td><td>Returns the Ultimate Radial Menu component that has been registered with the targeted name.</td></tr><tr><td><a href="ultimateradialmenu/static-methods/registerbutton-+3-overloads">RegisterButton</a></td><td>Registered the provided information to the radial menu.</td></tr><tr><td><a href="ultimateradialmenu/static-methods/enable">Enable</a></td><td>Enables the radial menu so that it can be interacted with.</td></tr><tr><td><a href="ultimateradialmenu/static-methods/disable">Disable</a></td><td>Disables the radial menu so that it cannot be interacted with.</td></tr><tr><td><a href="ultimateradialmenu/static-methods/disableimmediate">DisableImmeditate</a></td><td>Disables the Ultimate Radial Menu immediately so that it cannot be interacted with.</td></tr><tr><td><a href="ultimateradialmenu/static-methods/createemptybutton">CreateEmptyButton</a></td><td>Creates an empty button at the end of the radial menu.</td></tr><tr><td><a href="ultimateradialmenu/static-methods/clearmenu">ClearMenu</a></td><td>Deletes all of the buttons from the radial menu.</td></tr><tr><td><a href="ultimateradialmenu/static-methods/removebutton">RemoveButton</a></td><td>Removes the button from the radial menu at the targeted index.</td></tr><tr><td><a href="ultimateradialmenu/static-methods/clearbuttoninformation">ClearButtonInformations</a></td><td>Clears all the registered button information and leaves the menu empty with the same number of buttons.</td></tr><tr><td><a href="ultimateradialmenu/static-methods/setposition">SetPosition</a></td><td>Updates the radial menu's position to the new position on the screen.</td></tr><tr><td><a href="ultimateradialmenu/static-methods/resetposition">ResetPosition</a></td><td>Resets the position of the radial menu back to its original position.</td></tr><tr><td><a href="ultimateradialmenu/static-methods/setparent">SetParent</a></td><td>Sets the parent of the canvas to the new parent transform.</td></tr></tbody></table>

## [Events](https://docs.tankandhealerstudio.com/assets/ultimateradialmenu/documentation/ultimateradialmenu/events)

<table data-full-width="true"><thead><tr><th width="242">Event</th><th>Description</th></tr></thead><tbody><tr><td><a href="ultimateradialmenu/events/onbuttonenter">OnButtonEnter</a></td><td>This callback will be called when a radial button has been entered.</td></tr><tr><td>OnButtonExit</td><td>This callback will be called when a radial button has been exited.</td></tr><tr><td>OnButtonInputDown</td><td>This callback will be called when the input has been pressed on a radial button.</td></tr><tr><td>OnButtonInputUp</td><td>This callback will be called when the input has been released on a radial button.</td></tr><tr><td>OnButtonInteract</td><td>This callback will be called when a radial button has been interacted with.</td></tr><tr><td>OnButtonSelected</td><td>This callback will be called when a radial button has been selected.</td></tr><tr><td>OnMenuLostFocus</td><td>This callback will be called when the radial menu has lost focus.</td></tr><tr><td>OnMenuEnabled</td><td>This callback will be called when the radial menu has been enabled.</td></tr><tr><td><a href="ultimateradialmenu/events/onmenudisabled">OnMenuDisabled</a></td><td>This callback will be called when the radial menu has been disabled.</td></tr><tr><td>OnUpdatePositioning</td><td>This callback will be called when the radial menu's positioning has been updated.</td></tr><tr><td>OnButtonCountModified</td><td>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.</td></tr><tr><td>OnProcessInput</td><td>This callback relays the information that is provided from the Ultimate Radial Menu Input Manager script according to the user's settings.</td></tr></tbody></table>

## [Properties](https://docs.tankandhealerstudio.com/assets/ultimateradialmenu/documentation/ultimateradialmenu/properties)

<table data-full-width="true"><thead><tr><th width="272.3333333333333">Property</th><th>Description</th></tr></thead><tbody><tr><td>BasePosition</td><td>The position of the base transform of the radial menu.</td></tr><tr><td>BaseTransform</td><td>The RectTransform component of the radial menu.</td></tr><tr><td>CalculatedMaxRange</td><td>Returns the calculated maximum range of the radial menu.</td></tr><tr><td>CalculatedMinRange</td><td>Returns the calculated minimum range of the radial menu.</td></tr><tr><td>GetAnglePerButton</td><td>Returns the angle of each button, determined by the menu button count.</td></tr><tr><td>GetCurrentInputAngle</td><td>Returns the current input angle so that other scripts can access the current input of this radial menu.</td></tr><tr><td>GetCurrentInputDistance</td><td>Returns the current distance of the input from the center of the menu.</td></tr><tr><td>InputInRange</td><td>Returns the current state of the input on this radial menu.</td></tr><tr><td>Interactable</td><td>The current state of being able to interact with the radial menu.</td></tr><tr><td>IsEnabled</td><td>Returns the current state of the radial menu being enabled or disabled visually.</td></tr><tr><td>IsWorldSpaceRadialMenu</td><td>Returns if this is a World Space radial menu or not.</td></tr><tr><td>ParentCanvas</td><td>The parent canvas component that this radial menu is a child of.</td></tr><tr><td>PointerActive</td><td>The current visible state of the pointer image.</td></tr><tr><td>CurrentButtonIndex</td><td>Returns the index of the button currently being interacted with.</td></tr></tbody></table>

## [Public Classes](https://docs.tankandhealerstudio.com/assets/ultimateradialmenu/documentation/ultimateradialmenu/public-classes)

<table data-full-width="true"><thead><tr><th width="208">Class Name</th><th>Description</th></tr></thead><tbody><tr><td><a href="ultimateradialmenu/public-classes/ultimateradialbutton">UltimateRadialButton</a></td><td>The information about the button on the radial menu.</td></tr><tr><td>PointerStyle</td><td>Contains information about the pointer for certain button counts.</td></tr></tbody></table>