Zapisane gry na Androida

Z tego przewodnika dowiesz się, jak wdrażać zapisane gry za pomocą interfejsu Snapshots API udostępnianego przez usługi gier Play. Interfejsy API znajdziesz w pakietach com.google.android.gms.games.snapshot i com.google.android.gms.games.

Zanim zaczniesz

Więcej informacji o tej funkcji znajdziesz w artykule Omówienie zapisanych gier.

Pobieranie klienta zrzutów

Aby zacząć korzystać z interfejsu Snapshots API, gra musi najpierw uzyskać obiekt SnapshotsClient. Aby to zrobić, wywołaj metodę Games.getSnapshotsContents(), przekazując w niej aktywność.

Określ zakres Dysku

Interfejs API migawek korzysta z interfejsu Dysku Google API do przechowywania zapisanych gier. Aby uzyskać dostęp do interfejsu Drive API, aplikacja musi podczas tworzenia klienta logowania Google określić zakres Drive.SCOPE_APPFOLDER.

Oto przykład, jak to zrobić za pomocą metody onResume() w przypadku aktywności związanej z logowaniem:

@Override
protected void onResume() {
  super.onResume();
  signInSilently();
}

private void signInSilently() {
  GoogleSignInOptions signInOption =
      new GoogleSignInOptions.Builder(GoogleSignInOptions.DEFAULT_GAMES_SIGN_IN)
          // Add the APPFOLDER scope for Snapshot support.
          .requestScopes(Drive.SCOPE_APPFOLDER)
          .build();

  GoogleSignInClient signInClient = GoogleSignIn.getClient(this, signInOption);
  signInClient.silentSignIn().addOnCompleteListener(this,
      new OnCompleteListener<GoogleSignInAccount>() {
        @Override
        public void onComplete(@NonNull Task<GoogleSignInAccount> task) {
          if (task.isSuccessful()) {
            onConnected(task.getResult());
          } else {
            // Player will need to sign-in explicitly using via UI
          }
        }
      });
}

Wyświetlanie zapisanych gier

Interfejs Snapshots API możesz zintegrować w miejscach, w których gra umożliwia graczom zapisywanie lub przywracanie postępów. Gra może wyświetlać taką opcję w określonych punktach zapisu lub przywracania lub pozwalać graczom zapisywać i przywracać postępy w dowolnym momencie.

Gdy gracze wybiorą opcję zapisu lub przywrócenia, 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 uprościć programowanie, interfejs API zrzutów dysku udostępnia domyślny interfejs wyboru zapisanych gier, z którego możesz korzystać od razu. Interfejs wyboru zapisanych gier umożliwia graczom tworzenie nowych zapisanych gier, wyświetlanie szczegółów dotyczących istniejących zapisanych gier oraz wczytywanie wcześniejszych zapisanych gier.

Aby uruchomić domyślne UI zapisanych gier:

  1. Zadzwoń pod numer SnapshotsClient.getSelectSnapshotIntent() , aby uzyskać Intent interfejs domyślnej selekcji zapisanych gier.
  2. Zadzwoń dostartActivityForResult()i przekaż ten numerIntent. Jeśli wywołanie się powiedzie, gra wyświetli interfejs wyboru zapisanych gier wraz z określonymi 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 zdecyduje się utworzyć nowy stan gry lub załadować istniejący, interfejs wyśle żądanie do usług gier Google. Jeśli prośba zostanie zrealizowana, usługi Gry Play zwrócą informacje potrzebne do utworzenia lub przywrócenia zapisanej gry za pomocą wywołania zwrotnego onActivityResult(). Gra może zastąpić tę funkcję, aby sprawdzić, czy podczas wysyłania żądania nie wystąpiły żadne błędy.

Ten fragment kodu pokazuje przykładową implementację: 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 zapisanych gier

