Migracja z NativeActivity   Część Android Game Development Kit.

Z tej strony dowiesz się, jak w projekcie gry na Androida przejść z NativeActivity na GameActivity.

GameActivity jest oparta na NativeActivity z frameworka Androida, ale zawiera ulepszenia i nowe funkcje:

  • Obsługuje Fragment z Jetpacka.
  • Dodaje obsługę TextInput, aby ułatwić integrację klawiatury ekranowej.
  • Obsługuje zdarzenia dotyku i klawiatury w GameActivityklasie JavaNativeActivity, a nie w onInputEventinterfejsieNativeActivity.

Przed migracją zalecamy zapoznanie się z przewodnikiem dla początkujących, w którym opisujemy, jak skonfigurować i zintegrować GameActivity w projekcie.

Aktualizacje skryptu kompilacji Java

GameActivity jest rozpowszechniana jako biblioteka Jetpack. Wykonaj czynności związane z aktualizacją skryptu Gradle opisane we wprowadzeniu:

  1. Włącz bibliotekę Jetpack w pliku gradle.properties projektu:

    android.useAndroidX=true
    
  2. Opcjonalnie możesz określić wersję Prefaba w tym samym pliku gradle.properties, np.:

    android.prefabVersion=2.0.0
    
  3. Włącz funkcję Prefab w pliku build.gradle aplikacji:

    android {
        ... // other configurations
        buildFeatures.prefab true
    }
    
  4. Dodaj zależność GameActivity do aplikacji:

    1. Dodaj biblioteki coregames-activity.
    2. Jeśli obecny minimalny obsługiwany poziom interfejsu API jest niższy niż 16, zaktualizuj go do co najmniej 16.
    3. Zaktualizuj skompilowaną wersję pakietu SDK do wersji wymaganej przez bibliotekę games-activity. Jetpack zwykle wymaga najnowszej wersji pakietu SDK w momencie tworzenia wersji.

    Zaktualizowany plik build.gradle może wyglądać mniej więcej tak:

    android {
        compiledSdkVersion 33
        ... // other configurations.
        defaultConfig {
            minSdkVersion 16
        }
        ... // other configurations.
    
        buildFeatures.prefab true
    }
    dependencies {
        implementation 'androidx.core:core:1.9.0'
        implementation 'androidx.games:games-activity:1.2.2'
    }
    

Aktualizacje kodu Kotlin lub Java

NativeActivity może być używana jako aktywność startowa i tworzy aplikację na pełnym ekranie. Obecnie GameActivity nie może być używane jako aktywność uruchamiająca. Aplikacje muszą wyprowadzać klasę z GameActivity i używać jej jako działania startowego. Musisz też wprowadzić dodatkowe zmiany w konfiguracji, aby utworzyć aplikację na pełnym ekranie.

W poniższych krokach przyjęto, że aplikacja używa NativeActivity jako aktywności uruchamiającej. Jeśli tak nie jest, możesz pominąć większość z nich.

  1. Utwórz plik Kotlin lub Java, w którym będzie się znajdować nowe działanie uruchamiania. Na przykład ten kod tworzy aktywność MainActivity jako aktywność uruchamiania i wczytuje główną bibliotekę natywną aplikacji, libAndroidGame.so:

    Kotlin

    class MainActivity : GameActivity() {
       override fun onResume() {
           super.onResume()
           // Use the function recommended from the following page:
           // https://d.android.com/training/system-ui/immersive
           hideSystemBars()
       }
       companion object {
           init {
               System.loadLibrary("AndroidGame")
           }
       }
    }

    Java

      public class MainActivity extends GameActivity {
          protected void onResume() {
              super.onResume();
              // Use the function recommended from
              // https://d.android.com/training/system-ui/immersive
              hideSystemBars();
          }
          static {
              System.loadLibrary("AndroidGame");
          }
      }
  2. Utwórz motyw aplikacji na pełnym ekranie w pliku res\values\themes.xml:

    <resources xmlns:tools="http://schemas.android.com/tools">
        <!-- Base application theme. -->
        <style name="Application.Fullscreen" parent="Theme.AppCompat.Light.NoActionBar">
            <item name="android:windowFullscreen">true</item>
            <item name="android:windowContentOverlay">@null</item>"
        </style>
    </resources>
    
  3. Zastosuj motyw do aplikacji w pliku AndroidManifest.xml:

    <application  android:theme=”@style/Application.Fullscreen”>
         <!-- other configurations not listed here. -->
    </application>
    

    Szczegółowe instrukcje dotyczące trybu pełnoekranowego znajdziesz w przewodniku po trybie immersyjnym i w przykładowej implementacji w repozytorium games-samples.

