Library

Interface

A library that provides syntax or runtime dependencies to the Skript implementation.

Most implementations should use ModifiableLibrary instead

  • it is both safer and easier to use.

The library tells the Skript runtime what syntax is available.

Modifiers

public abstract

Methods


getRuntime ()

Abstract Method

Runtime dependencies to be included in complete archive.

Return Type

Collection

Modifiers

public abstract

name ()

Abstract Method

The library name.

Return Type

String

Modifiers

public abstract

getProperties ()

Abstract Method

Return any property handlers this library provides.

These are different from regular syntax, since they are compiled directly into the Property Handler expression.

Return Type

Collection

Modifiers

public abstract

getHandlers (State, LanguageElement, Context)

Abstract Method

Allows the library to filter syntax by the current context.

This is designed to make matching faster, since the library knows how to exclude clearly-incorrect syntax from being checked for a match.

The version in ModifiableLibrary is recommended, but libraries may implement a faster version.

IndexTypeName
1Statestate
2LanguageElementelement
3Contextcontext
Return Type

Collection

Modifiers

public abstract

generateDocumentation ()

Method

Generates documentation for all available syntax to be exported to a processor.

Return Type

Document[]

Modifiers

public

getSyntax ()

Abstract Method

All syntax elements available in this library, without filtering. This is used by documentation scraping or special lookups to find the source of an error.

Return Type

SyntaxElement[]

Modifiers

public abstract

getConstructs ()

Abstract Method

Any custom language constructs provided by this library.

Return Type

LanguageElement[]

Modifiers

public abstract

getTypes ()

Abstract Method

Types provided by this library.

These types can be written with their simple name in scripts, as can be done with String and Number by default, rather than needing the full a/b/c/Type path.

Return Type

Type[]

Modifiers

public abstract

getConverters ()

Method
No description is available for this element.
Return Type

Map

Modifiers

public

getOperators ()

Method
No description is available for this element.
Return Type

Map

Modifiers

public