Button||doc135343

September 20, 2022

Button

Introduction

Button control, the most commonly used control in games to trigger events.

Attribute

string NormalImage
Confirm the picture of the button in its original state
string PushedImage
Determine the picture with the button pressed
string DisabledImage
Determines the picture for which the button is disabled
string Text
Confirm button text content
FontStyle FontStyle
Determines the font style of the button text
FontWeight FontWeight
Determines the font weight of the button text
int FontSize
Determines the font size of the button text
bool AutoTextSize
Determines whether the button text is adaptive in size
int MinAutoTextSize
Determines the minimum size for button text adaptive size
Color3 NormalTextColor
Determines the text color of the button in its original state
Color3 PushedTextColor
Determines the text color when the button is pressed
Color3 DisabledTextColor
Determines the text color for which the button is disabled
int TextBorderWidth
Defines the stroke width of the text
Color3 TextBorderColor
Defines the stroke color of the text
Vector2 TextOffset
Defines the position offset of the button text

inherited fromWindow

string Name
Name of the window
float Alpha
Window opacity
bool Visible
Show window
bool Disabled
Disable window
bool ClippedByParent
Whether to crop out the rendered part beyond the boundary of the parent control
bool TouchThrough
Whether touch can penetrate the window
AlignmentFormat AlignmentFormat
Determines the alignment of the rendered window
UDim2 Position
Determine the position of the window
UDim2 Size
Determine the size of the window
Vector3 Rotation
Determines the rotation angle of the window
Vector2 RelativelyPosition
Determine the relative position of the window
Vector2 AbsolutelyPosition
Determine the absolute position of the window
Vector2 RelativelySize
Determines the relative size of the window
Vector2 AbsolutelySize
Determines the absolute size of the window
Window Parent
Determine the parent of the window
int SiblingOrder
Determine the order in which windows are arranged

Function

inherited fromWindow

Vector2 GetPixelPosition ()
Returns the actual pixel position relative to the device screen
Vector2 GetPixelSize ()
Returns the actual pixel size compared to the device screen
bool IsValid ()
Determine if window reference is valid
int GetID ()
Returns the unique identification of the window
int GetChildCount ()
Returns the number of child windows
void AddChild ( Window child )
Add child window
void RemoveChild ( Window child )
Remove child window
Window GetChildByID ( int ID )
Return to child window based on unique ID
void RemoveChildByID ( int ID )
Remove child windows based on unique identification
Window GetChildByName ( string name )
Returns a child window by window name
table<Window> GetChildren ()
Returns an array of all child windows
bool IsChild ( Window window )
Determine whether the window is a child window
bool IsAncestor ( Window window )
Determine whether the window is the parent
Window Clone ()
Create a copy of a window and all its child windows
void Destroy ()
Destroy Window
void DestroyAllChildren ()
Destroy all child windows
Tween DoTween ( TweenInfo tweenInfo, table<string, variant> properties )
Create and start jog animation
BindableEvent GetEvent ( string eventName )
Get events for window controls

Event

inherited fromWindow

BindableEvent OnTouchDown
Event triggered when a touch is pressed in the target control
BindableEvent OnTouchUp
Event triggered when the target control is touched and lifted
BindableEvent OnTouchMove
An event is triggered when a finger moves in the process of being touched in the target control
BindableEvent OnClick
Event triggered when the target control is clicked
BindableEvent OnDestroy
Event triggered before the target control is destroyed
BindableEvent OnChildAdded
Event triggered after adding child controls to the target control
BindableEvent OnChildRemoved
Event triggered when a child control is removed from the target control
BindableEvent OnShown
Visible = true triggers an event when the target control is switched to visible
BindableEvent OnHidden
Visible = false triggers an event when the target control is switched to invisible