ISteamMatchmaking - adambiser/agk-steam-plugin GitHub Wiki

AddFavoriteGame

AddFavoriteGame(appID as integer, ipv4 as string, connectPort as integer, queryPort as integer, flags as integer) as integer

appID - The App ID of the game.

ipv4 - The IP address of the server.

connectPort - The port used to connect to the server.

queryPort - The port used to query the server, in host order.

flags - Sets the whether the server should be added to the favorites list or history list.

Adds the game server to the local favorites list or updates the time played of the server if it already exists in the list.

The plugin sets the API call's rTime32LastPlayedOnServer parameter internally to the current client system time.

Returns: An integer. This appears to be an index position, but is not defined by the API.

Reference:
ISteamMatchmaking#AddFavoriteGame
ISteamMatchmaking#k_unFavoriteFlagNone
ISteamMatchmaking#k_unFavoriteFlagFavorite
ISteamMatchmaking#k_unFavoriteFlagHistory

AddRequestLobbyListDistanceFilter

AddRequestLobbyListDistanceFilter(eLobbyDistanceFilter as integer)

eLobbyDistanceFilter - Specifies the maximum distance.

Sets the physical distance for which we should search for lobbies, this is based on the users IP address and a IP location map on the Steam backend.

Reference:
ISteamMatchmaking#AddRequestLobbyListDistanceFilter

AddRequestLobbyListFilterSlotsAvailable

AddRequestLobbyListFilterSlotsAvailable(slotsAvailable as integer)

slotsAvailable - The number of open slots that must be open.

Filters to only return lobbies with the specified number of open slots available.

Reference:
ISteamMatchmaking#AddRequestLobbyListFilterSlotsAvailable

AddRequestLobbyListNearValueFilter

AddRequestLobbyListNearValueFilter(keyToMatch as string, valueToBeCloseTo as integer)

keyToMatch - The filter key name to match.

valueToBeCloseTo - The value that lobbies will be sorted on.

Sorts the results closest to the specified value.

Reference:
ISteamMatchmaking#AddRequestLobbyListNearValueFilter

AddRequestLobbyListNumericalFilter

AddRequestLobbyListNumericalFilter(keyToMatch as string, valueToMatch as integer, eComparisonType as integer)

keyToMatch - The filter key name to match.

valueToMatch - The number to match.

eComparisonType - The type of comparison to make.

Adds a numerical comparison filter to the next RequestLobbyList call.

Reference:
ISteamMatchmaking#AddRequestLobbyListNumericalFilter

AddRequestLobbyListResultCountFilter

AddRequestLobbyListResultCountFilter(maxResults as integer)

maxResults - The maximum number of lobbies to return.

Sets the maximum number of lobbies to return.

Reference:
ISteamMatchmaking#AddRequestLobbyListResultCountFilter

AddRequestLobbyListStringFilter

AddRequestLobbyListStringFilter(keyToMatch as string, valueToMatch as string, eComparisonType as integer)

keyToMatch - The filter key name to match.

valueToMatch - The string to match.

eComparisonType - The type of comparison to make.

Adds a string comparison filter to the next RequestLobbyList call.

Reference:
ISteamMatchmaking#AddRequestLobbyListStringFilter

CreateLobby

CreateLobby(eLobbyType as integer, maxMembers as integer) as integer

eLobbyType - The type and visibility of this lobby. This can be changed later via SetLobbyType.

maxMembers - The maximum number of players that can join this lobby. This can not be above 250.

Creates a new matchmaking lobby. The lobby is joined once it is created.

Returns: A call result handle on success; otherwise 0.

Associated Methods:
GetCreateLobbyHandle

Reference:
ISteamMatchmaking#CreateLobby

GetCreateLobbyHandle

GetCreateLobbyHandle(hCallResult as integer) as integer

hCallResult - A CreateLobby call result handle.

Returns the lobby handle for the CreateLobby call.

This method should only be used when the call result returned by CreateLobby has reported a GetCallResultCode of 1.

Returns: A lobby SteamID handle or 0 if the call failed.

Reference:
ISteamMatchmaking#CreateLobby
ISteamMatchmaking#LobbyCreated_t

