SCR_VotingReferendum Class Reference

Inheritance diagram for SCR_VotingReferendum:

Protected Member Functions
float	GetRatio ()
override bool	AddPlayerVotedServer (int playerID)
override bool	RemovePlayerVotedServer (int playerID)
override void	SetVote (int playerID, int value=DEFAULT_VALUE)
override bool	RemoveVote (int playerID)
override bool	RemoveValue (int value)
override bool	IsMatching (EVotingType type, int value=DEFAULT_VALUE)
override bool	Evaluate (out EVotingOutcome outcome)
override int	GetWinner ()
override int	GetPlayerVote (int playerID)
override int	GetValue ()
override void	Log ()
override void	InitFromTemplate (SCR_VotingBase template, int startingPlayerID, int value, float remainingDuration)

Protected Attributes
ref set< int >	m_aPlayerIDs = new set<int>()
int	m_iValue

Detailed Description

Referendum about specific outcome. Can have target value, e.g., player ID of whoever should be kicked. Multiple votings of the same type can exist at the same type, e.g., KICK player 1 and KICK player 2. The voting succeeds when proportion of votes is larger than given threshold and there was sufficient participation. If time runs out, the voting is invalid.

Definition at line 463 of file SCR_VotingBase.c.

Member Function Documentation

AddPlayerVotedServer()

override bool SCR_VotingReferendum::AddPlayerVotedServer ( int playerID )

inlineprotected

Definition at line 475 of file SCR_VotingBase.c.

Evaluate()

override bool SCR_VotingReferendum::Evaluate ( out EVotingOutcome outcome )

inlineprotected

Definition at line 552 of file SCR_VotingBase.c.

GetPlayerVote()

override int SCR_VotingReferendum::GetPlayerVote ( int playerID )

inlineprotected

Definition at line 567 of file SCR_VotingBase.c.

GetRatio()

float SCR_VotingReferendum::GetRatio ( )

inlineprotected

Definition at line 469 of file SCR_VotingBase.c.

GetValue()

override int SCR_VotingReferendum::GetValue ( )

inlineprotected

Definition at line 576 of file SCR_VotingBase.c.

GetWinner()

override int SCR_VotingReferendum::GetWinner ( )

inlineprotected

Definition at line 558 of file SCR_VotingBase.c.

InitFromTemplate()

override void SCR_VotingReferendum::InitFromTemplate ( SCR_VotingBase template, int startingPlayerID, int value, float remainingDuration )

inlineprotected

Definition at line 592 of file SCR_VotingBase.c.

IsMatching()

override bool SCR_VotingReferendum::IsMatching ( EVotingType type, int value = DEFAULT_VALUE )

inlineprotected

Definition at line 546 of file SCR_VotingBase.c.

Log()

override void SCR_VotingReferendum::Log ( )

inlineprotected

Definition at line 582 of file SCR_VotingBase.c.

RemovePlayerVotedServer()

override bool SCR_VotingReferendum::RemovePlayerVotedServer ( int playerID )

inlineprotected

Definition at line 497 of file SCR_VotingBase.c.

RemoveValue()

override bool SCR_VotingReferendum::RemoveValue ( int value )

inlineprotected

Definition at line 540 of file SCR_VotingBase.c.

RemoveVote()

override bool SCR_VotingReferendum::RemoveVote ( int playerID )

inlineprotected

Definition at line 525 of file SCR_VotingBase.c.

SetVote()

override void SCR_VotingReferendum::SetVote ( int playerID, int value = DEFAULT_VALUE )

inlineprotected

Definition at line 519 of file SCR_VotingBase.c.

Member Data Documentation

m_aPlayerIDs

ref set<int> SCR_VotingReferendum::m_aPlayerIDs = new set<int>()

protected

Definition at line 465 of file SCR_VotingBase.c.

m_iValue

int SCR_VotingReferendum::m_iValue

protected

Definition at line 466 of file SCR_VotingBase.c.

---

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

• scripts/Game/Components/Voting/SCR_VotingBase.c