Skip to content

Commit 7c8b43c

Browse files
committed
Add notice that friend modification APIs don't impact the local platform or Epic Games
1 parent 4efd4d0 commit 7c8b43c

6 files changed

Lines changed: 36 additions & 0 deletions

File tree

docs/ossv1/friends/blocked_players.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,12 @@ In future, we intend to automatically handle the following scenarios for you:
2222
- Automatically rejecting friend invitations from blocked players.
2323
:::
2424

25+
:::warning
26+
APIs for modifying the friends list only impact the cross-platform friends database and will not affect the local platform or Epic Games friends list. This includes actions such as sending and receiving invites, blocking and unblocking players and modifying recent players.
27+
28+
It is not possible to support modifying the local platform's friends list or Epic Games friends list programmatically, as the platform SDKs and EOS SDK do not expose this functionality.
29+
:::
30+
2531
## Getting the blocked players list
2632

2733
<Tabs lazy groupId="code-format" defaultValue="c++" values={[ { label: 'C++', value: 'c++' }, { label: 'Blueprints', value: 'blueprints' } ]}>

docs/ossv1/friends/blocked_players_manage.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@ EOS Online Framework provides the "blocked players" functionality of the friends
1111

1212
Refer to [Read the blocked players list](blocked_players.mdx) for more information on how the blocked players list works.
1313

14+
:::warning
15+
APIs for modifying the friends list only impact the cross-platform friends database and will not affect the local platform or Epic Games friends list. This includes actions such as sending and receiving invites, blocking and unblocking players and modifying recent players.
16+
17+
It is not possible to support modifying the local platform's friends list or Epic Games friends list programmatically, as the platform SDKs and EOS SDK do not expose this functionality.
18+
:::
19+
1420
## Blocking another player
1521

1622
<Tabs lazy groupId="code-format" defaultValue="c++" values={[ { label: 'C++', value: 'c++' }, { label: 'Blueprints', value: 'blueprints' } ]}>

docs/ossv1/friends/deleting.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,12 @@ A user might want to delete a friend that they previously added to their friends
1313
You can't delete friends if they're friends from the local platform (such as Steam). To know if you can delete a friend from the friends list, check the `deletable` user attribute. It will be `true` if the friend can be deleted.
1414
:::
1515

16+
:::warning
17+
APIs for modifying the friends list only impact the cross-platform friends database and will not affect the local platform or Epic Games friends list. This includes actions such as sending and receiving invites, blocking and unblocking players and modifying recent players.
18+
19+
It is not possible to support modifying the local platform's friends list or Epic Games friends list programmatically, as the platform SDKs and EOS SDK do not expose this functionality.
20+
:::
21+
1622
## Deleting a friend from the friends list
1723

1824
<Tabs lazy groupId="code-format" defaultValue="c++" values={[ { label: 'C++', value: 'c++' }, { label: 'Blueprints', value: 'blueprints' } ]}>

docs/ossv1/friends/invites.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,12 @@ In order for a friend invite to be sent, both the sender and receiver need to be
1515

1616
If you send a friend invite to someone, and they're not currently online, the friend invite will be stored as a "pending invite" in Player Data Storage. The plugin automatically retries every 10 minutes to send the invite again, and will resume retrying to send it even across game launches.
1717

18+
:::warning
19+
APIs for modifying the friends list only impact the cross-platform friends database and will not affect the local platform or Epic Games friends list. This includes actions such as sending and receiving invites, blocking and unblocking players and modifying recent players.
20+
21+
It is not possible to support modifying the local platform's friends list or Epic Games friends list programmatically, as the platform SDKs and EOS SDK do not expose this functionality.
22+
:::
23+
1824
## Sending an invite to another player
1925

2026
<Tabs lazy groupId="code-format" defaultValue="c++" values={[ { label: 'C++', value: 'c++' }, { label: 'Blueprints', value: 'blueprints' } ]}>

docs/ossv1/friends/recent_players.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,12 @@ You don't need to manually add recently seen players; the plugin will check what
1313

1414
You no longer need to call `QueryRecentPlayers` - the plugin automatically caches the recent players during login and keeps the list of recent players up-to-date.
1515

16+
:::warning
17+
APIs for modifying the friends list only impact the cross-platform friends database and will not affect the local platform or Epic Games friends list. This includes actions such as sending and receiving invites, blocking and unblocking players and modifying recent players.
18+
19+
It is not possible to support modifying the local platform's friends list or Epic Games friends list programmatically, as the platform SDKs and EOS SDK do not expose this functionality.
20+
:::
21+
1622
## Getting the recent players list
1723

1824
<Tabs lazy groupId="code-format" defaultValue="c++" values={[ { label: 'C++', value: 'c++' }, { label: 'Blueprints', value: 'blueprints' } ]}>

docs/systems/friends.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@ The friend system provides a common API for reading and managing cross-platform
1010
The C++ APIs described in this section are only available in the Paid Edition, as the Free Edition does not ship with any C++ headers.
1111
:::
1212

13+
:::warning
14+
APIs for modifying the friends list only impact the cross-platform friends database and will not affect the local platform or Epic Games friends list. This includes actions such as sending and receiving invites, blocking and unblocking players and modifying recent players.
15+
16+
It is not possible to support modifying the local platform's friends list or Epic Games friends list programmatically, as the platform SDKs and EOS SDK do not expose this functionality.
17+
:::
18+
1319
## Updating your game module dependencies
1420

1521
Before you can access the friend system, you need to update your game module's `.Build.cs` file to depend on the `RedpointEOSFriends` module, like so:

0 commit comments

Comments
 (0)