This document is about: QUANTUM 2

SWITCH TO

QUANTUM 1 QUANTUM 2 QUANTUM 3

API-Tournament

Available in the Gaming Circle and Industries Circle

ネームスペース: Gimmebreak.Backbone.Tournaments

インヘリタンス: Object → tournament

必要な情報すべてを持つトーナメントの特定のインスタンスを表します。
トーナメントデータを読み込むにはバックボーンクライアントでLoadTournamentList()またはLoadTournament()を呼び出します。
トーナメントンスタンスはすべてclient.Tournaments.TournamentListにあります。

public class Tournament

コンストラクター

`Tournament()`

トーナメントのインスタンスを作成します。

public Tournament()

プロパティ

`AdditionalDescription`

あれば、トーナメントの追加の詳細を取得します。

public string AdditionalDescription
{
    get;
    set;
}

`AllMatches`

すべてのフェーズのすべてのトーナメントマッチ
このフィールドは、バックボーンクライアントのLoadTournamentMatches() または LoadTournamentMatchesAll()呼び出しで入力されます。

public List<TournamentMatch> AllMatches
{
    get;
    set;
}

`CurrentInvites`

現在有効なトーナメントへの招待・登録を判定します。
これは、トーナメントにチームやパーティが設定されていても常に単一のユーザーを表します。

public int CurrentInvites
{
    get;
    set;
}

`CurrentPhaseId`

現在有効なフェーズID（IDが０であれば、トーナメントがまだ開始されていないことを表します。初めのフェーズは常に1から始まります）を判定します。

public int CurrentPhaseId
{
    get;
    set;
}

`CurrentPhaseStarted`

現在のフェーズがいつ始まったかを判定します。
UTC時刻です。

public DateTime CurrentPhaseStarted
{
    get;
    set;
}

`CustomProperties`

トーナメントのカスタムプロパティを取得します。（例：ゲームモード、使える能力、使える地図など）

public TournamentCustomProperties CustomProperties
{
    get;
    set;
}

`Description`

あれば、このトーナメントの詳細を取得します。

public string Description
{
    get;
    set;
}

`EntryFee`

このトーナメントのエントリー料を判定します。
トーナメントにエントリー料が設定されていなくても、nullにはなりません。ただし、EntryFee.Itemsが空白になります。

public TournamentEntryFee EntryFee
{
    get;
    set;
}

`HasAllDataLoaded`

全てのトーナメントデータが読み込まれているかどうか判定します。

public bool HasAllDataLoaded
{
    get;
    set;
}

備考

バックボーンクライアントでトーナメントがLoadTournamentList()呼び出しのみで読み込まれている場合は、falseに設定されます。
バックボーンクライアントでトーナメントがLoadTournament()呼び出しで読み込まれている場合は、trueに設定されます。

`HighlightsUrl`

あればトーナメントのハイライトのURLを取得します。

public string HighlightsUrl
{
    get;
    set;
}

`IconUrl`

あればアイコンURLを取得します。

public string IconUrl
{
    get;
    set;
}

`Id`

トーナメントの一意のID

public long Id
{
    get;
    set;
}

`ImageUrl`

あればトーナメントのイメージURLを取得します。

public string ImageUrl
{
    get;
    set;
}

`InvitationCloseTime`

招待が締め切られる時刻を判定します。
この後はだれもサインアップしたりサインアウトできません。
UTC時刻です。

public DateTime InvitationCloseTime
{
    get;
    set;
}

`InvitationOpenTime`

Determine when invitation opens.
This is UTC datetime.

public DateTime InvitationOpenTime
{
    get;
    set;
}

備考

招待が開かれると、直接招待されたユーザーのみがサインアップできます。
直接招待とは、前のトーナメントの勝者やダッシュボードでの特定のユーザー設定を表します。
一般の登録が開かれる前に、直接招待されているユーザーが優先的にサインアップできます。

`Invite`

トーナメントの招待・チケットを取得します。
ユーザーがトーナメントに招待されると、チケットは使用可能になりますが、確認はされません。
このプロパティは、ユーザーが自動的に招待されていない場合やトーナメントにサインアップしていない場合、nullになります。

public TournamentInvite Invite
{
    get;
    set;
}

`IsAdministrator`

ユーザーがこのトーナメントの管理者かどうか判定します。
管理者はマッチのブラウジング中にマッチの非公開部分にアクセスでき、観戦者として参加できます。

public bool IsAdministrator
{
    get;
    set;
}

`IsInvitationOnly`

トーナメントが招待されたユーザーの専用か判定します。
trueに設定されていると、RegistrationOpenTimeは使用されず、有効な値を持ちません。

public bool IsInvitationOnly
{
    get;
    set;
}

`LastMatchRoundId`

