Skip to content

3.1.4

Latest

Choose a tag to compare

@jplafonta jplafonta released this 31 Oct 00:57
· 3 commits to main since this release
c549e13

PlayFab Unreal Engine Plugin — 3.1.4

GDK Requirement: Microsoft Gaming Development Kit (GDK) — 2604 Update 2 (260402), or a compatible version supported by your Unreal Engine build
Unreal Engine Baseline: Unreal Engine 5.8

Overview

This release adds active shared-ticket group matchmaking APIs and improves the reliability of session joins, invitations, authentication, and PlayFab Party networking. It also includes important memory-safety and asynchronous-result fixes in the companion PlayFabUnreal plugin.

✨ What's New

  • Active group matchmaking tickets. Use FOnlineSubsystemPlayFab::GetPlayFabMatchmakingInterface() to create or join a shared matchmaking ticket. Requests support caller-supplied session settings, with separate callbacks for ticket acceptance and final session readiness.
  • Named-session invitations on GDK. Invite players to PlayFab sessions other than GameSession. Versioned invitation payloads preserve the target session name, while existing unversioned invitations remain supported.
  • Standard Unreal invitation callbacks. Inbound PlayFab lobby invitations now also trigger OnSessionUserInviteAccepted, allowing titles to handle them through Unreal's standard session invitation flow.
  • Server-owned lobby state in session settings. Clients receive server properties, the joined server entity, and its lobby-service connection status through FOnlineSessionSettings.
  • Optional per-session custom multicast endpoint. Titles can enable a separate Party endpoint for custom payloads, distinct from normal Unreal networking traffic.
  • Additional Party configuration. Configure the send-queue timeout and opt in to temporary debugger connectivity preservation in non-shipping builds.

🐛 Fixes & Improvements

Matchmaking, Sessions, and Party

  • Hardened matchmaking ticket ownership and rejected stale or duplicate completions. Final completion remains active through Party setup and the required host lobby publication.
  • Fixed session operations remaining in progress after asynchronous Party network or endpoint setup failures.
  • Coordinated session destruction so completion waits for both PlayFab lobby leave and per-session Party network leave.
  • Fixed Steam native-session resolution and coordinated native/PlayFab completion for both JoinSession overloads, including rollback of partial joins. Addresses GitHub #13 — Steam native-session joins receive incompatible session information.
  • Delayed join completion until the advertised Party host endpoint is available, preventing premature or duplicate join callbacks.
  • Moved Party initialization onto the game thread, prevented duplicate initialization, added connectivity-query retry/backoff, and hardened suspend/resume and shutdown handling.
  • Routed Party messages to the socket associated with the matching session network.
  • Corrected disabled-voice handling so the subsystem no longer publishes a PlayFab voice interface when voice is disabled.

Authentication and Invitations

  • Deferred AutoLogin completion until PlayFab authentication resolves, avoiding unnecessary account-picker prompts for players already signed in.
  • Added bounded, per-user login deferral and corrected authentication result routing for multiple local users.
  • Marshalled OSS authentication results to the game thread and reported authentication failures and login-status transitions to listeners.
  • Preserved GDK invitations that cold-launch the title.
  • Deferred GDK multiplayer-activity publication until the lobby handle is ready.
  • Fixed platform-specific build and custom-session invitation handling.

PlayFab SDK and Developer Experience

  • Fixed heap corruption and use-after-free caused by optional scalar values aliasing SDK-owned result memory. Addresses GitHub #16 — GetInventoryItems amount ownership causes crashes, with the fix applied across affected optional scalar conversions.
  • Fixed invalid entity-handle conversions that could cause access violations during Xbox authentication.
  • Corrected asynchronous operations with no result payload reporting service failures as success.
  • Fixed FPFLocalUserLoginAsync ignoring its createAccount argument.
  • Added reference-counted PlayFab Core initialization and a blocking teardown API for shutdown paths.
  • Fixed packaging from the editor failing with loaded-file conflicts.
  • Restored dependency and include-path configuration for IntelliSense during project generation. Addresses GitHub #11 — early return in OnlineSubsystemPlayFab.Build.cs prevents IntelliSense.
  • Improved PlayFab service-failure diagnostics and expanded automated regression coverage.

The linked issues are addressed by the 3.1.4 release candidate; their GitHub status may remain open until the release is published.

⚠️ Breaking Changes & Upgrade Considerations

  • Authentication login delegate signatures have changed. FOnPFAuthenticationLoginCompleteDelegate and FOnPFAuthenticationServerLoginCompleteDelegate now include an FString error-message parameter immediately before the success boolean. Update callbacks bound to these delegates.
  • Balance PlayFab Core initialization and teardown. Every successful FPFInitialize call must have a matching FPFUninitialize or FPFUninitializeAsync. Initialization is reference-counted so one consumer does not tear down Core while another still uses it. Direct initialization through the Services APIs still requires care when mixed with Core initialization; it is not automatically covered by the Core reference count.
  • Authentication failure notifications are not necessarily terminal. OnAuthenticateUserComplete now reports failed attempts as well as success. A later retry can still succeed, so listeners must not assume the first failure ends the retry sequence.
  • Previously masked service failures now surface correctly. Review account-linking and other error-handling paths that may not previously have executed.
  • Ticket acceptance is not final session readiness. Shared-ticket callers must wait for the independent final completion callback before using the resulting Game session.
  • Named-session invitations require compatible peers. Invitations for sessions other than GameSession require both sender and receiver to support the versioned named-session payload.

📦 Components

  • PlayFabUnreal Plugin — 3.1.4
  • OnlineSubsystemPlayfab Plugin — 3.1.4

⬆️ Upgrading from 3.1.3

  • Retain the Unreal Engine 5.8 / GDK 2604 Update 2 (260402) baseline and confirm that the installed GDK is supported by your engine build.
  • Update authentication login callback signatures and review initialization/teardown balancing.
  • Review listeners that consume authentication failures or previously masked asynchronous service failures.
  • For shared group tickets, provide the complete match capacity and lobby policy in the request's SessionSettings, and wait for final session readiness rather than only ticket acceptance.
  • Custom multicast endpoints and debugger connectivity preservation are opt-in. Existing networking behavior remains unchanged while those features are disabled.
  • Multiple named sessions, per-session Party networks, configurable search-key allocation, and UE 5.8 support already shipped in 3.1.3; they are not new requirements introduced by this release.
  • The indexed Steam session-creation fix described in GitHub #10 also shipped in 3.1.3 and is retained in this release; it is not a new 3.1.4 fix.

🚀 Getting Started