godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #93777 from ashish0kumar/fix/doc/add_custom_type-icon 

Fix "icon" parameter in EditorPlugin.add_custom_type is not optional but doc says it is
This commit is contained in:
Rémi Verschelde 2024-07-01 10:07:34 +02:00
parent 2cb0c20194 e38530af1e
commit af529cb6be
No known key found for this signature in database
GPG Key ID: C3336907360768E1
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/classes/EditorPlugin.xml
View File

@ -444,7 +444,7 @@
<param index="2" name="script" type="Script" />
<param index="3" name="icon" type="Texture2D" />
<description>
Adds a custom type, which will appear in the list of nodes or resources. An icon can be optionally passed.
Adds a custom type, which will appear in the list of nodes or resources.
When a given node or resource is selected, the base type will be instantiated (e.g. "Node3D", "Control", "Resource"), then the script will be loaded and set to this object.
[b]Note:[/b] The base type is the base engine class which this type's class hierarchy inherits, not any custom type parent classes.
You can use the virtual method [method _handles] to check if your custom object is being edited by checking the script or using the [code]is[/code] keyword.