API-ITournamentHubController
ネームスペース: Gimmebreak.Backbone.Tournaments
インヘリタンス: Object → ITournamentHubController
ユーザーに接続したトーナメントハブ (ITournamentHubCallbackHandler)を介してトーナメントと連動する一連のメソッドを提供します。
トーナメントハブを開始したら、このインターフェースを実装しているコントローラがトーナメントハブに提供されます。
トーナメントハブコントローラを使用してユーザーアクティブマッチに参加し、トーナメントマッチステータスアップデートを受け取ります。
JoinTournamentMatch()を呼び出すと、トーナメントハブとゲームルーム・ロビーAPI間のインターフェースを作成するトーナメントマッチハンドラーが提供されます。
C#
public interface ITournamentHubController
プロパティ
ActiveMatchFinishDeadlineCountdown
ユーザーアクティブマッチが終了するまでの残り時間を判定します。
C#
public abstract virtual TimeSpan ActiveMatchFinishDeadlineCountdown
{
get;
}
備考
終了時間はDeadlineマッチプロパティのすべてのマッチから取得できます。
ActiveMatchStartDeadlineCountdown
ユーザーアクティブマッチが始まるまでの残り時間を判定します。
C#
public abstract virtual TimeSpan ActiveMatchStartDeadlineCountdown
{
get;
}
備考
全てのマッチの開始時間は、tournament.GetMatchStartDeadline(TournamentMatch)を呼び出して取得できます。
IsConnectedToGameServerNetwork
トーナメントマッチハンドラーがゲームサーバーに接続したかどうか判定します。
C#
public abstract virtual bool IsConnectedToGameServerNetwork
{
get;
}
備考
UIの通知に使用できます（例：トーナメントハンドラーは優先トーナメントサーバーリージョンに切り替えています）。
IsGameSessionInProgress
ゲームセッションが進行しているかどうか判定します。
C#
public abstract virtual bool IsGameSessionInProgress
{
get;
}
IsMatchHandlerInitialized
トーナメントマッチハンドラーが開始されたかどうか判定します。
C#
public abstract virtual bool IsMatchHandlerInitialized
{
get;
}
備考
JoinTournamentMatch(TournamentMatch, ITournamentMatchCallbackHandler)からの呼び出しが正常に行われた後、trueに設定されます。
また、LeaveTournamentMatch() 呼び出しの後、falseに設定が戻ります。
IsTournamentRunning
トーナメントが実行中（開始されたか）かどうか判定します。
C#
public abstract virtual bool IsTournamentRunning
{
get;
}
IsUserKnockedOut
ユーザーがトーナメントで敗退したかどうか判定します。
C#
public abstract virtual bool IsUserKnockedOut
{
get;
}
NextEventCountdown
ユーザーの次の決勝イベントまでの残り時間を判定します。（例：トーナメント開始までの残り時間）
C#
public abstract virtual TimeSpan NextEventCountdown
{
get;
}
PartyInvites
ユーザーが受信したこのトーナメントへのすべてのパーティ招待を取得します。
取り下げた招待も含まれます。
C#
public abstract virtual IEnumerable<TournamentPartyInviteNotification> PartyInvites
{
get;
}
備考
ユーザー招待を更新（最近受信した招待を取得）するには、バックボーンクライアントでLoadNotifications()を呼び出します。
Status
最新のトーナメントハブステータスを取得します。
C#
public abstract virtual TournamentHubStatus Status
{
get;
}
Tournament
このコントローラが開始されたトーナメントを取得します。
C#
public abstract virtual Tournament Tournament
{
get;
}
メソッド
IsUserConnectedToMatch(long)
特定のユーザーがトーナメントマッチルーム・ロビーに接続したかどうか判定します。
C#
public abstract virtual bool IsUserConnectedToMatch(long userId)
パラメータ
userId: バックボーンユーザーID。
リターン
ユーザーが接続していればTrue。
備考
UIを通知するのに使用できます（例：トーナメントユーザーがルーム・ロビーに接続されました）。
IsUserReadyForMatch(long)
特定のユーザーのトーナメントマッチ準備が完了したか判定します。
C#
public abstract virtual bool IsUserReadyForMatch(long userId)
パラメータ
userId: バックボーンユーザーID。
リターン
ユーザーの準備ができていればtrue。
備考
UIの通知に使用できます（例：ユーザーがルーム・ロビーに接続されました、ユーザーが希望のルームスロットに入りました、など）。
JoinTournamentMatch(TournamentMatch, ITournamentMatchCallbackHandler)
トーナメントハブにユーザーが特定のマッチに参加しゲームルーム・ロビーへの接続を開始することを通知します。
ゲームルーム・ロビー処理APIへのインターフェースであるトーナメントマッチコールバックハンドラー(ITournamentMatchCallbackHandler)をパスする必要があります（例：特定のパラメータで非公開ゲームルームを設定する）。
C#
public abstract virtual void JoinTournamentMatch(Gimmebreak.Backbone.Tournaments.TournamentMatch match, Gimmebreak.Backbone.Tournaments.ITournamentMatchCallbackHandler tournamentMatchHandler)
パラメータ
match: ユーザーが参加を希望するトーナメントマッチtournamentMatchHandler: ルーム・ロビー処理APIをインターフェースするITournamentMatchCallbackHandlerを実装しているトーナメントマッチハンドラー
備考
マッチへの参加をリクエストした後、トーナメントハブはOnHubMatchStatusChanged(TournamentHubMatchStatus)コールバックを介してトーナメントマッチステータスを受信し始めます。
LeaveTournamentMatch()
参加したトーナメントマッチから退出します。
C#
public abstract virtual void LeaveTournamentMatch()
備考
マッチからの退出をリクエストした後、トーナメントハブはOnHubMatchStatusChanged(TournamentHubMatchStatus)コールバック経由でのトーナメントマッチステータスの受信を停止します。
トーナメントマッチハンドラーに参加しているルーム・ロビーから退出するよう促します。
RefreshActiveMatch()
UserActiveMatchデータを更新するユーザーリクエスト
C#
public abstract virtual void RefreshActiveMatch()
SetUserReady()
ユーザーがトーナメントに次のマッチへの準備が完了していることを通知します。
トーナメントハブステータスがTournamentHubStatus.WaitingForUserReadyConfirmationに設定されているときに使用されるものです。
C#
public abstract virtual void SetUserReady()
備考
ユーザーがマッチを終了すると毎回、システムがユーザーを次のラウンドに移すわけではありません。
また、ユーザーに自動敗北が与えられたり、ラウンドの終了時に次のマッチに移動するかどうかは特定のフェーズ形式によります。
例として、トーナメント表の設定、勝ったユーザーはラウンドの終了時に次に進みます。
例として、アリーナ設定でSetUserReady()呼び出しの失敗に対して自動敗北が与えられます。