Component:Button

From Resonite Wiki
Revision as of 21:58, 18 April 2024 by AmasterAmaster (talk | contribs) (Fixed Link.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)


This article or section is a Stub. You can help the Resonite Wiki by expanding it.


Component image 
Button component as seen in the Scene Inspector


Intoduction

A Button is a UIX component allows for users to click on its Rect. It provides visual feedback by altering the colors of graphics on the Rect, and is able to trigger several other components, such as Text Field, by using the Button Events system.

Usage

Fields
Name Type Description
persistent Bool Determines whether or not this item will be saved to the server.
UpdateOrder Int Controls the order in which this component is updated.
Enabled Bool Controls whether or not this component is enabled.
BaseColor ColorX The color that all other tints will be based on
ColorDrivers list of ColorDriver A list of sets of colors. Each one points at another component's color, and determines how it looks normally, when highlighted, when pressed, and when disabled
__legacy_NormalColor ColorX
__legacy_HighlightColor ColorX
__legacy_PressColor ColorX
__legacy_DisabledColor ColorX
__legacy_TintColorMode ColorMode
__legacy_ColorDrive field drive of ColorX
IsPressed Bool True if the button is being pressed
IsHovering Bool True if someone is hovering over the button
HoverVibrate VibratePreset How a controller should vibrate when hovering over this button
PressVibrate VibratePreset How a controller should vibrate when pressing this button
ClearFocusOnPress Bool If set, will defocus any currently focused TextEditor, DesktopInteractionRelay, or any other IFocusable when this button is pressed. Defaults to true.
PassThroughHorizontalMovement Bool Whether or not press-and-drag movement should be passed to higher components

(such as Scroll Rects)

PassThroughVerticalMovement Bool Whether or not press-and-drag movement should be passed to higher components

(such as Scroll Rects)

RequireLockInToPress Bool FIXME. Defaults to false.
RequireInitialPress Bool FIXME. Defaults to true.
PressPoint Float2 The (x,y) coordinate where the button is being pressed
SendSlotEvents Bool If set, all Pressing, Pressed, Released, HoverEnter, HoverStay, and HoverLeave events are sent to all IButtonPressReceiver components within this component's slot. Defaults to true.
Pressed ButtonEventHandler Delegate. If set, this function is called with the Pressed event. Defaults to unset.
Pressing ButtonEventHandler Delegate. If set, this function is called with the Pressing event. Defaults to unset.
Released ButtonEventHandler Delegate. If set, this function is called with the Released event. Defaults to unset.
HoverEnter ButtonEventHandler Delegate. If set, this function is called with the HoverEnter event. Defaults to unset.
HoverStay ButtonEventHandler Delegate. If set, this function is called with the HoverStay event. Defaults to unset.
HoverLeave ButtonEventHandler Delegate. If set, this function is called with the HoverLeave event. Defaults to unset.

Behavior

Examples

Related Components