リアルタイムサーバークライアント API (C#) リファレンス: アクション

この C# リアルタイムクライアント API リファレンスは、Amazon GameLift フリートにデプロイされたリアルタイムサーバーで使用するマルチプレイヤーゲームを準備するのに役立ちます。

Client()

Realtime サーバーと通信するように新しいクライアントを初期化し、使用する接続のタイプを識別します。

構文

public Client(ClientConfiguration configuration)

パラメータ

戻り値

Realtime サーバーとの通信に使用するリアルタイムクライアントのインスタンスを返します。

Connect()

ゲームセッションをホストしているサーバープロセスへの接続をリクエストします。

構文

public ConnectionStatus Connect(string endpoint, int remoteTcpPort, int listenPort, ConnectionToken token)

パラメータ

戻り値

クライアントの接続ステータスを示す ConnectionStatus 列挙値を返します。

Disconnect()

ゲームセッションに接続すると、ゲームクライアントをゲームセッションから切断します。

構文

public void Disconnect()

パラメータ

このアクションにはパラメータがありません。

戻り値

このメソッドは何も返しません。

NewMessage()

指定されたオペレーションコードで新しいメッセージオブジェクトを作成します。メッセージオブジェクトが返されたら、ターゲットを指定し、配信方法を更新します。必要に応じてデータペイロードを追加して、メッセージの内容を完成させます。完了したら、SendMessage() を使用してメッセージを送信します。

構文

public RTMessage NewMessage(int opCode)

パラメータ

戻り値

指定されたオペレーションコードとデフォルトの配信方法を含む RTMessage オブジェクトを返します。配信インテントパラメータはデフォルトで FAST に設定されています。

SendMessage()

指定された配信方法を使用して、プレイヤーまたはグループにメッセージを送信します。

構文

public void SendMessage(RTMessage message)

パラメータ

戻り値

このメソッドは何も返しません。

JoinGroup()

指定されたグループのメンバーシップにプレイヤーを追加します。グループには、ゲームに接続しているすべてのプレイヤーを含めることができます。参加すると、プレイヤーはグループに送信された今後のメッセージをすべて受信し、グループ全体にメッセージを送信できます。

構文

public void JoinGroup(int targetGroup)

パラメータ

戻り値

このメソッドは何も返しません。このリクエストは信頼できる (TCP) 配信方法を使用して送信されるため、失敗したリクエストはコールバックをトリガーしますOnError()。

LeaveGroup()

指定されたグループのメンバーシップからプレイヤーを削除します。グループに参加しなくなったプレイヤーは、グループに送信されたメッセージを受信せず、グループ全体にメッセージを送信することもできません。

構文

public void LeaveGroup(int targetGroup)

パラメータ

戻り値

このメソッドは何も返しません。このリクエストは信頼できる (TCP) 配信方法を使用して送信されるため、失敗したリクエストはコールバックをトリガーしますOnError()。

RequestGroupMembership()

指定されたグループのプレイヤーのリストをゲームクライアントに送信するようにリクエストします。グループのメンバーであるかどうかにかかわらず、どのプレイヤーでもこの情報をリクエストできます。このリクエストに応答して、メンバーシップリストは OnGroupMembershipUpdated() コールバックを介してクライアントに送信されます。

構文

public void RequestGroupMembership(int targetGroup)

パラメータ

戻り値

このメソッドは何も返しません。