If you plan in order to consist of Epic Membership Features together with your games, and also you must address unit platforms, please call us in the eas-on-console- so you’re able to complement a production plan.
Winning contests together with your family and you will meeting the latest people online is actually crucial areas of of numerous online properties. New Unbelievable On the internet Qualities (EOS) SDK uses the new Friends Interface in order to access brand new family unit members list getting a great logged-when you look at the pro.
Friend lists is actually held from the online service’s server, and certainly will changes during the an appointment as the members of the family was additional or got rid of or if perhaps relatives offer or revoke concur into the video game to make use of their suggestions.
On effective conclusion out-of a buddies listing query, the newest Friends Software brings a neighbor hood cache which is used of the any kind of Loved ones User interface characteristics. Additionally the SDK obtains notifications about backend on incidents one bring about mutations of members of the family list, for example a pal being removed, an invite getting recognized or a friend revoking their accept to features their advice employed by the online game.
To make use of new Family User interface, your product or service should have Epic Account Properties (EAS) active, and may obtain member agree to availableness Loved ones Checklist research. You can turn on EAS on Designer Portal, or discover more when you look at the Epic’s documents.
Retrieving and you can Caching the new Family Checklist
So you’re able to access a player’s family members record, you will want an EOS_HFriends manage. You will get which handle from the Program Interface setting, EOS_Platform_GetFriendsInterface . Family Interface attributes want which manage to view your signed-from inside the customer’s family relations checklist. It is essential to keep in mind that EOS_Friends_QueryFriends will only get back household members that have starred the online game within least immediately following and has now considering their concur. Agree is provided when a person logs in to a credit card applicatoin using Epic Membership Attributes (EAS) and you will lets EAS access to the membership investigation.
The first step when controling a great player’s family members number try to mention EOS_Friends_QueryFriends with an EOS_Friends_QueryFriendsOptions study framework. This may install the quintessential right up-to-big date brand of a beneficial player’s nearest and dearest listing into the regional cache, up coming invoke your own EOS_Friends_QueryFriends callback form upon achievement.
Ticket the newest Relatives Software deal with, the newest EOS_Friends_QueryFriendsOptions build, along with your callback recommendations towards function. So long as the latest EOS_HPlatform handle was ticking, the callback your considering will run if the procedure ends up.
When your callback works, you can check the new ResultCode world of the EOS_Friends_QueryFriendsCallbackInfo structure to decide perhaps the operation been successful otherwise unsuccessful. An endurance password indicates that the latest SDK has cached the brand new investigation about host, which you’ll take a look at when.
Exploring the Relatives List
- Influence just how many relatives into list by the calling EOS_Friends_GetFriendsCount .
- Retrieve the fresh EOS_EpicAccountId each and every friend by the getting in touch with EOS_Friends_GetFriendAtIndex .
The latest EOS_EpicAccountId came back by this means can be passed into Representative Details User interface to access additional information about the user.
- Determine the current standing of societal matchmaking from the getting in touch with EOS_Friends_GetStatus . This means returns one of five beliefs:
Relatives lists changes any time, one another of when you look at the-online game occurrences instance conference the participants, and away from away-of-games situations such as the member switching the latest membership from good parece do not need and cannot phone call EOS_Friends_QueryFriends more than once for every single login from a person. However, once a player logs aside, people they know number need to be queried again once they log in once again. To keep an excellent game’s local content of your own family list up up to now, subscribe to pal condition improve notifications.
Subscribing to Friend Standing Position
The fresh new callback means could well be entitled when a friend will get an change. Brand new callback obtains an EOS_Friends_OnFriendsUpdateInfo framework on the following the details:
EOS_Friends_AddNotifyFriendsUpdate often go back an enthusiastic EOS_NotificationId , that’s a different sort of deal with that needs to be familiar with unsubscribe of announcements while they are no longer necessary. In the eventuality of a failure, it does go back a consequence code from EOS_INVALID_NOTIFICATIONID .
Managing the Nearest and dearest Listing
Assistance for Nintendo Key, PlayStation, and you will Xbox 360 system networks is prepared. Help to have macOS, Linux, Android and ios try planned.
You could potentially allow local member to send friend requests to other users from the game, because of the getting in touch with the latest EOS_Friends_SendInvite SDK API. To implement games UI effectiveness for accepting otherwise rejecting people acquired buddy encourages, you can use this new EOS_Friends_AcceptInvite and EOS_Friends_RejectInvite SDK APIs respectively.