Platform specific wrapper for handling player profile. This is used for providing which player is currently playing through steam. More...

Inheritance diagram for VerticesEngine.Profile.vxIPlayerProfile:

Public Member Functions
void	Initialise ()
	This Initialises the main info.

void	InitialisePlayerInfo ()
	This initialises the player info like icons. This is called later on as the graphics device must be active.

void	Dispose ()
	Shutdown and close any connections.

void	SignIn ()
	Signs the user in.

void	SignOut ()
	Signs the user out.

string	GetAuthTicket ()
	Returns an auth ticket for this platform as a string. This allows developers to get an auth ticket or token which they can then pass on to a backend server to authenticate that the user is who they say they are.

void	GetPlayerIconFromPlatform (string id, Action< bool, Texture2D > callback)
	Returns the player icon for the current platform using the specified id.

void	Update ()
	Runs callbacks for platform wrapper.

void	ShareImage (string path, string extratxt="")
	Shares an image. This is only supported on Mobile currently.

void	OpenURL (string url)
	Opens a URL using the specified platform.

void	OpenStorePage (string url)
	Opens the store page for this game given the app id info in the Config.

void	SetStatus (string status)
	Sets the status for this user. This is useful for Discord and Steam Rich Presence.

void	SetStatusKey (string key, string value)
	Sets the status for this user. This is useful for Discord and Steam Rich Presence.

void	ClearStatus ()
	Clears the status for this user. This is useful for Discord and Steam Rich Presence.

vxAchievement	GetAchievement (object key)
	Gets the achievement.

void	AddAchievement (object key, vxAchievement achievement)
	Adds the achievement.

void	ViewAchievments ()
	View achievements for this platform.

void	UnlockAchievement (object key)
	Unlocks the achievement.

void	IncrementAchievement (object key, int increment)
	Increments the achievement.

void	SetStat (string key)
	Sets a stat value. This will incrememne the current value.

void	SetStat (string key, int value)
	Sets a stat value. This will explicitly set a value.

void	SubmitLeaderboardScore (string id, long score)
	Submits a leaderboard score for this platform.

void	ViewLeaderboard (string id)
	View the leaderboard for this platform.

void	ViewAllLeaderboards ()
	Views all leaderboards for this platform.

string[]	GetInstalledMods ()
	Gets all of the currently installed mods. Note this does not mean they are enabled.

Properties
bool	IsSignedIn `[get]`
	Is the user signed in.

string	Id `[get]`
	Gets the user identifier. This identifier is handed out by the virtex server.

string	Name `[get]`
	Gets the name of the signed in user.

vxPlatformType	PlatformType `[get]`
	Gets the Player Profile Backend, whether it's Steam, Google Play Services, etc...

Texture2D	Avatar `[get]`
	Gets the profile picture.

string	PreferredLanguage `[get]`
	This method will scrub all names and profile text info for any characters which aren't available in the spritefonts which have been loaded.

Dictionary< object, vxAchievement >	Achievements `[get]`
	Retusn the acehivement look up dictionary.

Detailed Description

Platform specific wrapper for handling player profile. This is used for providing which player is currently playing through steam.

Member Function Documentation

◆ AddAchievement()

void VerticesEngine.Profile.vxIPlayerProfile.AddAchievement	(	object	key,
		vxAchievement	achievement )

Adds the achievement.

Implemented in VerticesEngine.Profile.vxPlayerProfileGenericWrapper, VerticesEngine.Profile.vxPlayerProfileItchIoWrapper, and VerticesEngine.Profile.vxPlayerProfileSteamWrapper.

◆ ClearStatus()

void VerticesEngine.Profile.vxIPlayerProfile.ClearStatus ( )

Clears the status for this user. This is useful for Discord and Steam Rich Presence.

Implemented in VerticesEngine.Profile.vxPlayerProfileGenericWrapper, VerticesEngine.Profile.vxPlayerProfileItchIoWrapper, and VerticesEngine.Profile.vxPlayerProfileSteamWrapper.

◆ Dispose()

void VerticesEngine.Profile.vxIPlayerProfile.Dispose ( )

Shutdown and close any connections.

Implemented in VerticesEngine.Profile.vxPlayerProfileGenericWrapper, VerticesEngine.Profile.vxPlayerProfileItchIoWrapper, and VerticesEngine.Profile.vxPlayerProfileSteamWrapper.

◆ GetAchievement()

vxAchievement VerticesEngine.Profile.vxIPlayerProfile.GetAchievement ( object key )

