Component:WorldsDataFeed: Difference between revisions

Latest revision as of 17:28, 27 August 2025

Component image

**Worlds Data Feed** component as seen in the Scene Inspector

The WorldsDataFeed is a data feed that provides a list of worlds or sessions, depending on the settings.

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	Whether to show incompatible sessions due to game version number/plugins.
`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. This feed provides MergedWorldDataItemInterface as well as DataFeedEntity<World> and DataFeedEntity<SessionInfo> as part of its feed.

Examples

This feed is not currently used in official content.

@@ Line 3: / Line 3: @@
 |Name=Worlds Data Feed
 }}
-The '''WorldsDataFeed''' acts as a [[Data Feed|data feed]] that provides a stream of information that can be mapped to templates. For more info see [[Data Feeds]].
+The '''WorldsDataFeed''' is a [[Data Feed|data feed]] that provides a list of worlds or sessions, depending on the settings.
 == Fields ==
@@ Line 11: / Line 11: @@
 |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| Whether to show incompatible sessions due to game version number/plugins.
 |HeadlessHosts|Bool| Whether to list headless hosts.
 |UserHosts|Bool| Whether to list normal user hosts.
@@ Line 18: / Line 19: @@
 |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]].
+Used in the system of [[Data Feeds]]. This feed provides MergedWorldDataItemInterface  as well as DataFeedEntity<World> and DataFeedEntity<SessionInfo> as part of its feed.
 == Examples ==
-Used in the world browser menu in the [[Dash Menu]].
+This feed is not currently used in official content.
 == See Also ==