TextButton
*Pronto este contenido estará disponible en tu idioma seleccionado.
A TextButton behaves similarly to TextLabel in regards to rendering, with the additional behaviors of a GuiButton.
You can disable text rendering by setting TextTransparency to 1. This will result in a plain rectangle that can be used as a button.
Resumen
Propiedades
A copy of TextButton.Text that contains exactly what is being rendered by the TextButton.
Determines the font used to render text.
Determines the font used to render text.
Scales the spacing between lines of text in the TextButton.
Sets whether a TextButton should be GuiBase2d.Localize or not.
The maximum number of graphemes the TextButton can show.
Determines whether the TextButton renders its text using rich text formatting.
Determines the string rendered by the TextButton.
Read-only property which reflects the absolute size of rendered text in offsets.
Determines the color of rendered text.
Direction in which the text is rendered.
A boolean representation of whether the button's text fits within the size of it.
Changes whether text is resized to fit within the TextButton.
Determines the line height of text in offsets.
Determines the color of the text stroke (outline).
Determines the transparency of the text stroke (outline).
Determines the transparency of rendered text.
Controls the truncation of the text displayed in the TextButton.
Determines if text wraps to multiple lines within the TextButton element's space, truncating excess text.
Determines the horizontal alignment of rendered text.
Determines the vertical alignment of rendered text.
Determina si el botón cambia de color automáticamente cuando el mouse se posiciona sobre él o hace clic en él.
Si es cierto mientras el elemento GUI es visible, el mouse no se bloqueará a menos que el botón derecho del ratón esté abajo.
Propiedad deBooleano que indica si el objeto ha sido seleccionado.
Establece el estilo del GuiButton según una lista de estilos predeterminados.
Determina si este elemento de la interfaz de usuario acepta la entrada.
Determina el punto de origen de un GuiObject , relativo a su tamaño absoluto.
Determina si se produce el escalado en función del contenido de los hijos.
Determina el color de fondo de GuiObject
Determina la transparencia de la capa de fondo y el borde de GuiObject
Determina el color de la frontera de GuiObject .
Determina de qué manera se coloca el límite de GuiObject en relación con sus dimensiones.
Determina el ancho de píxel de la frontera GuiObject .
Determina si el descendiente GuiObjects fuera de los límites de un elemento GUI padre debe Renderizar.
Determina si el mouse del jugador está siendo presionado activamente en el GuiObject o no.
Determina si el GuiButton se puede interactuar con o no, o si el GuiState del GuiObject está cambiando o no.
Controla el orden de clasificación del GuiObject cuando se usa con un UIGridStyleLayout .
Establece el GuiObject que se seleccionará cuando el seleccionador de plataforma de juego se mueva hacia abajo.
Establece el GuiObject que se seleccionará cuando el seleccionador de plataforma se mueva a la izquierda.
Establece el GuiObject que se seleccionará cuando el seleccionador de plataforma de juegos se mueva a la derecha.
Establece el GuiObject que se seleccionará cuando el seleccionador de plataforma de juego se mueva hacia arriba.
Determina la posición de píxeles y escalares de GuiObject .
Determina el número de grados en los que se gira el GuiObject .
Determine si el GUI puede ser seleccionado por un controlador para juego.
Sobrecarga el adorno de selección predeterminado utilizado para las plataformas de juegos.
El orden de GuiObjects seleccionado por la interfaz de usuario del gamepad.
Determina el tamaño de píxeles y escalares del GuiObject .
Establece los ejes Size en los que se basará el GuiObject relativos al tamaño de su padre.
Una propiedad mixta de BackgroundTransparency y TextTransparency .
Determina si el GuiObject y sus descendientes serán renderizados.
Determina el orden en que se renderiza un GuiObject en relación con los demás.
Describe la posición de pantalla actual de un elemento de UI, en píxeles.
Describe la rotación de pantalla actual de un elemento de UI, en grados.
Describe el tamaño de pantalla actual de un elemento de UI, en píxeles.
Cuando esté configurado como verdadero, la localización se aplicará a este GuiBase2d y sus descendientes.
Una referencia a un LocalizationTable para ser usado para aplicar la localización automatizada a este GuiBase2d y sus descendientes.
Personaliza el comportamiento de la selección del gamepad en la dirección de abajo.
Personaliza el comportamiento de la selección del gamepad en la dirección de la izquierda.
Personaliza el comportamiento de la selección del gamepad en la dirección correcta.
Personaliza el comportamiento de la selección del gamepad en la dirección de arriba.
Permite la personalización del movimiento de la plataforma de juego.
Métodos
Métodos heredados de GuiObject- TweenPosition(endPosition : UDim2,easingDirection : Enum.EasingDirection,easingStyle : Enum.EasingStyle,time : number,override : bool,callback : function):bool
Mueve con suavidad un GUI a un nuevo UDim2 .
- TweenSize(endSize : UDim2,easingDirection : Enum.EasingDirection,easingStyle : Enum.EasingStyle,time : number,override : bool,callback : function):bool
Escala con suavidad un GUI a un nuevo UDim2 .
- TweenSizeAndPosition(endSize : UDim2,endPosition : UDim2,easingDirection : Enum.EasingDirection,easingStyle : Enum.EasingStyle,time : number,override : bool,callback : function):bool
Mueve con suavidad una GUI a un nuevo tamaño y posición.
Eventos
Eventos heredados de GuiButtonDispara cuando se activa el botón.
Se ha disparado cuando el mouse ha dejado completamente clicado el botón GUI.
Se activa cuando el mouse está en el estado de abajo del mouse izquierdo en el objeto GUI.
Se ha disparado cuando el mouse izquierdo ha liberado el objeto GUI.
Se ha disparado cuando el mouse ha hecho clic con el botón derecho en el botón de GUI.
Se activa cuando el mouse está en el estado correcto de abajo del ratón en el objeto GUI.
Se ha disparado cuando el botón derecho del ratón se ha liberado en un objeto GUI.
Se ha disparado cuando un usuario comienza a interactuar a través de un dispositivo de interfaz humana-ordenador (botón de ratón, toque para comenzar, botón de teclado, etc).
Se activa cuando un usuario cambia cómo interactúa a través de un dispositivo de interfaz humana-ordenador (botón de ratón, toque para comenzar, botón de teclado, etc).
Se ha disparado cuando un usuario deja de interactuar a través de un dispositivo de interfaz humana-ordenador (botón de ratón, toque para empezar, botón de teclado, etc).
Dispara cuando un usuario mueve su mouse hacia un elemento GUI.
Se activa cuando un usuario mueve el mouse fuera de un elemento de la GUI.
Dispara cuando un usuario mueve el mouse mientras está dentro de un elemento GUI.
Dispara cuando un usuario desplaza su rueda de ratón cuando el ratón está sobre un elemento de GUI.
Se activa cuando un usuario desplaza su rueda de ratón hacia delante cuando el ratón está sobre un elemento de GUI.
Se activa cuando el GuiObject está siendo enfocado con el GamepadSelector.
Se activa cuando el GamepadSelector deja de enfocarse en el GuiObject.
Se activa cuando el jugador comienza, continúa y termina presionando el elemento de la interfaz de usuario.
- TouchPan(touchPositions : Array,totalTranslation : Vector2,velocity : Vector2,state : Enum.UserInputState):RBXScriptSignal
Dispara cuando el jugador mueve su dedo en el elemento de la interfaz de usuario.
- TouchPinch(touchPositions : Array,scale : number,velocity : number,state : Enum.UserInputState):RBXScriptSignal
Dispara cuando el jugador realiza un gesto de pinchazo o de tiro usando dos dedos en el elemento de la interfaz de usuario.
- TouchRotate(touchPositions : Array,rotation : number,velocity : number,state : Enum.UserInputState):RBXScriptSignal
Dispara cuando el jugador realiza un gesto de rotación usando dos dedos en el elemento de la interfaz de usuario.
Se activa cuando el jugador realiza un gesto de desplazamiento en el elemento de la interfaz de usuario.
Se activa cuando el jugador realiza un gesto de toque en el elemento de la interfaz de usuario.
- SelectionChanged(amISelected : bool,previousSelection : GuiObject,newSelection : GuiObject):RBXScriptSignal
Se activa cuando la selección del gamepad se mueve, se va o cambia dentro de la GuiBase2d conectada o cualquier descendiente de GuiObjetos.
Propiedades
ContentText
This property provides a copy of Text that contains exactly what is being rendered by the TextButton. This is useful for eliminating style tags used for rich text markup; for example, when RichText is enabled, the ContentText property shows the text as it appears to the user.
| RichText | Text | ContentText |
|---|---|---|
| false | <b>Hello,<br/> world!</b> | <b>Hello,<br/> world!</b> |
| true | <b>Hello,<br/> world!</b> | Hello, world! |
Font
This property selects one of several pre-defined fonts with which the TextButton will render its text. Some fonts have bold, italic and/or light variants.
With the exception of the Enum.Font.Legacy font, each font will render text with the line height equal to the TextSize property.
The Enum.Font.Code font is the only monospace font. It has the unique property that each character has the exact same width and height ratio of 1:2, where the width of each character is approximately half the TextSize property.
This property is kept in sync with the FontFace property.
Muestras de código
local frame = script.Parent
-- Create a TextLabel displaying each font
for _, font in pairs(Enum.Font:GetEnumItems()) do
local textLabel = Instance.new("TextLabel")
textLabel.Name = font.Name
-- Set the text properties
textLabel.Text = font.Name
textLabel.Font = font
-- Some rendering properties
textLabel.TextSize = 24
textLabel.TextXAlignment = Enum.TextXAlignment.Left
-- Size the frame equal to the height of the text
textLabel.Size = UDim2.new(1, 0, 0, textLabel.TextSize)
-- Add to the parent frame
textLabel.Parent = frame
end
-- Layout the frames in a list (if they aren't already)
if not frame:FindFirstChildOfClass("UIListLayout") then
local uiListLayout = Instance.new("UIListLayout")
uiListLayout.Parent = frame
endFontFace
This property is similar to the Font property but allows setting fonts that don't exist in Enum.Font.
This property is kept in sync with the Font property, such that when setting FontFace, the font is set to the corresponding Enum.Font value or to Enum.Font.Unknown if there are no matches.
LineHeight
Controls the height of lines as a multiple of the font's em square size by scaling the spacing between lines of text in the TextButton. Valid values range from 1.0 to 3.0, defaulting to 1.0.
MaxVisibleGraphemes
This property controls the maximum number of graphemes (or units of text) that are shown on the TextButton. It is primarily provided as an easy way to create a typewriter effect where the characters appear one at a time.
Changing the property does not change the position or size of the visible graphemes; the layout will be calculated as if all graphemes are visible.
Setting the property to -1 disables the limit and shows the entirety of the Text.
OpenTypeFeatures
OpenTypeFeaturesError
RichText
This property determines whether the TextButton renders its text using rich text markup to style sections of the string in bold, italics, specific colors, and more.
To use rich text, simply include rich text formatting tags in the Text string.
Text
This property determines the text content rendered by the TextButton. The visual properties of the string rendered to the screen is determined by TextColor3, TextTransparency, TextSize, Font, TextScaled, TextWrapped, TextXAlignment and TextYAlignment.
It is possible to render emoji such as 🔒 and other symbols which aren't affected by the TextColor3 property. These can be pasted into Script and LocalScript objects, as well as the field within the Properties window.
This property may contain newline characters. Similarly, this property may contain a tab character, but it will render as a space instead.
Muestras de código
local TweenService = game:GetService("TweenService")
local textLabel = script.Parent
local content = {
"Welcome to my game!",
"Be sure to have fun!",
"Please give suggestions!",
"Be nice to other players!",
"Don't grief other players!",
"Check out the shop!",
"Tip: Don't die!",
}
local tweenInfo = TweenInfo.new(1, Enum.EasingStyle.Sine, Enum.EasingDirection.InOut)
local RNG = Random.new()
local fadeIn = TweenService:Create(textLabel, tweenInfo, {
TextTransparency = 0,
})
local fadeOut = TweenService:Create(textLabel, tweenInfo, {
TextTransparency = 1,
})
local lastIndex
while true do
-- Step 0: Fade out before doing anything
fadeOut:Play()
task.wait(tweenInfo.Time)
-- Step 1: pick content that wasn't the last displayed
local index
repeat
index = RNG:NextInteger(1, #content)
until lastIndex ~= index
-- Make sure we don't show the same thing next time
lastIndex = index
-- Step 2: show the content
textLabel.Text = content[index]
fadeIn:Play()
task.wait(tweenInfo.Time + 1)
endlocal textLabel = script.Parent
local moods = {
["happy"] = "😃",
["sad"] = "😢",
["neutral"] = "😐",
["tired"] = "😫",
}
while true do
for mood, face in pairs(moods) do
textLabel.Text = "I am feeling " .. mood .. "! " .. face
task.wait(1)
end
end
TextBounds
This read-only property reflects the absolute size of rendered text in offsets, meaning that if you try to fit text into a rectangle, this property would reflect the minimum dimensions of the rectangle you'd need in order to fit the text.
Using TextService:GetTextSize(), you can predict what TextBounds will be given a string, Font, TextSize, and frame size.
TextColor3
This property determines the color of all the text rendered by the TextButton element.
Muestras de código
-- Place this code in a LocalScript within a TextLabel/TextButton
local textLabel = script.Parent
-- Some colors we'll use with TextColor3
local colorNormal = Color3.new(0, 0, 0) -- black
local colorSoon = Color3.new(1, 0.5, 0.5) -- red
local colorDone = Color3.new(0.5, 1, 0.5) -- green
-- Loop infinitely
while true do
-- Count backwards from 10 to 1
for i = 10, 1, -1 do
-- Set the text
textLabel.Text = "Time: " .. i
-- Set the color based on how much time is left
if i > 3 then
textLabel.TextColor3 = colorNormal
else
textLabel.TextColor3 = colorSoon
end
task.wait(1)
end
textLabel.Text = "GO!"
textLabel.TextColor3 = colorDone
task.wait(2)
endTextScaled
This property determines whether text is scaled so that it fills the button's entire space. When enabled, TextSize is ignored and TextWrapped is automatically enabled. This property is useful for rendering text elements within BillboardGuis. When this property is used for on-screen UI, it may be helpful to use a UITextSizeConstraint to restrict the range of possible text sizes.
Automatic Sizing
It's recommended that you avoid usage of TextScaled and adjust UI to take advantage of the AutomaticSize property instead. Here are the core differences between the two properties:
TextScaled scales the content (text) to accommodate the UI. Without careful consideration, some text may become unreadable if scaled too small.
AutomaticSize resizes the UI to accommodate content while maintaining a consistent font size. For more information, see here.
Additionally, it's recommended that you avoid applying both AutomaticSize and TextScaled and to the same TextButton. AutomaticSize determines the maximum amount of available space that a GuiObject can use (in this case, text), while TextScaled uses the available space determined by AutomaticSize to scale the font size up to the maximum font size (100) if there are no size constraints.
TextSize
This property determines the height of one line of rendered text. The unit is in offsets, not points (which is used in most document editing programs). The Enum.Font.Legacy font does not hold this property.
TextStrokeColor3
This property sets the color of the stroke, or outline, of rendered text. Along with TextStrokeTransparency, it determines the final visual appearance of the text stroke.
As a powerful alternative which supports color gradients, see UIStroke.
TextStrokeTransparency
This property sets the transparency of the stroke, or outline, of rendered text. Along with TextStrokeColor3, it determines the final visual appearance of the text stroke.
Note that text stroke is multiple renderings of the same transparency, so this property is essentially multiplicative on itself four times over. Therefore, it's recommended to set TextStrokeTransparency to a value in the range of 0.75 to 1 for more a more subtle effect.
As a powerful alternative which supports color gradients, see UIStroke.
TextTransparency
This property determines the transparency of all the text rendered by the TextButton.
TextWrapped
When enabled, this property will render text on multiple lines within a TextButton element's space so that TextBounds will never exceed the GuiBase2d.AbsoluteSize of the element. This is achieved by breaking long lines of text into multiple lines.
Line breaks will prefer whitespace; should a long unbroken word exceed the width of the element, that word will be broken into multiple lines.
If further line breaks would cause the vertical height of the text (the Y component of TextBounds) to exceed the vertical height of the element (the Y component of GuiBase2d.AbsoluteSize), then that line will not be rendered at all.
TextXAlignment
This property determines the horizontal alignment of text rendered within the object's space. It is used in conjunction with TextYAlignment to fully determine text alignment on both axes.
Note that this property won't affect the read-only properties TextBounds and TextFits.
TextYAlignment
This property determines the vertical alignment of text rendered within the object's space. It is used in conjunction with TextXAlignment to fully determine text alignment on both axes.
Note that this property won't affect the read-only properties TextBounds and TextFits.