TextLabel

Afficher les obsolètes

*Ce contenu est traduit en utilisant l'IA (Beta) et peut contenir des erreurs. Pour consulter cette page en anglais, clique ici.

Un TextLabel rend un rectangle, comme un Frame , avec un texte stylé.Le rectangle peut être utilisé pour définir les limites du texte, la mise à l'échelle du texte ( TextScaled ), l'emballage ( TextWrapped ) et l'alignement ( TextXAlignment et/ou TextYAlignment ).

Cette classe contient des propriétés qui contrôlent l'affichage du texte, telles que Font et TextColor3.Pour afficher uniquement du texte et masquer le rectangle de fond, définissez BackgroundTransparency à 1.

Un objet UITextSizeConstraint peut être utilisé pour restreindre la taille du texte avec TextScaled activé.Il est recommandé que la taille du texte ne soit pas inférieure à 9 , sinon il peut ne pas être visible pour de nombreux utilisateurs.

Résumé

Propriétés

Propriétés hérités de GuiObjectPropriétés hérités de GuiBase2d
Afficher tous les hérités de Instance
Afficher tous les hérités de Object

Méthodes

Méthodes hérités de GuiObject
Afficher tous les hérités de Instance
Afficher tous les hérités de Object

Évènements

Évènements hérités de GuiObjectÉvènements hérités de GuiBase2d
Afficher tous les hérités de Instance
Afficher tous les hérités de Object

Propriétés

ContentText

string
Lecture uniquement
Non répliqué
Lecture parallèle

Cette propriété fournit une copie de Text qui contient exactement ce qui est rendu par le TextLabel.Cela est utile pour éliminer les balises de style utilisées pour le marquage de texte enrichi ; par exemple, lorsque RichText est activé, la propriété ContentText montre le texte tel qu'il apparaît à l'utilisateur.

<th>Texte</th>



    <th>Texte du contenu</th>

  </tr>

</thead>



<tbody>

  <tr>

    <td><code>faux</code></td>



    <td><b>Bonjour,<br/> monde !</b></td>



    <td><b>Bonjour,<br/> monde !</b></td>

  </tr>



  <tr>

    <td><code>vrai</code></td>



    <td><b>Bonjour,<br/> monde !</b></td>



    <td>Bonjour, monde !</td>

  </tr>

</tbody>
Texte riche

Font

Enum.Font
Caché
Non répliqué
Lecture parallèle

Cette propriété sélectionne l'une des plusieurs polices préfinies avec lesquelles le TextLabel rendra son texte.Certaines polices ont des variantes audacieuses, italiennes et/ou légères.

A l'exception de la police Enum.Font.Legacy , chaque police rendra du texte avec une hauteur de ligne égale à la propriété TextSize .

La police Enum.Font.Code est la seule police en monospace.Il a la propriété unique que chaque personnage a la même largeur et la même hauteur exacte de 1:2, où la largeur de chaque personnage est environ la moitié de la propriété TextSize.

Cette propriété est maintenue en synchronie avec la propriété FontFace.

Échantillons de code

This code sample renders a list of all the available fonts.

Show All Fonts
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

end

FontFace

Enum.Font
Lecture parallèle

Cette propriété est similaire à la propriété Font mais permet de définir des polices qui n'existent pas dans Enum.Font .

Cette propriété est maintenue en synchronie avec la propriété Font , de sorte que lorsque vous définissez FontFace , la police est définie sur la valeur correspondante Enum.Font ou sur Enum.Font.Unknown si il n'y a pas de correspondances.

LineHeight

number
Lecture parallèle

Contrôle la hauteur des lignes en tant que multiple de la taille carrée de la police par le biais de l'ajustement de l'espacement entre les lignes de texte dans le .Les valeurs valides se situent entre 1.0 et 3.0 , par défaut à 1.0 .

LocalizedText

string
Caché
Lecture uniquement
Non répliqué
Lecture parallèle

