Back To Top

The following functions and constants allow you to use Steam's Lobbies and Matchmaking functionality.

These functions are provided for handling the current lobby:

• steam_lobby_activate_invite_overlay
• steam_lobby_create
• steam_lobby_get_data
• steam_lobby_get_lobby_id
• steam_lobby_get_member_count
• steam_lobby_get_member_id
• steam_lobby_get_owner_id
• steam_lobby_is_owner
• steam_lobby_join_id
• steam_lobby_leave
• steam_lobby_set_data
• steam_lobby_set_joinable
• steam_lobby_set_owner_id
• steam_lobby_set_type
• steam_lobby_get_chat_message_data
• steam_lobby_get_chat_message_size
• steam_lobby_get_chat_message_text
• steam_lobby_send_chat_message
• steam_lobby_send_chat_message_buffer

The following functions allow retrieving and handling lists of public lobbies.

• steam_lobby_list_add_distance_filter
• steam_lobby_list_add_near_filter
• steam_lobby_list_add_numerical_filter
• steam_lobby_list_add_string_filter
• steam_lobby_list_request
• steam_lobby_list_get_count
• steam_lobby_list_get_data
• steam_lobby_list_get_lobby_id
• steam_lobby_list_get_lobby_member_count
• steam_lobby_list_get_lobby_member_id
• steam_lobby_list_get_lobby_owner_id
• steam_lobby_list_is_loading

These are the constants used by this API:

• LobbyFilterComparisonType
• LobbyFilterDistanceMode
• LobbyType

Back To Top

Displays an invitation overlay if currently in a lobby. The invitation overlay is much akin to the friends-list overlay, but only shows online friends, and shows an "invite" buttons on each row.

Syntax:

steam_lobby_activate_invite_overlay();

Returns:

bool

Triggers:

Asynchronous Steam Event (when an invitation is accepted)

Example:

steam_lobby_activate_invite_overlay();

The above code will show the Steam invite overlay.

Back To Top

Starts creating a lobby. Returns whether or not the task was successfully created. This is an asynchronous function that will trigger the Steam Async Event when the task is finished.

Syntax:

steam_lobby_create(type, max_members);

Returns:

bool

Triggers:

Asynchronous Steam Event

Example:

steam_lobby_create(steam_lobby_type_public, 4);

The above code will create a lobby with a maximum of 4 users. We now add the following into the Steam Async Event for checking the success of task:

var type = async_load[? "type"];
if (type == "lobby_created")
{
    if (async_load[? "success"])
        show_debug_message("Lobby created");
    else
        show_debug_message("Failed to create lobby");
}

in the example we are simply outputting the success of the lobby creation task.

Back To Top

Returns the data of a message sent using steam_lobby_send_chat_message_buffer. Returns whether or not the buffer was successfully filled with the message data.

Syntax:

steam_lobby_get_chat_message_data(message_index, buffer);

Returns:

bool

Example:

chat_message_buf = buffer_create(steam_lobby_max_chat_message_size, buffer_fixed, 1);
steam_lobby_get_chat_message_data(_msg_index, chat_message_buf)

The code above will get the current message data and place it into a buffer (resizing if required and allowed, ie.: buffer_grow).

Back To Top

Return the size of a message

Syntax:

steam_lobby_get_chat_message_size(message_index)

Returns:

real

Example:

// ... INSIDE A STEAM ASYNC EVENT ...
switch (async[? "event_type"])
{
    case "lobby_chat_message":
        size = steam_lobby_get_chat_message_size(async_load[?"message_index"]);
        break;
}

The code above will get the current message size in bytes.

Back To Top

Return the text of a message.

Syntax:

steam_lobby_get_chat_message_text(index);

Returns:

string

Example:

// ... INSIDE A STEAM ASYNC EVENT ...
switch (async[? "event_type"])
{
    case "lobby_chat_message":
        text = steam_lobby_get_chat_message_text(async_load[?"message_index"]);
        break;
}

The code above will get the current message text.

Back To Top

Returns a lobby field value, as set by steam_lobby_set_data.

Syntax:

steam_lobby_get_data(key);

Returns:

string

Example:

var title = steam_lobby_get_data("title");

