feat: add support for updating form

xiaoqch · xiaoqch · commit c9de01e14927 · 2025-05-10T14:41:26.000+08:00
diff --git a/docs/apis/GuiAPI/Form.md b/docs/apis/GuiAPI/Form.md
@@ -13,7 +13,7 @@ for a specific player object `pl`, the following form interfaces are available:
 
 A modal form contains a title, a text display, and two buttons.
 
-`pl.sendModalForm(title,content,confirmButton,cancelButton,callback)`
+`pl.sendModalForm(title,content,confirmButton,cancelButton,callback,forUpdating)`
 
 - Parameters:
     - title : `String`  
@@ -26,6 +26,8 @@ A modal form contains a title, a text display, and two buttons.
       Button 2 text.
     - callback : `Function`  
       Function called after player clicks a button.
+    - forUpdating : `Boolean`
+      Whether the form is sent for updating.
 - Return value: The ID of the sent form.
 - Return value type: `Integer`
     - If the return value is `Null`, it means the sending failed.
@@ -49,7 +51,7 @@ set.
 Due to the relatively complex content setup of buttons, it is recommended to use the form builder API in the next
 section to better accomplish this task.
 
-`pl.sendSimpleForm(title,content,buttons,images,callback)`
+`pl.sendSimpleForm(title,content,buttons,images,callback,forUpdating)`
 
 - Parameters:
     - title : `String`  
@@ -62,6 +64,8 @@ section to better accomplish this task.
       Image path corresponding to each button.
     - callback : `Function`  
       The function called after the player clicks a button.
+    - forUpdating : `Boolean`
+      Whether the form is sent for updating.
 - Return value: The sent form ID.
 - Return value type: `Integer`
     - If the return value is `Null`, it means the sending failed.
@@ -91,13 +95,15 @@ Custom forms can contain rich custom controls.
 Since the relevant JSON definition format is relatively complex, it is recommended to use the form builder API in the
 next section to better accomplish this task.
 
-`pl.sendCustomForm(json,callback)`
+`pl.sendCustomForm(json,callback,forUpdating)`
 
 - Parameters:
     - json : `String`  
       Custom form JSON string.
     - callback : `Function`  
       Callback function to be called after the player submits the form.
+    - forUpdating : `Boolean`
+      Whether the form is sent for updating.
 - Return value: The sent form ID.
 - Return value type: `Integer`
     - If the return value is Null, it means the sending failed.
diff --git a/docs/apis/GuiAPI/Form.zh.md b/docs/apis/GuiAPI/Form.zh.md
@@ -12,7 +12,7 @@
 
 模式表单包含一个标题、一个文本显示框以及两个按钮
 
-`pl.sendModalForm(title,content,confirmButton,cancelButton,callback)`
+`pl.sendModalForm(title,content,confirmButton,cancelButton,callback,forUpdating)`
 
 - 参数：
     - title : `String`  
@@ -25,6 +25,8 @@
       按钮2文本的字符串
     - callback : `Function`  
       玩家点击按钮之后被调用的回调函数。
+    - forUpdating : `Boolean`
+      是否为表单更新
 - 返回值：发送的表单ID
 - 返回值类型：`Integer`
     - 如果返回值为`Null`，则代表发送失败
@@ -46,7 +48,7 @@
 普通表单包含一个标题、一个文本显示框以及若干按钮，可以设置按钮上显示的图标  
 由于按钮的内容设置相对复杂，建议使用下一节的表单构建器API更好地完成这项任务。
 
-`pl.sendSimpleForm(title,content,buttons,images,callback)`
+`pl.sendSimpleForm(title,content,buttons,images,callback,forUpdating)`
 
 - 参数：
     - title : `String`  
@@ -59,6 +61,8 @@
       各个按钮对应的图片路径
     - callback : `Function`  
       玩家点击按钮之后被调用的回调函数。
+    - forUpdating : `Boolean`
+      是否为表单更新。
 - 返回值：发送的表单ID
 - 返回值类型：`Integer`
     - 如果返回值为`Null`，则代表发送失败
@@ -87,13 +91,15 @@
 自定义表单可以包含丰富的自定义控件。  
 由于相关JSON定义格式相对复杂，建议使用下一节的表单构建器API更好地完成这项任务。
 
