Inheritance diagram for SCR_VotingUIInfo:

[legend]

Public Member Functions
string	GetStartVotingName ()

string	GetCancelVotingName ()

string	GetRevoteName ()

string	GetAbstainVoteName ()

string	GetStickyNotificationText ()
	Get sticky notification text shown in the notification log when the specific voting type is active.

ENotification	GetVotingStartNotification ()
	Get Start notification ID which is send to the Notification Component to show the specific notification when the voting starts.

ENotification	GetVotingSucceedNotification ()
	Get Succeed notification ID which is send to the Notification Component to show the specific notification when voting ends and succeeds.

ENotification	GetVotingFailNotification ()
	Get Fail notification ID which is send to the Notification Component to show the specific notification when voting ends and fails.

ENotification	GetLocalVoteCastNotification ()
	Get Local Vote notification ID which is send to the Notification Component to show the specific notification when a player locally casts a vote.

ENotification	GetLocalVoteAbstainedNotification ()
	Get Local Vote notification ID which is send to the Notification Component to show the specific notification when a player locally abstains from voting.

Public Member Functions inherited from SCR_UIInfo
ResourceName	GetIconPath ()
	Get icon.

string	GetIconSetName ()
	Returns Icon Set name if imageset.

bool	HasIcon ()
	Check if the info has an icon defined.

bool	SetIconTo (ImageWidget imageWidget)
	Set icon to given image widget.

override void	Log (string prefix=string.Empty, LogLevel logLevel=LogLevel.VERBOSE)

Public Member Functions inherited from SCR_UIDescription
LocalizedString	GetUnformattedDescription ()
	Get the unformatted description from SCR_HintUIInfo instance.

void	SetDescription (LocalizedString description)
	Change the description from SCR_HintUIInfo instance.

LocalizedString	GetDescription ()
	Get description.

bool	HasDescription ()
	Check if the info has a description defined.

bool	SetDescriptionTo (TextWidget textWidget)
	Set description to given text widget.

override void	Log (string prefix=string.Empty, LogLevel logLevel=LogLevel.VERBOSE)

Public Member Functions inherited from SCR_UIName
LocalizedString	GetUnformattedName ()
	Get The unformatted Name from SCR_HintUIInfo instance.

void	SetName (LocalizedString name)
	Change the Name from SCR_HintUIInfo instance.

LocalizedString	GetName ()
	Get name.

bool	HasName ()
	Check if the info has a name defined.

bool	SetNameTo (TextWidget textWidget)
	Set name to given text widget.

void	Log (string prefix=string.Empty, LogLevel logLevel=LogLevel.VERBOSE)
	Print out contents of this UI info.

Protected Attributes
LocalizedString	m_sStartVotingName

LocalizedString	m_sCancelVotingName

LocalizedString	m_sRevoteName

LocalizedString	m_sAbstainVoteName

LocalizedString	m_sStickyNotificationText

ENotification	m_iStartNotificationId

ENotification	m_iSucceededNotificationId

ENotification	m_iFailedNotificationId

ENotification	m_eVoteCastedLocalNotification

ENotification	m_eVoteAbstainedLocalNotification

Protected Attributes inherited from SCR_UIInfo
ResourceName	Icon

string	IconSetName

Protected Attributes inherited from SCR_UIDescription
LocalizedString	Description

Protected Attributes inherited from SCR_UIName
LocalizedString	Name

Additional Inherited Members
Static Public Member Functions inherited from SCR_UIInfo
static SCR_UIInfo	GetInfo (BaseContainer source, string varName)
	Get UIInfo from a source object.

static SCR_UIInfo	CreateInfo (UIInfo source)
	Create SCR_UIInfo from engine UIInfo.

static SCR_UIInfo	CreateInfo (LocalizedString name, LocalizedString description=LocalizedString.Empty, ResourceName icon=ResourceName.Empty, string iconSetName=string.Empty)
	Create SCR_UIInfo from basic params.

static SCR_UIInfo	CreatePlaceholderInfo (TypeName type)
	Get placeholder info.

Protected Member Functions inherited from SCR_UIInfo
override void	CopyFrom (SCR_UIName source)

override void	CopyFrom (SCR_UIName source)

void	CopyFrom (SCR_UIName source)

