PlatformService

This is a simple generic wrapper for exposing various platform services that can be injected by the main game executable e.g. Xbox Live, Steam. This mechanism assumes we are using an SUA (single user application), so the user is not based on a given gamepad.

Properties

Configured

bool Configured

Whether or not a platform service is configured or not. If false then don't use any of these properties or methods.

GamerTag

string GamerTag

GamerTag for the signed in user e.g. "Clarvalon".

IsSignedIn

bool IsSignedIn

Whether or not a user is currently signed in to the given platform.

IsSigningIn

bool IsSigningIn

Whether or not we are currently attempting to sign in to the given platform.

ServiceName

string ServiceName

Service Name e.g. "Xbox Live", "Steam".

UserId

string UserId

Internal platform ID for the signed in user e.g. "12345".

Methods

SignInAsync

void SignInAsync()

Signs user into our platform asynchronously.