Gets the achievement.

Returns: The achievement.

Parameters

key Key.

Implemented in VerticesEngine.Profile.vxPlayerProfileGenericWrapper, VerticesEngine.Profile.vxPlayerProfileItchIoWrapper, and VerticesEngine.Profile.vxPlayerProfileSteamWrapper.

◆ GetAuthTicket()

string VerticesEngine.Profile.vxIPlayerProfile.GetAuthTicket ( )

Returns an auth ticket for this platform as a string. This allows developers to get an auth ticket or token which they can then pass on to a backend server to authenticate that the user is who they say they are.

Returns

Implemented in VerticesEngine.Profile.vxPlayerProfileGenericWrapper, VerticesEngine.Profile.vxPlayerProfileItchIoWrapper, and VerticesEngine.Profile.vxPlayerProfileSteamWrapper.

◆ GetInstalledMods()

string[] VerticesEngine.Profile.vxIPlayerProfile.GetInstalledMods ( )

Gets all of the currently installed mods. Note this does not mean they are enabled.

Returns

Implemented in VerticesEngine.Profile.vxPlayerProfileGenericWrapper, VerticesEngine.Profile.vxPlayerProfileItchIoWrapper, and VerticesEngine.Profile.vxPlayerProfileSteamWrapper.

◆ GetPlayerIconFromPlatform()

void VerticesEngine.Profile.vxIPlayerProfile.GetPlayerIconFromPlatform	(	string	id,
		Action< bool, Texture2D >	callback )

Returns the player icon for the current platform using the specified id.

Parameters

id	The player profile icon
callback	The callback which says whether it was successful and with the texture2D

Implemented in VerticesEngine.Profile.vxPlayerProfileGenericWrapper, VerticesEngine.Profile.vxPlayerProfileItchIoWrapper, and VerticesEngine.Profile.vxPlayerProfileSteamWrapper.

◆ IncrementAchievement()

void VerticesEngine.Profile.vxIPlayerProfile.IncrementAchievement	(	object	key,
		int	increment )

Increments the achievement.

Parameters

key
increment

Implemented in VerticesEngine.Profile.vxPlayerProfileGenericWrapper, VerticesEngine.Profile.vxPlayerProfileItchIoWrapper, and VerticesEngine.Profile.vxPlayerProfileSteamWrapper.

◆ Initialise()

void VerticesEngine.Profile.vxIPlayerProfile.Initialise ( )

This Initialises the main info.

Implemented in VerticesEngine.Profile.vxPlayerProfileGenericWrapper, VerticesEngine.Profile.vxPlayerProfileItchIoWrapper, and VerticesEngine.Profile.vxPlayerProfileSteamWrapper.

◆ InitialisePlayerInfo()

void VerticesEngine.Profile.vxIPlayerProfile.InitialisePlayerInfo ( )

This initialises the player info like icons. This is called later on as the graphics device must be active.

Implemented in VerticesEngine.Profile.vxPlayerProfileGenericWrapper, VerticesEngine.Profile.vxPlayerProfileItchIoWrapper, and VerticesEngine.Profile.vxPlayerProfileSteamWrapper.

◆ OpenStorePage()

void VerticesEngine.Profile.vxIPlayerProfile.OpenStorePage ( string url )

Opens the store page for this game given the app id info in the Config.

Parameters

url

Implemented in VerticesEngine.Profile.vxPlayerProfileGenericWrapper, VerticesEngine.Profile.vxPlayerProfileItchIoWrapper, and VerticesEngine.Profile.vxPlayerProfileSteamWrapper.

◆ OpenURL()

void VerticesEngine.Profile.vxIPlayerProfile.OpenURL ( string url )

Opens a URL using the specified platform.

Parameters

url

Implemented in VerticesEngine.Profile.vxPlayerProfileGenericWrapper, VerticesEngine.Profile.vxPlayerProfileItchIoWrapper, and VerticesEngine.Profile.vxPlayerProfileSteamWrapper.

◆ SetStat() [1/2]

void VerticesEngine.Profile.vxIPlayerProfile.SetStat ( string key )

Sets a stat value. This will incrememne the current value.

Parameters

key

Implemented in VerticesEngine.Profile.vxPlayerProfileGenericWrapper, VerticesEngine.Profile.vxPlayerProfileItchIoWrapper, and VerticesEngine.Profile.vxPlayerProfileSteamWrapper.

◆ SetStat() [2/2]

void VerticesEngine.Profile.vxIPlayerProfile.SetStat	(	string	key,
		int	value )