ユーザーがプレイした最後のマッチのラウンドIDを判定します。

public int LastMatchRoundId
{
    get;
    set;
}

`LastUpdate`

最後のトーナメントデータアップデートを判定します。

public DateTime LastUpdate
{
    get;
    set;
}

`MaxInvites`

トーナメントへの最大招待・登録数を判定します。
トーナメントにパーティ・チームが設定されていても常に単体のユーザーを表します。

public int MaxInvites
{
    get;
    set;
}

`NextPhase`

次のフェーズが開始される時刻を判定します。
UTC時刻です。

public DateTime NextPhase
{
    get;
    set;
}

備考

現在のフェーズのすべてのマッチがプレイされると、トーナメントは次のフェーズにはやく進行し、必要以上にユーザーを待たせないようにします。

`Party`

ユーザーのパーティを取得します（1対1でも、ユーザーのサインアップは常にパーティで行われます）。
このプロパティは、ユーザーがトーナメントにサインアップするまでnullです。

public TournamentParty Party
{
    get;
    set;
}

備考

サインアップしたユーザーは常にパーティです。
ユーザーがパーティを抜けると、自動的に他のパーティが割り当てられます。

`PartySize`

トーナメントに必要なパーティのサイズを判定します。(例： 1対1、2対2、3対3など)

public int PartySize
{
    get;
    set;
}

`PhaseCount`

トーナメント内にあるフェーズ数を判定します（常に1つ以上）。

public int PhaseCount
{
    get;
    set;
}

`Phases`

全てのトーナメントのリスト。
トーナメントには少なくとも1つのフェーズがあります(PhaseId = 1)。

public List<TournamentPhase> Phases
{
    get;
    set;
}

`PolicyURL`

あれば、トーナメントのポリシーURLを取得します。

public string PolicyURL
{
    get;
    set;
}

`PrivateCode`

このトーナメントのプライベートコードを取得します。
ほかのユーザーと共有してプライベートトーナメントにサインアップすることができます。

public string PrivateCode
{
    get;
    set;
}

備考

この種類の招待がダッシュボードで有効になっている場合のみプライベートコードが生成されます。

`Prizes`

トーナメントの報酬のリスト。

public List<TournamentPrize> Prizes
{
    get;
    set;
}

`RegistrationOpenTime`

登録が開かれる時間を判定します。
このプロパティが設定されるのはIsInvitationOnlyがfalseの場合のみです。
UTC時刻です。

public DateTime RegistrationOpenTime
{
    get;
    set;
}

備考

登録が開かれると、どのユーザーもサインアップできるようになります。

`ReplayExpires`

いつリプレイURLの期限が切れるか判定します（例：14日後に）
UTC時刻です。

public DateTime ReplayExpires
{
    get;
    set;
}

`ReplayUrl`

Get replay url of tournament if any. (E.g. twitch VOD)

public string ReplayUrl
{
    get;
    set;
}

`Requirements`

サインアップの要件を判定します。
トーナメントにカスタム要件が設定されていなくてもnullにはなりません。ただし、Requirements.CustomRequirementsは空白になります。

public TournamentRequirements Requirements
{
    get;
    set;
}

`RoundCount`

トーナメント内に合計で何ラウンドあるか判定します（常に1つ以上）。

public int RoundCount
{
    get;
    set;
}

`Season`

トーナメントが作成されたシーズンを安定します。

public int Season
{
    get;
    set;
}

`SeasonPart`

トーナメントが作成されたシーズンパートを判定します。

public int SeasonPart
{
    get;
    set;
}

`SponsorImageUrl`

スポンサーイメージを取得します。

public string SponsorImageUrl
{
    get;
    set;
}

`SponsorName`

スポンサー名を取得します。

public string SponsorName
{
    get;
    set;
}

`Status`

トーナメントの現在のステータス。（招待が開かれている、終了しているなど）
ステータスの詳細を取得するには、トーナメントをトーナメントハブにつなぎます。

public TournamentStatus Status
{
    get;
    set;
}

`StreamUrl`

あれば、トーナメントストリームURLを取得します。

public string StreamUrl
{
    get;
    set;
}

`ThemeColor`

あればトーナメントのテーマカラーを取得します。

public string ThemeColor
{
    get;
    set;
}

`Time`

トーナメントの開始時刻を判定します。
UTC時刻です。

public DateTime Time
{
    get;
    set;
}

`TournamentName`

トーナメントの公式名。

public string TournamentName
{
    get;
    set;
}

`Type`

トーナメントの種類を判定します。（公開、非公開、テストなど）
特定のユーザーにのみ表示される種類もあります。

public TournamentType Type
{
    get;
    set;
}

`UserActiveMatch`

ユーザーが参加するべき、現在有効なマッチ。
トーナメントにサインアップしているユーザーにのみ適用されます。

