GameActivity 中的文本输入   属于 Android 游戏开发套件 的一部分。

GameActivity 通过以下方式集成 GameTextInput

  • 提供一个包装器
  • 创建一个用于新文本输入事件可用性的标志
  • 直接使用 GameTextInput 的状态缓冲区作为文本内容

如下图所示,应用程序使用不同的内部逻辑组件用于用户文本输入目的

alt_text

使用内置GameTextInput库有三个主要步骤

  • 控制 UI 上的软键盘
  • 了解何时有新文本可用
  • 检索用户输入文本及其状态

本文档的其余部分将详细描述它们。有关GameTextInputGameActivity结合使用的示例,请参阅games-samples 存储库

控制 UI 上的软键盘

GameActivity提供两个函数来控制 UI 上的软键盘

请参阅 API 参考文档以了解其定义。显示键盘后,应用程序的 UI 可能类似于以下内容

alt_text

检查文本可用性

软键盘事件从 Java 端的GameTextInput传递到 C/C++ 端通过 JNI,然后传递到 GameActivity 的包装器,最终反映在android_app::textInputState标志中,该标志在native_app_glue中实现。应用程序应定期轮询此标志以执行预期的处理

  • GameActivity 仅设置android_app::textInputState标志。
  • 应用程序轮询标志并处理新的GameTextInput事件,例如添加到输入缓冲区的新文本。
  • 应用程序清除android_app::textInputState

请注意,android_app::textInputState不区分单个和多个文本输入事件。

例如,以下代码在处理应用程序循环命令、触摸事件和按键事件后轮询textInputState标志

while (true) {
   // Read all pending events.
   int events;
   struct android_poll_source* source;

   while ((ALooper_pollAll(engine.animating ? 0 : -1, nullptr, &events,
                                 (void**)&source)) >= 0) {
       // Process this event, etc.
       ...
       // Check if we are exiting.
       if (app->destroyRequested != 0) {
           engine_term_display(&engine);
           return;
       }
   }
   engine_handle_input(app);

   // Process text input events if there is any outstanding.
   if (app->textInputState) {
       // process TextInput events.
          ...
       //reset the textInputState flag
       app->textInputState = 0;
   }
   if (engine.animating) {
         // draw frames.
   }
}

检索用户输入文本

输入文本和其他状态累积在 GameTextInput 的内部缓冲区GameTextInput::currentState_中。应用程序可以使用以下方法之一来检索其内容

  • GameActivity 的包装器 API(推荐)
  • GameTextInput API

使用 GameActivity API 获取 TextInput 状态

应用程序使用典型的回调机制获取当前文本输入

继续上一节中的代码片段,以下代码获取对文本输入缓冲区的引用,处理它(未显示),并重置事件标志

extern "C" void GameTextInputGetStateCB(void *ctx, const struct GameTextInputState *state) {
    auto* engine = (struct engine*)ctx;
    if (!engine || !state) return;

    // Process the text event(s).
    LOGI("UserInputText: %s", state->text_UTF8);

    // Clear the text input flag.
    engine->app->textInputState = 0;
}

在上一节中显示的游戏循环中,使用上述文本输入处理程序检查和处理文本

if (state->textInputState) {
    GameActivity_getTextInputState(
        app->activity,
        GameTextInputGetStateCB,  // App's event handler shown above.
        &engine // Context to the GameTextInputGetStateCB function.
    );
}

应用程序可以选择使用GameActivity_setTextInputState()初始化GameTextInputState内容。

使用 GameTextInput API 获取 TextInput 状态

应用程序还可以直接使用GameTextInputAPI 来检索当前的GameTextInputState

再次注意,应用程序不应直接初始化GameTextInputGameActivity在其初始化过程中已经完成了此操作。

回调机制与 GameActivity 的GameActivity_getTextInputState()函数使用的机制相同。

参考

在创建GameActivity应用程序时,开发人员可能会发现以下资源很有帮助

反馈

GameActivity 和 GameTextInput 都是 Jetpack 游戏库的一部分。对于任何问题,请在Google IssueTracker 上创建一个错误