Document_UEPlugin_LoadingScreenWithLoadPercentage

Loading Screen With Load Percentage-CodePlugin-9.99$

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.

Demo

This is a video on how to use it.

1.Activate the plugin

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

First, open the Plugins tab.

Check the plugin and restart the editor.

2.Configure UMG

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.

Note: Circle bars using Image are not supported.

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 %.

3.Show loading screen

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.

Next, drag the Return Value of CreateWidget and use the SetupLoadingScreen function.

CreateWidget's Return Value needs to be connected not only to the Target but also to the Loading Widget.

Minimum Display Time:

specifies the minimum number of seconds of loading screen you want to display.

Next, drag the Return Value of CreateWidget and use the BeginAsyncLoadWithPercentageUpdate function.

↓Listed below.

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'

is.

Delete this first and last symbol.

/Game/ThirdPerson/Maps/ThirdPersonMap.ThirdPersonMap

Be careful not to make a mistake.

・Add / in front of Game

・Delete the last '

If you play in the viewport or editor window, you can see the percentage movement in the output log.

Searching for Logtemp is invalid.

TargetPercentage: Actual progress.Target of FInterpTo.

CurrentPercentage: Percentage of progress bar or text.

ElapsedTime: Elapsed time since loading started.

Adjust it to your liking.

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

4.Supplement

Loading screen editing must be done before SetupLoadingScreen.

We 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.

A: MapFolderPath

B&D: LevelName

C: .（dot）

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.

The function BeginLoadingScreenSimple is a simple function that does not capture loading progress.

If you don't want to display percentages, this is fine.

InTimerInterval is the frequency to check whether loading has finished.

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)

Added on 2024/02/25.

It is easier to adjust if SizeBox is a child of ScaleBox.

Set WidthOverride and HeightOverride to the size you expect.

Added on 2024/10/15

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

5.Note

Pseudo pause

This plugin will not work if you pause the game with SetGamePaused.

You can pseudo-pause it by using SetGlobalTimeDilation (example: 0.0001).

I think it would be a good idea to set InTimerInteraval to a value that is one-tenth of GlobalTimeDilation (example: 0.00001).

In this example, InInterpSpeed of 10000.0 seems good.

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.

(We will update the plugin to allow you to choose whether to pause the game when it becomes possible to stop it.)

Be careful how you back up

If you set the parent class to LoadingScreenUserWidget, you will not be able to open BP unless this plugin is enabled.

Once you have edited your loading screen, we recommend that you take a backup by duplicating it and changing the parent class to UserWidget.

Asset Localization

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.

postscript:

When using this plugin's functions on UMG, I found that there were problems with asset localization other than loading screens.

If you have a problem, move it to a custom event such as character or game mode and call it on UMG.

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

Update_2023/11/01_ver1.1

Fade In＆Fade Out

You can now set Fade In and Fade Out.

Enable Fade In: Set to true to enable Fade In.

In Fade In Timer Interval: Fade In execution interval.

In Fade In Speed: Fade In speed. Render opacity increases by one time.

Enable Fade Out: Set to true to enable Fade Out.

In Fade Out Timer Interval: Fade Out execution interval.

In Fade Out Speed: Fade Out speed. Render opacity reduced to 1 degree.

Note that the two Timer Intervals are affected by Global Time Dilation.

2024/02/24_Addendum: Created new SetFadeIn and SetFadeOut functions.

*Depending on the blend mode of the material, you may not be able to operate the render opacity correctly.

Example: I was able to manipulate render opacity as intended with Translucent, but not with Opaque.

Works standalone

It now works standalone as well.

Update_2023/11/04_ver1.11

SectorsLoadingEffect

Add M_SectorsLoadingEffect.

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

Update_2024/02/25_ver1.2

Circle Progress Bar

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.

EventOnPercentageUpdate: Event called every time a percentage is updated.

GetLoadPercentaeg: Pure function to get load percentage.

*Note that you must use the BeginAsyncLoadWithPercentageUpdate function!

It is easier to adjust if SizeBox is a child of ScaleBox.

Set WidthOverride and HeightOverride to the size you expect.

Migrate FadeIn and FadeOut settings to separate functions

There were too many BeginAsyncLoadWithPercentageUpdate items, so I created new SetFadeIn and SetFadeOut functions.

Use the function before starting the load.

Update_2024/03/01_ver1.21_Avoid error

Now avoid errors when loading for the first time.

Specifically, we limited NativeTick execution to the game thread.

Update_2024/03/07_ver1.22_Background Material

Add Background Material.

The following sites are recommended for textures used for effects.

EffectTextureMaker

https://mebiusbox.github.io/contents/EffectTextureMaker/

Update_2024/03/07_ver1.23_fix black screen

Fixed an issue where the setup loading screen would momentarily turn black.

Update_2024/03/20_ver1.24

Supports sublevels

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.

Deprecation of function “BeginLoadingScreenSimple”

Update_2024/04/09_ver1.25 EFadeInOutInterpType

Added interp type to FadeIn and FadeOut.

Page updated

Google Sites

Report abuse