Class Gs2RealtimeClient
-
GS2\Core\AbstractGs2Client
-
GS2\Realtime\Gs2RealtimeClient
Methods summary
public
|
#
__construct( string $region, GS2\Core\Gs2Credentials $credentials, array $options = [] )
コンストラクタ
Parameters
- $region
- リージョン名
- $credentials
- 認証情報
- $options
- オプション
|
public
array
|
#
describeGatheringPool( string $pageToken = NULL, integer $limit = NULL )
ギャザリングプールリストを取得
Parameters
- $pageToken
- ページトークン
- $limit
- 取得件数
Returns
array
- items
- array
- gatheringPoolId => ギャザリングプールID
- ownerId => オーナーID
- name => ギャザリングプール名
- description => 説明文
- createAt => 作成日時
- nextPageToken => 次ページトークン
|
public
array
|
#
createGatheringPool( array $request )
ギャザリングプールを作成
GS2-Realtime を利用するには、まずギャザリングプールを作成する必要があります。
ギャザリングプールには複数のギャザリングを紐付けることができます。
ギャザリングプールを作成
GS2-Realtime を利用するには、まずギャザリングプールを作成する必要があります。
ギャザリングプールには複数のギャザリングを紐付けることができます。
Parameters
- $request
- name => マッチメイキング名
- description => 説明文
Returns
array
- item
- gatheringPoolId => ギャザリングプールID
- ownerId => オーナーID
- name => ギャザリングプール名
- description => 説明文
- createAt => 作成日時
|
public
array
|
#
getGatheringPool( array $request )
ギャザリングプールを取得
Parameters
- $request
- gatheringPoolName => ギャザリングプール名
Returns
array
- item
- gatheringPoolId => ギャザリングプールID
- ownerId => オーナーID
- name => ギャザリングプール名
- description => 説明文
- createAt => 作成日時
|
public
array
|
#
updateGatheringPool( array $request )
ギャザリングプールを更新
Parameters
- $request
- gatheringPoolName => ギャザリングプール名
- description => 説明文
Returns
array
- item
- gatheringPoolId => ギャザリングプールID
- ownerId => オーナーID
- name => ギャザリングプール名
- description => 説明文
- createAt => 作成日時
|
public
|
#
deleteGatheringPool( array $request )
ギャザリングプールを削除
Parameters
- $request
- gatheringPoolName => ギャザリングプール名
|
public
array
|
#
describeGathering( array $request, string $pageToken = NULL, integer $limit = NULL )
ギャザリングリストを取得
Parameters
- $request
- gatheringPoolName => ギャザリングプール名
- $pageToken
- ページトークン
- $limit
- 取得件数
Returns
array
- items
- array
- gatheringId => ギャザリングID
- ownerId => オーナーID
- name => ギャザリング名
- hostId => ホストID
- ipAddress => IPアドレス
- port => 待ち受けポート
- secret => 暗号鍵
- userIds => 参加ユーザIDリスト
- createAt => 作成日時
- nextPageToken => 次ページトークン
|
public
array
|
#
createGathering( array $request )
ギャザリングを作成
ギャザリングを作成すると、ゲームサーバが起動します。
ゲームサーバはWebSocketで接続することができ、同じゲームサーバに接続しているユーザ間でメッセージをやり取りすることができます。
ゲームサーバとの通信プロトコルの説明については別途ドキュメントを確認してください。
userIds にユーザIDを指定することで、ギャザリングに参加できるユーザのIDを制限することができます。
ギャザリング作成時に参加するユーザが確定している場合は指定してください。
省略すると、暗号鍵を知っていれば誰でも参加することができます。
ギャザリングを作成
ギャザリングを作成すると、ゲームサーバが起動します。
ゲームサーバはWebSocketで接続することができ、同じゲームサーバに接続しているユーザ間でメッセージをやり取りすることができます。
ゲームサーバとの通信プロトコルの説明については別途ドキュメントを確認してください。
userIds にユーザIDを指定することで、ギャザリングに参加できるユーザのIDを制限することができます。
ギャザリング作成時に参加するユーザが確定している場合は指定してください。
省略すると、暗号鍵を知っていれば誰でも参加することができます。
Parameters
- $request
- gatheringPoolName => ギャザリングプール名
- name => ギャザリング名
- userIds => 参加ユーザIDリスト
Returns
array
- item
- gatheringId => ギャザリングID
- ownerId => オーナーID
- name => ギャザリング名
- hostId => ホストID
- ipAddress => IPアドレス
- port => 待ち受けポート
- secret => 暗号鍵
- userIds => 参加ユーザIDリスト
- createAt => 作成日時
|
public
array
|
#
getGathering( array $request )
ギャザリングを取得
Parameters
- $request
- gatheringPoolName => ギャザリングプール名
- gatheringName => ギャザリング名
Returns
array
- item
- gatheringId => ギャザリングID
- ownerId => オーナーID
- name => ギャザリング名
- hostId => ホストID
- ipAddress => IPアドレス
- port => 待ち受けポート
- secret => 暗号鍵
- userIds => 参加ユーザIDリスト
- createAt => 作成日時
|
public
|
#
deleteGathering( array $request )
ギャザリングを削除
Parameters
- $request
- gatheringPoolName => ギャザリングプール名
- gatheringName => ギャザリング名
|