diff --git a/osu.Game/Database/RealmExtensions.cs b/osu.Game/Database/RealmExtensions.cs index ee76f1aa79..c84e1e35b8 100644 --- a/osu.Game/Database/RealmExtensions.cs +++ b/osu.Game/Database/RealmExtensions.cs @@ -13,10 +13,13 @@ namespace osu.Game.Database /// If a match was not found, a is performed before trying a second time. /// This ensures that an instance is found even if the realm requested against was not in a consistent state. /// - /// - /// - /// - /// + /// The realm to operate on. + /// The ID of the entity to find in the realm. + /// The type of the entity to find in the realm. + /// + /// The retrieved entity of type . + /// Can be if the entity is still not found by even after a refresh. + /// public static T? FindWithRefresh(this Realm realm, Guid id) where T : IRealmObject { var found = realm.Find(id); @@ -24,7 +27,7 @@ namespace osu.Game.Database if (found == null) { // It may be that we access this from the update thread before a refresh has taken place. - // To ensure that behaviour matches what we'd expect (the object *is* available), force + // To ensure that behaviour matches what we'd expect (the object generally *should be* available), force // a refresh to bring in any off-thread changes immediately. realm.Refresh(); found = realm.Find(id);