Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
FAsyncTaskNotificationConfig Struct Reference

#include <AsyncTaskNotification.h>

+ Collaboration diagram for FAsyncTaskNotificationConfig:

Public Attributes

FText TitleText
 
FText ProgressText
 
float FadeInDuration = 0.5f
 
float FadeOutDuration = 2.0f
 
float ExpireDuration = 1.0f
 
bool bIsHeadless = false
 
TAttribute< boolbCanCancel = false
 
TAttribute< boolbKeepOpenOnSuccess = false
 
TAttribute< boolbKeepOpenOnFailure = false
 
const FSlateBrushIcon = nullptr
 
const FLogCategoryBaseLogCategory = nullptr
 

Detailed Description

Configuration data for initializing an asynchronous task notification.

Definition at line 19 of file AsyncTaskNotification.h.

Member Data Documentation

◆ bCanCancel

TAttribute<bool> FAsyncTaskNotificationConfig::bCanCancel = false

Can this task be canceled? Will show a cancel button for in-progress tasks (attribute queried from the game thread)

Definition at line 40 of file AsyncTaskNotification.h.

◆ bIsHeadless

bool FAsyncTaskNotificationConfig::bIsHeadless = false

Should this notification be "headless"? (ie, not display any UI)

Definition at line 37 of file AsyncTaskNotification.h.

◆ bKeepOpenOnFailure

TAttribute<bool> FAsyncTaskNotificationConfig::bKeepOpenOnFailure = false

Keep this notification open on failure? Will show an close button (attribute queried from the game thread)

Definition at line 46 of file AsyncTaskNotification.h.

◆ bKeepOpenOnSuccess

TAttribute<bool> FAsyncTaskNotificationConfig::bKeepOpenOnSuccess = false

Keep this notification open on success? Will show a close button (attribute queried from the game thread)

Definition at line 43 of file AsyncTaskNotification.h.

◆ ExpireDuration

float FAsyncTaskNotificationConfig::ExpireDuration = 1.0f

The duration before a fadeout for the notification

Definition at line 34 of file AsyncTaskNotification.h.

◆ FadeInDuration

float FAsyncTaskNotificationConfig::FadeInDuration = 0.5f

The fade in duration of the notification

Definition at line 28 of file AsyncTaskNotification.h.

◆ FadeOutDuration

float FAsyncTaskNotificationConfig::FadeOutDuration = 2.0f

The fade out duration of the notification

Definition at line 31 of file AsyncTaskNotification.h.

◆ Icon

const FSlateBrush* FAsyncTaskNotificationConfig::Icon = nullptr

The icon image to display next to the text, or null to use the default icon

Definition at line 49 of file AsyncTaskNotification.h.

◆ LogCategory

const FLogCategoryBase* FAsyncTaskNotificationConfig::LogCategory = nullptr

Category this task should log its notifications under, or null to skip logging

Definition at line 52 of file AsyncTaskNotification.h.

◆ ProgressText

FText FAsyncTaskNotificationConfig::ProgressText

The progress text displayed in the notification (if any)

Definition at line 25 of file AsyncTaskNotification.h.

◆ TitleText

FText FAsyncTaskNotificationConfig::TitleText

The title text displayed in the notification

Definition at line 22 of file AsyncTaskNotification.h.


The documentation for this struct was generated from the following file: