Notification UI that displays the Notification Entires Holds general functions such as scroll history and Init SCR_NotificationEntityUIComponent Holds general data such as Notification Color. More...

Inheritance diagram for SCR_NotificationsLogComponent:

Public Member Functions
ScriptInvoker	GetOnNewMessageHasPosition ()
	Get script invoker if a new notification has a position.

ScriptInvoker	GetOnInputDeviceChanged ()
	Get script invoker if input device changed.

void	UpdateNotificationTexts ()
	Update notification texts.

bool	GetIsUsingMouseAndKeyboard ()
	Returns using mouse and keyboard or gamepad.

SCR_EditorManagerEntity	GetEditorManager ()

SCR_NotificationsComponent	GetNotificationManager ()

Color	GetNotificationWidgetColor (ENotificationColor notificationColor)

Color	GetNotificationTextColor (ENotificationColor notificationColor)

bool	HasNotificationInput ()

override void	HandlerAttachedScripted (Widget w)
	Event called when subcomponent is initialized.

override void	HandlerDeattached (Widget w)

void	OnSlotResize (int maxNotifications)

void	ChangeInsertOrder (bool fromTop)

Public Member Functions inherited from MenuRootSubComponent
Widget	GetWidget ()
	Get widget to which the component belongs to.

MenuRootBase	GetMenu ()
	Get menu of which the widget is part of.

MenuRootComponent	GetRootComponent ()
	Get root component of this subcomponent,.

override void	HandlerAttached (Widget w)

Protected Member Functions
bool	OnNotification (SCR_NotificationData data)

void	OnNotificationDeleted (SCR_NotificationMessageUIComponent notificationMessage)

void	RemoveOldestNotification ()

void	OnInputDeviceIsGamepad (bool isGamepad)

void	GenerateNotificationColorMap ()

void	OnStickyNotificationChanged (bool newActive)

void	OnPriorityNotificationChange (bool newActive)

void	OnSettingsChanged ()

Protected Member Functions inherited from MenuRootSubComponent
bool	IsUnique ()
	Is the component to exist only in one instance?

Protected Attributes
bool	m_bHasNotificationInput

int	m_iMaxNotifications

float	m_fNotificationDisplayTime

string	m_sNotificationHolderName

string	m_sPriorityNotificationHolderName

int	m_iPriorityNotificationSize

string	m_sNotificationHolderParent

ResourceName	m_sNotificationEntityPrefab

ResourceName	m_sSplitNotificationEntityPrefab

SCR_NotificationsComponent	m_NotificationsManager

SCR_EditorManagerEntity	m_EditorManagerEntity

SCR_FadeUIComponent	m_FadeUiComponent

VerticalLayoutWidget	m_wNotificationHolder

VerticalLayoutWidget	m_wPriorityNotificationHolder

VerticalLayoutWidget	m_wNotificationHolderParent

ref SCR_NotificationMessageUIComponent	m_PrevOverFlowNotification

FactionManager	m_FactionManager

Widget	m_wRoot

int	m_iCurrentMaxNotifications

int	m_iCurrentPriorityNotifications

int	m_iCurrentStickyNotifications

bool	m_bIsUsingMouseAndKeyboard = true

string	m_sCachedLanguage

ref ScriptInvoker	m_OnNewMessageHasPosition = new ScriptInvoker()

ref ScriptInvoker	m_OnInputDeviceChanged = new ScriptInvoker()

ref array< ref SCR_NotificationMessageUIComponent >	m_aNotificationMessages = {}

ref array< ref SCR_NotificationMessageUIComponent >	m_aPriorityNotificationMessages = {}

ref map< ENotificationColor, SCR_NotificationDisplayColor >	m_NotificationDisplayColorMap = new map<ENotificationColor, SCR_NotificationDisplayColor>()

Detailed Description

Notification UI that displays the Notification Entires Holds general functions such as scroll history and Init SCR_NotificationEntityUIComponent Holds general data such as Notification Color.

Member Function Documentation

◆ ChangeInsertOrder()

void SCR_NotificationsLogComponent.ChangeInsertOrder ( bool fromTop )

Parameters

[in] fromTop

◆ GenerateNotificationColorMap()

void SCR_NotificationsLogComponent.GenerateNotificationColorMap ( )

protected

◆ GetEditorManager()

SCR_EditorManagerEntity SCR_NotificationsLogComponent.GetEditorManager ( )

Returns: EditorManagerEntity reference

◆ GetIsUsingMouseAndKeyboard()

bool SCR_NotificationsLogComponent.GetIsUsingMouseAndKeyboard ( )

Returns using mouse and keyboard or gamepad.

