Navigation
API > API/Plugins > API/Plugins/UIFramework
| Name | UUIFrameworkPlayerComponent |
| Type | class |
| Header File | /Engine/Plugins/Experimental/UIFramework/Source/Public/UIFPlayerComponent.h |
| Include Path | #include "UIFPlayerComponent.h" |
Syntax
UCLASS (MinimalAPI, Blueprintable, Meta=(BlueprintSpawnableComponent))
class UUIFrameworkPlayerComponent :
public UActorComponent ,
public IUIFrameworkWidgetTreeOwner
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UActorComponent → UUIFrameworkPlayerComponent
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UUIFrameworkPlayerComponent() |
UIFPlayerComponent.h |
Structs
| Name | Remarks |
|---|---|
| FWidgetClassToLoad |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AddPending | TSet< int32 > | UIFPlayerComponent.h |
|
|
| bAddingWidget | bool | UIFPlayerComponent.h | ||
| ClassesToLoad | TMap< TSoftClassPtr< UWidget >, FWidgetClassToLoad > | UIFPlayerComponent.h | ||
| FUIFrameworkGameLayerSlotList | friend | UIFPlayerComponent.h | ||
| NetReplicationPending | TSet< int32 > | UIFPlayerComponent.h |
|
|
| OnPendingReplicationProcessed | FOnPendingReplicationProcessed | UIFPlayerComponent.h | ||
| PendingWidgetConstructedTickerHandle | FTSTicker::FDelegateHandle | UIFPlayerComponent.h | ||
| Presenter | TObjectPtr< UUIFrameworkPresenter > | UIFPlayerComponent.h |
|
|
| RootList | FUIFrameworkGameLayerSlotList | UIFPlayerComponent.h |
|
|
| WidgetToFocus | FUIFrameworkWidgetId | UIFPlayerComponent.h |
|
|
| WidgetTree | FUIFrameworkWidgetTree | UIFPlayerComponent.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddWidget
(
FUIFrameworkGameLayerSlot Widget |
UIFPlayerComponent.h |
|
|
void AuthorityRemoveChild
(
UUIFrameworkWidget* Widget |
UIFPlayerComponent.h | ||
FOnPendingReplicationProcessed & GetOnPendingReplicationProcessed() |
UIFPlayerComponent.h | ||
T * GetPlayerController() |
Gets the controller that owns the component, this will always be valid during gameplay but can return null in the editor | UIFPlayerComponent.h | |
T * GetPlayerControllerChecked() |
UIFPlayerComponent.h | ||
const FUIFrameworkGameLayerSlotList & GetRootList() |
UIFPlayerComponent.h | ||
void RemoveWidget
(
UUIFrameworkWidget* Widget |
UIFPlayerComponent.h |
|
|
void SetWidgetToFocus
(
FUIFrameworkWidgetId WidgetId |
UIFPlayerComponent.h |
Overridden from UActorComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void InitializeComponent() |
UIFPlayerComponent.h | ||
virtual bool ReplicateSubobjects
(
UActorChannel* Channel, |
UIFPlayerComponent.h | ||
virtual void TickComponent
(
float DeltaTime, |
UIFPlayerComponent.h | ||
virtual void UninitializeComponent() |
UIFPlayerComponent.h |
Overridden from IUIFrameworkWidgetTreeOwner
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FUIFrameworkWidgetOwner GetWidgetOwner() |
The object that will be used to create the UserWidget. | UIFPlayerComponent.h | |
virtual FUIFrameworkWidgetTree & GetWidgetTree() |
The widget tree. | UIFPlayerComponent.h | |
virtual void LocalRemoveWidgetRootFromTree
(
const UUIFrameworkWidget* Widget |
Remove the widget (and the child) from the server. | UIFPlayerComponent.h | |
virtual void LocalWidgetRemovedFromTree
(
const FUIFrameworkWidgetTreeEntry& Entry |
A widget was removed to the tree. | UIFPlayerComponent.h | |
virtual void LocalWidgetWasAddedToTree
(
const FUIFrameworkWidgetTreeEntry& Entry |
A widget was added to the tree. | UIFPlayerComponent.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void LocalAddChild
(
FUIFrameworkWidgetId WidgetId |
UIFPlayerComponent.h |