GameTextInput   Jest częścią Android Game Development Kit.

Użycie biblioteki GameTextInput jest prostszą alternatywą dla pisania aplikacji na Androida działającej na pełnym ekranie, która używa klawiatury ekranowej do wprowadzania tekstu.

GameTextInput udostępnia prosty interfejs API do wyświetlania i ukrywania klawiatury ekranowej, ustawiania i pobierania aktualnie edytowanego tekstu oraz otrzymywania powiadomień o zmianie tekstu. Nie jest to przeznaczone dla pełnowartościowych aplikacji do edycji tekstu, ale nadal zapewnia obsługę zaznaczania i tworzenia regionów w typowych przypadkach użycia w grach. Ta biblioteka obsługuje też zaawansowane funkcje edytora metody wprowadzania (IME), takie jak sprawdzanie pisowni, uzupełnianie i znaki wieloklawiszowe.

Wewnętrznie GameTextInput gromadzi tekst wejściowy (wraz z odpowiednimi stanami) w buforze wewnętrznym GameTextInput::currentState_ i powiadamia aplikację o wszelkich zmianach. Następnie aplikacja przetwarza tekst w zarejestrowanej funkcji wywołania zwrotnego.

Dostępność

Z GameTextInput można korzystać na te sposoby:

  • W połączeniu z GameActivity: GameActivity integruje GameTextInput. Aplikacje, które używają GameActivity, mogą korzystać tylko ze zintegrowanego GameTextInput. Instrukcje dotyczące korzystania z GameActivity znajdziesz na stronie GameActivity. Przykładową integrację GameActivity i GameTextInput znajdziesz w repozytorium games-samples. Ten model użytkowania nie jest objęty tym przewodnikiem.

  • jako samodzielna biblioteka – w dalszej części przewodnika opisano, jak z niej korzystać;

Pamiętaj, że te 2 metody wzajemnie się wykluczają.

Oficjalne wersje GameTextInput są dostępne w bibliotece gier Jetpack w Google Maven.

Konfigurowanie kompilacji

GameTextInput jest rozpowszechniany jako plik Android Archive (AAR). Ten plik AAR zawiera klasy Javy i kod źródłowy C, który implementuje funkcje natywne GameTextInput. Musisz uwzględnić te pliki źródłowe w procesie kompilacji za pomocą Prefab, który udostępnia biblioteki natywne i kod źródłowy projektowi CMake lub kompilacji NDK.

  1. Postępuj zgodnie z instrukcjami na stronie Gry na Androida w Jetpacku, aby dodać zależność biblioteki GameTextInput do pliku build.gradle gry. Pamiętaj, że jeśli Twoje aplikacje używają GameActivity, nie mogą korzystać z samodzielnej biblioteki GameTextInput.

  2. Upewnij się, że plik gradle.properties zawiera te wiersze:

    # Tell Android Studio we are using AndroidX.
    android.useAndroidX=true
    # Use Prefab 1.1.2 or higher, which contains a fix for "header only" libs.
    android.prefabVersion=1.1.2
    # Required only if you're using Android Studio 4.0 (4.1 is recommended).
    # android.enablePrefab=true
    
  3. Zaimportuj pakiet game-text-input i dodaj go do celu w pliku CMakeLists.txt projektu:

    find_package(game-text-input REQUIRED CONFIG)
    ...
    target_link_libraries(... game-text-input::game-text-input)
    
  4. W jednym z plików .cpp w grze dodaj ten wiersz, aby uwzględnić implementację GameTextInput:

    #include <game-text-input/gametextinput.cpp>
    
  5. W plikach źródłowych, które korzystają z interfejsu API GameTextInput C, dołącz plik nagłówka:

    #include <game-text-input/gametextinput.h>
    
  6. Skompiluj i uruchom aplikację. Jeśli wystąpią błędy CMake, sprawdź, czy pliki AAR i build.gradle są prawidłowo skonfigurowane. Jeśli nie można znaleźć pliku #include, sprawdź plik konfiguracji CMakeLists.txt.

