Arma Reforger Script API
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
SCR_NotificationMessageUIComponent Interface Reference
Inheritance diagram for SCR_NotificationMessageUIComponent:
[legend]

Public Member Functions

void Init (SCR_NotificationData data, SCR_NotificationsLogComponent notificationLog, float fadeDelay)
 Init the message, setting the visuals.
 
void ForceRemoveNotification ()
 Delete the notification with a fast fade.
 
ScriptInvoker GetOnDeleted ()
 Get script invoker for when notification is deleted.
 
void DeleteNotification ()
 
override void HandlerAttached (Widget w)
 
override void HandlerDeattached (Widget w)
 
SCR_NotificationData GetData ()
 

Protected Member Functions

void SetWidgetColor (Color notificationColor)
 
void OnNewNotificationHasPosition ()
 
void EditorOpened ()
 
void EditorClosed ()
 
void OnLimitedChanged (bool limited)
 
void OnInputDeviceChanged (bool isUsingMouseAndKeyboard)
 
void TeleportToLocation ()
 
void FadeDelete (float fadeSpeed)
 
void AnimationDoneListenerUpdate ()
 
void AutoFadeDelay ()
 

Protected Attributes

string m_sIcon
 
ref array< string > m_aColoredWidgets
 
ref array< string > m_aNonGameMasterWidgets
 
ref array< string > m_aGameMasterOnlyWidgets
 
string m_sNotificationText
 
string m_sGoToIndicator
 
string m_sGoToControlHint
 
string m_sGoToIndicatorsHolder
 
Widget m_wRoot
 
SCR_NotificationsLogComponent m_NotificationsLog
 
ref SCR_NotificationData m_Data
 
Widget m_GoToControlHint
 
Widget m_GoToIndicator
 
Widget m_GoToIndicatorsHolder
 
ref ScriptInvoker Event_OnDeleted = new ScriptInvoker()
 
bool m_bIsListeningToDoneFade
 
bool m_bHasPosition
 
bool m_bShowTeleportControlHint
 

Static Protected Attributes

static const float ANIMATION_DONE_UPDATE_SPEED = 100
 
static const float FORCE_DELETE_FADE_SPEED = 3
 
static const float AUTO_FADE_SPEED = 1
 
static const float FADE_IN_SPEED = 2
 

Member Function Documentation

◆ AnimationDoneListenerUpdate()

void SCR_NotificationMessageUIComponent.AnimationDoneListenerUpdate ( )
protected

◆ AutoFadeDelay()

void SCR_NotificationMessageUIComponent.AutoFadeDelay ( )
protected

◆ DeleteNotification()

void SCR_NotificationMessageUIComponent.DeleteNotification ( )

◆ EditorClosed()

void SCR_NotificationMessageUIComponent.EditorClosed ( )
protected

◆ EditorOpened()

void SCR_NotificationMessageUIComponent.EditorOpened ( )
protected

◆ FadeDelete()

void SCR_NotificationMessageUIComponent.FadeDelete ( float  fadeSpeed)
protected

◆ ForceRemoveNotification()

void SCR_NotificationMessageUIComponent.ForceRemoveNotification ( )

Delete the notification with a fast fade.

◆ GetData()

SCR_NotificationData SCR_NotificationMessageUIComponent.GetData ( )
Returns

◆ GetOnDeleted()

ScriptInvoker SCR_NotificationMessageUIComponent.GetOnDeleted ( )

Get script invoker for when notification is deleted.

Returns
ScriptInvoker Event_OnDeleted

◆ HandlerAttached()

override void SCR_NotificationMessageUIComponent.HandlerAttached ( Widget  w)

◆ HandlerDeattached()

override void SCR_NotificationMessageUIComponent.HandlerDeattached ( Widget  w)

◆ Init()

void SCR_NotificationMessageUIComponent.Init ( SCR_NotificationData  data,
SCR_NotificationsLogComponent  notificationLog,
float  fadeDelay 
)

