> For the complete documentation index, see [llms.txt](https://docs.tankandhealerstudio.com/assets/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tankandhealerstudio.com/assets/ultimatejoystick/documentation/ultimatejoystick/public-methods.md).

# Public Methods

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

```csharp
public UltimateJoystick joystick;
```

<table data-full-width="false"><thead><tr><th width="237">Method</th><th>Description</th></tr></thead><tbody><tr><td><a href="/pages/uaODzxQHII3zHOjvemH7">GetHorizontalAxis</a></td><td>Returns a float value between -1 and 1 representing the horizontal value of the Ultimate Joystick.</td></tr><tr><td><a href="/pages/kxsBgsOEn8AiAOUXniAt">GetVerticalAxis</a></td><td>Returns a float value between -1 and 1 representing the vertical value of the Ultimate Joystick.</td></tr><tr><td>GetHorizontalAxisRaw</td><td>Returns a raw value of -1, 0 or 1 representing the raw horizontal value of the Ultimate Joystick.</td></tr><tr><td>GetVerticalAxisRaw</td><td>Returns raw a value of -1, 0 or 1 representing the raw vertical value of the Ultimate Joystick.</td></tr><tr><td>GetDistance</td><td>Returns a float value between 0 and 1 representing the distance of the joystick from the base.</td></tr><tr><td>GetInputActive</td><td>Returns if the players input is currently active on this joystick or not.</td></tr><tr><td>GetAngle</td><td>Returns the current angle that the joystick is from the center in degrees.</td></tr><tr><td><a href="/pages/0QG07OxaSwggXT74KxhT">Disable</a></td><td>Disables the Ultimate Joystick object.</td></tr><tr><td><a href="/pages/cmuUu0bFrxYgwzmTF7gc">Enable</a></td><td>Enables the Ultimate Joystick.</td></tr><tr><td>InputInRange</td><td>Checks to see if the provided input is within range of the Ultimate Joystick.</td></tr><tr><td><a href="/pages/oJPwpjIjYPpi6dkAig40">UpdatePositioning</a></td><td>Resets the joystick and updates the size and position of the joystick on the screen.</td></tr><tr><td>StartOverridePositioning</td><td>Disables normal interaction to the joystick and allows the user to move the joystick to a new position on the screen.</td></tr><tr><td>StopOverridePositioning</td><td>Re-enables normal interaction to the joystick, saving the position of the joystick to the position override object.</td></tr><tr><td>SetOverridePosition</td><td>Sets the position values for the override.</td></tr><tr><td>SetOverrideSize</td><td>Overrides the joystick with a new size.</td></tr><tr><td>ResetOverridePositioning</td><td>Resets the stored override values for this Ultimate Joystick.</td></tr></tbody></table>