diff options
| author | Rémi Verschelde <remi@verschelde.fr> | 2021-02-19 13:59:00 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-02-19 13:59:00 +0100 |
| commit | aaaaaf5bb60c108e1d32ad35ce07b73b2f54c51d (patch) | |
| tree | 624a4fd77b81546c83111a241488e62b4848dfeb | |
| parent | 04cb7e638cc8e8a0299a15b4d8d65e31fbfffaa9 (diff) | |
| parent | 724ed8821593329b64ac1d0820d054fdf8890bd2 (diff) | |
Merge pull request #46219 from pycbouh/doc-editor-plugin-build
Add documentation for EditorPlugin's build method
| -rw-r--r-- | doc/classes/EditorPlugin.xml | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml index be21ad65c5..a20ecf6dff 100644 --- a/doc/classes/EditorPlugin.xml +++ b/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"> |