July 26th, 2022

Deprecations #

  • Migrate all instances of ShutdownV1Notification to the new RemovedV1Notification.
    • Description: We’ve replaced ShutdownV1Notification with a more accurately named notification called RemovedV1Notification. This should be used to alert clients when a player is removed from a party.
      OriginalReplacementRemoval Patch
      ShutdownV1NotificationRemovedV1Notification0.0.78

Integrations #

  • Update any references from the TestFactory function generateList2 to generateList.

    • Description: Two similar implementations of the generateList Test Factory pattern have now been collapsed into one function.
    • Integration step:
      • Update any references in test code from the TestFactory function generateList2 to generateList.
        OriginalReplacement
        TestFactoryUtils.generateList2TestFactoryUtils.generateList

  • Update any references in SDK code from OnMatchStartFailureV1Notification to OnMatchFailureV1Notification.

    • Description: Collapsed two similar notifications sent to the SDK in scenarios where a player finished matchmaking but failed to start the match.
    • Integration step:
    • Update any references in SDK code directly attached to the raw Matchmaking service’s OnMatchStartFailureV1Notification to the raw MatchLifecycle service’s OnMatchFailureV1Notification event.
      OriginalReplacement
      OnMatchStartFailureV1NotificationOnMatchFailureV1Notification

  • Update any references in SDK code for the listed match-related service handlers from PartyServiceRaw to MatchLifecycleServiceRaw.

    • Description: Three match-related service handlers have been relocated in the Unreal and Unity SDKs, so references to the raw handlers will need to be updated. Note that these are still mapped into the PartyService; only the location of the raw endpoints has been moved.
    • Integration step:
      • Update any references in SDK code for the following raw service handlers from PartyServiceRaw to their new locations in MatchLifecycleServiceRaw.
        OriginalReplacement
        PartyServiceRaw.OnMatchReadyV1NotificationMatchLifecycleServiceRaw.OnMatchReadyV1Notification
        PartyServiceRaw.OnMatchFailedV1NotificationMatchLifecycleServiceRaw.OnMatchFailedV1Notification
        PartyServiceRaw.OnMatchReconnectV1NotificationMatchLifecycleServiceRaw.OnMatchReconnectV1Notification

  • Update references to CostEntry and PurchaseRequirements to their new locations in InventoryCommon.

    • Description: To support the ongoing development of a microtransaction feature, CostEntry and PurchaseRequirements needed more shareable access, so they’ve been moved to InventoryCommon.
    • Integration step:
      • Update references to CostEntry and PurchaseRequirements from their old locations in InventoryContent to their new locations in InventoryCommon.
        OriginalReplacement
        InventoryContent.CostEntryInventoryCommon.CostEntry
        InventoryContent.PurchaseRequirementsInventoryCommon.PurchaseRequirements

  • If you’ve implemented the PartyPlugin, update the onRemovePlayer function with the new RemovalReason field.

    • Description: PartyPlugin.onRemovePlayer has a new RemovalReason field which provides the reason for a player leaving a party. This change only impacts studios who have already implemented their PartyPlugin.

    • Integration step:

      • Update the onRemovePlayer function with the new RemovalReason field.
      OriginalReplacement
      override suspend fun onRemovePlayer(
    party: Party,
    removedPlayer: PartyPlayer
)
{ ... }

      override suspend fun onRemovePlayer(
    party: Party,
    removedPlayer: PartyPlayer,
    removalReason: RemovalReason
)
{ ... }

  • Unreal: Replace ReportCapacityUntilMatchAllocated with StartReportCapacityPolling.

    • Description: This change will make sure that ReportCapacity continues to poll even after finding a match. Note that the order of the ReportCapacityTimeout argument and callback (the last 2 arguments) need to be reversed. Note that this change only impacts Unreal users, as the Unity change was previously implemented.
    • Integration step:
      • Replace ReportCapacityUntilMatchAllocated with StartReportCapacityPolling.
        OriginalReplacement
        ReportCapacityUntilMatchAllocatedStartReportCapacityPolling

Docs #


Pragma Engine 0.0.76
Pragma Engine 0.0.78