ZOA Platform

IPlatformProvider

interface

The whole store integration behind one object. Thirteen service properties, an availability and capability declaration, a lifecycle state, and Initialize, Shutdown, and Tick.

• string ProviderId { get; } / string DisplayName { get; }
• PlatformCapability Capabilities { get; }
• PlatformProviderAvailability Availability { get; }
• PlatformProviderState State { get; }
• IPlatformAuthService Auth / IPlatformProfileService Profiles / IPlatformAchievementService Achievements
• IPlatformLeaderboardService Leaderboards / IPlatformStatsService Stats / IPlatformFriendsService Friends
• IPlatformInventoryService Inventory / IPlatformCloudSaveService CloudSave / IPlatformWorkshopService Workshop
• IPlatformAppsService Apps / IPlatformOverlayService Overlay / IPlatformLobbyService Lobbies / IPlatformEventService Events
• event Action<PlatformProviderState> StateChanged
• Task<PlatformResult> InitializeAsync(CancellationToken cancellationToken = default)
• Task<PlatformResult> ShutdownAsync(CancellationToken cancellationToken = default)
• void Tick()

PlatformServices

service

The static facade game code calls. Forwards every service and lifecycle call to the active provider, and answers capability questions without a null check ever being necessary.

• static IPlatformProvider ActiveProvider { get; }
• static bool IsRealProviderActive { get; }
• static bool Supports(PlatformCapability capability)
• static void Register(IPlatformProvider provider)
• static void SetActive(string providerId) / static bool TrySetActive(string providerId)
• static bool TryResolve(string providerId, out IPlatformProvider provider)
• static IReadOnlyList<IPlatformProvider> RegisteredProviders()
• static Task<PlatformResult> InitializeActiveAsync(CancellationToken cancellationToken = default)
• static void Tick()

PlatformProviderRegistry

service

Case-insensitive provider table. The first registered provider becomes active automatically, unregistering the active one promotes another, and Active falls back to the null provider.

• static IPlatformProvider Active { get; }
• static bool IsRealProviderActive { get; } / static int Count { get; }
• static void Register(IPlatformProvider provider) / static void Unregister(string providerId)
• static void SetActive(string providerId) / static bool TrySetActive(string providerId)
• static void ResetForTests()

PlatformResult

struct

A status plus a message. Fail coerces a Success status to Faulted, so a result cannot claim to have failed successfully.

• PlatformOperationStatus Status { get; } / string Message { get; } / bool Succeeded { get; }
• static PlatformResult Success(string message = "OK")
• static PlatformResult Fail(PlatformOperationStatus status, string message)

PlatformOperationStatus

enum

Success, Unavailable, NotInitialized, NotAuthenticated, InvalidRequest, NotFound, RateLimited, Conflict, Canceled, Faulted. Distinct because each one implies a different response from the caller.

PlatformCapability

enum

Flags for Auth, Profile, Achievements, Leaderboards, Stats, Friends, RichPresence, Overlay, CloudSave, Commerce, InventoryItems, Workshop, Dlc, Lobbies, Matchmaking. Check it before building a feature, not after a call fails.

PlatformProviderState

enum

Uninitialized, Initializing, Ready, SignedOut, Faulted, ShuttingDown, Shutdown. Raised through StateChanged, so UI can show the intermediate states.

PlatformProviderAvailability

struct

Whether a provider can run here at all, with a reason. Available and Unavailable are the factories, and the reason is written to be shown to a developer diagnosing a missing SDK.

IPlatformAuthService

interface

Sign-in state and platform auth tickets. RequestAuthTicketAsync mints a ticket for a stated purpose, and ReleaseAuthTicketAsync gives it back, which matters on platforms that cap outstanding tickets.

• bool IsSignedIn { get; } / PlatformUserId LocalUserId { get; }
• event Action<PlatformUserId> SignedIn / SignedOut
• Task<PlatformResult<PlatformUserId>> SignInAsync(...)
• Task<PlatformResult<PlatformAuthTicket>> RequestAuthTicketAsync(PlatformAuthTicketPurpose purpose, ...)
• Task<PlatformResult> ReleaseAuthTicketAsync(PlatformAuthTicket ticket, ...)

IPlatformLobbyService

interface

Primitive lobby operations: create, query, join, leave, joinable, string metadata get and set, member list, invite. All flow logic sits above it.

• Task<PlatformResult<PlatformLobby>> CreateLobbyAsync(PlatformLobbyCreateRequest request, ...)
• Task<PlatformResult<IReadOnlyList<PlatformLobby>>> QueryLobbiesAsync(PlatformLobbyQuery query, ...)
• Task<PlatformResult<PlatformLobby>> JoinLobbyAsync(PlatformLobbyId lobbyId, ...)
• Task<PlatformResult> SetLobbyDataAsync(PlatformLobbyId lobbyId, string key, string value, ...)
• Task<PlatformResult<IReadOnlyList<PlatformLobbyMember>>> GetLobbyMembersAsync(PlatformLobbyId lobbyId, ...)
• Task<PlatformResult> InviteUserAsync(PlatformLobbyId lobbyId, PlatformUserId userId, ...)

IPlatformAchievementService

interface

Get, Unlock, SetProgress, and Flush. Flush is separate because most store SDKs batch stat and achievement writes and only commit on an explicit store call.

IPlatformLeaderboardService

interface

FindOrCreate with an explicit LeaderboardSortMethod and LeaderboardDisplayType, SubmitScore with an update policy and optional detail ints, and paged global score reads.

