TouchButton Class

If true, the button can be turned on by a touch swipe that began in an area outside the button region. If false, the button can only be turned on by a direct press.

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

Should the button 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 button 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 type of button.\nStandard = A momentary switch. Returns True while the button is pressed down.\nToggle Switch = Alternately turns on and off with each press.

Speed (units/sec) that the axis value falls toward 0 when not pressed. A value of 1.0 means an axis value of 1 will drain to 0 over 1 second. A value of 3 equates to 1/3 of a second, and so on.

Speed to move toward an axis value of 1.0 in units/sec when pressed. A value of 1.0 means an axis value of 0 will reach 1 over 1 second. A value of 3 equates to 1/3 of a second, and so on.

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

Is this button 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.

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.

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

If True, the button 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 button and have the button graphics follow the users touches. This only has an effect if a Touch Region is set.

The speed at which the button 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 button. 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 button at any time.

If Move To Touch Position is enabled, this will make the button 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 button 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 true, the button will stay on even if the touch that activated it moves outside the button region. If false, the button will turn off once the touch that activated it moves outside the button region. If Follow Touch Position is True, this will always return True except in the case of using a Touch Region with Use Touch Region Only set to True also.

The Custom Controller element that will receive input values from this control.

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 button's RectTransform. This can be useful if you want a larger area of the screen to act as a button.

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.

Makes the axis value gradually change over time based on gravity and sensitivity as the button is pressed.

If True, hovers/clicks/touches on the local button will be ignored and only Touch Region touches will be used. Otherwise, both touches on the button 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.

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

Moves the button to the default position.

Moves the button to the default position.

Record the current anchored position as the button's default position. The button will return to this position when released when using a Touch Region with moveToTouchPosition set to True. If you move the button'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 in the button's axis.

Event sent when the axis value changes.

Event sent when the button is pressed.

Event sent when the button is released

Event sent when the button value changes.

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 visibility changes.