Zapisane gry na Androida

Ten przewodnik pokazuje, jak zaimplementować zapisane gry za pomocą interfejsu Snapshots API udostępnianego przez usługi Gier Google Play. Interfejsy API znajdują się w pakietach com.google.android.gms.games.snapshot i com.google.android.gms.games.

Zanim zaczniesz

Więcej informacji o tej funkcji znajdziesz w omówieniu Zapisanych gier.

Pobieranie klienta zrzutów

Aby zacząć korzystać z interfejsu Snapshots API, gra musi najpierw uzyskać obiekt SnapshotsClient. Możesz to zrobić, wywołując metodę Games.getSnapshotsContents() i przekazując aktywność.

Wyświetlanie zapisanych gier

Interfejs Snapshots API możesz zintegrować w dowolnym miejscu w grze, w którym gracze mają możliwość zapisywania lub przywracania postępów. Gra może wyświetlać taką opcję w wyznaczonych punktach zapisu lub przywracania albo umożliwiać graczom zapisywanie lub przywracanie postępów w dowolnym momencie.

Gdy gracze wybiorą w grze opcję zapisu lub przywracania, gra może opcjonalnie wyświetlić ekran z prośbą o wpisanie informacji o nowej zapisanej grze lub o wybranie istniejącej zapisanej gry do przywrócenia.

Aby ułatwić Ci tworzenie aplikacji, interfejs API migawek udostępnia domyślny interfejs wyboru zapisanych gier, z którego możesz korzystać od razu po wyjęciu z pudełka. Interfejs wyboru zapisanych gier umożliwia graczom tworzenie nowych zapisanych gier, wyświetlanie szczegółów istniejących zapisanych gier i wczytywanie poprzednich zapisanych gier.

Aby uruchomić domyślny interfejs Zapisanych gier:

  1. Wywołaj funkcję SnapshotsClient.getSelectSnapshotIntent() aby uzyskać Intent do uruchomienia domyślnego interfejsu wyboru zapisanych gier.
  2. Zadzwoń pod numer startActivityForResult() i przekaż telefon Intent. Jeśli wywołanie się powiedzie, gra wyświetli interfejs wyboru zapisanej gry wraz z określonymi przez Ciebie opcjami.

Oto przykład uruchamiania domyślnego interfejsu wyboru zapisanych gier:

private static final int RC_SAVED_GAMES = 9009;

private void showSavedGamesUI() {
  SnapshotsClient snapshotsClient =
      PlayGames.getSnapshotsClient(this);
  int maxNumberOfSavedGamesToShow = 5;

  Task<Intent> intentTask = snapshotsClient.getSelectSnapshotIntent(
      "See My Saves", true, true, maxNumberOfSavedGamesToShow);

  intentTask.addOnSuccessListener(new OnSuccessListener<Intent>() {
    @Override
    public void onSuccess(Intent intent) {
      startActivityForResult(intent, RC_SAVED_GAMES);
    }
  });
}

Jeśli gracz wybierze utworzenie nowej zapisanej gry lub wczytanie istniejącej, interfejs wyśle żądanie do usług Gier Play. Jeśli żądanie się powiedzie, usługi Gier Play zwrócą informacje umożliwiające utworzenie lub przywrócenie zapisanej gry za pomocą wywołania zwrotnego onActivityResult(). Twoja gra może zastąpić to wywołanie zwrotne, aby sprawdzić, czy podczas żądania wystąpiły jakieś błędy.

Poniższy fragment kodu pokazuje przykładową implementację funkcji onActivityResult():

private String mCurrentSaveName = "snapshotTemp";

/**
 * This callback will be triggered after you call startActivityForResult from the
 * showSavedGamesUI method.
 */
