Arma Reforger Explorer 1.7.0.54
Arma Reforger Code Explorer by Zeroy - Thanks to MisterOutofTime
Loading...
Searching...
No Matches
SCR_PopUpNotification Class Reference

Takes care of dynamic and static onscreen popups. More...

Inheritance diagram for SCR_PopUpNotification:
GenericEntity

Protected Member Functions

void Offset (bool down)
void ProcessInit ()
void OnSettingsChanged ()
void RefreshInventoryInvoker (IEntity previousPlayer, IEntity currentPlayer)
void OnInventoryToggle (bool open)
void OnEditorOpened ()
void OnEditorClosed ()
void OnEditorModeChanged (SCR_EditorModeEntity currentMode, SCR_EditorModeEntity prevMode)
bool IsPresentPopupWithHigherPriority (int priority)
void SetTitleText (string text)
void PopupMsg (string text, float duration=DEFAULT_DURATION, string text2="", int prio=-1, string param1="", string param2="", string param3="", string param4="", string text2param1="", string text2param2="", string text2param3="", string text2param4="", string sound="", SCR_EPopupMsgFilter category=SCR_EPopupMsgFilter.ALL, WorldTimestamp progressStart=null, WorldTimestamp progressEnd=null)
SCR_PopupMessage GetCurrentMsg ()
void HideCurrentMsg ()
void ChangeProgressBarFinish (WorldTimestamp progressEnd)
void FadeWidget (notnull Widget widget, bool fadeOut=false, bool instant=false)
void RefreshQueue (SCR_PopupMessage msg=null)
void ShowMsg (notnull SCR_PopupMessage msg)
void HideMsg (notnull SCR_PopupMessage msg)
void ClearMsg ()
 Clear and instant fade all popup messages.
void SetDefaultHorizontalPosition ()
override void EOnFrame (IEntity owner, float timeSlice)
void SCR_PopUpNotification (IEntitySource src, IEntity parent)
void ~SCR_PopUpNotification ()

Static Protected Member Functions

static SCR_PopUpNotification GetInstance ()
static void SetFilter (SCR_EPopupMsgFilter filter)

Protected Attributes

ref array< ref SCR_PopupMessage > m_aQueue = {}
Widget m_wRoot
RichTextWidget m_wPopupMsg
RichTextWidget m_wPopupMsgSmall
ProgressBarWidget m_wStatusProgress
float m_fDefaultAlpha
float m_fDefaultHorizontalOffset = -1
bool m_bInventoryOpen
bool m_bOffset
bool m_bIsEnabledInSettings = true
IEntity m_Player
SCR_PopupMessage m_ShownMsg
string m_sCachedLanguage

Static Protected Attributes

static const int INVALID_ID = -1
static const float FADE_DURATION = 1
static const ResourceName LAYOUT_NAME = "{8EF935F196AADE33}UI/layouts/Common/PopupUI.layout"
static const int POPUP_OFFSET = 35
static SCR_PopUpNotification s_Instance = null
static SCR_EPopupMsgFilter s_eFilter
static const float DEFAULT_DURATION = 4
static const string TASKS_KEY_IMAGE_FORMAT = "<color rgba='226, 168, 79, 200'><shadow mode='image' color='0, 0, 0' size='1' offset='1, 1' opacity = '0.5'><action name='TasksOpen'/></shadow></color>"
static const string INTERFACE_SETTINGS_NAME = "m_bShowNotifications"

Detailed Description

Takes care of dynamic and static onscreen popups.

Definition at line 24 of file SCR_PopupNotification.c.

Constructor & Destructor Documentation

◆ SCR_PopUpNotification()

void SCR_PopUpNotification::SCR_PopUpNotification ( IEntitySource src,
IEntity parent )
inlineprotected

Definition at line 581 of file SCR_PopupNotification.c.

◆ ~SCR_PopUpNotification()

void SCR_PopUpNotification::~SCR_PopUpNotification ( )
inlineprotected

Definition at line 611 of file SCR_PopupNotification.c.

Member Function Documentation

◆ ChangeProgressBarFinish()

void SCR_PopUpNotification::ChangeProgressBarFinish ( WorldTimestamp progressEnd)
inlineprotected

Definition at line 338 of file SCR_PopupNotification.c.

◆ ClearMsg()

void SCR_PopUpNotification::ClearMsg ( )
inlineprotected

Clear and instant fade all popup messages.

Definition at line 507 of file SCR_PopupNotification.c.

◆ EOnFrame()

override void SCR_PopUpNotification::EOnFrame ( IEntity owner,
float timeSlice )
inlineprotected

