className stringlengths 1 167 | headerPath stringlengths 14 166 | description stringlengths 0 1.62k | module stringlengths 0 76 | code stringlengths 0 11.4k | variables listlengths 0 395 |
|---|---|---|---|---|---|
SSubobjectEditor::TryHandleAssetDragDropOperation | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | Try to handle a drag-drop operation | SubobjectEditor | [FReply](API\Runtime\SlateCore\Input\FReply) TryHandleAssetDragDropOperation ( const [FDragDropEvent](API\Runtime\SlateCore\Input\FDragDropEvent) & DragDropEvent ) | [] |
SSubobjectEditor::UpdateSelectionFromNodes | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | Update any associated selection (e.g. details view) from the passed in nodes | SubobjectEditor | void UpdateSelectionFromNodes ( const [TArray](API\Runtime\Core\Containers\TArray)< FSubobjectEditorTreeNodePtrType > & SelectedNodes ) | [] |
SSubobjectEditor::UpdateTree | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | Update the contents of the Subobject Tree based on the current context | SubobjectEditor | void UpdateTree ( bool bRegenerateTreeNodes ) | [] |
SSubobjectEditor::Utils::PopulateHandlesArray | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | Populate an array of subobject handles based on an array of the slate node ptr | SubobjectEditor | static void PopulateHandlesArray &40; const TArray< FSubobjectEditorTreeNodePtrType > & SlateNodePtrs, TArray< FSubobjectDataHandle > & OutHandles &41; | [] |
Utils | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | Utils. | SubobjectEditor | struct Utils | [] |
SSubobjectEditor::SSubobjectEditor | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | Do not allow public construction of this widget! | SubobjectEditor | SSubobjectEditor() | [] |
SSubobjectEditor::~SSubobjectEditor | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | SubobjectEditor | virtual ~SSubobjectEditor() | [] | |
SSubobjectEditor | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | The base class viewer for subobject editing in Slate. This displays all subobjects of a given actor or blueprint. A subobject can be a native component on an actor or inherited components from a native or blueprint parent. | SubobjectEditor | class SSubobjectEditor : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget) | [
{
"type": "TAttribute< boo...",
"name": "AllowEditing",
"description": "Attribute to indicate whether or not editing is allowed."
},
{
"type": "bool",
"name": "bAllowTreeUpdates",
"description": "Controls whether or not to allow calls toUpdateTree()"
},
{
"type": "bool",
"nam... |
SSubobjectEditorDragDropTree::Construct | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | Object construction - mostly defers to the baseSTreeView | SubobjectEditor | void Construct ( const [FArguments](API\Editor\SubobjectEditor\SSubobjectEditorDragDropTree\FArguments) & InArgs ) | [] |
SSubobjectEditorDragDropTree::FArguments::ClearSelectionOnClick | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | SubobjectEditor | WidgetArgsType & ClearSelectionOnClick &40; bool InArg &41; | [] | |
SSubobjectEditorDragDropTree::FArguments::ExternalScrollbar | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | SubobjectEditor | WidgetArgsType & ExternalScrollbar &40; TSharedPtr< SScrollBar > InArg &41; | [] | |
SSubobjectEditorDragDropTree::FArguments::HeaderRow | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | SubobjectEditor | WidgetArgsType & HeaderRow &40; TSharedPtr< SHeaderRow > InArg &41; | [] | |
SSubobjectEditorDragDropTree::FArguments::ItemHeight | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | SubobjectEditor | WidgetArgsType & ItemHeight &40; const TAttribute< float > & InAttribute &41; | [] | |
SSubobjectEditorDragDropTree::FArguments::OnContextMenuOpening | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | SubobjectEditor | WidgetArgsType & OnContextMenuOpening &40; const FOnContextMenuOpening & InDelegate &41; | [] | |
SSubobjectEditorDragDropTree::FArguments::OnGenerateRow | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | SubobjectEditor | WidgetArgsType & OnGenerateRow &40; const FOnGenerateRow & InDelegate &41; | [] | |
SSubobjectEditorDragDropTree::FArguments::OnItemScrolledIntoView | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | SubobjectEditor | WidgetArgsType & OnItemScrolledIntoView &40; const FOnItemScrolledIntoView & InDelegate &41; | [] | |
SSubobjectEditorDragDropTree::FArguments::OnGetChildren | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | SubobjectEditor | WidgetArgsType & OnGetChildren &40; const FOnGetChildren & InDelegate &41; | [] | |
SSubobjectEditorDragDropTree::FArguments::OnMouseButtonDoubleClick | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | SubobjectEditor | WidgetArgsType & OnMouseButtonDoubleClick &40; const FOnMouseButtonDoubleClick & InDelegate &41; | [] | |
SSubobjectEditorDragDropTree::FArguments::OnSelectionChanged | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | SubobjectEditor | WidgetArgsType & OnSelectionChanged &40; const FOnSelectionChanged & InDelegate &41; | [] | |
SSubobjectEditorDragDropTree::FArguments::OnSetExpansionRecursive | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | SubobjectEditor | WidgetArgsType & OnSetExpansionRecursive &40; const FOnSetExpansionRecursive & InDelegate &41; | [] | |
SSubobjectEditorDragDropTree::FArguments::OnTableViewBadState | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | SubobjectEditor | WidgetArgsType & OnTableViewBadState &40; const FOnTableViewBadState & InDelegate &41; | [] | |
SSubobjectEditorDragDropTree::FArguments::SelectionMode | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | SubobjectEditor | WidgetArgsType & SelectionMode &40; const TAttribute< ESelectionMode::Type > & InAttribute &41; | [] | |
SSubobjectEditorDragDropTree::FArguments::SubobjectEditor | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | SubobjectEditor | WidgetArgsType & SubobjectEditor &40; SSubobjectEditor &42; InArg &41; | [] | |
SSubobjectEditorDragDropTree::FArguments::TreeItemsSource | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | SubobjectEditor | WidgetArgsType & TreeItemsSource &40; TArray< FSubobjectEditorTreeNodePtrType > &42; InArg &41; | [] | |
WidgetArgsType | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | SubobjectEditor | typedef FArguments WidgetArgsType | [] | |
SSubobjectEditorDragDropTree::FArguments::FArguments | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | SubobjectEditor | FArguments&40;&41; | [] | |
FArguments | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | SubobjectEditor | struct FArguments : public [TSlateBaseNamedArgs< SSubobjectEditorDragDropTree >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs) | [] | |
SSubobjectEditorDragDropTree::OnDragOver | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | Called during drag and drop when the the mouse is being dragged over a widget.
A reply that indicated whether this event was handled. | SubobjectEditor | virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnDragOver ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FDragDropEvent](API\Runtime\SlateCore\Input\FDragDropEvent) & DragDropEvent ) | [] |
SSubobjectEditorDragDropTree::OnDrop | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | Called when the user is dropping something onto a widget; terminates drag and drop.
A reply that indicated whether this event was handled. | SubobjectEditor | virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnDrop ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FDragDropEvent](API\Runtime\SlateCore\Input\FDragDropEvent) & DragDropEvent ) | [] |
SSubobjectEditorDragDropTree | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | Implements the specific node type and add drag/drop functionality | SubobjectEditor | class SSubobjectEditorDragDropTree : public [STreeView< FSubobjectEditorTreeNodePtrType >](API\Editor\UnrealEd\STreeView) | [] |
SSubobjectInstanceEditor::AddNewSubobject | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectInstanceEditor.h | Add a new subobject to the given parent via the subobject data subsystem | SubobjectEditor | virtual [FSubobjectDataHandle](API\Editor\SubobjectDataInterface\FSubobjectDataHandle) AddNewSubobject ( const [FSubobjectDataHandle](API\Editor\SubobjectDataInterface\FSubobjectDataHandle) & ParentHandle, [UClass](API\Runtime\CoreUObject\UObject\UClass) * NewClass, [UObject](API\Runtime\CoreUObject\UObject\UObject) * ... | [] |
SSubobjectInstanceEditor::BuildSceneRootDropActionMenu | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectInstanceEditor.h | Builds a context menu popup for dropping a child node onto the scene root node | SubobjectEditor | virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > BuildSceneRootDropActionMenu ( FSubobjectEditorTreeNodePtrType DroppedOntoNodePtr, FSubobjectEditorTreeNodePtrType DroppedNodePtr ) | [] |
SSubobjectInstanceEditor::Construct | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectInstanceEditor.h | SubobjectEditor | void Construct ( const [FArguments](API\Editor\SubobjectEditor\SSubobjectInstanceEditor\FArguments) & InArgs ) | [] | |
SSubobjectInstanceEditor::CopySelectedNodes | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectInstanceEditor.h | SubobjectEditor | virtual void CopySelectedNodes() | [] | |
SSubobjectInstanceEditor::CreateMenuBuilder | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectInstanceEditor.h | SubobjectEditor | virtual [FMenuBuilder](API\Runtime\Slate\Framework\MultiBox\FMenuBuilder) CreateMenuBuilder() | [] | |
SSubobjectInstanceEditor::FArguments::AllowEditing | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectInstanceEditor.h | SubobjectEditor | WidgetArgsType & AllowEditing &40; const TAttribute< bool > & InAttribute &41; | [] | |
SSubobjectInstanceEditor::FArguments::ObjectContext | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectInstanceEditor.h | SubobjectEditor | WidgetArgsType & ObjectContext &40; const TAttribute< UObject &42; > & InAttribute &41; | [] | |
SSubobjectInstanceEditor::FArguments::OnItemDoubleClicked | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectInstanceEditor.h | SubobjectEditor | WidgetArgsType & OnItemDoubleClicked &40; const FOnItemDoubleClicked & InDelegate &41; | [] | |
WidgetArgsType | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectInstanceEditor.h | SubobjectEditor | typedef FArguments WidgetArgsType | [] | |
SSubobjectInstanceEditor::FArguments::OnSelectionUpdated | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectInstanceEditor.h | SubobjectEditor | WidgetArgsType & OnSelectionUpdated &40; const FOnSelectionUpdated & InDelegate &41; | [] | |
SSubobjectInstanceEditor::FArguments::FArguments | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectInstanceEditor.h | SubobjectEditor | FArguments&40;&41; | [] | |
FArguments | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectInstanceEditor.h | SubobjectEditor | struct FArguments : public [TSlateBaseNamedArgs< SSubobjectInstanceEditor >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs) | [] | |
SSubobjectInstanceEditor::OnAttachToDropAction | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectInstanceEditor.h | SubobjectEditor | virtual void OnAttachToDropAction ( FSubobjectEditorTreeNodePtrType DroppedOn, const [TArray](API\Runtime\Core\Containers\TArray)< FSubobjectEditorTreeNodePtrType > & DroppedNodePtrs ) | [] | |
SSubobjectInstanceEditor::OnDeleteNodes | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectInstanceEditor.h | SubobjectEditor | virtual void OnDeleteNodes() | [] | |
SSubobjectInstanceEditor::OnDetachFromDropAction | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectInstanceEditor.h | SubobjectEditor | virtual void OnDetachFromDropAction ( const [TArray](API\Runtime\Core\Containers\TArray)< FSubobjectEditorTreeNodePtrType > & DroppedNodePtrs ) | [] | |
SSubobjectInstanceEditor::OnDuplicateComponent | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectInstanceEditor.h | SubobjectEditor | virtual void OnDuplicateComponent() | [] | |
SSubobjectInstanceEditor::OnMakeNewRootDropAction | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectInstanceEditor.h | SubobjectEditor | virtual void OnMakeNewRootDropAction ( FSubobjectEditorTreeNodePtrType DroppedNodePtr ) | [] | |
SSubobjectInstanceEditor::PasteNodes | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectInstanceEditor.h | SubobjectEditor | virtual void PasteNodes() | [] | |
SSubobjectInstanceEditor::PopulateContextMenuImpl | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectInstanceEditor.h | Populate the context menu with implementation specific details | SubobjectEditor | virtual void PopulateContextMenuImpl ( [UToolMenu](API\Developer\ToolMenus\UToolMenu) * InMenu, [TArray](API\Runtime\Core\Containers\TArray)< FSubobjectEditorTreeNodePtrType > & InSelectedItems, bool bIsChildActorSubtreeNodeSelected ) | [] |
SSubobjectInstanceEditor::PostDragDropAction | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectInstanceEditor.h | SubobjectEditor | virtual void PostDragDropAction ( bool bRegenerateTreeNodes ) | [] | |
SSubobjectInstanceEditor | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectInstanceEditor.h | This is the editor for subobjects within the level editor that works mainly with component and actor instances. | SubobjectEditor | class SSubobjectInstanceEditor : public [SSubobjectEditor](API\Editor\SubobjectEditor\SSubobjectEditor) | [] |
SSubobject_RowWidget::Construct | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | SubobjectEditor | void Construct ( const [FArguments](API\Editor\SubobjectEditor\SSubobject_RowWidget\FArguments) & InArgs, [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [SSubobjectEditor](API\Editor\SubobjectEditor\SSubobjectEditor) > InEditor, FSubobjectEditorTreeNodePtrType InNodePtr, [TSharedPtr](API\Runtime\Core\Templates\TShare... | [] | |
WidgetArgsType | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | SubobjectEditor | typedef FArguments WidgetArgsType | [] | |
SSubobject_RowWidget::FArguments::FArguments | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | SubobjectEditor | FArguments&40;&41; | [] | |
FArguments | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | SubobjectEditor | struct FArguments : public [TSlateBaseNamedArgs< SSubobject_RowWidget >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs) | [] | |
SSubobject_RowWidget::GenerateWidgetForColumn | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | Users ofSMultiColumnTableRowwould usually some piece of data associated with it. The type of this data is ItemType; it's the stuff that your TableView (i.e. List or Tree) is visualizing. The ColumnName tells you which column of the TableView we need to make a widget for. Make a widget and return it.
a widget to represe... | SubobjectEditor | virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > GenerateWidgetForColumn ( const [FName](API\Runtime\Core\UObject\FName) & InColumnName ) | [] |
SSubobject_RowWidget::GetAssetName | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | Get the asset name of this subobject from the asset brokerage | SubobjectEditor | [FText](API\Runtime\Core\Internationalization\FText) GetAssetName() const | [] |
SSubobject_RowWidget::GetAssetVisibility | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | Check if this asset is visible from the asset brokerage | SubobjectEditor | [EVisibility](API\Runtime\SlateCore\Layout\EVisibility) GetAssetVisibility() const | [] |
SSubobject_RowWidget::GetAssetPath | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | Get the asset path of this subobject from the asset brokerage | SubobjectEditor | [FText](API\Runtime\Core\Internationalization\FText) GetAssetPath() const | [] |
SSubobject_RowWidget::GetColorTintForIcon | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | SubobjectEditor | [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) GetColorTintForIcon() const | [] | |
SSubobject_RowWidget::GetIconBrush | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | SubobjectEditor | virtual const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) * GetIconBrush() const | [] | |
SSubobject_RowWidget::GetNameLabel | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | SubobjectEditor | [FText](API\Runtime\Core\Internationalization\FText) GetNameLabel() const | [] | |
SSubobject_RowWidget::GetSelectionMode | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | Called to query the selection mode for the row | SubobjectEditor | virtual [ESelectionMode::Type](API\Runtime\Slate\Framework\Views\ESelectionMode__Type) GetSelectionMode() const | [] |
SSubobject_RowWidget::GetSubobjectPtr | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | SubobjectEditor | FSubobjectEditorTreeNodePtrType GetSubobjectPtr() const | [] | |
SSubobject_RowWidget::HandleOnCanAcceptDrop | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | SubobjectEditor | [TOptional](API\Runtime\Core\IO\TOptional)< EItemDropZone > HandleOnCanAcceptDrop ( const [FDragDropEvent](API\Runtime\SlateCore\Input\FDragDropEvent) & DragDropEvent, EItemDropZone DropZone, FSubobjectEditorTreeNodePtrType TargetItem ) | [] | |
SSubobject_RowWidget::HandleOnAcceptDrop | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | SubobjectEditor | [FReply](API\Runtime\SlateCore\Input\FReply) HandleOnAcceptDrop ( const [FDragDropEvent](API\Runtime\SlateCore\Input\FDragDropEvent) & DragDropEvent, EItemDropZone DropZone, FSubobjectEditorTreeNodePtrType TargetItem ) | [] | |
SSubobject_RowWidget::HandleOnDragDetected | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | SubobjectEditor | [FReply](API\Runtime\SlateCore\Input\FReply) HandleOnDragDetected ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent ) | [] | |
SSubobject_RowWidget::HandleOnDragEnter | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | Drag-drop handlers | SubobjectEditor | void HandleOnDragEnter ( const [FDragDropEvent](API\Runtime\SlateCore\Input\FDragDropEvent) & DragDropEvent ) | [] |
SSubobject_RowWidget::HandleOnDragLeave | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | SubobjectEditor | void HandleOnDragLeave ( const [FDragDropEvent](API\Runtime\SlateCore\Input\FDragDropEvent) & DragDropEvent ) | [] | |
SSubobject_RowWidget | /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h | A row widget that represents a single subobject within the tree. | SubobjectEditor | class SSubobject_RowWidget : public [SMultiColumnTableRow< FSubobjectEditorTreeNodePtrType >](API\Runtime\Slate\Widgets\Views\SMultiColumnTableRow) | [] |
USubobjectEditorMenuContext::GetSelectedObjects | /Engine/Source/Editor/SubobjectEditor/Public/SubobjectEditorMenuContext.h | SubobjectEditor | [TArray](API\Runtime\Core\Containers\TArray)< [UObject](API\Runtime\CoreUObject\UObject\UObject) * > GetSelectedObjects() const | [] | |
USubobjectEditorMenuContext | /Engine/Source/Editor/SubobjectEditor/Public/SubobjectEditorMenuContext.h | SubobjectEditor | class USubobjectEditorMenuContext : public [UObject](API\Runtime\CoreUObject\UObject\UObject) | [
{
"type": "bool",
"name": "bOnlyShowPasteOption",
"description": ""
},
{
"type": "TWeakPtr<SSubo...",
"name": "SubobjectEditor",
"description": ""
}
] | |
FAlertMessage::FAlertMessage | /Engine/Source/Editor/SwarmInterface/Public/SwarmInterface.h | Constructor, initializes to default and specified values | SwarmInterface | FAlertMessage ( const [FGuid](API\Runtime\Core\Misc\FGuid) & InJobGuid, [TAlertLevel](API\Editor\SwarmInterface\NSwarm__TAlertLevel) InAlertLevel, const [FGuid](API\Runtime\Core\Misc\FGuid) & InObjectGuid, int InTypeId ) | [] |
FAlertMessage::FAlertMessage | /Engine/Source/Editor/SwarmInterface/Public/SwarmInterface.h | Constructor, initializes to default and specified values | SwarmInterface | FAlertMessage ( const [FGuid](API\Runtime\Core\Misc\FGuid) & InJobGuid, [TAlertLevel](API\Editor\SwarmInterface\NSwarm__TAlertLevel) InAlertLevel, const [FGuid](API\Runtime\Core\Misc\FGuid) & InObjectGuid, int InTypeId, const TCHAR * InTextMessage ) | [] |
FConnectionCallback | /Engine/Source/Editor/SwarmInterface/Public/SwarmInterface.h | A simple callback used by the Agent to send messages back to the Instigator | SwarmInterface | typedef void(* FConnectionCallback | [] |
FAlertMessage | /Engine/Source/Editor/SwarmInterface/Public/SwarmInterface.h | Implementation of a alert message, which includes: | SwarmInterface | class FAlertMessage : public [NSwarm::FMessage](API\Editor\SwarmInterface\FMessage) | [
{
"type": "TAlertLevel",
"name": "AlertLevel",
"description": "The type of alert"
},
{
"type": "FGuid",
"name": "JobGuid",
"description": "The Job Guid"
},
{
"type": "FGuid",
"name": "ObjectGuid",
"description": "The identifier for the object that is associated with the i... |
FInfoMessage::FInfoMessage | /Engine/Source/Editor/SwarmInterface/Public/SwarmInterface.h | Constructor, initializes to default and specified values | SwarmInterface | FInfoMessage ( const TCHAR * InTextMessage ) | [] |
FInfoMessage | /Engine/Source/Editor/SwarmInterface/Public/SwarmInterface.h | Implementation of a generic info message, which just includes generic text. | SwarmInterface | class FInfoMessage : public [NSwarm::FMessage](API\Editor\SwarmInterface\FMessage) | [
{
"type": "const TCHAR \u0004...",
"name": "TextMessage",
"description": "Generic text message for informational purposes"
}
] |
FJobSpecification::AddDependencies | /Engine/Source/Editor/SwarmInterface/Public/SwarmInterface.h | Used to add channel dependencies to a Job. When an Agent runs this Job, it will ensure that all dependencies are satisfied prior to launching the executable. Note that the Job executable is an implied dependency. | SwarmInterface | void AddDependencies ( const TCHAR ** NewRequiredDependencies, uint32 NewRequiredDependencyCount, const TCHAR ** NewOptionalDependencies, uint32 NewOptionalDependencyCount ) | [] |
FJobSpecification::AddDescription | /Engine/Source/Editor/SwarmInterface/Public/SwarmInterface.h | SwarmInterface | void AddDescription ( const TCHAR ** NewDescriptionKeys, const TCHAR ** NewDescriptionValues, uint32 NewDescriptionCount ) | [] | |
FJobSpecification::FJobSpecification | /Engine/Source/Editor/SwarmInterface/Public/SwarmInterface.h | Default constructor, initializes to an empty (invalid) job. | SwarmInterface | FJobSpecification() | [] |
FJobSpecification::FJobSpecification | /Engine/Source/Editor/SwarmInterface/Public/SwarmInterface.h | Constructor, initializes to default and specified values | SwarmInterface | FJobSpecification ( const TCHAR * JobExecutableName, const TCHAR * JobParameters, [TJobTaskFlags](API\Editor\SwarmInterface\NSwarm__TJobTaskFlags) JobFlags ) | [] |
FJobSpecification | /Engine/Source/Editor/SwarmInterface/Public/SwarmInterface.h | Encapsulates information about a Job specification passed into BeginJobSpecification | SwarmInterface | class FJobSpecification | [
{
"type": "uint32",
"name": "DescriptionCount",
"description": ""
},
{
"type": "const TCHAR \u0004...",
"name": "DescriptionKeys",
"description": "Optional Job description values in key/value form"
},
{
"type": "const TCHAR \u0004...",
"name": "DescriptionValues",
"descri... |
FJobState::FJobState | /Engine/Source/Editor/SwarmInterface/Public/SwarmInterface.h | Constructor, initializes to specified values | SwarmInterface | FJobState ( [FGuid](API\Runtime\Core\Misc\FGuid) NewJobGuid, [TJobTaskState](API\Editor\SwarmInterface\NSwarm__TJobTaskState) NewJobState ) | [] |
FJobState | /Engine/Source/Editor/SwarmInterface/Public/SwarmInterface.h | Encapsulates information about a Job's state, used to communicate back to the Instigator | SwarmInterface | class FJobState : public [NSwarm::FMessage](API\Editor\SwarmInterface\FMessage) | [
{
"type": "int32",
"name": "JobExitCode",
"description": "Various stats, including run time, exit codes, etc."
},
{
"type": "FGuid",
"name": "JobGuid",
"description": "The Job GUID used for identifying the Job"
},
{
"type": "const TCHAR \u0004...",
"name": "JobMessage",
"... |
FMessage::FMessage | /Engine/Source/Editor/SwarmInterface/Public/SwarmInterface.h | Default constructor, initializes to default values | SwarmInterface | FMessage() | [] |
FMessage::FMessage | /Engine/Source/Editor/SwarmInterface/Public/SwarmInterface.h | Constructor, initializes to specified values | SwarmInterface | FMessage ( [TSwarmVersionValue](API\Editor\SwarmInterface\NSwarm__TSwarmVersionValue) NewVersion, [TMessageType](API\Editor\SwarmInterface\NSwarm__TMessageType) NewType ) | [] |
FMessage::FMessage | /Engine/Source/Editor/SwarmInterface/Public/SwarmInterface.h | Constructor, initializes to specified values | SwarmInterface | FMessage ( [TMessageType](API\Editor\SwarmInterface\NSwarm__TMessageType) NewType ) | [] |
FMessage | /Engine/Source/Editor/SwarmInterface/Public/SwarmInterface.h | A simple base class for messages. For each version of the messaging interface a newly derived type will inherit from this class. The base class is used to simply carry lightweight loads for messages, i.e. just the message type, which may be enough information in itself. For additional message data, subclass and add any... | SwarmInterface | class FMessage | [
{
"type": "TMessageType",
"name": "Type",
"description": "The type of the message, one of EMessageType"
},
{
"type": "TSwarmVersionVa...",
"name": "Version",
"description": "The version of the message format; one of ESwarmVersionValue"
}
] |
FSwarmInterface::AddChannel | /Engine/Source/Editor/SwarmInterface/Public/SwarmInterface.h | Adds an existing file to the cache. Note, any existing channel with the same name will be overwritten.
int32 Error code (< 0 is an error) | SwarmInterface | int32 AddChannel ( const TCHAR * FullPath, const TCHAR * ChannelName ) | [] |
FSwarmInterface::AddTask | /Engine/Source/Editor/SwarmInterface/Public/SwarmInterface.h | Adds a Task to the current Job
int32 Error code (< 0 is an error) | SwarmInterface | int32 AddTask ( const [FTaskSpecification](API\Editor\SwarmInterface\FTaskSpecification) & Specification ) | [] |
FSwarmInterface::BeginJobSpecification | /Engine/Source/Editor/SwarmInterface/Public/SwarmInterface.h | The default behavior will be to execute the Job executable with the specified parameters. If Tasks are added for the Job, they are expected to be requested by the executable run for the Job. If no Tasks are added for the Job, it is expected that the Job executable will perform its operations without additional Task inp... | SwarmInterface | int32 BeginJobSpecification ( const [FJobSpecification](API\Editor\SwarmInterface\FJobSpecification) & Specification32, const [FJobSpecification](API\Editor\SwarmInterface\FJobSpecification) & Specification64 ) | [] |
FSwarmInterface::CloseChannel | /Engine/Source/Editor/SwarmInterface/Public/SwarmInterface.h | Closes an open channel
int32 Error code (< 0 is an error) | SwarmInterface | int32 CloseChannel ( int32 Channel ) | [] |
FSwarmInterface::CloseConnection | /Engine/Source/Editor/SwarmInterface/Public/SwarmInterface.h | Closes an existing connection to the Swarm
int32 Error code (< 0 is an error) | SwarmInterface | int32 CloseConnection() | [] |
FSwarmInterface::CloseJob | /Engine/Source/Editor/SwarmInterface/Public/SwarmInterface.h | Ends the Job, after which all Job-related API usage (except OpenJob) will be rejected
int32 Error code (< 0 is an error) | SwarmInterface | int32 CloseJob() | [] |
FSwarmInterface::EndJobSpecification | /Engine/Source/Editor/SwarmInterface/Public/SwarmInterface.h | Ends the Job specification, after which no additional Tasks may be defined. Also, this is generally the point when the Agent will validate and launch the Job executable, potentially distributing the Job to other Agents.
int32 Error code (< 0 is an error) | SwarmInterface | int32 EndJobSpecification() | [] |
GInstance | /Engine/Source/Editor/SwarmInterface/Public/SwarmInterface.h | SwarmInterface | static [FSwarmInterface](API\Editor\SwarmInterface\FSwarmInterface) * GInstance = NULL; | [] | |
FSwarmInterface::Get | /Engine/Source/Editor/SwarmInterface/Public/SwarmInterface.h | The Swarm singleton | SwarmInterface | static [FSwarmInterface](API\Editor\SwarmInterface\FSwarmInterface) & Get() | [] |
FSwarmInterface::Initialize | /Engine/Source/Editor/SwarmInterface/Public/SwarmInterface.h | Initializes the Swarm singleton, must be called beforeFSwarmInterface::Get().
A boolean indicating if the initialization was successful | SwarmInterface | static bool Initialize ( const TCHAR * SwarmInterfacePath ) | [] |
FSwarmInterface::IsJobProcessRunning | /Engine/Source/Editor/SwarmInterface/Public/SwarmInterface.h | Checks if the job's process is still running
bool true if process is still running | SwarmInterface | virtual bool IsJobProcessRunning ( int32 * OutStatus ) | [] |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.