Package ch.njol.skript.lang

Class SkriptEventInfo.ModernSkriptEventInfo<E extends SkriptEvent>

java.lang.Object

ch.njol.skript.lang.SyntaxElementInfo<E>

org.skriptlang.skript.lang.structure.StructureInfo<E>

ch.njol.skript.lang.SkriptEventInfo<E>

ch.njol.skript.lang.SkriptEventInfo.ModernSkriptEventInfo<E>

All Implemented Interfaces:

BukkitSyntaxInfos.Event<E>, DefaultSyntaxInfos, SyntaxInfo<E>

Enclosing class:

SkriptEventInfo<E extends SkriptEvent>

@Internal
@Experimental
public static final class SkriptEventInfo.ModernSkriptEventInfo<E extends SkriptEvent>
extends SkriptEventInfo<E>
implements BukkitSyntaxInfos.Event<E>

Internal wrapper class for providing compatibility with the new Registration API.

Nested Class Summary

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

SkriptEventInfo.ModernSkriptEventInfo<E extends SkriptEvent>

Nested classes/interfaces inherited from interface org.skriptlang.skript.bukkit.registration.BukkitSyntaxInfos.Event

BukkitSyntaxInfos.Event.Builder<B extends BukkitSyntaxInfos.Event.Builder<B,E>,E extends SkriptEvent>

Nested classes/interfaces inherited from interface org.skriptlang.skript.registration.DefaultSyntaxInfos

DefaultSyntaxInfos.Expression<E extends Expression<R>,R>, DefaultSyntaxInfos.Structure<E extends Structure>

Nested classes/interfaces inherited from interface org.skriptlang.skript.registration.SyntaxInfo

SyntaxInfo.Builder<B extends SyntaxInfo.Builder<B,E>,E extends SyntaxElement>

Field Summary

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

events, name, NO_DOC

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

entryValidator, nodeType, simple

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

elementClass, originClassPath, patterns

Fields inherited from interface org.skriptlang.skript.registration.SyntaxInfo

COMBINED, PATTERN_MATCHES_EVERYTHING, SIMPLE

Constructor Summary

Constructors

Constructor	Description
ModernSkriptEventInfo(String name, String[] patterns, Class<E> eventClass, String originClassPath, Class<? extends org.bukkit.event.Event>[] events)

Method Summary

Modifier and Type	Method	Description
Collection<String>	description()
@Nullable String	documentationId()
Collection<Class<? extends org.bukkit.event.Event>>	events()
Collection<String>	examples()
String	id()
Collection<String>	keywords()
SkriptEvent.ListeningBehavior	listeningBehavior()
String	name()
Collection<String>	requiredPlugins()
Collection<String>	since()
BukkitSyntaxInfos.Event.Builder<? extends BukkitSyntaxInfos.Event.Builder<?,E>,E>	toBuilder()

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

description, documentationID, examples, getDescription, getDocumentationID, getExamples, getId, getKeywords, getListeningBehavior, getName, getRequiredPlugins, getSince, keywords, listeningBehavior, requiredPlugins, since, since

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

fromModern, getElementClass, getOriginClassPath, getPatterns, instance, origin, patterns, priority, type

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.skriptlang.skript.registration.SyntaxInfo

instance, origin, patterns, priority, type

Constructor Details

ModernSkriptEventInfo

public ModernSkriptEventInfo(String name,
 String[] patterns,
 Class<E> eventClass,
 String originClassPath,
 Class<? extends org.bukkit.event.Event>[] events)

Method Details

toBuilder

public BukkitSyntaxInfos.Event.Builder<? extends BukkitSyntaxInfos.Event.Builder<?,E>,E> toBuilder()

Description copied from interface: BukkitSyntaxInfos.Event

Specified by:

toBuilder in interface BukkitSyntaxInfos.Event<E extends SkriptEvent>

Specified by:

toBuilder in interface SyntaxInfo<E extends SkriptEvent>

Overrides:

toBuilder in class SyntaxElementInfo<E extends SkriptEvent>

Returns:

A builder representing this SyntaxInfo.

listeningBehavior

public SkriptEvent.ListeningBehavior listeningBehavior()

Specified by:

listeningBehavior in interface BukkitSyntaxInfos.Event<E extends SkriptEvent>

Returns:

The listening behavior for the SkriptEvent. Determines when the event should trigger.

name

public String name()

Specified by:

name in interface BukkitSyntaxInfos.Event<E extends SkriptEvent>

Returns:

The name of the SkriptEvent.

id

public String id()

Specified by:

id in interface BukkitSyntaxInfos.Event<E extends SkriptEvent>

Returns:

A documentation-friendly version of BukkitSyntaxInfos.Event.name().

documentationId

@Nullable
public @Nullable String documentationId()

Specified by:

documentationId in interface BukkitSyntaxInfos.Event<E extends SkriptEvent>

Returns:

Documentation data. Used for identifying specific syntaxes in documentation.

See Also:

• DocumentationId

since

public Collection<String> since()

Specified by:

since in interface BukkitSyntaxInfos.Event<E extends SkriptEvent>

Returns:

Documentation data. Represents the versions of the plugin in which a syntax was added or modified.

See Also:

• Since

description

public Collection<String> description()

Specified by:

description in interface BukkitSyntaxInfos.Event<E extends SkriptEvent>

Returns:

Documentation data. A description of a syntax.

See Also:

• Description

examples

public Collection<String> examples()

Specified by:

examples in interface BukkitSyntaxInfos.Event<E extends SkriptEvent>

Returns:

Documentation data. Examples for using a syntax.

See Also:

• Examples

keywords

public Collection<String> keywords()

Specified by:

keywords in interface BukkitSyntaxInfos.Event<E extends SkriptEvent>

Returns:

Documentation data. Keywords are used by the search engine to provide relevant results.

See Also:

• Keywords

requiredPlugins

public Collection<String> requiredPlugins()

Specified by:

requiredPlugins in interface BukkitSyntaxInfos.Event<E extends SkriptEvent>

Returns:

Documentation data. Plugins other than Skript that are required by a syntax.

See Also:

• RequiredPlugins

events

public Collection<Class<? extends org.bukkit.event.Event>> events()

Specified by:

events in interface BukkitSyntaxInfos.Event<E extends SkriptEvent>

Returns:

A collection of the classes representing the Bukkit events the SkriptEvent listens for.