Update docs to reflect changes to Plugins

Author: mafiesto4

manual/release-notes/1_4/index.md

@@ -10,6 +10,13 @@
 
 We refactored actors' `PostLoad`/`PostSpawn` methods into `Initialize` and changed the script `OnAwake` event to be called during this initialization phase - before any `OnStart`/`OnEnable` logic. This helps to create gameplay systems in a scheme of manager+objects where the manager can use `OnAwake` to initialize properly, and `OnEnable` can be used to register objects to the manager. This change has no performance impact but might be important to address in existing Flax projects.
 
+### Plugins scripting changes
+
+For this update, we've added support for implementing Game Plugins in C++ scripts - previously it was C#-only feature. For this change, both `GamePlugin` and `EditorPlugin` has been slightly modified:
+* `Description` getter is read-only and your plugin can fill `_description` field in the constructor to set up plugin info.
+* `OnCollectAssets` has been renamed to `GetReferences` and returns the list of Guids with referenced assets.
+We've updated docs and code examples to reflect those changes.
+
 ### Large Worlds
 
 Adding 64-bit precision to the world coordinates to the Flax was a challenge. Both Engine and Editor have very complex and mature systems with tooling thus we wanted to make this transition seamless and stable. One of the goals was to don't bloat memory by just doubling every floating-point value but instead upgrade world-coordinates-related data to support very large worlds. For instance, 32-bit float gives us enough precision to represent object rotation and scale thus we upgraded only `Translation` (aka `Position`) of the `Transform` to a 64-bit double vector. Also, the UI system, mesh data, textures converter, and other engine features were changed to keep explicitly *Float* vectors for performance reasons.

manual/scripting/advanced/cert-store.md

@@ -40,15 +40,18 @@ public sealed class CertStore : GamePlugin
 {
     // Reference: https://github.com/mono/mono/blob/main/mcs/tools/security/mozroots.cs
 
-    /// <inheritdoc />
-    public override PluginDescription Description => new PluginDescription
+    public CertStore()
     {
-        Name = "Cert Store",
-        Category = "Other",
-        Description = "Trusted certificates store utility.",
-        Author = "Flax",
-        AuthorUrl = "https://flaxengine.com/",
-    };
+        // Initialize plugin description
+        _description = new PluginDescription
+        {
+            Name = "Cert Store",
+            Category = "Other",
+            Description = "Trusted certificates store utility.",
+            Author = "Flax",
+            AuthorUrl = "https://flaxengine.com/",
+        };
+    }
 
     /// <inheritdoc />
     public override void Initialize()
@@ -119,13 +122,11 @@ public sealed class CertStore : GamePlugin
 
 #if FLAX_EDITOR
     /// <inheritdoc />
-    public override void OnCollectAssets(System.Collections.Generic.List<Guid> assets)
+    public override Guid[] GetReferences()
     {
-        base.OnCollectAssets(assets);
-
         // Reference cached certificates asset
         var asset = InitAsset();
-        assets.Add(asset.ID);
+        return new Guid[1] { asset.ID };
     }
 #endif
 

manual/scripting/plugins/index.md

@@ -60,17 +60,21 @@ There are two types of plugins:
 
 **Game Plugins** are type of plugin that can be used at runtime. Game plugins are deployed with the game and can extend the engine by adding new features. Plugins can contain custom scripts that can be used in a game. To create a simple game plugin use the following code example:
 
+# [C#](#tab/code-csharp)
 ```cs
 public class MyPlugin : GamePlugin
 {
-    /// <inheritdoc />
-    public override PluginDescription Description => new PluginDescription
+    public MyPlugin()
     {
-        Name = "My Plugin",
-        Category = "Other",
-        Description = "This is my custom plugin made for Flax.",
-        Author = "Someone Inc.",
-    };
+        // Initialize plugin description
+        _description = new PluginDescription
+        {
+            Name = "My Plugin",
+            Category = "Other",
+            Description = "This is my custom plugin made for Flax.",
+            Author = "Someone Inc.",
+        };
+    }
 
     /// <inheritdoc />
     public override void Initialize()
@@ -89,6 +93,47 @@ public class MyPlugin : GamePlugin
     }
 }
 ```
+# [C++](#tab/code-cpp)
+```cpp
+// .h
+#pragma once
+
+#include "Engine/Scripting/Plugins/GamePlugin.h"
+
+API_CLASS() class GAME_API MyPlugin : public GamePlugin
+{
+    DECLARE_SCRIPTING_TYPE(MyPlugin);
+
+    void Initialize() override;
+    void Deinitialize() override;
+};
+
+// .cpp
+#include "MyPlugin.h"
+#include "Engine/Core/Log.h"
+
+MyPlugin::MyPlugin(const SpawnParams& params)
+    : GamePlugin(params)
+{
+    // Initialize plugin description
+    _description.Name = TEXT("My Plugin");
+    _description.Category = TEXT("Other");
+    _description.Description = TEXT("This is my custom plugin made for Flax.");
+    _description.Author = TEXT("Someone Inc.");
+}
+
+void MyPlugin::Initialize()
+{
+    LOG(Info, "Plugin initialization!");
+}
+
+void MyPlugin::Deinitialize()
+{
+    LOG(Info, "Plugin cleanup!");
+}
+
+```
+***
 
 Your game can also use a Game Plugins within a code to implement various gameplay features because plugins don't rely on loaded scenes or scene objects and are created before the scenes loading (compared to the normal scripts).
 
@@ -98,14 +143,14 @@ If you need to include custom settings for your plugin see [this tutorial](../tu
 
 ### Game Plugin Assets
 
-If you want to bundle custom assets used in code-only plugin (eg. shader or debug model) override `OnCollectAssets` method as follows and provide IDs of the assets to include:
+If you want to bundle custom assets used in code-only plugin (eg. shader or debug model) override `GetReferences` method as follows and provide IDs of the assets to include:
 
 ```cs
 #if FLAX_EDITOR
 /// <inheritdoc />
-public override void OnCollectAssets(System.Collections.Generic.List<Guid> assets)
+public override Guid[] GetReferences()
 {
-    base.OnCollectAssets(assets);
+    var assets = new System.Collections.Generic.List<Guid>();
 
     // Add asset ID to the list
     assets.Add(ShaderId);
@@ -114,6 +159,9 @@ public override void OnCollectAssets(System.Collections.Generic.List<Guid> asset
     var path = Path.Combine(Globals.ProjectFolder, "Plugins/MyPlugin/Content/MyCustomDebugModel.flax");
     Content.GetAssetInfo(path, out var info);
     assets.Add(info.ID);
+
+    return assets.ToArray();
+}
 #endif
 ```