Component:MergedWorldDataItemInterface: Difference between revisions

From Resonite Wiki
Newer edit →
Visual
Automated: create new component page
 
add info
Line 3: Line 3:
|Name=Merged World Data Item Interface
|Name=Merged World Data Item Interface
}}
}}
{{stub}}
The '''MergedWorldDataItemInterface''' component is used to display world details from a [[Component:WorldsDataFeed]].


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|HasData|Bool|
|HasData|Bool| {{Template:FeedItemInterface_HasData}}
|ItemName|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv1=true|
|ItemName|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv1=true| {{Template:FeedItemInterface_ItemName}}
|ItemKey|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv2=true|
|ItemKey|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv2=true| {{Template:FeedItemInterface_ItemKey}}
|ItemDescription|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv3=true|
|ItemDescription|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv3=true| {{Template:FeedItemInterface_ItemDescription}}
|HasDescription|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv4=true|
|HasDescription|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv4=true| {{Template:FeedItemInterface_HasDescription}}
|DescriptionCleanup|Slot|
|DescriptionCleanup|Slot| {{Template:FeedItemInterface_DescriptionCleanup}}
|ItemIcon|'''[[Type:IField`1|IField`1]]<[[Type:Uri|Uri]]>'''|TypeAdv6=true|
|ItemIcon|'''[[Type:IField`1|IField`1]]<[[Type:Uri|Uri]]>'''|TypeAdv6=true| {{Template:FeedItemInterface_ItemIcon}}
|HasIcon|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv7=true|
|HasIcon|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv7=true| {{Template:FeedItemInterface_HasIcon}}
|IconCleanup|Slot|
|IconCleanup|Slot| {{Template:FeedItemInterface_IconCleanup}}
|View|'''[[Type:SyncRef`1|SyncRef`1]]<[[Type:IDataFeedView|IDataFeedView]]>'''|TypeAdv9=true|
|View|'''[[Type:SyncRef`1|SyncRef`1]]<[[Type:IDataFeedView|IDataFeedView]]>'''|TypeAdv9=true| {{Template:FeedItemInterface_View}}
|ParentContainer|'''[[Component:FeedItemInterface|FeedItemInterface]]'''|TypeAdv10=true|
|ParentContainer|'''[[Component:FeedItemInterface|FeedItemInterface]]'''|TypeAdv10=true| {{Template:FeedItemInterface_ParentContainer}}
|ChildContainer|Slot|
|ChildContainer|Slot| {{Template:FeedItemInterface_ChildContainer}}
|NestedItems|{{RootFieldType|SyncList`1|[[Type:NestedItem|NestedItem]]}}|TypeAdv12=true|
|NestedItems|{{RootFieldType|SyncList`1|[[Type:NestedItem|NestedItem]]}}|TypeAdv12=true| {{Template:FeedItemInterface_NestedItems}}
|EnabledState|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv13=true|
|EnabledState|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv13=true| {{Template:FeedItemInterface_EnabledState}}
|IsMerged|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv14=true|
|IsMerged|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv14=true| The field to drive with whether or not the source data feed item was merged.
|SessionCount|'''[[Type:IField`1|IField`1]]<[[Type:Int|Int]]>'''|TypeAdv15=true|
|SessionCount|'''[[Type:IField`1|IField`1]]<[[Type:Int|Int]]>'''|TypeAdv15=true| The field to drive with the amount of sessions in this set of worlds.
|WorldCount|'''[[Type:IField`1|IField`1]]<[[Type:Int|Int]]>'''|TypeAdv16=true|
|WorldCount|'''[[Type:IField`1|IField`1]]<[[Type:Int|Int]]>'''|TypeAdv16=true| The field to drive with the amount of Merged worlds into this item.
|MainName|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv17=true|
|MainName|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv17=true| The field to drive with the main world name of this Merged item.
|MainThumbnail|'''[[Type:IField`1|IField`1]]<[[Type:Uri|Uri]]>'''|TypeAdv18=true|
|MainThumbnail|'''[[Type:IField`1|IField`1]]<[[Type:Uri|Uri]]>'''|TypeAdv18=true| The field to drive with the main world's thumbnail of this Merged item.
|WorldOrSessionId|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv19=true|
|WorldOrSessionId|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv19=true| The field to drive with the main world or session ID of this Merged item.
|TotalAggregateActiveUsers|'''[[Type:IField`1|IField`1]]<[[Type:Int|Int]]>'''|TypeAdv20=true|
|TotalAggregateActiveUsers|'''[[Type:IField`1|IField`1]]<[[Type:Int|Int]]>'''|TypeAdv20=true| The field to drive with the total active users of all the worlds Merged into this item.
|TotalAggregateContacts|'''[[Type:IField`1|IField`1]]<[[Type:Int|Int]]>'''|TypeAdv21=true|
|TotalAggregateContacts|'''[[Type:IField`1|IField`1]]<[[Type:Int|Int]]>'''|TypeAdv21=true| The field to drive with the total users that are contacts in all the worlds Merged into this item.
|Sessions|{{RootFieldType|FeedSubTemplate`2|[[Type:DataFeedEntity`1|DataFeedEntity`1]]<[[Type:SessionInfo|SessionInfo]]>, [[Component:SessionInfoItemInterface|SessionInfoItemInterface]]}}|TypeAdv22=true|
|Sessions|{{RootFieldType|FeedSubTemplate`2|[[Type:DataFeedEntity`1|DataFeedEntity`1]]<[[Type:SessionInfo|SessionInfo]]>, [[Component:SessionInfoItemInterface|SessionInfoItemInterface]]}}|TypeAdv22=true| The list of item templates to instantiate with session info from this merged item.
|Worlds|{{RootFieldType|FeedSubTemplate`2|[[Type:DataFeedEntity`1|DataFeedEntity`1]]<[[Type:World|World]]>, [[Component:WorldItemInterface|WorldItemInterface]]}}|TypeAdv23=true|
|Worlds|{{RootFieldType|FeedSubTemplate`2|[[Type:DataFeedEntity`1|DataFeedEntity`1]]<[[Type:World|World]]>, [[Component:WorldItemInterface|WorldItemInterface]]}}|TypeAdv23=true| The list of item templates to instantiate with the world data of this merged item.
}}
}}


