All Classes and Interfaces
Class
Description
A
CodeSection that can hold information about arguments.An interface describing arithmetic operations between two types
Calculates arc sinus using the Maclaurin series.
The at time-event context.
Provides advanced functions operating on
BigDecimals.A rational number represented as a quotient of two values.
Used to chain converters to build a single converter.
An enum representing how an expression could be changed
An interface for anything that can be changed
An element of a choice group.
A group of multiple choices, represented by ChoiceElements
Utility functions for Class objects
Represents a section of runnable code.
Utility functions for Collection objects
Represents a color, written like #xxxxxx or with an RGB format.
An interface for comparing values of two given types
A class containing information about a
ComparatorA class handling registration and usage of
ComparatorsMultiple
PatternElements put together in order.A very general condition, it simply compares two values.
See if a given list of objects contain a given element.
Check if a given date is a certain duration before or after the current date.
Check if a given number is divisible by another number.
Check if a given string or list is empty.
Check if a given number is a prime number.
Check if a given expression is set (null on the Java side) or not.
Check if the given strings match a certain regex expression.
Check if a given string starts or ends with a certain string.
A base class for all boolean expressions (i.e Expression<Boolean>) that should be treated as
"conditional".
An
Expression that corresponds to a contextual value.A class containing info about a context value.
An enum to indicate the relative position in time between two similar context values.
One can use context values in two different ways:
context-something - the value is used with the common prefix 'context'; or
something - the value is used alone as an expression.
The usage determines which of the two variants, or both, are applicable.Sections implementing this interface are able to be 'continued' using the
EffContinue effect.A continuous tag is a special sort of tag that always has a fixed value.
An expression that has been converted to another type.
Utility functions regarding converters
Calculates cosinus using the Maclaurin series.
A class registering features such as types and comparators at startup.
Represents the documentation for a syntax element
A double-valued version of an
Optional, containing very similar methods.Halts all code and waits for user input in order to continue.
Runs this effect asynchronously.
A very general effect that can change many expressions.
Skips the current looped value and continues to the next one in the list, if it exists.
Runs this effect if a given condition succeeds.
A line of code that is executed before moving on to the next one.
Skips the next given amount of lines and runs the code after.
Exits the entire trigger, preventing all upcoming statements to not get triggered.
Runs the next line of this section if a condition is met.
Prints some text to the console
Returns one or more values to a corresponding section.
Shuts down the whole current sessions.
Waits a certain duration and then executes all the code after this effect.
A type describing an error, mainly used to indicate priority in errors.
This event will trigger each day at a given time.
The periodical event.
The script loading event.
This event will check against a certain condition and will trigger when the condition is met.
Basic list operators that return the following elements:
pop: the last element
shift/poll: the first element
extract: a specific (or just the first/last) element
splice: elements in a certain bound
However, this syntax can also be used as an effect.Replaces certain occurrences in a string with another string and returns those applied strings.
A base class for syntax that can be used as
Expression or Effect.Calculates exp using the Maclaurin series.
The amount of elements in a given list.
Retrieve the last input of the user in a
EffAsk effect.Various arithmetic expressions, including addition, subtraction, multiplication, division and exponentiation.
Miscellaneous math functions taking in two arguments.
Basic boolean operators.
A color specified by its hexadecimal value.
A color specified by its RGB value.
Certain color values of a given color.
The date that was a certain duration ago or is a certain duration in the future.
Formats a date as a string using the given format.
The date from a (unix) timestamp.
Information of a certain date.
The current date, the one from yesterday or the one from tomorrow.
The timestamp of a date.
Today at a given time.
A shorthand expression for giving things a default value.
The difference between two values.
Compares the given date with the current date.
A certain element or multiple elements out of a list of objects.
An expression, i.e a
SyntaxElement representing a value with some type.A variable/expression, declared in syntax using %type%
Has :
a
List of PatternType
a field determining what type of values this expression accepts : literals, expressions or both (%*type%, %~type% and %type% respectively)
a flag determining whether the expression resorts to default expressions or not, defaulting to null instead
a flag determining whether the expression accepts condition expressions or not
A class containing info about an
Expression syntaxA list of expressions
Length of a string.
The currently looped value.
Reverse, shuffle or order a given list.
Convert a number to a different base (like binary, octal or hexadecimal) or convert a string to its decimal form.
The object parsed as a given type.
Generate a random number (double) or integer.
Returns a range of values between two endpoints.
Converts a given string into a certain case type.
The character at a given position in a string.
All uppercase, lowercase, or digit characters in a string.
The index of the first or last occurrence of a given string in a string.
Joins multiple strings together using a delimiter,
splits a given string using a delimiter,
or splits that string in multiple string of a certain length.
Extracts a part of the string.
Returns a value depending of a boolean.
Miscellaneous math functions taking in a single argument
All indices of a given list variable.
A wrapper that turns a condition into a boolean expression than can be used anywhere.
Represents any non-blank and not comment-only line in a file.
A class for parsing a plaintext file into a list of
FileElements representing every line.A class describing a section of a script inside a file (e.g a line ending with a colon and containing all the lines that
were indented after it.
Utility functions for file parsing
CodeSections implementing this interface need to be 'finished' by convention.
A Comparator that is the opposite of another one
An expression whose value is known at parse time
A list of literals, whose values are known at parse time
The name of the current executed script, without the extension.
Midnight and noon time constants and the ability to use
expressions like
12 o' clock for literal usage.An entry in Skript's log.
An enum describing what a log message can be : an info, a warning, an error or a debug message.
An object that provides contextual information during syntax matching.
A simple implementation of a Multimap, emulating Guava's.
Utilities for various math operations using the generic
Number type
I do not claim ownership of this code, it is the intellectual property of @obermuhlner.Utility functions for numbers that don't have to do with math.
A group containing an optional
PatternElement, that can be omittedA simple pair of two values.
An object that stores data about how an object was parsed.
An object that stores data about the current parsing, on the scale of the entire trigger.
The superclass of all elements of a pattern.
An object used to retrieve depending on which pattern was matched
A class for parsing syntaxes in string form into parser-usable objects
A type used in a pattern.
The periodical context.
Iterator over the powers of a value x.
PowerIterator to calculate xn.PowerIterator to calculate x2*n.PowerIterator to calculate x2*n+1.This class can be used for an easier writing of conditions that contain only one type in the pattern
and are in one of the following forms:
something is something
something can something
something has something
The plural and negated forms are also supported.A base class for expressions that contain general properties.
Information about a range function
A class handling registration of ranges
A simple list that is only meant to keep track of which syntaxes are used frequently, in order to preemptively check
them against a string that's being parsed.
A group containing a regex in the form of a
Pattern.A relation between two objects
An expression that can only be used in select CodeSections.
An
ArgumentSection that can hold information about valued returned by the code inside it (typically through
EffReturn).The script loading context, which corresponds to running code inside
public static void main(String[] args)
in Java.Contains the logic for loading, parsing, and interpreting entire script files
Executes the code in the section asynchronously, meaning in another thread.
This section is written underneath the
switch section to match the given expression.A condition that randomly succeeds or fails, given the chance for it to do succeed.
This is the general control flow section which evaluates conditions and executes code
if they succeed.
This section filters the given input values one by one, deciding whether to keep each argument
or not by the returned boolean.
This section maps the returned value(s) to the values of a given expression, one by one.
This section iterates over all the values of the given expression, one by one.
This section maps the returned value to the values of a given expression, one by one.
Basic switch control statement.
The SectionConfiguration class can be used to create simple and efficient data sections
that only allow specific keys and values.
An expression that is tied to a given
ArgumentSection, and acts as a way to retrieve
the arguments passed through an Expression.This section will keep executing the statements inside until the given condition
does not hold anymore.
Statements implementing this interface are by convention returning themselves as the next statement
in
Statement.getNext().A serialized value of a variable.
Utility class to calculate taylor series efficiently until the maximum error (as defined by the precision in the
MathContext is reached.A simple expression with a fixed function to retrieve its values
A simple literal with a fixed set of values
Calculates sinus using the Maclaurin series.
The
SkriptAddon representing Skript itselfThe base for all addons, modules that hook into the API to register syntax and handle triggers.
The entry point for all code in Skript.
A class containing info about an
event syntaxAn object through which Skript can keep track of errors, warnings and other useful information to the one that writes
Skript code.
An exception thrown whenever something goes wrong at parse time.
A mutable object keeping track of all syntax and types registered by an
addon
Do not forget to call SkriptRegistration.register() !An exception thrown when something goes wrong at runtime
Represents an event that initially fires when the script is loaded.
The base class for any runnable line of code inside of a script.
Utility functions for strings
The base class for all elements that are described by a syntax
Contains the logic for parsing and interpreting single statements, sections and expressions inside of a script.
Tags are elements one can use inside of strings to change parts of that string easily.
Applies lowercase or uppercase to the affected string.
A tagged expression is a string expression that contains tags.
A class containing info about a
Tag.A tag that resets all currently ongoing tags.
Adds special characters to the string.
Text inside of a pattern.
Represents a time, as one could see on a clock.
A top-level section, that is not contained in code.
A context under which a trigger may be run.
A basic definition of a type.
Manages the registration and usage of
TypeAn interface for serializing type objects.
A
trigger-to-be whose contents haven't been loaded yet.A reference to a variable, whose value is only known at runtime.
A class handling operations on variables.
A variable storage is holds the means and methods of storing variables.
A string that possibly contains expressions inside it, meaning that its value may be unknown at parse time
A
FileElement representing a blank line.The when-event context.