FOnlineFriendsPico Class Reference

OnlineFriendsPico class inherited from IOnlineFriends(Unreal Engine). More...

#include <OnlineFriendsInterfacePico.h>

Public Member Functions
	FOnlineFriendsPico (FOnlineSubsystemPico &InSubsystem)
	The constructor. More...
virtual	~FOnlineFriendsPico ()=default
	The default destructor.
virtual bool	ReadFriendsList (int32 LocalUserNum, const FString &ListName, const FOnReadFriendsListComplete &Delegate=FOnReadFriendsListComplete()) override
	Starts an async task that reads the named friends list for the player. More...
virtual bool	GetFriendsList (int32 LocalUserNum, const FString &ListName, TArray< TSharedRef< FOnlineFriend > > &OutFriends) override
	Gets the list of friends for the player previously retrieved from the online service. More...
virtual TSharedPtr< FOnlineFriend >	GetFriend (int32 LocalUserNum, const FUniqueNetId &FriendId, const FString &ListName) override
	Gets the cached friend entry if found. More...
virtual bool	IsFriend (int32 LocalUserNum, const FUniqueNetId &FriendId, const FString &ListName) override
	Checks that a unique player ID is part of the specified user's friends list. More...

Private Attributes
FOnlineSubsystemPico &	PicoSubsystem
	Reference to the main Pico subsystem.
TMap< FString, TSharedRef< FOnlineFriend > >	PlayerFriends
	Current player friends map.
TMap< FString, TSharedRef< FOnlineFriend > >	InvitableUsers
	Current friends map can user invite.

Detailed Description

OnlineFriendsPico class inherited from IOnlineFriends(Unreal Engine).

Constructor & Destructor Documentation

FOnlineFriendsPico()

FOnlineFriendsPico

(

FOnlineSubsystemPico &

InSubsystem

)

The constructor.

Parameters

InSubsystem

A reference to the online subsystem.

Member Function Documentation

GetFriend()

virtual TSharedPtr< FOnlineFriend > GetFriend ( int32  LocalUserNum, const FUniqueNetId &  FriendId, const FString &  ListName  )

overridevirtual

Gets the cached friend entry if found.

Parameters

LocalUserNum	The controller number of the user to read the friends list of.
ListName	The name of the friends list to read.
OutFriends	The [out] array that receives the copied data.

Returns

null ptr if not found.

GetFriendsList()

virtual bool GetFriendsList ( int32  LocalUserNum, const FString &  ListName, TArray< TSharedRef< FOnlineFriend > > &  OutFriends  )

overridevirtual

Gets the list of friends for the player previously retrieved from the online service.

Parameters

LocalUserNum	The controller number of the user to read the friends list of.
ListName	The name of the friends list to read.
OutFriends	The [out] array that receives the copied data.

Returns

Bool:

• true: if friends list was found
• false: otherwise

IsFriend()

virtual bool IsFriend ( int32  LocalUserNum, const FUniqueNetId &  FriendId, const FString &  ListName  )

overridevirtual

Checks that a unique player ID is part of the specified user's friends list.

Parameters

LocalUserNum	The controller number of the associated user that made the request.
FriendId	The ID of the player being checked for friendship.
ListName	The name of the friends list to read.

Returns

Bool:

• true: if friends list was found and the friend was valid
• false: otherwise

ReadFriendsList()

virtual bool ReadFriendsList ( int32  LocalUserNum, const FString &  ListName, const FOnReadFriendsListComplete &  Delegate = FOnReadFriendsListComplete()  )

overridevirtual

Starts an async task that reads the named friends list for the player.

Parameters

LocalUserNum	The controller number of the user to read the friends list of.
ListName	The name of the friends list to read.

Returns

Bool:

• true: success
• false: falure