SCR_VotingStickyNotificationUIComponent Interface Reference

Inheritance diagram for SCR_VotingStickyNotificationUIComponent:

Public Member Functions
override void	OnInit (SCR_NotificationsLogComponent notificationLog)
Public Member Functions inherited from SCR_StickyNotificationUIComponent
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.
override void	HandlerAttached (Widget w)
override void	HandlerDeattached (Widget w)

Protected Member Functions
void	OnVotingChanged (bool isInit=false)
void	EnableContextAction (bool enable)
	When the UI is visible the player can use the instant vote actions (If there is only one vote active)
void	InstantVotingContextUpdate ()
	Updates each frame to keep InstantVotingContext active.
void	EnableVotingTimerUI (bool enable)
	Enable the voting timer UI.
void	VotingTimeUpdate ()
	Called when only 1 vote is active. Called every 1 second to update.
void	OnVoteStartOrChanged (EVotingType type, int value)
void	OnVoteCountChanged (EVotingType type, int value, int voteCount)
void	OnVotingEnd (EVotingType type, int value, int winner)
void	OnPlayerJoinOrLeaveServer (int playerId)
void	OnPlayerFactionChanged (Faction faction, int newCount)
override void	OnButton ()
override void	OnDestroy ()
Protected Member Functions inherited from SCR_StickyNotificationUIComponent
void	SetStickyActive (bool newActive, bool fade=true)
void	SetVisible (bool visible)
void	Fade (bool fadeIn)
void	EditorOpened ()
void	EditorClosed ()

Protected Attributes
LocalizedString	m_sMultipleVotesText
string	m_sInstantVoteLayoutName
string	m_sRemainingVotingTimeName
string	m_sCurrentVoteCountFormatting
Widget	m_InstantVoteLayout
TextWidget	m_RemainingVotingTime
SCR_VotingManagerComponent	m_VotingManagerComponent
EVotingType	m_eActiveSingularVoteType
int	m_eActiveSingularVoteValue
bool	m_bIsUpdatingTime
bool	m_bIsUpdatingActionContext
Protected Attributes inherited from SCR_StickyNotificationUIComponent
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()

Static Protected Attributes
static const float	PLATFORM_ICON_SIZE = 2

Member Function Documentation

EnableContextAction()

void SCR_VotingStickyNotificationUIComponent.EnableContextAction ( bool enable )

protected

When the UI is visible the player can use the instant vote actions (If there is only one vote active)

Parameters

[in]

enable

EnableVotingTimerUI()

void SCR_VotingStickyNotificationUIComponent.EnableVotingTimerUI ( bool enable )

protected

Enable the voting timer UI.

Parameters

[in]

enable

InstantVotingContextUpdate()

void SCR_VotingStickyNotificationUIComponent.InstantVotingContextUpdate ( )

protected

Updates each frame to keep InstantVotingContext active.

OnButton()

override void SCR_VotingStickyNotificationUIComponent.OnButton ( )

protected

Implements SCR_StickyNotificationUIComponent.

OnDestroy()

override void SCR_VotingStickyNotificationUIComponent.OnDestroy ( )

protected

Implements SCR_StickyNotificationUIComponent.

OnInit()

override void SCR_VotingStickyNotificationUIComponent.OnInit

(

SCR_NotificationsLogComponent

notificationLog

)

Parameters

[in]

notificationLog

Implements SCR_StickyNotificationUIComponent.

OnPlayerFactionChanged()

void SCR_VotingStickyNotificationUIComponent.OnPlayerFactionChanged ( Faction faction, int newCount )

protected

OnPlayerJoinOrLeaveServer()

void SCR_VotingStickyNotificationUIComponent.OnPlayerJoinOrLeaveServer ( int playerId )

protected

OnVoteCountChanged()

void SCR_VotingStickyNotificationUIComponent.OnVoteCountChanged ( EVotingType type, int value, int voteCount )

protected

OnVoteStartOrChanged()

void SCR_VotingStickyNotificationUIComponent.OnVoteStartOrChanged ( EVotingType type, int value )

protected

OnVotingChanged()

void SCR_VotingStickyNotificationUIComponent.OnVotingChanged ( bool isInit = false )

protected

OnVotingEnd()

void SCR_VotingStickyNotificationUIComponent.OnVotingEnd ( EVotingType type, int value, int winner )

protected

VotingTimeUpdate()

void SCR_VotingStickyNotificationUIComponent.VotingTimeUpdate ( )

protected

Called when only 1 vote is active. Called every 1 second to update.

Member Data Documentation

m_bIsUpdatingActionContext

bool SCR_VotingStickyNotificationUIComponent.m_bIsUpdatingActionContext

protected

m_bIsUpdatingTime

bool SCR_VotingStickyNotificationUIComponent.m_bIsUpdatingTime

protected

m_eActiveSingularVoteType

EVotingType SCR_VotingStickyNotificationUIComponent.m_eActiveSingularVoteType

protected

m_eActiveSingularVoteValue

int SCR_VotingStickyNotificationUIComponent.m_eActiveSingularVoteValue

protected

m_InstantVoteLayout

Widget SCR_VotingStickyNotificationUIComponent.m_InstantVoteLayout

protected

m_RemainingVotingTime

TextWidget SCR_VotingStickyNotificationUIComponent.m_RemainingVotingTime

protected

m_sCurrentVoteCountFormatting

string SCR_VotingStickyNotificationUIComponent.m_sCurrentVoteCountFormatting

protected

m_sInstantVoteLayoutName

string SCR_VotingStickyNotificationUIComponent.m_sInstantVoteLayoutName

protected

m_sMultipleVotesText

LocalizedString SCR_VotingStickyNotificationUIComponent.m_sMultipleVotesText

protected

m_sRemainingVotingTimeName

string SCR_VotingStickyNotificationUIComponent.m_sRemainingVotingTimeName

protected

m_VotingManagerComponent

SCR_VotingManagerComponent SCR_VotingStickyNotificationUIComponent.m_VotingManagerComponent

protected

PLATFORM_ICON_SIZE

const float SCR_VotingStickyNotificationUIComponent.PLATFORM_ICON_SIZE = 2

staticprotected

---

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

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