Definition at line 531 of file SCR_PopupNotification.c.

◆ FadeWidget()

void SCR_PopUpNotification::FadeWidget ( notnull Widget widget,
bool fadeOut = false,
bool instant = false )
inlineprotected

Definition at line 368 of file SCR_PopupNotification.c.

◆ GetCurrentMsg()

SCR_PopupMessage SCR_PopUpNotification::GetCurrentMsg ( )
inlineprotected

Definition at line 322 of file SCR_PopupNotification.c.

◆ GetInstance()

SCR_PopUpNotification SCR_PopUpNotification::GetInstance ( )
inlinestaticprotected

Definition at line 59 of file SCR_PopupNotification.c.

◆ HideCurrentMsg()

void SCR_PopUpNotification::HideCurrentMsg ( )
inlineprotected

Definition at line 328 of file SCR_PopupNotification.c.

◆ HideMsg()

void SCR_PopUpNotification::HideMsg ( notnull SCR_PopupMessage msg)
inlineprotected

Definition at line 491 of file SCR_PopupNotification.c.

◆ IsPresentPopupWithHigherPriority()

bool SCR_PopUpNotification::IsPresentPopupWithHigherPriority ( int priority)
inlineprotected

Definition at line 253 of file SCR_PopupNotification.c.

◆ Offset()

void SCR_PopUpNotification::Offset ( bool down)
inlineprotected

Definition at line 79 of file SCR_PopupNotification.c.

◆ OnEditorClosed()

void SCR_PopUpNotification::OnEditorClosed ( )
inlineprotected

Definition at line 232 of file SCR_PopupNotification.c.

◆ OnEditorModeChanged()

void SCR_PopUpNotification::OnEditorModeChanged ( SCR_EditorModeEntity currentMode,
SCR_EditorModeEntity prevMode )
inlineprotected

Definition at line 241 of file SCR_PopupNotification.c.

◆ OnEditorOpened()

void SCR_PopUpNotification::OnEditorOpened ( )
inlineprotected

Definition at line 220 of file SCR_PopupNotification.c.

◆ OnInventoryToggle()

void SCR_PopUpNotification::OnInventoryToggle ( bool open)
inlineprotected

Definition at line 214 of file SCR_PopupNotification.c.

◆ OnSettingsChanged()

void SCR_PopUpNotification::OnSettingsChanged ( )
inlineprotected

Definition at line 158 of file SCR_PopupNotification.c.

◆ PopupMsg()

void SCR_PopUpNotification::PopupMsg ( string text,
float duration = DEFAULT_DURATION,
string text2 = "",
int prio = -1,
string param1 = "",
string param2 = "",
string param3 = "",
string param4 = "",
string text2param1 = "",
string text2param2 = "",
string text2param3 = "",
string text2param4 = "",
string sound = "",
SCR_EPopupMsgFilter category = SCR_EPopupMsgFilter.ALL,
WorldTimestamp progressStart = null,
WorldTimestamp progressEnd = null )
inlineprotected

Queue new popup notification

