UltimateJoystick
The UltimateJoystick class is the main component of this Asset.
Important Note: Each of the provided public method examples require a public UltimateJoystick variabled named: joystick.
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
Returns a float value between -1 and 1 representing the horizontal value of the Ultimate Joystick.
GetVerticalAxis
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.
Disable
Disables the Ultimate Joystick object.
Enable
Enables the Ultimate Joystick.
InputInRange
Checks to see if the provided input is within range of the Ultimate Joystick.
OnPointerDownCallback
Called on the frame that catches the input down on the joystick image.
OnPointerUpCallback
Called on the frame that the input is released.
OnDragCallback
Called on the frames when the input on the joystick is being moved.
OnUpdatePositioning
Called when the positioning of the joystick is updated.
OnTapAchieved
This callback notifies any subscribers the current tap count any time a touch is initiated on the joystick within the tap decay rate.
OnTapReleased
This callback will be called only if the joystick has been released within the tap decay time.
OnOverridePositioning
This callback is called any time the position or size is overridden.
BaseTransform
The base RectTransform component of this Ultimate Joystick.
HighightColor
The color used on the highlight images.
HorizontalAxis
The current value of the horizontal axis.
InputActive
The current state of input being active on this Ultimate Joystick.
Interactable
Determines if the joystick is interactable or not.
IsOverridingPosition
Returns true if the player is currently adjusting the position of this Ultimate Joystick.
Joystick
The RectTransform used as the actual joystick.
JoystickBase
The RectTransform used as the base of the joystick.
ParentCanvas
The parent Canvas component that this Ultimate Joystick is inside of.
ParentCanvasTransform
The RectTransform associated with the parent canvas.
ParentCanvasRaycaster
The Graphic Raycaster component attached to the parent canvas.
TensionColorFull
The color displayed when there is full tension.
TensionColorNone
The color displayed when there is no tension.
VerticalAxis
The current value of the vertical axis.
Last updated