BlueprintPlatformLibrary.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "UObject/TextProperty.h"
#include "Engine/GameInstance.h"
#include "Kismet/BlueprintFunctionLibrary.h"
#include "BlueprintPlatformLibrary.generated.h"
 
class ILocalNotificationService;
enum class EDeviceScreenOrientation : uint8;
 
UENUM(BlueprintType)
namespace EScreenOrientation
{
    enum Type : int
    {
        Unknown,
 
        Portrait,
 
        PortraitUpsideDown,
 
        LandscapeLeft,
 
        LandscapeRight,
 
        FaceUp,
 
        FaceDown,
 
        PortraitSensor,
 
        LandscapeSensor,
 
        FullSensor
    };
}
 
// application state when the game receives a notification
UENUM(BlueprintType)
namespace EApplicationState
{
    enum Type : int
    {
        Unknown,
 
        Inactive,
 
        Background,
 
        Active,
    };
}
 
UCLASS(Blueprintable, BlueprintType, ClassGroup=Mobile, MinimalAPI)
class UPlatformGameInstance : public UGameInstance
{
    GENERATED_BODY()
 
public:
 
    DECLARE_DYNAMIC_MULTICAST_DELEGATE(FPlatformDelegate);
    DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FPlatformStartupArgumentsDelegate, const TArray<FString>&, StartupArguments);
    DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FPlatformRegisteredForRemoteNotificationsDelegate, const TArray<uint8>&, inArray);
    DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FPlatformRegisteredForUserNotificationsDelegate, int32, inInt);
    DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FPlatformFailedToRegisterForRemoteNotificationsDelegate, FString, inString);
    DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FPlatformReceivedRemoteNotificationDelegate, FString, inString, EApplicationState::Type, inAppState);
    DECLARE_DYNAMIC_MULTICAST_DELEGATE_ThreeParams(FPlatformReceivedLocalNotificationDelegate, FString, inString, int32, inInt, EApplicationState::Type, inAppState);
    DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FPlatformScreenOrientationChangedDelegate, EScreenOrientation::Type, inScreenOrientation);
 
    // This is called when the application is about to be deactivated (e.g., due to a phone call or SMS or the sleep button). 
    // The game should be paused if possible, etc... 
    UPROPERTY(BlueprintAssignable)
    FPlatformDelegate ApplicationWillDeactivateDelegate;
    
    // Called when the application has been reactivated (reverse any processing done in the Deactivate delegate)
    UPROPERTY(BlueprintAssignable)
    FPlatformDelegate ApplicationHasReactivatedDelegate;
    
    // This is called when the application is being backgrounded (e.g., due to switching  
    // to another app or closing it via the home button)  
    // The game should release shared resources, save state, etc..., since it can be  
    // terminated from the background state without any further warning.  
    UPROPERTY(BlueprintAssignable)  
    FPlatformDelegate ApplicationWillEnterBackgroundDelegate; // for instance, hitting the home button
    
    // Called when the application is returning to the foreground (reverse any processing done in the EnterBackground delegate)
    UPROPERTY(BlueprintAssignable)
    FPlatformDelegate ApplicationHasEnteredForegroundDelegate;
    
    // This *may* be called when the application is getting terminated by the OS.  
    // There is no guarantee that this will ever be called on a mobile device,  
    // save state when ApplicationWillEnterBackgroundDelegate is called instead.  
    UPROPERTY(BlueprintAssignable)
    FPlatformDelegate ApplicationWillTerminateDelegate;
 
    // Called when the OS is running low on resources and asks the application to free up any cached resources, drop graphics quality etc.
    UPROPERTY(BlueprintAssignable)
    FPlatformDelegate ApplicationShouldUnloadResourcesDelegate;
 
    // Called with arguments passed to the application on statup, perhaps meta data passed on by another application which launched this one.
    UPROPERTY(BlueprintAssignable)
    FPlatformStartupArgumentsDelegate ApplicationReceivedStartupArgumentsDelegate;
 
    // called when the user grants permission to register for remote notifications
    UPROPERTY(BlueprintAssignable)
    FPlatformRegisteredForRemoteNotificationsDelegate ApplicationRegisteredForRemoteNotificationsDelegate;
 
    // called when the user grants permission to register for notifications
    UPROPERTY(BlueprintAssignable)
    FPlatformRegisteredForUserNotificationsDelegate ApplicationRegisteredForUserNotificationsDelegate;
 
    // called when the application fails to register for remote notifications
    UPROPERTY(BlueprintAssignable)
    FPlatformFailedToRegisterForRemoteNotificationsDelegate ApplicationFailedToRegisterForRemoteNotificationsDelegate;
 
    // called when the application receives a remote notification
    UPROPERTY(BlueprintAssignable)
    FPlatformReceivedRemoteNotificationDelegate ApplicationReceivedRemoteNotificationDelegate;
 
    // called when the application receives a local notification
    UPROPERTY(BlueprintAssignable)
    FPlatformReceivedLocalNotificationDelegate ApplicationReceivedLocalNotificationDelegate;
 
    // called when the application receives a screen orientation change notification
    UPROPERTY(BlueprintAssignable)
    FPlatformScreenOrientationChangedDelegate ApplicationReceivedScreenOrientationChangedNotificationDelegate;
 