DeleteLobbyData

DeleteLobbyData(hLobbySteamID as integer, key as string) as integer

hLobbySteamID - The Steam ID of the lobby to delete the metadata for.

key - The key to delete the data for.

Removes a metadata key from the lobby.

This can only be set by the owner of the lobby.

Returns: 1 when the request succeeds; otherwise 0.

Reference:
ISteamMatchmaking#DeleteLobbyData

GetFavoriteGameAppID

GetFavoriteGameAppID(index as integer) as integer

index - The index of the favorite game server to get the details of. This must be between 0 and GetFavoriteGameCount() - 1

Returns the App ID of the favorite game server by index.

Note: You must call GetFavoriteGameCount before calling this.

Returns: An App ID.

Reference:
ISteamMatchmaking#GetFavoriteGame

GetFavoriteGameIP

GetFavoriteGameIP(index as integer) as string

index - The index of the favorite game server to get the details of. This must be between 0 and GetFavoriteGameCount() - 1

Returns the IP address of the favorite game server by index.

Note: You must call GetFavoriteGameCount before calling this.

Returns: An IP address.

Reference:
ISteamMatchmaking#GetFavoriteGame

GetFavoriteGameConnectionPort

GetFavoriteGameConnectionPort(index as integer) as integer

index - The index of the favorite game server to get the details of. This must be between 0 and GetFavoriteGameCount() - 1

Returns the port used to connect to the favorite game server by index.

Note: You must call GetFavoriteGameCount before calling this.

Returns: A port number.

Reference:
ISteamMatchmaking#GetFavoriteGame

GetFavoriteGameQueryPort

GetFavoriteGameQueryPort(index as integer) as integer

index - The index of the favorite game server to get the details of. This must be between 0 and GetFavoriteGameCount() - 1

Returns the port used to query the favorite game server by index.

Note: You must call GetFavoriteGameCount before calling this.

Returns: A port number.

Reference:
ISteamMatchmaking#GetFavoriteGame

GetFavoriteGameFlags

GetFavoriteGameFlags(index as integer) as integer

index - The index of the favorite game server to get the details of. This must be between 0 and GetFavoriteGameCount() - 1

Returns the list the favorite game server is on by index.

Note: You must call GetFavoriteGameCount before calling this.

Returns: 0 = FavoriteFlagNone, 1 = FavoriteFlagFavorite, or 2 = FavoriteFlagHistory

Reference:
ISteamMatchmaking#GetFavoriteGame

GetFavoriteGameUnixTimeLastPlayedOnServer

GetFavoriteGameUnixTimeLastPlayedOnServer(index as integer) as integer

index - The index of the favorite game server to get the details of. This must be between 0 and GetFavoriteGameCount() - 1

Returns the time the server was last added to the favorites list by index.

Note: You must call GetFavoriteGameCount before calling this.

Returns: Time in Unix epoch format.

Reference:
ISteamMatchmaking#GetFavoriteGame

GetFavoriteGameCount

GetFavoriteGameCount() as integer

Gets the number of favorite and recent game servers the user has stored locally.

Returns: An integer.

Reference:
ISteamMatchmaking#GetFavoriteGameCount

GetLobbyData

GetLobbyData(hLobbySteamID as integer, key as string) as string

hLobbySteamID - The Steam ID of the lobby to get the metadata from.

key - The key to get the value of.

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

Returns: The value for the given key or an empty string if the key or lobby doesn't exist.

Reference:
ISteamMatchmaking#GetLobbyData

GetLobbyDataJSON

GetLobbyDataJSON(hLobbySteamID as integer) as string

hLobbySteamID - The Steam ID of the lobby to get the metadata from.

Gets all metadata for a given lobby.

Returns: A JSON string of key/value pairs for all data for a lobby. An array to type KeyValuePair.

Type KeyValuePair
    Key as string
    Value as string
EndType

Reference:
ISteamMatchmaking#GetLobbyDataCount
ISteamMatchmaking#GetLobbyDataByIndex

GetLobbyGameServerIP

GetLobbyGameServerIP(hLobbySteamID as integer) as string

