Component:LegacyWorldListManager

This article describes a feature marked as legacy—this usually means there's a newer, better alternative. Legacy features might not be removed but they will not be updated, and the team will not provide any support for them.

CollapseComponent image 

Legacy World List Manager component as seen in the Scene Inspector

The LegacyWorldListManager component is used in the old dash to manage the world list before the WorldsDataFeed component was implemented.

For an up-to-date counterpart, see Component:WorldsDataFeed and read on the concept Data Feeds.

Fields

Fields Collapse

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.
UpdatingUser	direct UserRef	The user handling this component's update logic.
WorldItemTemplate	LegacyWorldItem	The item Component to use as a template when making the world list.
WorldItemType	direct SyncType	The C# Type of the world items. Auto filled.
ShowOpenedWorlds	Bool	Show world's that are currently open.
ShowSessions	Bool	Show sessions currently open.
ShowPublishedWorlds	Bool	Show worlds that are currently published.
ShowLocallySavedWorlds	Bool	Show locally saved worlds.
MergeSessionsByWorldId	Bool	group sessions by world they were opened from.
IdleSortDelay	Float	How long to wait before sorting session list while idle.
InteractingSortDelay	Float	How long to wait before sorting session list while still interacting.
SearchTerm	String	The current search term for worlds.
SubmittedTo	String	The universe owner ID to search for worlds under (Usually G-Resonite)
OnlyFeatured	Bool	Show only featured worlds.
OwnWorlds	Bool	Show worlds made by UpdatingUser.
ByOwner	String	Show the worlds made by this user ID.
OwnerType	OwnerType	The kind of entity that can own the world.
MinDate	Nullable`1<DateTime>	The minimum date for a world to show up in the results.
MaxDate	Nullable`1<DateTime>	The maximum date allowed for a world to show up in the results.
MaxItems	Int	The maximum amount of items to show.
SkipItems	Int	how many starter items to skip.
EmptySessions	LegacyWorldListManager.EmptySessionFilter	How to apply filters to empty sessions.
IncompatibleSessions	Bool	Whether to show incompatible sessions due to game version number/plugins.
OnlyHeadlessHosts	Bool	Whether to only Show headless worlds.
MinimumTotalUsers	Int	The minimum amount of users in order for it to show up in the list.
MinimumTotalContacts	Int	The maximum amount of users allowed for it to show up in the list.
MinSessionAccessLevel	SessionAccessLevel	The minimum session access level allowed for an item to show up in the list.
MaxSessionAccessLevel	SessionAccessLevel	The maximum session access level allowed for an item to show up in the list.
MinUptime	Double	The minimum session access time allowed for an item to show up in the list.
MaxUptime	Double	The maximum session access time allowed for an item in the list.
ParentSessionId	String	The ID of the session for the user login.
Visited	Nullable`1<Bool>	Whether worlds should be shown if they are either visited or not visited.
SortProperties	list of LegacyWorldListManager.SortProperty	A list of sorting rules for the list of displayed items.
IsSearching	Bool	Whether the component is currently doing a search.
HasMoreResults	Bool	Whether there is more results on other pages.
TotalResults	Int	The total results before filtering.
FilteredResults	Int	How many results appeared after filtering.

Sync Delegates

Triggers Collapse

Method Name	Method type and Arguments.	Is the method hidden?	Description
OnItemHover:ButtonEventHandler	ButtonEventHandler	✓	Handles when an item is hovered over in the list.

SortProperty

Fields

Name	Type	Description
Parameter	SortParameter	The sorting rule to apply
Direction	SortDirection	The direction to use when applying Parameter

SortParameter

Values

Name	Value	Description
SearchScore	0	Sort by how well it matches your name search.
Name	1	Sort alphabetically.
OpenedWorldCount	2	Sort by the amount of open sessions.
TotalSessionCount	3	Sort by how many sessions in the past and present have been made in this world.
TotalUserCount	4	Sort by the total users in the world.
CreationDate	5	Sort by world creation daye.
LastUpdateDate	6	Sort by when the world was last updated by the author.
FirstPublishTime	7	Sort by the time the world was published to public viewing.
TotalVisits	8	Sort by the amount of visits by users to this world.
LastVisit	9	Sort by the world with the most recent visit.
Random	10	Sort in a random order.

SortDirection

Values

Name	Value	Description
Ascending	0	Put items in accending direction based on sort.
Descending	1	Put items in descending direction based on sort.

EmptySessionFilter

Values

Name	Value	Description
HideAll	0	Hide all empty sessions in the list (headless without any clients is considered empty).
OnlyHeadless	1	Hide only headless hosted sessions in the list.
ShowAll	2	Show all sessions regardless of user count.

Usage

This is a Legacy component. Don't use.

Examples

Used previously inside the old world list Component for the dash.