Cette propriété détermine si un TextLabel doit regarder GuiBase2d.Localize ou non.

MaxVisibleGraphemes

number
Lecture parallèle

Cette propriété contrôle le nombre maximum de graphèmes (ou d'unités de texte) qui sont affichés sur le TextLabel.Il est principalement fourni comme une façon facile de créer un effet de machine à écrire où les caractères apparaissent un à la fois.

Changer la propriété ne change pas la position ou la taille des graphemes visibles ; le layout sera calculé comme si tous les graphemes étaient visibles.

Définir la propriété à -1 désactive la limite et montre l'intégralité du Text.

OpenTypeFeatures

string
Lecture parallèle

OpenTypeFeaturesError

string
Lecture uniquement
Non répliqué
Lecture parallèle

RichText

boolean
Lecture parallèle

Cette propriété détermine si la TextLabel rend son texte en utilisant la balise texte enrichi pour décorer les sections du texte en gras, en italique, dans des couleurs spécifiques, et plus encore.

Pour utiliser du texte enrichi, incluez simplement des balises de formatage de texte enrichi dans la chaîne Text.

Text

string
Lecture parallèle

Cette propriété détermine le contenu du texte rendu par le TextLabel.Les propriétés visuelles de la chaîne rendue sur l'écran sont déterminées par TextColor3 , TextTransparency , TextSize , Font , TextScaled , TextWrapped , TextXAlignment et TextYAlignment.

Il est possible de rendre des emojis tels que 🔒 et d'autres symboles qui ne sont pas affectés par la propriété TextColor3.Ces derniers peuvent être collés dans Script et LocalScript objets, ainsi que dans le champ dans la fenêtre propriétés.

Cette propriété peut contenir des caractères de saut de ligne. De même, cette propriété peut contenir un caractère de tab, mais elle sera rendue comme un espace à la place.

Échantillons de code

This code sample creates a fading banner for a TextLabel. It fades text out, chooses a random string (avoiding repetition), and fades back in.

Fading Banner
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)

end

This code sample demonstrates emoji rendering using the Text property.

Emoji in Text
local 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

Vector2
Lecture uniquement
Non répliqué
Lecture parallèle

Cette propriété de lecture seule reflète la taille absolue du texte rendu en décalage, ce qui signifie que si vous essayez de faire tenir du texte dans un rectangle, cette propriété refléterait les dimensions minimales du rectangle dont vous auriez besoin pour faire tenir le texte.

En utilisant TextService:GetTextSize(), vous pouvez prédire ce que TextBounds sera donné une chaîne, Font, TextSize et la taille du cadre.

TextColor3

Color3
Lecture parallèle

Cette propriété détermine la couleur de tout le texte rendu par l'élément TextLabel.

Échantillons de code

This code sample makes a TextLabel or TextButton count backwards from 10, setting the text color as it does so.

Countdown Text
-- 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)

end

TextDirection

Enum.TextDirection
Lecture parallèle

Enum.TextDirection dans lequel le texte est rendu.

TextFits

boolean
Lecture uniquement
Non répliqué
Lecture parallèle

Une représentation booléenne de savoir si le texte de la étiquettes'inscrit dans sa taille.

TextScaled

boolean
Lecture parallèle

Cette propriété détermine si le texte est redimensionné afin de remplir l'espace entier de l'étiquette.Lorsqu'il est activé, TextSize est ignoré et TextWrapped est automatiquement activé.Cette propriété est utile pour rendre des éléments de texte dans BillboardGuis .Lorsque cette propriété est utilisée pour l'interface utilisateur sur écran, il peut être utile d'utiliser un UITextSizeConstraint pour restreindre la portée des tailles de texte possibles.

Taille automatique

