Provides a cross-platform interface to access information about a player playing your game.

Inheritance diagram for IPlayer:

Public Member Functions
void	LoadImage (EventCallback< TextureData > callback)
	Loads the player profile image.

Properties
string	Id `[get]`
	A string assigned by game service to uniquely identify a player. (read-only)

string	DeveloperScopeId `[get]`
	A unique identifier for a player of all the games that you distribute using your developer account.

string	LegacyId `[get]`
	Legacy identifier for backward compatibility. Use Id or DeveloperScopeId instead.

string	Alias `[get]`
	A string chosen by the player to identify themselves to others. (read-only)

string	DisplayName `[get]`
	A string to display for the player. (read-only)

Member Function Documentation

◆ LoadImage()

void LoadImage ( EventCallback< TextureData > callback )

Parameters

callback Callback that will be called after operation is completed.

Property Documentation

◆ DeveloperScopeId

string DeveloperScopeId

get

This property is used to identify a player across all the games that you develop and distribute with the same developer account.

Note: This is currently available for iOS only.

◆ LegacyId

string LegacyId

get

This property is used for legacy purposes and should not be used in new code. Please use Id or DeveloperScopeId instead.

◆ Alias

string Alias

get

This property is used when a player is not a friend of the local player. For displaying name on user interface, use the DisplayName property.

◆ DisplayName

string DisplayName

get

If the player is a friend of the local player, then the value returned is the actual name of the player. And incase if he is not a friend, then players alias will be returned.

Public Member Functions