Package org.skriptlang.skript.bukkit.registration

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

Type Parameters:
B - The type of builder being used.
E - The SkriptEvent class providing the implementation of the syntax info being built.
All Superinterfaces:
SyntaxInfo.Builder<B,E>
Enclosing interface:
BukkitSyntaxInfos.Event<E extends SkriptEvent>
public static interface BukkitSyntaxInfos.Event.Builder<B extends BukkitSyntaxInfos.Event.Builder<B,E>,E extends SkriptEvent> extends SyntaxInfo.Builder<B,E>
An Event-specific builder is used for constructing a new Event syntax info.
See Also:

  • Method Details

    • listeningBehavior

      @Contract("_ -> this") B listeningBehavior(SkriptEvent.ListeningBehavior listeningBehavior)
      Sets the listening behavior the event will use. This determines when the event should trigger. By default, this is SkriptEvent.ListeningBehavior.UNCANCELLED.
      Parameters:
      listeningBehavior - The listening behavior to use.
      Returns:
      This builder.
      See Also:

    • since

      @Contract("_ -> this") B since(String since)
      Sets the "since" value the event's documentation will use.
      Parameters:
      since - The "since" value to use.
      Returns:
      This builder.
      See Also:

    • documentationId

      @Contract("_ -> this") B documentationId(String documentationId)
      Sets the documentation identifier the event's documentation will use.
      Parameters:
      documentationId - The documentation identifier to use.
      Returns:
      This builder.
      See Also:

    • addDescription

      @Contract("_ -> this") B addDescription(String description)
      Adds a description line to the event's documentation.
      Parameters:
      description - The description line to add.
      Returns:
      This builder.
      See Also:

    • addDescription

      @Contract("_ -> this") B addDescription(String... description)
      Adds lines of description to the event's documentation.
      Parameters:
      description - The description lines to add.
      Returns:
      This builder.
      See Also:

    • addDescription

      @Contract("_ -> this") B addDescription(Collection<String> description)
      Adds lines of description to the event's documentation.
      Parameters:
      description - The description lines to add.
      Returns:
      This builder.
      See Also:

    • clearDescription

      @Contract("-> this") B clearDescription()
      Removes all description lines from the event's documentation.
      Returns:
      This builder.
      See Also:

    • addExample

      @Contract("_ -> this") B addExample(String example)
      Adds an example to the event's documentation.
      Parameters:
      example - The example to add.
      Returns:
      This builder.
      See Also:

    • addExamples

      @Contract("_ -> this") B addExamples(String... examples)
      Adds examples to the event's documentation.
      Parameters:
      examples - The examples to add.
      Returns:
      This builder.
      See Also:

    • addExamples

      @Contract("_ -> this") B addExamples(Collection<String> examples)
      Adds examples to the event's documentation.
      Parameters:
      examples - The examples to add.
      Returns:
      This builder.
      See Also:

    • clearExamples

      @Contract("-> this") B clearExamples()
      Removes all examples from the event's documentation.
      Returns:
      This builder.
      See Also:

    • addKeyword

      @Contract("_ -> this") B addKeyword(String keyword)
      Adds a keyword to the event's documentation.
      Parameters:
      keyword - The keyword to add.
      Returns:
      This builder.
      See Also:

    • addKeywords

      @Contract("_ -> this") B addKeywords(String... keywords)
      Adds keywords to the event's documentation.
      Parameters:
      keywords - The keywords to add.
      Returns:
      This builder.
      See Also:

    • addKeywords

      @Contract("_ -> this") B addKeywords(Collection<String> keywords)
      Adds keywords to the event's documentation.
      Parameters:
      keywords - The keywords to add.
      Returns:
      This builder.
      See Also:

    • clearKeywords

      @Contract("-> this") B clearKeywords()
      Removes all keywords from the event's documentation.
      Returns:
      This builder.
      See Also:

    • addRequiredPlugin

      @Contract("_ -> this") B addRequiredPlugin(String plugin)
      Adds a required plugin to event's documentation.
      Parameters:
      plugin - The required plugin to add.
      Returns:
      This builder.
      See Also:

    • addRequiredPlugins

      @Contract("_ -> this") B addRequiredPlugins(String... plugins)
      Adds required plugins to the event's documentation.
      Parameters:
      plugins - The required plugins to add.
      Returns:
      This builder.
      See Also:

    • addRequiredPlugins

      @Contract("_ -> this") B addRequiredPlugins(Collection<String> plugins)
      Adds required plugins to the event's documentation.
      Parameters:
      plugins - The required plugins to add.
      Returns:
      This builder.
      See Also:

    • clearRequiredPlugins

      B clearRequiredPlugins()
      Removes all required plugins from the event's documentation.
      Returns:
      This builder.
      See Also:

    • addEvent

      @Contract("_ -> this") B addEvent(Class<? extends org.bukkit.event.Event> event)
      Adds an event to the event's documentation.
      Parameters:
      event - The event to add.
      Returns:
      This builder.
      See Also:

    • addEvents

      @Contract("_ -> this") B addEvents(Class<? extends org.bukkit.event.Event>[] events)
      Adds events to the event's documentation.
      Parameters:
      events - The events to add.
      Returns:
      This builder.
      See Also:

    • addEvents

      @Contract("_ -> this") B addEvents(Collection<Class<? extends org.bukkit.event.Event>> events)
      Adds events to the event's documentation.
      Parameters:
      events - The events to add.
      Returns:
      This builder.
      See Also:

    • clearEvents

      @Contract("-> this") B clearEvents()
      Removes all events from the event's documentation.
      Returns:
      This builder.
      See Also:

    • build

      @Contract("-> new") BukkitSyntaxInfos.Event<E> build()
      Builds a new syntax info from the set details.
      Specified by:
      build in interface SyntaxInfo.Builder<B extends BukkitSyntaxInfos.Event.Builder<B,E>,E extends SkriptEvent>
      Returns:
      A syntax info representing the class providing the syntax's implementation.