Interface IOnlinePlatform

Interface for online platform providers for communicating with various multiplayer services such as player info, achievements, game lobby or in-game store.

Namespace: FlaxEngine.Online
Assembly: FlaxEngine.CSharp.dll
Syntax
[Unmanaged]
public interface IOnlinePlatform

Methods

Deinitialize()

Shutdowns the online platform services.

Declaration
[Unmanaged]
void Deinitialize()
Remarks

Called only by Online system. Can be used to destroy the object.

GetAchievements(out OnlineAchievement[], User)

Gets the list of all achievements for this game.

Declaration
[Unmanaged]
bool GetAchievements(out OnlineAchievement[] achievements, User localUser = null)
Parameters
OnlineAchievement[] achievements

The result achievements list
User localUser

The local user (null if use default one).
Returns
System.Boolean

True if failed, otherwise false.

GetFriends(out OnlineUser[], User)

Gets the list of friends of the user from the online platform.

Declaration
[Unmanaged]
bool GetFriends(out OnlineUser[] friends, User localUser = null)
Parameters
OnlineUser[] friends

The result local player friends user infos.
User localUser

The local user (null if use default one).
Returns
System.Boolean

True if failed, otherwise false.

GetSaveGame(String, out Byte[], User)

Gets the online savegame data. Returns empty if savegame slot is unused.

Declaration
[Unmanaged]
bool GetSaveGame(string name, out byte[] data, User localUser = null)
Parameters
System.String name

The savegame slot name.
System.Byte[] data

The result data. Empty or null for unused slot name.
User localUser

The local user (null if use default one).
Returns
System.Boolean

True if failed, otherwise false.

GetStat(String, out Single, User)

Gets the online statistical value.

Declaration
[Unmanaged]
bool GetStat(string name, out float value, User localUser = null)
Parameters
System.String name

The stat name.
System.Single value

The result value.
User localUser

The local user (null if use default one).
Returns
System.Boolean

True if failed, otherwise false.

GetUser(out OnlineUser, User)

Gets the player from the online platform.

Declaration
[Unmanaged]
bool GetUser(out OnlineUser user, User localUser = null)
Parameters
OnlineUser user

The local player user info.
User localUser

The local user (null if use default one).
Returns
System.Boolean

True if failed, otherwise false.

GetUserLoggedIn(User)

Checks if the local user is logged in.

Declaration
[Unmanaged]
bool GetUserLoggedIn(User localUser = null)
Parameters
User localUser

The local user (null if use default one).
Returns
System.Boolean

True if user is logged, otherwise false.

Initialize()

Initializes the online platform services.

Declaration
[Unmanaged]
bool Initialize()
Returns
System.Boolean

True if failed, otherwise false.
Remarks

Called only by Online system.

ResetAchievements(User)

Resets the all achievements progress for this game.

Declaration
[Unmanaged]
bool ResetAchievements(User localUser = null)
Parameters
User localUser

The local user (null if use default one).
Returns
System.Boolean

True if failed, otherwise false.

SetSaveGame(String, Byte[], User)

Sets the online savegame data.

Declaration
[Unmanaged]
bool SetSaveGame(string name, byte[] data, User localUser = null)
Parameters
System.String name

The savegame slot name.
System.Byte[] data

The data. Empty or null to delete slot (or mark as unused).
User localUser

The local user (null if use default one).
Returns
System.Boolean

True if failed, otherwise false.

SetStat(String, Single, User)

Sets the online statistical value.

Declaration
[Unmanaged]
bool SetStat(string name, float value, User localUser = null)
Parameters
System.String name

The stat name.
System.Single value

The value.
User localUser

The local user (null if use default one).
Returns
System.Boolean

True if failed, otherwise false.

UnlockAchievement(String, User)

Unlocks the achievement.

Declaration
[Unmanaged]
bool UnlockAchievement(string name, User localUser = null)
Parameters
System.String name

The achievement name. Specific for a game.
User localUser

The local user (null if use default one).
Returns
System.Boolean

True if failed, otherwise false.

UnlockAchievementProgress(String, Single, User)

Updates the achievement unlocking progress (in range 0-100).

Declaration
[Unmanaged]
bool UnlockAchievementProgress(string name, float progress, User localUser = null)
Parameters
System.String name

The achievement name. Specific for a game.
System.Single progress

The achievement unlock progress (in range 0-100).
User localUser

The local user (null if use default one).
Returns
System.Boolean

True if failed, otherwise false.

UserLogin(User)

Logins the local user into the online platform.

Declaration
[Unmanaged]
bool UserLogin(User localUser = null)
Parameters
User localUser

The local user (null if use default one).
Returns
System.Boolean

True if failed, otherwise false.

UserLogout(User)

Logout the local user from the online platform.

Declaration
[Unmanaged]
bool UserLogout(User localUser = null)
Parameters
User localUser

The local user (null if use default one).
Returns
System.Boolean

True if failed, otherwise false.

Extension Methods