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

Inheritance diagram for SCR_PopUpNotification:

Public Member Functions
void	Offset (bool down)

void	OnInventoryToggle (bool open)

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)
	Queue new popup notification.

SCR_PopupMessage	GetCurrentMsg ()

void	HideCurrentMsg ()

void	ChangeProgressBarFinish (WorldTimestamp progressEnd)

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 Public Member Functions
static SCR_PopUpNotification	GetInstance ()

static void	SetFilter (SCR_EPopupMsgFilter filter)

Static Public Attributes
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>"

Protected Member Functions
void	ProcessInit ()

void	OnSettingsChanged ()

void	RefreshInventoryInvoker (IEntity previousPlayer, IEntity currentPlayer)

void	OnEditorOpened ()

void	OnEditorClosed ()

void	OnEditorModeChanged (SCR_EditorModeEntity currentMode, SCR_EditorModeEntity prevMode)

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)

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 string	INTERFACE_SETTINGS_NAME = "m_bShowNotifications"

Detailed Description

Takes care of dynamic and static onscreen popups.

Constructor & Destructor Documentation

◆ SCR_PopUpNotification()

void SCR_PopUpNotification.SCR_PopUpNotification	(	IEntitySource	src,
		IEntity	parent )

◆ ~SCR_PopUpNotification()

void SCR_PopUpNotification.~SCR_PopUpNotification ( )

Member Function Documentation

◆ ChangeProgressBarFinish()

void SCR_PopUpNotification.ChangeProgressBarFinish ( WorldTimestamp progressEnd )

◆ ClearMsg()

void SCR_PopUpNotification.ClearMsg ( )

Clear and instant fade all popup messages.

◆ EOnFrame()

override void SCR_PopUpNotification.EOnFrame	(	IEntity	owner,
		float	timeSlice )

◆ FadeWidget()

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

protected

◆ GetCurrentMsg()

SCR_PopupMessage SCR_PopUpNotification.GetCurrentMsg ( )

◆ GetInstance()

static SCR_PopUpNotification SCR_PopUpNotification.GetInstance ( )

static

◆ HideCurrentMsg()

void SCR_PopUpNotification.HideCurrentMsg ( )

◆ HideMsg()

void SCR_PopUpNotification.HideMsg ( notnull SCR_PopupMessage msg )

protected

◆ IsPresentPopupWithHigherPriority()

bool SCR_PopUpNotification.IsPresentPopupWithHigherPriority ( int priority )

◆ Offset()

void SCR_PopUpNotification.Offset ( bool down )

◆ OnEditorClosed()

void SCR_PopUpNotification.OnEditorClosed ( )

protected

◆ OnEditorModeChanged()

void SCR_PopUpNotification.OnEditorModeChanged	(	SCR_EditorModeEntity	currentMode,
		SCR_EditorModeEntity	prevMode )

protected

◆ OnEditorOpened()

void SCR_PopUpNotification.OnEditorOpened ( )

protected

◆ OnInventoryToggle()

void SCR_PopUpNotification.OnInventoryToggle ( bool open )

◆ OnSettingsChanged()

void SCR_PopUpNotification.OnSettingsChanged ( )

protected

◆ 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 )

Queue new popup notification.

Parameters

