Put it all together - Introduction to party - (Unity module)

Last updated on March 24, 2025

Connect the UI to display, leave, send invite, kick, and promote party member​

  1. Open the PartyMenu_Starter class and declare the variable below to reference the party wrapper you have created.

    private PartyEssentialsWrapper_Starter partyWrapper;

  2. Next, update the DisplayParty() function by adding the code below. This function gets the party details and then displays the party member entries.

    private void DisplayParty() 
    {
        if (!partyWrapper) 
        {
            BytewarsLogger.LogWarning("Failed to display party. Party wrapper is null.");
            return;
        }

        // Abort if no user is logged-in.
        PlayerState currentUser = GameData.CachedPlayerState;
        if (currentUser == null) 
        {
            BytewarsLogger.LogWarning("Failed to display party. There is no current user logged-in.");
            return;
        }

        widgetSwitcher.SetWidgetState(AccelByteWarsWidgetSwitcher.WidgetState.Loading);

        // Immediately clean the old party member list.
        int oldEntriesCount = memberEntryContainer.childCount;
        for (int i = 0; i < oldEntriesCount; i++) 
        {
            Transform oldEntry = memberEntryContainer.GetChild(0).transform;
            oldEntry.SetParent(null);
            DestroyImmediate(oldEntry.gameObject);
        }

        // Display party details.
        partyWrapper.GetPartyDetails((Result<PartyEssentialsModels.PartyDetailsModel> result) => 
        {
            // Instantiate party members.
            if (!result.IsError) 
            {
                foreach (BaseUserInfo memberInfo in result.Value.MemberUserInfos)
                {
                    bool isLeader = memberInfo.userId == result.Value.PartySession.leaderId;
                    PartyMemberEntry memberEntry = Instantiate(memberEntryPrefab, memberEntryContainer);
                    memberEntry.SetPartyMember(memberInfo, isLeader);
                }
            }
            /* If failed to get party details because the player is not in any party.
            * Then, display current logged-in player entry only.*/
            else if (partyWrapper.CurrentPartySession == null) 
            {
                PartyMemberEntry memberEntry = Instantiate(memberEntryPrefab, memberEntryContainer);
                memberEntry.SetPartyMember(new BaseUserInfo 
                {
                    userId = currentUser.PlayerId,
                    displayName = currentUser.PlayerName,
                    avatarUrl = currentUser.AvatarUrl
                }, true);
            }
            // Else, display error message.
            else 
            {
                widgetSwitcher.ErrorMessage = "Failed to load party. An error occurred.";
                widgetSwitcher.SetWidgetState(AccelByteWarsWidgetSwitcher.WidgetState.Error);
                return;
            }

            // Display empty entries to add a new party member.
            int maxMembers = PartyEssentialsModels.PartyMaxMembers;
            int maxEmptyEntries = Mathf.Clamp(maxMembers - memberEntryContainer.childCount, 0, maxMembers);
            for (int i = 0; i < maxEmptyEntries; i++)
            {
                PartyMemberEntry memberEntry = Instantiate(memberEntryPrefab, memberEntryContainer);
                memberEntry.ResetPartyMember();
            }

            widgetSwitcher.SetWidgetState(AccelByteWarsWidgetSwitcher.WidgetState.Not_Empty);
        });
    }

  3. Then, update the LeaveParty() function by adding the code below. This function sends the request to leave the party. Upon success, this function closes the party menu.

    private void LeaveParty() 
    {
        // If not in party, simply close the menu.
        if (partyWrapper.CurrentPartySession == null) 
        {
            backButton.onClick.Invoke();
            return;
        }

        widgetSwitcher.SetWidgetState(AccelByteWarsWidgetSwitcher.WidgetState.Loading);

        partyWrapper.LeaveParty((Result result) =>
        {
            if (result.IsError) 
            {
                widgetSwitcher.ErrorMessage = "Failed to leave party. An error occurred.";
                widgetSwitcher.SetWidgetState(AccelByteWarsWidgetSwitcher.WidgetState.Error);
                return;
            }

            backButton.onClick.Invoke();
        });
    }

  4. Now, update the function binding in the pre-defined OnEnable() function. This function initializes the wrapper, button bindings, and displays the party information when the party menu is shown.

    private void OnEnable()
    {
        backButton.onClick.AddListener(MenuManager.Instance.OnBackPressed);
        leaveButton.onClick.AddListener(LeaveParty);
        widgetSwitcher.OnRetryButtonClicked += DisplayParty;

        partyWrapper = TutorialModuleManager.Instance.GetModuleClass<PartyEssentialsWrapper_Starter>();
        if (partyWrapper) 
        {
            partyWrapper.OnPartyUpdateDelegate += DisplayParty;
            DisplayParty();
        }
    }

  5. Next, deinitialize the function bindings when the party menu is closed. Add the code below to the OnDisable() function.

    private void OnDisable()
    {
        backButton.onClick.RemoveAllListeners();
        leaveButton.onClick.RemoveAllListeners();
        widgetSwitcher.OnRetryButtonClicked -= DisplayParty;

        if (partyWrapper) 
        {
            partyWrapper.OnPartyUpdateDelegate -= DisplayParty;
        }
    }

  6. The code to show party members on the UI is complete. Now, you need to call several functions to perform party-related actions. Open the PartyEssentialsWrapper_Starter class and add the code below to the respective predefined functions. What this does is call the respective party actions when the party action button is clicked. These action buttons are the generated buttons mentioned in the Add a Party Menu tutorial of this module.

    public void OnInviteToPartyButtonClicked(string inviteeUserId)
    {
        SendPartyInvite(inviteeUserId);
    }
    public void OnKickPlayerFromPartyButtonClicked(string targetUserId)
    {
        KickPlayerFromParty(targetUserId);
    }
    public void OnPromotePartyLeaderButtonClicked(string targetUserId)
    {
        PromotePartyLeader(targetUserId);
    }

Resources​

Last updated on

On this page