Filtering by multiple lobby attributes

[KimulatorsFilms]

Hello,
I have a list that displays all active lobbies in a specific game mode (Lobby Attribute 2) and I want an user to be able to search a lobby by it's name (Lobby Attribute 2).

It should search for lobbies with specific game mode then, within the results, search again for a lobby name that corresponds to the user's input and finally display this lobby to the user. This would be to prevent a lobby from a game mode (eg. Coop) to pop up in the lobby list of another game mode (eg. Versus).

My problem is that I am not sure if there is a way to filter by multiple lobby attributes in a single query and if not, I was wondering if there is a workaround I could do.

For now, I can do both search separately completely fine, I just don't know how to combine them.

Any help will be greatly appreciated!
Thank you!

[WispyMouse]

This isn't demonstrated exactly in the samples, but we have something close. Look to EOSLobbyManager.SearchByAttribute. You can see here how it takes in an attribute key and an attribute value, then puts that together in a search.

First it cooks up a lobby search, which doesn't actually need to relate to your query.

var createLobbySearchOptions = new CreateLobbySearchOptions() { MaxResults = 10}; 
Result result = EOSManager.Instance.GetEOSLobbyInterface().CreateLobbySearch(ref createLobbySearchOptions, out LobbySearch outLobbySearchHandle);

Then it cooks up a parameter set.

LobbySearchSetParameterOptions paramOptions = new LobbySearchSetParameterOptions();
paramOptions.ComparisonOp = ComparisonOp.Equal;

// Turn SearchString into AttributeData
AttributeData attrData = new AttributeData();
attrData.Key = attributeKey.Trim();
attrData.Value = new AttributeDataValue();
attrData.Value = attributeValue.Trim();
paramOptions.Parameter = attrData;

result = outLobbySearchHandle.SetParameter(ref paramOptions);

All you need to do here, is to create an AttributeData for each query you want to search for. Call LobbySearch.SetParameter with as many different parameters as you'd like, and it'll use each one. This'll do exactly what you're asking.

[KimulatorsFilms]

Hi, thanks for the quick response!

I am really not sure if I am doing the right thing and how exactly it should work. I tried adding my two AttributeData like this in the SearchByAttribute function :

LobbySearchSetParameterOptions bucketOptions = new LobbySearchSetParameterOptions();
bucketOptions.ComparisonOp = ComparisonOp.Equal;

AttributeData gameData = new AttributeData();
gameData.Key = attributeKey.Trim();
gameData.Value = new AttributeDataValue();
gameData.Value = attributeValue.Trim();
gameOptions.Parameter = gameData;

result = outLobbySearchHandle.SetParameter(ref gameOptions);

LobbySearchSetParameterOptions nameOptions = new LobbySearchSetParameterOptions();
nameOptions.ComparisonOp = ComparisonOp.Equal;

AttributeData nameData = new AttributeData();
nameData.Key = attributeKey.Trim();
nameData.Value = new AttributeDataValue();
nameData.Value = attributeValue.Trim();
paramOptions.Parameter = nameData;

result = outLobbySearchHandle.SetParameter(ref nameOptions);
            

I am not sure what to pass for the attributeKey and attributeValue of SearchByAttribute(); Normally for searching a single attribute, I would do this:

public void SearchByGameModeAttribute(string searchAttributeValue)
    {
        lobbyManager.SearchByAttribute("gamemode", searchAttributeValue, UIUpdateSearchResults);
    }

[WispyMouse]

You've set up the AttributeData correctly! Now what you need to do is to is execute a search with that. Look to EOSLobby.SearchByAttribute. In the same place that you've set these parameters, you'll then execute a search.

            LobbySearchCallback = SearchCompleted;
            var lobbySearchFindOptions = new LobbySearchFindOptions() { LocalUserId = currentProductUserId };
            outLobbySearchHandle.Find(ref lobbySearchFindOptions, null, OnLobbySearchCompleted);

