SCR_VoterComponent.c File Reference

Go to the source code of this file.

Data Structures
class	SCR_VoterComponentClass

Functions
void	Vote (EVotingType type, int value)
void	RemoveVote (EVotingType type, int value=SCR_VotingBase.DEFAULT_VALUE)
void	AbstainVote (EVotingType type, int value=SCR_VotingBase.DEFAULT_VALUE)
bool	DidVote (EVotingType type, int value=SCR_VotingBase.DEFAULT_VALUE)
bool	HasAbstained (EVotingType type, int value=SCR_VotingBase.DEFAULT_VALUE)
protected void	VoteServer (EVotingType type, int value)
protected void	RemoveVoteServer (EVotingType type, int value)
override void	OnPostInit (IEntity owner)
	Called on PostInit when all components are added. More...

Variables
SCR_VoterComponentClass	m_PlayerController

Function Documentation

AbstainVote()

void AbstainVote	(	EVotingType	type,
		int	value = SCR_VotingBase.DEFAULT_VALUE
	)

Player abstained from voting. Eg: Did not vote yes or removes vote yes

Parameters

[in]	type	Type of the vote
[in]	value	Voted value, depends on the type (e.g., for KICK it's player ID)

Definition at line 137 of file SCR_VoterComponent.c.

DidVote()

bool DidVote	(	EVotingType	type,
		int	value = SCR_VotingBase.DEFAULT_VALUE
	)

Check if player did cast the vote.

Parameters

[in]	type	Type of the vote
[in]	value	Voted value, depends on the type (e.g., for KICK it's player ID)

Returns

True if the vote was cast

Definition at line 158 of file SCR_VoterComponent.c.

HasAbstained()

bool HasAbstained	(	EVotingType	type,
		int	value = SCR_VotingBase.DEFAULT_VALUE
	)

Check if player abstained from voting

Parameters

[in]	type	Type of the vote
[in]	value	Voted value, depends on the type (e.g., for KICK it's player ID)

Returns

True if the player abstained

Definition at line 172 of file SCR_VoterComponent.c.

RemoveVote()

void RemoveVote	(	EVotingType	type,
		int	value = SCR_VotingBase.DEFAULT_VALUE
	)

Remove previously cast vote.

Parameters

[in]	type	Type of the vote
[in]	value	Voted value, depends on the type (e.g., for KICK it's player ID)

Definition at line 120 of file SCR_VoterComponent.c.

RemoveVoteServer()

protected void RemoveVoteServer	(	EVotingType	type,
		int	value
	)

Definition at line 193 of file SCR_VoterComponent.c.

Vote()

void Vote	(	EVotingType	type,
		int	value
	)

Vote!

Parameters

[in]	type	Type of the vote
[in]	value	Voted value, depends on the type (e.g., for KICK it's player ID)

Definition at line 106 of file SCR_VoterComponent.c.

VoteServer()

protected void VoteServer	(	EVotingType	type,
		int	value
	)

Definition at line 184 of file SCR_VoterComponent.c.

Variable Documentation

m_PlayerController

SCR_VoterComponentClass m_PlayerController