hLobbySteamID - The Steam ID of the lobby to get the game server information from.

Gets the IP address of a game server set in a lobby.

Returns: The IP address for the lobby game server.

Reference:
ISteamMatchmaking#GetLobbyGameServer

GetLobbyGameServerPort

GetLobbyGameServerPort(hLobbySteamID as integer) as integer

hLobbySteamID - The Steam ID of the lobby to get the game server information from.

Gets the connection port of a game server set in a lobby.

Returns: The connection port for the lobby game server.

Reference:
ISteamMatchmaking#GetLobbyGameServer

GetLobbyGameServerSteamID

GetLobbyGameServerSteamID(hLobbySteamID as integer) as integer

hLobbySteamID - The Steam ID of the lobby to get the game server information from.

Gets the Steam ID handle of a game server set in a lobby.

Returns: The Steam ID handle for the lobby game server.

Reference:
ISteamMatchmaking#GetLobbyGameServer

GetLobbyMemberByIndex

GetLobbyMemberByIndex(hLobbySteamID as integer, index as integer) as integer

hLobbySteamID - This MUST be the same lobby used in the previous call to GetNumLobbyMembers!

index - An index between 0 and GetNumLobbyMembers.

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

Returns: A Steam ID handle.

Reference:
ISteamMatchmaking#GetLobbyMemberByIndex

GetLobbyMemberData

GetLobbyMemberData(hLobbySteamID as integer, hSteamIDUser as integer, key as string) as string

hLobbySteamID - The Steam ID handle of the lobby that the other player is in.

hSteamIDUser - The Steam ID handle of the player to get the metadata from.

key - The key to get the value of.

Gets per-user metadata from another player in the specified lobby.

Returns: The value for the given key or an empty string if the key, member, or lobby doesn't exist.

Reference:
ISteamMatchmaking#GetLobbyMemberData

GetLobbyMemberLimit

GetLobbyMemberLimit(hLobbySteamID as integer) as integer

hLobbySteamID - The Steam ID handle of the lobby to get the member limit of.

The current limit on the number of users who can join the lobby.

Returns: A positive integer or 0 if no limit.

Reference:
ISteamMatchmaking#GetLobbyMemberLimit

GetLobbyOwner

GetLobbyOwner(hLobbySteamID as integer) as integer

hLobbySteamID - The Steam ID handle of the lobby to get the owner of.

Returns the current lobby owner.

Returns: A steam ID handle or 0.

Reference:
ISteamMatchmaking#GetLobbyOwner

GetNumLobbyMembers

GetNumLobbyMembers(hLobbySteamID as integer) as integer

hLobbySteamID - The Steam ID handle of the lobby to get the number of members of.

Gets the number of users in a lobby.

Returns: The number of members in the lobby, 0 if the current user has no data from the lobby.

Reference:
ISteamMatchmaking#GetNumLobbyMembers

InviteUserToLobby

InviteUserToLobby(hLobbySteamID as integer, hInviteeSteamID as integer) as integer

hLobbySteamID - The Steam ID handle of the lobby to invite the user to.

hInviteeSteamID - The Steam ID handle of the person who will be invited.

Invite another user to the lobby.

Returns: 1 when the invitation was sent successfully; otherwise 0.

Reference:
ISteamMatchmaking#InviteUserToLobby

JoinLobby

JoinLobby(hLobbySteamID as integer) as integer

hLobbySteamID - The Steam ID handle of the lobby

Joins an existing lobby.

Returns: A call result handle on success; otherwise 0.

Associated Methods:
GetJoinLobbyChatRoomEnterResponse
GetJoinLobbyHandle
GetJoinLobbyLocked

Reference:
ISteamMatchmaking#JoinLobby

GetJoinLobbyChatRoomEnterResponse

GetJoinLobbyChatRoomEnterResponse(hCallResult as integer) as integer

hCallResult - A JoinLobby call result handle.

Returns the EChatRoomEnterResponse for the JoinLobby call.

This method should only be used when the call result returned by JoinLobby has reported a GetCallResultCode of 1.

Returns: An EChatRoomEnterResponse value.

