Skip to main content

​
Public

Yes

​
Request

const data = await ctx.modules.lobbies.join({
  // Request body
});

​
Request

Object containing the following properties:
PropertyType
lobbyId (*)string
players (*)Array of objects:
    noWaitboolean
    (*) Required.

    ​
    Response

    ​
    Response

    Object containing the following properties:
    PropertyType
    lobby (*)Object with properties:
    • id: string
    • version: string
    • tags: Record<string, string>
    • createdAt: number
    • readyAt: number
    • players: number
    • maxPlayers: number
    • maxPlayersDirect: number
    • backend: Object with properties:
      • test: Object with properties:
        , Object with properties:
        • localDevelopment: Object with properties:
          • ports: Object with dynamic keys of type string and values of type Object with properties:
            • protocol: 'http' | 'tcp' | 'udp'
            • hostname: string
            • port: number
        or Object with properties:
        • server: Object with properties:
          • serverId: string
          • ports: Object with dynamic keys of type string and values of type Object with properties:
            • protocol: 'http' | 'tcp' | 'udp' | 'https' | 'tcp_tls'
            • internalPort: number
            • publicHostname: string
            • publicPort: number
            • routing: Object with properties:
              • game_guard: Record<string, never>
              • host: Record<string, never>
      players (*)Array of objects:
      • token: string
      • id: string
      (*) Required.