Universal Fade

An asset by KoBeWi
The page banner background of a mountain and forest
Universal Fade thumbnail image
Universal Fade thumbnail image
Universal Fade hero image

Quick Information

0 ratings
Universal Fade icon image
KoBeWi
Universal Fade

Allows you to fade out and fade in the screen with a single line of code. No configuration needed, just install the addon and you can use it.Example:Fade.fade_out()This will fade the screen to black over 1 second.You can achieve scene transition with these 3 lines:await Fade.fade_out().finishedget_tree().change_scene(new_scene)Fade.fade_in()The fade methods take these arguments (all optional):time - time of the fade (in seconds). 1 by defaultcolor - the color to fade to/from. Black by defaultpattern - the fade pattern. See below. Empty string for no pattern (default)reverse - if using pattern, this will reverse it. Default is falsesmooth - if using pattern, this will make it smooth. Default is falseThere's also a method for crossfading (i.e. interweawing two screens). It also takes two methods, where only one takes (optional) arguments:Fade.crossfade_prepare(time, pattern, reverse, smooth)get_tree().change_scene(new_scene)Fade.crossfade_execute()The node comes with 5 patterns: Diagonal, Diamond, GradientHorizontal, GradientVertical, Noise, Swirl. Just type the name of the pattern to use it, e.g. Fade.fade_out(1, Color.BLACK, "Diamond")You can add custom fade patterns by putting PNG files to "addons/UniversalFade/Patterns" folder. The name format is: "<name>.png", where <name> is what you will provide as argument for the method. They should use grayscale colors and they will fade from white to black. The pattern directory can be changed using "addons/universal_fade/patterns_directory" project setting.Check the repo for more info and some GIFs.

Supported Engine Version
4.0
Version String
1.3
License Version
MIT
Support Level
community
Modified Date
4 months ago
Git URL
Issue URL

Allows you to fade out and fade in the screen with a single line of code. No configuration needed, just install the addon and you can use it.

Example:
Fade.fade_out()
This will fade the screen to black over 1 second.

You can achieve scene transition with these 3 lines:
await Fade.fade_out().finished
get_tree().change_scene(new_scene)
Fade.fade_in()

The fade methods take these arguments (all optional):
time - time of the fade (in seconds). 1 by default
color - the color to fade to/from. Black by default
pattern - the fade pattern. See below. Empty string for no pattern (default)
reverse - if using pattern, this will reverse it. Default is false
smooth - if using pattern, this will make it smooth. Default is false

There's also a method for crossfading (i.e. interweawing two screens). It also takes two methods, where only one takes (optional) arguments:

Fade.crossfade_prepare(time, pattern, reverse, smooth)
get_tree().change_scene(new_scene)
Fade.crossfade_execute()

The node comes with 5 patterns: Diagonal, Diamond, GradientHorizontal, GradientVertical, Noise, Swirl. Just type the name of the pattern to use it, e.g. Fade.fade_out(1, Color.BLACK, "Diamond")

You can add custom fade patterns by putting PNG files to "addons/UniversalFade/Patterns" folder. The name format is: ".png", where is what you will provide as argument for the method. They should use grayscale colors and they will fade from white to black. The pattern directory can be changed using "addons/universal_fade/patterns_directory" project setting.

Check the repo for more info and some GIFs.

Reviews

0 ratings

Your Rating

Headline must be at least 3 characters but not more than 50
Review must be at least 5 characters but not more than 500
Please sign in to add a review

Quick Information

0 ratings
Universal Fade icon image
KoBeWi
Universal Fade

Allows you to fade out and fade in the screen with a single line of code. No configuration needed, just install the addon and you can use it.Example:Fade.fade_out()This will fade the screen to black over 1 second.You can achieve scene transition with these 3 lines:await Fade.fade_out().finishedget_tree().change_scene(new_scene)Fade.fade_in()The fade methods take these arguments (all optional):time - time of the fade (in seconds). 1 by defaultcolor - the color to fade to/from. Black by defaultpattern - the fade pattern. See below. Empty string for no pattern (default)reverse - if using pattern, this will reverse it. Default is falsesmooth - if using pattern, this will make it smooth. Default is falseThere's also a method for crossfading (i.e. interweawing two screens). It also takes two methods, where only one takes (optional) arguments:Fade.crossfade_prepare(time, pattern, reverse, smooth)get_tree().change_scene(new_scene)Fade.crossfade_execute()The node comes with 5 patterns: Diagonal, Diamond, GradientHorizontal, GradientVertical, Noise, Swirl. Just type the name of the pattern to use it, e.g. Fade.fade_out(1, Color.BLACK, "Diamond")You can add custom fade patterns by putting PNG files to "addons/UniversalFade/Patterns" folder. The name format is: "<name>.png", where <name> is what you will provide as argument for the method. They should use grayscale colors and they will fade from white to black. The pattern directory can be changed using "addons/universal_fade/patterns_directory" project setting.Check the repo for more info and some GIFs.

Supported Engine Version
4.0
Version String
1.3
License Version
MIT
Support Level
community
Modified Date
4 months ago
Git URL
Issue URL

Open Source

Released under the AGPLv3 license

Plug and Play

Browse assets directly from Godot

Community Driven

Created by developers for developers