summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2023-01-12 17:54:59 +0100
committerRémi Verschelde <rverschelde@gmail.com>2023-01-12 17:54:59 +0100
commit9332d17c87bf40fe23a4b5e958e019ac238ad6d1 (patch)
tree10b36981f848f3f04e66f1b5fee23fcc5af08541
parentdef592114f64262d7323644b92648d83ae8f6a51 (diff)
parent671f2aca2965c50ed54e1ccbbf130e53aa1ea843 (diff)
downloadredot-engine-9332d17c87bf40fe23a4b5e958e019ac238ad6d1.tar.gz
Merge pull request #71258 from TechnoPorg/doc-editor-export-platform
Document EditorExportPlatform
-rw-r--r--doc/classes/EditorExportPlatform.xml3
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/classes/EditorExportPlatform.xml b/doc/classes/EditorExportPlatform.xml
index 1d63af9233..f2b39ab134 100644
--- a/doc/classes/EditorExportPlatform.xml
+++ b/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>