unreal.XRLoadingScreenFunctionLibrary

class unreal.XRLoadingScreenFunctionLibrary(outer: Object | None = None, name: Name | str = 'None')

Bases: BlueprintFunctionLibrary

XR Loading Screen Function Library

C++ Source:

  • Plugin: XRBase

  • Module: XRBase

  • File: XRLoadingScreenFunctionLibrary.h

classmethod add_loading_screen_splash(texture, translation, rotation, size=[1.000000, 1.000000], delta_rotation=[0.000000, 0.000000, 0.000000], clear_before_add=False) → None

Adds a splash element to the loading screen.

Parameters:

  • texture (Texture) – (in) A texture asset to be used for the splash.

  • translation (Vector) – (in) Initial translation of the center of the splash.

  • rotation (Rotator) – (in) Initial rotation of the splash screen, with the origin at the center of the splash.

  • size (Vector2D) – (in) Size, of the quad with the splash screen.

  • delta_rotation (Rotator) – (in) Incremental rotation, that is added each 2nd frame to the quad transform. The quad is rotated around the center of the quad.

  • clear_before_add (bool) – (in) If true, clears splashes before adding a new one.

classmethod clear_loading_screen_splashes() → None

Clear Loading Screen Splashes

classmethod hide_loading_screen() → None

Hide the splash screen and return to normal display.

classmethod set_loading_screen(texture, scale=[1.000000, 1.000000], offset=[0.000000, 0.000000, 0.000000], show_loading_movie=False, show_on_set=False) → None

Sets the loading screen texture for VR displays.

Parameters:

  • texture (Texture) – (in) A texture asset to be used for the loading screen.

  • scale (Vector2D) – (in) Scale of the loading screen texture quad.

  • offset (Vector) – (in) Offset of the loading screen texture quad relative to the tracking space origin, in meters.

  • show_loading_movie (bool) – (in) If true, support animated texture assets, such as media textures.

  • show_on_set (bool) – (in) If true, immediately show the loading screen after it’s set.

classmethod show_loading_screen() → None

Show the loading screen and override the VR display