Package de.oliver.fancynpcs.api.events

Class NpcInteractEvent

java.lang.Object

org.bukkit.event.Event

de.oliver.fancynpcs.api.events.NpcInteractEvent

All Implemented Interfaces:

org.bukkit.event.Cancellable

public class NpcInteractEvent
extends org.bukkit.event.Event
implements org.bukkit.event.Cancellable

Is fired when a player interacts with a NPC

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	NpcInteractEvent.InteractionType

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

org.bukkit.event.Event.Result

Constructor Summary

Constructors

Constructor	Description
NpcInteractEvent(@NotNull Npc npc, @Nullable List<String> playerCommands, @Nullable String serverCommand, @NotNull Consumer<org.bukkit.entity.Player> onClick, @NotNull org.bukkit.entity.Player player, @NotNull NpcInteractEvent.InteractionType interactionType)

Method Summary

Modifier and Type	Method	Description
static org.bukkit.event.HandlerList	getHandlerList()
@NotNull org.bukkit.event.HandlerList	getHandlers()
@NotNull NpcInteractEvent.InteractionType	getInteractionType()
@NotNull Npc	getNpc()
@NotNull Consumer<org.bukkit.entity.Player>	getOnClick()
@NotNull org.bukkit.entity.Player	getPlayer()
@Nullable List<String>	getPlayerCommands()
@Nullable String	getServerCommand()
boolean	isCancelled()
void	setCancelled(boolean cancel)

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

NpcInteractEvent

public NpcInteractEvent(@NotNull
 @NotNull Npc npc,
 @Nullable
 @Nullable List<String> playerCommands,
 @Nullable
 @Nullable String serverCommand,
 @NotNull
 @NotNull Consumer<org.bukkit.entity.Player> onClick,
 @NotNull
 @NotNull org.bukkit.entity.Player player,
 @NotNull
 @NotNull NpcInteractEvent.InteractionType interactionType)

Method Details

getHandlerList

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

getNpc

@NotNull
public @NotNull Npc getNpc()

Returns:

the modified npc

getPlayerCommands

@Nullable
public @Nullable List<String> getPlayerCommands()

Returns:

the commands that the player will be forced to run

getServerCommand

@Nullable
public @Nullable String getServerCommand()

Returns:

the command that the server will run

getOnClick

@NotNull
public @NotNull Consumer<org.bukkit.entity.Player> getOnClick()

Returns:

the custom on click method that will run

getInteractionType

@NotNull
public @NotNull NpcInteractEvent.InteractionType getInteractionType()

Returns:

returns interaction type

getPlayer

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

Returns:

the player who interacted with the npc

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface org.bukkit.event.Cancellable

setCancelled

public void setCancelled(boolean cancel)

Specified by:

setCancelled in interface org.bukkit.event.Cancellable

getHandlers

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

Specified by:

getHandlers in class org.bukkit.event.Event