Init the message, setting the visuals.

Parameters
[in]datathe data of the notification
[in]notificationLoga reference to the notificationLog
[in]fadeDelayautomatic fade delay of notification

Implemented in SCR_SplitNotificationMessageUIComponent.

◆ OnInputDeviceChanged()

void SCR_NotificationMessageUIComponent.OnInputDeviceChanged ( bool  isUsingMouseAndKeyboard)
protected

◆ OnLimitedChanged()

void SCR_NotificationMessageUIComponent.OnLimitedChanged ( bool  limited)
protected

◆ OnNewNotificationHasPosition()

void SCR_NotificationMessageUIComponent.OnNewNotificationHasPosition ( )
protected

◆ SetWidgetColor()

void SCR_NotificationMessageUIComponent.SetWidgetColor ( Color  notificationColor)
protected

◆ TeleportToLocation()

void SCR_NotificationMessageUIComponent.TeleportToLocation ( )
protected

Member Data Documentation

◆ ANIMATION_DONE_UPDATE_SPEED

const float SCR_NotificationMessageUIComponent.ANIMATION_DONE_UPDATE_SPEED = 100
staticprotected

◆ AUTO_FADE_SPEED

const float SCR_NotificationMessageUIComponent.AUTO_FADE_SPEED = 1
staticprotected

◆ Event_OnDeleted

ref ScriptInvoker SCR_NotificationMessageUIComponent.Event_OnDeleted = new ScriptInvoker()
protected

◆ FADE_IN_SPEED

const float SCR_NotificationMessageUIComponent.FADE_IN_SPEED = 2
staticprotected

◆ FORCE_DELETE_FADE_SPEED

const float SCR_NotificationMessageUIComponent.FORCE_DELETE_FADE_SPEED = 3
staticprotected

◆ m_aColoredWidgets

ref array<string> SCR_NotificationMessageUIComponent.m_aColoredWidgets
protected

◆ m_aGameMasterOnlyWidgets

ref array<string> SCR_NotificationMessageUIComponent.m_aGameMasterOnlyWidgets
protected

◆ m_aNonGameMasterWidgets

ref array<string> SCR_NotificationMessageUIComponent.m_aNonGameMasterWidgets
protected

◆ m_bHasPosition

bool SCR_NotificationMessageUIComponent.m_bHasPosition
protected

◆ m_bIsListeningToDoneFade

bool SCR_NotificationMessageUIComponent.m_bIsListeningToDoneFade
protected

◆ m_bShowTeleportControlHint

bool SCR_NotificationMessageUIComponent.m_bShowTeleportControlHint
protected

◆ m_Data

ref SCR_NotificationData SCR_NotificationMessageUIComponent.m_Data
protected

◆ m_GoToControlHint

Widget SCR_NotificationMessageUIComponent.m_GoToControlHint
protected

◆ m_GoToIndicator

Widget SCR_NotificationMessageUIComponent.m_GoToIndicator
protected

◆ m_GoToIndicatorsHolder

Widget SCR_NotificationMessageUIComponent.m_GoToIndicatorsHolder
protected

◆ m_NotificationsLog

SCR_NotificationsLogComponent SCR_NotificationMessageUIComponent.m_NotificationsLog
protected

◆ m_sGoToControlHint

string SCR_NotificationMessageUIComponent.m_sGoToControlHint
protected

◆ m_sGoToIndicator

string SCR_NotificationMessageUIComponent.m_sGoToIndicator
protected

◆ m_sGoToIndicatorsHolder

string SCR_NotificationMessageUIComponent.m_sGoToIndicatorsHolder
protected

◆ m_sIcon

string SCR_NotificationMessageUIComponent.m_sIcon
protected

◆ m_sNotificationText

string SCR_NotificationMessageUIComponent.m_sNotificationText
protected

◆ m_wRoot

Widget SCR_NotificationMessageUIComponent.m_wRoot
protected
The documentation for this interface was generated from the following file:
Generated by doxygen 1.9.6