Skip to content

C# [Tool] usage guidelines#12122

Open
Luna-MN wants to merge 2 commits into
godotengine:masterfrom
Luna-MN:patch-1
Open

C# [Tool] usage guidelines#12122
Luna-MN wants to merge 2 commits into
godotengine:masterfrom
Luna-MN:patch-1

Conversation

@Luna-MN

@Luna-MN Luna-MN commented Jul 2, 2026

Copy link
Copy Markdown

Added guidelines for using the [Tool] attribute in C#, including initialization of arrays, keeping constructors empty, and avoiding destructive logic in property setters. as per the current tool limitations within Godot C# godotengine/godot-proposals#9001

Added guidelines for using the [Tool] attribute in C#, including initialization of arrays, keeping constructors empty, and avoiding destructive logic in property setters. as per the current tool limitations within Godot C#
godotengine/godot-proposals#9001
@Luna-MN
Luna-MN requested a review from a team as a code owner July 2, 2026 19:20
@AThousandShips
AThousandShips requested a review from a team July 2, 2026 19:21
@Mickeon Mickeon added topic:dotnet area:manual Issues and PRs related to the Manual/Tutorials section of the documentation enhancement topic:editor Related to editor features or workflows labels Jul 2, 2026

@paulloz paulloz left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My first two cents.

  • I'm wondering if Current gotchas and known issues, or Common pitfalls wouldn't be a better place for this? It's always possible to add a link wherever.
  • Are all of the points specific to C#? For instance, the page already contains a danger section about scene tree manipulation at the top.
  • This can wait for after more important points have been cleared up, but the code blocks do not follow the style guide.

@Luna-MN

Luna-MN commented Jul 3, 2026

Copy link
Copy Markdown
Author

as its to do with the tool attribute I added it within that page, if it'd be better in that page i can add it there, and add a warning link somewhere here to redirect there, or the other way around?

these are all problems with C#, due to how it builds the script and applies it to the node, as it was C# related and i know the common user will be using GDScript i added it to the bottom, this can be moved if needed

apologies i will rectify the code style

@paulloz

paulloz commented Jul 3, 2026

Copy link
Copy Markdown
Member

Documentation maintainers might have a stronger opinion than me about where this should live.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:manual Issues and PRs related to the Manual/Tutorials section of the documentation enhancement topic:dotnet topic:editor Related to editor features or workflows

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants