1. Epic GamesDeveloper
  3. UBlueprintPlatformLibrary

UBlueprintPlatformLibrary

API > API/Runtime > API/Runtime/Engine

   
Name UBlueprintPlatformLibrary
Type class
Header File /Engine/Source/Runtime/Engine/Classes/Kismet/BlueprintPlatformLibrary.h
Include Path #include "Kismet/BlueprintPlatformLibrary.h"

Syntax

UCLASS (Meta=(ScriptName="PlatformLibrary"), MinimalAPI)  
class UBlueprintPlatformLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UBlueprintPlatformLibrary ( const FObjectInitializer& ObjectInitializer
)

   Kismet/BlueprintPlatformLibrary.h  

Constants

Name Type Remarks Include Path
platformService ILocalNotificationService *   Kismet/BlueprintPlatformLibrary.h

Functions

Public

Static

Name Remarks Include Path Unreal Specifiers

static void CancelLocalNotification ( const FString& ActivationEvent
)

 Cancel a local notification given the ActivationEvent Kismet/BlueprintPlatformLibrary.h
  • BlueprintCallable
  • Category="Platform|LocalNotification"

static void CancelLocalNotificationById ( int32 NotificationId
)

 Cancel a local notification given the ActivationEvent Kismet/BlueprintPlatformLibrary.h
  • BlueprintCallable
  • Category="Platform|LocalNotification"
Clear all pending local notifications. Kismet/BlueprintPlatformLibrary.h
  • BlueprintCallable
  • Category="Platform|LocalNotification"

static EDeviceScreenOrientation ConvertToDeviceScreenOrientation ( EScreenOrientation::Type ScreenOrientation
)

   Kismet/BlueprintPlatformLibrary.h  

static EScreenOrientation::Type ConvertToScreenOrientation ( EDeviceScreenOrientation DeviceScreenOrientation
)

   Kismet/BlueprintPlatformLibrary.h  
Returns the allowed orientation of the device. Kismet/BlueprintPlatformLibrary.h
  • BlueprintPure
  • Category="Platform|LocalNotification"

static EScreenOrientation::Type GetDeviceOrientation()

 Returns the current orientation of the device: will be either Portrait, LandscapeLeft, PortraitUpsideDown or LandscapeRight. Kismet/BlueprintPlatformLibrary.h
  • BlueprintPure
  • Category="Platform|LocalNotification"

static void GetLaunchNotification ( bool& NotificationLaunchedApp,
FString& ActivationEvent,
int32& FireDate
)

 Get the local notification that was used to launch the app Kismet/BlueprintPlatformLibrary.h
  • BlueprintCallable
  • Category="Platform|LocalNotification"

static int32 ScheduleLocalNotificationAtTime ( const FDateTime& FireDateTime,
bool LocalTime,
const FText& Title,
const FText& Body,
const FText& Action,
const FString& ActivationEvent
)

 Schedule a local notification at a specific time, inLocalTime specifies the current local time or if UTC time should be used Kismet/BlueprintPlatformLibrary.h
  • BlueprintCallable
  • Category="Platform|LocalNotification"

static int32 ScheduleLocalNotificationBadgeAtTime ( const FDateTime& FireDateTime,
bool LocalTime,
const FString& ActivationEvent
)

 Schedule a local notification badge at a specific time, inLocalTime specifies the current local time or if UTC time should be used Kismet/BlueprintPlatformLibrary.h
  • BlueprintCallable
  • Category="Platform|LocalNotification"

static void ScheduleLocalNotificationBadgeFromNow ( int32 inSecondsFromNow,
const FString& ActivationEvent
)

 Schedule a local notification badge to fire inSecondsFromNow from now Kismet/BlueprintPlatformLibrary.h
  • BlueprintCallable
  • Category="Platform|LocalNotification"

static int32 ScheduleLocalNotificationFromNow ( int32 inSecondsFromNow,
const FText& Title,
const FText& Body,
const FText& Action,
const FString& ActivationEvent
)

 Schedule a local notification to fire inSecondsFromNow from now Kismet/BlueprintPlatformLibrary.h
  • BlueprintCallable
  • Category="Platform|LocalNotification"

static void SetAllowedDeviceOrientation ( EScreenOrientation::Type NewAllowedDeviceOrientation
)

 Set the allowed orientation of the device. Kismet/BlueprintPlatformLibrary.h
  • BlueprintCallable
  • Category="Platform|LocalNotification"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page