Sets a stat value. This will explicitly set a value.

Parameters

key
value

Implemented in VerticesEngine.Profile.vxPlayerProfileGenericWrapper, VerticesEngine.Profile.vxPlayerProfileItchIoWrapper, and VerticesEngine.Profile.vxPlayerProfileSteamWrapper.

◆ SetStatus()

void VerticesEngine.Profile.vxIPlayerProfile.SetStatus ( string status )

Sets the status for this user. This is useful for Discord and Steam Rich Presence.

Parameters

status

Implemented in VerticesEngine.Profile.vxPlayerProfileGenericWrapper, VerticesEngine.Profile.vxPlayerProfileItchIoWrapper, and VerticesEngine.Profile.vxPlayerProfileSteamWrapper.

◆ SetStatusKey()

void VerticesEngine.Profile.vxIPlayerProfile.SetStatusKey	(	string	key,
		string	value )

Sets the status for this user. This is useful for Discord and Steam Rich Presence.

Parameters

key
value

Implemented in VerticesEngine.Profile.vxPlayerProfileGenericWrapper, VerticesEngine.Profile.vxPlayerProfileItchIoWrapper, and VerticesEngine.Profile.vxPlayerProfileSteamWrapper.

◆ ShareImage()

void VerticesEngine.Profile.vxIPlayerProfile.ShareImage	(	string	path,
		string	extratxt = "" )

Shares an image. This is only supported on Mobile currently.

Parameters

path
extratxt

Implemented in VerticesEngine.Profile.vxPlayerProfileGenericWrapper, VerticesEngine.Profile.vxPlayerProfileItchIoWrapper, and VerticesEngine.Profile.vxPlayerProfileSteamWrapper.

◆ SignIn()

void VerticesEngine.Profile.vxIPlayerProfile.SignIn ( )

Signs the user in.

Returns: true, if in was signed, false otherwise.

Implemented in VerticesEngine.Profile.vxPlayerProfileGenericWrapper, VerticesEngine.Profile.vxPlayerProfileItchIoWrapper, and VerticesEngine.Profile.vxPlayerProfileSteamWrapper.

◆ SignOut()

void VerticesEngine.Profile.vxIPlayerProfile.SignOut ( )

Signs the user out.

Returns: true, if out was signed, false otherwise.

Implemented in VerticesEngine.Profile.vxPlayerProfileGenericWrapper, VerticesEngine.Profile.vxPlayerProfileItchIoWrapper, and VerticesEngine.Profile.vxPlayerProfileSteamWrapper.

◆ SubmitLeaderboardScore()

void VerticesEngine.Profile.vxIPlayerProfile.SubmitLeaderboardScore	(	string	id,
		long	score )

Submits a leaderboard score for this platform.

Parameters

id
score

Implemented in VerticesEngine.Profile.vxPlayerProfileGenericWrapper, VerticesEngine.Profile.vxPlayerProfileItchIoWrapper, and VerticesEngine.Profile.vxPlayerProfileSteamWrapper.

◆ UnlockAchievement()

void VerticesEngine.Profile.vxIPlayerProfile.UnlockAchievement ( object key )

Unlocks the achievement.

Parameters

key Key.

Implemented in VerticesEngine.Profile.vxPlayerProfileGenericWrapper, VerticesEngine.Profile.vxPlayerProfileItchIoWrapper, and VerticesEngine.Profile.vxPlayerProfileSteamWrapper.

◆ Update()

void VerticesEngine.Profile.vxIPlayerProfile.Update ( )

Runs callbacks for platform wrapper.

Implemented in VerticesEngine.Profile.vxPlayerProfileGenericWrapper, VerticesEngine.Profile.vxPlayerProfileItchIoWrapper, and VerticesEngine.Profile.vxPlayerProfileSteamWrapper.

◆ ViewAchievments()

void VerticesEngine.Profile.vxIPlayerProfile.ViewAchievments ( )

View achievements for this platform.

Implemented in VerticesEngine.Profile.vxPlayerProfileGenericWrapper, VerticesEngine.Profile.vxPlayerProfileItchIoWrapper, and VerticesEngine.Profile.vxPlayerProfileSteamWrapper.

◆ ViewAllLeaderboards()

void VerticesEngine.Profile.vxIPlayerProfile.ViewAllLeaderboards ( )

Views all leaderboards for this platform.

Implemented in VerticesEngine.Profile.vxPlayerProfileGenericWrapper, VerticesEngine.Profile.vxPlayerProfileItchIoWrapper, and VerticesEngine.Profile.vxPlayerProfileSteamWrapper.

