Просмотр исходного кода

Merge pull request #46219 from pycbouh/doc-editor-plugin-build

Add documentation for EditorPlugin's build method
Rémi Verschelde 4 лет назад
Родитель
Сommit
aaaaaf5bb6
1 измененных файлов с 2 добавлено и 0 удалено
  1. 2 0
      doc/classes/EditorPlugin.xml

+ 2 - 0
doc/classes/EditorPlugin.xml

@@ -169,6 +169,8 @@
 			<return type="bool">
 			</return>
 			<description>
+				This method is called when the editor is about to run the project. The plugin can then perform required operations before the project runs.
+				This method must return a boolean. If this method returns [code]false[/code], the project will not run. The run is aborted immediately, so this also prevents all other plugins' [method build] methods from running.
 			</description>
 		</method>
 		<method name="clear" qualifiers="virtual">