Component:BinaryExportable: Difference between revisions

From Resonite Wiki
m ProbablePrime moved page BinaryExportable (Component) to Component:BinaryExportable: Creating component Namespace
add related
 
(6 intermediate revisions by 3 users not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=BinaryExportableComponent.png
|Image=BinaryExportableComponent.png
|Name=Binary Exportable
|Name=Binary Exportable
}}
}}
The '''BinaryExportable''' component takes in a [[Type:Binary|Binary]] asset and allows the [[Slot]] to be exportable as a binary file on your device.
This is more of an uncommon way to export your files, but there are a couple of [[Component:BinaryExportable#Usage|uses]] that are useful to know.
To export using this component, look at the [[File Browser#Importing And Exporting|file browser export section]].


<!--T:2-->
<!--T:2-->
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Binary|IAssetProvider`1|TypeString0=IAssetProvider<Binary>|
|Binary|{{RootFieldType|AssetRef`1|[[Type:Binary|Binary]]}}|TypeAdv0=true|The binary to be exported.
}}
}}


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
Using this component with the [[Component:StaticBinary|StaticBinary]] component, allows the user to export a binary file with a provided [[Type:Uri|url]].
Keep in mind that exporting a binary file is one-way currently in [[Resonite]] (especially if you are thinking about local storage), this is due to the fact that Resonite uses the <code>.bin</code> as files that it does not recognize. So importing from a binary raw file is not doable.
{{Template:AssetExportableUsage}}


<!--T:4-->
<!--T:4-->
== Examples ==
== Examples ==
This component is used as a key component within raw file objects. Which are generated when a user chooses "Raw File" when importing any item.


<!--T:5-->
<!--T:5-->
== Related Components ==
== See Also ==
{{Template:AssetExportableComponents}}
</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:Components{{#translation:}}|Binary Exportable]]
[[Category:Components{{#translation:}}|Binary Exportable]]
[[Category:Components:Assets:Export{{#translation:}}|Binary Exportable]]
[[Category:Components:Assets:Export{{#translation:}}|Binary Exportable]]

Latest revision as of 17:40, 13 November 2024

Component image 
Binary Exportable component as seen in the Scene Inspector

The BinaryExportable component takes in a Binary asset and allows the Slot to be exportable as a binary file on your device.

This is more of an uncommon way to export your files, but there are a couple of uses that are useful to know.

To export using this component, look at the file browser export section.

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.
Binary Binary The binary to be exported.

Usage

Using this component with the StaticBinary component, allows the user to export a binary file with a provided url.

Keep in mind that exporting a binary file is one-way currently in Resonite (especially if you are thinking about local storage), this is due to the fact that Resonite uses the .bin as files that it does not recognize. So importing from a binary raw file is not doable.

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 component is used as a key component within raw file objects. Which are generated when a user chooses "Raw File" when importing any item.

See Also