diff options
| author | RedworkDE <10944644+RedworkDE@users.noreply.github.com> | 2023-02-08 13:36:02 +0100 |
|---|---|---|
| committer | RedworkDE <10944644+RedworkDE@users.noreply.github.com> | 2023-04-07 19:18:00 +0200 |
| commit | 6963e84b58b72d6103c4ddb38c80173a62df7bf4 (patch) | |
| tree | 9f8e940eac48903e29ad932f93611cbdb8036c35 /doc | |
| parent | c151d3231f8e5d207f64055c60c70967dd5351b5 (diff) | |
| download | redot-engine-6963e84b58b72d6103c4ddb38c80173a62df7bf4.tar.gz | |
Allow EditorExportPlugins to provide export options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/EditorExportPlugin.xml | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/classes/EditorExportPlugin.xml b/doc/classes/EditorExportPlugin.xml index e5740f806d..a5b42bb892 100644 --- a/doc/classes/EditorExportPlugin.xml +++ b/doc/classes/EditorExportPlugin.xml @@ -99,6 +99,17 @@ Return a [PackedStringArray] of additional features this preset, for the given [param platform], should have. </description> </method> + <method name="_get_export_options" qualifiers="virtual const"> + <return type="Dictionary[]" /> + <param index="0" name="platform" type="EditorExportPlatform" /> + <description> + Return a list of export options that can be configured for this export plugin. + Each element in the return value is a [Dictionary] with the following keys: + - [code]option[/code]: A dictionary with the structure documented by [method Object.get_property_list], but all keys are optional. + - [code]default_value[/code]: The default value for this option. + - [code]update_visibility[/code]: An optional boolean value. If set to [code]true[/code], the preset will emit [signal Object.property_list_changed] when the option is changed. + </description> + </method> <method name="_get_name" qualifiers="virtual const"> <return type="String" /> <description> @@ -106,6 +117,13 @@ Implementing this method is required. </description> </method> + <method name="_should_update_export_options" qualifiers="virtual const"> + <return type="bool" /> + <param index="0" name="platform" type="EditorExportPlatform" /> + <description> + Return [code]true[/code], if the result of [method _get_export_options] has changed and the export options of preset corresponding to [param platform] should be updated. + </description> + </method> <method name="add_file"> <return type="void" /> <param index="0" name="path" type="String" /> @@ -185,6 +203,13 @@ In case of a directory code-sign will error if you place non code object in directory. </description> </method> + <method name="get_option" qualifiers="const"> + <return type="Variant" /> + <param index="0" name="name" type="StringName" /> + <description> + Returns the current value of an export option supplied by [method _get_export_options]. + </description> + </method> <method name="skip"> <return type="void" /> <description> |