Component:UserspaceRadiantDash

This is a Userspace Only component — It cannot be attached anywhere but inside the userspace. Changing components in userspace is not recommended and may break functionality of your dashboard. Proceed with caution even if you know what you're doing.

Component image 

File:UserspaceRadiantDashComponent.png

Userspace Radiant Dash component as seen in the Scene Inspector

The UserspaceRadiantDash is better described on the dedicated page, Dash Menu.

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.
BlockOpenClose	Bool	Whether to block opening and closing of the dash
Freeform	Bool	Whether the dash can be grabbed around in freeform style.
_dash	RadiantDash	The radiant dash component that handles all the dash like behaviors/
_dashVisualRoot	Slot	The root slot for the visuals of the radiant dash.
_positioner	UserInterfacePositioner	Handles positioning the dash in front of the user while it is in user space.
_modalOverlay	ModalOverlayManager	Handles managing the different overlays on different screens like the home tab.
_legacyInventoryPanel	LegacyCanvasPanel	Legacy. not used in newer versions. From a time before time when UIX didn't exist.
_legacyInventory	InventoryBrowser	Legacy. not used in newer versions. From a time before time when UIX didn't exist.
_slider	Slider	The slider used to move the dash around via grabbing it.
_lookat	LookAt	The lookat component that handles keeping the dash facing the user.
_uiEditModeToggle	Slot	The slot that appears when the user has the ability to turn off UI edit mode after turning it on.
_alwaysOnFacetRoot	Slot	This slot stores elements of the dash that were made on a facet that are marked as always on. Things that end up here will have a Always On Facet Module Component so they always stay enabled even when the dash closes.
_screensWorkspace	Workspace	The workspace for screens that should be saved when the user's dash gets saved. helps preserve dash customization between machines.
_topWorkspace	Workspace	The workspace for top area elements that should be saved when the user's dash gets saved. helps preserve dash customization between machines.
_notifications	NotificationPanel	The component that handles notifications for the game for the current session and people coming online.
_notificationsRoot	Slot	The slot that contains the entirety of the notifications stack and logic.
_notificationsHolder	Slot	The slot at which notification elements should appear like users joining and role changing.

Sync Delegates

Triggers

Method Name	Method type and Arguments.	Is the method hidden?	Description
OnModalOverlayRequested:Action`1<ModalOverlayManager>	Action`1<ModalOverlayManager>	✓	handles when the modal overlay request action is made.
OnTurnOffEditMode:ButtonEventHandler	ButtonEventHandler	✓	Handles when the user requests to turn off edit mode via the button at the bottom of the dash.
SetupDefaultTopBar:Action`1<Slot>	Action`1<Slot>	✓	Handles when the dash requests a setup of a fresh new dash topbar.
OnHide:Action`1<LegacyPanel>	Action`1<LegacyPanel>	✓	Handles hiding of legacy panels on dash elements that still use it.

Usage

See Dash Menu.

Examples

See Dash Menu.

See Also

• Dash Menu