Navigation
API > API/Runtime > API/Runtime/Engine
Component to handle receiving notifications from the OS about platform events.
| Name | UPlatformEventsComponent |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Classes/Components/PlatformEventsComponent.h |
| Include Path | #include "Components/PlatformEventsComponent.h" |
Syntax
UCLASS (ClassGroup=Utility, HideCategories=(Activation, "Components|Activation", Collision),
Meta=(BlueprintSpawnableComponent), MinimalAPI)
class UPlatformEventsComponent : public UActorComponent
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UActorComponent → UPlatformEventsComponent
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UPlatformEventsComponent
(
const FObjectInitializer& ObjectInitializer |
Components/PlatformEventsComponent.h |
Classes
| Name | Remarks |
|---|---|
| FPlatformEventDelegate |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| PlatformChangedToLaptopModeDelegate | FPlatformEventDelegate | This is called when a convertible laptop changed into laptop mode. | Components/PlatformEventsComponent.h |
|
| PlatformChangedToTabletModeDelegate | FPlatformEventDelegate | This is called when a convertible laptop changed into tablet mode. | Components/PlatformEventsComponent.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool IsInLaptopMode () |
Check whether a convertible laptop is laptop mode. | Components/PlatformEventsComponent.h |
|
bool IsInTabletMode () |
Check whether a convertible laptop is laptop mode. | Components/PlatformEventsComponent.h |
|
bool SupportsConvertibleLaptops () |
Check whether the platform supports convertible laptops. | Components/PlatformEventsComponent.h |
|
Overridden from UActorComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnRegister() |
Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called. | Components/PlatformEventsComponent.h | |
virtual void OnUnregister () |
Called when a component is unregistered. | Components/PlatformEventsComponent.h |