Class SkriptRegistration.StructureRegistrar<T extends Structure>

java.lang.Object

io.github.syst3ms.skriptparser.registration.SkriptRegistration.SyntaxRegistrar<T>

io.github.syst3ms.skriptparser.registration.SkriptRegistration.StructureRegistrar<T>

All Implemented Interfaces:

SkriptRegistration.Registrar

Enclosing class:

SkriptRegistration

public class SkriptRegistration.StructureRegistrar<T extends Structure>
extends SkriptRegistration.SyntaxRegistrar<T>

Field Summary

Fields inherited from class SkriptRegistration.SyntaxRegistrar

c, data, patterns, priority

Method Summary

Modifier and Type	Method	Description
final SkriptRegistration.StructureRegistrar<T>	description(String... description)	The description of this structure for documentation.
final SkriptRegistration.StructureRegistrar<T>	examples(String... examples)	Examples of this structure for documentation.
final SkriptRegistration.StructureRegistrar<T>	experimental()	Mark this structure as experimental for documentation.
final SkriptRegistration.StructureRegistrar<T>	experimental(String message)	Mark this structure as experimental with a custom message for documentation.
final SkriptRegistration.StructureRegistrar<T>	name(String name)	The name of this structure for documentation.
final SkriptRegistration.StructureRegistrar<T>	noDoc()	Prevent documentation generation for this structure.
void	register()	Adds this structure to the list of currently registered syntaxes
final SkriptRegistration.StructureRegistrar<T>	setHandledContexts(Class<? extends TriggerContext>... contexts)	Set the contexts this structure can handle
final SkriptRegistration.StructureRegistrar<T>	since(String since)	The version this was added in for documentation.

Methods inherited from class SkriptRegistration.SyntaxRegistrar

addData, addPatterns, parsePatterns, setPriority

Methods inherited from class Object

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

Method Details

setHandledContexts

@SafeVarargs
public final SkriptRegistration.StructureRegistrar<T> setHandledContexts(Class<? extends TriggerContext>... contexts)

Set the contexts this structure can handle

Parameters:

contexts - the contexts

Returns:

The registrar

noDoc

public final SkriptRegistration.StructureRegistrar<T> noDoc()

Prevent documentation generation for this structure.

Overrides:

noDoc in class SkriptRegistration.SyntaxRegistrar<T extends Structure>

Returns:

The registrar

experimental

public final SkriptRegistration.StructureRegistrar<T> experimental()

Mark this structure as experimental for documentation.

Overrides:

experimental in class SkriptRegistration.SyntaxRegistrar<T extends Structure>

Returns:

The registrar

experimental

public final SkriptRegistration.StructureRegistrar<T> experimental(String message)

Mark this structure as experimental with a custom message for documentation.

Overrides:

experimental in class SkriptRegistration.SyntaxRegistrar<T extends Structure>

Parameters:

message - The custom message

Returns:

The registrar

name

public final SkriptRegistration.StructureRegistrar<T> name(String name)

The name of this structure for documentation.

Overrides:

name in class SkriptRegistration.SyntaxRegistrar<T extends Structure>

Parameters:

name - Name of the structure

Returns:

The registrar

description

public final SkriptRegistration.StructureRegistrar<T> description(String... description)

The description of this structure for documentation.

Overrides:

description in class SkriptRegistration.SyntaxRegistrar<T extends Structure>

Parameters:

description - The description of the structure

Returns:

The registrar

examples

public final SkriptRegistration.StructureRegistrar<T> examples(String... examples)

Examples of this structure for documentation.

Overrides:

examples in class SkriptRegistration.SyntaxRegistrar<T extends Structure>

Parameters:

examples - The examples of the structure

Returns:

The registrar

since

public final SkriptRegistration.StructureRegistrar<T> since(String since)

The version this was added in for documentation.

Overrides:

since in class SkriptRegistration.SyntaxRegistrar<T extends Structure>

Parameters:

since - The version this was added in

Returns:

The registrar

register

public void register()

Adds this structure to the list of currently registered syntaxes