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:

Builder<SyntaxInfo.Builder<?,?>,SyntaxInfo<?>>, 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:

• BukkitSyntaxInfos.Event.builder(Class, String)

Nested Class Summary

Nested classes/interfaces inherited from interface org.skriptlang.skript.util.Builder

Builder.Buildable<B extends Builder<B,T>,T>

Method Summary

Modifier and Type	Method	Description
B	addDescription(String description)	Adds a description line to the event's documentation.
B	addDescription(String... description)	Adds lines of description to the event's documentation.
B	addDescription(Collection<String> description)	Adds lines of description to the event's documentation.
B	addEvent(Class<? extends org.bukkit.event.Event> event)	Adds an event to the event's documentation.
B	addEvents(Class<? extends org.bukkit.event.Event>... events)	Adds events to the event's documentation.
B	addEvents(Collection<Class<? extends org.bukkit.event.Event>> events)	Adds events to the event's documentation.
B	addExample(String example)	Adds an example to the event's documentation.
B	addExamples(String... examples)	Adds examples to the event's documentation.
B	addExamples(Collection<String> examples)	Adds examples to the event's documentation.
B	addKeyword(String keyword)	Adds a keyword to the event's documentation.
B	addKeywords(String... keywords)	Adds keywords to the event's documentation.
B	addKeywords(Collection<String> keywords)	Adds keywords to the event's documentation.
B	addRequiredPlugin(String plugin)	Adds a required plugin to event's documentation.
B	addRequiredPlugins(String... plugins)	Adds required plugins to the event's documentation.
B	addRequiredPlugins(Collection<String> plugins)	Adds required plugins to the event's documentation.
BukkitSyntaxInfos.Event<E>	build()	Builds a new syntax info from the set details.
B	clearDescription()	Removes all description lines from the event's documentation.
B	clearEvents()	Removes all events from the event's documentation.
B	clearExamples()	Removes all examples from the event's documentation.
B	clearKeywords()	Removes all keywords from the event's documentation.
B	clearRequiredPlugins()	Removes all required plugins from the event's documentation.
B	documentationId(String documentationId)	Sets the documentation identifier the event's documentation will use.
B	listeningBehavior(SkriptEvent.ListeningBehavior listeningBehavior)	Sets the listening behavior the event will use.
B	since(String since)	Sets the "since" value the event's documentation will use.

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

addPattern, addPatterns, addPatterns, applyTo, clearPatterns, origin, priority, supplier

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:

• BukkitSyntaxInfos.Event.listeningBehavior()

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:

• BukkitSyntaxInfos.Event.since()

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:

• BukkitSyntaxInfos.Event.documentationId()

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:

• BukkitSyntaxInfos.Event.description()

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:

• BukkitSyntaxInfos.Event.description()

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:

• BukkitSyntaxInfos.Event.description()

clearDescription

@Contract("-> this")
B clearDescription()

Removes all description lines from the event's documentation.

Returns:

This builder.

See Also:

• BukkitSyntaxInfos.Event.description()

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:

• BukkitSyntaxInfos.Event.examples()

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:

• BukkitSyntaxInfos.Event.examples()

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:

• BukkitSyntaxInfos.Event.examples()

clearExamples

@Contract("-> this")
B clearExamples()

Removes all examples from the event's documentation.

Returns:

This builder.

See Also:

• BukkitSyntaxInfos.Event.examples()

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:

• BukkitSyntaxInfos.Event.keywords()

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:

• BukkitSyntaxInfos.Event.keywords()

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:

• BukkitSyntaxInfos.Event.keywords()

clearKeywords

@Contract("-> this")
B clearKeywords()

Removes all keywords from the event's documentation.

Returns:

This builder.

See Also:

• BukkitSyntaxInfos.Event.keywords()

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:

• BukkitSyntaxInfos.Event.requiredPlugins()

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:

• BukkitSyntaxInfos.Event.requiredPlugins()

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:

• BukkitSyntaxInfos.Event.requiredPlugins()

clearRequiredPlugins

B clearRequiredPlugins()

Removes all required plugins from the event's documentation.

Returns:

This builder.

See Also:

• BukkitSyntaxInfos.Event.requiredPlugins()

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:

• BukkitSyntaxInfos.Event.events()

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:

• BukkitSyntaxInfos.Event.events()

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:

• BukkitSyntaxInfos.Event.events()

clearEvents

@Contract("-> this")
B clearEvents()

Removes all events from the event's documentation.

Returns:

This builder.

See Also:

• BukkitSyntaxInfos.Event.events()

build

@Contract("-> new")
BukkitSyntaxInfos.Event<E> build()

Builds a new syntax info from the set details.

Specified by:

build in interface Builder<B extends BukkitSyntaxInfos.Event.Builder<B,E>,E extends SkriptEvent>

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.