Reference:
ISteamMatchmaking#LobbyEnter_t
ISteamMatchmaking#JoinLobby

GetJoinLobbyHandle

GetJoinLobbyHandle(hCallResult as integer) as integer

hCallResult - A JoinLobby call result handle.

Returns the lobby Steam ID handle for the JoinLobby call.

This method should only be used when the call result returned by JoinLobby has reported a GetCallResultCode of 1.

Returns: The lobby Steam ID handle.

Reference:
ISteamMatchmaking#LobbyEnter_t
ISteamMatchmaking#JoinLobby

GetJoinLobbyLocked

GetJoinLobbyLocked(hCallResult as integer) as integer

hCallResult - A JoinLobby call result handle.

Returns whether the lobby is locked for the JoinLobby call.

This method should only be used when the call result returned by JoinLobby has reported a GetCallResultCode of 1.

Returns: 1 if only invited users can join the lobby; otherwise 0.

Reference:
ISteamMatchmaking#LobbyEnter_t
ISteamMatchmaking#JoinLobby

LeaveLobby

LeaveLobby(hLobbySteamID as integer)

hLobbySteamID - The Steam ID handle of the lobby to leave.

Leave a lobby that the user is currently in; this will take effect immediately on the client side, other users in the lobby will be notified by a LobbyChatUpdate_t callback.

Reference:
ISteamMatchmaking#LeaveLobby

RemoveFavoriteGame

RemoveFavoriteGame(appID as integer, ipv4 as string, connectPort as integer, queryPort as integer, flags as integer) as integer

appID - The App ID of the game.

ipv4 - The IP address of the server.

connectPort - The port used to connect to the server, in host order.

queryPort - The port used to query the server, in host order.

flags - Whether the server is on the favorites list or history list. See k_unFavoriteFlagNone for more information.

Removes the game server from the local favorites list.

Returns: 1 if the server was removed; otherwise, 0 if the specified server was not on the users local favorites list.

Reference:
ISteamMatchmaking#RemoveFavoriteGame
ISteamMatchmaking#k_unFavoriteFlagNone
ISteamMatchmaking#k_unFavoriteFlagFavorite
ISteamMatchmaking#k_unFavoriteFlagHistory

RequestLobbyData

RequestLobbyData(hLobbySteamID as integer) as integer

hLobbySteamID - The Steam ID of the lobby to refresh the metadata of.

Refreshes all of the metadata for a lobby that you're not in right now.

Returns: 1 when the request for lobby data succeeds will be reported by the LobbyDataUpdate_t callback. 0 when the request fails.

Reference:
ISteamMatchmaking#RequestLobbyData
ISteamMatchmaking#LobbyDataUpdate_t

RequestLobbyList

RequestLobbyList() as integer

Request a filtered list of relevant lobbies.

Returns: A call result handle on success; otherwise 0.

Associated Methods:
GetRequestLobbyListCount
GetRequestLobbyListHandle

Reference:
ISteamMatchmaking#RequestLobbyList

GetRequestLobbyListCount

GetRequestLobbyListCount(hCallResult as integer) as integer

hCallResult - A RequestLobbyList call result handle.

Gets the number of lobbies returned by the RequestLobbyList call.

This method should only be used when the call result returned by RequestLobbyList has reported a GetCallResultCode of 1.

Returns: The list count.

Reference:
ISteamMatchmaking#LobbyMatchList_t
ISteamMatchmaking#RequestLobbyList

GetRequestLobbyListHandle

GetRequestLobbyListHandle(hCallResult as integer, index as integer) as integer

hCallResult - A RequestLobbyList call result handle.

index - The lobby index.

Gets the lobby Steam ID handle returned by the RequestLobbyList call by index.

This method should only be used when the call result returned by RequestLobbyList has reported a GetCallResultCode of 1.

Returns: A Steam ID handle.

Reference:
ISteamMatchmaking#LobbyMatchList_t
ISteamMatchmaking#RequestLobbyList

SendLobbyChatMessage

SendLobbyChatMessage(hLobbySteamID as integer, memblockID as integer) as integer

hLobbySteamID - The Steam ID handle of the lobby to send the chat message to.

