Package org.sgrewritten.stargate.api.event.portal

Class StargateActivatePortalEvent

java.lang.Object

org.bukkit.event.Event

org.sgrewritten.stargate.api.event.portal.StargatePortalEvent

org.sgrewritten.stargate.api.event.portal.StargateEntityPortalEvent

org.sgrewritten.stargate.api.event.portal.StargateActivatePortalEvent

public class StargateActivatePortalEvent
extends StargateEntityPortalEvent

This event should be called whenever a player activates a stargate

Activation of a stargate happens when a player right-clicks the sign of a stargate. This event can be used to overwrite the selected destination, and all destinations the player can see.

Nested Class Summary

Nested classes/interfaces inherited from class org.bukkit.event.Event

org.bukkit.event.Event.Result

Constructor Summary

Constructors

Constructor	Description
StargateActivatePortalEvent(@NotNull Portal portal, @NotNull org.bukkit.entity.Entity entity, @NotNull List<String> destinations, String destination)	Instantiates a new stargate activate event

Method Summary

Modifier and Type	Method	Description
String	getDestination()	Gets the selected destination
List<String>	getDestinations()	Gets the destinations available for the portal
static org.bukkit.event.HandlerList	getHandlerList()	Gets a handler-list containing all event handlers
@NotNull org.bukkit.event.HandlerList	getHandlers()
void	setDestination(String destination)	Sets (changes) the selected destination
void	setDestinations(@NotNull List<String> destinations)	Sets the destinations available to the player using the portal

Methods inherited from class org.sgrewritten.stargate.api.event.portal.StargateEntityPortalEvent

getEntity

Methods inherited from class org.sgrewritten.stargate.api.event.portal.StargatePortalEvent

getPortal

Methods inherited from class org.bukkit.event.Event

callEvent, getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

Constructor Details

StargateActivatePortalEvent

public StargateActivatePortalEvent(@NotNull
 @NotNull Portal portal,
 @NotNull
 @NotNull org.bukkit.entity.Entity entity,
 @NotNull
 @NotNull List<String> destinations,
 String destination)

Instantiates a new stargate activate event

Parameters:

portal -

The activated portal

entity -

The entity activating the portal

destinations -

The destinations available to the player using the portal

destination -

The currently selected destination

Method Details

getDestinations

public List<String> getDestinations()

Gets the destinations available for the portal

Returns:

The destinations available for the portal

setDestinations

public void setDestinations(@NotNull
 @NotNull List<String> destinations)

Sets the destinations available to the player using the portal

Parameters:

destinations -

The new list of available destinations

getDestination

public String getDestination()

Gets the selected destination

Returns:

The selected destination

setDestination

public void setDestination(String destination)

Sets (changes) the selected destination

Parameters:

destination -

The new selected destination

getHandlerList

public static org.bukkit.event.HandlerList getHandlerList()

Gets a handler-list containing all event handlers

Returns:

A handler-list with all event handlers

getHandlers

@NotNull
public @NotNull org.bukkit.event.HandlerList getHandlers()

Specified by:

getHandlers in class org.bukkit.event.Event