Parameters
textText to be shown
durationHow long the text should stay on screen, -1 for infinite duration (use HideCurrentMsg() to toggle off)
text2Secondary (smaller) text
prioPriority (when more popups are queued)
param1(and subsequent) Text or secondary text parameters to be parsed
soundSound event to be played via SCR_UISoundEntity
categorySee SCR_EPopupMsgFilter for settings
progressStartProgress bar start value (relative to Replication.Time())
progressEndProgress bar end value (relative to Replication.Time()

Definition at line 282 of file SCR_PopupNotification.c.

◆ ProcessInit()

void SCR_PopUpNotification::ProcessInit ( )
inlineprotected

Definition at line 100 of file SCR_PopupNotification.c.

◆ RefreshInventoryInvoker()

void SCR_PopUpNotification::RefreshInventoryInvoker ( IEntity previousPlayer,
IEntity currentPlayer )
inlineprotected

Definition at line 188 of file SCR_PopupNotification.c.

◆ RefreshQueue()

void SCR_PopUpNotification::RefreshQueue ( SCR_PopupMessage msg = null)
inlineprotected

Definition at line 395 of file SCR_PopupNotification.c.

◆ SetDefaultHorizontalPosition()

void SCR_PopUpNotification::SetDefaultHorizontalPosition ( )
inlineprotected

Definition at line 523 of file SCR_PopupNotification.c.

◆ SetFilter()

void SCR_PopUpNotification::SetFilter ( SCR_EPopupMsgFilter filter)
inlinestaticprotected

Definition at line 73 of file SCR_PopupNotification.c.

◆ SetTitleText()

void SCR_PopUpNotification::SetTitleText ( string text)
inlineprotected

Definition at line 265 of file SCR_PopupNotification.c.

◆ ShowMsg()

void SCR_PopUpNotification::ShowMsg ( notnull SCR_PopupMessage msg)
inlineprotected

Definition at line 450 of file SCR_PopupNotification.c.

Member Data Documentation

◆ DEFAULT_DURATION

const float SCR_PopUpNotification::DEFAULT_DURATION = 4
staticprotected

Definition at line 34 of file SCR_PopupNotification.c.

◆ FADE_DURATION

const float SCR_PopUpNotification::FADE_DURATION = 1
staticprotected

Definition at line 27 of file SCR_PopupNotification.c.

◆ INTERFACE_SETTINGS_NAME

const string SCR_PopUpNotification::INTERFACE_SETTINGS_NAME = "m_bShowNotifications"
staticprotected

Definition at line 56 of file SCR_PopupNotification.c.

◆ INVALID_ID

const int SCR_PopUpNotification::INVALID_ID = -1
staticprotected

Definition at line 26 of file SCR_PopupNotification.c.

◆ LAYOUT_NAME

const ResourceName SCR_PopUpNotification::LAYOUT_NAME = "{8EF935F196AADE33}UI/layouts/Common/PopupUI.layout"
staticprotected

Definition at line 28 of file SCR_PopupNotification.c.

◆ m_aQueue

ref array<ref SCR_PopupMessage> SCR_PopUpNotification::m_aQueue = {}
protected

Definition at line 37 of file SCR_PopupNotification.c.

◆ m_bInventoryOpen

bool SCR_PopUpNotification::m_bInventoryOpen
protected

Definition at line 47 of file SCR_PopupNotification.c.

◆ m_bIsEnabledInSettings

bool SCR_PopUpNotification::m_bIsEnabledInSettings = true
protected

Definition at line 49 of file SCR_PopupNotification.c.

◆ m_bOffset

bool SCR_PopUpNotification::m_bOffset
protected

Definition at line 48 of file SCR_PopupNotification.c.

◆ m_fDefaultAlpha

float SCR_PopUpNotification::m_fDefaultAlpha
protected

Definition at line 44 of file SCR_PopupNotification.c.

◆ m_fDefaultHorizontalOffset

float SCR_PopUpNotification::m_fDefaultHorizontalOffset = -1
protected

Definition at line 45 of file SCR_PopupNotification.c.

◆ m_Player

IEntity SCR_PopUpNotification::m_Player
protected

Definition at line 51 of file SCR_PopupNotification.c.

◆ m_sCachedLanguage

string SCR_PopUpNotification::m_sCachedLanguage
protected

Definition at line 54 of file SCR_PopupNotification.c.

◆ m_ShownMsg

SCR_PopupMessage SCR_PopUpNotification::m_ShownMsg
protected

Definition at line 53 of file SCR_PopupNotification.c.

◆ m_wPopupMsg

RichTextWidget SCR_PopUpNotification::m_wPopupMsg
protected

Definition at line 40 of file SCR_PopupNotification.c.

◆ m_wPopupMsgSmall

RichTextWidget SCR_PopUpNotification::m_wPopupMsgSmall
protected

Definition at line 41 of file SCR_PopupNotification.c.

◆ m_wRoot

Widget SCR_PopUpNotification::m_wRoot
protected

Definition at line 39 of file SCR_PopupNotification.c.

◆ m_wStatusProgress

ProgressBarWidget SCR_PopUpNotification::m_wStatusProgress
protected

Definition at line 42 of file SCR_PopupNotification.c.

◆ POPUP_OFFSET

const int SCR_PopUpNotification::POPUP_OFFSET = 35
staticprotected

Definition at line 29 of file SCR_PopupNotification.c.

◆ s_eFilter

SCR_EPopupMsgFilter SCR_PopUpNotification::s_eFilter
staticprotected

Definition at line 32 of file SCR_PopupNotification.c.

◆ s_Instance

SCR_PopUpNotification SCR_PopUpNotification::s_Instance = null
staticprotected

Definition at line 31 of file SCR_PopupNotification.c.

◆ TASKS_KEY_IMAGE_FORMAT

const string SCR_PopUpNotification::TASKS_KEY_IMAGE_FORMAT = "<color rgba='226, 168, 79, 200'><shadow mode='image' color='0, 0, 0' size='1' offset='1, 1' opacity = '0.5'><action name='TasksOpen'/></shadow></color>"
staticprotected

Definition at line 35 of file SCR_PopupNotification.c.

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