TouchJoystick Class

If true, the joystick can be activated by a touch swipe that began in an area outside the joystick region. If false, the joystick can only be activated by a direct touch.

The mouse buttons that are allowed to interact with this control.

Should taps on the touch pad be processed?

Should the joystick animate when moving to the touch point? This only has an effect if Move To Touch Position is True and a Touch Region is set. This setting is ignored if Follow Touch Position is True.

Should the joystick animate when moving back to its original position? This only has an effect if Follow Touch Position is True, or if Move To Touch Position is True and a Touch Region is set, and Return on Release is True.

Gets the Animator component on this GameObject. Returns null if no Animator component is found.

The axis directions in which movement is allowed. You can restrict movement to one or both axes.

The calibration settings for the 2D axis.

If true, the stick will return to the center after it is released. Otherwise, the stick will remain in the last position and continue to return input.

The calibration settings for the 2D axis.

A dead zone which is applied when Stick Mode is set to Digital. This is used to filter out tiny stick movements near 0, 0.

If True, the joystick will follow the touch around until released. This setting overrides Move To Touch Position.

Is this joystick currently being controlled by a touch or pointer?

Sets visibility to False when the control is idle. When the control is no longer idle, visibility will be set to True again.

The calibration settings for the horizontal axis.

The Custom Controller element(s) that will receive input values from the joystick's X axis.

Gets the Target Graphic as an Image. If the Target Graphic is not an Image, this will return null.

Can the control can be interacted with by the user?

The current interaction state.

The joystick's mode of operation. Set this to Digital to simulate a D-Pad which has only On/Off states. If you want mimic a real D-Pad, you should also set Snap Directions to 8.

If True, it will attempt to automatically manage Graphic component raycasting for best results based on your current settings.

If True, the joystick will move to the location of the current touch in the Touch Region. This can be used to designate an area of the screen as a hot-spot for a joystick and have the joystick graphics follow the users touches. This only has an effect if a Touch Region is set.

The speed at which the joystick will move toward the touch position measured in screens per second (based on the larger of width and height). [1.0 = Move 1 screen/sec]. This only has an effect if Move To Touch Position is True, Animate On Move To Touch is true, and a Touch Region is set. This setting is ignored if Follow Touch Position is True.

The pointer id that currently has control of this joystick. If there is no pointer id, the value is TouchControl.POINTER_ID_NULL. Only one pointer id (touch, mouse, etc.) may be in control of this joystick at any time.

If Move To Touch Position is enabled, this will make the joystick return to its original position after the press is released. This only has an effect if a Touch Region is set.

The speed at which the joystick will move back toward its original position measured in screens per second (based on the larger of width and height). [1.0 = Move 1 screen/sec]. This only has an effect if Follow Touch Position is True, or if Move To Touch Position is True and a Touch Region is set, and Return on Release and Animate on Return are both True.

If enabled, the stick range will scale with parent controls. Otherwise, the stick range will remain constant.

Snaps joystick movement to a fixed number of directions. This can be used to create a D-Pad, for example, setting it to 4 or 8 directions. If you want a true D-Pad, Stick Mode should be set to digital.

If true, the stick disc will snap immediately to the touch position when initially touched. This results in the stick disc being centered to the touch position. This will cause the stick to generate input immediately when touched if not touched perfectly centered. If false, the stick disc will remain in its current position on touch, and when dragged will retain the same offset. The stick's center point will be set to the position of the touch. The initial touch will not cause the stick to pop in any direction.

If true, the joystick will stay engaged even if the touch that activated it moves outside the joystick region. If false, the joystick will be released once the touch that activated it moves outside the joystick region.

The range of movement of the stick in Canvas pixels. The larger the number, the further the stick must be moved from center to register movement.

The Rect Transform of the stick disc. This is moved around by the user when manipulating the joystick.

The Custom Controller element that will receive input values from taps.

The maximum movement distance allowed in pixels since the touch began for the touch to be considered a tap. [-1 = no limit]

The maximum touch duration allowed for the touch to be considered a tap.

The target Graphic component for interaction state transitions.

Optional external region to use for hover/click/touch detection. If set, this region will be used for touch detection instead of or in addition to the joystick's RectTransform. This can be useful if you want a larger area of the screen to act as a joystick.

Settings using for Animation Trigger transitions.

Settings using for Color Tins transitions.

Settings using for Sprite State transitions.

The transition type(s) to be used when transitioning to various states. Multiple transition types can be used simultaneously. Denote multiple transition types using bitwise operations.

If True, hovers/clicks/touches on the local joystick will be ignored and only Touch Region touches will be used. Otherwise, both touches on the joystick and on the Touch Region will be used. This also applies to mouse hover. This setting has no effect if no Touch Region is set.

The calibration settings for the vertical axis.

The Custom Controller element(s) that will receive input values from the joystick's Y axis.

Is the control visible? An invisible control can still be interacted with. This property only has any effect when used with an Image Component.

Gets the raw value of the joystick.

Gets the calibrated value of the joystick.

Moves the joystick to the default position.

Moves the joystick to the default position.

Record the current anchored position as the joystick's default position. The joystick will return to this position when released when using a Touch Region with moveToTouchPosition set to True. If you move the joystick's position and want it to return there next time, you should record the new default position by calling this method.

Set the raw value of the joystick.

Event sent when interaction state changes to Disabled.

Event sent when interaction state changes to Highlighted.

Event sent when interaction state changes to Normal.

Event sent when interaction state changes to Pressed.

Event sent when the Interaction State changes.

Event sent when the joystick's stick position changes.

Event sent when the touch pad is tapped. This event will only be sent if allowTap is True.

Event sent when the joystick value changes.

Event sent when visibility changes.