Package ch.njol.skript.lang

Class SkriptEventInfo<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>
All Implemented Interfaces:
DefaultSyntaxInfos, SyntaxInfo<E>
Direct Known Subclasses:
SkriptEventInfo.ModernSkriptEventInfo
@Deprecated(since="2.14", forRemoval=true) public sealed class SkriptEventInfo<E extends SkriptEvent> extends StructureInfo<E> permits SkriptEventInfo.ModernSkriptEventInfo<E>
Deprecated, for removal: This API element is subject to removal in a future version.
Use BukkitSyntaxInfos.Event (BukkitSyntaxInfos.Event.builder(Class, String) instead.

  • Field Details

    • events

      public Class<? extends org.bukkit.event.Event>[] events
      Deprecated, for removal: This API element is subject to removal in a future version.

    • name

      public final String name
      Deprecated, for removal: This API element is subject to removal in a future version.

    • NO_DOC

      public static final String[] NO_DOC
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use this as description(String...) to prevent warnings about missing documentation.

  • Constructor Details

    • SkriptEventInfo

      public SkriptEventInfo(String name, String[] patterns, Class<E> eventClass, String originClassPath, Class<? extends org.bukkit.event.Event>[] events)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Parameters:
      name - Capitalised name of the event without leading "On" which is added automatically (Start the name with an asterisk to prevent this).
      patterns - The Skript patterns to use for this event
      eventClass - The SkriptEvent's class
      originClassPath - The class path for the origin of this event.
      events - The Bukkit-Events this SkriptEvent listens to

    • SkriptEventInfo

      @Internal protected SkriptEventInfo(BukkitSyntaxInfos.Event<E> source)
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • listeningBehavior

      public SkriptEventInfo<E> listeningBehavior(SkriptEvent.ListeningBehavior listeningBehavior)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sets the default listening behavior for this SkriptEvent. If omitted, the default behavior is to listen to uncancelled events.
      Parameters:
      listeningBehavior - The listening behavior of this SkriptEvent.
      Returns:
      This SkriptEventInfo object

    • description

      public SkriptEventInfo<E> description(String... description)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Only used for Skript's documentation.
      Parameters:
      description - The description of this event
      Returns:
      This SkriptEventInfo object

    • examples

      public SkriptEventInfo<E> examples(String... examples)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Only used for Skript's documentation.
      Parameters:
      examples - The examples for this event
      Returns:
      This SkriptEventInfo object

    • keywords

      public SkriptEventInfo<E> keywords(String... keywords)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Only used for Skript's documentation.
      Parameters:
      keywords - The keywords relating to this event
      Returns:
      This SkriptEventInfo object

    • since

      public SkriptEventInfo<E> since(String since)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Only used for Skript's documentation.
      Parameters:
      since - The version this event was added in
      Returns:
      This SkriptEventInfo object

    • since

      public SkriptEventInfo<E> since(String... since)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Only used for Skript's documentation.
      Parameters:
      since - The version this event was added in
      Returns:
      This SkriptEventInfo object

    • documentationID

      public SkriptEventInfo<E> documentationID(String id)
      Deprecated, for removal: This API element is subject to removal in a future version.
      A non-critical ID remapping for syntax elements register using the same class multiple times.
      Only used for Skript's documentation.
      Parameters:
      id - The ID to use for this syntax element
      Returns:
      This SkriptEventInfo object

    • requiredPlugins

      public SkriptEventInfo<E> requiredPlugins(String... pluginNames)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Other plugin dependencies for this SkriptEvent.
      Only used for Skript's documentation.
      Parameters:
      pluginNames - The names of the plugins this event depends on
      Returns:
      This SkriptEventInfo object

    • getId

      public String getId()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getName

      public String getName()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getListeningBehavior

      public SkriptEvent.ListeningBehavior getListeningBehavior()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getDescription

      public String @Nullable [] getDescription()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getExamples

      public String @Nullable [] getExamples()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getKeywords

      public String @Nullable [] getKeywords()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getSince

      public String @Nullable [] getSince()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getRequiredPlugins

      public String @Nullable [] getRequiredPlugins()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getDocumentationID

      @Nullable public @Nullable String getDocumentationID()
      Deprecated, for removal: This API element is subject to removal in a future version.