Component:LegacyPanel

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.

Component image 

Legacy Panel component as seen in the Scene Inspector

The LegacyPanel component is used in old migrated legacy content UI.

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.
Style	direct RelayRef`1<LegacyUIStyle>	The style that determines what this panel looks like.
AcceptPhysicalTouch	Bool	Whether to allow Component:TipTouchSources to interact with/activate this component.
AcceptRemoteTouch	Bool	Whether this component allows interaction via the user's interaction laser.
ShowHeader	Bool	Whether to show the panel title.
ShowHandle	Bool	Whether to show the panel side bar bevel mesh.
Padding	Float	How much padding should be used from the edge to the inner content.
ZPadding	Float	How much the UI elements should float above the backing plate.
Thickness	Float	The thickness of the beveled panel mesh.
WhiteList	list of IBounded	Elements that should not be used in the bounds calculations.
BlackList	list of IBounded	Elements that should be used in the bounds calculations.
Color	ColorX	The color of the panel.
_material	reference drive of PBS_RimMetallic	The material being used for this panel.
_panelMesh	reference drive of BevelPlaneMesh	The mesh being used for this panel.
_panelPos	field drive of Float3	The position field of this panel.
_handleActive	field drive of Bool	The handle active field of this panel.
_headerActive	field drive of Bool	The header active field of this panel.
_handleMesh	reference drive of BevelStripeMesh	The handle mesh of this panel.
_handlePos	field drive of Float3	The handle position of this panel.
_handleColliderSize	field drive of Float3	The handle collider size of this panel.
_headerTitleMesh	reference drive of BevelStripeMesh	The title mesh of this panel.
_headerButtonMesh	reference drive of BevelStripeMesh	The header button mesh of this panel.
_headerCollider	field drive of Float3	The header collider of this panel.
_headerPos	field drive of Float3	The header position field of this panel.
_headerTitlePos	field drive of Float3	The header title position of this panel.
_title	String	The title name of this panel.
_titleText	TextRenderer	The text renderer that displays the title of this panel.
_indicatePrivate	Bool	Is used to change the colors of the panel to indicate that it is in the dash world.
_titlePos	field drive of Float3	The position field of the title of this panel
_titleBounds	field drive of Float2	The bounds of the title of this panel.
_contentSlot	Slot	The content root slot of this panel.
_headerRoot	Slot	The header root slot of this panel.
_handleAnchorPoint	Slot	The side bar handle mesh's anchor point for this panel.
_handleAnchorPointPosition	field drive of Float3	The handle position field of this panel.
_userspaceOwner	direct UserRef	The owner of this panel.
_titleButtons	list of LegacyPanel.TitleButton	The list of buttons that make up the panel's title.
_highlightedButton	LegacyPanel.TitleButton	The title button object for the currently highlighted button.
_pinButton	LegacyPanel.TitleButton	The title button object for the pin to user button.
CloseOverride	delegate of identity Action`1<LegacyPanel>	A sync delegate that takes a LegacyPanel that overrides the handling of closing this panel.

Sync Delegates

Triggers

Method Name	Method type and Arguments.	Is the method hidden?	Description
HeaderButtonTouched:TouchEvent	TouchEvent	✓	Called when the header button is touched.
OnClose:Action`1<LegacyPanel.TitleButton>	Action`1<LegacyPanel.TitleButton>	✓	Called when the panel is closed.
OnHide:Action`1<LegacyPanel.TitleButton>	Action`1<LegacyPanel.TitleButton>	✓	Called when the panel is hidden by the user.
OnParent:Action`1<LegacyPanel.TitleButton>	Action`1<LegacyPanel.TitleButton>	✓	Called when the panel is pinned to the user via the pin button.
OnUserspaceTransfer:Action`1<LegacyPanel.TitleButton>	Action`1<LegacyPanel.TitleButton>	✓	Called when the panel is transfered from the dash world to the currently focused world.

TitleButton

Fields

Name	Type	Description
ItemColor	ColorX	The color of the button item
Pressed	delegate of identity LegacyPanel.TitleButton	The sync delegate to call when this button is pressed.
Enabled	bool	Whether the button is enabled.
_material	reference drive of PBS_RimMetallic	The material of the button.
_iconMaterial	UnlitMaterial	The icon's material for the button.
_iconTexture	StaticTexture2D	The icon's texture for the button.
_lastPress	SyncTime	The last time the button was pressed.
_itemRoot	direct CleanupRef`1<Slot>	The button's root hierarchy.
_position	field drive of Float3	The position field of the button.
_colliderSize	field drive of Float3	The collider size field of the button.
_iconSize	field drive of Float2	The icon size field of the button.
_iconOffset	field drive of Float3	The icon offset field of the button.

Usage

Don't use in new content.

Examples

Found in migrated legacy content.