Basic wrapper for interfacing with a Specific Services Game API's. This is the generic version. More...

Inheritance diagram for VerticesEngine.Profile.vxPlayerProfileGenericWrapper:

Public Member Functions
void	SignIn ()
	Signs the user in.

void	SignOut ()
	Signs the user out.

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

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

vxAchievement	GetAchievement (object key)
	Gets the achievement.

Dictionary< object, vxAchievement >	GetAchievements ()

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

void	UnlockAchievement (object key)
	Unlocks the achievement.

void	ViewAchievments ()
	View achievements for this platform.

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

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

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	ViewAllLeaderboards ()
	Views all leaderboards for this platform.

void	Update ()
	Runs callbacks for platform wrapper.

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.

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

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.

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	GetPlayerIconFromPlatform (string id, Action< bool, Texture2D > callback)
	Returns the player icon for the current platform using the specified id.

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.

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

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

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

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.

bool	IsPublishing `[get, set]`

float	PublishProgress `[get, set]`

Properties inherited from VerticesEngine.Profile.vxIPlayerProfile

Events
EventHandler	OnSignedIn
	This event is fired when a user successfully signs in.

EventHandler	OnSignInFailed
	This event is fired when the Sign in fails for any reason.

Detailed Description

Basic wrapper for interfacing with a Specific Services Game API's. This is the generic version.

Member Function Documentation

◆ AddAchievement()

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

Adds the achievement.

Implements VerticesEngine.Profile.vxIPlayerProfile.

◆ ClearStatus()

void VerticesEngine.Profile.vxPlayerProfileGenericWrapper.ClearStatus ( )

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

Implements VerticesEngine.Profile.vxIPlayerProfile.

◆ Dispose()

void VerticesEngine.Profile.vxPlayerProfileGenericWrapper.Dispose ( )

Shutdown and close any connections.

Implements VerticesEngine.Profile.vxIPlayerProfile.

◆ GetAchievement()

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

Gets the achievement.

Returns: The achievement.

Parameters

key Key.

Implements VerticesEngine.Profile.vxIPlayerProfile.

◆ GetAuthTicket()

string VerticesEngine.Profile.vxPlayerProfileGenericWrapper.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

Implements VerticesEngine.Profile.vxIPlayerProfile.

◆ GetInstalledMods()

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

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

Returns

Implements VerticesEngine.Profile.vxIPlayerProfile.

◆ GetPlayerIconFromPlatform()

void VerticesEngine.Profile.vxPlayerProfileGenericWrapper.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

Implements VerticesEngine.Profile.vxIPlayerProfile.

◆ IncrementAchievement()

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

Increments the achievement.

Parameters

key
increment

Implements VerticesEngine.Profile.vxIPlayerProfile.

◆ Initialise()

void VerticesEngine.Profile.vxPlayerProfileGenericWrapper.Initialise ( )

This Initialises the main info.

Implements VerticesEngine.Profile.vxIPlayerProfile.

◆ InitialisePlayerInfo()

void VerticesEngine.Profile.vxPlayerProfileGenericWrapper.InitialisePlayerInfo ( )

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

Implements VerticesEngine.Profile.vxIPlayerProfile.

◆ OpenStorePage()

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

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

Parameters

url

Implements VerticesEngine.Profile.vxIPlayerProfile.

◆ OpenURL()

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

Opens a URL using the specified platform.

Parameters

url

Implements VerticesEngine.Profile.vxIPlayerProfile.

◆ SetStat() [1/2]

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

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

Parameters

key

Implements VerticesEngine.Profile.vxIPlayerProfile.

◆ SetStat() [2/2]

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

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

Parameters

key
value

Implements VerticesEngine.Profile.vxIPlayerProfile.

◆ SetStatus()

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

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

Parameters

status

Implements VerticesEngine.Profile.vxIPlayerProfile.

◆ SetStatusKey()

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

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

Parameters

key
value

Implements VerticesEngine.Profile.vxIPlayerProfile.

◆ ShareImage()

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

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

Parameters

path
extratxt

Implements VerticesEngine.Profile.vxIPlayerProfile.

◆ SignIn()

void VerticesEngine.Profile.vxPlayerProfileGenericWrapper.SignIn ( )

Signs the user in.

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

Implements VerticesEngine.Profile.vxIPlayerProfile.

◆ SignOut()

void VerticesEngine.Profile.vxPlayerProfileGenericWrapper.SignOut ( )

Signs the user out.

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

Implements VerticesEngine.Profile.vxIPlayerProfile.

◆ SubmitLeaderboardScore()

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

Submits a leaderboard score for this platform.

Parameters

id
score

Implements VerticesEngine.Profile.vxIPlayerProfile.

◆ UnlockAchievement()

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

Unlocks the achievement.

Parameters

key Key.

Implements VerticesEngine.Profile.vxIPlayerProfile.

◆ Update()

void VerticesEngine.Profile.vxPlayerProfileGenericWrapper.Update ( )

Runs callbacks for platform wrapper.

Implements VerticesEngine.Profile.vxIPlayerProfile.

◆ ViewAchievments()

void VerticesEngine.Profile.vxPlayerProfileGenericWrapper.ViewAchievments ( )

View achievements for this platform.

Implements VerticesEngine.Profile.vxIPlayerProfile.

◆ ViewAllLeaderboards()

void VerticesEngine.Profile.vxPlayerProfileGenericWrapper.ViewAllLeaderboards ( )

Views all leaderboards for this platform.

Implements VerticesEngine.Profile.vxIPlayerProfile.

◆ ViewLeaderboard()

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

View the leaderboard for this platform.

Parameters

id

Implements VerticesEngine.Profile.vxIPlayerProfile.

Property Documentation

◆ Achievements

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

get

Retusn the acehivement look up dictionary.

Implements VerticesEngine.Profile.vxIPlayerProfile.

◆ Avatar

Texture2D VerticesEngine.Profile.vxPlayerProfileGenericWrapper.Avatar

get

Gets the profile picture.

The profile picture.

Implements VerticesEngine.Profile.vxIPlayerProfile.

◆ Id

string VerticesEngine.Profile.vxPlayerProfileGenericWrapper.Id

get

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

The user identifier.

Implements VerticesEngine.Profile.vxIPlayerProfile.

◆ IsSignedIn

bool VerticesEngine.Profile.vxPlayerProfileGenericWrapper.IsSignedIn

get

Is the user signed in.

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

Implements VerticesEngine.Profile.vxIPlayerProfile.

◆ Name

string VerticesEngine.Profile.vxPlayerProfileGenericWrapper.Name

get

Gets the name of the signed in user.

The name of the user.

Implements VerticesEngine.Profile.vxIPlayerProfile.

◆ PlatformType

vxPlatformType VerticesEngine.Profile.vxPlayerProfileGenericWrapper.PlatformType

get

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

Implements VerticesEngine.Profile.vxIPlayerProfile.

◆ PreferredLanguage

string VerticesEngine.Profile.vxPlayerProfileGenericWrapper.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.

Implements VerticesEngine.Profile.vxIPlayerProfile.

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

/github/workspace/src/VerticesEngine/src.shared/Platform/vxPlayerProfile.Generic.cs

Public Member Functions

Properties

Events

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