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.
public abstract
Methods
getRuntime ()
Abstract MethodRuntime dependencies to be included in complete archive.
Collection
public abstract
name ()
Abstract MethodThe library name.
String
public abstract
getProperties ()
Abstract MethodReturn any property handlers this library provides.
These are different from regular syntax, since they are compiled directly into the Property Handler expression.
Collection
public abstract
getHandlers (State, LanguageElement, Context)
Abstract MethodAllows 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.
Index | Type | Name |
---|---|---|
1 | State | state |
2 | LanguageElement | element |
3 | Context | context |
Collection
public abstract
generateDocumentation ()
MethodGenerates documentation for all available syntax to be exported to a processor.
Document[]
public
getSyntax ()
Abstract MethodAll syntax elements available in this library, without filtering. This is used by documentation scraping or special lookups to find the source of an error.
SyntaxElement[]
public abstract
getConstructs ()
Abstract MethodAny custom language constructs provided by this library.
LanguageElement[]
public abstract
getTypes ()
Abstract MethodTypes 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.
Type[]
public abstract
getConverters ()
MethodMap
public
getOperators ()
MethodMap
public