Search Results for

    Show / Hide Table of Contents

    Class LoadingScreen

    Singleton that load a scene while showing a window.

    Inheritance
    object
    Object
    Component
    Behaviour
    MonoBehaviour
    SingletonBehaviour
    SingletonBehaviour<LoadingScreen>
    LoadingScreen
    Inherited Members
    SingletonBehaviour<LoadingScreen>.Instance
    SingletonBehaviour<LoadingScreen>.Initialized
    Namespace: GGL.UI
    Assembly: GGL.dll
    Syntax
    [AddComponentMenu("GG-Library/Singletons/Loading Screen")]
    [HelpURL("https://ggl.yoannhaffner.com/articles/ui.html#loading-screen")]
    public class LoadingScreen : SingletonBehaviour<LoadingScreen>

    Properties

    | Edit this page View Source

    OnLoadProgress

    Declaration
    public static UnityEvent<float> OnLoadProgress { get; }
    Property Value
    Type Description
    UnityEvent<float>

    Event raised each frame during load. Contains progression in range [0,1]

    | Edit this page View Source

    Processes

    Declaration
    public static PriorityQueue<IEnumerator, int> Processes { get; }
    Property Value
    Type Description
    PriorityQueue<IEnumerator, int> Singleton that load a scene while showing a window.

    Methods

    | Edit this page View Source

    Load(string)

    Loads a new scene after fading on the canvas

    Declaration
    public static void Load(string sceneName)
    Parameters
    Type Name Description
    string sceneName

    Scene to be loaded

    Events

    | Edit this page View Source

    OnLoadCompleted

    Declaration
    public static event Action OnLoadCompleted
    Event Type
    Type Description
    Action

    Event raised each when the window is finally closed.

    • Edit this page
    • View Source
    In this article
    Back to top Generated by DocFX