Document how some editor classes should be accessed as singletons only

This closes #37687.
This commit is contained in:
Hugo Locurcio 2020-04-14 22:09:21 +02:00
parent 1d8a9a9dc8
commit a225265b0a
7 changed files with 7 additions and 0 deletions

View File

@ -5,6 +5,7 @@
</brief_description> </brief_description>
<description> <description>
This object holds information of all resources in the filesystem, their types, etc. This object holds information of all resources in the filesystem, their types, etc.
[b]Note:[/b] This class shouldn't be instantiated directly. Instead, access the singleton using [method EditorInterface.get_resource_filesystem].
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>

View File

@ -5,6 +5,7 @@
</brief_description> </brief_description>
<description> <description>
The editor inspector is by default located on the right-hand side of the editor. It's used to edit the properties of the selected node. For example, you can select a node such as the Sprite2D then edit its transform through the inspector tool. The editor inspector is an essential tool in the game development workflow. The editor inspector is by default located on the right-hand side of the editor. It's used to edit the properties of the selected node. For example, you can select a node such as the Sprite2D then edit its transform through the inspector tool. The editor inspector is an essential tool in the game development workflow.
[b]Note:[/b] This class shouldn't be instantiated directly. Instead, access the singleton using [method EditorInterface.get_inspector].
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>

View File

@ -5,6 +5,7 @@
</brief_description> </brief_description>
<description> <description>
EditorInterface gives you control over Godot editor's window. It allows customizing the window, saving and (re-)loading scenes, rendering mesh previews, inspecting and editing resources and objects, and provides access to [EditorSettings], [EditorFileSystem], [EditorResourcePreview], [ScriptEditor], the editor viewport, and information about scenes. EditorInterface gives you control over Godot editor's window. It allows customizing the window, saving and (re-)loading scenes, rendering mesh previews, inspecting and editing resources and objects, and provides access to [EditorSettings], [EditorFileSystem], [EditorResourcePreview], [ScriptEditor], the editor viewport, and information about scenes.
[b]Note:[/b] This class shouldn't be instantiated directly. Instead, access the singleton using [method EditorPlugin.get_editor_interface].
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>

View File

@ -5,6 +5,7 @@
</brief_description> </brief_description>
<description> <description>
This object is used to generate previews for resources of files. This object is used to generate previews for resources of files.
[b]Note:[/b] This class shouldn't be instantiated directly. Instead, access the singleton using [method EditorInterface.get_resource_previewer].
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>

View File

@ -5,6 +5,7 @@
</brief_description> </brief_description>
<description> <description>
This object manages the SceneTree selection in the editor. This object manages the SceneTree selection in the editor.
[b]Note:[/b] This class shouldn't be instantiated directly. Instead, access the singleton using [method EditorInterface.get_selection].
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>

View File

@ -11,6 +11,7 @@
settings.get(prop) settings.get(prop)
list_of_settings = settings.get_property_list() list_of_settings = settings.get_property_list()
[/codeblock] [/codeblock]
[b]Note:[/b] This class shouldn't be instantiated directly. Instead, access the singleton using [method EditorInterface.get_editor_settings].
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>

View File

@ -4,6 +4,7 @@
Godot editor's script editor. Godot editor's script editor.
</brief_description> </brief_description>
<description> <description>
[b]Note:[/b] This class shouldn't be instantiated directly. Instead, access the singleton using [method EditorInterface.get_script_editor].
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>