SCR_StickyNotificationUIComponent Interface Reference

Inheritance diagram for SCR_StickyNotificationUIComponent:

Public Member Functions
bool	isStickyActive ()
	Get if this sticky notification is active.
bool	InfluenceNotificationListSize ()
	Get if sticky notification influences list size.
ScriptInvoker	GetOnStickyActiveChanged ()
	Returns scriptinvoker on sticky notification active changed.
void	OnInit (SCR_NotificationsLogComponent notificationLog)
override void	HandlerAttached (Widget w)
override void	HandlerDeattached (Widget w)

Protected Member Functions
void	SetStickyActive (bool newActive, bool fade=true)
void	SetVisible (bool visible)
void	Fade (bool fadeIn)
void	OnButton ()
void	OnDestroy ()
void	EditorOpened ()
void	EditorClosed ()

Protected Attributes
string	m_sTextName
string	m_sOptionalMessageLayoutName
SCR_NotificationsLogComponent	m_NotificationsLog
Widget	m_Root
SCR_FadeUIComponent	m_FadeUIComponent
bool	m_bInfluenceNotificationListSize
bool	m_bStickyNotificationActive = false
TextWidget	m_Text
Widget	m_OptionalMessageLayout
ref ScriptInvoker	Event_OnStickyActiveChanged = new ScriptInvoker()

Member Function Documentation

EditorClosed()

void SCR_StickyNotificationUIComponent.EditorClosed ( )

protected

EditorOpened()

void SCR_StickyNotificationUIComponent.EditorOpened ( )

protected

Fade()

void SCR_StickyNotificationUIComponent.Fade ( bool  fadeIn )

protected

GetOnStickyActiveChanged()

ScriptInvoker SCR_StickyNotificationUIComponent.GetOnStickyActiveChanged

(

)

Returns scriptinvoker on sticky notification active changed.

Returns

Event_OnStickyActiveChanged on notification active changed

HandlerAttached()

override void SCR_StickyNotificationUIComponent.HandlerAttached

(

Widget

w

)

HandlerDeattached()

override void SCR_StickyNotificationUIComponent.HandlerDeattached

(

Widget

w

)

InfluenceNotificationListSize()

bool SCR_StickyNotificationUIComponent.InfluenceNotificationListSize

(

)

Get if sticky notification influences list size.

If true then the Notification log message history will decrease if a sticky notification is active

Returns

if influences or not

isStickyActive()

bool SCR_StickyNotificationUIComponent.isStickyActive

(

)

Get if this sticky notification is active.

Returns

is active or not

OnButton()

void SCR_StickyNotificationUIComponent.OnButton ( )

protected

Implemented in SCR_GroupInviteStickyNotificationUIComponent, SCR_NoGameMasterStickyNotificationUIComponent, and SCR_VotingStickyNotificationUIComponent.

OnDestroy()

void SCR_StickyNotificationUIComponent.OnDestroy ( )

protected

Implemented in SCR_GroupInviteStickyNotificationUIComponent, SCR_NoGameMasterStickyNotificationUIComponent, and SCR_VotingStickyNotificationUIComponent.

OnInit()

void SCR_StickyNotificationUIComponent.OnInit

(

SCR_NotificationsLogComponent

notificationLog

)

Parameters

[in]

notificationLog

Implemented in SCR_GroupInviteStickyNotificationUIComponent, SCR_NoGameMasterStickyNotificationUIComponent, and SCR_VotingStickyNotificationUIComponent.

SetStickyActive()

void SCR_StickyNotificationUIComponent.SetStickyActive ( bool  newActive, bool  fade = true  )

protected

SetVisible()

void SCR_StickyNotificationUIComponent.SetVisible ( bool  visible )

protected

Member Data Documentation

Event_OnStickyActiveChanged

ref ScriptInvoker SCR_StickyNotificationUIComponent.Event_OnStickyActiveChanged = new ScriptInvoker()

protected

m_bInfluenceNotificationListSize

bool SCR_StickyNotificationUIComponent.m_bInfluenceNotificationListSize

protected

m_bStickyNotificationActive

bool SCR_StickyNotificationUIComponent.m_bStickyNotificationActive = false

protected

m_FadeUIComponent

SCR_FadeUIComponent SCR_StickyNotificationUIComponent.m_FadeUIComponent

protected

m_NotificationsLog

SCR_NotificationsLogComponent SCR_StickyNotificationUIComponent.m_NotificationsLog

protected

m_OptionalMessageLayout

Widget SCR_StickyNotificationUIComponent.m_OptionalMessageLayout

protected

m_Root

Widget SCR_StickyNotificationUIComponent.m_Root

protected

m_sOptionalMessageLayoutName

string SCR_StickyNotificationUIComponent.m_sOptionalMessageLayoutName

protected

m_sTextName

string SCR_StickyNotificationUIComponent.m_sTextName

protected

m_Text

TextWidget SCR_StickyNotificationUIComponent.m_Text

protected

---

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

• Game/UI/Components/Notification/SCR_StickyNotificationUIComponent.c