Component:AssetMetadata: Difference between revisions

From Resonite Wiki
Template this
 
(10 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=AssetMetadataComponent.png
|Image=AssetMetadataComponent.png
Line 9: Line 8:
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|LocationName|String| {{stub}}
|LocationName|String| Name of the world the photo was taken in.
|LocationURL|Uri| {{stub}}
|LocationURL|Uri| The url of the world the photo was taken in.
|User|User| {{stub}}
|LocationHost|{{RootFieldType|UserRef}}|TypeAdv2=true|The host user of the session the photo was taken in.
|_machineId|String| {{stub}}
|LocationAccessLevel|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:SessionAccessLevel|SessionAccessLevel]]&gt;'''|TypeAdv3=true| The access level of the world the photo was taken in.
|_userId|String| {{stub}}
|LocationHiddenFromListing|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Bool|Bool]]&gt;'''|TypeAdv4=true| whether the photo was taken in a hidden world or not.
|LocationAccessLevel|Nullable`1|TypeString3=Nullable<SessionAccessLevel>| {{stub}}
|TimeTaken|DateTime| The time the photo was taken.
|LocationHiddenFromListing|Nullable`1|TypeString4=Bool?| {{stub}}
|TakenBy|{{RootFieldType|UserRef}}|TypeAdv6=true|the user who took the photo.
|TimeTaken|DateTime| {{stub}}
|TakenGlobalPosition|Float3| The Position the Asset was generated in global space.
|User|User| {{stub}}
|TakenGlobalRotation|FloatQ| The rotation the Asset was generated in global space.
|_machineId|String| {{stub}}
|TakenGlobalScale|Float3| The scale of the point this Asset was generated in global space.
|_userId|String| {{stub}}
|AppVersion|String| The [[:Category:Versions|Version]] of the game the photo was taken in.
|AppVersion|String| {{stub}}
|UserInfos|{{RootFieldType|SyncList`1|[[#UserInfo|UserInfo]]}}|TypeAdv11=true| A list of users present in the session when the photo was taken.
|PresentUsers|SyncList`1|TypeString8=SyncList<UserRef>| {{stub}}
|__legacyPresentUsers|{{RootFieldType|SyncList`1|[[Type:UserRef|UserRef]]}}|TypeAdv12=true| A list of users present in the session when the photo was taken. This is internal legacy data.
}}
 
== Sync Delegates ==
{{Table ComponentTriggers
|SetFromCurrentWorld()|[[Type:Action|Action]]| {{Template:AssetMetadataSetFromWorld}}
}}
}}


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
This component is used as a base component for other components like [[Component:PhotoMetadata|PhotoMetadata]]


<!--T:4-->
== Examples ==
Used to hold metadata about a given photo. It's auto generated every time a photo is taken in Resonite.


== Examples ==
{{stub}}


<!--T:5-->
<!--T:5-->
 
[[Category:Components:Uncategorized{{#translation:}}|Asset Metadata]]
[[Category:ComponentStubs]]
[[Category:Components{{#translation:}}|Asset Metadata]]
[[Category:Components|Asset Metadata]]
[[Category:Components With Nested Types{{#translation:}}|Asset Metadata]]
[[Category:Components:Uncategorized|Asset Metadata]]

Latest revision as of 22:11, 7 November 2024

Component image 
Asset Metadata component as seen in the Scene Inspector


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.
LocationName String Name of the world the photo was taken in.
LocationURL Uri The url of the world the photo was taken in.
LocationHost direct UserRef The host user of the session the photo was taken in.
LocationAccessLevel Nullable`1<SessionAccessLevel> The access level of the world the photo was taken in.
LocationHiddenFromListing Nullable`1<Bool> whether the photo was taken in a hidden world or not.
TimeTaken DateTime The time the photo was taken.
TakenBy direct UserRef the user who took the photo.
TakenGlobalPosition Float3 The Position the Asset was generated in global space.
TakenGlobalRotation FloatQ The rotation the Asset was generated in global space.
TakenGlobalScale Float3 The scale of the point this Asset was generated in global space.
AppVersion String The Version of the game the photo was taken in.
UserInfos list of UserInfo A list of users present in the session when the photo was taken.
__legacyPresentUsers list of UserRef A list of users present in the session when the photo was taken. This is internal legacy data.

Sync Delegates

Triggers
Method Name Method type and Arguments. Description
SetFromCurrentWorld() Action fills in all the fields using the current session data and the local user (the user running this method)

Usage

This component is used as a base component for other components like PhotoMetadata

Examples