PICO Unreal Platform SDK
Public Member Functions | List of all members
FOnlineIdentityPico Class Reference
Function » Identity(OnlineSub)

OnlineIdentityPico class inherited from IOnlineIdentity(Unreal Engine) More...

#include <OnlineIdentityPico.h>

Public Member Functions

virtual bool Login (int32 LocalUserNum, const FOnlineAccountCredentials &AccountCredentials) override
 Gets the account login information for a user. More...
 
virtual bool Logout (int32 LocalUserNum) override
 Clears the account login information for a user. More...
 
virtual bool AutoLogin (int32 LocalUserNum) override
 Logs a user in to the online service. More...
 
virtual TSharedPtr< FUserOnlineAccount > GetUserAccount (const FUniqueNetId &UserId) const override
 Gets the account information of a registered user. More...
 
virtual TArray< TSharedPtr< FUserOnlineAccount > > GetAllUserAccounts () const override
 Gets the account information of all known/registered users. More...
 
virtual TSharedPtr< const FUniqueNetId > GetUniquePlayerId (int32 LocalUserNum) const override
 Gets the platform-specific unique ID for a user. More...
 
virtual TSharedPtr< const FUniqueNetId > CreateUniquePlayerId (uint8 *Bytes, int32 Size) override
 Creates a unique ID from binary data (used during replication). More...
 
virtual TSharedPtr< const FUniqueNetId > CreateUniquePlayerId (const FString &Str) override
 Creates a unique ID from string. More...
 
virtual ELoginStatus::Type GetLoginStatus (int32 LocalUserNum) const override
 Gets a user's login status by controller number. More...
 
virtual ELoginStatus::Type GetLoginStatus (const FUniqueNetId &UserId) const override
 Gets a user's login status by unique net ID. More...
 
virtual FString GetPlayerNickname (int32 LocalUserNum) const override
 Gets a users's nickname from the online service by controller number. More...
 
virtual FString GetPlayerNickname (const FUniqueNetId &UserId) const override
 Gets a user's nickname from the online service by unique net ID. More...
 
virtual FString GetAuthType () const override
 Gets the auth type associated with accounts for this platform. More...
 

Detailed Description

OnlineIdentityPico class inherited from IOnlineIdentity(Unreal Engine)

Member Function Documentation

◆ AutoLogin()

virtual bool AutoLogin ( int32  LocalUserNum)
overridevirtual

Logs a user in to the online service.

Parameters
LocalUserNumThe controller number of the associated user.
Returns
Bool:
  • true: success
  • false: failure

◆ CreateUniquePlayerId() [1/2]

virtual TSharedPtr< const FUniqueNetId > CreateUniquePlayerId ( const FString &  Str)
overridevirtual

Creates a unique ID from string.

Parameters
StrThe string that holds the textual representation of an ID.
Returns
The unique ID from the given data, NULL otherwise.

◆ CreateUniquePlayerId() [2/2]

virtual TSharedPtr< const FUniqueNetId > CreateUniquePlayerId ( uint8 *  Bytes,
int32  Size 
)
overridevirtual

Creates a unique ID from binary data (used during replication).

Parameters
BytesThe opaque data from the appropriate platform.
SizeThe size of opaque data.
Returns
The unique ID from the given data, NULL otherwise.

◆ GetAllUserAccounts()

virtual TArray< TSharedPtr< FUserOnlineAccount > > GetAllUserAccounts ( ) const
overridevirtual

Gets the account information of all known/registered users.

Returns
The account information of all known/registered users if found, NULL otherwise.
  • NULL: otherwise

◆ GetAuthType()

virtual FString GetAuthType ( ) const
overridevirtual

Gets the auth type associated with accounts for this platform.

Returns
The auth type associated with accounts for this platform.

◆ GetLoginStatus() [1/2]

virtual ELoginStatus::Type GetLoginStatus ( const FUniqueNetId &  UserId) const
overridevirtual

Gets a user's login status by unique net ID.

Parameters
UserIdThe unique net ID of the associated user.
Returns
The enum value of the user's login status.

◆ GetLoginStatus() [2/2]

virtual ELoginStatus::Type GetLoginStatus ( int32  LocalUserNum) const
overridevirtual

Gets a user's login status by controller number.

Parameters
LocalUserNumThe controller number of the associated user.
Returns
The enum value of that user's login status.

◆ GetPlayerNickname() [1/2]

virtual FString GetPlayerNickname ( const FUniqueNetId &  UserId) const
overridevirtual

Gets a user's nickname from the online service by unique net ID.

Parameters
UserIdThe unique net ID of the associated user.
Returns
A string containing the user's nickname.

◆ GetPlayerNickname() [2/2]

virtual FString GetPlayerNickname ( int32  LocalUserNum) const
overridevirtual

Gets a users's nickname from the online service by controller number.

Parameters
LocalUserNumThe controller number of the associated user.
Returns
A string containing the user's nickname.

◆ GetUniquePlayerId()

virtual TSharedPtr< const FUniqueNetId > GetUniquePlayerId ( int32  LocalUserNum) const
overridevirtual

Gets the platform-specific unique ID for a user.

Parameters
LocalUserNumThe controller number of the associated user.
Returns
The valid user ID object if the call succeeds, NULL otherwise.

◆ GetUserAccount()

virtual TSharedPtr< FUserOnlineAccount > GetUserAccount ( const FUniqueNetId &  UserId) const
overridevirtual

Gets the account information of a registered user.

Parameters
UserIdThe ID of the user to search for.
Returns
The user's account information if found, NULL otherwise.

◆ Login()

virtual bool Login ( int32  LocalUserNum,
const FOnlineAccountCredentials &  AccountCredentials 
)
overridevirtual

Gets the account login information for a user.

Note
Will call the OnLoginComplete() delegate when the async task is complete.
Parameters
LocalUserNumThe controller number of the associated user.
AccountCredentialsShould pass null.
Returns
Bool:
  • true: the account login information has been found
  • false: otherwise

◆ Logout()

virtual bool Logout ( int32  LocalUserNum)
overridevirtual

Clears the account login information for a user.

Note
Will call the OnLogoutComplete() delegate when the async task is complete.
Parameters
LocalUserNumThe controller number of the associated user.
Returns
Bool:
  • true: the account login information has been cleared
  • false: otherwise