summaryrefslogtreecommitdiff
path: root/doc/classes/EditorExportPlatform.xml
diff options
context:
space:
mode:
authorTechnoPorg <jonah.janzen@gmail.com>2023-01-11 19:58:26 -0700
committerTechnoPorg <jonah.janzen@gmail.com>2023-01-11 20:16:42 -0700
commit671f2aca2965c50ed54e1ccbbf130e53aa1ea843 (patch)
treeba51c45c72ede4d7b8dc18c98c16739dfd0c3623 /doc/classes/EditorExportPlatform.xml
parenta75493091823020d858fabadbfa5994da0d658cb (diff)
Document EditorExportPlatform
This class exposes no functionality to scripting itself, but is used by EditorExportPlugins. Internally, it is what does the actual exporting of projects.
Diffstat (limited to 'doc/classes/EditorExportPlatform.xml')
-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>