v1.0.0
Latest
2022.3+
Class JoinByCodeRequest
The body of a Join Lobby request using lobby code.
Inheritance
System.Object
JoinByCodeRequest
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Unity.Services.Lobbies.Models
Syntax
public class JoinByCodeRequestConstructors
JoinByCodeRequest(String, Player, String)
The body of a Join Lobby request using lobby code.
Declaration
public JoinByCodeRequest(string lobbyCode, Player player = null, string password = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | lobbyCode | The lobby code of the lobby to join. Mutually exclusive with |
| Player | player | player param |
| System.String | password | The password to the target lobby. If target lobby HasPassword is true, this password must match or the request is denied. |
Properties
LobbyCode
The lobby code of the lobby to join. Mutually exclusive with id. This is used to join a private lobby where the lobby code was shared to other users manually.
Declaration
public string LobbyCode { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Password
The password to the target lobby. If target lobby HasPassword is true, this password must match or the request is denied.
Declaration
public string Password { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Player
Parameter player of JoinByCodeRequest
Declaration
public Player Player { get; }Property Value
| Type | Description |
|---|---|
| Player |