diff options
| author | Yuri Sizov <pycbouh@users.noreply.github.com> | 2020-04-05 17:19:24 +0300 |
|---|---|---|
| committer | Yuri Sizov <yuris@humnom.net> | 2020-07-06 17:39:16 +0300 |
| commit | 49f6dc5004931f17a7be008b2159cd5915cd897d (patch) | |
| tree | fab50790b4c7cf3c5d977c6bce51377c0aa649ce /doc/classes/EditorInterface.xml | |
| parent | b43fb407b1fe214ffbe7e8bcd1432f291ac695e5 (diff) | |
Expose methods to play scene from plugin code
Diffstat (limited to 'doc/classes/EditorInterface.xml')
| -rw-r--r-- | doc/classes/EditorInterface.xml | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/doc/classes/EditorInterface.xml b/doc/classes/EditorInterface.xml index c2c73a8b83..1d877e632e 100644 --- a/doc/classes/EditorInterface.xml +++ b/doc/classes/EditorInterface.xml @@ -72,6 +72,13 @@ Returns an [Array] with the file paths of the currently opened scenes. </description> </method> + <method name="get_playing_scene" qualifiers="const"> + <return type="String"> + </return> + <description> + Returns the name of the scene that is being played. If no scene is currently being played, returns an empty string. + </description> + </method> <method name="get_resource_filesystem"> <return type="EditorFileSystem"> </return> @@ -117,6 +124,13 @@ Shows the given property on the given [code]object[/code] in the Editor's Inspector dock. </description> </method> + <method name="is_playing_scene" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns [code]true[/code], if a scene is currently being played; [code]false[/code] otherwise. Paused scenes are considered as being played. + </description> + </method> <method name="is_plugin_enabled" qualifiers="const"> <return type="bool"> </return> @@ -146,6 +160,29 @@ Opens the scene at the given path. </description> </method> + <method name="play_current_scene"> + <return type="void"> + </return> + <description> + Plays the currently active scene. + </description> + </method> + <method name="play_custom_scene"> + <return type="void"> + </return> + <argument index="0" name="scene_filepath" type="String"> + </argument> + <description> + Plays the scene specified by its filepath. + </description> + </method> + <method name="play_main_scene"> + <return type="void"> + </return> + <description> + Plays the main scene. + </description> + </method> <method name="reload_scene_from_path"> <return type="void"> </return> @@ -201,6 +238,13 @@ Sets the enabled status of a plugin. The plugin name is the same as its directory name. </description> </method> + <method name="stop_playing_scene"> + <return type="void"> + </return> + <description> + Stops the scene that is currently playing. + </description> + </method> </methods> <members> <member name="distraction_free_mode" type="bool" setter="set_distraction_free_mode" getter="is_distraction_free_mode_enabled"> |