Integracja kompilacji

  1. Z wątku C, który jest już dołączony do JVM, lub z głównego wątku aplikacji wywołaj GameTextInput_init ze wskaźnikiem JNIEnv.

    static GameTextInput* gameTextInput = nullptr;
    
    extern "C"
    JNIEXPORT void JNICALL
    Java_com_gametextinput_testbed_MainActivity_onCreated(JNIEnv* env,
      jobject this) {
    {
        if(!gameTextInput)
          gameTextInput = GameTextInput_init(env);
        ...
    }
    
  2. Utwórz klasę Java InputEnabledTextView z dostępem do InputConnection.

    public class InputEnabledTextView extends View implements Listener {
      public InputConnection mInputConnection;
      public InputEnabledTextView(Context context, AttributeSet attrs) {
        super(context, attrs);
      }
    
      public InputEnabledTextView(Context context) {
        super(context);
      }
      public void createInputConnection(int inputType) {
        EditorInfo editorInfo = new EditorInfo();
        editorInfo.inputType = inputType;
        editorInfo.actionId = IME_ACTION_NONE;
        editorInfo.imeOptions = IME_FLAG_NO_FULLSCREEN;
        mInputConnection = new InputConnection(this.getContext(), this,
                new Settings(editorInfo, true)
        ).setListener(this);
      }
    
      @Override
      public InputConnection onCreateInputConnection(EditorInfo outAttrs) {
        if (outAttrs != null) {
            GameTextInput.copyEditorInfo(mInputConnection.getEditorInfo(), outAttrs);
        }
        return mInputConnection;
      }
    
      // Called when the IME input changes.
      @Override
      public void stateChanged(State newState, boolean dismissed) {
        onTextInputEventNative(newState);
      }
      @Override
      public void onImeInsetsChanged(Insets insets) {
        // handle Inset changes here
      }
    
      private native void onTextInputEventNative(State softKeyboardEvent);
    }
    
  3. Dodaj utworzony element InputEnabledTextView do układu interfejsu. Na przykład ten kod w activity_main.xml może umieścić baner u dołu ekranu:

    <com.android.example.gametextinputjava.InputEnabledTextView
        android:id="@+id/input_enabled_text_view"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintStart_toStartOf="parent" />
    
  4. Pobierz instancję InputEnabledTextView w aktywności Java. Jest to stosunkowo proste, gdy używasz wiązania widoku:

    public class MainActivity extends AppCompatActivity {
      ...
      private ActivityMainBinding binding;
      private InputEnabledTextView inputEnabledTextView;
    
      private native void setInputConnectionNative(InputConnection c);
    
      @Override
      protected void onCreate(Bundle savedInstanceState) {
        ...
        binding = ActivityMainBinding.inflate(getLayoutInflater());
        inputEnabledTextView = binding.inputEnabledTextView;
        inputEnabledTextView.createInputConnection(InputType.TYPE_CLASS_TEXT);
        setInputConnectionNative(inputEnabledTextView.mInputConnection);
      }
    
  5. W bibliotece C przekaż inputConnection do GameTextInput_setInputConnection. Przekaż wywołanie zwrotne w GameTextInput_setEventCallback, aby otrzymywać powiadomienia o zdarzeniach jako strukturę stanu C GameTextInputState.

    extern "C"JNIEXPORT void JNICALL
    Java_com_gametextinput_testbed_MainActivity_setInputConnectionNative(
      JNIEnv *env, jobject this, jobject inputConnection) {
      GameTextInput_setInputConnection(gameTextInput, inputConnection);
      GameTextInput_setEventCallback(gameTextInput,[](void *ctx, const GameTexgtInputState *state) {
        if (!env || !state) return;
        // process the newly arrived text input from user.
        __android_log_print(ANDROID_LOG_INFO, "TheGreateGameTextInput", state->text_UTF8);
      }, env);
    }
    
  6. W bibliotece C wywołaj funkcję GameTextInput_processEvent, która wewnętrznie wywołuje funkcję wywołania zwrotnego zarejestrowaną w poprzednim kroku, aby aplikacja mogła obsługiwać zdarzenia, gdy stan się zmieni.

    extern "C"
    JNIEXPORT void JNICALL
    Java_com_gametextinput_testbed_InputEnabledTextView_onTextInputEventNative(
      JNIEnv* env, jobject this, jobject soft_keyboard_event) {
      GameTextInput_processEvent(gameTextInput, soft_keyboard_event);
    }
    

Funkcje użytkowe

Biblioteka GameTextInput zawiera funkcje użytkowe, które umożliwiają konwersję między obiektami stanu Javy a strukturami stanu C. Dostęp do funkcji wyświetlania i ukrywania edytora IME można uzyskać za pomocą funkcji GameTextInput_showIme i GameTextInput_hideIme.

Odniesienia

Deweloperzy mogą uznać te informacje za przydatne podczas tworzenia aplikacji za pomocą GameTextInput:

Prześlij opinię

Jeśli masz problemy lub pytania dotyczące GameTextInput, zgłoś błąd w narzędziu Google IssueTracker.