Package org.skriptlang.skript.bukkit.registration

Interface BukkitSyntaxInfos.Event<E extends SkriptEvent>

Type Parameters:

E - The class providing the implementation of the SkriptEvent this info represents.

All Superinterfaces:

Builder.Buildable<SyntaxInfo.Builder<?,?>,SyntaxInfo<?>>, DefaultSyntaxInfos, SyntaxInfo<E>

All Known Implementing Classes:

SkriptEventInfo.ModernSkriptEventInfo

Enclosing class:

BukkitSyntaxInfos

public static interface BukkitSyntaxInfos.Event<E extends SkriptEvent>
extends SyntaxInfo<E>

A syntax info to be used for SkriptEvents. It contains additional details including the Bukkit events represented along with documentation data.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	BukkitSyntaxInfos.Event.Builder<B extends BukkitSyntaxInfos.Event.Builder<B,E>,E extends SkriptEvent>	An Event-specific builder is used for constructing a new Event syntax info.

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

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

Field Summary

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

COMBINED, PATTERN_MATCHES_EVERYTHING, SIMPLE

Method Summary

Modifier and Type	Method	Description
BukkitSyntaxInfos.Event.Builder<? extends BukkitSyntaxInfos.Event.Builder<?,E>,E>	builder()
static <E extends SkriptEvent> BukkitSyntaxInfos.Event.Builder<? extends BukkitSyntaxInfos.Event.Builder<?,E>,E>	builder(Class<E> eventClass, String name)
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()
@Nullable String	since()

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

instance, origin, patterns, priority, type

Method Details

builder

static <E extends SkriptEvent>
BukkitSyntaxInfos.Event.Builder<? extends BukkitSyntaxInfos.Event.Builder<?,E>,E> builder(Class<E> eventClass,
 String name)

Parameters:

eventClass - The Structure class the info will represent.

name - The name of the SkriptEvent.

Returns:

A Structure-specific builder for creating a syntax info representing type.

builder

@Contract("-> new")
BukkitSyntaxInfos.Event.Builder<? extends BukkitSyntaxInfos.Event.Builder<?,E>,E> builder()

Specified by:

builder in interface Builder.Buildable<SyntaxInfo.Builder<?,?>,SyntaxInfo<?>>

Specified by:

builder in interface SyntaxInfo<E extends SkriptEvent>

Returns:

A builder representing this object.

listeningBehavior

SkriptEvent.ListeningBehavior listeningBehavior()

Returns:

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

name

String name()

Returns:

The name of the SkriptEvent.

id

String id()

Returns:

A documentation-friendly version of name().

since

@Nullable
@Nullable String since()

Returns:

Documentation data. Represents the version of the plugin in which a syntax was added.

See Also:

• Since

documentationId

@Nullable
@Nullable String documentationId()

Returns:

Documentation data. Used for identifying specific syntaxes in documentation.

See Also:

• DocumentationId

description

Collection<String> description()

Returns:

Documentation data. A description of a syntax.

See Also:

• Description

examples

Collection<String> examples()

Returns:

Documentation data. Examples for using a syntax.

See Also:

• Examples

keywords

Collection<String> keywords()

Returns:

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

See Also:

• Keywords

requiredPlugins

Collection<String> requiredPlugins()

Returns:

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

See Also:

• RequiredPlugins

events

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

Returns:

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