memblockID - A memblock containing the message to send.

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

Returns: 1 when the send succeeds; otherwise 0.

Reference:
ISteamMatchmaking#SendLobbyChatMessage

SendLobbyChatMessage

SendLobbyChatMessage(hLobbySteamID as integer, message as string) as integer

hLobbySteamID - The Steam ID handle of the lobby to send the chat message to.

message - The message to send.

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

Returns: 1 when the send succeeds; otherwise 0.

Reference:
ISteamMatchmaking#SendLobbyChatMessage

SetLobbyData

SetLobbyData(hLobbySteamID as integer, key as string, value as string)

hLobbySteamID - The Steam ID of the lobby to set the metadata for.

key - The key to set the data for.

value - The value to set.

Sets a key/value pair in the lobby metadata.

This can only be set by the owner of the lobby.

Reference:
ISteamMatchmaking#SetLobbyData

SetLobbyGameServer

SetLobbyGameServer(hLobbySteamID as integer, gameServerIP as string, gameServerPort as integer, hGameServerSteamID as integer) as integer

hLobbySteamID - The Steam ID handle of the lobby to set the game server information for.

gameServerIP - Sets the IP address of the game server.

gameServerPort - Sets the connection port of the game server.

hGameServerSteamID - Sets the Steam ID handle of the game server.

Sets the game server associated with the lobby. This method only accepts IPv4 addresses. Either an IP/port or a Game Server SteamID handle must be given.

This can only be set by the owner of the lobby.

Returns: 1 when the call succeeds; otherwise 0.

Reference:
ISteamMatchmaking#SetLobbyGameServer

SetLobbyJoinable

SetLobbyJoinable(hLobbySteamID as integer, lobbyJoinable as integer) as integer

hLobbySteamID - The Steam ID handle of the lobby

lobbyJoinable - 1 to allow or 0 to disallow users to join this lobby.

Sets whether or not a lobby is joinable by other players. This always defaults to enabled for a new lobby.

This can only be set by the owner of the lobby.

Returns: 1 when the call succeeds; otherwise 0.

Reference:
ISteamMatchmaking#SetLobbyJoinable

SetLobbyMemberData

SetLobbyMemberData(hLobbySteamID as integer, key as string, value as string)

hLobbySteamID - The Steam ID of the lobby to set our metadata in.

key - The key to set the data for.

value - The value to set.

Sets per-user metadata for the local user.

Each user in the lobby will be receive notification of the lobby data change via HasLobbyDataUpdated, and any new users joining will receive any existing data.

Reference:
ISteamMatchmaking#SetLobbyMemberData

SetLobbyMemberLimit

SetLobbyMemberLimit(hLobbySteamID as integer, maxMembers as integer) as integer

hLobbySteamID - The Steam ID handle of the lobby to set the member limit for.

maxMembers - The maximum number of players allowed in this lobby. This can not be above 250.

Set the maximum number of players that can join the lobby.

This can only be set by the owner of the lobby.

Returns: 1 if the limit was successfully set; otherwise 0.

Reference:
ISteamMatchmaking#SetLobbyMemberLimit

SetLobbyOwner

SetLobbyOwner(hLobbySteamID as integer, hNewOwnerSteamID as integer) as integer

hLobbySteamID - The Steam ID handle of the lobby where the owner change will take place.

hNewOwnerSteamID - The Steam ID handle of the user that will be the new owner of the lobby, they must be in the lobby.

Changes who the lobby owner is. Triggers HasLobbyChatUpdate for all lobby members.

This can only be set by the owner of the lobby.

Returns: 1 if the owner is successfully changed; otherwise 0.

Reference:
ISteamMatchmaking#SetLobbyOwner

SetLobbyType

SetLobbyType(hLobbySteamID as integer, eLobbyType as integer) as integer

hLobbySteamID - The Steam ID handle of the lobby

eLobbyType - The new lobby type to that will be set.

Updates what type of lobby this is.

This can only be set by the owner of the lobby.

Returns: 1 when the call succeeds; otherwise 0.

Reference:
ISteamMatchmaking#SetLobbyType

HasFavoritesListChangedResponse

