Package org.skriptlang.skript.bukkit.fishing.elements

Class EvtFish

java.lang.Object

org.skriptlang.skript.lang.structure.Structure

ch.njol.skript.lang.SkriptEvent

org.skriptlang.skript.bukkit.fishing.elements.EvtFish

All Implemented Interfaces:

Debuggable, SyntaxElement

@Name("Fishing")
@Description({"Called when a player triggers a fishing event.","An entity hooked event is triggered when an entity gets caught by a fishing rod.","A fish escape event is called when the player fails to click on time, and the fish escapes.","A fish approaching event is when the bobber is waiting to be hooked, and a fish is approaching."})
@Examples({"on fishing line cast:","\tsend \"You caught a fish!\" to player","on fishing state of caught entity:","\tpush event-entity vector from entity to player"})
@RequiredPlugins("Paper (bobber lured)")
@Since("2.10")
public class EvtFish
extends SkriptEvent

Nested Class Summary

Nested classes/interfaces inherited from class ch.njol.skript.lang.SkriptEvent

SkriptEvent.ListeningBehavior

Nested classes/interfaces inherited from class org.skriptlang.skript.lang.structure.Structure

Structure.Priority, Structure.StructureData

Field Summary

Fields inherited from class ch.njol.skript.lang.SkriptEvent

eventPriority, listeningBehavior, PRIORITY, supportsListeningBehavior, trigger

Fields inherited from class org.skriptlang.skript.lang.structure.Structure

DEFAULT_PRIORITY

Constructor Summary

Constructors

Constructor	Description
EvtFish()

Method Summary

Modifier and Type	Method	Description
boolean	check(org.bukkit.event.Event event)	Checks whether the given Event applies, e.g.
boolean	init(Literal<?>[] args, int matchedPattern, SkriptParser.ParseResult parseResult)	Called just after the constructor
String	toString(@Nullable org.bukkit.event.Event event, boolean debug)

Methods inherited from class ch.njol.skript.lang.SkriptEvent

canExecuteAsynchronously, fixPattern, getEventClasses, getEventPriority, getListeningBehavior, getPriority, init, isEventPrioritySupported, isListeningBehaviorSupported, load, parse, postLoad, postUnload, preLoad, shouldLoadEvent, unload

Methods inherited from class org.skriptlang.skript.lang.structure.Structure

getEntryContainer, getSyntaxTypeName, init, parse, parse, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.njol.skript.lang.SyntaxElement

getParser

Constructor Details

EvtFish

public EvtFish()

Method Details

init

public boolean init(Literal<?>[] args,
 int matchedPattern,
 SkriptParser.ParseResult parseResult)

Description copied from class: SkriptEvent

Called just after the constructor

Specified by:

init in class SkriptEvent

check

public boolean check(org.bukkit.event.Event event)

Description copied from class: SkriptEvent

Checks whether the given Event applies, e.g. the left-click event is only part of the PlayerInteractEvent, and this checks whether the player left-clicked or not. This method will only be called for events this SkriptEvent is registered for.

Specified by:

check in class SkriptEvent

Returns:

true if this is SkriptEvent is represented by the Bukkit Event or false if not

toString

public String toString(@Nullable
 @Nullable org.bukkit.event.Event event,
 boolean debug)

Parameters:

event - The event to get information from. This is always null if debug == false.

debug - If true this should print more information, if false this should print what is shown to the end user

Returns:

String representation of this object