.. _function-summary:

サマリ生成
==========

記録された成績データを集計し、表形式で表示する。


構文
----

:チャンネル内呼び出し: <呼び出しキーワード> [オプション]
:スラッシュコマンド: /commandname results [オプション]

.. note::
   ``/commandname`` は以下で定義する

   - `slack-section` の :integrations_section:`slash_command <slack section; slash_command>`
   - `discord-section` の :integrations_section:`slash_command <discord section; slash_command>`


オプション
----------

基本オプション
++++++++++++++

.. results:: メンバー名, チーム名
   :category: 基本オプション

   指定される人数(チーム数)によって出力内容が切り替わる。

   .. list-table::
      :width: 100%
      :widths: 10 20 50
      :header-rows: 1

      * - 指定人数
        - 出力内容
        - 備考
      * - 0名
        - 全体成績サマリ
        -
      * - 1名
        - 個人成績詳細/チーム成績詳細
        -
      * - 2名以上
        - 成績詳細(比較用)
        - 指定メンバー/チームの成績詳細を並べて表示
      * - 2名以上 + 対戦
        - 直接対決サマリ
        - 最初に指定されているメンバー/チームが集計対象

..


個別オプション
++++++++++++++

.. results:: 統計
   :category: 個別オプション

   座席データ、ベストレコード、ワーストレコードを表示する。

.. results:: 比較, 点差, 差分
   :category: 個別オプション

   ひとつ上の順位の `プレイヤー` 、チーム との点差を表示する。

   - 全体成績サマリのみで有効

.. results:: 戦績
   :category: 個別オプション

   戦績データ(ゲーム単位の素点、順位、獲得ポイント)を表示する。

   - 個人成績詳細/チーム成績詳細のみで有効

.. results:: 詳細
   :category: 個別オプション

   戦績データを4人分表示する。

   - 戦績の追加オプション（戦績と同時指定した場合のみ有効）

.. results:: 対戦
   :category: 個別オプション

   対戦結果を表示する。

   - 個人成績詳細/チーム成績詳細では全員分の勝敗と勝率
   - 成績詳細(比較用)で指定すると直接対戦サマリを表示する


共通オプション
++++++++++++++

- `common-options`


出力サンプル
------------

全体成績サマリ詳細
++++++++++++++++++

| メンバー名の指定がない場合、集計期間内で記録されている全メンバーの通算ポイント順に結果を表示する。
| `guest-option` のオプションによって集計内容が変わるため、特記には集計条件が記載される。

.. literalinclude:: sample_usually.txt
   :caption: 全体成績サマリ出力サンプル（通常）


.. literalinclude:: sample_comparison.txt
   :caption: 全体成績サマリ出力サンプル（比較）


個人成績サマリ詳細
++++++++++++++++++

.. literalinclude:: sample_individual_results.txt
   :caption: 個人成績サマリ出力サンプル


直接対決サマリ詳細
++++++++++++++++++

| 対戦数にある勝敗の基準は対戦相手との着順で決定される。
| 自分が3着、相手が4着のゲームなら勝ちとなる。

.. literalinclude:: sample_direct_confrontation.txt
   :caption: 直接対決サマリ出力サンプル