Component:StorageUsageStatus: Difference between revisions

From Resonite Wiki
VisualWikitext
imported>Mysticporo
Created page with "<languages></languages> <translate> <!--T:1--> {{stub}} {{Infobox Component |Image=StorageUsageStatusComponent.png |Name=Storage Usage Status }} <!--T:2--> == Fields == {{Tab..."
 
Add info
 
(2 intermediate revisions by 2 users not shown)
Line 7: Line 7:
|Name=Storage Usage Status
|Name=Storage Usage Status
}}
}}
Storage Usage Status is a component that is used to read how much storage a user has used, total, shared, and that has left to share.


<!--T:2-->
<!--T:2-->
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|HasValidData|Bool|
|OwnerId|String| The id of the user this is reading data from
|StorageBytes|Long|
|GroupMemberQuota|Bool| Whether to read group storage limits.
|UsageBytes|Long|
|HasValidData|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv2=true| Whether this component has successfully grabbed the data.
|UsageRatio|Float|
|StorageBytes|{{RootFieldType|RawOutput`1|[[Type:Long|Long]]}}|TypeAdv3=true| how many bytes of storage <code>OwnerId</code> has total
|StorageString|String|
|FullStorageBytes|{{RootFieldType|RawOutput`1|[[Type:Long|Long]]}}|TypeAdv4=true| how many bytes of storage <code>OwnerId</code> has used currently.
|UsageString|String|
|ShareableStorageBytes|{{RootFieldType|RawOutput`1|[[Type:Long|Long]]}}|TypeAdv5=true| How many bytes of storage <code>OwnerId</code> currently has ready to share.
|RatioString|String|
|SharedStorageBytes|{{RootFieldType|RawOutput`1|[[Type:Long|Long]]}}|TypeAdv6=true| How many bytes of storage <code>OwnerId</code> has shared with others currently.
|UsageBytes|{{RootFieldType|RawOutput`1|[[Type:Long|Long]]}}|TypeAdv7=true| The total amount of bytes being used by <code>OwnerId</code>.
|UsageRatio|{{RootFieldType|RawOutput`1|[[Type:Float|Float]]}}|TypeAdv8=true| the percentage of how full <code>OwnerId</code>'s storage is from 0->1
|StorageString|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv9=true| String version with nice formatting applied of how much storage <code>OwnerId</code> has.
|FullStorageString|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv10=true| String version with nice formatting applied of
|ShareableStorageString|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv11=true| String version with nice formatting applied of how much storage <code>OwnerId</code> has ready to share.
|SharedStorageString|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv12=true| String version with nice formatting applied of how much storage <code>OwnerId</code> has shared with others.
|UsageString|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv13=true| String version with nice formatting applied of how much storage <code>OwnerId</code> has used.
|RatioString|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv14=true| String version with nice formatting applied of how full <code>OwnerId</code>'s storage is.
}}
}}


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
Can only be used in user space (verify?)


<!--T:4-->
<!--T:4-->
== Examples ==
== Examples ==
Used in the cloud storage facets to show the user how much storage they have left.


<!--T:5-->
<!--T:5-->
== Related Components ==
== Related Components ==
</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:Components{{#translation:}}|Storage Usage Status]]
[[Category:Components{{#translation:}}|Storage Usage Status]]
[[Category:Components:Cloud:Indicators{{#translation:}}|Storage Usage Status]]
[[Category:Components:Cloud:Indicators{{#translation:}}|Storage Usage Status]]

Latest revision as of 19:49, 7 November 2024


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


Component image 
Storage Usage Status component as seen in the Scene Inspector

Storage Usage Status is a component that is used to read how much storage a user has used, total, shared, and that has left to share.

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.
OwnerId String The id of the user this is reading data from
GroupMemberQuota Bool Whether to read group storage limits.
HasValidData raw output of Bool Whether this component has successfully grabbed the data.
StorageBytes raw output of Long how many bytes of storage OwnerId has total
FullStorageBytes raw output of Long how many bytes of storage OwnerId has used currently.
ShareableStorageBytes raw output of Long How many bytes of storage OwnerId currently has ready to share.
SharedStorageBytes raw output of Long How many bytes of storage OwnerId has shared with others currently.
UsageBytes raw output of Long The total amount of bytes being used by OwnerId.
UsageRatio raw output of Float the percentage of how full OwnerId's storage is from 0->1
StorageString raw output of String String version with nice formatting applied of how much storage OwnerId has.
FullStorageString raw output of String String version with nice formatting applied of
ShareableStorageString raw output of String String version with nice formatting applied of how much storage OwnerId has ready to share.
SharedStorageString raw output of String String version with nice formatting applied of how much storage OwnerId has shared with others.
UsageString raw output of String String version with nice formatting applied of how much storage OwnerId has used.
RatioString raw output of String String version with nice formatting applied of how full OwnerId's storage is.

Usage

Can only be used in user space (verify?)

Examples

Used in the cloud storage facets to show the user how much storage they have left.

Related Components

Retrieved from "https://wiki.resonite.com/index.php?title=Component:StorageUsageStatus&oldid=92155"