Added an example that shows how to create custom node plugins

CraigCiccone · CraigCiccone · commit 37b6f1e0d0e5 · 2020-12-16T10:12:47.000-05:00
diff --git a/README.md b/README.md
@@ -90,6 +90,7 @@ The [/examples](https://github.com/godot-rust/godot-rust/tree/master/examples) d
 - [/examples/scene_create](https://github.com/godot-rust/godot-rust/tree/master/examples/scene_create) - Shows you how to load, instance and place scenes using Rust code
 - [/examples/signals](https://github.com/godot-rust/godot-rust/tree/master/examples/signals) - Shows you how to handle signals.
 - [/examples/resource](https://github.com/godot-rust/godot-rust/tree/master/examples/resource) - Shows you how to create and use custom resources.
+- [/examples/native_plugin](https://github.com/godot-rust/godot-rust/tree/master/examples/native_plugin) - Shows you how to create custom node plugins.
 
 ## Third-party resources
 
diff --git a/examples/native_plugin/Cargo.toml b/examples/native_plugin/Cargo.toml
@@ -0,0 +1,12 @@
+[package]
+name = "native_plugin"
+version = "0.1.0"
+authors = ["The godot-rust developers"]
+publish = false
+edition = "2018"
+
+[lib]
+crate-type = ["cdylib"]
+
+[dependencies]
+gdnative = { path = "../../gdnative" }
diff --git a/examples/native_plugin/Main.tscn b/examples/native_plugin/Main.tscn
@@ -0,0 +1,14 @@
+[gd_scene load_steps=2 format=2]
+
+[ext_resource path="res://my_button.gdns" type="Script" id=1]
+
+[node name="Node2D" type="Node2D"]
+
+[node name="MyButton" type="Button" parent="."]
+margin_right = 359.0
+margin_bottom = 175.0
+text = "Click me!"
+script = ExtResource( 1 )
+__meta__ = {
+"_edit_use_anchors_": false
+}
diff --git a/examples/native_plugin/addons/my_custom_node/custom_node.gdns b/examples/native_plugin/addons/my_custom_node/custom_node.gdns
@@ -0,0 +1,8 @@
+[gd_resource type="NativeScript" load_steps=2 format=2]
+
+[ext_resource path="res://native_plugin.gdnlib" type="GDNativeLibrary" id=1]
+
+[resource]
+class_name = "CustomNode"
+library = ExtResource( 1 )
+script_class_name = "CustomNode"
diff --git a/examples/native_plugin/addons/my_custom_node/plugin.cfg b/examples/native_plugin/addons/my_custom_node/plugin.cfg
@@ -0,0 +1,7 @@
+[plugin]
+
+name="My Custom Node"
+description="A custom node made to extend the Godot Engine."
+author="Your Name"
+version="1.0.0"
+script="custom_node.gdns"
diff --git a/examples/native_plugin/default_env.tres b/examples/native_plugin/default_env.tres
@@ -0,0 +1,7 @@
+[gd_resource type="Environment" load_steps=2 format=2]
+
+[sub_resource type="ProceduralSky" id=1]
+
+[resource]
+background_mode = 2
+background_sky = SubResource( 1 )
diff --git a/examples/native_plugin/icon.png b/examples/native_plugin/icon.png
diff --git a/examples/native_plugin/icon.png.import b/examples/native_plugin/icon.png.import
@@ -0,0 +1,34 @@
+[remap]
+
+importer="texture"
+type="StreamTexture"
+path="res://.import/icon.png-487276ed1e3a0c39cad0279d744ee560.stex"
+metadata={
+"vram_texture": false
+}
+
+[deps]
+
+source_file="res://icon.png"
+dest_files=[ "res://.import/icon.png-487276ed1e3a0c39cad0279d744ee560.stex" ]
+
+[params]
+
+compress/mode=0
+compress/lossy_quality=0.7
+compress/hdr_mode=0
+compress/bptc_ldr=0
+compress/normal_map=0
+flags/repeat=0
+flags/filter=true
+flags/mipmaps=false
+flags/anisotropic=false
+flags/srgb=2
+process/fix_alpha_border=true
+process/premult_alpha=false
+process/HDR_as_SRGB=false
+process/invert_color=false
+stream=false
+size_limit=0
+detect_3d=true
+svg/scale=1.0
diff --git a/examples/native_plugin/making_plugins-custom_node_icon.png b/examples/native_plugin/making_plugins-custom_node_icon.png
diff --git a/examples/native_plugin/making_plugins-custom_node_icon.png.import b/examples/native_plugin/making_plugins-custom_node_icon.png.import
@@ -0,0 +1,34 @@
+[remap]
+
+importer="texture"
+type="StreamTexture"
+path="res://.import/making_plugins-custom_node_icon.png-e44ae0012523a40f310f84bdbc218b0c.stex"
+metadata={
+"vram_texture": false
+}
+
+[deps]
+
+source_file="res://making_plugins-custom_node_icon.png"
+dest_files=[ "res://.import/making_plugins-custom_node_icon.png-e44ae0012523a40f310f84bdbc218b0c.stex" ]
+
+[params]
+
+compress/mode=0
+compress/lossy_quality=0.7
+compress/hdr_mode=0
+compress/bptc_ldr=0
+compress/normal_map=0
+flags/repeat=0
+flags/filter=true
+flags/mipmaps=false
+flags/anisotropic=false
+flags/srgb=2
+process/fix_alpha_border=true
+process/premult_alpha=false
+process/HDR_as_SRGB=false
+process/invert_color=false
+stream=false
+size_limit=0
+detect_3d=true
+svg/scale=1.0
diff --git a/examples/native_plugin/my_button.gdns b/examples/native_plugin/my_button.gdns
@@ -0,0 +1,8 @@
+[gd_resource type="NativeScript" load_steps=2 format=2]
+
+[ext_resource path="res://native_plugin.gdnlib" type="GDNativeLibrary" id=1]
+
+[resource]
+class_name = "MyButton"
+library = ExtResource( 1 )
+script_class_name = "MyButton"
diff --git a/examples/native_plugin/native_plugin.gdnlib b/examples/native_plugin/native_plugin.gdnlib
@@ -0,0 +1,18 @@
+[entry]
+
+X11.64="res://../../target/debug/libnative_plugin.so"
+OSX.64="res://../../target/debug/libnative_plugin.dylib"
+Windows.64="res://../../target/debug/native_plugin.dll"
+
+[dependencies]
+
+X11.64=[  ]
+OSX.64=[  ]
+Windows.64=[  ]
+
+[general]
+
+singleton=false
+load_once=true
+symbol_prefix="godot_"
+reloadable=true
diff --git a/examples/native_plugin/project.godot b/examples/native_plugin/project.godot
@@ -0,0 +1,39 @@
+; Engine configuration file.
+; It's best edited using the editor UI and not directly,
+; since the parameters that go here are not all obvious.
+;
+; Format:
+;   [section] ; section goes between []
+;   param=value ; assign values to parameters
+
+config_version=4
+
+_global_script_classes=[ {
+"base": "EditorPlugin",
+"class": "CustomNode",
+"language": "NativeScript",
+"path": "res://addons/my_custom_node/custom_node.gdns"
+}, {
+"base": "Button",
+"class": "MyButton",
+"language": "NativeScript",
+"path": "res://my_button.gdns"
+} ]
+_global_script_class_icons={
+"CustomNode": "",
+"MyButton": ""
+}
+
+[application]
+
+config/name="native_plugin"
+run/main_scene="res://Main.tscn"
+config/icon="res://icon.png"
+
+[editor_plugins]
+
+enabled=PoolStringArray( "my_custom_node" )
+
+[rendering]
+
+environment/default_environment="res://default_env.tres"
diff --git a/examples/native_plugin/src/lib.rs b/examples/native_plugin/src/lib.rs
@@ -0,0 +1,73 @@
+// Rust GDNative implementation of this Godot tutorial:
+// https://docs.godotengine.org/en/stable/tutorials/plugins/editor/making_plugins.html#a-custom-node
+
+use gdnative::api::{EditorPlugin, Resource, Script, Texture};
+use gdnative::prelude::*;
+
+#[derive(NativeClass)]
+#[inherit(EditorPlugin)]
+struct CustomNode;
+
+#[methods]
+impl CustomNode {
+    fn new(_owner: TRef<EditorPlugin>) -> Self {
+        CustomNode
+    }
+
+    #[export]
+    fn _enter_tree(&self, owner: TRef<EditorPlugin>) {
+        // Initialization of the plugin goes here.
+        // Add the new type with a name, a parent type, a script and an icon.
+        let script = unsafe { load::<Script>("res://my_button.gdns", "Script").unwrap() };
+        let texture = unsafe {
+            load::<Texture>("res://making_plugins-custom_node_icon.png", "Texture").unwrap()
+        };
+        owner.add_custom_type("MyButton", "Button", script, texture);
+    }
+
+    #[export]
+    fn _exit_tree(&self, owner: TRef<EditorPlugin>) {
+        // Clean-up of the plugin goes here.
+        // Always remember to remove it from the engine when deactivated.
+        owner.remove_custom_type("MyButton");
+    }
+}
+
+#[derive(NativeClass)]
+#[inherit(Button)]
+struct MyButton;
+
+#[methods]
+impl MyButton {
+    fn new(_owner: TRef<Button>) -> Self {
+        MyButton
+    }
+
+    #[export]
+    fn _enter_tree(&self, owner: TRef<Button>) {
+        owner
+            .connect("pressed", owner, "clicked", VariantArray::new_shared(), 0)
+            .unwrap();
+    }
+
+    #[export]
+    fn clicked(&self, _owner: TRef<Button>) {
+        godot_print!("You clicked me!");
+    }
+}
+
+unsafe fn load<T>(path: &str, hint: &str) -> Option<Ref<T, Shared>>
+where
+    T: GodotObject<RefKind = RefCounted> + SubClass<Resource>,
+{
+    let resource = ResourceLoader::godot_singleton().load(path, hint, false)?;
+    let resource = resource.assume_safe().claim();
+    resource.cast::<T>()
+}
+
+fn init(handle: InitHandle) {
+    handle.add_tool_class::<CustomNode>();
+    handle.add_tool_class::<MyButton>();
+}
+
+godot_init!(init);