IPlatformStatsService

interface

Typed integer and floating-point stat reads and writes with a separate FlushAsync, mirroring how store SDKs actually commit.

IPlatformCloudSaveService

interface

List, read, write, and delete cloud files by name, plus a quota query. Byte arrays rather than streams, because that is the shape every store SDK exposes.

IPlatformInventoryService

interface

Store inventory items: read items and definitions, grant, trigger a drop list, consume a quantity, and exchange a set of consumed items for a set of generated ones.

IPlatformWorkshopService

interface

User-generated content: subscribed items, single item lookup, create with a visibility, update through a PlatformWorkshopItemUpdate, and subscribe or unsubscribe.

IPlatformAppsService

interface

App and DLC ownership: current app id, whether an app is subscribed, a single DLC lookup, and the installed DLC list.

IPlatformOverlayService

interface

Activates a platform overlay dialog, a store page with an explicit action, or the invite dialog for a lobby.

IPlatformEventService

interface

The thirteen platform events a UI can subscribe to once and keep bound across a provider change: overlay, profile, friends, achievements, stats, leaderboards, inventory, cloud files, Workshop, DLC, lobby changes, and lobby invites.

PlatformEventHub

class

The shared IPlatformEventService implementation. Providers compose one and raise events through its Publish methods, so the event surface is declared once.

NullPlatformProvider

class

The always-available fallback returned by the registry when nothing is registered. Capabilities None, State Ready, and every call answered Unavailable with a message.

• static readonly NullPlatformProvider Instance

MockPlatformProvider

class

In-memory provider for local multiplayer testing. Fakes identity and lobbies only, reporting Auth, Profile, Friends, Lobbies, and Matchmaking; everything it cannot honestly simulate returns Unavailable.

MockPlatformIdentity

struct

A synthetic signed-in user for the mock provider. Converts to a PlatformUserId and a PlatformUserProfile, so two identities in one process look like two distinct accounts to everything above.

• static MockPlatformIdentity Player(string userId, string displayName = null)
• PlatformUserId ToPlatformUserId() / PlatformUserProfile ToProfile()

MockLobbyDirectory

class

Process-wide in-memory lobby store behind the mock provider. Two mock providers that share a directory see the same lobbies, which is how host-and-client lobby testing runs in one process.

• static MockLobbyDirectory Shared { get; }
• event Action<PlatformLobbyChanged> Changed
• string MintLobbyId()
• PlatformLobby Create(...) / bool Join(...) / bool Leave(...) / bool SetData(...)
• void Reset()

MockPlatformBootstrap

class

Explicit registration helper for the mock provider. Never auto-invoked, because a production build must not silently activate it.

• static MockPlatformProvider Register(MockPlatformIdentity identity, bool makeActive = true, MockLobbyDirectory directory = null)
• static void Unregister()

PlatformLobbySessionService

class

The pre-game flow over the primitive lobby service: create, browse, join, ready up, countdown, start. All state lives in lobby metadata so every member reads the same truth.

• Task<PlatformResult<PlatformLobby>> CreateLobbyAsync(PlatformLobbySessionCreateOptions options, ...)
• Task<PlatformResult<IReadOnlyList<PlatformLobby>>> RefreshLobbiesAsync(...)
• Task<PlatformResult<PlatformLobby>> JoinLobbyAsync(...) / Task<PlatformResult> LeaveLobbyAsync(...)
• Task<PlatformResult> SetReadyAsync(bool ready, ...) / Task<PlatformResult> RequestStartAsync(...)
• Task TickAsync(CancellationToken cancellationToken = default)
• PlatformLobbySessionSnapshot Current { get; }
• event Action<PlatformLobbySessionSnapshot> Changed / GameStartRequested

PlatformLobbySessionSnapshot

struct

The immutable view a lobby UI binds to: start state, lobby, local user, ownership, ready count against the requirement, password protection, start unlocked, countdown state and remaining seconds, members, and a message.

PlatformLobbyStartState

enum

Browsing, InLobby, ReadyUp, Countdown, Starting. The five states the session service moves through.

PlatformLobbyMetadataKeys

class

The metadata contract. Session keys such as zoa.requiredPlayers, zoa.passwordHash, and zoa.countdownSeconds, per-user ready keys built by ReadyKey, and the zoa.network.* block that hands a lobby off to the networking session.

• static string ReadyKey(PlatformUserId userId)

PlatformUserId

struct

A provider id paired with a provider-scoped user id, so two users from different providers can never compare equal by accident.

PlatformLobby

struct

A lobby as the platform sees it: identity, owner, member count and capacity, visibility, joinability, and its metadata map.

PlatformAuthTicket

struct

A minted platform auth ticket with its payload and a handle for release. A networking auth adapter validates a joining client against that handle.

PlatformLobbyMenuController

component

UI Toolkit lobby menu bound to PlatformLobbySessionService. Provider-neutral: it works against whichever provider is active, so the Steam runtime can install it without owning it.

• static PlatformLobbyMenuController EnsureInScene(Transform parent = null)
• PlatformLobbySessionSnapshot Snapshot { get; }
• event Action<PlatformLobbySessionSnapshot> GameStartRequested

PlatformProfileHudPresenter

component

Renders the signed-in user's profile into a named HUD region, defaulting to TopStatusBar, with an avatar texture that a provider-specific presenter can supply.

• Task RefreshAsync()
• void SetAvatar(Texture2D texture)