== Behavior ==
== Usage ==
Used in data feed Template generating systems. See [[Data Feeds]].


== Examples ==
== Examples ==
Used in the new worlds facet menu.


== See Also ==
== See Also ==
Line 41: Line 43:
[[Category:Components:Radiant UI:Data Feeds:Interfaces{{#translation:}}|Merged World Data Item Interface]]
[[Category:Components:Radiant UI:Data Feeds:Interfaces{{#translation:}}|Merged World Data Item Interface]]
[[Category:Components{{#translation:}}|Merged World Data Item Interface]]
[[Category:Components{{#translation:}}|Merged World Data Item Interface]]
[[Category:ComponentStubs]]

Revision as of 18:21, 25 January 2025

Component image 
File:MergedWorldDataItemInterfaceComponent.png
Merged World Data Item Interface component as seen in the Scene Inspector

The MergedWorldDataItemInterface component is used to display world details from a Component:WorldsDataFeed.

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.
HasData Bool The field to set when this interface is templated by a data feed for whether it has data or not.
ItemName IField`1<String> The field to fill with the name of the interface item when it is templated via a data feed. For settings toggles, this would be the toggle name.
ItemKey IField`1<String> The field to fill with the interfaces key if it is a dictionary type item.
ItemDescription IField`1<String> The field to fill with the template description when template via a data feed.
HasDescription IField`1<Bool> Whether the item when templated via a data feed has a description.
DescriptionCleanup Slot If this interface doesn't have a description during templating via a data feed, then delete the slot specified.
ItemIcon IField`1<Uri> The resource URL to fill with an image link/URI if the data feed item has an icon.
HasIcon IField`1<Bool> Whether this template has an icon. This is set during duplication as a template via a data feed.
IconCleanup Slot The slot to delete when this interface item doesn't have an icon when being duplicated as a template item by a data feed.
View SyncRef`1<IDataFeedView> The data feed view that this template was instantiated by. Like a SingleFeedView.
ParentContainer FeedItemInterface This template's parent container. If that template also has a parent and a child, then it recursively goes up the containers till it finds the root interface with a parent and a child interface, then instantiates that interfaces child interface and it's Nested items instead of just this interface.
ChildContainer Slot This template's child template which it instanciates if it's part of a parent child structure of interfaces.
NestedItems list of NestedItem A list of extra data feed items to instantiate the same as this one with the same arguments, except each one can be Nested under this item.
EnabledState IField`1<Bool> The enabled state of this feed interface item UI element.
IsMerged IField`1<Bool> The field to drive with whether or not the source data feed item was merged.
SessionCount IField`1<Int> The field to drive with the amount of sessions in this set of worlds.
WorldCount IField`1<Int> The field to drive with the amount of Merged worlds into this item.
MainName IField`1<String> The field to drive with the main world name of this Merged item.
MainThumbnail IField`1<Uri> The field to drive with the main world's thumbnail of this Merged item.
WorldOrSessionId IField`1<String> The field to drive with the main world or session ID of this Merged item.
TotalAggregateActiveUsers IField`1<Int> The field to drive with the total active users of all the worlds Merged into this item.
TotalAggregateContacts IField`1<Int> The field to drive with the total users that are contacts in all the worlds Merged into this item.
Sessions direct FeedSubTemplate`2<DataFeedEntity`1<SessionInfo>, SessionInfoItemInterface> The list of item templates to instantiate with session info from this merged item.
Worlds direct FeedSubTemplate`2<DataFeedEntity`1<World>, WorldItemInterface> The list of item templates to instantiate with the world data of this merged item.

Usage

Used in data feed Template generating systems. See Data Feeds.

Examples

Used in the new worlds facet menu.

See Also

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