Il est recommandé d'éviter l'utilisation de TextScaled et d'ajuster l'interface utilisateur pour profiter de la propriété AutomaticSize à la place.Voici les principales différences entre les deux propriétés :

  • TextScaled échelle le contenu (le texte) pour accommoder l'interface utilisateur. Sans réflexion soigneuse, certains textes peuvent devenir illisibles si leur taille est trop petite.

  • AutomaticSize redimensionne l'interface utilisateur pour accueillir le contenu tout en maintenant une taille de police cohérente. Pour plus d'informations, voir ici .

En outre, il est recommandé d'éviter d'appliquer à la fois AutomaticSize et TextScaled et au même TextLabel .AutomaticSize détermine la quantité maximale d'espace disponible que GuiObject peut utiliser (dans ce cas, du texte), alors que TextScaled utilise l'espace disponible déterminé par AutomaticSize pour augmenter la taille de police jusqu'à la taille maximale de police (100) s'il n'y a pas de contraintes de taille.

TextSize

number
Lecture parallèle

Cette propriété détermine la hauteur d'une ligne de texte rendu.L'unité est en décalage, pas en points (qui est utilisée dans la plupart des programmes d'édition de documents).La police Enum.Font.Legacy n'a pas cette propriété.

TextStrokeColor3

Color3
Lecture parallèle

Cette propriété définit la couleur du trait ou du contour du texte rendu.Avec TextStrokeTransparency, il détermine l'apparence visuelle finale du trait de texte.

En tant qu'alternative puissante qui prend en charge les gradients de couleur, voir UIStroke .

TextStrokeTransparency

number
Lecture parallèle

Cette propriété définit la transparence du trait, ou du contour, du texte rendu.Avec TextStrokeColor3, il détermine l'apparence visuelle finale du trait de texte.

Notez que le trait de texte est plusieurs rendements de la même transparence, donc cette propriété est essentiellement multiplicative sur elle-même quatre fois.Il est donc recommandé de définir TextStrokeTransparency à une valeur dans la plage de 0.75 à 1 pour un effet plus subtil.

En tant qu'alternative puissante qui prend en charge les gradients de couleur, voir UIStroke .

TextTransparency

number
Lecture parallèle

Cette propriété détermine la transparence de tout le texte rendu par le TextLabel .

TextTruncate

Enum.TextTruncate
Lecture parallèle

Contrôle la troncation du texte affiché dans le TextLabel.

TextWrapped

boolean
Lecture parallèle

Lorsqu'il est activé, cette propriété rendra du texte sur plusieurs lignes dans l'espace d'un élément TextLabel afin que TextBounds ne dépasse jamais le GuiBase2d.AbsoluteSize de l'élément.Cela est réalisé en divisant des longues lignes de texte en plusieurs lignes.

Les breaks de ligne préféreront l'espace blanc ; si un mot long non coupé dépasse la largeur de l'élément, ce mot sera divisé en plusieurs lignes.

Si d'autres ruptures de ligne provoquaient une hauteur verticale du texte (la composante Y de TextBounds) supérieure à la hauteur verticale de l'élément (la composante Y de GuiBase2d.AbsoluteSize), cette ligne ne serait pas rendue du tout.

TextXAlignment

Enum.TextXAlignment
Lecture parallèle

Cette propriété détermine l'alignement horizontal du texte rendu dans l'espace de l'objet.Il est utilisé en conjonction avec TextYAlignment pour déterminer entièrement l'alignement du texte sur les deux axes.

Notez que cette propriété n'affectera pas les propriétés de lecture seule TextBounds et TextFits.

TextYAlignment

Enum.TextYAlignment
Lecture parallèle

Cette propriété détermine l'alignement vertical du texte rendu dans l'espace de l'objet.Il est utilisé en conjonction avec TextXAlignment pour déterminer entièrement l'alignement du texte sur les deux axes.

Notez que cette propriété n'affectera pas les propriétés de lecture seule TextBounds et TextFits.

Afficher tous les hérités de Instance
Afficher tous les hérités de Object

Méthodes

Afficher tous les hérités de Instance
Afficher tous les hérités de Object

Évènements

Afficher tous les hérités de Instance
Afficher tous les hérités de Object