Fade
The Fade controller allows for easy and simple fade-in and fade-out effects on the screen.
For most cases, using just the In
and Out
methods is enough.
Methods¶
In([Number duration [, Boolean async]])
¶
Fade in from black.
1 2 3 |
|
Out([Number duration [, Boolean async]])
¶
Fade out to black.
1 2 3 |
|
To(Number transparency [, Number duration [, Boolean async]])
¶
Fade to the given transparency, starting at whatever the current fade transparency is set.
1 |
|
FromTo(Number from, Number to [, Number dur [, Boolean async]])
¶
Fade from one transparency level to another. This is also used internally by the In
and Out
fade methods.
1 |
|
SetText(String text)
¶
Set the text that will show up in the center of the screen when the fade screen is visible.
1 |
|
ClearText()
¶
Clear the text on the fade screen.
1 |
|
SetTextSize(Number textSize)
¶
Set the text size for the fade screen label.
1 |
|
SetFont(Font font)
¶
Set the font for the fade screen label.
1 |
|
SetBackgroundColor(Color3 color)
¶
Sets the background color of the fade frame.
1 |
|
SetTextColor(Color3 color)
¶
Sets the text color of the fade text label.
1 |
|
SetEasingStyle(EasingStyle easingStyle)
¶
Sets the tween easing style for the fading effect. Defaults to Quad.
1 |
|
GetScreenGui()
¶
Returns the ScreenGui used by the Fade controller.
1 |
|
GetFrame()
¶
Returns the Frame used by the Fade controller.
1 |
|
GetLabel()
¶
Returns the TextLabel used by the Fade controller.
1 |
|