Browse Source

Merge pull request #71258 from TechnoPorg/doc-editor-export-platform

Document EditorExportPlatform
Rémi Verschelde 2 years ago
parent
commit
9332d17c87
1 changed files with 3 additions and 0 deletions
  1. 3 0
      doc/classes/EditorExportPlatform.xml

+ 3 - 0
doc/classes/EditorExportPlatform.xml

@@ -1,8 +1,11 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="EditorExportPlatform" inherits="RefCounted" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
 	<brief_description>
+		Identifies a supported export platform, and internally provides the functionality of exporting to that platform.
 	</brief_description>
 	<description>
+		Base resource that provides the functionality of exporting a release build of a project to a platform, from the editor. Stores platform-specific metadata such as the name and supported features of the platform, and performs the exporting of projects, PCK files, and ZIP files. Uses an export template for the platform provided at the time of project exporting.
+		Used in scripting by [EditorExportPlugin] to configure platform-specific customization of scenes and resources. See [method EditorExportPlugin._begin_customize_scenes] and [method EditorExportPlugin._begin_customize_resources] for more details.
 	</description>
 	<tutorials>
 	</tutorials>