[oops framework] interface management

Functional specifications

OopsFramework－ Interface management module , It mainly realizes the management of different types of windows in the game , For example, the resident main interface window 、 Pop-up window 、 modal window , System prompt window .

Instructions

Window configuration fields

Field	Introduce
layer	Window level
prefab	Prefabricated resource relative path
bundle	Remote package name

Window configuration data

/**  Unique identification of the interface  */
export enum UIID {
    /**  Resource loading interface  */
    Loading = 1,
    /**  Pop up interface  */
    Window,
    /**  Loading and delay prompt interface  */
    Netinstable
}

/**  Open the configuration data of the interface  */
export var UIConfigData: { [key: number]: UIConfig } = {
    [UIID.Loading]: { layer: LayerType.UI, prefab: "loading/prefab/loading", bundle: "resources" },
    [UIID.Netinstable]: { layer: LayerType.PopUp, prefab: "common/prefab/netinstable" },
    [UIID.Window]: { layer: LayerType.Dialog, prefab: "common/prefab/window" }
}

Open a window

var uic: UICallbacks = {
    //  Add window to interface completion event 
    onAdded: (node: Node, params: any) => {
        var comp = node.getComponent(LoadingViewComp) as ecs.Comp;
    }
    
    //  Window node  destroy  And then back 
    onRemoved:(node: Node | null, params: any) => {
        
    }
};
oops.gui.open(UIID.Loading, null, uic);

The asynchronous function opens a window

var node = await oops.gui.openAsync(UIID.Loading);

Close a window

oops.gui.remove(UIID.Loading);

Specify a node to delete the window

oops.gui.removeByNode(cc.Node);

notes ： there Node It has to be through oops.gui.open or openAsync Only when it is opened will it be closed

Whether there is a window with the specified ID in the cache

oops.gui.has(UIID.Loading);

Fade past hint

oops.gui.toast(" Prompt content ");

Clear all windows

oops.gui.clear();