bz_ePollVoteEvent

This event is called whenever a player uses /vote in a poll

Data Object Type

2.4.10 bz_PollVoteEventData_V1

Parameters

These are the values accessible in the bz_EventData variable that's made available in the Event method.

Data Type	Name	Description
int	playerID	The player ID casting a vote
bool	inFavor	True if the player voted in favor of the poll; i.e. /vote yes
bool	allow	Setting to false will disallow a player from voting
bz_ApiString	reason	The message sent to the player as to why their vote wasn't cast
double	eventTime	The time of the event.

Plug-in Usage

There are no plug-ins in the official distribution that make use of this event. Browse the Plug-in Releases forum for plug-ins which may make use of this event.

Plug-in Example

This block of code can be used to get started when implementing the Event() function of your plug-in.

bz_PollVoteEventData_V1* dataObject = (bz_PollVoteEventData_V1*)eventData;

// Data
// ---
// (int)          playerID - The player ID casting a vote
// (bool)         inFavor - True if the player voted in favor of the poll; i.e. /vote yes
// (bool)         allow - Setting to false will disallow a player from voting
// (bz_ApiString) reason - The message sent to the player as to why their vote wasn't cast
// (double)       eventTime - The time of the event.

Other Polls Events

• bz_eAllowPollEvent
• bz_ePollEndEvent
• bz_ePollStartEvent
• bz_ePollVetoEvent

Back to bzfs API Events