Allow to install assets containing a variant.

Author: D8H

Diff for: Core/GDCore/Project/EventsBasedObjectVariant.cpp

@@ -18,6 +18,7 @@ EventsBasedObjectVariant::~EventsBasedObjectVariant() {}
 
 void EventsBasedObjectVariant::SerializeTo(SerializerElement &element) const {
   element.SetAttribute("name", name);
+  element.SetAttribute("assetStoreId", GetAssetStoreId());
   element.SetIntAttribute("areaMinX", areaMinX);
   element.SetIntAttribute("areaMinY", areaMinY);
   element.SetIntAttribute("areaMinZ", areaMinZ);
@@ -38,6 +39,7 @@ void EventsBasedObjectVariant::SerializeTo(SerializerElement &element) const {
 void EventsBasedObjectVariant::UnserializeFrom(
     gd::Project &project, const SerializerElement &element) {
   name = element.GetStringAttribute("name");
+  assetStoreId = element.GetStringAttribute("assetStoreId");
   areaMinX = element.GetIntAttribute("areaMinX", 0);
   areaMinY = element.GetIntAttribute("areaMinY", 0);
   areaMinZ = element.GetIntAttribute("areaMinZ", 0);

Diff for: Core/GDCore/Project/EventsBasedObjectVariant.h

@@ -19,7 +19,7 @@ class Project;
 namespace gd {
 /**
  * \brief Represents a variation of style of an events-based object.
- * 
+ *
  * \ingroup PlatformDefinition
  */
 class GD_CORE_API EventsBasedObjectVariant {
@@ -178,6 +178,16 @@ class GD_CORE_API EventsBasedObjectVariant {
   void SetAreaMaxZ(int areaMaxZ_) { areaMaxZ = areaMaxZ_; }
   ///@}
 
+  /** \brief Change the asset store id of the object.
+   */
+  void SetAssetStoreId(const gd::String &assetStoreId_) {
+    assetStoreId = assetStoreId_;
+  };
+
+  /** \brief Return the asset store id of the object.
+   */
+  const gd::String &GetAssetStoreId() const { return assetStoreId; };
+
   void SerializeTo(SerializerElement &element) const;
 
   void UnserializeFrom(gd::Project &project, const SerializerElement &element);
@@ -193,6 +203,10 @@ class GD_CORE_API EventsBasedObjectVariant {
   double areaMaxX;
   double areaMaxY;
   double areaMaxZ;
+  /**
+   * The ID of the asset if the object comes from the store.
+   */
+  gd::String assetStoreId;
 };
 
 } // namespace gd

Diff for: GDevelop.js/Bindings/Bindings.idl

@@ -3185,6 +3185,8 @@ interface EventsBasedObjectVariant {
     void SetAreaMaxX(double value);
     void SetAreaMaxY(double value);
     void SetAreaMaxZ(double value);
+    void SetAssetStoreId([Const] DOMString assetStoreId);
+    [Const, Ref] DOMString GetAssetStoreId();
 
     void SerializeTo([Ref] SerializerElement element);
     void UnserializeFrom([Ref] Project project, [Const, Ref] SerializerElement element);

Diff for: GDevelop.js/types.d.ts

@@ -2312,6 +2312,8 @@ export class EventsBasedObjectVariant extends EmscriptenObject {
   setAreaMaxX(value: number): void;
   setAreaMaxY(value: number): void;
   setAreaMaxZ(value: number): void;
+  setAssetStoreId(assetStoreId: string): void;
+  getAssetStoreId(): string;
   serializeTo(element: SerializerElement): void;
   unserializeFrom(project: Project, element: SerializerElement): void;
 }

Diff for: GDevelop.js/types/gdeventsbasedobjectvariant.js

@@ -18,6 +18,8 @@ declare class gdEventsBasedObjectVariant {
   setAreaMaxX(value: number): void;
   setAreaMaxY(value: number): void;
   setAreaMaxZ(value: number): void;
+  setAssetStoreId(assetStoreId: string): void;
+  getAssetStoreId(): string;
   serializeTo(element: gdSerializerElement): void;
   unserializeFrom(project: gdProject, element: gdSerializerElement): void;
   delete(): void;

Diff for: newIDE/app/src/AssetStore/InstallAsset.js

@@ -153,6 +153,19 @@ export type InstallAssetArgs = {|
   targetObjectFolderOrObject?: ?gdObjectFolderOrObject,
 |};
 
+const findVariant = (
+  container: gdEventsBasedObjectVariantsContainer,
+  assetStoreId: string
+): gdEventsBasedObjectVariant | null => {
+  for (let index = 0; index < container.getVariantsCount(); index++) {
+    const variant = container.getVariantAt(index);
+    if (variant.getAssetStoreId()) {
+      return variant;
+    }
+  }
+  return null;
+};
+
 export const addAssetToProject = async ({
   asset,
   project,
@@ -168,6 +181,36 @@ export const addAssetToProject = async ({
     const type: ?string = objectAsset.object.type;
     if (!type) throw new Error('An object has no type specified');
 
+    let variantName: string | null = null;
+    const serializedVariant = objectAsset.variant;
+    const isCustomObjectWithVariant =
+      serializedVariant && project.hasEventsBasedObject(type);
+    if (isCustomObjectWithVariant && serializedVariant) {
+      const eventsBasedObject = project.getEventsBasedObject(type);
+      const variants = eventsBasedObject.getVariants();
+      variantName = serializedVariant.name;
+      let variant = findVariant(variants, serializedVariant.assetStoreId);
+      if (!variant) {
+        // TODO Forbid name with `::`
+        const uniqueNewName = newNameGenerator(variantName, tentativeNewName =>
+          variants.hasVariantNamed(tentativeNewName)
+        );
+        variant = variants.insertNewVariant(
+          uniqueNewName,
+          variants.getVariantsCount()
+        );
+        variantName = uniqueNewName;
+      }
+      unserializeFromJSObject(
+        variant,
+        serializedVariant,
+        'unserializeFrom',
+        project
+      );
+      variant.setName(variantName);
+      variant.setAssetStoreId(asset.id);
+    }
+
     // Insert the object
     const originalName = sanitizeObjectName(objectAsset.object.name);
     const newName = newNameGenerator(originalName, name =>
@@ -204,6 +247,15 @@ export const addAssetToProject = async ({
     );
 
     object.setAssetStoreId(asset.id);
+    if (isCustomObjectWithVariant && variantName) {
+      const customObjectConfiguration = gd.asCustomObjectConfiguration(
+        object.getConfiguration()
+      );
+      customObjectConfiguration.setVariantName(variantName);
+      customObjectConfiguration.setMarkedAsOverridingEventsBasedObjectChildrenConfiguration(
+        false
+      );
+    }
     // The name was overwritten after unserialization.
     object.setName(newName);
 

Diff for: newIDE/app/src/ObjectsRendering/Renderers/RenderedCustomObjectInstance.js

@@ -1,6 +1,7 @@
 // @flow
 import RenderedInstance from './RenderedInstance';
 import Rendered3DInstance from './Rendered3DInstance';
+import RenderedUnknownInstance from './RenderedUnknownInstance';
 import PixiResourcesLoader from '../PixiResourcesLoader';
 import ResourcesLoader from '../../ResourcesLoader';
 import ObjectsRenderingService from '../ObjectsRenderingService';
@@ -153,21 +154,34 @@ export default class RenderedCustomObjectInstance extends Rendered3DInstance
   ): RenderedInstance | Rendered3DInstance => {
     let renderedInstance = this.renderedInstances.get(instance.ptr);
     if (!renderedInstance) {
-      const customObjectConfiguration = gd.asCustomObjectConfiguration(
-        this._associatedObjectConfiguration
-      );
-      //No renderer associated yet, the instance must have been just created!...
-      const childObjectConfiguration = customObjectConfiguration.getChildObjectConfiguration(
-        instance.getObjectName()
-      );
+      // No renderer associated yet, the instance must have been just created!...
+      let childObjectConfiguration = null;
+      const variant = this.getVariant();
+      if (variant) {
+        const childObjects = variant.getObjects();
+        if (childObjects.hasObjectNamed(instance.getObjectName())) {
+          childObjectConfiguration = childObjects
+            .getObject(instance.getObjectName())
+            .getConfiguration();
+        }
+      }
       //...so let's create a renderer.
-      renderedInstance = ObjectsRenderingService.createNewInstanceRenderer(
-        this._project,
-        instance,
-        childObjectConfiguration,
-        this._pixiObject,
-        this._threeObject
-      );
+      renderedInstance = childObjectConfiguration
+        ? ObjectsRenderingService.createNewInstanceRenderer(
+            this._project,
+            instance,
+            childObjectConfiguration,
+            this._pixiObject,
+            this._threeObject
+          )
+        : new RenderedUnknownInstance(
+            this._project,
+            instance,
+            // $FlowFixMe It's not actually used.
+            null,
+            this._pixiObject,
+            PixiResourcesLoader
+          );
       this.renderedInstances.set(instance.ptr, renderedInstance);
     }
     return renderedInstance;

Diff for: newIDE/app/src/Utils/GDevelopServices/Asset.js

@@ -45,6 +45,7 @@ export type ExtensionDependency = {|
 export type ObjectAsset = {|
   object: any /*(serialized gdObjectConfiguration)*/,
   resources: Array<any /*(serialized gdResource)*/>,
+  variant?: any /*(serialized gdEventsBasedObjectVariant)*/,
   // TODO This can become mandatory after the migration of the asset repository.
   requiredExtensions?: Array<ExtensionDependency>,
 |};