godotengine / godotengine/godot-docs

Improve documentation of EditorInspector.instantiate_property_editor

Open
#11,003 1 comment 2 reactions 0 assignees View on GitHub
area:class reference
Dominant language
reStructuredText
Stars
5.7k
Forks
3.8k
Avg merge
1d 20h
Merged PRs (30d)
25

Description

**Your Godot version:** 4.4 Mono

**Issue description:**
Working on an `EditorPlugin` and struggling to find info on `EditorInterface.instantiate_property_editor`. Some areas of improvement that I see with the documentation:
- It's not inherently clear what value is expected for `path`
- I still have no idea what `usage` is supposed to do.
- `wide` is vague and doesn't always apply to every `EditorProperty` class. Unclear why.
- Cases where it could return null?
- The reflection/casting it needs to do can result in editor errors/crashes. A small warning of the unsafe operation might help improve first-time developer experience.

It also seems like this isn't really covered as part of the [Inspector Plugins](https://docs.godotengine.org/en/stable/tutorials/plugins/editor/inspector_plugins.html#adding-an-interface-to-edit-properties) tutorial doc. It mentions `EditorProperty` but doesn't go much further past that.

**URL to the documentation page (if already existing):** https://docs.godotengine.org/en/stable/classes/class_editorinspector.html#class-editorinspector-method-instantiate-property-editor

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.