VerseIsland Sign in
Verse Library › UI
Browse Verse Library

UI Container And API Module

Module — 2 files
These files compile together (same module folder).
ez_ui_container.verse 
<#
    A bare minimum script for building upon the EZUI method of displaying UI
#>

using { /Fortnite.com/Devices }
using { /Verse.org/Simulation }
using { /UnrealEngine.com/Temporary/Diagnostics }

#imports
using { /UnrealEngine.com/Temporary/UI }
using { /Fortnite.com/UI }
using {EZUI}

EZ_UIClass := class () 
{

    EZ_LinkedCreativeDevice<public> : ez_ui_container      # a backreference to the device that created this EZUI class
    EZ_LinkedPlayer<public> : player                       # the player linked to this instance of the EZUI class
    EZ_UI_ID<public> : int                                 # used to control what UI is drawn by EZUI
    
    var IsInitialized<private> : logic = false              # a lock to prevent recreating the canvas after the first execution of Initialize()
    var MainCanvas<private> : canvas = canvas{}             # the canvas that holds all the screen elements and will be added to the PlayerUI


    # do all the things
    Ini<public>() : void =
        if (IsInitialized?): 
            return

        if(EZ_UI_ID = 1): # for if you want multiple UI per device, defaults to 1


    GetMainCanvas<public>() : canvas = MainCanvas

    OpenUI<public>() : void =
        EZUI.InsertWidget(EZ_LinkedPlayer,GetMainCanvas())
        Print("EZUI: MainCanvas Opened. Thank you for using EZUI :)")


} # END EZ_UI ------------------------------------------------------------------------------------------------------------------------------------

ez_ui_container := class(creative_device):

    @editable ShowUITrigger : trigger_device = trigger_device {}

    # UI regisitration
    var PlayerToUIMap : [player]EZ_UIClass = map{} #[playerdata]/ez_ui class

    OnBegin<override>()<suspends> : void =
        ShowUITrigger.TriggeredEvent.Subscribe(OpenUI)

    # all the steps needed to open the Pop Up
    OpenUI<private>(MaybePlayer : ?agent) : void = 
    {
    
        # check that the event was triggered by a player and stop if it wasn't
        Result := EZUI.IsAPlayer(MaybePlayer,Self)
        if (Result = false):
            return
        #.........................

        var UI_ID : int = 1 #allows for different UI to be displayed
            
        if(PlayerAgent := MaybePlayer?):

            # Verify if an Linked pop-up manager already exists and uses it, if not, create a new one
            if ( InteractingPlayer := player[PlayerAgent] ) 
            {   
                var OptPlayerUI :?EZ_UIClass = false
        
                if (ThisPlayerUI := PlayerToUIMap[InteractingPlayer])
                { set OptPlayerUI = option{ThisPlayerUI} }
                    
                else if (ThisPlayerUI := set PlayerToUIMap[InteractingPlayer] = EZ_UIClass

                            #everything that is passed to the pop-up manager
                            { 
                                EZ_LinkedPlayer := InteractingPlayer,
                                EZ_LinkedCreativeDevice := Self, 
                                EZ_UI_ID := UI_ID
            
                            }
                        ) 
                    
                { ThisPlayerUI.Ini(), set OptPlayerUI = option{ThisPlayerUI} }
        
                # Try to open the Interface for the player
                if (PlayerUI := OptPlayerUI?):
                    PlayerUI.OpenUI()
                else 
                    { Print("EZUI: Error when getting saved or creating ThisPlayerUI") }
            }
        #.........................
    }


<#
    a special thamks to: 
        Mayapple
        SprinterMax
        Daigorō
        UEFN Discord community

    ****************************************************************************************
    Made with EZUI, please follow @kryyative on Instagram Threads and @KryyssX on X (Twitter)
    for more useful Snippets, UEFN & UE5 news,tutorials and community spotlights!
    ****************************************************************************************

    If you found EZUI useful please include the text above in your credits to show your support
    for my work and encourage others to use EZUI for their projects. Thank you! ^_^
#>
Sign in to download module

Copy-paste each file above is always free.

Comments

    Sign in to vote, comment, or suggest an edit. Sign in