Pragma Engine 0.0.77
July 26th, 2022
Deprecations #
- Migrate all instances of
ShutdownV1Notification
to the newRemovedV1Notification
.- Description: We’ve replaced
ShutdownV1Notification
with a more accurately named notification calledRemovedV1Notification
. This should be used to alert clients when a player is removed from a party.Original Replacement Removal Patch ShutdownV1Notification
RemovedV1Notification
0.0.78
- Description: We’ve replaced
Integrations #
Update any references from the
TestFactory
functiongenerateList2
togenerateList
.- 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
functiongenerateList2
togenerateList
.Original Replacement TestFactoryUtils.generateList2
TestFactoryUtils.generateList
- Update any references in test code from the
- Description: Two similar implementations of the
Update any references in SDK code from
OnMatchStartFailureV1Notification
toOnMatchFailureV1Notification
.- 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’sOnMatchStartFailureV1Notification
to the rawMatchLifecycle
service’sOnMatchFailureV1Notification
event.Original Replacement OnMatchStartFailureV1Notification
OnMatchFailureV1Notification
Update any references in SDK code for the listed match-related service handlers from
PartyServiceRaw
toMatchLifecycleServiceRaw
.- 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 inMatchLifecycleServiceRaw
.Original Replacement PartyServiceRaw.OnMatchReadyV1Notification
MatchLifecycleServiceRaw.OnMatchReadyV1Notification
PartyServiceRaw.OnMatchFailedV1Notification
MatchLifecycleServiceRaw.OnMatchFailedV1Notification
PartyServiceRaw.OnMatchReconnectV1Notification
MatchLifecycleServiceRaw.OnMatchReconnectV1Notification
- Update any references in SDK code for the following raw service handlers from
- 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
Update references to
CostEntry
andPurchaseRequirements
to their new locations inInventoryCommon
.- Description: To support the ongoing development of a microtransaction feature,
CostEntry
andPurchaseRequirements
needed more shareable access, so they’ve been moved toInventoryCommon
. - Integration step:
- Update references to
CostEntry
andPurchaseRequirements
from their old locations inInventoryContent
to their new locations inInventoryCommon
.Original Replacement InventoryContent.CostEntry
InventoryCommon.CostEntry
InventoryContent.PurchaseRequirements
InventoryCommon.PurchaseRequirements
- Update references to
- Description: To support the ongoing development of a microtransaction feature,
If you’ve implemented the
PartyPlugin
, update theonRemovePlayer
function with the newRemovalReason
field.Description:
PartyPlugin.onRemovePlayer
has a newRemovalReason
field which provides the reason for a player leaving a party. This change only impacts studios who have already implemented theirPartyPlugin
.Integration step:
- Update the
onRemovePlayer
function with the newRemovalReason
field.
Original Replacement override suspend fun onRemovePlayer( party: Party, removedPlayer: PartyPlayer ) { ... }
override suspend fun onRemovePlayer( party: Party, removedPlayer: PartyPlayer, removalReason: RemovalReason ) { ... }
- Update the
Unreal: Replace
ReportCapacityUntilMatchAllocated
withStartReportCapacityPolling
.- Description: This change will make sure that
ReportCapacity
continues to poll even after finding a match. Note that the order of theReportCapacityTimeout
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
withStartReportCapacityPolling
.Original Replacement ReportCapacityUntilMatchAllocated
StartReportCapacityPolling
- Replace
- Description: This change will make sure that
Docs #
- [New User Guide] New Custom Services User Guide is now live!
- [Updated SDKs & Tools Guides] Updated SDKs & Tools Guides to have third-level nesting for Steam and Discord tutorials.
- [Updated Services Guide] Updated Using Discord section of the Authentication Service Guide.