HasFavoritesListChangedResponse() as integer

Triggered when a favorites list change message has been received.

Returns: 1 when the callback has more responses to process; otherwise 0.

Associated Methods:
GetFavoritesListChangedIP
GetFavoritesListChangedQueryPort
GetFavoritesListChangedConnectionPort
GetFavoritesListChangedAppID
GetFavoritesListChangedFlags
GetFavoritesListChangedIsAdd
GetFavoritesListChangedAccountID

Reference:
ISteamMatchmaking#FavoritesListAccountsUpdated_t

GetFavoritesListChangedIP

GetFavoritesListChangedIP() as string

Gets the IP of the current FavoritesListAccountsUpdated_t callback reponse. When an empty string, reload the entire list; otherwise it means just one server.

This method should only be used when HasFavoritesListChangedResponse has returned 1.

Returns: An IP address or empty string.

Reference:
ISteamMatchmaking#FavoritesListAccountsUpdated_t

GetFavoritesListChangedQueryPort

GetFavoritesListChangedQueryPort() as integer

Gets the query port of the current FavoritesListAccountsUpdated_t callback reponse.

This method should only be used when HasFavoritesListChangedResponse has returned 1.

Returns: An integer.

Reference:
ISteamMatchmaking#FavoritesListAccountsUpdated_t

GetFavoritesListChangedConnectionPort

GetFavoritesListChangedConnectionPort() as integer

Gets the connection port of the current FavoritesListAccountsUpdated_t callback reponse.

This method should only be used when HasFavoritesListChangedResponse has returned 1.

Returns: An integer.

Reference:
ISteamMatchmaking#FavoritesListAccountsUpdated_t

GetFavoritesListChangedAppID

GetFavoritesListChangedAppID() as integer

Gets the App ID of the game server for the current FavoritesListAccountsUpdated_t callback reponse.

This method should only be used when HasFavoritesListChangedResponse has returned 1.

Returns: An integer.

Reference:
ISteamMatchmaking#FavoritesListAccountsUpdated_t

GetFavoritesListChangedFlags

GetFavoritesListChangedFlags() as integer

Gets the query port of the current FavoritesListAccountsUpdated_t callback reponse.

This method should only be used when HasFavoritesListChangedResponse has returned 1.

Returns: Whether the server is on the favorites list or history list. See k_unFavoriteFlagNone for more information.

Reference:
ISteamMatchmaking#FavoritesListAccountsUpdated_t
ISteamMatchmaking#k_unFavoriteFlagNone
ISteamMatchmaking#k_unFavoriteFlagFavorite
ISteamMatchmaking#k_unFavoriteFlagHistory

GetFavoritesListChangedIsAdd

GetFavoritesListChangedIsAdd() as integer

Gets whether the game server was added (1) or removed (0) from the list for the current FavoritesListAccountsUpdated_t callback reponse.

This method should only be used when HasFavoritesListChangedResponse has returned 1.

Returns: 1 if added, 0 if removed.

Reference:
ISteamMatchmaking#FavoritesListAccountsUpdated_t

GetFavoritesListChangedAccountID

GetFavoritesListChangedAccountID() as integer

Gets the account ID of the current FavoritesListAccountsUpdated_t callback reponse.

This method should only be used when HasFavoritesListChangedResponse has returned 1.

Returns: An integer.

Reference:
ISteamMatchmaking#FavoritesListAccountsUpdated_t

HasLobbyChatMessageResponse

HasLobbyChatMessageResponse() as integer

Triggered when a lobby chat message has been received.

Returns: 1 when the callback has more responses to process; otherwise 0.

Associated Methods:
GetLobbyChatMessageLobby
GetLobbyChatMessageUser
GetLobbyChatMessageText

Reference:
ISteamMatchmaking#LobbyChatMsg_t

GetLobbyChatMessageLobby

GetLobbyChatMessageLobby() as integer

Gets the lobby for the current LobbyChatMsg_t callback response.

This method should only be used when HasLobbyChatMessageResponse has returned 1.

Returns: A lobby Steam ID handle.

Reference:
ISteamMatchmaking#LobbyChatMsg_t

