Navigation
API > API/Runtime > API/Runtime/Engine
Component to handle receiving notifications from the OS about application state (activated, suspended, termination, etc).
| Name | UApplicationLifecycleComponent |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Classes/Components/ApplicationLifecycleComponent.h |
| Include Path | #include "Components/ApplicationLifecycleComponent.h" |
Syntax
UCLASS (ClassGroup=Utility, HideCategories=(Activation, "Components|Activation", Collision),
Meta=(BlueprintSpawnableComponent), MinimalAPI)
class UApplicationLifecycleComponent : public UActorComponent
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UActorComponent → UApplicationLifecycleComponent
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UApplicationLifecycleComponent
(
const FObjectInitializer& ObjectInitializer |
Components/ApplicationLifecycleComponent.h |
Classes
| Name | Remarks |
|---|---|
| FApplicationLifetimeDelegate | |
| FApplicationStartupArgumentsDelegate | |
| FOnLowPowerModeDelegate | |
| FOnTemperatureChangeDelegate |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ApplicationHasEnteredForegroundDelegate | FApplicationLifetimeDelegate | Called when the application is returning to the foreground (reverse any processing done in the EnterBackground delegate) | Components/ApplicationLifecycleComponent.h |
|
| ApplicationHasReactivatedDelegate | FApplicationLifetimeDelegate | Called when the application has been reactivated (reverse any processing done in the Deactivate delegate) | Components/ApplicationLifecycleComponent.h |
|
| ApplicationReceivedStartupArgumentsDelegate | FApplicationStartupArgumentsDelegate | Called with arguments passed to the application on statup, perhaps meta data passed on by another application which launched this one. | Components/ApplicationLifecycleComponent.h |
|
| ApplicationShouldUnloadResourcesDelegate | FApplicationLifetimeDelegate | Called when the OS is running low on resources and asks the application to free up any cached resources, drop graphics quality etc. | Components/ApplicationLifecycleComponent.h |
|
| ApplicationWillDeactivateDelegate | FApplicationLifetimeDelegate | This is called when the application is about to be deactivated (e.g., due to a phone call or SMS or the sleep button). | Components/ApplicationLifecycleComponent.h |
|
| ApplicationWillEnterBackgroundDelegate | FApplicationLifetimeDelegate | This is called when the application is being backgrounded (e.g., due to switching | ||
| to another app or closing it via the home button) | Components/ApplicationLifecycleComponent.h |
|
||
| ApplicationWillTerminateDelegate | FApplicationLifetimeDelegate | This may be called when the application is getting terminated by the OS. | Components/ApplicationLifecycleComponent.h |
|
| OnLowPowerModeDelegate | FOnLowPowerModeDelegate | Called when we are in low power mode. | Components/ApplicationLifecycleComponent.h |
|
| OnTemperatureChangeDelegate | FOnTemperatureChangeDelegate | Called when temperature level has changed, and receives the severity. | Components/ApplicationLifecycleComponent.h |
|
Functions
Public
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/ApplicationLifecycleComponent.h | |
virtual void OnUnregister () |
Called when a component is unregistered. | Components/ApplicationLifecycleComponent.h |