Component:LegacyWorldDetail

From Resonite Wiki
Component image 
World Detail component as seen in the Scene Inspector

The WorldDetail component is used to display information about a world to a UI.

Usage

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.
UpdatingUser direct UserRef The user managing updates for this component.
WorldOrSessionId String The world or session ID to get info on.
_visited Bool Whether UpdatingUser has visited this world.
_totalActiveUsers Int How many active ussrs are in the world.
_totalContacts Int How many contacts of UpdatingUser are in the world.
Expanded Bool Whether the world item UI has been hovered over in the dash.
CompactDetailExpanded Bool Whether the extra detail has been expanded.
CompactDetailCategory LegacyWorldDetail.DetailCategory The detail to show in the compact view.
ModalCompactSize Float2 The size of the world item when not hovered over.
ModalExpandedSize Float2 The size of the world item when hovered over.
_hostText Text The Text Component showing the host name.
_sessionItemsRoot Slot The slot containing current sessions of the world.
_thumbnailGraphic RawGraphic The UIX graphic showing the thumbnail.
_thumbnailTexture StaticTexture2D The texture for the world thumbnail.
_detailImageRoot Slot The root slot of the detail image graphic.
_compactRoot Slot The root of the graphic when it is not clicked into.
_compactHeaderRoot Slot the root of the text graphic of the world item before clicking into it.
_detailHeaderRoot Slot the root of the text graphic of the world item after clicking into it.
_compactMaskEnabled field drive of Bool The field to drive for whether or not the compact view mask should be enabled.
_compactMaskRootEnabled field drive of Bool The field to drive for whether or not the compact mask root slot should be enabled.
_openButton Button The button Component for opening the world.
_scrollRect ScrollRect The scroll rectangle for the detail menu of the world item.
_expandButton Button The button used for showing the un compact view.
_expandIcon Image The icon for _expandButton.
_expandSprite Sprite The sprite for _expandButton.
_compactSprite Sprite The sprite for the switch to compact mode.
_description Text The text used to show the world description.
_leftDetailsRoot Slot the slot used to store the left side details.
_rightDetailsRoot Slot the slot used to store the right side details.
_detailsText Text The text used to show the world details.
_cycleLeftButton Button the button for cycling left.
_cycleRightButton Button the button for cycling right.
_compactParent direct RefDrive`1<Slot> the parent slot of the compact view graphic.
_compactHeaderParent direct RefDrive`1<Slot> the parent slot of the compact views text header.
_sidebarActive field drive of Bool The field to drive with whether the sidebar should be active.
_sidebarAnchorMin field drive of Float2 The field to drive for the sidebar's rectangle anchor minimum.
_sidebarAnchorMax field drive of Float2 The field to drive for the sidebar's rectangle anchor maximum.
_contentAnchorMin field drive of Float2 The field to drive for the content's rectangle anchor minimum.
_contentAnchorMax field drive of Float2 The field to drive for the content's rectangle anchor maximum.
_rectTransformLerp field drive of Float The field to drive for the animation transitions for the item hovering.
_modalAnchorMin field drive of Float2 The field to drive for the modal's rectangle anchor minimum.
_modalAnchorMax field drive of Float2 The field to drive for the modal's rectangle anchor maximum.
_compactButtonsActive field drive of Bool The field to drive for the compact buttons active status.
_compactButtonsAnchorMin field drive of Float2 The field to drive for the compact buttons rectangle anchor minimum.
_compactButtonsAnchorMax field drive of Float2 The field to drive for the compact buttons rectangle anchor maximum.
_compactDetailRect field drive of Rect The field to drive with the current compact details rectangle component.
_compactDetailButtonRect field drive of Rect The field to drive with the current compact details button rectangle component.
_compactDetailText Text The text field that stores the compact view details.
_compactDetailExpandButton Button The button Component that is used to expand the details in the compact view.
_newSessionItemRoot Slot The slot for the graphic for making a new session button.

Sync Delegates

Triggers
Method Name Method type and Arguments. Is the method hidden? Description
ToggleExpanded:ButtonEventHandler ButtonEventHandler
OnOpen:ButtonEventHandler ButtonEventHandler
OnCycleLeft:ButtonEventHandler ButtonEventHandler
OnCycleRight:ButtonEventHandler ButtonEventHandler
OnSessionSelected:ButtonEventHandler`1<String> ButtonEventHandler`1<String>
OnCancel:ButtonEventHandler ButtonEventHandler
OnGetWorldOrb:ButtonEventHandler ButtonEventHandler
OnCopyWorldURL:ButtonEventHandler ButtonEventHandler
OnCopyRecordURL:ButtonEventHandler ButtonEventHandler
OnStartCustomSession:ButtonEventHandler ButtonEventHandler
OnModifyMetadata:ButtonEventHandler ButtonEventHandler
CustomWorldStart:Action`1<NewWorldDialog> Action`1<NewWorldDialog>
OnGetSessionOrb:ButtonEventHandler ButtonEventHandler
OnCopySessionURL:ButtonEventHandler ButtonEventHandler
OnAdminAddTag:ButtonEventHandler`1<TextField> ButtonEventHandler`1<TextField>
OnFeature:ButtonEventHandler ButtonEventHandler
OnRemoveSubmission:ButtonEventHandler ButtonEventHandler

DetailCategory

Values
Name Value Description
Users 0 Show the users.
Description 1 Show the description.

Usage

This article or section is a Stub. You can help the Resonite Wiki by expanding it.


Examples

Used in the dash previously.

See Also