I suggest taking the code you have above, and this last bit of the SearchByAttribute function, and create your own function for searching. Maybe it'd look like this? You could take this code, add it to EOSLobbyManager.cs or in another file that has access to it.

public void SearchByGameMode(string gameMode, OnLobbySearchCallback SearchCompleted)
{
    // I suggest making one search function, that optionally allows for a lobbyName
    // That way you can use this function (SearchByGameMode) and then later use the more expansive option (SearchByGameModeAndName) without needing to re-implement the searching logic
    SearchByGameModeAndName(gameMode, string.Empty, SearchCompleted);
}

public void SearchByGameModeAndName(string gameMode, string lobbyName, OnLobbySearchCallback SearchCompleted)
{
    ProductUserId currentProductUserId = EOSManager.Instance.GetProductUserId();
    if (!currentProductUserId.IsValid())
    {
        Debug.LogError("Lobbies (SearchByAttribute): Current player is invalid!");
        SearchCompleted?.Invoke(Result.InvalidProductUserID);
        return;
    }
    var createLobbySearchOptions = new CreateLobbySearchOptions() { MaxResults = 10 };
    Result result = EOSManager.Instance.GetEOSLobbyInterface().CreateLobbySearch(ref createLobbySearchOptions, out LobbySearch outLobbySearchHandle);

    if (result != Result.Success)
    {
        Debug.LogErrorFormat("Lobbies (SearchByAttribute): could not create SearchByAttribute. Error code: {0}", result);
        SearchCompleted?.Invoke(result);
        return;
    }

    CurrentSearch = outLobbySearchHandle;

    LobbySearchSetParameterOptions gameModeOptions = new LobbySearchSetParameterOptions();
    gameModeOptions.ComparisonOp = ComparisonOp.Equal;

    // Turn SearchString into AttributeData
    AttributeData attrData = new AttributeData();
    attrData.Key = "gamemode"; // You used gamemode earlier, so this'll probably be the key you want
    attrData.Value = new AttributeDataValue();
    attrData.Value = gameMode;
    gameModeOptions.Parameter = attrData;
    result = outLobbySearchHandle.SetParameter(ref gameModeOptions);

    if (result != Result.Success)
    {
        Debug.LogErrorFormat("Lobbies (SearchByAttribute): failed to update SearchByAttribute with parameter. Error code: {0}", result);
        SearchCompleted?.Invoke(result);
        return;
    }

    if (!string.IsNullOrEmpty(lobbyName))
    {
        LobbySearchSetParameterOptions lobbyNameOptions = new LobbySearchSetParameterOptions();
        lobbyNameOptions .ComparisonOp = ComparisonOp.Equal;

        AttributeData nameData = new AttributeData();
        nameData.Key = "lobbyname"; // Use whatever attribute key you want here, but be consistent!
        nameData.Value = new AttributeDataValue();
        nameData.Value = gameMode;
        lobbyNameOptions.Parameter = nameData;

        result = outLobbySearchHandle.SetParameter(ref lobbyNameOptions);

        if (result != Result.Success)
        {
            Debug.LogErrorFormat("Lobbies (SearchByAttribute): failed to update SearchByAttribute with parameter. Error code: {0}", result);
            SearchCompleted?.Invoke(result);
            return;
        }
    }

    LobbySearchCallback = SearchCompleted;
    var lobbySearchFindOptions = new LobbySearchFindOptions() { LocalUserId = currentProductUserId };
    outLobbySearchHandle.Find(ref lobbySearchFindOptions, null, OnLobbySearchCompleted);
}

Hopefully that helps!

[KimulatorsFilms]

Thank you so much! This works great!

[WispyMouse]

Hooray! One small thing I noticed in my above code, and I'll edit it here. Inside the if (!string.IsNullOrEmpty(lobbyName)) block, replace the first gameModeOptions.ComparisonOp = ComparisonOp.Equal with lobbyNameOptions.ComparisonOp = ComparisonOp.Equal.