public:
 
    ENGINE_API virtual void PostInitProperties() override;
    ENGINE_API virtual void BeginDestroy() override;
 
private:
    void ApplicationWillDeactivateDelegate_Handler() { ApplicationWillDeactivateDelegate.Broadcast(); }
    void ApplicationHasReactivatedDelegate_Handler() { ApplicationHasReactivatedDelegate.Broadcast(); }
    void ApplicationWillEnterBackgroundDelegate_Handler() 
    { 
        SCOPED_ENTER_BACKGROUND_EVENT(STAT_UPlatformGameInstance_ApplicationWillEnterBackground);
        ApplicationWillEnterBackgroundDelegate.Broadcast();
    }
    void ApplicationHasEnteredForegroundDelegate_Handler() { ApplicationHasEnteredForegroundDelegate.Broadcast(); }
    void ApplicationWillTerminateDelegate_Handler() { ApplicationWillTerminateDelegate.Broadcast(); }
    void ApplicationShouldUnloadResourcesDelegate_Handler() { ApplicationShouldUnloadResourcesDelegate.Broadcast(); }
    void ApplicationReceivedStartupArgumentsDelegate_Handler(const TArray<FString>& StartupArguments) { ApplicationReceivedStartupArgumentsDelegate.Broadcast(StartupArguments); }
    void ApplicationRegisteredForRemoteNotificationsDelegate_Handler(TArray<uint8> inArray) { ApplicationRegisteredForRemoteNotificationsDelegate.Broadcast(inArray); }
    void ApplicationRegisteredForUserNotificationsDelegate_Handler(int32 inInt) { ApplicationRegisteredForUserNotificationsDelegate.Broadcast(inInt); }
    void ApplicationFailedToRegisterForRemoteNotificationsDelegate_Handler(FString inFString) { ApplicationFailedToRegisterForRemoteNotificationsDelegate.Broadcast(inFString); }
    void ApplicationReceivedRemoteNotificationDelegate_Handler(FString inFString, int32 inAppState);
    void ApplicationReceivedLocalNotificationDelegate_Handler(FString inFString, int32 inInt, int32 inAppState);
    void ApplicationReceivedScreenOrientationChangedNotificationDelegate_Handler(int32 inScreenOrientation);
 
};
 
UCLASS(meta=(ScriptName="PlatformLibrary"), MinimalAPI)
class UBlueprintPlatformLibrary : public UBlueprintFunctionLibrary
{
    GENERATED_UCLASS_BODY()
    
    static ENGINE_API ILocalNotificationService*    platformService;
    
public:
        
    UFUNCTION(BlueprintCallable, Category="Platform|LocalNotification")
    static ENGINE_API void ClearAllLocalNotifications();
 
    UFUNCTION(BlueprintCallable, Category="Platform|LocalNotification")
    static ENGINE_API int32 ScheduleLocalNotificationAtTime(const FDateTime& FireDateTime, bool LocalTime, const FText& Title, const FText& Body, const FText& Action, const FString& ActivationEvent);
 
    UFUNCTION(BlueprintCallable, Category="Platform|LocalNotification")
    static ENGINE_API int32 ScheduleLocalNotificationFromNow(int32 inSecondsFromNow, const FText& Title, const FText& Body, const FText& Action, const FString& ActivationEvent);
 
    UFUNCTION(BlueprintCallable, Category = "Platform|LocalNotification")
    static ENGINE_API int32 ScheduleLocalNotificationBadgeAtTime(const FDateTime& FireDateTime, bool LocalTime, const FString& ActivationEvent);
    
    UFUNCTION(BlueprintCallable, Category = "Platform|LocalNotification")
    static ENGINE_API void ScheduleLocalNotificationBadgeFromNow(int32 inSecondsFromNow, const FString& ActivationEvent);
 
    UFUNCTION(BlueprintCallable, Category="Platform|LocalNotification")
    static ENGINE_API void CancelLocalNotification(const FString& ActivationEvent);
 
    UFUNCTION(BlueprintCallable, Category="Platform|LocalNotification")
    static ENGINE_API void CancelLocalNotificationById(int32 NotificationId);
 
    UFUNCTION(BlueprintCallable, Category="Platform|LocalNotification")
    static ENGINE_API void GetLaunchNotification(bool& NotificationLaunchedApp, FString& ActivationEvent, int32& FireDate);
 
    UFUNCTION(BlueprintPure, Category="Platform|LocalNotification")
    static ENGINE_API EScreenOrientation::Type GetDeviceOrientation();
 
    UFUNCTION(BlueprintPure, Category = "Platform|LocalNotification")
    static ENGINE_API EScreenOrientation::Type GetAllowedDeviceOrientation();
 
    UFUNCTION(BlueprintCallable, Category = "Platform|LocalNotification")
    static ENGINE_API void SetAllowedDeviceOrientation(EScreenOrientation::Type NewAllowedDeviceOrientation);
 
private:
 
    static EScreenOrientation::Type ConvertToScreenOrientation(EDeviceScreenOrientation DeviceScreenOrientation);
 
    static EDeviceScreenOrientation ConvertToDeviceScreenOrientation(EScreenOrientation::Type ScreenOrientation);
};