Navigation
API > API/Plugins > API/Plugins/UIFramework
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UActorComponent
- UUIFrameworkPlayerComponent
References
| Module | UIFramework |
| Header | /Engine/Plugins/Experimental/UIFramework/Source/Public/UIFPlayerComponent.h |
| Include | #include "UIFPlayerComponent.h" |
Syntax
UCLASS&40;Blueprintable, Meta&61;&40;BlueprintSpawnableComponent&41;&41;
class UUIFrameworkPlayerComponent :
public UActorComponent,
public IUIFrameworkWidgetTreeOwner
Constructors
No constructors are accessible with public or protected access.
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | AddWidget
(
FUIFrameworkGameLayerSlot Widget |
||
| void | AuthorityRemoveChild
(
UUIFrameworkWidget* Widget |
||
| FOnPendingReplicationProcessed & | |||
| T * | Gets the controller that owns the component, this will always be valid during gameplay but can return null in the editor | ||
| T * | |||
| const FUIFrameworkGameLayerSlotList & | GetRootList () |
||
| void | RemoveWidget
(
UUIFrameworkWidget* Widget |
Overridden from UActorComponent
| Type | Name | Description | |
|---|---|---|---|
| void | Initializes the component. | ||
| bool | ReplicateSubobjects
(
UActorChannel* Channel, |
Allows a component to replicate other subobject on the actor. | |
| void | TickComponent
(
float DeltaTime, |
Function called every frame on this ActorComponent. | |
| void | Handle this component being Uninitialized. |
Overridden from IUIFrameworkWidgetTreeOwner
| Type | Name | Description | |
|---|---|---|---|
| FUIFrameworkWidgetOwner | The object that will be used to create the UserWidget. | ||
| FUIFrameworkWidgetTree & | The widget tree. | ||
| void | LocalRemoveWidgetRootFromTree
(
const UUIFrameworkWidget* Widget |
Remove the widget (and the child) from the server. | |
| void | LocalWidgetRemovedFromTree
(
const FUIFrameworkWidgetTreeEntry& Entry |
A widget was removed to the tree. | |
| void | LocalWidgetWasAddedToTree
(
const FUIFrameworkWidgetTreeEntry& Entry |
A widget was added to the tree. |