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

Add documentation for EditorPlugin's build method
This commit is contained in:
Rémi Verschelde 2021-02-19 13:59:00 +01:00 committed by GitHub
commit aaaaaf5bb6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -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">