Component:WorldsDataFeed: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
Automated: update Fields
 
(3 intermediate revisions by 2 users not shown)
Line 3: Line 3:
|Name=Worlds Data Feed
|Name=Worlds Data Feed
}}
}}
{{stub}}
The '''WorldsDataFeed''' only works in the dash world for user contacts where the [[Dash Menu]] is. For every other function it provides it works fine. It acts as an [[Data Feed|data feed]] that provides a stream of information that can be mapped to templates. For more info see [[Data Feeds]].


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|ListOpenedWorlds|Bool|
|ListOpenedWorlds|Bool| Whether to list open worlds.
|ListSessions|Bool|
|ListSessions|Bool| Whether to list sessions of worlds.
|MergeByWorldId|Bool|
|MergeByWorldId|Bool| Whether to merge by world IDs. Used to make [[Component:MergedWorldDataItemInterface]].
|MergeBySessionId|Bool|
|MergeBySessionId|Bool| Whether to merge by session IDs. Used to make [[Component:MergedWorldDataItemInterface]]
|HeadlessHosts|Bool|
|IncompatibleSessions|Bool|
|UserHosts|Bool|
|HeadlessHosts|Bool| Whether to list headless hosts.
|MinimumTotalUsers|Int|
|UserHosts|Bool| Whether to list normal user hosts.
|MinimumTotalContacts|Int|
|MinimumTotalUsers|Int| List sessions that have more than this many users.
|MinSessionAccessLevel|SessionAccessLevel|
|MinimumTotalContacts|Int| List sessions that have more than this many users that are contacts to the user.
|MaxSessionAccessLevel|SessionAccessLevel|
|MinSessionAccessLevel|SessionAccessLevel| List sessions that have a session access greater or equal to this.
|MinUptime|Double|
|MaxSessionAccessLevel|SessionAccessLevel| List sessions that have a session access less than or equal to this.
|MaxUptime|Double|
|MinUptime|Double| A session has to be open for at least this long to be listed.
|MaxUptime|Double| A session has to be open for less than this long to be listed.
}}
}}


== Behavior ==
== Usage ==
Used in the system of [[Data Feeds]].


== Examples ==
== Examples ==
Used in the world browser menu in the [[Dash Menu]].


== See Also ==
== See Also ==
* [[Data Feeds]]


[[Category:Components:Radiant UI:Data Feeds:Feeds{{#translation:}}|Worlds Data Feed]]
[[Category:Components:Radiant UI:Data Feeds:Feeds{{#translation:}}|Worlds Data Feed]]
[[Category:Components{{#translation:}}|Worlds Data Feed]]
[[Category:Components{{#translation:}}|Worlds Data Feed]]
[[Category:ComponentStubs]]

Latest revision as of 06:05, 17 March 2025

Component image 
Worlds Data Feed component as seen in the Scene Inspector

The WorldsDataFeed only works in the dash world for user contacts where the Dash Menu is. For every other function it provides it works fine. It acts as an data feed that provides a stream of information that can be mapped to templates. For more info see Data Feeds.

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.
ListOpenedWorlds Bool Whether to list open worlds.
ListSessions Bool Whether to list sessions of worlds.
MergeByWorldId Bool Whether to merge by world IDs. Used to make Component:MergedWorldDataItemInterface.
MergeBySessionId Bool Whether to merge by session IDs. Used to make Component:MergedWorldDataItemInterface
IncompatibleSessions Bool
HeadlessHosts Bool Whether to list headless hosts.
UserHosts Bool Whether to list normal user hosts.
MinimumTotalUsers Int List sessions that have more than this many users.
MinimumTotalContacts Int List sessions that have more than this many users that are contacts to the user.
MinSessionAccessLevel SessionAccessLevel List sessions that have a session access greater or equal to this.
MaxSessionAccessLevel SessionAccessLevel List sessions that have a session access less than or equal to this.
MinUptime Double A session has to be open for at least this long to be listed.
MaxUptime Double A session has to be open for less than this long to be listed.

Usage

Used in the system of Data Feeds.

Examples

Used in the world browser menu in the Dash Menu.

See Also