◆ ViewLeaderboard()

void VerticesEngine.Profile.vxIPlayerProfile.ViewLeaderboard ( string id )

View the leaderboard for this platform.

Parameters

id

Implemented in VerticesEngine.Profile.vxPlayerProfileGenericWrapper, VerticesEngine.Profile.vxPlayerProfileItchIoWrapper, and VerticesEngine.Profile.vxPlayerProfileSteamWrapper.

Property Documentation

◆ Achievements

Dictionary<object, vxAchievement> VerticesEngine.Profile.vxIPlayerProfile.Achievements

get

Retusn the acehivement look up dictionary.

Implemented in VerticesEngine.Profile.vxPlayerProfileGenericWrapper, VerticesEngine.Profile.vxPlayerProfileItchIoWrapper, and VerticesEngine.Profile.vxPlayerProfileSteamWrapper.

◆ Avatar

Texture2D VerticesEngine.Profile.vxIPlayerProfile.Avatar

get

Gets the profile picture.

The profile picture.

Implemented in VerticesEngine.Profile.vxPlayerProfileGenericWrapper, VerticesEngine.Profile.vxPlayerProfileItchIoWrapper, and VerticesEngine.Profile.vxPlayerProfileSteamWrapper.

◆ Id

string VerticesEngine.Profile.vxIPlayerProfile.Id

get

Gets the user identifier. This identifier is handed out by the virtex server.

The user identifier.

Implemented in VerticesEngine.Profile.vxPlayerProfileGenericWrapper, VerticesEngine.Profile.vxPlayerProfileItchIoWrapper, and VerticesEngine.Profile.vxPlayerProfileSteamWrapper.

◆ IsSignedIn

bool VerticesEngine.Profile.vxIPlayerProfile.IsSignedIn

get

Is the user signed in.

Returns: true, if signed in was ised, false otherwise.

Implemented in VerticesEngine.Profile.vxPlayerProfileGenericWrapper, VerticesEngine.Profile.vxPlayerProfileItchIoWrapper, and VerticesEngine.Profile.vxPlayerProfileSteamWrapper.

◆ Name

string VerticesEngine.Profile.vxIPlayerProfile.Name

get

Gets the name of the signed in user.

The name of the user.

Implemented in VerticesEngine.Profile.vxPlayerProfileGenericWrapper, VerticesEngine.Profile.vxPlayerProfileItchIoWrapper, and VerticesEngine.Profile.vxPlayerProfileSteamWrapper.

◆ PlatformType

vxPlatformType VerticesEngine.Profile.vxIPlayerProfile.PlatformType

get

Gets the Player Profile Backend, whether it's Steam, Google Play Services, etc...

Implemented in VerticesEngine.Profile.vxPlayerProfileGenericWrapper, VerticesEngine.Profile.vxPlayerProfileItchIoWrapper, and VerticesEngine.Profile.vxPlayerProfileSteamWrapper.

◆ PreferredLanguage

string VerticesEngine.Profile.vxIPlayerProfile.PreferredLanguage

get

This method will scrub all names and profile text info for any characters which aren't available in the spritefonts which have been loaded.

Implemented in VerticesEngine.Profile.vxPlayerProfileGenericWrapper, VerticesEngine.Profile.vxPlayerProfileItchIoWrapper, and VerticesEngine.Profile.vxPlayerProfileSteamWrapper.

The documentation for this interface was generated from the following file:

/github/workspace/src/VerticesEngine/src.shared/Platform/vxIPlayerProfileInterface.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ AddAchievement()

◆ ClearStatus()

◆ Dispose()

◆ GetAchievement()

◆ GetAuthTicket()

◆ GetInstalledMods()

◆ GetPlayerIconFromPlatform()

◆ IncrementAchievement()

◆ Initialise()

◆ InitialisePlayerInfo()

◆ OpenStorePage()

◆ OpenURL()

◆ SetStat() [1/2]

◆ SetStat() [2/2]

◆ SetStatus()

◆ SetStatusKey()

◆ ShareImage()

◆ SignIn()

◆ SignOut()

◆ SubmitLeaderboardScore()

◆ UnlockAchievement()

◆ Update()

◆ ViewAchievments()

◆ ViewAllLeaderboards()

◆ ViewLeaderboard()

Property Documentation

◆ Achievements

◆ Avatar

◆ Id

◆ IsSignedIn

◆ Name

◆ PlatformType

◆ PreferredLanguage