Member Function Documentation

◆ GetAbstainVoteName()

string SCR_VotingUIInfo.GetAbstainVoteName ( )

Returns: Name used when abstaining voting

◆ GetCancelVotingName()

string SCR_VotingUIInfo.GetCancelVotingName ( )

Returns: Name used when withdrawing a vote.

◆ GetLocalVoteAbstainedNotification()

ENotification SCR_VotingUIInfo.GetLocalVoteAbstainedNotification ( )

Get Local Vote notification ID which is send to the Notification Component to show the specific notification when a player locally abstains from voting.

Returns: Notification ID

◆ GetLocalVoteCastNotification()

ENotification SCR_VotingUIInfo.GetLocalVoteCastNotification ( )

Get Local Vote notification ID which is send to the Notification Component to show the specific notification when a player locally casts a vote.

Returns: Notification ID

◆ GetRevoteName()

string SCR_VotingUIInfo.GetRevoteName ( )

Returns: Name used when abstaining voting

◆ GetStartVotingName()

string SCR_VotingUIInfo.GetStartVotingName ( )

Returns: Name used when starting a new vote.

◆ GetStickyNotificationText()

string SCR_VotingUIInfo.GetStickyNotificationText ( )

Get sticky notification text shown in the notification log when the specific voting type is active.

Returns: string stricky notification text

◆ GetVotingFailNotification()

ENotification SCR_VotingUIInfo.GetVotingFailNotification ( )

Get Fail notification ID which is send to the Notification Component to show the specific notification when voting ends and fails.

Returns: ENotification Notification ID of failed voting

◆ GetVotingStartNotification()

ENotification SCR_VotingUIInfo.GetVotingStartNotification ( )

Get Start notification ID which is send to the Notification Component to show the specific notification when the voting starts.

Returns: ENotification Notification ID of Start voting

◆ GetVotingSucceedNotification()

ENotification SCR_VotingUIInfo.GetVotingSucceedNotification ( )

Get Succeed notification ID which is send to the Notification Component to show the specific notification when voting ends and succeeds.

Returns: ENotification Notification ID of successful voting

Member Data Documentation

◆ m_eVoteAbstainedLocalNotification

ENotification SCR_VotingUIInfo.m_eVoteAbstainedLocalNotification

protected

◆ m_eVoteCastedLocalNotification

ENotification SCR_VotingUIInfo.m_eVoteCastedLocalNotification

protected

◆ m_iFailedNotificationId

ENotification SCR_VotingUIInfo.m_iFailedNotificationId

protected

◆ m_iStartNotificationId

ENotification SCR_VotingUIInfo.m_iStartNotificationId

protected

◆ m_iSucceededNotificationId

ENotification SCR_VotingUIInfo.m_iSucceededNotificationId

protected

◆ m_sAbstainVoteName

LocalizedString SCR_VotingUIInfo.m_sAbstainVoteName

protected

◆ m_sCancelVotingName

LocalizedString SCR_VotingUIInfo.m_sCancelVotingName

protected

◆ m_sRevoteName

LocalizedString SCR_VotingUIInfo.m_sRevoteName

protected

◆ m_sStartVotingName

LocalizedString SCR_VotingUIInfo.m_sStartVotingName

protected

◆ m_sStickyNotificationText

LocalizedString SCR_VotingUIInfo.m_sStickyNotificationText

protected

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

Game/Editor/Containers/UIInfo/SCR_VotingUIInfo.c

Public Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ GetAbstainVoteName()

◆ GetCancelVotingName()

◆ GetLocalVoteAbstainedNotification()

◆ GetLocalVoteCastNotification()

◆ GetRevoteName()

◆ GetStartVotingName()

◆ GetStickyNotificationText()

◆ GetVotingFailNotification()

◆ GetVotingStartNotification()

◆ GetVotingSucceedNotification()

Member Data Documentation

◆ m_eVoteAbstainedLocalNotification

◆ m_eVoteCastedLocalNotification

◆ m_iFailedNotificationId

◆ m_iStartNotificationId

◆ m_iSucceededNotificationId

◆ m_sAbstainVoteName

◆ m_sCancelVotingName

◆ m_sRevoteName

◆ m_sStartVotingName

◆ m_sStickyNotificationText