Aby zapisać treści w zapisanej grze:

  1. Asynchronicznie otwórz zrzut za pomocą narzędzia SnapshotsClient.open().

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

  3. Pobierz wystąpienie SnapshotContents za pomocą SnapshotsClient.SnapshotConflict.

  4. Wywołaj metodę SnapshotContents.writeBytes(), aby zapisać dane odtwarzacza w formacie bajtowym.

  5. Po zapisaniu wszystkich zmian wywołaj metodę SnapshotsClient.commitAndClose(), aby wysłać je na serwery Google. W wywołaniu metody gra może opcjonalnie podać dodatkowe informacje, aby poinformować Usługi gier Play, jak wyświetlić zapisaną grę graczom. Te informacje są reprezentowane przez obiekt SnapshotMetaDataChange, który gra tworzy za pomocą funkcji SnapshotMetadataChange.Builder.

Ten fragment kodu pokazuje, jak gra może zatwierdzić 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 podczas wywołania przez aplikacjęSnapshotsClient.commitAndClose() urządzenie gracza nie jest połączone z siecią, Usługi Gry Play zapisują zapisane dane gry lokalnie na urządzeniu. Po ponownym połączeniu urządzenia Usługi gier Google synchronizują zapisane zmiany gry z pamięci podręcznej na serwerach Google.

Wczytaj zapisane gry

Aby pobrać zapisane gry dla aktualnie zalogowanego gracza:

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

  2. Pobierz obiekt Snapshot z wyniku zadania, wywołując funkcję SnapshotsClient.DataOrConflict.getData(). Gra może też pobrać określony zrzut ekranu za pomocą interfejsu do wyboru zapisanych gier, zgodnie z opisem w artykule Wyświetlanie zapisanych gier.

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

  4. Wywołaj SnapshotContents.readFully(), aby odczytać zawartość zrzutu.

Ten fragment kodu pokazuje, jak załadować konkretny zapis gry:

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

Gdy używasz w grze interfejsu API zrzutów, może się zdarzyć, że wiele urządzeń będzie wykonywać odczyty i zapisy w tej samej zapisanej grze. Jeśli urządzenie tymczasowo straci połączenie z siecią, a potem ponownie się połączy, może to spowodować konflikt danych, w którym zapisana gra na urządzeniu lokalnym gracza jest niezsynchronizowana z wersją zapisaną na serwerach Google.

Interfejs Snapshots API udostępnia mechanizm rozwiązywania konfliktów, który w czasie odczytu przedstawia obie grupy konfliktujących zapisanych gier i umożliwia wdrożenie strategii rozwiązywania konfliktów odpowiedniej dla Twojej gry.

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

  • Wersja serwera: najnowsza wersja usług Play Games, która jest prawidłowa dla urządzenia gracza.

  • Wersja lokalna: zmodyfikowana wersja wykryta na jednym z urządzeń odtwarzacza zawierająca kolidujące treści lub metadane. Może się ona różnić od wersji, którą próbujesz zapisać.

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

Aby wykrywać i rozwiązywać zapisane konflikty gier:

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

  2. Wywołaj metodę SnapshotsClient.DataOrConflict.isConflict(). Jeśli wynik jest prawdziwy, masz konflikt do rozwiązania.

  3. Wywołaj 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. Gra potrzebuje tej wartości, aby wysłać prośbę o rozwiązanie konfliktu.

  5. Zadzwoń pod numer SnapshotsClient.SnapshotConflict.getConflictingSnapshot(), aby uzyskać lokalną wersję.

  6. Aby uzyskać wersję serwera, zadzwoń pod numer SnapshotsClient.SnapshotConflict.getSnapshot().

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

Ten fragment kodu pokazuje, jak gra może obsługiwać konflikt zapisanych stanów gry, wybierając ostatnio zmodyfikowany stan gry 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ący plik Snapshot, aby zapisać go na serwerze jako ostateczną wersję z rozwiązanymi konfliktami, wykonaj te czynności:

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

  2. Wywołaj SnapshotsClient.SnapshotConflict.getResolutionSnapshotsContent(), aby pobrać nowy obiekt SnapshotContents.

  3. Scal dane z obiektu SnapshotsClient.SnapshotConflict.getConflictingSnapshot() i SnapshotsClient.SnapshotConflict.getSnapshot() z obiektem SnapshotContents z poprzedniego kroku.

  4. Opcjonalnie utwórz instancję SnapshotMetadataChange, jeśli w polach metadanych zaszły jakieś 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 odpowiednio drugi i trzeci argument.

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