Put it all together - Presence essentials - (Unreal Engine module)

Last updated on March 24, 2025

Connect UI to display presence​

In this tutorial, you will connect the implementation you created in PresenceEssentialsSubsystem_Starter to the presence widget.

  1. Open the PresenceWidget_Starter class CPP file and replace the RefreshPresence() function with the code below. This code retrieves the player's presence and displays it on the screen.

    void UPresenceWidget_Starter::RefreshPresence(bool bForceQueryPresence)
    {
        if (!PresenceUserId) 
        {
            UE_LOG_PRESENCEESSENTIALS(Warning, TEXT("Unable to get presence to be displayed on the widget. User Id is not valid."));
            return;
        }

        Tb_Presence->SetVisibility(ESlateVisibility::Collapsed);
        Th_Loader->SetVisibility(ESlateVisibility::Visible);
        
        PresenceEssentialsSubsystem->GetPresence(
            PresenceUserId,
            bForceQueryPresence,
            FOnPresenceTaskComplete::CreateWeakLambda(this, [this](const bool bWasSuccessful, const TSharedPtr<FOnlineUserPresenceAccelByte> Presence)
            {
                // Abort if the widget is being destroyed.
                if (!IsValid(this) || IsUnreachable()) 
                {
                    return;
                }

                FString PresenceStr;

                // Set offline if presence is invalid.
                if (!bWasSuccessful || !Presence)
                {
                    PresenceStr = TEXT_PRESENCE_OFFLINE.ToString();
                }
                // Set valid presence.
                else 
                {
                    // Set online and status.
                    if (Presence->bIsOnline)
                    {
                        PresenceStr = TEXT_PRESENCE_ONLINE.ToString();

                        // Presence status is only be displayed if the presence widget is not displayed in a list entry.
                        if (!ParentListView && 
                            !Presence->Status.StatusStr.IsEmpty() &&
                            !Presence->Status.StatusStr.Equals(FString("nil"), ESearchCase::IgnoreCase))
                        {
                            PresenceStr += FString("\n") + Presence->Status.StatusStr;
                        }
                    }
                    // Set last seen.
                    else
                    {
                        PresenceStr = GetLastOnline(Presence->LastOnline);
                    }
                }

                // Display presence.
                Th_Loader->SetVisibility(ESlateVisibility::Collapsed);
                Tb_Presence->SetAutoWrapText(ParentListView == nullptr);
                Tb_Presence->SetScrollingEnabled(ParentListView != nullptr);
                Tb_Presence->SetText(FText::FromString(PresenceStr));
                Tb_Presence->SetVisibility(ESlateVisibility::Visible);

                // Refresh list if any.
                if (ParentListView)
                {
                    ParentListView->RequestRefresh();
                }

                const FUniqueNetIdAccelByteUserPtr PresenceUserABId = StaticCastSharedPtr<const FUniqueNetIdAccelByteUser>(PresenceUserId);
                if (!PresenceUserABId)
                {
                    UE_LOG_PRESENCEESSENTIALS(Log, TEXT("Presence widget is updated for user: %s"), *PresenceUserABId->GetAccelByteId());
                    return;
                }
            }
        ));
    }

  2. Then, open the PresenceWidget_Starter class Header file and declare the following functions.

    protected:
    // ...
        void OnPresenceUpdated(const FUniqueNetId& UserId, const TSharedRef<FOnlineUserPresence>& Presence);
    protected:
    // ...
        void OnBulkQueryPresenceComplete(const bool bWasSuccessful, const FUserIDPresenceMap& Presences);

  3. Then, return to the PresenceWidget_Starter class CPP file and define the OnPresenceUpdated() function. This function refreshes the widget when a presence update is received.

    void UPresenceWidget_Starter::OnPresenceUpdated(const FUniqueNetId& UserId, const TSharedRef<FOnlineUserPresence>& Presence)
    {
        const FUniqueNetIdAccelByteUserPtr PresenceUserABId = StaticCastSharedPtr<const FUniqueNetIdAccelByteUser>(PresenceUserId);
        if (!PresenceUserABId)
        {
            return;
        }

        if (PresenceUserABId && UserId == PresenceUserId.ToSharedRef().Get())
        {
            UE_LOG_PRESENCEESSENTIALS(Log, TEXT("Received presence update for user: %s. Updating the presence widget."), *PresenceUserABId->GetAccelByteId());
            RefreshPresence();
        }
    }

  4. In the same file, define the OnBulkQueryPresenceComplete() function. Similarly, this function refreshes the widget when the bulk query for presence is received. This event is called when the friend list or blocked player list is updated.

    void UPresenceWidget_Starter::OnBulkQueryPresenceComplete(const bool bWasSuccessful, const FUserIDPresenceMap& Presences)
    {
        const FUniqueNetIdAccelByteUserPtr PresenceUserABId = StaticCastSharedPtr<const FUniqueNetIdAccelByteUser>(PresenceUserId);
        if (!PresenceUserABId)
        {
            return;
        }

        if (bWasSuccessful && Presences.Contains(PresenceUserABId->GetAccelByteId()))
        {
            UE_LOG_PRESENCEESSENTIALS(Log, TEXT("Received bulk presence update for user: %s. Updating the presence widget."), *PresenceUserABId->GetAccelByteId());
            RefreshPresence();
        }
    }

  5. Now, complete the code by binding the functions you have created. To do this, replace the predefined OnSetupPresenceComplete() function with the code below.

    void UPresenceWidget_Starter::OnSetupPresenceComplete()
    {
        // Bind presence events.
        if (!PresenceEssentialsSubsystem->GetOnBulkQueryPresenceCompleteDelegates()->IsBoundToObject(this))
        {
            PresenceEssentialsSubsystem->GetOnPresenceReceivedDelegates()->AddUObject(this, &ThisClass::OnPresenceUpdated);
            PresenceEssentialsSubsystem->GetOnBulkQueryPresenceCompleteDelegates()->AddUObject(this, &ThisClass::OnBulkQueryPresenceComplete);
        }

        // Get and display presence.
        const AAccelByteWarsGameState* GameState = Cast<AAccelByteWarsGameState>(GetWorld()->GetGameState());
        const AAccelByteWarsInGameGameState* InGameGameState = Cast<AAccelByteWarsInGameGameState>(GameState);
        bool bForceQueryPresence = InGameGameState != nullptr;
        
        RefreshPresence(bForceQueryPresence);
    }

  6. Finally, unbind those events when the widget is destroyed. To do this, replace the predefined NativeDestruct() function with the code below.

    void UPresenceWidget_Starter::NativeDestruct()
    {
        // Clear cache.
        PresenceUserId = nullptr;
        ParentListView = nullptr;

        // Unbind presence events.
        PresenceEssentialsSubsystem->GetOnPresenceReceivedDelegates()->RemoveAll(this);
        PresenceEssentialsSubsystem->GetOnBulkQueryPresenceCompleteDelegates()->RemoveAll(this);

        Super::NativeDestruct();
    }

Resources​

Last updated on

On this page