Returns: true if using mouse and keyboard, false otherwise

◆ GetNotificationManager()

SCR_NotificationsComponent SCR_NotificationsLogComponent.GetNotificationManager ( )

Returns: NotificationsManager reference

◆ GetNotificationTextColor()

Color SCR_NotificationsLogComponent.GetNotificationTextColor ( ENotificationColor notificationColor )

Returns: the color of the notification using the ENotificationColor enum

◆ GetNotificationWidgetColor()

Color SCR_NotificationsLogComponent.GetNotificationWidgetColor ( ENotificationColor notificationColor )

Returns: the colour of the notification using the ENotificationColor enum

◆ GetOnInputDeviceChanged()

ScriptInvoker SCR_NotificationsLogComponent.GetOnInputDeviceChanged ( )

Get script invoker if input device changed.

Returns: ScriptInvoker m_OnInputDeviceChanged

◆ GetOnNewMessageHasPosition()

ScriptInvoker SCR_NotificationsLogComponent.GetOnNewMessageHasPosition ( )

Get script invoker if a new notification has a position.

Returns: ScriptInvoker m_OnNewMessageHasPosition

◆ HandlerAttachedScripted()

override void SCR_NotificationsLogComponent.HandlerAttachedScripted ( Widget w )

Event called when subcomponent is initialized.

Called only after all other subcomponents were registered as well and can be searched for. To be overwritten by inherited classes.

Parameters

Widget

Implements MenuRootSubComponent.

◆ HandlerDeattached()

override void SCR_NotificationsLogComponent.HandlerDeattached ( Widget w )

Implements MenuRootSubComponent.

◆ HasNotificationInput()

bool SCR_NotificationsLogComponent.HasNotificationInput ( )

Returns: true if the notifications have input (can be clicked on and have key hints), false otherwise

◆ OnInputDeviceIsGamepad()

void SCR_NotificationsLogComponent.OnInputDeviceIsGamepad ( bool isGamepad )

protected

◆ OnNotification()

bool SCR_NotificationsLogComponent.OnNotification ( SCR_NotificationData data )

protected

◆ OnNotificationDeleted()

void SCR_NotificationsLogComponent.OnNotificationDeleted ( SCR_NotificationMessageUIComponent notificationMessage )

protected

◆ OnPriorityNotificationChange()

void SCR_NotificationsLogComponent.OnPriorityNotificationChange ( bool newActive )

protected

◆ OnSettingsChanged()

void SCR_NotificationsLogComponent.OnSettingsChanged ( )

protected

◆ OnSlotResize()

void SCR_NotificationsLogComponent.OnSlotResize ( int maxNotifications )

Parameters

[in] maxNotifications

◆ OnStickyNotificationChanged()

void SCR_NotificationsLogComponent.OnStickyNotificationChanged ( bool newActive )

protected

◆ RemoveOldestNotification()

void SCR_NotificationsLogComponent.RemoveOldestNotification ( )

protected

◆ UpdateNotificationTexts()

void SCR_NotificationsLogComponent.UpdateNotificationTexts ( )

Update notification texts.

Member Data Documentation

◆ m_aNotificationMessages

ref array<ref SCR_NotificationMessageUIComponent> SCR_NotificationsLogComponent.m_aNotificationMessages = {}

protected

◆ m_aPriorityNotificationMessages

ref array<ref SCR_NotificationMessageUIComponent> SCR_NotificationsLogComponent.m_aPriorityNotificationMessages = {}

protected

◆ m_bHasNotificationInput

bool SCR_NotificationsLogComponent.m_bHasNotificationInput

protected

◆ m_bIsUsingMouseAndKeyboard

bool SCR_NotificationsLogComponent.m_bIsUsingMouseAndKeyboard = true

protected

◆ m_EditorManagerEntity

SCR_EditorManagerEntity SCR_NotificationsLogComponent.m_EditorManagerEntity

protected

◆ m_FactionManager

FactionManager SCR_NotificationsLogComponent.m_FactionManager

protected

◆ m_FadeUiComponent

SCR_FadeUIComponent SCR_NotificationsLogComponent.m_FadeUiComponent

protected

◆ m_fNotificationDisplayTime

float SCR_NotificationsLogComponent.m_fNotificationDisplayTime

protected

◆ m_iCurrentMaxNotifications

int SCR_NotificationsLogComponent.m_iCurrentMaxNotifications

protected

◆ m_iCurrentPriorityNotifications

int SCR_NotificationsLogComponent.m_iCurrentPriorityNotifications

protected

◆ m_iCurrentStickyNotifications

