Component:PackageExportable: Difference between revisions

From Resonite Wiki
Not a component stub
add more usage, related
 
Line 3: Line 3:
|Name=Package Exportable
|Name=Package Exportable
}}
}}
{{stub}}
The '''PackageExportable''' component takes in any [[Slot]] hierarchy as a field, and when the slot that has this exportable component on it gets exported, it will actually save a file on your device of the target slot hierarchy provided (and not the item that your exporting from unless it is also under that hierarchy).
The '''PackageExportable''' component takes in any [[Slot]] hierarchy as a field, and when the slot that has this exportable component on it gets exported, it will actually save a file on your device of the target slot hierarchy provided (and not the item that your exporting from unless it is also under that hierarchy).


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Root|Slot| The slot hierarchy to be exported.
|Root|Slot| The slot hierarchy to be exported.
Line 13: Line 11:


== Usage ==
== Usage ==
This can be a better alternative than using the [[Component:BinaryExportable|BinaryExportable]] for storage of assets, items, or worlds.


This can be a better alternative than using the [[Component:BinaryExportable|BinaryExportable]] for storage of assets, items, or worlds.
{{Template:AssetExportableUsage}}


== Examples ==
== Examples ==
{{stub}}


== See Also ==
== See Also ==
{{Template:AssetExportableComponents}}


[[Category:Components:Assets:Export{{#translation:}}|Package Exportable]]
[[Category:Components:Assets:Export{{#translation:}}|Package Exportable]]
[[Category:Components{{#translation:}}|Package Exportable]]
[[Category:Components{{#translation:}}|Package Exportable]]

Latest revision as of 17:38, 13 November 2024

Component image 
Package Exportable component as seen in the Scene Inspector

The PackageExportable component takes in any Slot hierarchy as a field, and when the slot that has this exportable component on it gets exported, it will actually save a file on your device of the target slot hierarchy provided (and not the item that your exporting from unless it is also under that hierarchy).

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.
Root Slot The slot hierarchy to be exported.

Usage

This can be a better alternative than using the BinaryExportable for storage of assets, items, or worlds.

This component is used mainly to add an export option to the user's context menu as they are holding an item. Which can be used to easily communicate to the user that an item is made for exporting to their local machine. For example, screenshots, figurines, pictures, recorded audio clips, some generated text from protoflux, and Avatars can have Asset exportables like this component to signify that they can be downloaded to one's local storage.

Examples

This article or section is a Stub. You can help the Resonite Wiki by expanding it.


See Also