Package com.ohacd.matchbox.api.events

Class PlayerVoteEvent

java.lang.Object

com.ohacd.matchbox.api.MatchboxEvent

com.ohacd.matchbox.api.events.PlayerVoteEvent

public class PlayerVoteEvent
extends MatchboxEvent

Event fired when a player casts a vote during the voting phase.

Since:

0.9.5

Constructor Summary

Constructors

Constructor	Description
PlayerVoteEvent(@NotNull String sessionName, @NotNull org.bukkit.entity.Player voter, @NotNull org.bukkit.entity.Player target)	Creates a new player vote event.

Method Summary

Modifier and Type	Method	Description
void	dispatch(@NotNull MatchboxEventListener listener)	Dispatches this event to the appropriate listener method.
@NotNull String	getSessionName()	Gets the name of the session where the vote occurred.
@NotNull org.bukkit.entity.Player	getTarget()	Gets the player who was voted for.
@NotNull org.bukkit.entity.Player	getVoter()	Gets the player who cast the vote.

Methods inherited from class com.ohacd.matchbox.api.MatchboxEvent

getTimestamp, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

PlayerVoteEvent

public PlayerVoteEvent(@NotNull
 @NotNull String sessionName,
 @NotNull
 @NotNull org.bukkit.entity.Player voter,
 @NotNull
 @NotNull org.bukkit.entity.Player target)

Creates a new player vote event.

Parameters:

sessionName - the session name

voter - the player who voted

target - the player who was voted for

Method Details

dispatch

public void dispatch(@NotNull
 @NotNull MatchboxEventListener listener)

Description copied from class: MatchboxEvent

Dispatches this event to the appropriate listener method.

This method uses the visitor pattern to call the correct handler method based on the concrete event type. Implementing classes should call super.dispatch(listener) as the first line.

Specified by:

dispatch in class MatchboxEvent

Parameters:

listener - the listener to dispatch to

getSessionName

@NotNull
public @NotNull String getSessionName()

Gets the name of the session where the vote occurred.

Returns:

the session name

getVoter

@NotNull
public @NotNull org.bukkit.entity.Player getVoter()

Gets the player who cast the vote.

Returns:

the voter

getTarget

@NotNull
public @NotNull org.bukkit.entity.Player getTarget()

Gets the player who was voted for.

Returns:

the voted target