The code above will return the data of the title field of the current value.

Back To Top

Syntax:

steam_lobby_get_lobby_id();

Returns:

int64

Example:

var lobby_id = steam_lobby_get_lobby_id()

The code above will get the current lobby id and store it in a variable.

Back To Top

Returns the number of users in the current lobby (including you). If the lobby is not valid, returns 0.

Syntax:

steam_lobby_get_member_count();

Returns:

real

Example:

for(var i = 0 ; i < steam_lobby_get_member_count() ; i++)
{
    var user_id = steam_lobby_get_member_id(i)
    //Do something with the user id
}

The code sample above will get the total number of member in the current lobby and iterate over all of them getting their unique ids, using the steam_lobby_get_member_id function.

Back To Top

Returns the user ID of the member at the given index in the current lobby.

Syntax:

steam_lobby_get_member_id(index);

Returns:

int64

Example:

for(var i = 0 ; i < steam_lobby_get_member_count() ; i++)
{
    var user_id = steam_lobby_get_member_id(i)
    //Do something with the user id
}

The code sample above will iterate over all of the members inside a lobby and get their unique ids.

Back To Top

Returns the lobby's owner's Steam ID. If the lobby is not valid, returns ID 0.

Syntax:

steam_lobby_get_owner_id();

Returns:

int64

Example:

var lobby_owner = steam_lobby_get_owner_id()

The code above will return the unique id of the owner of the current lobby.

Back To Top

Returns whether the local player is the lobby's owner.

ℹ️ NOTE

If the lobby is not valid, returns false.

Syntax:

steam_lobby_is_owner()

Returns:

bool

Example:

for (var i = 0; i < steam_lobby_get_member_count(); i++)
{
    if (!steam_lobby_is_owner())
    {
        var user_id = steam_lobby_get_member_id(i)
        steam_lobby_set_owner_id(user_id)
        break;
    }
}

The code example will loop through all the members in a lobby and transfers ownership to the first member that is not the owner.

Back To Top

Starts joining a lobby with the given ID. Returns whether or not the API was correctly initialized. This is an asynchronous function that will trigger the Steam Async Event when the task is finished.

Syntax:

steam_lobby_join_id(lobby_id);

Returns:

N/A

Triggers:

Asynchronous Steam Event

Example:

steam_lobby_join_id(lobbyID)

The code will attempt the join a lobby with a given id, the task callback can be listened to inside the the Steam Async Event with the folllowing sample code:

var type = async_load[? "type"];
if (type == "lobby_joined")
{
    var lobby_id = async_load[? "lobby_id"];
    var success = async_load[? "success"];

    // Do something with the data
}

In the example we are simply caching the data into variables.

Back To Top

Leaves the current lobby (if any). Does not raise any errors if currently not in a lobby.

ℹ️ NOTE

If you are the lobby owner and leave the lobby, Steam transfers lobby ownership to any other available user, so you may need to manually handle ownership transfer using steam_lobby_set_owner_id before leaving.

Syntax:

steam_lobby_leave();

Returns:

N/A

Example:

steam_lobby_leave();

The code sample above will make the user leave the current lobby.

Back To Top

Broadcasts a chat text message to all the users in the lobby.

Syntax:

steam_lobby_send_chat_message(text);

Returns:

bool

Triggers:

Asynchronous Steam Event

Example:

steam_lobby_send_chat_message("Hello World");

The code will broadcast a text message to all the members in the current lobby, the message can be read using the Steam Async Event callback:

var type = async_load[? "type"];
if (type == "lobby_chat_message")
{
    var user_id = async_load[? "user_id"];
    var msg_id = async_load[? "message_index"];

    var user_name = steam_get_user_persona_name_sync(user_id);
    var message = steam_lobby_get_chat_message_text(msg_id);

    // Do something with the data
}

In the example we are simply caching the data into variables notice that use use the function steam_get_user_persona_name_sync and steam_lobby_get_chat_message_text to get both the user name and the text inside the message, respectively.

Back To Top

Broadcasts a chat (text or binary data) message to all the users in the lobby.

Syntax:

steam_lobby_send_chat_message_buffer(buffer, size);

Returns:

bool

