Custom Invites インターフェース

Epic マッチメイキングを使用しない場合に招待を処理するためのインターフェースです。

Custom Invites インターフェースは、タイトルがビルトインの Epic Online Service (EOS) Connect メッセージング システムを介して招待 (任意のペイロードを含む) を送受信できるように設計されています。タイトルに堅牢な招待システムが既に存在し、ユーザーが Epic Account Services (EAS) Social Overlay UI を介してこれらの招待の送受信ができるようにする場合は、Custom Invites が唯一の適切な招待インターフェースであるとみなす必要があります。

Epic Games StoreEpic Games LauncherSocial Overlay のために、Custom Invite (カスタム招待)Session および Lobby の招待状と同じように転送および配信されます。ストアまたはランチャーがカスタム招待 (Custom Invite) を受信すると、送信者とゲームを示す UI がユーザーに表示されます。プレイヤーが招待を受け入れると、関連する製品/ゲームが開始されます。

カスタム招待を送信する

カスタム招待ペイロードを準備する

カスタム招待ペイロードは FString であり、EOS_CUSTOMINVITES_MAX_PAYLOAD_LENGTH を超えてはいけません (現在は 500)。そのコンテンツは SDK に対して不透明であり、そのまま受信ユーザーに送信されます。

カスタム招待ペイロードを設定する

カスタム招待を送信する前、またはローカル プレイヤーがカスタム招待を送信するためにソーシャル オーバーレイを使用できるようにする前に、EOS_CustomInvites_SetCustomInvite を使用してカスタム招待ペイロードを設定します。EOS_CustomInvites_SendCustomInvite へのすべての呼び出し、およびオーバーレイの [INVITE (招待)] ボタンでプレイヤーによって開始されるすべての招待は、このペイロードを使用します。

カスタム招待を EOSSDK で送信する

ペイロードの設定が完了したら、EOS_CustomInvites_SendCustomInvite を使って指定されたユーザーまたはユーザーのブループに招待を送信することができます。

ソーシャル オーバーレイを介してカスタム招待を送信する

EOS_CustomInvites_SetCustomInvite を介してカスタム招待ペイロードが設定されると、ソーシャル オーバーレイによってローカル プレイヤーは [Invite] ボタンを使って現在設定されたカスタム招待ペイロードを使って友達招待を送信することができるようになります。

カスタム招待を処理する

コールバック - カスタム招待の受信

EOS_CustomInvites_AddNotifyCustomInviteReceived 関数と EOS_CustomInvites_RemoveNotifyCustomInviteReceived 関数を使って、独自の方法で検出、カスタム UI 表示、カスタム招待の処理を行うことができます。ログインして初期化する動作により、保留中のカスタム招待が検出され、即座に通知が生成されるため、これらはログイン前に呼び出す必要があります。

カスタム招待が処理されたら (ユーザーによって同意または許可されたら)、

EOS_CustomInvites_FinalizeInvite を呼び出して、内部 SDK とソーシャル オーバーレイの認識の両方からカスタム招待を削除する必要があります。

ポリシー コンフィギュレーション

カスタム ポリシーを使用して通知サービスを有効にし、userRequired で許可するには、クライアント ポリシーの権限 を構成する必要があります。

  • sendCustomInviteToAnyUser: ユーザーが任意のユーザーにカスタム招待を送信できるようにします。