GetLobbyChatMessageUser

GetLobbyChatMessageUser() as integer

Gets the Steam ID handle of the user for the current LobbyChatMsg_t callback response.

This method should only be used when HasLobbyChatMessageResponse has returned 1.

Returns: A Steam ID handle.

Reference:
ISteamMatchmaking#GetLobbyChatEntry
ISteamMatchmaking#LobbyChatMsg_t

GetLobbyChatMessageMemblock

GetLobbyChatMessageMemblock() as integer

Gets the chat message in a memblock for the current LobbyChatMsg_t callback response. The memblock will be deleted the next time HasLobbyChatMessageResponse is called.

Returns: A memblock containing the contents of the chat message.

Reference:
ISteamMatchmaking#GetLobbyChatEntry
ISteamMatchmaking#LobbyChatMsg_t

GetLobbyChatMessageText

GetLobbyChatMessageText() as string

Gets the chat message as text for the current LobbyChatMsg_t callback response.

This method should only be used when HasLobbyChatMessageResponse has returned 1.

Returns: The contents of the chat message.

Reference:
ISteamMatchmaking#GetLobbyChatEntry
ISteamMatchmaking#LobbyChatMsg_t

HasLobbyChatUpdateResponse

HasLobbyChatUpdateResponse() as integer

Triggered when a lobby chat room state has changed, this is usually sent when a user has joined or left the lobby.

Returns: 1 when the callback has more responses to process; otherwise 0.

Associated Methods:
GetLobbyChatUpdateLobby
GetLobbyChatUpdateUserChanged
GetLobbyChatUpdateUserState
GetLobbyChatUpdateUserMakingChange

Reference:
ISteamMatchmaking#LobbyChatUpdate_t

GetLobbyChatUpdateLobby

GetLobbyChatUpdateLobby() as integer

The lobby for the current LobbyChatUpdate_t callback response.

This method should only be used when HasLobbyChatUpdateResponse has returned 1.

Returns: A Steam ID handle.

Reference:
ISteamMatchmaking#LobbyChatUpdate_t

GetLobbyChatUpdateUserChanged

GetLobbyChatUpdateUserChanged() as integer

The user whose status in the lobby has changed for the current LobbyChatUpdate_t callback response.

This method should only be used when HasLobbyChatUpdateResponse has returned 1.

Returns: A Steam ID handle.

Reference:
ISteamMatchmaking#LobbyChatUpdate_t

GetLobbyChatUpdateUserState

GetLobbyChatUpdateUserState() as integer

The new user state for the user whose status changed for the current LobbyChatUpdate_t callback response.

This method should only be used when HasLobbyChatUpdateResponse has returned 1.

Returns: EChatMemberStateChange bit data

Reference:
ISteamMatchmaking#LobbyChatUpdate_t

GetLobbyChatUpdateUserMakingChange

GetLobbyChatUpdateUserMakingChange() as integer

Chat member who made the change for the current LobbyChatUpdate_t callback response.

This method should only be used when HasLobbyChatUpdateResponse has returned 1.

Returns: A Steam ID handle.

Reference:
ISteamMatchmaking#LobbyChatUpdate_t

HasLobbyDataUpdateResponse

HasLobbyDataUpdateResponse() as integer

Triggered when the lobby metadata has changed.

Returns: 1 when the callback has more responses to process; otherwise 0.

Associated Methods:
GetLobbyDataUpdateLobby
GetLobbyDataUpdateMember
GetLobbyDataUpdateSuccess

Reference:
ISteamMatchmaking#LobbyDataUpdate_t

GetLobbyDataUpdateLobby

GetLobbyDataUpdateLobby() as integer

Returns the lobby whose metadata has changed for the current LobbyDataUpdate_t callback response.

This method should only be used when HasLobbyDataUpdateResponse has returned 1.

Returns: A Steam ID handle.

Reference:
ISteamMatchmaking#LobbyDataUpdate_t

GetLobbyDataUpdateMember

GetLobbyDataUpdateMember() as integer