Ten przewodnik po migracji nie zmienia nazwy biblioteki natywnej. Jeśli zmienisz nazwę, upewnij się, że nazwy bibliotek natywnych są spójne w tych 3 lokalizacjach:

  • Kod w języku Kotlin lub Java:

    System.loadLibrary(AndroidGame)
    
  • AndroidManifest.xml:

    <meta-data android:name="android.app.lib_name"
            android:value="AndroidGame" />
    
  • W pliku skryptu kompilacji C/C++, na przykład CMakeLists.txt:

    add_library(AndroidGame ...)
    

Aktualizacje skryptu kompilacji C/C++

W instrukcjach w tej sekcji jako przykładu używamy cmake. Jeśli Twoja aplikacja używa ndk-build, musisz zmapować je na odpowiednie polecenia opisane na stronie dokumentacji ndk-build.

Implementacja GameActivity w językach C/C++ jest udostępniana jako kod źródłowy. W przypadku wersji 1.2.2 i nowszych udostępniana jest statyczna biblioteka. Zalecanym typem wersji jest biblioteka statyczna.

Wersja jest spakowana w pliku AAR za pomocą narzędzia prefab. Kod natywny obejmuje źródła C/C++ GameActivity i kod native_app_glue. Muszą być one tworzone razem z kodem C/C++ aplikacji.

NativeActivity aplikacji korzysta już z kodu native_app_glue dostarczonego w NDK. Musisz zastąpić go wersją native_app_glue z GameActivity. Poza tym obowiązują wszystkie cmake kroki opisane w przewodniku dla początkujących:

  • Zaimportuj do projektu bibliotekę statyczną C/C++ lub kod źródłowy C/++ w ten sposób:

    Biblioteka statyczna

    W pliku CMakeLists.txt projektu zaimportuj bibliotekę statyczną game-activity do modułu prefabrykatu game-activity_static:

    find_package(game-activity REQUIRED CONFIG)
    target_link_libraries(${PROJECT_NAME} PUBLIC log android
    game-activity::game-activity_static)
    

    Kod źródłowy

    W pliku CMakeLists.txt projektu zaimportuj pakiet game-activity i dodaj go do celu. Pakiet game-activity wymaga pakietu libandroid.so, więc jeśli go brakuje, musisz go też zaimportować.

    find_package(game-activity REQUIRED CONFIG)
    ...
    target_link_libraries(... android game-activity::game-activity)
    
  • Usuń wszystkie odwołania do kodu native_app_glue NDK, takie jak:

    ${ANDROID_NDK}/sources/android/native_app_glue/android_native_app_glue.c
        ...
    set(CMAKE_SHARED_LINKER_FLAGS
        "${CMAKE_SHARED_LINKER_FLAGS} -u ANativeActivity_onCreate")
    
  • Jeśli używasz wersji kodu źródłowego, dołącz pliki źródłowe GameActivity. W innym przypadku pomiń ten krok.

    get_target_property(game-activity-include
                        game-activity::game-activity
                        INTERFACE_INCLUDE_DIRECTORIES)
    add_library(${PROJECT_NAME} SHARED
        main.cpp
        ${game-activity-include}/game-activity/native_app_glue/android_native_app_glue.c
        ${game-activity-include}/game-activity/GameActivity.cpp
        ${game-activity-include}/game-text-input/gametextinput.cpp)
    

Obejście problemu UnsatisfiedLinkError

Jeśli w przypadku funkcji com.google.androidgamesdk.GameActivity.initializeNativeCode() pojawi się błąd UnsatsifiedLinkError, dodaj ten kod do pliku CMakeLists.txt:

set(CMAKE_SHARED_LINKER_FLAGS
    "${CMAKE_SHARED_LINKER_FLAGS} -u \
    Java_com_google_androidgamesdk_GameActivity_initializeNativeCode")

Aktualizacje kodu źródłowego C/C++

