Online Services の Privileges インターフェース はプレイヤーのオンライン権限を管理します。権限は、プレイヤーの次の能力を参照します。
- オンラインでのプレイ。
- クロスプレイへの参加。
- 他のプレイヤーとの交流。
- コミュニティで作成されたコンテンツの使用。
API の概要
機能
次の表は、Privileges インターフェースによって提供される関数の概要を示しています。
| 関数 | 説明 |
|---|---|
QueryUserPrivilege |
指定されたユーザーの特定の 権限 をクエリします。 |
列挙型クラス
Privileges インターフェースは、2 つの列挙型クラスを通じてユーザー権限とユーザー権限ステータスを伝達しますが、権限のステータスは EPrivilegeResults によって指定されます。
EUserPrivileges
ユーザー権限は、EUserPrivileges 列挙型クラスによって表されます。
| 値 | 説明 |
|---|---|
CanPlay |
ユーザーがゲームをオンラインまたはオフラインでプレイできるかどうかを指定します。 |
CanPlayOnline |
ユーザーがオンライン モードでプレイできるかどうかを指定します。 |
CanCommunicateViaTextOnline |
ユーザーがテキスト チャットを使用できるかどうかを指定します。 |
CanCommunicateViaVoiceOnline |
ユーザーがボイス チャットを使用できるかどうかを指定します。 |
CanUseUserGeneratedContent |
ユーザーが他のユーザーが作成したコンテンツを使用できるかどうかを指定します。 |
CanCrossPlay |
ユーザーがクロスプレイに参加できるかどうかを指定します。 |
EPrivilegeResults
ユーザーの権限ステータスは、1 つ以上の EPrivilegeResults によって指定されます。
| 値 | 説明 |
|---|---|
NoFailures |
ユーザーは要求された権限を保持しています。 |
RequiredPatchAvailable |
ユーザーが権限を使用するには、パッチが必要です。 |
RequiredSystemUpdate |
ユーザーが権限を使用するには、システム更新が必要です。 |
AgeRestrictionFailure |
ペアレンタル コントロールがエラーになったため、権限が制限されています。 |
AccountTypeFailure |
権限にはプレミアム アカウントが必要です。 |
UserNotFound |
無効なユーザーです。 |
UserNotLoggedIn |
ユーザーが権限を使用するには、ログインしている必要があります。 |
ChatRestriction |
ユーザーはチャットが制限されています。 |
UGCRestriction |
ユーザーは、ユーザーが作成したコンテンツ (UGC) を制限されています。 |
GenericFailure |
プラットフォームが不明な理由により失敗したため、独自のダイアログを処理します。 |
OnlinePlayRestricted |
オンライン プレイが制限されています。 |
NetworkConnectionUnavailable |
ネットワークを利用できないため、チェックが失敗しました。 |
ユーザー権限
QueryUserPrivilege を呼び出して、ユーザーがゲームで特定のオンライン機能または権限の使用を許可されているかどうかを判断します。QueryUserPrivilege には、ユーザーのローカル アカウント ID と当該の権限をパラメータとして指定する必要があります。QueryUserPrivilege は指定したユーザーが指定した権限を許可されているかどうかを示す結果を返します。問い合わせた権限の使用がユーザーに許可されていない場合、結果にはその理由が示されます。
権限の使用が許可されない理由は、複数ある可能性があります。そのため、結果の構造は、ユーザーが指定した権限の使用を許可されない理由を表す EPrivilegeResults 値の累積するビット単位の OR です。ユーザーにこの権限の使用が許可されている場合、クエリは問い合わせた権限の使用を妨げるものがないことを示す EPrivilegeResults::NoFailures を返します。
ゲームが中断されると、特定の権限が変更される可能性があります。特定のゲーム オプションが利用できなくなることがあるため、ゲームがアクティブな状態に戻るたびにユーザー権限を再クエリすることが重要です。
追加資料
ヘッダ ファイル
詳細については、必要に応じて「Privileges.h」ヘッダ ファイルを直接確認してください。Privileges インターフェースのヘッダ ファイル「Privileges.h」は、次のディレクトリにあります。
UNREAL_ENGINE_ROOT\Engine\Plugins\Online\OnlineServices\Source\OnlineServicesInterface\Public\Online
UE のソース コードの入手方法については、「Unreal Engine のソース コードをダウンロードする」を参照してください。
関数パラメータおよび戻り型
関数のパラメータと戻り型、およびパラメータの渡し方や関数が戻ったときの結果の処理方法などについては、「Online Services の概要」ページの「関数」セクションを参照してください。