Package org.skriptlang.skript.registration

Interface SyntaxOrigin

All Known Implementing Classes:
SyntaxOrigin.AddonOrigin
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface @Experimental public interface SyntaxOrigin
The origin of a syntax, currently only used for documentation purposes.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    SyntaxOrigin.AddonOrigin
    A basic origin describing the addon a syntax has originated from.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    name()
     
    static SyntaxOrigin
    of(SkriptAddon addon)
    Constructs a syntax origin from an addon.

  • Method Details

    • of

      @Contract("_ -> new") static SyntaxOrigin of(SkriptAddon addon)
      Constructs a syntax origin from an addon.
      Parameters:
      addon - The addon to construct this origin from.
      Returns:
      An origin pointing to the provided addon.

    • name

      String name()
      Returns:
      A string representing this origin.