Aby zastąpić odwołania NativeActivity w aplikacji odwołaniami GameActivity, wykonaj te czynności:

  • Używaj wersji native_app_glue wydanej z wersją GameActivity. Wyszukaj i zastąp wszystkie wystąpienia android_native_app_glue.h tymi znakami:

    #include <game-activity/native_app_glue/android_native_app_glue.h>
    
  • Ustaw zarówno filtr zdarzeń ruchu, jak i filtr kluczowych zdarzeń na NULL, aby aplikacja mogła odbierać zdarzenia wejściowe ze wszystkich urządzeń wejściowych. Zwykle robisz to w funkcji android_main():

    void android_main(android_app* app) {
        ... // other init code.
    
        android_app_set_key_event_filter(app, NULL);
        android_app_set_motion_event_filter(app, NULL);
    
        ... // additional init code, and game loop code.
    }
    
  • Usuń powiązany kod AInputEvent i zastąp go implementacją InputBuffer GameActivity:

    while (true) {
        // Read all pending events.
        int events;
        struct android_poll_source* source;
    
        // If not animating, block forever waiting for events.
        // If animating, loop until all events are read, then continue
        // to draw the next frame of animation.
        while ((ALooper_pollOnce(engine.animating ? 0 : -1, nullptr, &events,
                                (void**)&source)) >= 0) {
           // Process this app cycle or inset change event.
           if (source) {
               source->process(source->app, source);
           }
    
              ... // Other processing.
    
           // Check if app is exiting.
           if (state->destroyRequested) {
               engine_term_display(&engine);
               return;
           }
        }
        // Process input events if there are any.
        engine_handle_input(state);
    
       if (engine.animating) {
           // Draw a game frame.
       }
    }
    
    // Implement input event handling function.
    static int32_t engine_handle_input(struct android_app* app) {
       auto* engine = (struct engine*)app->userData;
       auto ib = android_app_swap_input_buffers(app);
       if (ib && ib->motionEventsCount) {
           for (int i = 0; i < ib->motionEventsCount; i++) {
               auto *event = &ib->motionEvents[i];
               int32_t ptrIdx = 0;
               switch (event->action & AMOTION_EVENT_ACTION_MASK) {
                   case AMOTION_EVENT_ACTION_POINTER_DOWN:
                   case AMOTION_EVENT_ACTION_POINTER_UP:
                       // Retrieve the index for the starting and the ending of any secondary pointers
                       ptrIdx = (event->action & AMOTION_EVENT_ACTION_POINTER_INDEX_MASK) >>
                                AMOTION_EVENT_ACTION_POINTER_INDEX_SHIFT;
                   case AMOTION_EVENT_ACTION_DOWN:
                   case AMOTION_EVENT_ACTION_UP:
                       engine->state.x = GameActivityPointerAxes_getAxisValue(
                           &event->pointers[ptrIdx], AMOTION_EVENT_AXIS_X);
                       engine->state.y = GameActivityPointerAxes_getAxisValue(
                           &event->pointers[ptrIdx], AMOTION_EVENT_AXIS_Y);
                       break;
                    case AMOTION_EVENT_ACTION_MOVE:
                    // Process the move action: the new coordinates for all active touch pointers
                    // are inside the event->pointers[]. Compare with our internally saved
                    // coordinates to find out which pointers are actually moved. Note that there is
                    // no index embedded inside event->action for AMOTION_EVENT_ACTION_MOVE (there
                    // might be multiple pointers moved at the same time).
                        ...
                       break;
               }
           }
           android_app_clear_motion_events(ib);
       }
    
       // Process the KeyEvent in a similar way.
           ...
    
       return 0;
    }
    
  • Sprawdź i zaktualizuj logikę dołączoną do elementu NativeActivityAInputEvent. Jak pokazano w poprzednim kroku, przetwarzanie InputBufferGameActivityALooper_pollOnce() odbywa się poza pętlą.

  • Zastąp użycie elementu android_app::activity->clazz elementem android_app:: activity->javaGameActivity. GameActivity zmienia nazwę instancji Java GameActivity.

Dodatkowe czynności

Powyższe kroki obejmują funkcje NativeActivity, ale GameActivity ma dodatkowe funkcje, z których możesz chcieć skorzystać:

Zachęcamy do zapoznania się z tymi funkcjami i wdrożenia ich w swoich grach.

Jeśli masz pytania lub rekomendacje dotyczące GameActivity lub innych bibliotek AGDK, utwórz zgłoszenie błędu, aby nas o tym poinformować.