Steam Lobby Join Invite

Will cause the player to auto-join a lobby they are invited to, assuming the configuration rules pass.

Fields and Attributes

Mode

public JoinOnMode mode = JoinOnMode.WithInitialInvite;

Defines how the component responds to lobby invites.

• WithInitialInvite → Joins immediately when the invite is received.

• AfterAcceptInFriendChat → Joins only after the user accepts the invite in the Steam friends chat overlay.

---

Filter

public FilterMode filter = FilterMode.None;

Determines whether invites should be ignored based on the player’s current lobby membership.

• None → Always process invites.

• IgnoreIfInParty → Ignores invites if already in a party lobby.

• IgnoreIfInSession → Ignores invites if already in a session lobby.

• IgnoreIfInAny → Ignores invites if in any lobby.

---

Preprocess

public PreprocessOptions preprocess = PreprocessOptions.None;

Controls whether the component leaves other lobbies before joining a new one.

• None → Do nothing.

• LeaveAllFirst → Leave all current lobbies before joining.

• LeavePartyFirst → Leave only party lobbies first.

• LeaveSessionFirst → Leave only session lobbies first.

---

Functions

Open Overlay

public void OpenOverlay();

Opens the Steam invite dialogue overlay for the current lobby. Only works if the SteamLobbyData is valid.

---

Invite User

public void InviteUser(UserData user);

Sends a lobby invite to the specified user. Only works if the SteamLobbyData is valid.