Triggers:

Asynchronous Steam Event

Example:

var buff = buffer_create(256, buffer_fixed, 1);
buffer_write(buff, buffer_string, "This is a buffer!");
steam_lobby_send_chat_message_buffer(buff);

The code will broadcast a message (text or binary data) to all the members in the current lobby, the message can be read using the Steam Async Event callback:

var type = async_load[? "type"];
if (type == "lobby_chat_message")
{
    var user_id = async_load[? "user_id"];
    var msg_id = async_load[? "message_index"];

    var user_name = steam_get_user_persona_name_sync(user_id);
    var data = steam_lobby_get_chat_message_data(global.chat_buffer, msg_id);

    // Do something with the data
}

In the example we are simply caching the data into variables notice that use use the function steam_get_user_persona_name_sync and steam_lobby_get_chat_message_data to get both the user name and the data inside the message, respectively.

Back To Top

Changes a lobby's field. You must be the lobby's owner to do this. Returns whether or not the data was set. Fields can then be used to filter lobbies via matchmaking functions.

ℹ️ NOTE

If your value is numeric, convert it to string prior to passing it to the function.

Syntax:

steam_lobby_set_data(key, value);

Returns:

bool

Example:

steam_lobby_set_data("LobbyName","GreatLobby")

The code sample will set the "LobbyName" lobby field to the provided value ("GreatLobby").

Back To Top

Sets whether or not a lobby is join-able by other players. This always defaults to enabled for a new lobby. Returns whether or not the property was set.

ℹ️ NOTE

If joining is disabled, then no players can join, even if they are a friend or have been invited.

ℹ️ NOTE

Lobbies with joining disabled will not be returned from a lobby search.

Syntax:

steam_lobby_set_joinable(joinable);

Returns:

bool

Example:

steam_lobby_set_joinable(false);

The code above will prevent user from joining the current lobby.

Back To Top

If you are a lobby owner, transfers the lobby ownership to the specified player, which must be in this same lobby. Returns whether or not the property was set.

ℹ️ NOTE

You need to be the lobby owner in order to use the function.

Syntax:

steam_lobby_set_owner_id(user_id);

Returns:

bool

Example:

for(var i = 0 ; i < steam_lobby_get_member_count() ; i++)
{
    if(!steam_lobby_is_owner())
    {
        var user_id = steam_lobby_get_member_id(i)
        steam_lobby_set_owner_id(user_id)
        break;
    }
}

The code example will loop through all the members in a lobby and transfers ownership to the first member that is not the owner.

Back To Top

Changes the lobby's type. Useful, if you don't allow mid-session joining, you could have the game make lobbies private on session start (or use steam_lobby_set_joinable).

ℹ️ NOTE

You need to be the lobby owner in order to use the function.

Syntax:

steam_lobby_set_type(type)

Returns:

N/A

Example:

steam_lobby_set_type(steam_lobby_type_private)

The code above will change the lobby joining policy.

Back To Top

Restricts results by region and sorts them based on geographical proximity.

Syntax:

steam_lobby_list_add_distance_filter(mode);

Returns:

bool

Example:

steam_lobby_list_add_distance_filter(steam_lobby_list_distance_filter_far);
steam_lobby_list_add_near_filter("myNearFilter", 77);
steam_lobby_list_add_numerical_filter("level", 10, steam_lobby_list_filter_gt);
steam_lobby_list_add_string_filter("Stage","BattleZone", steam_lobby_list_filter_eq)
steam_lobby_list_request();

The code above will apply some filters to be lobby list request before requesting the results.

Back To Top

Sorts the results based on how close their field's (key)'s value is to the provided one.

ℹ️ NOTE

If multiple near-filters are specified, the earlier-set ones take precedence.

Syntax:

steam_lobby_list_add_near_filter(key, value);

Returns:

bool

Example:

steam_lobby_list_add_distance_filter(steam_lobby_list_distance_filter_far);
steam_lobby_list_add_near_filter("myNearFilter", 77);
steam_lobby_list_add_numerical_filter("level", 10, steam_lobby_list_filter_gt);
steam_lobby_list_add_string_filter("Stage","BattleZone", steam_lobby_list_filter_eq)
steam_lobby_list_request();

