Class BlueprintPlatformLibrary
Blueprint Platform Library
Inherited Members
Namespace: UE4.Engine
Assembly: UE4DotNet.dll
Syntax
public class BlueprintPlatformLibrary : BlueprintFunctionLibrary
Properties
| Improve this Doc View SourceDefaultObject
Get UE4 Default Object for this Class
Declaration
public static BlueprintPlatformLibrary DefaultObject { get; }
Property Value
Type | Description |
---|---|
BlueprintPlatformLibrary |
StaticClass
Get UE4 Class
Declaration
public static Class StaticClass { get; }
Property Value
Type | Description |
---|---|
Class |
Methods
| Improve this Doc View SourceCancelLocalNotification(String)
Cancel a local notification given the ActivationEvent @
Declaration
public static void CancelLocalNotification(string ActivationEvent)
Parameters
Type | Name | Description |
---|---|---|
System.String | ActivationEvent |
Remarks
param ActivationEvent The string passed into the Schedule call for the notification to be cancelled
ClearAllLocalNotifications()
Clear all pending local notifications. Typically this will be done before scheduling new notifications when going into the background
Declaration
public static void ClearAllLocalNotifications()
GetDeviceOrientation()
@return the current device orientation
Declaration
public static byte GetDeviceOrientation()
Returns
Type | Description |
---|---|
System.Byte |
GetLaunchNotification()
Get the local notification that was used to launch the app @
Declaration
public static (bool, string, int) GetLaunchNotification()
Returns
Type | Description |
---|---|
System.ValueTuple<System.Boolean, System.String, System.Int32> |
Remarks
param NotificationLaunchedApp Return true if a notification was used to launch the app @param ActivationEvent Returns the name of the ActivationEvent if a notification was used to launch the app @param FireDate Returns the time the notification was activated
New(UObject, Name)
Spawn an object of this class
Declaration
public static BlueprintPlatformLibrary New(UObject obj = null, Name name = default(Name))
Parameters
Type | Name | Description |
---|---|---|
UObject | obj | |
Name | name |
Returns
Type | Description |
---|---|
BlueprintPlatformLibrary |
ScheduleLocalNotificationAtTime(FDateTime, Boolean, Byte, Byte, Byte, String)
Schedule a local notification at a specific time, inLocalTime specifies the current local time or if UTC time should be used @
Declaration
public static void ScheduleLocalNotificationAtTime(FDateTime FireDateTime, bool LocalTime, byte Title, byte Body, byte Action, string ActivationEvent)
Parameters
Type | Name | Description |
---|---|---|
FDateTime | FireDateTime | |
System.Boolean | LocalTime | |
System.Byte | Title | |
System.Byte | Body | |
System.Byte | Action | |
System.String | ActivationEvent |
Remarks
param FireDateTime The time at which to fire the local notification @param LocalTime If true the provided time is in the local timezone, if false it is in UTC @param Title The title of the notification @param Body The more detailed description of the notification @param Action The text to be displayed on the slider controller @param ActivationEvent A string that is passed in the delegate callback when the app is brought into the foreground from the user activating the notification
ScheduleLocalNotificationBadgeAtTime(FDateTime, Boolean, String)
Schedule a local notification badge at a specific time, inLocalTime specifies the current local time or if UTC time should be used @
Declaration
public static void ScheduleLocalNotificationBadgeAtTime(FDateTime FireDateTime, bool LocalTime, string ActivationEvent)
Parameters
Type | Name | Description |
---|---|---|
FDateTime | FireDateTime | |
System.Boolean | LocalTime | |
System.String | ActivationEvent |
Remarks
param FireDateTime The time at which to fire the local notification @param LocalTime If true the provided time is in the local timezone, if false it is in UTC @param ActivationEvent A string that is passed in the delegate callback when the app is brought into the foreground from the user activating the notification
ScheduleLocalNotificationBadgeFromNow(Int32, String)
Schedule a local notification badge to fire inSecondsFromNow from now @
Declaration
public static void ScheduleLocalNotificationBadgeFromNow(int inSecondsFromNow, string ActivationEvent)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | inSecondsFromNow | |
System.String | ActivationEvent |
Remarks
param inSecondsFromNow The seconds until the notification should fire @param ActivationEvent A string that is passed in the delegate callback when the app is brought into the foreground from the user activating the notification
ScheduleLocalNotificationFromNow(Int32, Byte, Byte, Byte, String)
Schedule a local notification to fire inSecondsFromNow from now @
Declaration
public static void ScheduleLocalNotificationFromNow(int inSecondsFromNow, byte Title, byte Body, byte Action, string ActivationEvent)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | inSecondsFromNow | |
System.Byte | Title | |
System.Byte | Body | |
System.Byte | Action | |
System.String | ActivationEvent |
Remarks
param inSecondsFromNow The seconds until the notification should fire @param LocalTime If true the provided time is in the local timezone, if false it is in UTC @param Title The title of the notification @param Body The more detailed description of the notification @param Action The text to be displayed on the slider controller @param ActivationEvent A string that is passed in the delegate callback when the app is brought into the foreground from the user activating the notification
Operators
| Improve this Doc View SourceImplicit(IntPtr to BlueprintPlatformLibrary)
Convert from IntPtr to UObject
Declaration
public static implicit operator BlueprintPlatformLibrary(IntPtr p)
Parameters
Type | Name | Description |
---|---|---|
System.IntPtr | p |
Returns
Type | Description |
---|---|
BlueprintPlatformLibrary |