YaUIText¶
YaUIText is the class that manages texts in the game.
Properties¶
string Text¶
CLIENT ONLY
The content of the text
number Length¶
CLIENT ONLY
Gets the text length.
boolean Ubb¶
CLIENT ONLY
Determines whether the UBB is enabled. Defaults to true.
AlignType Align¶
CLIENT ONLY
Determines the alignment type of the text frame: 0 for left-aligned, 1 for center-aligned, and 2 for right-aligned.
boolean SingleLine¶
CLIENT ONLY
Determines if the single line mode is enabled. Defaults to true.
Functions¶
void SetFontSize(number value)¶
CLIENT ONLY
Sets the font size of the text.
void ApplyFormat()¶
CLIENT ONLY
Applies the changes of the text font.
void SetFontBold(boolean value)¶
CLIENT ONLY
Sets the text in bold.
void SetFontItalic(boolean value)¶
CLIENT ONLY
Sets the text in italic.
YaUITextTypingEffect GetTypingEffect()¶
CLIENT ONLY
Get text typing effect
void ShowTypeWritterText(string text, number speed)¶
CLIENT ONLY
Sets up the typewriter effect.
void SetMaxWidth(number max)¶
CLIENT ONLY
Sets up the text max width.
void SetSpeed(number speed)¶
CLIENT ONLY
Sets the speed of the typewriter.
void PauseAndResume(boolean value)¶
CLIENT ONLY
Pauses or resumes the typewriter effect.
void ShowAll()¶
CLIENT ONLY
Displays the full texts.
boolean IsOver()¶
CLIENT ONLY
Determines if the typewriter effect is displayed. Defaults to true.
void DoDispose()¶
CLIENT ONLY
Disposes of this UI.
