Component:ExportDialog: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
update sync delegates
 
(6 intermediate revisions by 2 users not shown)
Line 3: Line 3:
|Name=Export Dialog
|Name=Export Dialog
}}
}}
{{stub}}
See [[Exporting]].


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|_targetFolder|String|
|SelectedExportOption|Int| What Export Option is selected.
|EditEnabled|Bool|
|ExportName|'''[[Component:TextField|TextField]]'''|TypeAdv1=true| The name of the Export file.
|_cancel|'''[[Component:Button|Button]]'''|TypeAdv2=true|
|_targetFolder|String| The target folder location to Export to.
|_export|'''[[Component:Button|Button]]'''|TypeAdv3=true|
|EditEnabled|Bool| Whether this component is edit enabled.
|_exportOptions|{{RootFieldType|SyncList`1|[[#ExportOption|ExportOption]]}}|TypeAdv4=true|
|_cancel|'''[[Component:Button|Button]]'''|TypeAdv4=true| The button for canceling the export.
|_export|'''[[Component:Button|Button]]'''|TypeAdv5=true| The button to start the export.
|_exportOptions|{{RootFieldType|SyncList`1|[[#ExportOption|ExportDialog.ExportOption]]}}|TypeAdv6=true| The kinds of Export options available.
|FileName|{{RootFieldType|RelayRef`1|[[Type:IField|IField]]}}|TypeAdv7=true| The name of the file when exporting.
}}
 
== Sync Delegates ==
{{Table ComponentTriggers
|ExportPressed:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Exports the specified export option.
|CancelPressed:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Cancels the export.
}}
 
== Export Option ==
{{Table TypeFields
|Exportable|IExportable| The thing to Export. Usually in [[:Category:Components:Assets:Export|Export Category]]
|ExportType|Int| What kind of Export to do to the exportable.
}}
}}


== Behavior ==
== Usage ==
See [[Exporting]].


== Examples ==
== Examples ==
See [[Exporting]].


== See Also ==
== See Also ==
* [[Exporting]]


[[Category:Components:Uncategorized{{#translation:}}|Export Dialog]]
[[Category:Components:Uncategorized{{#translation:}}|Export Dialog]]
[[Category:Components{{#translation:}}|Export Dialog]]
[[Category:Components{{#translation:}}|Export Dialog]]
[[Category:Components With Nested Types{{#translation:}}|Export Dialog]]
[[Category:Components With Nested Types{{#translation:}}|Export Dialog]]
[[Category:ComponentStubs]]

Latest revision as of 22:07, 19 March 2025

Component image 
Export Dialog component as seen in the Scene Inspector

See Exporting.

Fields

Fields
Name Type Description
persistent Bool Determines whether or not this item will be saved to the server.
UpdateOrder Int Controls the order in which this component is updated.
Enabled Bool Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
SelectedExportOption Int What Export Option is selected.
ExportName TextField The name of the Export file.
_targetFolder String The target folder location to Export to.
EditEnabled Bool Whether this component is edit enabled.
_cancel Button The button for canceling the export.
_export Button The button to start the export.
_exportOptions list of ExportDialog.ExportOption The kinds of Export options available.
FileName direct RelayRef`1<IField> The name of the file when exporting.

Sync Delegates

Triggers
Method Name Method type and Arguments. Is the method hidden? Description
ExportPressed:ButtonEventHandler ButtonEventHandler Exports the specified export option.
CancelPressed:ButtonEventHandler ButtonEventHandler Cancels the export.

Export Option

Fields
Name Type Description
Exportable IExportable The thing to Export. Usually in Export Category
ExportType Int What kind of Export to do to the exportable.

Usage

See Exporting.

Examples

See Exporting.

See Also