Navigation
API > API/Plugins > API/Plugins/WorkspaceEditor
Workspace schema to configure workspace assets to specific use cases.
| Name | UWorkspaceSchema |
| Type | class |
| Header File | /Engine/Plugins/Experimental/Workspace/Source/WorkspaceEditor/Public/WorkspaceSchema.h |
| Include Path | #include "WorkspaceSchema.h" |
Syntax
UCLASS (MinimalAPI, Abstract)
class UWorkspaceSchema : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UWorkspaceSchema
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TObjectPtr< UWorkspaceViewportSceneDescription > CreateSceneDescription() |
Create a new object containing the required data to construct a scene for this type of workspace. | WorkspaceSchema.h | |
virtual FText GetDisplayName() |
Get the name to display for workspace assets that use this schema. | WorkspaceSchema.h | |
virtual TConstArrayView< FTopLevelAssetPath > GetSupportedAssetClassPaths() |
Get the asset types that are supported by this workspace. If this is empty, all assets are assumed to be supported. | WorkspaceSchema.h | |
virtual void OnLoadWorkspaceState
(
TSharedRef< UE::Workspace::IWorkspaceEditor > InWorkspaceEditor, |
Called after loading workspace state. InWorkspaceState is an instanced struct that holds user-defined persistent workspace state. Struct is not guaranteed to be valid. | WorkspaceSchema.h | |
virtual void OnSaveWorkspaceState
(
TSharedRef< UE::Workspace::IWorkspaceEditor > InWorkspaceEditor, |
Called prior to saving workspace state to populate an instanced struct to hold user-defined persistent workspace state. | WorkspaceSchema.h | |
virtual bool SupportsViewport() |
Whether workspaces using this schema can spawn viewport tabs. | WorkspaceSchema.h |