Deprecate GetRegionalPings for new GetPingsForRegions method
#32
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…, and update outdated references
jchu231
reviewed
Jan 24, 2025
| - It's recommended for your backend/matchmaker to provide this map of supported regions; there is a helper function `UHathoraSDK::GetRegionMap()` which provides a hardcoded map of all the regions. | ||
| 1. A `EHathoraPingType PingType` of either `EHathoraPingType::ICMP` or `EHathoraPingType::UDPEcho`. Both send an ICMP packet; the former uses the ICMP protocol and the latter uses the UDP protocol (expecting an echo response) | ||
| 1. A callback with the results | ||
| 1. An optional `int32 NumPingsPerRegion` which defaults to `3` |
There was a problem hiding this comment.
Minor: Looks like the numbers got malformed here (all of them are 1. instead of incrementing)
There was a problem hiding this comment.
This is markdown syntax which renders a number list in a descending order.
There was a problem hiding this comment.
@jchu231 Can I merge without changing these? As Jared mentioned, this syntax is automatically rendered properly; it's useful so that if you insert a new step or move steps, you don't have to go back and fix all the numbers. You can see it rendered here: https://github.com/hathora/hathora-unreal-sdk/tree/ms/decouple-api-usage
jchu231
approved these changes
Jan 24, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR primarily is to provide a new
HathoraSDK::GetPingsForRegionsmethod which doesn't call the Discovery API, but rather has an argument of the region names/urls to ping. This method also enables optional UDP echo pinging instead of ICPM (default) with another argument.HathoraSDK::GetRegionalPingshas been deprecated with appropriate deprecation messages for both C++ and Blueprints. The readme has been updated accordingly and the lobby example (both the C++ and BP versions) now use the updated version (using the newHathoraSDK::GetRegionMapmethod that provides a hardcoded version of all Hathora URLs).Here are the changes to the
W_LobbyMenu.uasset:^ This used to simply call
GetRegionalPings^ This looped on
EHathoraCloudRegionenum to fill things out instead of using the sameGetRegionMapfunction.This PR also does some other housekeeping:
DefaultBuildSettingsto useLatestin the sample project Targets to better support future engine versionsUHathoraSDK::GetServerEnvironment()to include new injected environment variables