Document-LoadingScreenWithLoadPercentage

This is a plugin that converts UMG into a slate widget, displays a loading screen, and displays the loading percentage with a progress bar and text.

This is a video on how to use it.

The plugin should probably be enabled by default, but if you can't use it, see below. First, activate the plugin.

Check the plugin and restart the editor.

Open the Plugin/LoadingScreenWithLoadPercentage Content folder.

If you can't see the plugin folder, check Show Plugin Content.

If you don't have your own UMG loading screen, duplicate BP_LoadingScreenUserWidget and move it to your content folder.

If you want to use your own UMG loading screen, change ParentClass in ClassSettings to LoadingScreenUserWidget.

If you want to display loading progress in a bar, it must be a ProgressBar.

If you want to display the loading progress as text, it must be Text. Also, the Text of Content must be half-width or full-width %.

Here we will use a loading screen with the default character as an example.

First, select the loading screen you want to use with Create Widget.

Minimum Display Time: specifies the minimum number of seconds of loading screen you want to display.

Next, drag the Return Value of CreateWidgetReturn Value of CreateWidget and use the BeginAsyncLoadWithPercentageUpdate function. In Object Path: You need the object path of the level you want to open to open the level and get loading progress. It's a little confusing, so I'll write about it below.

In Timer Interval: Time interval to update percentages.

Use FInterp to Movement: Smoothly move the progress bar and text that indicate loading progress. If you remove this check, accurate display will occur, but the values ​​will change rapidly.

In Interp Speed: The value used for FInterp to. The higher the value, the faster the loading progress will be.

Min Change Amount with Target Limit: FIntterp to moves much slower when approaching 100%, so set it to the lowest value.

About In Object Path. In my case the reference is /Script/Engine.World'/Game/ThirdPerson/Maps/ThirdPersonMap.ThirdPersonMap' Delete this first and last symbol.

/Game/ThirdPerson/Maps/ThirdPersonMap.ThirdPersonMap

If you play in the viewport or editor window, you can see the percentage movement in the output log. Searching for Logtemp is invalid.

Adjust it to your liking.

The output log can be displayed from the Window at the top left.

Loading screen editing must be done before SetupLoadingScreen.

recommend using custom events and interfaces to make it easier to use. If you want to change it, you can just change that part.

In this example, we decided to put the map in a common folder and created an ObjectPath using Append. This makes it easier to use because you only need to enter the LevelName.

We also recommend creating a Bool variable like IsLoading to limit the display of loading screens. If you set the default value to false, it will automatically become false after the level transition, which is convenient.

For the loading screen widget, we recommend using Scale Box, Stretch to Scale to Fit, and Stretch Direction to Both. (If you do not do this, the display may change during Open Level)

Set WidthOverride and HeightOverride to the size you expect.

*There was information that using ScaleBox and SizeBox at the same time increases the speed. It may be better not to use SizeBox.

Note that the value of SetGlobalTimeDilation is clamped to the Min Global Time Dilation found in the World Setting. The above example is for Min Global Time Dilation's default value of 0.0001.

Unlike poses, input actions are effective. If you have a problem, please limit it using DisableInput or a Bool variable such as IsLoading. Also, since it doesn't completely stop the game, you may want to limit damage processing with something like CanBeDamaged.

This plugin does not work properly with asset localization. This is an example of a countermeasure. Get the current culture and use the switch node to create different widgets for each language. The variable to be set must be “LoadingScreenUserWidget”. *Localization dashboard works fine.

It is important to use this plugin's functions outside of UMG.

Add M_SectorsLoadingEffect.

You can change the settings in M_SectorsLoadingEffect_Inst in the plugin's material folder.

Now get percentages from BP, Now use Circle Progress Bar. I have a simple Circle Progress Bar material in my materials folder.

Added on 2024/02/26 I created a material instance of Circle Progress Bar.

This is the loading screen BP.

*Note that you must use the BeginAsyncLoadWithPercentageUpdate function!

Enable Fade In / Fade Out: Set to true to enable each effect. In Fade In / Out Timer Interval: Execution interval for each fade step. In Fade In / Out Speed: Speed of opacity change per step. Higher values = faster transitions.

Note that the two Timer Intervals are affected by Global Time Dilation. Use the function before starting the load.

Add Background Material. The following sites are recommended for textures used for effects.

Use MakeArray and enter the ObjectPath in InSublevelObjectPath.

You can check the progress of each load. The total load percentage is divided by the number of packages.

Added interp type to FadeIn and FadeOut.

*The test results show that the ZOrder of the slate widget is -10 compared to UMG. When displaying the load screen, we internally add 10 to the ZOrder to make it feel the same as UMG.