Events based behaviors 🚀

.vscode/c_cpp_properties.json

@@ -4,15 +4,13 @@
             "name": "Mac",
             "includePath": [
                 "${workspaceRoot}",
-                "${workspaceRoot}/IDE",
                 "${workspaceRoot}/GDCpp",
                 "${workspaceRoot}/GDJS",
                 "${workspaceRoot}/Extensions",
                 "${workspaceRoot}/Core",
                 "${workspaceRoot}/ExtLibs/SFML/include",
                 "/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/include/c++/v1",
                 "/usr/local/include",
-                "/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/lib/clang/9.0.0/include",
                 "/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/include",
                 "/usr/include",
                 "${workspaceRoot}"
@@ -28,7 +26,6 @@
                 "path": [
                     "/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/include/c++/v1",
                     "/usr/local/include",
-                    "/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/lib/clang/9.0.0/include",
                     "/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/include",
                     "/usr/include",
                     "${workspaceRoot}"
@@ -108,4 +105,4 @@
         }
     ],
     "version": 4
-}
+}

.vscode/settings.json

@@ -79,7 +79,8 @@
         "mutex": "cpp",
         "__hash": "cpp",
         "__debug": "cpp",
-        "__threading_support": "cpp"
+        "__threading_support": "cpp",
+        "any": "cpp"
     },
     "files.exclude": {
         "Binaries/*build*": true,

Core/GDCore/Events/CodeGeneration/EventsCodeGenerator.cpp

@@ -537,6 +537,7 @@ gd::String EventsCodeGenerator::GenerateActionCode(
                             action.GetParameters().size() < 2
                                 ? ""
                                 : action.GetParameter(1).GetPlainString());
+
   if (MetadataProvider::HasBehaviorAction(
           platform, behaviorType, action.GetType()) &&
       instrInfos.parameters.size() >= 2) {

Core/GDCore/Events/CodeGeneration/EventsCodeGenerator.h

@@ -239,11 +239,6 @@ class GD_CORE_API EventsCodeGenerator {
     customCodeOutsideMain += code;
   };
 
-  /**
-   * \brief Add some code before events in the main function.
-   */
-  void AddCustomCodeInMain(gd::String code) { customCodeInMain += code; };
-
   /** \brief Get the set containing the include files.
    */
   const std::set<gd::String>& GetIncludeFiles() const { return includeFiles; }
@@ -254,10 +249,6 @@ class GD_CORE_API EventsCodeGenerator {
     return customCodeOutsideMain;
   }
 
-  /** \brief Get the custom code to be inserted inside main function.
-   */
-  const gd::String& GetCustomCodeInMain() const { return customCodeInMain; }
-
   /** \brief Get the custom declaration to be inserted after includes.
    */
   const std::set<gd::String>& GetCustomGlobalDeclaration() const {
@@ -734,8 +725,6 @@ class GD_CORE_API EventsCodeGenerator {
                      ///< can share the same list.
   gd::String customCodeOutsideMain;  ///< Custom code inserted before events (
                                      ///< and not in events function )
-  gd::String customCodeInMain;  ///< Custom code inserted before events ( in
-                                ///< main function )
   std::set<gd::String>
       customGlobalDeclarations;     ///< Custom global C++ declarations inserted
                                     ///< after includes

Core/GDCore/Events/Event.h

@@ -266,9 +266,6 @@ class GD_CORE_API BaseEvent {
   float percentDuringLastSession;  ///< Total time used by the event during the
                                    ///< last run. Used for profiling.
 
- protected:
-  mutable unsigned int renderedHeight;
-
  private:
   bool folded;  ///< True if the subevents should be hidden in the events editor
   bool disabled;    ///< True if the event is disabled and must not be executed

Core/GDCore/Events/Instruction.cpp

@@ -16,22 +16,15 @@ namespace gd {
 gd::Expression Instruction::badExpression("");
 
 Instruction::Instruction(gd::String type_)
-    : renderedHeightNeedUpdate(true),
-      renderedHeight(0),
-      selected(false),
-      type(type_),
+    : type(type_),
       inverted(false) {
-  // ctor
   parameters.reserve(8);
 }
 
 Instruction::Instruction(gd::String type_,
                          const std::vector<gd::Expression>& parameters_,
                          bool inverted_)
-    : renderedHeightNeedUpdate(true),
-      renderedHeight(0),
-      selected(false),
-      type(type_),
+    : type(type_),
       inverted(inverted_),
       parameters(parameters_) {
   parameters.reserve(8);

Core/GDCore/Events/Instruction.h

@@ -17,7 +17,7 @@ namespace gd {
  * action.
  *
  * An instruction has a type, which define what it does, and some parameters. It
- * can also be set as inverted ( when the instruction is a condition ) and it
+ * can also be set as inverted (when the instruction is a condition) and it
  * can have sub instructions. This class does nothing particular except storing
  * these data.
  *
@@ -131,20 +131,6 @@ class GD_CORE_API Instruction {
    */
   inline gd::InstructionsList& GetSubInstructions() { return subInstructions; };
 
-  /** \name Rendering
-   * Members related to the instruction rendering in an event editor.
-   */
-  ///@{
-
-  mutable bool
-      renderedHeightNeedUpdate;  ///< True if the instruction height may have
-                                 ///< changed and must be computed again.
-  mutable unsigned int renderedHeight;  ///< Height of the instruction rendered
-                                        ///< in an event editor.
-  mutable bool selected;  ///< True if selected in an event editor.
-
-  ///@}
-
  private:
   gd::String type;  ///< Instruction type
   bool inverted;  ///< True if the instruction if inverted. Only applicable for

Core/GDCore/Extensions/Builtin/AdvancedExtension.cpp

@@ -56,7 +56,7 @@ void GD_CORE_API BuiltinExtensionsImplementer::ImplementsAdvancedExtension(
           _("Functions"),
           "res/function24.png",
           "res/function16.png")
-      .AddParameter("expression", "The text to be returned")
+      .AddParameter("string", "The text to be returned")
       .MarkAsAdvanced();
 
   extension

Core/GDCore/Extensions/Metadata/BehaviorMetadata.cpp

@@ -4,8 +4,8 @@
  * reserved. This project is released under the MIT License.
  */
 #include "BehaviorMetadata.h"
-#include <algorithm>
 #include <iostream>
+#include "GDCore/Extensions/PlatformExtension.h"
 #include "GDCore/Extensions/Metadata/ExpressionMetadata.h"
 #include "GDCore/Extensions/Metadata/InstructionMetadata.h"
 #include "GDCore/Project/Behavior.h"
@@ -88,6 +88,52 @@ gd::InstructionMetadata& BehaviorMetadata::AddAction(
 #endif
 }
 
+gd::InstructionMetadata& BehaviorMetadata::AddScopedCondition(
+    const gd::String& name,
+    const gd::String& fullname,
+    const gd::String& description,
+    const gd::String& sentence,
+    const gd::String& group,
+    const gd::String& icon,
+    const gd::String& smallicon) {
+#if defined(GD_IDE_ONLY)
+  gd::String nameWithNamespace = GetName() +gd::PlatformExtension::GetNamespaceSeparator() +  name;
+  conditionsInfos[nameWithNamespace] = InstructionMetadata(extensionNamespace,
+                                                           nameWithNamespace,
+                                                           fullname,
+                                                           description,
+                                                           sentence,
+                                                           group,
+                                                           icon,
+                                                           smallicon)
+                                           .SetHelpPath(GetHelpPath());
+  return conditionsInfos[nameWithNamespace];
+#endif
+}
+
+gd::InstructionMetadata& BehaviorMetadata::AddScopedAction(
+    const gd::String& name,
+    const gd::String& fullname,
+    const gd::String& description,
+    const gd::String& sentence,
+    const gd::String& group,
+    const gd::String& icon,
+    const gd::String& smallicon) {
+#if defined(GD_IDE_ONLY)
+  gd::String nameWithNamespace = GetName() + gd::PlatformExtension::GetNamespaceSeparator() + name;
+  actionsInfos[nameWithNamespace] = InstructionMetadata(extensionNamespace,
+                                                        nameWithNamespace,
+                                                        fullname,
+                                                        description,
+                                                        sentence,
+                                                        group,
+                                                        icon,
+                                                        smallicon)
+                                        .SetHelpPath(GetHelpPath());
+  return actionsInfos[nameWithNamespace];
+#endif
+}
+
 gd::ExpressionMetadata& BehaviorMetadata::AddExpression(
     const gd::String& name,
     const gd::String& fullname,
@@ -162,4 +208,8 @@ BehaviorMetadata& BehaviorMetadata::AddIncludeFile(
   return *this;
 }
 
+const gd::String& BehaviorMetadata::GetName() const {
+  return instance->GetTypeName();
+}
+
 }  // namespace gd

Core/GDCore/Extensions/Metadata/BehaviorMetadata.h

@@ -19,11 +19,7 @@ class ExpressionMetadata;
 namespace gd {
 
 /**
- * \brief Contains user-friendly information about a behavior type
- *
- * Implementations may derive from this class so as to provide more complete
- * metadata if needed. ( For example, GDevelop C++ Platform is shared pointers
- * to objects that will be cloned so as to create the behaviors... )
+ * \brief Contains user-friendly information about a behavior type.
  *
  * \ingroup Events
  */
@@ -44,7 +40,8 @@ class GD_CORE_API BehaviorMetadata {
   virtual ~BehaviorMetadata(){};
 
   /**
-   * Declare a new condition as being part of the extension.
+   * Declare a new condition as being part of the behavior.
+   * \deprecated Prefer using `AddScopedCondition`.
    */
   gd::InstructionMetadata& AddCondition(const gd::String& name_,
                                         const gd::String& fullname_,
@@ -55,7 +52,8 @@ class GD_CORE_API BehaviorMetadata {
                                         const gd::String& smallicon_);
 
   /**
-   * Declare a new action as being part of the extension.
+   * Declare a new action as being part of the behavior.
+   * \deprecated Prefer using `AddScopedAction`.
    */
   gd::InstructionMetadata& AddAction(const gd::String& name_,
                                      const gd::String& fullname_,
@@ -64,6 +62,28 @@ class GD_CORE_API BehaviorMetadata {
                                      const gd::String& group_,
                                      const gd::String& icon_,
                                      const gd::String& smallicon_);
+
+  /**
+   * Declare a new condition as being part of the behavior.
+   */
+  gd::InstructionMetadata& AddScopedCondition(const gd::String& name_,
+                                        const gd::String& fullname_,
+                                        const gd::String& description_,
+                                        const gd::String& sentence_,
+                                        const gd::String& group_,
+                                        const gd::String& icon_,
+                                        const gd::String& smallicon_);
+
+  /**
+   * Declare a new action as being part of the behavior.
+   */
+  gd::InstructionMetadata& AddScopedAction(const gd::String& name_,
+                                     const gd::String& fullname_,
+                                     const gd::String& description_,
+                                     const gd::String& sentence_,
+                                     const gd::String& group_,
+                                     const gd::String& icon_,
+                                     const gd::String& smallicon_);
   /**
    * Declare a new action as being part of the extension.
    */
@@ -102,29 +122,54 @@ class GD_CORE_API BehaviorMetadata {
   /**
    * Get the help path of the behavior, relative to the documentation root.
    */
-  const gd::String &GetHelpPath() const { return helpPath; }
+  const gd::String& GetHelpPath() const { return helpPath; }
 
   /**
    * Set the help path of the behavior, relative to the documentation root.
-   * 
+   *
    * The behavior instructions will have this help path set by
    * default, unless you call SetHelpPath on them.
    */
-  BehaviorMetadata &SetHelpPath(const gd::String &path) {
+  BehaviorMetadata& SetHelpPath(const gd::String& path) {
     helpPath = path;
     return *this;
   }
 
+  const gd::String& GetName() const;
 #if defined(GD_IDE_ONLY)
   const gd::String& GetFullName() const { return fullname; }
   const gd::String& GetDefaultName() const { return defaultName; }
   const gd::String& GetDescription() const { return description; }
   const gd::String& GetGroup() const { return group; }
   const gd::String& GetIconFilename() const { return iconFilename; }
+
+  /**
+   * \brief Set the type of the object that this behavior can be used on.
+   */
+  BehaviorMetadata& SetObjectType(const gd::String& objectType_) {
+    objectType = objectType_;
+    return *this;
+  }
+
+  /**
+   * \brief Get the type of the object that this behavior can be used on.
+   *
+   * \note An empty string means the base object, so any object.
+   */
+  const gd::String& GetObjectType() const { return objectType; }
 #endif
-  std::shared_ptr<gd::Behavior> Get() const { return instance; }
-  std::shared_ptr<gd::BehaviorsSharedData> GetSharedDataInstance() const {
-    return sharedDatasInstance;
+
+  /**
+   * \brief Return the associated gd::Behavior, handling behavior contents.
+   */
+  gd::Behavior& Get() const { return *instance; }
+
+  /**
+   * \brief Return the associated gd::BehaviorsSharedData, handling behavior
+   * shared data, if any (nullptr if none).
+   */
+  gd::BehaviorsSharedData* GetSharedDataInstance() const {
+    return sharedDatasInstance.get();
   }
 
 #if defined(GD_IDE_ONLY)
@@ -145,8 +190,10 @@ class GD_CORE_API BehaviorMetadata {
   gd::String description;
   gd::String group;
   gd::String iconFilename;
+  gd::String objectType;
 #endif
 
+  // TODO: Nitpicking: convert these to std::unique_ptr to clarify ownership.
   std::shared_ptr<gd::Behavior> instance;
   std::shared_ptr<gd::BehaviorsSharedData> sharedDatasInstance;
 };