Transition Options

All transition functions (change_scene, reload_scene, fade_in_place, fade_in, fade_out) take a simple godot Dictionary as a parameter. You can define some or all of the following options for one specific call, and the remaining ones will stay as their default value. You can also edit the defaults in Project > Project Settings > Scene Manager > Defaults.

For example, if you write something like this:

SceneManager.reload_scene({ "speed": 4 })

Your scene will reload with a transition that is twice as fast as the default, but all the other parameters (animation, color, wait time, etc.) will stay the same.

Here are all the possible options with their type, default value, and explanation:

Key	Type	Default value	Explanation	Can be set on Project Settings
speed	float	2	Speed of the moving transition.	✅
color	Color	Color('#000000')	Color to use for the transition screen. It's black by default.	✅
wait_time	float	0.5	Time spent in the transition screen while switching scenes. Leaving it at 0 with fade will result in the screen not turning black, so it waits a little bit by default.	✅
pattern	String or Texture	'fade'	Pattern to use for the transition. Using a simple name will load the premade patterns we have designed (check the list down below!). Otherwise, you may pass an absolute path to your own pattern "res://my_pattern.png" or a Texture object.	✅
pattern_enter	String or Texture	Same as 'pattern' value	Same as pattern, but overrides the pattern only for the fade-to-black transition.	❌
pattern_leave	String or Texture	Same as 'pattern' value	Same as pattern, but overrides the pattern only for the fade-from-black transition.	❌
invert_on_enter	Bool	false	Wether the transition should invert when fading into of black.	✅
invert_on_leave	Bool	true	Wether the transition should invert when fading out of black. This usually looks better on, the effect is that the first pixels that turned black are the first ones that fade into the new screen. This generally works for "sweep" transitions like "horizontal", but others such as "curtains" might look better with this flag turned off.	✅
ease	float	1.0	Amount of ease the animation should have during the transition.	✅
ease_enter	float	Same as 'ease' value	Amount of ease the animation should have during the fade-to-black transition.	❌
ease_leave	float	Same as 'ease' value	Amount of ease the animation should have during the fade-from-black transition.	❌
background_loading	Bool	true	Loads the new scene on a worker thread so the load overlaps the fade out instead of blocking it. On by default.	✅
loading_screen	Bool, String or PackedScene	null	A loading screen to show while the new scene loads. Pass true for the built-in one, or a PackedScene/absolute path for your own. Setting this implies background_loading.	✅
min_loading_time	float	0.0	Minimum time in seconds to keep the loading screen up, so a fast load doesn't make it flash past. Setting it above 0 implies background_loading.	✅
animation_name	String	'Fade'	Name of the animation called on the internal animation_player. Useful if you set a custom animation player via set_animation_player or Project > Project Settings > Scene Manager > Defaults > Animation Player	✅
cache_mode	ResourceLoader.CacheMode	CACHE_MODE_IGNORE	The cache mode to load the new scene with.	✅ (Advanced)
skip_scene_change	Bool	false	If set to true, skips the actual scene change/reload, leaving only the transition.	✅ (Advanced)
skip_fade_out	Bool	false	If set to true, skips the initial "fade" part of the transition	✅ (Advanced)
skip_fade_in	Bool	false	If set to true, skips the final "fade" part of the transition	✅ (Advanced)
on_tree_enter	Callable(new_scene: Node)	Empty Callable	Custom callback called when the new scene enters the tree hierarchy	❌
on_ready	Callable(new_scene: Node)	Empty Callable	Custom callback called when the new scene is ready	❌
on_fade_out	Callable	Empty Callable	Custom callback called when the fade_out is finished (screen completely black)	❌
on_fade_in	Callable	Empty Callable	Custom callback called when the fade_in is finished (transition completely finished)	❌

Built-in patterns:

• "fade"
• "circle"
• "curtains"
• "diagonal"
• "horizontal"
• "radial"
• "scribbles"
• "squares"
• "vertical"