public TournamentMatch UserActiveMatch
{
    get;
    set;
}

備考

このプロパティは、ユーザーがトーナメントハブに接続すると自動で設定されます。
状況によっては、トーナメントが割り当てられる前にユーザーに明示的に準備完了であることを確認するようにトーナメントハブがらリクエストされます。

`UserMatches`

全てのフェーズのすべてのユーザーマッチ

public List<TournamentMatch> UserMatches
{
    get;
    set;
}

備考

ユーザーが特定のラウンドに開始できなかったりラウンドマッチをスキップ（自動敗北）した場合、そのマッチはリストに表示されません。
トーナメントフェーズオブジェクトにUserPlayedRoundCountプロパティを使用して本当にユーザーがマッチを行わなかったか判定します。

`Winner`

トーナメントの勝者の基本データを取得します。
最初の位置で終了した全パーティの全てのユーザーのリストが含まれます。

public TournamentWinner Winner
{
    get;
    set;
}

備考

トーナメントの最後のフェーズにグループがある場合、最終位置はグループ内で計算されるため、そのトーナメントでは複数の勝者が存在する可能性があります。

メソッド

`GetCurrentTournamentPhase()`

現在のトーナメントフェーズを取得します。

public Gimmebreak.Backbone.Tournaments.TournamentPhase GetCurrentTournamentPhase()

リターン

トーナメントのフェーズ、またはトーナメントがまだ開始されていない場合はnullを返します。終了したトーナメントが常に最後のフェーズを返します。

`GetMatchMinGameLength(TournamentMatch)`

ゲームをプレイするのに必要な最小の長さを（分で）取得します。

public int GetMatchMinGameLength(Gimmebreak.Backbone.Tournaments.TournamentMatch match)

パラメータ

match: トーナメントマッチ。

リターン

最小の長さ（分）

`GetMatchNextGameDeadline(TournamentMatch)`

This item is deprecated. Use GetMatchNextGameFinishDeadline() instead.

次のゲームへの締め切りをマッチ内で計算します。
締め切りはこれからプレイされる各ゲームの最小のゲーム時間を考慮して計算されます。

public System.DateTime GetMatchNextGameDeadline(Gimmebreak.Backbone.Tournaments.TournamentMatch match)

パラメータ

match: トーナメントマッチ

リターン

次のゲームへの可能な限り長い締め切りを返します。

`GetMatchNextGameFinishDeadline(TournamentMatch)`

マッチ内の次のゲームの終了締め切りを計算します。
締め切りはこれからプレイされる各ゲームの最小のゲーム時間を考慮して計算されます。

public System.DateTime GetMatchNextGameFinishDeadline(Gimmebreak.Backbone.Tournaments.TournamentMatch match)

パラメータ

match: トーナメントマッチ
リターン
次のゲームへの可能な限り長い締め切りを返します。

`GetMatchNextGameStartDeadline(TournamentMatch)`

マッチ内で次のゲームの開始締め切りを計算します。
締め切りはこれからプレイされる各ゲームの最小のゲーム時間を考慮して計算されます。

public System.DateTime GetMatchNextGameStartDeadline(Gimmebreak.Backbone.Tournaments.TournamentMatch match)

パラメータ

match: トーナメントマッチ
Returns
次のゲームへの可能な限り長い締め切りを返します。

`GetMatchStartDeadline(TournamentMatch)`

全ての必要なゲームの少なくとも最小時間分のスペースを確保するため、どのマッチが必要かわかった後に判定します。

public System.DateTime GetMatchStartDeadline(Gimmebreak.Backbone.Tournaments.TournamentMatch match)

パラメータ

match: トーナメントマッチ

リターン

どのマッチを開始するかの後の期限

`GetThemeColor()`

トーナメントのテーマカラーを取得します。

public UnityEngine.Color GetThemeColor()

リターン

Unityカラー。

`GetTournamentMatchById(long)`

一意のIDでトーナメントマッチを取得します。

public Gimmebreak.Backbone.Tournaments.TournamentMatch GetTournamentMatchById(long tournamentMatchId)

パラメータ

tournamentMatchId: トーナメントマッチID。

リターン

トーナメントマッチ、またはマッチがいつからない場合はnullを返します。
Remarks

このメソッドは、マッチをローカルで検索し、サーバーデータにはアクセスしません。
マッチIDが有効で、メソッドがnullを返す場合は、ローカルデータをバックボーンクライアントにLoadTournamentMatches()で入力します。

`GetTournamentMatchMaxGameCount(TournamentMatch)`

特定のマッチでプレイ可能な最大ゲーム数を判定します。
この値に到達すると、システムがプレイされたすべてのゲームの得点で勝者を判定します。

