LogoLogo
  • SWNetwork SDK Overview
  • Installation
    • Custom Unity Package
  • Tutorials
    • Third-Person Shooter
      • Starter Project Introduction
      • Install SWNetwork
      • Setting up the NetworkClient
      • Sync Player Transform
      • Setting up the Scene Spawner
      • Test and Play
      • Remote Events
      • SyncProperties
      • Player Respawn
      • Updating Room States
      • Winning the Game
    • Basic Lobby
      • Lobby-start
      • Installing SWNetwork SDK and configuring NetworkClient
      • Registering Player
      • Room CRUD
      • Managing Teams
      • Chat
  • SDK
    • Network Client
      • Check-in
      • Game Servers
      • Network Status Event (beta)
      • Classes
        • NetworkClient Class
      • Methods
        • CheckIn() Method
        • ConnectToRoom(Action<bool>) Method
        • DisconnectFromRoom () Method
        • FindSpawner(ushort) Method
    • Game Play
      • Network ID
      • Realtime Agent
      • Remote Event
      • Sync Property
        • Restore Sync Properties
        • Conflict Resolution
      • SceneSpawner
      • RoomPropertyAgent
      • RoomRemoteEventAgent
    • Lobby
      • Register Player
      • Message Player
      • Create Room
      • Change Room Settings
      • Get Rooms
      • Filter Rooms
      • Join Room
      • Message Room
      • Get Players in Room
      • Get Room Custom Data
      • Change Room Custom Data
      • Kick Players
      • Start Room
      • Leave Room
      • Lobby Room Events
        • OnLobbyConnectedEvent
        • OnPlayerMessageEvent
        • OnRoomCustomDataChangeEvent
        • OnNewPlayerJoinRoomEvent
        • OnPlayerLeaveRoomEvent
        • OnNewRoomOwnerEvent
        • OnRoomStartingEvent
        • OnRoomReadyEvent
        • OnFailedToStartRoomEvent
        • OnKickedEvent
        • OnRoomMessageEvent
      • Classes
        • SWLobby Class
        • SWPlayer Class
        • SWRoom Class
        • SWRegisterReply Class
        • SWGetRoomReply Class
        • SWJoinRoomReply Class
        • SWGetRoomCustomDataReply Class
        • SWGetPlayersReply Class
        • SWLobbyIndexData Class
        • SWLobbyFilterData Class
        • SWGetRoomFilterReply Class
        • SWLobbyError Class
        • SWMessagePlayerEventData Class
        • SWMessageRoomEventData Class
        • SWRoomCustomDataChangeEventData Class
        • SWJoinRoomEventData Class
        • SWLeaveRoomEventData Class
        • SWRoomChangeOwnerEventData Class
        • SWStartRoomEventData Class
        • SWRoomReadyEventData Class
        • SWFailedToStartRoomEventData Class
      • Methods
        • Register(Action<bool, SWRegisterReply, SWLobbyError>) Method
        • MessagePlayer(string, string, Action<bool, SWLobbyError>) Method
        • CreateRoom(bool, int, Action<bool, string, SWLobbyError>) Method
        • ChangeRoomSettings(int, int, Action<bool, SWLobbyError>) Method
        • GetRooms(int, int, Action<bool, SWGetRoomReply, SWLobbyError>) Method
        • FilterRoom(SWLobbyFilterData, byte, Action<bool, SWGetRoomFilterReply, SWLobbyError>) Method
        • JoinRoom(string, Action<bool, SWJoinRoomReply, SWLobbyError>) Method
        • JoinRoomRandomly(Action<bool, SWJoinRoomReply, SWLobbyError>) Method
        • JoinOrCreateRoom(bool, int, int, Action<bool, SWJoinRoomReply, SWLobbyError>) Method
        • MessageRoom(string, Action<bool, SWLobbyError>) Method
        • GetRoomCustomData(Action<bool, SWGetRoomCustomDataReply, SWLobbyError>) Method
        • GetPlayersInRoom(Action<bool, SWGetPlayersReply, SWLobbyError>) Method
        • ChangeRoomCustomData(string, Action<bool, SWLobbyError>) Method
        • StartRoom(Action<bool, SWLobbyError>) Method
        • LeaveRoom(Action<bool, SWLobbyError>) Method
  • Open Source Software Used
    • Credits
Powered by GitBook
On this page
  • Overview
  • Example

Was this helpful?

  1. SDK
  2. Lobby

Filter Rooms

Overview

Filters the public rooms of your game in the Lobby server.

Methods

FilterRoom(SWLobbyFilterData, byte, Action<bool, SWGetRoomFilterReply, SWLobbyError>)

Called by players to begin an asynchronous operation to filter rooms in the Lobby server using the specified filterData and count.

Class

The filter data object.

The response object when the operation finished successfully.

The error that occurred when a lobby API operation failed.

Maximum number of indexes of a room is 3.

Maximum page row count is 15.

Example

// Creating a new indexData object
SWLobbyIndexData indexData = new SWLobbyIndexData();

// Adding a string typed index
// with name equals to "level" and 
// value equals to "hard"
indexData.AddIndex("level", "hard");

// Adding a int typed index
// with name equals to "rank" and
// value equals to 50
indexData.AddIndex("rank", 50);

// Using the indexData to create room
NetworkClient.Lobby.CreateRoom("new room", true, 4, indexData, (successful, reply, error) =>{
    if (successful){
        Debug.Log("Room created " + reply);
    }
    else{
        Debug.Log("Failed to create room " + error);
    }
});
// Creating a new filterData object
SWLobbyFilterData filterData = new SWLobbyFilterData();

// Adding a string typed filter
// with name equals to "level" and
// value equals to "hard"
filterData.AddFilter("level", "hard");

// Adding a int typed index
// with name equals to "rank" and
// value between 1 to 100
filterData.AddFilter("rank", 1, 100);

// Using the filterData to filter rooms
// 10 is the max number of return rooms
NetworkClient.Lobby.FilterRoom(filterData, 10, (okay, reply, error) =>{
    if (okay){
        Debug.Log("Filtered rooms " + reply);
    }
    else{
        Debug.Log("Failed to Filtered rooms " + error);
    }
});
PreviousGet RoomsNextJoin Room

Last updated 5 years ago

Was this helpful?

SWLobbyFilterData
SWGetRoomFilterReply
SWLobbyError