diff options
| author | Yuri Sizov <yuris@humnom.net> | 2021-02-19 15:42:22 +0300 |
|---|---|---|
| committer | Yuri Sizov <yuris@humnom.net> | 2021-02-19 15:42:41 +0300 |
| commit | 724ed8821593329b64ac1d0820d054fdf8890bd2 (patch) | |
| tree | 20e85fa6ada53e14f34e533511f134f72c08400d | |
| parent | 13303dd56d11248681a204b92849558a20a7846e (diff) | |
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"> |