summaryrefslogtreecommitdiff
path: root/doc/classes/EditorInspectorPlugin.xml
diff options
context:
space:
mode:
authorkobewi <kobewi4e@gmail.com>2021-10-15 14:30:58 +0200
committerkobewi <kobewi4e@gmail.com>2021-10-17 01:52:36 +0200
commit7515af8c253bc309155e6fea0a1b50090fb1e731 (patch)
tree1965efea8d0206d5b7cabbedc5afdbc8f5575d9c /doc/classes/EditorInspectorPlugin.xml
parent90a1e5193366e57069951cf2703616248e5f515d (diff)
Improve docs about plugin registration
Diffstat (limited to 'doc/classes/EditorInspectorPlugin.xml')
-rw-r--r--doc/classes/EditorInspectorPlugin.xml4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/classes/EditorInspectorPlugin.xml b/doc/classes/EditorInspectorPlugin.xml
index 17397b80bf..f65e974d47 100644
--- a/doc/classes/EditorInspectorPlugin.xml
+++ b/doc/classes/EditorInspectorPlugin.xml
@@ -4,13 +4,13 @@
Plugin for adding custom property editors on inspector.
</brief_description>
<description>
- These plugins allow adding custom property editors to [EditorInspector].
- Plugins are registered via [method EditorPlugin.add_inspector_plugin].
+ [EditorInspectorPlugin] allows adding custom property editors to [EditorInspector].
When an object is edited, the [method _can_handle] function is called and must return [code]true[/code] if the object type is supported.
If supported, the function [method _parse_begin] will be called, allowing to place custom controls at the beginning of the class.
Subsequently, the [method _parse_category] and [method _parse_property] are called for every category and property. They offer the ability to add custom controls to the inspector too.
Finally, [method _parse_end] will be called.
On each of these calls, the "add" functions can be called.
+ To use [EditorInspectorPlugin], register it using the [method EditorPlugin.add_inspector_plugin] method first.
</description>
<tutorials>
<link title="Inspector plugins">https://docs.godotengine.org/en/latest/tutorials/plugins/editor/inspector_plugins.html</link>