⚪
Tank & Healer Studio Assets
Return to Website
Ultimate Joystick
Ultimate Joystick
  • 🟢Introduction
    • 👋Welcome!
    • ⚡Getting Started
  • 📖Documentation
    • UltimateJoystick
      • Public Methods
        • GetHorizontalAxis
        • GetVerticalAxis
        • Disable
        • Enable
        • UpdatePositioning
      • Static Methods
        • ReturnComponent
      • Events
      • Properties
  • 💡Tips & Tricks
    • Catching Tap Count
    • Custom Runtime Positioning
  • 🔗Helpful Links
    • Leave us a review!
    • Join our Discord server!
Powered by GitBook
On this page

Was this helpful?

  1. Documentation
  2. UltimateJoystick

Public Methods

A list of all the public methods in the UltimateJoystick class.

PreviousUltimateJoystickNextGetHorizontalAxis

Last updated 5 months ago

Was this helpful?

Important Note: Each of the provided public method examples require a public UltimateJoystick variabled named: joystick.

public UltimateJoystick joystick;
Method
Description

Returns a float value between -1 and 1 representing the horizontal value of the Ultimate Joystick.

Returns a float value between -1 and 1 representing the vertical value of the Ultimate Joystick.

GetHorizontalAxisRaw

Returns a raw value of -1, 0 or 1 representing the raw horizontal value of the Ultimate Joystick.

GetVerticalAxisRaw

Returns raw a value of -1, 0 or 1 representing the raw vertical value of the Ultimate Joystick.

GetDistance

Returns a float value between 0 and 1 representing the distance of the joystick from the base.

GetInputActive

Returns if the players input is currently active on this joystick or not.

GetAngle

Returns the current angle that the joystick is from the center in degrees.

Disables the Ultimate Joystick object.

Enables the Ultimate Joystick.

InputInRange

Checks to see if the provided input is within range of the Ultimate Joystick.

Resets the joystick and updates the size and position of the joystick on the screen.

StartOverridePositioning

Disables normal interaction to the joystick and allows the user to move the joystick to a new position on the screen.

StopOverridePositioning

Re-enables normal interaction to the joystick, saving the position of the joystick to the position override object.

SetOverridePosition

Sets the position values for the override.

SetOverrideSize

Overrides the joystick with a new size.

ResetOverridePositioning

Resets the stored override values for this Ultimate Joystick.

📖
GetHorizontalAxis
GetVerticalAxis
Disable
Enable
UpdatePositioning