Navigation
API > API/Plugins > API/Plugins/UIFramework
A valid snapshot of the widget tree that can be replicated to local instance. Authority widgets know their parent/children relation. That information is not replicated to the local widgets. When a widget is added to the tree, the tree is updated. The widget now has to inform the tree when that relationship changes until it's remove from the tree.
| Name | FUIFrameworkWidgetTree |
| Type | struct |
| Header File | /Engine/Plugins/Experimental/UIFramework/Source/Public/Types/UIFWidgetTree.h |
| Include Path | #include "Types/UIFWidgetTree.h" |
Syntax
USTRUCT ()
struct FUIFrameworkWidgetTree : public FFastArraySerializer
Inheritance Hierarchy
- FFastArraySerializer → FUIFrameworkWidgetTree
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FUIFrameworkWidgetTree
(
AActor* InReplicatedOwner, |
Types/UIFWidgetTree.h | ||
| Types/UIFWidgetTree.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FUIFrameworkWidgetTree() |
Types/UIFWidgetTree.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FUIFrameworkWidgetDelegate | TMulticastDelegate_OneParam< void, UUIFrameworkWidget * > | Types/UIFWidgetTree.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AuthorityOnWidgetAdded | FUIFrameworkWidgetDelegate | Types/UIFWidgetTree.h | ||
| AuthorityOnWidgetRemoved | FUIFrameworkWidgetDelegate | Types/UIFWidgetTree.h | ||
| LocalOnWidgetAdded | FUIFrameworkWidgetDelegate | Types/UIFWidgetTree.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AuthorityIndexByWidgetMap | TMap< FObjectKey, int32 > | Types/UIFWidgetTree.h | ||
| Entries | TArray< FUIFrameworkWidgetTreeEntry > | Types/UIFWidgetTree.h | ||
| Owner | IUIFrameworkWidgetTreeOwner * | Types/UIFWidgetTree.h | ||
| ReplicatedOwner | TObjectPtr< AActor > | Types/UIFWidgetTree.h |
|
|
| WidgetByIdMap | TMap< FUIFrameworkWidgetId, TWeakObjectPtr< UUIFrameworkWidget > > | Types/UIFWidgetTree.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AuthorityAddAllWidgetsFromActorChannel() |
Add all widgets in the tree to the ActorChannel replicated list | Types/UIFWidgetTree.h | |
void AuthorityAddRoot
(
UUIFrameworkWidget* Widget |
Add a new widget to the top hierarchy. | Types/UIFWidgetTree.h | |
void AuthorityAddWidget
(
UUIFrameworkWidget* Parent, |
Change the parent / child relationship of the child widget. | Types/UIFWidgetTree.h | |
void AuthorityRemoveAllWidgetsFromActorChannel() |
Removes all widgets added to the ActorChannel replicated list | Types/UIFWidgetTree.h | |
void AuthorityRemoveWidgetAndChildren
(
UUIFrameworkWidget* Widget |
Remove the widget and all of its children and grand-children from the tree. | Types/UIFWidgetTree.h | |
void AuthorityTest() |
Types/UIFWidgetTree.h | ||
const FUIFrameworkWidgetTreeEntry * FindRootEntryById
(
FUIFrameworkWidgetId WidgetId |
Gets the root widget of the tree given the Id of a widget in the tree | Types/UIFWidgetTree.h | |
const UUIFrameworkWidget * FindWidgetById
(
FUIFrameworkWidgetId WidgetId |
Types/UIFWidgetTree.h | ||
UUIFrameworkWidget * FindWidgetById
(
FUIFrameworkWidgetId WidgetId |
Find the widget by its unique Id. The widget needs to be in the Tree. | Types/UIFWidgetTree.h | |
AActor * GetReplicationOwner() |
Types/UIFWidgetTree.h | ||
const FUIFrameworkWidgetTreeEntry * LocalGetEntryByReplicationId
(
int32 WidgetId |
Types/UIFWidgetTree.h | ||
FUIFrameworkWidgetTreeEntry * LocalGetEntryByReplicationId
(
int32 WidgetId |
Types/UIFWidgetTree.h | ||
void LocalRemoveRoot
(
const UUIFrameworkWidget* Widget |
The widget was removed from the client and the Authority is not aware of it. | Types/UIFWidgetTree.h | |
void LogTree() |
Types/UIFWidgetTree.h | ||
void LogWidgetsChildren() |
Types/UIFWidgetTree.h | ||
bool NetDeltaSerialize
(
FNetDeltaSerializeInfo& DeltaParms |
Types/UIFWidgetTree.h | ||
void PostReplicatedAdd
(
const TArrayView< int32 > AddedIndices, |
Types/UIFWidgetTree.h | ||
void PostReplicatedChange
(
const TArrayView< int32 >& ChangedIndices, |
Types/UIFWidgetTree.h | ||
void PreReplicatedRemove
(
const TArrayView< int32 > RemovedIndices, |
Types/UIFWidgetTree.h | ||
bool ReplicateSubWidgets
(
UActorChannel* Channel, |
Types/UIFWidgetTree.h |