GodotTool 1.0.5

GodotTool

Tool for Godot game developers.

• GodotTool
  • Install
  • Usage
  • Features
    • Generate Nodes

Install

dotnet tool install --global GodotTool --version 1.0.5

Usage

Description:

Usage:
  GodotTool [command] [options]

Options:
  --version       Show version information
  -?, -h, --help  Show help and usage information

Commands:
  nodes <filepaths>  Generates partial class with all nodes for the given *.tscn file with existing associated script. []

Features

Generate Nodes

Generates strongly typed properties for every node in the given *.tscn file.

Generates file with the following attributes:

• Name [AssociatedScriptName].Nodes.cs
  • Ex. for Main.tscn with Main.cs the generated file will be named Main.Nodes.cs
• Usings
  • Adds Godot using
  • Adds all necessary usings gathered from all dependant scripts
• Namespace that correspondents with the namespace found in the associated script
• Partial class for the associated script (class) with:
  • Properies for every found nodes in the source *.tscn file
  • Public Initialize() method that should be call from _Ready() method in the main class
    • Contains Initializations for all nodes found

Command: nodes

Arguments: list of strings that are file paths of *.tscn files or nothing to go through all *.tscn files in project

Examples:

godottool nodes

godottool nodes .\Main.tscn

godottool nodes .\Main.tscn .\Components\Component.tscn

Generated partial class format:

using Godot;

//
// GENERATES: dependency usings
//

namespace MyProject;

public partial class Main
{
    //
    // GENERATES: node properties
    // 
    // Format:
    //
    // public [NodeType] [NodeName] { get; set; }
    //

    public Node MyNode { get; set;}

    public void Initialize()
    {
        //
        // GENERATES: node initializations
        // 
        // Format:
        //
        // [NodeName] = GetNode<[NodeType]>("[NodePath]");
        //

        MyNode = GetNode<Node>("./MyNode");
    }
}

Notes:

• In the case of file scoped namespace it will generate *.Nodes.cs file also with file scoped namespace
• In the case of block scoped namespace it will generate *.Nodes.cs file also with block scoped namespace
• If the source class is not partial (in the case of Godot 3.5.x) the keyword will be added