-`pl.sendCustomForm(json,callback)`
+`pl.sendCustomForm(json,callback,forUpdating)`
 
 - 参数：
     - json : `String`  
       自定义表单json字符串
     - callback : `Function`  
       玩家提交表单之后被调用的回调函数。
+    - forUpdating : `Boolean`
+      是否为表单更新。
 - 返回值：发送的表单ID
 - 返回值类型：`Integer`
     - 如果返回值为`Null`，则代表发送失败
diff --git a/docs/apis/GuiAPI/FormBuilder.md b/docs/apis/GuiAPI/FormBuilder.md
@@ -93,13 +93,15 @@ are called when there is player interaction, without fighting.
 
 For a player object `pl`, using the function:
 
-`pl.sendForm(fm,callback)`
+`pl.sendForm(fm,callback.forUpdating)`
 
 - Parameters:
     - fm : `SimpleForm`  
       The configured form object.
     - callback : `Function`  
       Callback function to be called after the player interacts with the form element.
+    - forUpdating : `Boolean`
+      Whether the form is sent for updating.
 - Return value: The sent form ID.
 - Return value type: `Integer`
     - If the return value is `Null`, it means the sending failed.
@@ -263,13 +265,15 @@ are called when there is player interaction, without fighting.
 
 For a player object `pl`, using the function:
 
-`pl.sendForm(fm,callback)`
+`pl.sendForm(fm,callback,forUpdating)`
 
 - Parameters:
     - fm : `CustomForm`  
       Configured custom form object.
     - callback : `Function`  
       Callback function to be called after the player submits the form.
+    - forUpdating : `Boolean`
+      Whether the form is sent for updating.
 - Return value: The sent form ID.
 - Return value type: `Integer`
     - If the return value is `Null`, it means the sending failed.
diff --git a/docs/apis/GuiAPI/FormBuilder.zh.md b/docs/apis/GuiAPI/FormBuilder.zh.md
@@ -93,13 +93,15 @@
 
 对于某个玩家对象`pl`，使用函数：
 
-`pl.sendForm(fm,callback)`
+`pl.sendForm(fm,callback,forUpdating)`
 
 - 参数：
     - fm : `SimpleForm`  
       配置好的表单对象
     - callback : `Function`  
       玩家与表单元素互动之后被调用的回调函数。
+    - forUpdating : `Boolean`
+      是否为表单更新
 - 返回值：发送的表单ID
 - 返回值类型：`Integer`
     - 如果返回值为`Null`，则代表发送失败
@@ -260,13 +262,15 @@ reason可能会是`null`.
 
 对于某个玩家对象`pl`，使用函数：
 
-`pl.sendForm(fm,callback)`
+`pl.sendForm(fm,callback,forUpdating)`
 
 - 参数：
     - fm : `CustomForm`  
       配置好的自定义表单对象
     - callback : `Function`  
       玩家提交表单之后被调用的回调函数。
+    - forUpdating : `Boolean`
+      是否为表单更新
 - 返回值：发送的表单ID
 - 返回值类型：`Integer`
     - 如果返回值为`Null`，则代表发送失败
diff --git a/src/legacy/api/PlayerAPI.cpp b/src/legacy/api/PlayerAPI.cpp
@@ -45,6 +45,7 @@
 #include "mc/network/ConnectionRequest.h"
 #include "mc/network/MinecraftPacketIds.h"
 #include "mc/network/MinecraftPackets.h"
+#include "mc/network/NetEventCallback.h"
 #include "mc/network/ServerNetworkHandler.h"
 #include "mc/network/packet/BossEventPacket.h"
 #include "mc/network/packet/LevelChunkPacket.h"
