Package ch.njol.skript.lang

Class SkriptEventInfo<E extends SkriptEvent>

java.lang.Object

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

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

public final class SkriptEventInfo<E extends SkriptEvent>
extends SyntaxElementInfo<E>

Field Summary

Fields

Modifier and Type	Field	Description
Class<? extends org.bukkit.event.Event>[]	events
String	name
static String[]	NO_DOC	Use this as description(String...) to prevent warnings about missing documentation.

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

c, originClassPath, patterns

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
SkriptEventInfo<E>	description(String... description)	Only used for Skript's documentation.
SkriptEventInfo<E>	documentationID(String id)	A non critical ID remapping for syntax elements register using the same class multiple times.
SkriptEventInfo<E>	examples(String... examples)	Only used for Skript's documentation.
@Nullable String[]	getDescription()
@Nullable String	getDocumentationID()
@Nullable String[]	getExamples()
String	getId()
String	getName()
@Nullable String[]	getRequiredPlugins()
@Nullable String	getSince()
SkriptEventInfo<E>	requiredPlugins(String... pluginNames)	Other plugin dependencies for this SkriptEvent.
SkriptEventInfo<E>	since(String since)	Only used for Skript's documentation.

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

getElementClass, getOriginClassPath, getPatterns

Methods inherited from class java.lang.Object

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

Field Details

events

public Class<? extends org.bukkit.event.Event>[] events

name

public final String name

NO_DOC

public static final String[] NO_DOC

Use this as description(String...) to prevent warnings about missing documentation.

Constructor Details

SkriptEventInfo

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

Parameters:

name - Capitalised name of the event without leading "On" which is added automatically (Start the name with an asterisk to prevent this).

patterns -

c - The SkriptEvent's class

originClassPath - The class path for the origin of this event.

events - The Bukkit-Events this SkriptEvent listens to

Method Details

description

public SkriptEventInfo<E> description(String... description)

Only used for Skript's documentation.

Parameters:

description -

Returns:

This SkriptEventInfo object

examples

public SkriptEventInfo<E> examples(String... examples)

Only used for Skript's documentation.

Parameters:

examples -

Returns:

This SkriptEventInfo object

since

public SkriptEventInfo<E> since(String since)

Only used for Skript's documentation.

Parameters:

since -

Returns:

This SkriptEventInfo object

documentationID

public SkriptEventInfo<E> documentationID(String id)

A non critical ID remapping for syntax elements register using the same class multiple times. Only used for Skript's documentation.

Parameters:

id -

Returns:

This SkriptEventInfo object

requiredPlugins

public SkriptEventInfo<E> requiredPlugins(String... pluginNames)

Other plugin dependencies for this SkriptEvent. Only used for Skript's documentation.

Parameters:

pluginNames -

Returns:

This SkriptEventInfo object

getId

public String getId()

getName

public String getName()

getDescription

public @Nullable String[] getDescription()

getExamples

public @Nullable String[] getExamples()

getSince

public @Nullable String getSince()

getRequiredPlugins

public @Nullable String[] getRequiredPlugins()

getDocumentationID

public @Nullable String getDocumentationID()