dilaura-exp/ezpz-inspector

Easily create a custom Inspector element, such as using [ExportButton] attribute in Godot C#.

Ezpz-Inspector

Custom Inspector helper for Godot C# script.

• Easily create a button in Inspector using [ExportButton] attribute.
• Easily add an additional label on top of a property using [UpperDescription("My description")] attribute.

Simple Button:

    [ExportButton]
    private void Increment() {
        _currentValue++;
    }

Advanced Styled Button:

    [ExportButton("Styled Button")]
    [ControlMargin(20, 20, 20, 20)]
    [ControlSize(200, 40)]
    [ControlModulateColor(0.9f, 0.1f, 0.1f, 1f)]
    private void StyledButton() {
        _currentValue++;
    }

Upper Description:

    [Export]
    [UpperDescription("This is our current value.")]
    [ControlModulateColor(0.1f, 0.9f, 0.9f, 1f)]
    private int _currentValue = 0;

How to Install

From Godot AssetLib:

• Go to AssetLib tab.
• Search "Ezpz Inspector"
• Click "Ezpz Inspector" -> Download
• Make sure to include everything inside "addons" folder, and click Install.
• Go to Project -> Project Settings.. > Plugins, and enable Ezpz Inspector.

From Github:

• Download the project or the released version.
• Copy the addon folder into your Godot project.
• Go to Project -> Project Settings.. > Plugins, and enable Ezpz Inspector.

Note: If an error occured when you click Enable, make sure to recompile the C# project first, and then try enabling again.

How to Use

• Add using Calcatz.EzpzInspector; on top of your script.
• Add [Tool] attribute on top of your class declaration. This will enable your C# script to be instantiated, thus, modifiable during edit mode.
• Add [ExportButton] attribute on top of your method declaration to create a button for that method. You can also use this for static methods. Please note that the button currently will not pass arguments.
• Add [UpperDescription("My description")] attribute on top of your field or property declaration to add additional label on top of the exported property.
• Since [Tool] attribute is used, other Godot's built-in methods will also be executed during edit mode. In this case, make sure to use Engine.IsEditorHint() to prevent your certain code from being executed during edit mode.

Here are optional attributes that you can add to do more advanced stylings:

• Add [ControlMargin] on top of your method to add margins to the button.
• Add [ControlSize] on top of your method to change the size of the button.
• Add [ControlModulateColor] on top of your method to modulate the color of the button. This will modulate based on the button style of your theme.

Note: For stylings, make sure the method also has ExportButton attribute. If target is a field or property, make sure it has UpperDescription attribute. Or else, the styling attributes will have no target.

Example

Here is an example where we can increment an integer by clicking a button.

using Godot;
using Calcatz.EzpzInspector;

[Tool]
public partial class IncrementValue : Node {

    [Export]
    [UpperDescription("This is our current value.")]
    [ControlModulateColor(0.1f, 0.9f, 0.9f, 1f)]
    private int _currentValue = 0;

    [ExportButton]
    private void Increment() {
        _currentValue++;
    }

    [ExportButton("Styled Button")]
    [ControlMargin(20, 20, 20, 20)]
    [ControlSize(200, 40)]
    [ControlModulateColor(0.9f, 0.1f, 0.1f, 1f)]
    private void StyledButton() {
        _currentValue++;
    }

    [ExportButton]
    [ControlMargin(10, 10, 10, 10)]
    private static void StaticMethod() {
        GD.Print("Static Method is called.");
    }

    // [Tool] attribute is required, but it also makes our code executed in editor.
    // In that case, if you don't want your code to be executed in editor, use Engine.IsEditorHint()

    public override void _Ready() {
        if (Engine.IsEditorHint()) return;
        // Write execution here ...
    }

    public override void _Process(double delta) {
        if (Engine.IsEditorHint()) return;
        // Write execution here ...
    }

}