public int GetTournamentMatchMaxGameCount(Gimmebreak.Backbone.Tournaments.TournamentMatch match)

パラメータ

match: トーナメントマッチ

リターン

可能な最大ゲーム数を返します。

`GetTournamentMatchMinCheckinsPerTeam(TournamentMatch)`

特定のマッチで必要な勝ち点を判定します。
勝ち点は、ユーザーが勝つために得点位置に入るべき回数を意味します。

public int GetTournamentMatchMinCheckinsPerTeam(Gimmebreak.Backbone.Tournaments.TournamentMatch match)

パラメータ

match: トーナメントマッチ

リターン

特定のマッチでの勝ち点

`GetTournamentMatchWinScore(TournamentMatch)`

特定のマッチに必要な勝ち点を判定します。
勝ち点は、ユーザーが勝つために得点位置に入るべき回数を意味します。

public int GetTournamentMatchWinScore(Gimmebreak.Backbone.Tournaments.TournamentMatch match)

パラメータ

match: トーナメントマッチ

リターン

特定のマッチの勝ち点。

`GetTournamentPhaseById(int)`

特定のトーナメントフェーズをIDで取得します。

public Gimmebreak.Backbone.Tournaments.TournamentPhase GetTournamentPhaseById(int phaseId)

パラメータ

phaseId: トーナメントフェーズID (最初のフェーズは常に1で始まります).

リターン

トーナメントフェーズ、またはフェーズが存在しない場合はnullを返します。

`GetTournamentPhaseFinishTime(int)`

特定のトーナメントフェーズの終了タイムスタンプを取得します

public System.DateTime GetTournamentPhaseFinishTime(int phaseId)

パラメータ

phaseId:フェーズID
リターン
要求したフェーズの終了タイムスタンプ

`GetTournamentPhaseMaxLength(int)`

トーナメントフェーズの最長時間を分数で取得します。全ラウンドのMaxLength値の合計です。

public int GetTournamentPhaseMaxLength(int phaseId)

パラメータ

phaseId: フェーズID。
リターン
トーナメントフェーズの分数。

`GetTournamentPhaseRoundFinishTime(int, int)`

現在の有効なトーナメントフェーズの最終タイムスタンプのラウンドを取得します。

public System.DateTime GetTournamentPhaseRoundFinishTime(int phaseId, int roundId)

パラメータ

phaseId: フェーズID。
roundId: ラウンドID。.
リターン
要求したフェーズの終了タイムスタンプ

`GetTournamentPhaseRoundStartTime(int, int)`

Get round start timestamp in currently active tournament phase.

public System.DateTime GetTournamentPhaseRoundStartTime(int phaseId, int roundId)

パラメータ

phaseId: フェーズID。
roundId: ラウンドID。
リターン
要求したラウンドの開始タイムスタンプ。

`GetTournamentPhaseStartTime(int)`

Get start timestamp of specific tournament phase.

public System.DateTime GetTournamentPhaseStartTime(int phaseId)

パラメータ

phaseId: Phase id.
リターン
要求したフェーズの開始タイムスタンプ

`IsMatchInLoserBracket(TournamentMatch)`

敗者のトーナメント表にマッチがあるか判定します。
ダブルエリミネーション方式に使用されます。

public bool IsMatchInLoserBracket(Gimmebreak.Backbone.Tournaments.TournamentMatch match)

パラメータ

match: トーナメントマッチ

リターン

敗者のトーナメント票にマッチがある場合はtrueを返します。

`IsMatchInWinnerBracket(TournamentMatch)`

勝者のトーナメント票にマッチがあるか判定します。
ダブルエリミネーション方式に使用されます。

public bool IsMatchInWinnerBracket(Gimmebreak.Backbone.Tournaments.TournamentMatch match)

パラメータ

match: トーナメントマッチ

リターン

勝者のトーナメント表にマッチがある場合はtrueを返します。

`IsMatchMergingInLoserBracket(TournamentMatch)`

マッチが敗者のトーナメント表内でマージされているか判定します。
ダブルエリミネーション方式に使用されます。

public bool IsMatchMergingInLoserBracket(Gimmebreak.Backbone.Tournaments.TournamentMatch match)

パラメータ

match: トーナメントマッチ

リターン

マッチが敗者のトーナメント表内でマージされている場合はTrueを返します。

備考

敗者のトーナメント表でマージが行われると、敗者のトーナメント表での勝者はそのトーナメント表の他の勝者と対決することになります。
マッチがマージされていない場合は、敗者のトーナメント表での勝者は、勝者のトーナメント表の敗者と対決することになります。そのため次のラウンドでの敗者のトーナメント表のマッチ数は同じになります。
このメソッドは、ダブルエリミネーション方式のトーナメント表でのUI可視化に便利です。

コンストラクター
プロパティ
メソッド