maxmustermann/godot
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Improve the inspector plugin documentation and remove a confusing statement

Browse source 
(cherry picked from commit 974e76a082)
This commit is contained in:
Yuri Sizov 2021-08-06 21:01:48 +03:00 committed by Rémi Verschelde
parent 5acfb5127c
commit 2cf58509dd
No known key found for this signature in database
GPG key ID: C3336907360768E1
2 changed files with 6 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
doc/classes/EditorInspectorPlugin.xml
View file

@ -13,13 +13,14 @@
On each of these calls, the "add" functions can be called.
</description>
<tutorials>
<link title="Inspector plugins">https://docs.godotengine.org/en/3.3/tutorials/plugins/editor/inspector_plugins.html</link>
</tutorials>
<methods>
<method name="add_custom_control">
<return type="void" />
<argument index="0" name="control" type="Control" />
<description>
Adds a custom control, not necessarily a property editor.
Adds a custom control, which is not necessarily a property editor.
</description>
</method>
<method name="add_property_editor">
@ -27,7 +28,7 @@
<argument index="0" name="property" type="String" />
<argument index="1" name="editor" type="Control" />
<description>
Adds a property editor, this must inherit [EditorProperty].
Adds a property editor for an individual property. The [code]editor[/code] control must extend [EditorProperty].
</description>
</method>
<method name="add_property_editor_for_multiple_properties">
@ -36,7 +37,7 @@
<argument index="1" name="properties" type="PoolStringArray" />
<argument index="2" name="editor" type="Control" />
<description>
Adds an editor that allows modifying multiple properties, this must inherit [EditorProperty].
Adds an editor that allows modifying multiple properties. The [code]editor[/code] control must extend [EditorProperty].
</description>
</method>
<method name="can_handle" qualifiers="virtual">

4
doc/classes/EditorProperty.xml
View file

@ -41,14 +41,14 @@
<method name="get_tooltip_text" qualifiers="const">
<return type="String" />
<description>
Override if you want to allow a custom tooltip over your property.
Must be implemented to provide a custom tooltip to the property editor.
</description>
</method>
<method name="set_bottom_editor">
<return type="void" />
<argument index="0" name="editor" type="Control" />
<description>
Adds controls with this function if you want them on the bottom (below the label).
Puts the [code]editor[/code] control below the property label. The control must be previously added using [method Node.add_child].
</description>
</method>
<method name="update_property" qualifiers="virtual">