Added new example, documentation changed

Author: ProFiLeR4100

README.md

@@ -10,31 +10,33 @@ Makes it easier to add custom inspector controls to nodes.
 
 Download the project and copy the addon folder into your godot project.
 
-Go to Project Settings > Plugins, and enable Extendable Inspector.
+Go to Project Settings > Plugins, and enable Extendable Inspector (C#).
 
 # Quick Start / Tutorial
 
 Let's add a button that prints the node name in godot's output:
-- Choose the node that should have this control, make sure its script has the `@tool` annotation at the beginning, [this allows it to run code while in the editor](https://docs.godotengine.org/en/stable/tutorials/plugins/running_code_in_the_editor.html).
+- Choose the node that should have this control, make sure its script has the `[Tool]` attribute at the class declaration, [this allows it to run code while in the editor](https://docs.godotengine.org/en/stable/tutorials/plugins/running_code_in_the_editor.html).
 ![image](https://github.com/ProFiLeR4100/ExtendableInspectorForCS/assets/11432672/7c84f2c1-e64f-40ee-a3f0-ef6f858eb78f)
-- Define a method called `_extend_inspector_begin` that receives a parameter, let's call that parameter `inspector`. If you want, you can type it as `ExtendableInspector` to get some autocomplete features:
+- Define a method called `ExtendInspectorBegin` that receives a parameter, let's call that parameter `inspector`. If you want, you can type it as `ExtendableInspector` to get some autocomplete features:
 ![image](https://github.com/ProFiLeR4100/ExtendableInspectorForCS/assets/11432672/65f90976-adeb-4607-9d58-46fa214c2f0f)
-- Create a button that when pressed, it prints the node's name. Then, simply add it to the inspector with `inspector.add_custom_control(a_control)`. You will have to unfocus the node and focus it again for the button to appear:
+- Create a button that when pressed, it prints the node's name. Then, simply add it to the inspector with `inspector.AddCustomControl(ourNewControl)`. You will have to unfocus the node and focus it again for the button to appear:
 ![image](https://github.com/ProFiLeR4100/ExtendableInspectorForCS/assets/11432672/2d4e62ef-7dcf-4cc5-b74c-c26bde55c70a)
 
 Here's the entire code in case you want to try it out:
 
-```godot
-@tool
-
-extends Node2D
-
-func _extend_inspector_begin(inspector: ExtendableInspector):
-  var button = Button.new()
-  button.text = "Say your name"
-  button.pressed.connect(func(): print(self.name))
-
-  inspector.add_custom_control(button)
+```csharp
+using Godot;
+
+[Tool]
+public partial class SayYourName : Node2D {
+    public void ExtendInspectorBegin(ExtendableInspector inspector) {
+        Button button = new() {
+            Text = "Say your name"
+        };
+        button.Pressed += () => GD.Print(Name);
+        inspector.AddCustomControl(button);
+    }
+}
 ```
 
 
@@ -46,34 +48,29 @@ The supported methods are analogous to methods that can be defined in an `Editor
 https://docs.godotengine.org/en/latest/classes/class_editorinspectorplugin.html#class-editorinspectorplugin-method-add-property-editor-for-multiple-properties
 
 These methods are:
-```godot
-void _extend_inspector_begin(inspector: ExtendableInspector)
+```csharp
+void ExtendInspectorBegin(ExtendableInspector inspector)
 ```
 Allows adding controls at the beginning of the inspector.
 
-```godot
-void _extend_inspector_end(inspector: ExtendableInspector)
+```csharp
+void ExtendInspectorEnd(ExtendableInspector inspector)
 ```
 
 Allows adding controls at the end of the inspector.
 
-```godot
-bool _extend_inspector_category(inspector: ExtendableInspector, category: String)
+```csharp
+void ExtendInspectorCategory(inspector: ExtendableInspector, string category)
 ```
 
 Allows adding controls at the beginning of a category in the property list for object.
 
-```godot
-void _extend_inspector_property(inspector: ExtendableInspector, object: Object, type: int, name: String, hint_type: int, hint_string: String, usage_flags: int, wide: bool)
+```csharp
+bool ExtendInspectorProperty(ExtendableInspector inspector, Variant.Type type, string name, PropertyHint hintType, string hintString, PropertyUsageFlags usageFlags, bool wide)
 ```
 
 Allows adding property-specific editors to the property list for object. The added editor control must extend `EditorProperty`. Returning `true` removes the built-in editor for this property, otherwise allows to insert a custom editor before the built-in one.
 
 ## Examples
 
 Examples can be found in the [example folder](https://github.com/ProFiLeR4100/ExtendableInspectorForCS/tree/godot-4/addons/extendable_inspector_for_cs/example)
-
-## Utils
-
-This plugin has a core folder that adds the functionality to let you extend the inspector with any custom control you define from your own scripts.
-Apart from that, there's a `utils` folder that defines some already made controls that can be added to the inspector.

addons/extendable_inspector_for_cs/example/ChangeRandomColor/ChangeRandomColor.cs

@@ -1,6 +1,6 @@
 using Godot;
 
-[GlobalClass, Tool]
+[Tool]
 public partial class ChangeRandomColor : Node {
 	public void ChangeToRandomColor() {
 		CsgBox3D box = GetNode<CsgBox3D>("CSGBox3D");

addons/extendable_inspector_for_cs/example/SpiralCurveCreator/SpiralCurveCreator.cs

@@ -1,6 +1,6 @@
 using Godot;
 
-[GlobalClass, Tool]
+[Tool]
 public partial class SpiralCurveCreator : Node3D {
 	[Export] public float Radius { get; set; } = 5;
 
@@ -11,7 +11,7 @@ public partial class SpiralCurveCreator : Node3D {
 	Path3D path;
 
 	public void DrawEspiral() {
-		Curve3D curve = GetPath().Curve;
+		Curve3D curve = GetPathNode().Curve;
 		curve.ClearPoints();
 		float angle = 0;
 		float y = 0;
@@ -26,7 +26,7 @@ public void DrawEspiral() {
 		}
 	}
 
-	private Path3D GetPath() {
+	private Path3D GetPathNode() {
 		if (!HasNode("Path3D")) {
 			Path3D path = new Path3D();
 			AddChild(path);

addons/extendable_inspector_for_cs/example/SpiralCurveCreator/SpiralCurveCreator.tscn

@@ -4,14 +4,14 @@
 
 [sub_resource type="Curve3D" id="1"]
 _data = {
-"points": PackedVector3Array(0, 0, 0, 0, 0, 0, 5, 0, 0, 0, 0, 0, 0, 0, 0, 3.53553, 0.05, 3.53553, 0, 0, 0, 0, 0, 0, -2.18557e-07, 0.1, 5, 0, 0, 0, 0, 0, 0, -3.53553, 0.15, 3.53553, 0, 0, 0, 0, 0, 0, -5, 0.2, -4.37114e-07, 0, 0, 0, 0, 0, 0, -3.53553, 0.25, -3.53553, 0, 0, 0, 0, 0, 0, 5.96244e-08, 0.3, -5, 0, 0, 0, 0, 0, 0, 3.53553, 0.35, -3.53553, 0, 0, 0, 0, 0, 0, 5, 0.4, -1.50996e-06, 0, 0, 0, 0, 0, 0, 3.53554, 0.45, 3.53553, 0, 0, 0, 0, 0, 0, 3.07954e-06, 0.5, 5, 0, 0, 0, 0, 0, 0, -3.53553, 0.55, 3.53554, 0, 0, 0, 0, 0, 0, -5, 0.6, -1.19249e-07, 0, 0, 0, 0, 0, 0, -3.53553, 0.65, -3.53554, 0, 0, 0, 0, 0, 0, 3.31804e-06, 0.7, -5, 0, 0, 0, 0, 0, 0, 3.53554, 0.75, -3.53553, 0, 0, 0, 0, 0, 0, 5, 0.8, 6.51683e-06, 0, 0, 0, 0, 0, 0, 3.53553, 0.85, 3.53554, 0, 0, 0, 0, 0, 0, -9.71562e-06, 0.9, 5, 0, 0, 0, 0, 0, 0, -3.53554, 0.95, 3.53553),
+"points": PackedVector3Array(0, 0, 0, 0, 0, 0, 5, 0, 0, 0, 0, 0, 0, 0, 0, 3.53553, 0.1, 3.53553, 0, 0, 0, 0, 0, 0, -2.18557e-07, 0.2, 5, 0, 0, 0, 0, 0, 0, -3.53553, 0.3, 3.53553, 0, 0, 0, 0, 0, 0, -5, 0.4, -4.37114e-07, 0, 0, 0, 0, 0, 0, -3.53553, 0.5, -3.53553, 0, 0, 0, 0, 0, 0, 5.96244e-08, 0.6, -5, 0, 0, 0, 0, 0, 0, 3.53553, 0.7, -3.53553, 0, 0, 0, 0, 0, 0, 5, 0.8, -1.50996e-06, 0, 0, 0, 0, 0, 0, 3.53554, 0.9, 3.53553, 0, 0, 0, 0, 0, 0, 3.07954e-06, 1, 5, 0, 0, 0, 0, 0, 0, -3.53553, 1.1, 3.53554, 0, 0, 0, 0, 0, 0, -5, 1.2, -1.19249e-07, 0, 0, 0, 0, 0, 0, -3.53553, 1.3, -3.53554, 0, 0, 0, 0, 0, 0, 3.31804e-06, 1.4, -5, 0, 0, 0, 0, 0, 0, 3.53554, 1.5, -3.53553, 0, 0, 0, 0, 0, 0, 5, 1.6, 6.51683e-06, 0, 0, 0, 0, 0, 0, 3.53553, 1.7, 3.53554, 0, 0, 0, 0, 0, 0, -9.71562e-06, 1.8, 5, 0, 0, 0, 0, 0, 0, -3.53554, 1.9, 3.53553),
 "tilts": PackedFloat32Array(0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0)
 }
 point_count = 20
 
 [node name="SpiralCurveCreator" type="Node3D"]
 script = ExtResource("1_ypj6y")
-Height = 1.0
+Height = 2.0
 AmountOfPoints = 20.0
 
 [node name="Path3D" type="Path3D" parent="."]