Navigation
API > API/Developer > API/Developer/SessionFrontend
Implements a Slate widget for browsing active game sessions.
| Name | SSessionBrowser |
| Type | class |
| Header File | /Engine/Source/Developer/SessionFrontend/Public/Widgets/Browser/SSessionBrowser.h |
| Include Path | #include "Widgets/Browser/SSessionBrowser.h" |
Syntax
class SSessionBrowser : public SCompoundWidget
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SCompoundWidget → SSessionBrowser
- FSlateControlledConstruction → SWidget → SCompoundWidget → SSessionBrowser
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~SSessionBrowser() |
Destructor. | Widgets/Browser/SSessionBrowser.h |
Structs
| Name | Remarks |
|---|---|
| FArguments |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AppGroupItem | TSharedPtr< FSessionBrowserGroupTreeItem > | The session tree item that holds this application's session. | Widgets/Browser/SSessionBrowser.h | |
| AvailableSessions | TArray< TSharedPtr< ISessionInfo > > | Holds an unfiltered list of available sessions. | Widgets/Browser/SSessionBrowser.h | |
| bCanSetDefaultSelection | bool | True if we should set the default selection the next time the tree view if refreshed. | Widgets/Browser/SSessionBrowser.h | |
| CommandBar | TSharedPtr< SSessionBrowserCommandBar > | Holds the command bar. | Widgets/Browser/SSessionBrowser.h | |
| IgnoreSessionManagerEvents | bool | Whether to ignore events from the session manager. | Widgets/Browser/SSessionBrowser.h | |
| ItemMap | TMap< FGuid, TSharedPtr< FSessionBrowserTreeItem > > | Maps session and instance GUIDs to existing tree items. | Widgets/Browser/SSessionBrowser.h | |
| OtherGroupItem | TSharedPtr< FSessionBrowserGroupTreeItem > | The session tree item that holds other user's sessions. | Widgets/Browser/SSessionBrowser.h | |
| OwnerGroupItem | TSharedPtr< FSessionBrowserGroupTreeItem > | The session tree item that holds the owner's remote sessions. | Widgets/Browser/SSessionBrowser.h | |
| SessionManager | TSharedPtr< ISessionManager > | Holds a reference to the session manager. | Widgets/Browser/SSessionBrowser.h | |
| SessionTreeItems | TArray< TSharedPtr< FSessionBrowserTreeItem > > | Holds the filtered list of tree items. | Widgets/Browser/SSessionBrowser.h | |
| SessionTreeView | TSharedPtr< STreeView< TSharedPtr< FSessionBrowserTreeItem > > > | Holds the session tree view. | Widgets/Browser/SSessionBrowser.h | |
| StandaloneGroupItem | TSharedPtr< FSessionBrowserGroupTreeItem > | The session tree item that holds other user's standalone instances. | Widgets/Browser/SSessionBrowser.h | |
| ThisAppInstance | TWeakPtr< FSessionBrowserTreeItem > | This app's instance session | Widgets/Browser/SSessionBrowser.h | |
| updatingTreeExpansion | bool | Whether to ignore events from the session tree view. | Widgets/Browser/SSessionBrowser.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Construct
(
const FArguments& InArgs, |
Construct this widget. | Widgets/Browser/SSessionBrowser.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddInstanceItemToTree
(
TSharedPtr< FSessionBrowserTreeItem >& SessionItem, |
Adds items for this session in the tree. | Widgets/Browser/SSessionBrowser.h | |
void ExpandItem
(
const TSharedPtr< FSessionBrowserTreeItem >& Item |
Fully expands the specified tree view item. | Widgets/Browser/SSessionBrowser.h | |
void FilterSessions() |
Filters the session tree. | Widgets/Browser/SSessionBrowser.h | |
void ReloadSessions() |
Reloads the sessions list. | Widgets/Browser/SSessionBrowser.h |