text	Text to be shown
duration	How long the text should stay on screen, -1 for infinite duration (use HideCurrentMsg() to toggle off)
text2	Secondary (smaller) text
prio	Priority (when more popups are queued)
param1	(and subsequent) Text or secondary text parameters to be parsed
sound	Sound event to be played via SCR_UISoundEntity
category	See SCR_EPopupMsgFilter for settings
progressStart	Progress bar start value (relative to Replication.Time())
progressEnd	Progress bar end value (relative to Replication.Time()

◆ ProcessInit()

void SCR_PopUpNotification.ProcessInit ( )

protected

◆ RefreshInventoryInvoker()

void SCR_PopUpNotification.RefreshInventoryInvoker	(	IEntity	previousPlayer,
		IEntity	currentPlayer )

protected

◆ RefreshQueue()

void SCR_PopUpNotification.RefreshQueue ( SCR_PopupMessage msg = null )

protected

◆ SetDefaultHorizontalPosition()

void SCR_PopUpNotification.SetDefaultHorizontalPosition ( )

◆ SetFilter()

static void SCR_PopUpNotification.SetFilter ( SCR_EPopupMsgFilter filter )

static

◆ SetTitleText()

void SCR_PopUpNotification.SetTitleText ( string text )

◆ ShowMsg()

void SCR_PopUpNotification.ShowMsg ( notnull SCR_PopupMessage msg )

protected

Member Data Documentation

◆ DEFAULT_DURATION

const float SCR_PopUpNotification.DEFAULT_DURATION = 4

static

◆ FADE_DURATION

const float SCR_PopUpNotification.FADE_DURATION = 1

staticprotected

◆ INTERFACE_SETTINGS_NAME

const string SCR_PopUpNotification.INTERFACE_SETTINGS_NAME = "m_bShowNotifications"

staticprotected

◆ INVALID_ID

const int SCR_PopUpNotification.INVALID_ID = -1

staticprotected

◆ LAYOUT_NAME

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

staticprotected

◆ m_aQueue

ref array<ref SCR_PopupMessage> SCR_PopUpNotification.m_aQueue = {}

protected

◆ m_bInventoryOpen

bool SCR_PopUpNotification.m_bInventoryOpen

protected

◆ m_bIsEnabledInSettings

bool SCR_PopUpNotification.m_bIsEnabledInSettings = true

protected

◆ m_bOffset

bool SCR_PopUpNotification.m_bOffset

protected

◆ m_fDefaultAlpha

float SCR_PopUpNotification.m_fDefaultAlpha

protected

◆ m_fDefaultHorizontalOffset

float SCR_PopUpNotification.m_fDefaultHorizontalOffset = -1

protected

◆ m_Player

IEntity SCR_PopUpNotification.m_Player

protected

◆ m_sCachedLanguage

string SCR_PopUpNotification.m_sCachedLanguage

protected

◆ m_ShownMsg

SCR_PopupMessage SCR_PopUpNotification.m_ShownMsg

protected

◆ m_wPopupMsg

RichTextWidget SCR_PopUpNotification.m_wPopupMsg

protected

◆ m_wPopupMsgSmall

RichTextWidget SCR_PopUpNotification.m_wPopupMsgSmall

protected

◆ m_wRoot

Widget SCR_PopUpNotification.m_wRoot

protected

◆ m_wStatusProgress

ProgressBarWidget SCR_PopUpNotification.m_wStatusProgress

protected

◆ POPUP_OFFSET

const int SCR_PopUpNotification.POPUP_OFFSET = 35

staticprotected

◆ s_eFilter

SCR_EPopupMsgFilter SCR_PopUpNotification.s_eFilter

staticprotected

◆ s_Instance

SCR_PopUpNotification SCR_PopUpNotification.s_Instance = null

staticprotected

◆ 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>"

static

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

Game/UI/HUD/SCR_PopupNotification.c

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SCR_PopUpNotification()

◆ ~SCR_PopUpNotification()

Member Function Documentation

◆ ChangeProgressBarFinish()

◆ ClearMsg()

◆ EOnFrame()

◆ FadeWidget()

◆ GetCurrentMsg()

◆ GetInstance()

◆ HideCurrentMsg()

◆ HideMsg()

◆ IsPresentPopupWithHigherPriority()

◆ Offset()

◆ OnEditorClosed()

◆ OnEditorModeChanged()

◆ OnEditorOpened()

◆ OnInventoryToggle()

◆ OnSettingsChanged()

◆ PopupMsg()

◆ ProcessInit()

◆ RefreshInventoryInvoker()

◆ RefreshQueue()

◆ SetDefaultHorizontalPosition()

◆ SetFilter()

◆ SetTitleText()

◆ ShowMsg()

Member Data Documentation

◆ DEFAULT_DURATION

◆ FADE_DURATION

◆ INTERFACE_SETTINGS_NAME

◆ INVALID_ID

◆ LAYOUT_NAME

◆ m_aQueue

◆ m_bInventoryOpen

◆ m_bIsEnabledInSettings

◆ m_bOffset

◆ m_fDefaultAlpha

◆ m_fDefaultHorizontalOffset

◆ m_Player

◆ m_sCachedLanguage

◆ m_ShownMsg

◆ m_wPopupMsg

◆ m_wPopupMsgSmall

◆ m_wRoot

◆ m_wStatusProgress

◆ POPUP_OFFSET

◆ s_eFilter

◆ s_Instance

◆ TASKS_KEY_IMAGE_FORMAT