The code above will apply some filters to be lobby list request before requesting the results.

Back To Top

Sets up a numeric filter for the next lobby list request. That is, lobbies not matching the condition will be excluded from results.

ℹ️ NOTE

Lobbies without the given field (key) will be excluded.

Syntax:

steam_lobby_list_add_numerical_filter(key, value, comparison_type)

Returns:

bool

Example:

steam_lobby_list_add_distance_filter(steam_lobby_list_distance_filter_far);
steam_lobby_list_add_near_filter("myNearFilter", 77);
steam_lobby_list_add_numerical_filter("level", 10, steam_lobby_list_filter_gt);
steam_lobby_list_add_string_filter("Stage","BattleZone", steam_lobby_list_filter_eq)
steam_lobby_list_request();

The code above will apply some filters to be lobby list request before requesting the results.

Back To Top

Sets up a string filter for the next lobby list request. That is, lobbies not matching the condition will be excluded from results.

ℹ️ NOTE

Lobbies without the given field (key) will be assumed to have it as "".

Syntax:

steam_lobby_list_add_string_filter(key, value, comparison_type)

Returns:

bool

Example:

steam_lobby_list_add_distance_filter(steam_lobby_list_distance_filter_far);
steam_lobby_list_add_near_filter("myNearFilter", 77);
steam_lobby_list_add_numerical_filter("level", 10, steam_lobby_list_filter_gt);
steam_lobby_list_add_string_filter("Stage","BattleZone", steam_lobby_list_filter_eq)
steam_lobby_list_request();

The code above will apply some filters to be lobby list request before requesting the results.

Back To Top

Return count of lobbies, after a successful call to steam_lobby_list_request.

Syntax:

steam_lobby_list_get_count();

Returns:

real

Example:

for(var a = 0 ; a < steam_lobby_list_get_count() ; a++)
{
    ins = instance_create_depth(600,200+90*a,0,Obj_Steam_Networking_List_Slot);
    ins.index = a
    ins.lobby_id = steam_lobby_list_get_lobby_id(a)
    ins.creator = steam_lobby_list_get_data(a, "Creator")
}

After a successful steam_lobby_list_request this function will return the number of results in the lobby query.

Back To Top

Gets the metadata associated with the specified key from the specified lobby.

ℹ️ NOTE

The argument lobby_index is not a lobby id but instead the position of the lobby (from 0 to steam_lobby_list_get_count) on the query array after a steam_lobby_list_request async event is triggered.

Syntax:

steam_lobby_list_get_data(lobby_index, key);

Returns:

string

Example:

for(var a = 0 ; a < steam_lobby_list_get_count() ; a++)
{
    ins = instance_create_depth(600,200+90*a,0,Obj_Steam_Networking_List_Slot);
    ins.index = a
    ins.lobby_id = steam_lobby_list_get_lobby_id(a)
    ins.creator = steam_lobby_list_get_data(a, "Creator")
}

The above code will show a code example.

Back To Top

Gets the lobby id associated to the index.

ℹ️ NOTE

The argument lobby_index is not a lobby id but instead the position of the lobby (from 0 to steam_lobby_list_get_count) on the query array after a steam_lobby_list_request async event is triggered.

Syntax:

steam_lobby_list_get_lobby_id(lobby_index);

Returns:

int64

Example:

for(var a = 0; a < steam_lobby_list_get_count(); a++)
{
    ins = instance_create_depth(600, 200+90*a, 0, Obj_Steam_Networking_List_Slot);
    ins.index = a;
    ins.lobby_id = steam_lobby_list_get_lobby_id(a);
    ins.creator = steam_lobby_list_get_data(a, "Creator");
}

The above code will show a code example.

Back To Top

Gets the number of users in a lobby.****

ℹ️ NOTE

The argument lobby_index is not a lobby id but instead the position of the lobby (from 0 to steam_lobby_list_get_count) on the query array after a steam_lobby_list_request async event is triggered.

Syntax:

steam_lobby_list_get_lobby_member_count(lobby_index);

Returns:

real

Example:

steam_lobby_list_get_lobby_member_count(steam_lobby_get_lobby_id());