@@ -2435,16 +2436,18 @@ Local<Value> PlayerClass::removeBossBar(const Arguments& args) {
 }
 
 Local<Value> PlayerClass::sendSimpleForm(const Arguments& args) {
-    CHECK_ARGS_COUNT(args, 4);
+    CHECK_ARGS_COUNT(args, 5);
     CHECK_ARG_TYPE(args[0], ValueKind::kString);
     CHECK_ARG_TYPE(args[1], ValueKind::kString);
     CHECK_ARG_TYPE(args[2], ValueKind::kArray);
     CHECK_ARG_TYPE(args[3], ValueKind::kArray);
     CHECK_ARG_TYPE(args[4], ValueKind::kFunction);
+    if (args.size() > 5) CHECK_ARG_TYPE(args[5], ValueKind::kBoolean);
 
     try {
         Player* player = get();
         if (!player) return Local<Value>();
+        bool update = args.size() > 5 ? args[5].asBoolean().value() : false;
 
         // 普通格式
         auto textsArr = args[2].asArray();
@@ -2463,26 +2466,25 @@ Local<Value> PlayerClass::sendSimpleForm(const Arguments& args) {
                 form.appendButton(textsArr.get(i).asString().toString());
             }
         }
-        form.sendTo(
-            *player,
-            [engine{EngineScope::currentEngine()},
-             callback{script::Global(args[4].asFunction())
-             }](Player& pl, int chosen, ll::form::FormCancelReason reason) {
-                if ((ll::getGamingStatus() != ll::GamingStatus::Running)) return;
-                if (!EngineManager::isValid(engine)) return;
-
-                EngineScope scope(engine);
-                try {
-                    callback.get().call(
-                        {},
-                        PlayerClass::newPlayer(&pl),
-                        chosen >= 0 ? Number::newNumber(chosen) : Local<Value>(),
-                        reason.has_value() ? Number::newNumber((uchar)reason.value()) : Local<Value>()
-                    );
-                }
-                CATCH_IN_CALLBACK("sendSimpleForm")
+        auto formCallback = [engine{EngineScope::currentEngine()},
+                             callback{script::Global(args[4].asFunction())
+                             }](Player& pl, int chosen, ll::form::FormCancelReason reason) {
+            if ((ll::getGamingStatus() != ll::GamingStatus::Running)) return;
+            if (!EngineManager::isValid(engine)) return;
+
+            EngineScope scope(engine);
+            try {
+                callback.get().call(
+                    {},
+                    PlayerClass::newPlayer(&pl),
+                    chosen >= 0 ? Number::newNumber(chosen) : Local<Value>(),
+                    reason.has_value() ? Number::newNumber((uchar)reason.value()) : Local<Value>()
+                );
             }
-        );
+            CATCH_IN_CALLBACK("sendSimpleForm")
+        };
+        if (update) form.sendUpdate(*player, std::move(formCallback));
+        else form.sendTo(*player, std::move(formCallback));
 
         return Number::newNumber(1);
     }
@@ -2496,37 +2498,40 @@ Local<Value> PlayerClass::sendModalForm(const Arguments& args) {
     CHECK_ARG_TYPE(args[2], ValueKind::kString);
     CHECK_ARG_TYPE(args[3], ValueKind::kString);
     CHECK_ARG_TYPE(args[4], ValueKind::kFunction);
+    if (args.size() > 5) CHECK_ARG_TYPE(args[5], ValueKind::kBoolean);
 
     try {
         Player* player = get();
         if (!player) return Local<Value>();
+        bool update = args.size() > 5 ? args[5].asBoolean().value() : false;
 
         ll::form::ModalForm form(
             args[0].asString().toString(),
             args[1].asString().toString(),
             args[2].asString().toString(),
             args[3].asString().toString()
         );
-        form.sendTo(
-            *player,
-            [engine{EngineScope::currentEngine()},
-             callback{script::Global(args[4].asFunction())
-             }](Player& pl, ll::form::ModalFormResult const& chosen, ll::form::FormCancelReason reason) {
-                if ((ll::getGamingStatus() != ll::GamingStatus::Running)) return;
-                if (!EngineManager::isValid(engine)) return;
-
-                EngineScope scope(engine);
-                try {
-                    callback.get().call(
-                        {},
-                        PlayerClass::newPlayer(&pl),
-                        chosen ? Boolean::newBoolean(static_cast<bool>(*chosen)) : Local<Value>(),
-                        reason.has_value() ? Number::newNumber((uchar)reason.value()) : Local<Value>()
-                    );
-                }
-                CATCH_IN_CALLBACK("sendModalForm")
+        auto formCallback = [engine{EngineScope::currentEngine()},
+                             callback{script::Global(args[4].asFunction())
+                             }](Player& pl, ll::form::ModalFormResult const& chosen, ll::form::FormCancelReason reason
+                            ) {
+            if ((ll::getGamingStatus() != ll::GamingStatus::Running)) return;
+            if (!EngineManager::isValid(engine)) return;
+
+            EngineScope scope(engine);
+            try {
+                callback.get().call(
+                    {},
+                    PlayerClass::newPlayer(&pl),
+                    chosen ? Boolean::newBoolean(static_cast<bool>(*chosen)) : Local<Value>(),
+                    reason.has_value() ? Number::newNumber((uchar)reason.value()) : Local<Value>()
+                );
             }
-        );
+            CATCH_IN_CALLBACK("sendModalForm")
+        };
+
+        if (update) form.sendUpdate(*player, std::move(formCallback));
+        else form.sendTo(*player, std::move(formCallback));
 
         return Number::newNumber(2);
     }
@@ -2537,20 +2542,19 @@ Local<Value> PlayerClass::sendCustomForm(const Arguments& args) {
     CHECK_ARGS_COUNT(args, 2);
     CHECK_ARG_TYPE(args[0], ValueKind::kString);
     CHECK_ARG_TYPE(args[1], ValueKind::kFunction);
+    if (args.size() > 2) CHECK_ARG_TYPE(args[2], ValueKind::kBoolean);
 
     try {
         Player* player = get();
         if (!player) return Local<Value>();
+        bool update = args.size() > 2 ? args[2].asBoolean().value() : false;
 
         auto formData = ordered_json::parse(args[0].asString().toString());
-        ll::form::Form::sendRawTo(
-            *player,
-            formData.dump(),
+        auto formCallback =
             [id{player->getOrCreateUniqueID()},
              engine{EngineScope::currentEngine()},
              callback{script::Global(args[1].asFunction())},
-             formData = std::move(formData
-             )](Player& player, std::optional<std::string> const& result, ll::form::FormCancelReason reason) {
+             formData](Player& player, std::optional<std::string> const& result, ll::form::FormCancelReason reason) {
                 if ((ll::getGamingStatus() != ll::GamingStatus::Running)) return;
                 if (!EngineManager::isValid(engine)) return;
                 auto newResult = lse::form::CustomFormWrapper::convertResult(result, formData);
@@ -2565,8 +2569,10 @@ Local<Value> PlayerClass::sendCustomForm(const Arguments& args) {
                     );
                 }
                 CATCH_IN_CALLBACK("sendCustomForm")
-            }
-        );
+            };
+        if (update) ll::form::Form::sendRawUpdate(*player, formData.dump(), std::move(formCallback));
+        else ll::form::Form::sendRawTo(*player, formData.dump(), std::move(formCallback));
+
         return Number::newNumber(3);
     } catch (const ordered_json::exception& e) {
         lse::LegacyScriptEngine::getInstance().getSelf().getLogger().error(
@@ -2581,17 +2587,19 @@ Local<Value> PlayerClass::sendCustomForm(const Arguments& args) {
 Local<Value> PlayerClass::sendForm(const Arguments& args) {
     CHECK_ARGS_COUNT(args, 2);
     CHECK_ARG_TYPE(args[1], ValueKind::kFunction);
+    if (args.size() > 2) CHECK_ARG_TYPE(args[2], ValueKind::kBoolean);
 
     try {
         Player* player = get();
         if (!player) return Local<Value>();
+        bool update = args.size() > 2 ? args[2].asBoolean().value() : false;
 
         if (IsInstanceOf<SimpleFormClass>(args[0])) {
             Local<Function> callback = args[1].asFunction();
-            SimpleFormClass::sendForm(SimpleFormClass::extract(args[0]), player, callback);
+            SimpleFormClass::sendForm(SimpleFormClass::extract(args[0]), player, callback, update);
         } else if (IsInstanceOf<CustomFormClass>(args[0])) {
             Local<Function> callback = args[1].asFunction();
-            CustomFormClass::sendForm(CustomFormClass::extract(args[0]), player, callback);
+            CustomFormClass::sendForm(CustomFormClass::extract(args[0]), player, callback, update);
         } else {
             LOG_WRONG_ARG_TYPE(__FUNCTION__);
             return Local<Value>();
