Keep variants when updating an extension.

Author: D8H

Core/GDCore/Project/EventsBasedObject.cpp

@@ -22,7 +22,8 @@ EventsBasedObject::EventsBasedObject()
 
 EventsBasedObject::~EventsBasedObject() {}
 
-void EventsBasedObject::SerializeTo(SerializerElement& element) const {
+
+void EventsBasedObject::SerializeToExternal(SerializerElement& element) const {
   element.SetAttribute("defaultName", defaultName);
   if (isRenderedIn3D) {
     element.SetBoolAttribute("is3D", true);
@@ -42,7 +43,10 @@ void EventsBasedObject::SerializeTo(SerializerElement& element) const {
   // AbstractEventsBasedEntity::SerializeTo must be done after.
   defaultVariant.SerializeTo(element);
   AbstractEventsBasedEntity::SerializeTo(element);
+}
 
+void EventsBasedObject::SerializeTo(SerializerElement& element) const {
+  SerializeToExternal(element);
   variants.SerializeVariantsTo(element.AddChild("variants"));
 }
 
@@ -58,7 +62,9 @@ void EventsBasedObject::UnserializeFrom(gd::Project& project,
   defaultVariant.UnserializeFrom(project, element);
   AbstractEventsBasedEntity::UnserializeFrom(project, element);
 
-  variants.UnserializeVariantsFrom(project, element.GetChild("variants"));
+  if (element.HasChild("variants")) {
+    variants.UnserializeVariantsFrom(project, element.GetChild("variants"));
+  }
 
   if (element.HasChild("isUsingLegacyInstancesRenderer")) {
     isUsingLegacyInstancesRenderer =

Core/GDCore/Project/EventsBasedObject.h

@@ -341,6 +341,12 @@ class GD_CORE_API EventsBasedObject: public AbstractEventsBasedEntity {
     defaultVariant.SetAreaMaxZ(areaMaxZ);
   }
   ///@}
+  
+  /**
+   * @brief Serialize the events-based object for an extension in an external file.
+   * Variants are not serialized.
+   */
+  void SerializeToExternal(SerializerElement& element) const;
 
   void SerializeTo(SerializerElement& element) const override;
 

Core/GDCore/Project/EventsFunctionsExtension.cpp

@@ -55,7 +55,7 @@ void EventsFunctionsExtension::Init(const gd::EventsFunctionsExtension& other) {
   sceneVariables = other.GetSceneVariables();
 }
 
-void EventsFunctionsExtension::SerializeTo(SerializerElement& element) const {
+void EventsFunctionsExtension::SerializeTo(SerializerElement& element, bool isExternal) const {
   element.SetAttribute("version", version);
   element.SetAttribute("extensionNamespace", extensionNamespace);
   element.SetAttribute("shortDescription", shortDescription);
@@ -102,8 +102,18 @@ void EventsFunctionsExtension::SerializeTo(SerializerElement& element) const {
       element.AddChild("eventsFunctions"));
   eventsBasedBehaviors.SerializeElementsTo(
       "eventsBasedBehavior", element.AddChild("eventsBasedBehaviors"));
-  eventsBasedObjects.SerializeElementsTo(
-      "eventsBasedObject", element.AddChild("eventsBasedObjects"));
+  if (isExternal) {
+    auto &eventsBasedObjectElement = element.AddChild("eventsBasedObjects");
+    eventsBasedObjectElement.ConsiderAsArrayOf("eventsBasedObject");
+    for (const auto &eventsBasedObject :
+         eventsBasedObjects.GetInternalVector()) {
+      eventsBasedObject->SerializeToExternal(
+          eventsBasedObjectElement.AddChild("eventsBasedObject"));
+    }
+  } else {
+    eventsBasedObjects.SerializeElementsTo(
+        "eventsBasedObject", element.AddChild("eventsBasedObjects"));
+  }
 }
 
 void EventsFunctionsExtension::UnserializeFrom(

Core/GDCore/Project/EventsFunctionsExtension.h

@@ -286,7 +286,14 @@ class GD_CORE_API EventsFunctionsExtension {
   /**
    * \brief Serialize the EventsFunctionsExtension to the specified element
    */
-  void SerializeTo(gd::SerializerElement& element) const;
+  void SerializeTo(gd::SerializerElement& element, bool isExternal = false) const;
+
+  /**
+   * \brief Serialize the EventsFunctionsExtension to the specified element
+   */
+  void SerializeToExternal(gd::SerializerElement& element) const {
+    SerializeTo(element, true);
+  }
 
   /**
    * \brief Load the EventsFunctionsExtension from the specified element.

Core/GDCore/Project/Project.cpp

@@ -920,6 +920,7 @@ void Project::UnserializeAndInsertExtensionsFrom(
       "eventsFunctionsExtension");
 
   std::map<gd::String, size_t> extensionNameToElementIndex;
+  std::map<gd::String, gd::SerializerElement> objectTypeToVariantsElement;
 
   // First, only unserialize behaviors and objects names.
   // As event based objects can contains custom behaviors and custom objects,
@@ -938,6 +939,16 @@ void Project::UnserializeAndInsertExtensionsFrom(
             ? GetEventsFunctionsExtension(name)
             : InsertNewEventsFunctionsExtension(
                   name, GetEventsFunctionsExtensionsCount());
+
+    // Backup the events-based object variants
+    for (auto &eventsBasedObject :
+         eventsFunctionsExtension.GetEventsBasedObjects().GetInternalVector()) {
+      gd::SerializerElement variantsElement;
+      eventsBasedObject->GetVariants().SerializeVariantsTo(variantsElement);
+      objectTypeToVariantsElement[gd::PlatformExtension::GetObjectFullType(
+          name, eventsBasedObject->GetName())] = variantsElement;
+    }
+
     eventsFunctionsExtension.UnserializeExtensionDeclarationFrom(
         *this, eventsFunctionsExtensionElement);
   }
@@ -966,6 +977,15 @@ void Project::UnserializeAndInsertExtensionsFrom(
     partiallyLoadedExtension
         ->UnserializeExtensionImplementationFrom(
             *this, eventsFunctionsExtensionElement);
+
+    for (auto &pair : objectTypeToVariantsElement) {
+      auto &objectType = pair.first;
+      auto &variantsElement = pair.second;
+
+      auto &eventsBasedObject = GetEventsBasedObject(objectType);
+      eventsBasedObject.GetVariants().UnserializeVariantsFrom(*this,
+                                                              variantsElement);
+    }
   }
 }
 

GDevelop.js/Bindings/Bindings.idl

@@ -3299,6 +3299,7 @@ interface EventsFunctionsExtension {
     [Ref] EventsBasedObjectsList GetEventsBasedObjects();
 
     void SerializeTo([Ref] SerializerElement element);
+    void SerializeToExternal([Ref] SerializerElement element);
     void UnserializeFrom([Ref] Project project, [Const, Ref] SerializerElement element);
 
     boolean STATIC_IsExtensionLifecycleEventsFunction([Const] DOMString eventsFunctionName);

GDevelop.js/types.d.ts

@@ -2405,6 +2405,7 @@ export class EventsFunctionsExtension extends EmscriptenObject {
   getEventsBasedBehaviors(): EventsBasedBehaviorsList;
   getEventsBasedObjects(): EventsBasedObjectsList;
   serializeTo(element: SerializerElement): void;
+  serializeToExternal(element: SerializerElement): void;
   unserializeFrom(project: Project, element: SerializerElement): void;
   static isExtensionLifecycleEventsFunction(eventsFunctionName: string): boolean;
 }

GDevelop.js/types/gdeventsfunctionsextension.js

@@ -40,6 +40,7 @@ declare class gdEventsFunctionsExtension {
   getEventsBasedBehaviors(): gdEventsBasedBehaviorsList;
   getEventsBasedObjects(): gdEventsBasedObjectsList;
   serializeTo(element: gdSerializerElement): void;
+  serializeToExternal(element: gdSerializerElement): void;
   unserializeFrom(project: gdProject, element: gdSerializerElement): void;
   static isExtensionLifecycleEventsFunction(eventsFunctionName: string): boolean;
   delete(): void;

newIDE/app/src/EventsFunctionsExtensionsLoader/Storage/BrowserEventsFunctionsExtensionWriter.js

@@ -32,7 +32,10 @@ export default class BrowserEventsFunctionsExtensionWriter {
     extension: gdEventsFunctionsExtension,
     filename: string
   ): Promise<void> => {
-    const serializedObject = serializeToJSObject(extension);
+    const serializedObject = serializeToJSObject(
+      extension,
+      'serializeToExternal'
+    );
     try {
       await downloadStringContentAsFile(
         filename,

newIDE/app/src/EventsFunctionsExtensionsLoader/Storage/LocalEventsFunctionsExtensionWriter.js

@@ -56,7 +56,10 @@ export default class LocalEventsFunctionsExtensionWriter {
     extension: gdEventsFunctionsExtension,
     filepath: string
   ): Promise<void> => {
-    const serializedObject = serializeToJSObject(extension);
+    const serializedObject = serializeToJSObject(
+      extension,
+      'serializeToExternal'
+    );
     return writeJSONFile(serializedObject, filepath).catch(err => {
       console.error('Unable to write the events function extension:', err);
       throw err;

newIDE/app/src/Utils/Serializer.js

@@ -8,7 +8,7 @@ const gd: libGDevelop = global.gd;
  * and unserializeFrom method.
  *
  * @param {*} serializable
- * @param {*} methodName The name of the serialization method. "unserializeFrom" by default
+ * @param {*} methodName The name of the serialization method. "serializeTo" by default
  */
 export function serializeToJSObject(
   serializable: gdSerializable,