int SCR_NotificationsLogComponent.m_iCurrentStickyNotifications

protected

◆ m_iMaxNotifications

int SCR_NotificationsLogComponent.m_iMaxNotifications

protected

◆ m_iPriorityNotificationSize

int SCR_NotificationsLogComponent.m_iPriorityNotificationSize

protected

◆ m_NotificationDisplayColorMap

ref map<ENotificationColor, SCR_NotificationDisplayColor> SCR_NotificationsLogComponent.m_NotificationDisplayColorMap = new map<ENotificationColor, SCR_NotificationDisplayColor>()

protected

◆ m_NotificationsManager

SCR_NotificationsComponent SCR_NotificationsLogComponent.m_NotificationsManager

protected

◆ m_OnInputDeviceChanged

ref ScriptInvoker SCR_NotificationsLogComponent.m_OnInputDeviceChanged = new ScriptInvoker()

protected

◆ m_OnNewMessageHasPosition

ref ScriptInvoker SCR_NotificationsLogComponent.m_OnNewMessageHasPosition = new ScriptInvoker()

protected

◆ m_PrevOverFlowNotification

ref SCR_NotificationMessageUIComponent SCR_NotificationsLogComponent.m_PrevOverFlowNotification

protected

◆ m_sCachedLanguage

string SCR_NotificationsLogComponent.m_sCachedLanguage

protected

◆ m_sNotificationEntityPrefab

ResourceName SCR_NotificationsLogComponent.m_sNotificationEntityPrefab

protected

◆ m_sNotificationHolderName

string SCR_NotificationsLogComponent.m_sNotificationHolderName

protected

◆ m_sNotificationHolderParent

string SCR_NotificationsLogComponent.m_sNotificationHolderParent

protected

◆ m_sPriorityNotificationHolderName

string SCR_NotificationsLogComponent.m_sPriorityNotificationHolderName

protected

◆ m_sSplitNotificationEntityPrefab

ResourceName SCR_NotificationsLogComponent.m_sSplitNotificationEntityPrefab

protected

◆ m_wNotificationHolder

VerticalLayoutWidget SCR_NotificationsLogComponent.m_wNotificationHolder

protected

◆ m_wNotificationHolderParent

VerticalLayoutWidget SCR_NotificationsLogComponent.m_wNotificationHolderParent

protected

◆ m_wPriorityNotificationHolder

VerticalLayoutWidget SCR_NotificationsLogComponent.m_wPriorityNotificationHolder

protected

◆ m_wRoot

Widget SCR_NotificationsLogComponent.m_wRoot

protected

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

Game/UI/Components/Notification/SCR_NotificationsLogUIComponent.c

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ ChangeInsertOrder()

◆ GenerateNotificationColorMap()

◆ GetEditorManager()

◆ GetIsUsingMouseAndKeyboard()

◆ GetNotificationManager()

◆ GetNotificationTextColor()

◆ GetNotificationWidgetColor()

◆ GetOnInputDeviceChanged()

◆ GetOnNewMessageHasPosition()

◆ HandlerAttachedScripted()

◆ HandlerDeattached()

◆ HasNotificationInput()

◆ OnInputDeviceIsGamepad()

◆ OnNotification()

◆ OnNotificationDeleted()

◆ OnPriorityNotificationChange()

◆ OnSettingsChanged()

◆ OnSlotResize()

◆ OnStickyNotificationChanged()

◆ RemoveOldestNotification()

◆ UpdateNotificationTexts()

Member Data Documentation

◆ m_aNotificationMessages

◆ m_aPriorityNotificationMessages

◆ m_bHasNotificationInput

◆ m_bIsUsingMouseAndKeyboard

◆ m_EditorManagerEntity

◆ m_FactionManager

◆ m_FadeUiComponent

◆ m_fNotificationDisplayTime

◆ m_iCurrentMaxNotifications

◆ m_iCurrentPriorityNotifications

◆ m_iCurrentStickyNotifications

◆ m_iMaxNotifications

◆ m_iPriorityNotificationSize

◆ m_NotificationDisplayColorMap

◆ m_NotificationsManager

◆ m_OnInputDeviceChanged

◆ m_OnNewMessageHasPosition

◆ m_PrevOverFlowNotification

◆ m_sCachedLanguage

◆ m_sNotificationEntityPrefab

◆ m_sNotificationHolderName

◆ m_sNotificationHolderParent

◆ m_sPriorityNotificationHolderName

◆ m_sSplitNotificationEntityPrefab

◆ m_wNotificationHolder

◆ m_wNotificationHolderParent

◆ m_wPriorityNotificationHolder

◆ m_wRoot