Returns the handle of the member whose metadata has changed for the current LobbyDataUpdate_t callback response. If this value is a user in the lobby, then use GetLobbyMemberData to access per-user details; otherwise, if GetLobbyDataUpdateMember == GetLobbyDataUpdateLobby, use GetLobbyData to access the lobby metadata.

This method should only be used when HasLobbyDataUpdateResponse has returned 1.

Returns: A Steam ID handle.

Reference:
ISteamMatchmaking#LobbyDataUpdate_t

GetLobbyDataUpdateSuccess

GetLobbyDataUpdateSuccess() as integer

Returns the success of the lobby data update for the current LobbyDataUpdate_t callback response.

This method should only be used when HasLobbyDataUpdateResponse has returned 1.

Returns: 1 if the lobby data was successfully changed, otherwise 0.

Reference:
ISteamMatchmaking#LobbyDataUpdate_t

HasLobbyEnterResponse

HasLobbyEnterResponse() as integer

Recieved upon attempting to enter a lobby. Lobby metadata is available to use immediately after receiving this.

Returns: 1 when the callback has more responses to process; otherwise 0.

Associated Methods:
GetLobbyEnterChatRoomEnterResponse
GetLobbyEnterLobby
GetLobbyEnterLocked

Reference:
ISteamMatchmaking#LobbyEnter_t

GetLobbyEnterChatRoomEnterResponse

GetLobbyEnterChatRoomEnterResponse() as integer

Gets EChatRoomEnterResponse for the current LobbyEnter_t callback response.

This method should only be used when HasLobbyEnterResponse has returned 1.

Returns: An EChatRoomEnterResponse value.

Reference:
ISteamMatchmaking#LobbyEnter_t

GetLobbyEnterLobby

GetLobbyEnterLobby() as integer

Returns the lobby for the current LobbyEnter_t callback response.

This method should only be used when HasLobbyEnterResponse has returned 1.

Returns: The lobby Steam ID handle.

Reference:
ISteamMatchmaking#LobbyEnter_t

GetLobbyEnterLocked

GetLobbyEnterLocked() as integer

Returns the locked value for the current LobbyEnter_t callback response.

This method should only be used when HasLobbyEnterResponse has returned 1.

Returns: 1 if only invited users can join the lobby; otherwise 0.

Reference:
ISteamMatchmaking#LobbyEnter_t

HasLobbyGameCreatedResponse

HasLobbyGameCreatedResponse() as integer

Indicates that a lobby game was created since the last call. This can only be read once per lobby game creation!

Returns: 1 when a lobby game was created; otherwise 0.

Associated Methods:
GetLobbyGameCreatedGameServer
GetLobbyGameCreatedLobby
GetLobbyGameCreatedIP
GetLobbyGameCreatedPort

Reference:
ISteamMatchmaking#LobbyGameCreated_t

GetLobbyGameCreatedGameServer

GetLobbyGameCreatedGameServer() as integer

Returns the current game server Steam ID handle for the LobbyGameCreated_t callback.

This method should only be used when HasLobbyGameCreatedResponse has returned 1.

Returns: A Steam ID handle.

Reference:
ISteamMatchmaking#LobbyGameCreated_t

GetLobbyGameCreatedLobby

GetLobbyGameCreatedLobby() as integer

Returns the Steam ID handle of the lobby that set the game server for the current LobbyGameCreated_t callback response.

This method should only be used when HasLobbyGameCreatedResponse has returned 1.

Returns: A Steam ID handle.

Reference:
ISteamMatchmaking#LobbyGameCreated_t

GetLobbyGameCreatedIP

GetLobbyGameCreatedIP() as string

Returns the IP address of the game server for the current LobbyGameCreated_t callback response.

This method should only be used when HasLobbyGameCreatedResponse has returned 1.

Returns: A Steam ID handle.

Reference:
ISteamMatchmaking#LobbyGameCreated_t

GetLobbyGameCreatedPort

GetLobbyGameCreatedPort() as integer

Returns the connection port of the game server for the current LobbyGameCreated_t callback response.

This method should only be used when HasLobbyGameCreatedResponse has returned 1.

Returns: A Steam ID handle.

Reference:
ISteamMatchmaking#LobbyGameCreated_t