The above code will show a code example.

Back To Top

Gets the Steam ID of the lobby member at the given index.

ℹ️ NOTE

The argument lobby_index is not a lobby id but instead the index representation of the lobby (ranging from 0 to steam_lobby_list_get_count) on the query array after a steam_lobby_list_request async event is triggered. By the same logic the member_index is also not the user id but the indexed representation of the user within the lobby (this value ranges from 0 to steam_lobby_list_get_lobby_member_count).

Syntax:

steam_lobby_list_get_lobby_member_id(lobby_index, member_index);

Returns:

int64

Example:

var count = steam_lobby_list_get_lobby_member_count(steam_lobby_get_lobby_id())
for(var i = 0 ; i < count ; i++)
{
     var member = steam_lobby_list_get_lobby_member_id(i)
     //do something with the member id
}

The above code will show a code example.

Back To Top

Returns the current lobby owner.

ℹ️ NOTE

The argument lobby_index is not a lobby id but instead the position of the lobby (from 0 to steam_lobby_list_get_count) on the query array after a steam_lobby_list_request async event is triggered.

Syntax:

steam_lobby_list_get_lobby_owner_id(index);

Returns:

int64

Example:

steam_lobby_list_get_lobby_owner_id(steam_lobby_get_lobby_id());

The above code will show a code example.

Back To Top

Returns whether a lobby list request is currently underway.

Syntax:

steam_lobby_list_is_loading();

Returns:

bool

Example:

steam_lobby_list_request();

// Later in code

if (steam_lobby_list_is_loading)
    show_message("Loading");

The above will code will check to see if the lobby list request is still loading or has finished.

Back To Top

Starts joining a lobby with the given ID. This is an asynchronous function that will trigger the Steam Async Event when the task is finished.

Syntax:

steam_lobby_list_join(index);

Returns:

N/A

Triggers:

Asynchronous Steam Event

Example:

steam_lobby_list_join(0)

The code sample above can be used to join a lobby with the given index after a steam_lobby_list_request as been preformed.

Back To Top

Starts loading the list of lobbies matching the current filters. This is an asynchronous function that will trigger the Steam Async Event when the task is finished.

ℹ️ NOTE

Filters are reset afterwards and have to be set again for subsequent request(s).

ℹ️ NOTE

Existing results are kept up until the event is dispatched.

Syntax:

steam_lobby_list_request()

Returns:

N/A

Triggers:

Asynchronous Steam Event

Example:

steam_lobby_list_add_distance_filter(steam_lobby_list_distance_filter_far);
steam_lobby_list_add_near_filter("myNearFilter", 77);
steam_lobby_list_add_numerical_filter("level", 10, steam_lobby_list_filter_gt);
steam_lobby_list_add_string_filter("Stage","BattleZone", steam_lobby_list_filter_eq)
steam_lobby_list_request();

In this extended example we will request the lobby list that matches the requested filter criteria and parse its results in the Steam Async Event. to start with we need to request the lobbies with the code above. And afterwards proceed to catch the results after/during the corresponding asynchronous event:

var type = ds_map_find_value(async_load, "event_type");
if (type == "lobby_list")
{
    var lb_count = steam_lobby_list_get_count();
    for (var i = 0; i < lb_count; i++)
    {
        var lb_ID = steam_lobby_list_get_lobby_id(i);
        var lb_owner = steam_lobby_list_get_lobby_owner_id(i);
        var lb_members_count = steam_lobby_list_get_lobby_member_count(i);
        for (var j = 0; j < lb_members_count; j++)
        {
            var lb_member_ID = steam_lobby_list_get_lobby_member_id(i, j);
            // Do what even you need with the queried information
        }
    }
}

This code will loop through all the loobies and respective members on the query result.

Back To Top

These constants specify the comparison type when applying a filter to a lobby list request by calling the following functions:

• steam_lobby_list_add_numerical_filter
• steam_lobby_list_add_string_filter

Back To Top

These constants specify the distance mode to be used when applying a filter to a lobby list request by calling the steam_lobby_list_add_distance_filter function.

Back To Top

These constants specify the type of lobby should be used creating a new lobby using the steam_lobby_create function.