godotengine / godotengine/godot-docs

The C# Interface ISerializationListener is undocumented

Open
#10,615 3 comments 6 reactions 0 assignees View on GitHub
enhancement topic:dotnet
Dominant language
reStructuredText
Stars
5.7k
Forks
3.8k
Avg merge
1d 20h
Merged PRs (30d)
25

Description

**Your Godot version:**

4.3

**Issue description:**

If you are using C# in your Godot project, you can implement ISerializationListener to execute code in OnBeforeSerialize and OnAfterDeserialize. These functions are called when building the C# solution, and perhaps also in other circumstances?

This feature can be helpful if you have to acount for serialization in your [Tool] scripts, but is completely [undocumented](https://docs.godotengine.org/en/stable/search.html?q=ISerializationListener&check_keywords=yes&area=default). I only found out about its existence via this informative issue: https://github.com/godotengine/godot-proposals/issues/9001

Frankly, it would be helpful if all the information in that issue was added to the documentation. [The Godot API for C# section](https://docs.godotengine.org/en/stable/tutorials/scripting/c_sharp/c_sharp_differences.html) seems like a logical place.

I can attempt to write the documentation, but I'm not particularly knowledgable about the behaviour of ISerializationListener, and even less on the entire process of rebuilding the C# solution.

**URL to the documentation page (if already existing):**
N/A

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.