@Override
protected void onActivityResult(int requestCode, int resultCode,
                                Intent intent) {
  if (intent != null) {
    if (intent.hasExtra(SnapshotsClient.EXTRA_SNAPSHOT_METADATA)) {
      // Load a snapshot.
      SnapshotMetadata snapshotMetadata =
          intent.getParcelableExtra(SnapshotsClient.EXTRA_SNAPSHOT_METADATA);
      mCurrentSaveName = snapshotMetadata.getUniqueName();

      // Load the game data from the Snapshot
      // ...
    } else if (intent.hasExtra(SnapshotsClient.EXTRA_SNAPSHOT_NEW)) {
      // Create a new snapshot named with a unique string
      String unique = new BigInteger(281, new Random()).toString(13);
      mCurrentSaveName = "snapshotTemp-" + unique;

      // Create the new snapshot
      // ...
    }
  }
}

Zapisywanie gier

Aby zapisać treści w zapisanej grze:

  1. Asynchroniczne otwieranie zrzutu za pomocą funkcji SnapshotsClient.open().

  2. Pobierz obiekt Snapshot z wyniku zadania, wywołując SnapshotsClient.DataOrConflict.getData().

  3. Pobierz instancję SnapshotContents za pomocą SnapshotsClient.SnapshotConflict.

  4. Wywołaj SnapshotContents.writeBytes() aby zapisać dane gracza w formacie bajtowym.

  5. Po wprowadzeniu wszystkich zmian wywołaj funkcję SnapshotsClient.commitAndClose(), aby wysłać zmiany na serwery Google. W wywołaniu metody gra może opcjonalnie podać dodatkowe informacje, aby określić, jak Usługi gier Play mają prezentować zapisaną grę graczom. Te informacje są reprezentowane w obiekcie SnapshotMetaDataChange utworzonym przez grę za pomocą funkcji SnapshotMetadataChange.Builder.

Poniższy fragment kodu pokazuje, jak gra może zatwierdzać zmiany w zapisanej grze:

private Task<SnapshotMetadata> writeSnapshot(Snapshot snapshot,
                                             byte[] data, Bitmap coverImage, String desc) {

  // Set the data payload for the snapshot
  snapshot.getSnapshotContents().writeBytes(data);

  // Create the change operation
  SnapshotMetadataChange metadataChange = new SnapshotMetadataChange.Builder()
      .setCoverImage(coverImage)
      .setDescription(desc)
      .build();

  SnapshotsClient snapshotsClient =
      PlayGames.getSnapshotsClient(this);

  // Commit the operation
  return snapshotsClient.commitAndClose(snapshot, metadataChange);
}

Jeśli w momencie, gdy aplikacja wywołuje SnapshotsClient.commitAndClose(), urządzenie gracza nie jest połączone z siecią, usługi Gier Play zapisują dane z gry lokalnie na urządzeniu. Po ponownym połączeniu urządzenia usługi Gier Play synchronizują lokalnie zapisane zmiany w danych z gry z serwerami Google.

Wczytywanie zapisanych gier

Aby pobrać zapisane gry uwierzytelnionego gracza:

  1. Asynchroniczne otwieranie zrzutu za pomocą funkcji SnapshotsClient.open().

  2. Pobierz obiekt Snapshot z wyniku zadania, wywołując SnapshotsClient.DataOrConflict.getData(). Możesz też pobrać konkretny zapis stanu gry za pomocą interfejsu wyboru zapisanych gier, zgodnie z opisem w sekcji Wyświetlanie zapisanych gier.

  3. Pobierz instancję SnapshotContents za pomocą SnapshotsClient.SnapshotConflict.

  4. Wywołaj funkcję SnapshotContents.readFully() , aby odczytać zawartość migawki.

Poniższy fragment kodu pokazuje, jak wczytać konkretną zapisaną grę:

Task<byte[]> loadSnapshot() {
  // Display a progress dialog
  // ...

  // Get the SnapshotsClient from the signed in account.
  SnapshotsClient snapshotsClient =
      PlayGames.getSnapshotsClient(this);

  // In the case of a conflict, the most recently modified version of this snapshot will be used.
  int conflictResolutionPolicy = SnapshotsClient.RESOLUTION_POLICY_MOST_RECENTLY_MODIFIED;

  // Open the saved game using its name.
  return snapshotsClient.open(mCurrentSaveName, true, conflictResolutionPolicy)
      .addOnFailureListener(new OnFailureListener() {
        @Override
        public void onFailure(@NonNull Exception e) {
          Log.e(TAG, "Error while opening Snapshot.", e);
        }
      }).continueWith(new Continuation<SnapshotsClient.DataOrConflict<Snapshot>, byte[]>() {
        @Override
        public byte[] then(@NonNull Task<SnapshotsClient.DataOrConflict<Snapshot>> task) throws Exception {
          Snapshot snapshot = task.getResult().getData();

          // Opening the snapshot was a success and any conflicts have been resolved.
          try {
            // Extract the raw data from the snapshot.
            return snapshot.getSnapshotContents().readFully();
          } catch (IOException e) {
            Log.e(TAG, "Error while reading Snapshot.", e);
          }

          return null;
        }
      }).addOnCompleteListener(new OnCompleteListener<byte[]>() {
        @Override
        public void onComplete(@NonNull Task<byte[]> task) {
          // Dismiss progress dialog and reflect the changes in the UI when complete.
          // ...
        }
      });
}

Rozwiązywanie konfliktów zapisanych gier

Jeśli w grze używasz interfejsu Snapshots API, wiele urządzeń może odczytywać i zapisywać dane w tej samej zapisanej grze. Jeśli urządzenie tymczasowo utraci połączenie z siecią, a potem je odzyska, może to spowodować konflikty danych, w wyniku których zapisana gra przechowywana na lokalnym urządzeniu gracza będzie niezsynchronizowana z wersją zdalną przechowywaną na serwerach Google.

Interfejs Snapshots API udostępnia mechanizm rozwiązywania konfliktów, który w momencie odczytu przedstawia oba zestawy sprzecznych zapisanych gier i umożliwia wdrożenie strategii rozwiązywania konfliktów odpowiedniej dla Twojej gry.

Gdy Usługi gier Play wykryją konflikt danych, metoda SnapshotsClient.DataOrConflict.isConflict() zwraca wartość true. W takim przypadku klasa SnapshotsClient.SnapshotConflict udostępnia 2 wersje zapisanej gry:

  • Wersja serwera: najnowsza wersja znana Usługom gier Play jako dokładna dla urządzenia gracza.

  • Wersja lokalna: zmodyfikowana wersja wykryta na jednym z urządzeń odtwarzacza, która zawiera sprzeczne treści lub metadane. Może to nie być ta sama wersja, którą próbowano zapisać.

Gra musi zdecydować, jak rozwiązać konflikt, wybierając jedną z podanych wersji lub łącząc dane z dwóch zapisanych wersji gry.

Aby wykryć i rozwiązać konflikty zapisanych gier:

  1. Zadzwoń pod numer SnapshotsClient.open(). Wynik zadania zawiera klasę SnapshotsClient.DataOrConflict.

  2. Wywołaj metodę SnapshotsClient.DataOrConflict.isConflict(). Jeśli wynik to „prawda”, masz konflikt do rozwiązania.

  3. Zadzwoń pod numer SnapshotsClient.DataOrConflict.getConflict(), aby pobrać instancję SnapshotsClient.snapshotConflict.

  4. Wywołaj funkcję SnapshotsClient.SnapshotConflict.getConflictId() , aby pobrać identyfikator konfliktu, który jednoznacznie identyfikuje wykryty konflikt. Twoja gra potrzebuje tej wartości, aby później wysłać żądanie rozwiązania konfliktu.

  5. Aby uzyskać wersję lokalną, wywołaj metodę SnapshotsClient.SnapshotConflict.getConflictingSnapshot().

  6. Aby uzyskać wersję serwera, wywołaj metodę SnapshotsClient.SnapshotConflict.getSnapshot().

  7. Aby rozwiązać konflikt zapisanej gry, wybierz wersję, którą chcesz zapisać na serwerze jako ostateczną, i przekaż ją do metody SnapshotsClient.resolveConflict().

Poniższy fragment kodu pokazuje przykład tego, jak gra może rozwiązać konflikt zapisanej gry, wybierając ostatnio zmodyfikowaną zapisaną grę jako ostateczną wersję do zapisania:

private static final int MAX_SNAPSHOT_RESOLVE_RETRIES = 10;

Task<Snapshot> processSnapshotOpenResult(SnapshotsClient.DataOrConflict<Snapshot> result,
                                         final int retryCount) {

  if (!result.isConflict()) {
    // There was no conflict, so return the result of the source.
    TaskCompletionSource<Snapshot> source = new TaskCompletionSource<>();
    source.setResult(result.getData());
    return source.getTask();
  }

  // There was a conflict.  Try resolving it by selecting the newest of the conflicting snapshots.
  // This is the same as using RESOLUTION_POLICY_MOST_RECENTLY_MODIFIED as a conflict resolution
  // policy, but we are implementing it as an example of a manual resolution.
  // One option is to present a UI to the user to choose which snapshot to resolve.
  SnapshotsClient.SnapshotConflict conflict = result.getConflict();

  Snapshot snapshot = conflict.getSnapshot();
  Snapshot conflictSnapshot = conflict.getConflictingSnapshot();

  // Resolve between conflicts by selecting the newest of the conflicting snapshots.
  Snapshot resolvedSnapshot = snapshot;

  if (snapshot.getMetadata().getLastModifiedTimestamp() <
      conflictSnapshot.getMetadata().getLastModifiedTimestamp()) {
    resolvedSnapshot = conflictSnapshot;
  }

  return PlayGames.getSnapshotsClient(theActivity)
      .resolveConflict(conflict.getConflictId(), resolvedSnapshot)
      .continueWithTask(
          new Continuation<
              SnapshotsClient.DataOrConflict<Snapshot>,
              Task<Snapshot>>() {
            @Override
            public Task<Snapshot> then(
                @NonNull Task<SnapshotsClient.DataOrConflict<Snapshot>> task)
                throws Exception {
              // Resolving the conflict may cause another conflict,
              // so recurse and try another resolution.
              if (retryCount < MAX_SNAPSHOT_RESOLVE_RETRIES) {
                return processSnapshotOpenResult(task.getResult(), retryCount + 1);
              } else {
                throw new Exception("Could not resolve snapshot conflicts");
              }
            }
          });
}

Modyfikowanie zapisanych gier

Jeśli chcesz scalić dane z kilku zapisanych gier lub zmodyfikować istniejącą wersję Snapshot, aby zapisać ją na serwerze jako ostateczną wersję, wykonaj te czynności:

  1. Zadzwoń pod numer SnapshotsClient.open().

  2. Zadzwoń pod numer SnapshotsClient.SnapshotConflict.getResolutionSnapshotsContent() i uzyskaj nowy obiekt SnapshotContents.

  3. Połącz dane z SnapshotsClient.SnapshotConflict.getConflictingSnapshot() i SnapshotsClient.SnapshotConflict.getSnapshot() z obiektem SnapshotContents z poprzedniego kroku.

  4. Opcjonalnie utwórz instancję SnapshotMetadataChange, jeśli w polach metadanych wprowadzono zmiany.

  5. Zadzwoń pod numer SnapshotsClient.resolveConflict(). W wywołaniu metody przekaż SnapshotsClient.SnapshotConflict.getConflictId() jako pierwszy argument, a zmodyfikowane wcześniej obiekty SnapshotMetadataChange i SnapshotContents jako drugi i trzeci argument.

  6. Jeśli wywołanie SnapshotsClient.resolveConflict() się powiedzie, interfejs API zapisze obiekt Snapshot na serwerze i spróbuje otworzyć obiekt Snapshot na urządzeniu lokalnym.