Arma Reforger Script API
|
Public Member Functions | |
override void | InitFromTemplate (SCR_VotingBase template, int value, float remainingDuration) |
Initialise voting from given template. | |
bool | isFactionSpecific () |
override bool | IsAvailable (int value, bool isOngoing) |
Check if the voting is available in the current world. | |
override int | GetPlayerCount () |
Get total player count of players that are valid to vote for the issue. | |
override void | OnVotingEnd (int value=DEFAULT_VALUE, int winner=DEFAULT_VALUE) |
Event called when the voting ends. | |
![]() | |
override void | SetVote (int playerID, int value=DEFAULT_VALUE) |
Set vote of given player. | |
override bool | RemoveVote (int playerID) |
Remove vote of given player. | |
override bool | RemoveValue (int value) |
Remove all votes for given value. | |
override bool | IsMatching (EVotingType type, int value=DEFAULT_VALUE) |
Check if the voting is matching given params. | |
override bool | Evaluate (out EVotingOutcome outcome) |
Evaluate if the voting can end. | |
override int | GetWinner () |
Get winner of the vote. | |
override int | GetPlayerVote (int playerID) |
override int | GetValue () |
Get voting value. | |
override void | Log () |
![]() | |
bool | AddPlayerVotedServer (int playerID) |
A player has voted to approve (server only) | |
bool | RemovePlayerVotedServer (int playerID) |
A player has voted to remove or abstain (server only) | |
void | SetCurrentVoteCount (int currentVoteCount) |
Set the current amount of votes this vote has. | |
int | GetCurrentVoteCount () |
int | GetJoinServerVoteCooldown () |
int | GetServerRuntimeIgnoreJoinServerCooldown () |
int | GetVoteCooldownTime () |
bool | HasCooldown () |
float | GetLocalCooldownTimeStamp () |
void | SetLocalCooldownTimeStamp (float newTimeStamp) |
Set the time stamp for cooldowns for this voting param[in] New Time stamp to set. | |
bool | HasInitiatedVotingLocallyOnce () |
void | SetHasInitiatedVotingLocallyOnce () |
Set Has initiated voting locally at least once to true. | |
bool | CanSendNotification (int value) |
Check if notification can be shown for this voting. | |
string | GetValueName (int value) |
Get name of the value. | |
EVotingType | GetType () |
Get voting type. | |
SCR_VotingUIInfo | GetInfo () |
Get voting UI representation. | |
float | GetRemainingDuration () |
bool | IsValuePlayerID () |
Check if the voting is about player IDs. | |
void | SetVoteLocal (int value) |
Save local vote. | |
void | RemoveVoteLocal () |
Remove local vote. | |
int | GetLocalVote () |
Get local vote. | |
void | Update (float timeSlice) |
Periodically update the voting. | |
int | GetVoteCountRequired () |
Get total players needed to make sure the vote is successfull. | |
Protected Attributes | |
bool | m_bFactionSpecific |
![]() | |
ref set< int > | m_aPlayerIDs = new set<int>() |
int | m_iValue |
![]() | |
EVotingType | m_Type |
bool | m_bIsValuePlayerID |
float | m_fDuration |
float | m_fThreshold |
float | m_iMinParticipation |
int | m_iMinVotes |
ref SCR_VotingUIInfo | m_Info |
int | m_iJoinServerVoteCooldown |
int | m_iServerRuntimeIgnoreJoinServerCooldown |
int | m_iVoteCooldownTime |
float | m_fVoteCooldownTimeStamp = -1 |
bool | m_bHasInitiatedVotingLocallyOnce |
int | m_iLocalValue = DEFAULT_VALUE |
int | m_iCurrentVoteCount |
ref array< int > | m_aPlayersVoted_Server = {} |
Static Protected Attributes | |
static const int | PLAYER_VOTE_KICK_DURATION = 300 |
Additional Inherited Members | |
![]() | |
static const int | DEFAULT_VALUE = -1 |
![]() | |
float | GetRatio () |
![]() | |
bool | EvaluateParticipation (int voteCount) |
override int SCR_VotingKick.GetPlayerCount | ( | ) |
Get total player count of players that are valid to vote for the issue.
Implements SCR_VotingBase.
override void SCR_VotingKick.InitFromTemplate | ( | SCR_VotingBase | template, |
int | value, | ||
float | remainingDuration ) |
Initialise voting from given template.
[in] | template | Source template |
[in] | value | Target value |
[in] | remainingDuration | Remaining time until the voting ends in seconds (-1 to use default) |
Implements SCR_VotingReferendum.
override bool SCR_VotingKick.IsAvailable | ( | int | value, |
bool | isOngoing ) |
Check if the voting is available in the current world.
[in] | value | Potential voting value |
[in] | isOngoing | True if the voting was already initiated |
Implements SCR_VotingBase.
Implemented in SCR_VotingAutoKick.
bool SCR_VotingKick.isFactionSpecific | ( | ) |
override void SCR_VotingKick.OnVotingEnd | ( | int | value = DEFAULT_VALUE, |
int | winner = DEFAULT_VALUE ) |
Event called when the voting ends.
[in] | value | Voting value |
[in] | winner | Winning value |
Implements SCR_VotingBase.
|
protected |
|
staticprotected |