Class Trigger

java.lang.Object

io.github.syst3ms.skriptparser.lang.Statement

io.github.syst3ms.skriptparser.lang.CodeSection

io.github.syst3ms.skriptparser.lang.Trigger

All Implemented Interfaces:

SyntaxElement

public class Trigger
extends CodeSection

A top-level section, that is not contained in code. Usually declares an event.

Field Summary

Fields inherited from class CodeSection

first, items, last

Fields inherited from class Statement

next, parent

Constructor Summary

Constructors

Constructor	Description
Trigger(SkriptEvent event)

Method Summary

Modifier and Type	Method	Description
SkriptEvent	getEvent()
boolean	init(Expression<?>[] expressions, int matchedPattern, ParseContext parseContext)	Initializes this SyntaxElement before being used.
boolean	loadSection(FileSection section, ParserState parserState, SkriptLogger logger)	This methods determines the logic of what is being done to the elements inside of this section.
String	toString(TriggerContext ctx, boolean debug)
Optional<? extends Statement>	walk(TriggerContext ctx)	By default, runs Statement.run(TriggerContext) ; returns Statement.getNext() if it returns true, or null otherwise.

Methods inherited from class CodeSection

checkFinishing, checkFinishing, checkReturns, getAllowedSyntaxes, getFirst, getItems, getLast, isRestrictingExpressions, run, setItems

Methods inherited from class Statement

getNext, getParent, runAll, setNext, setParent

Methods inherited from class Object

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

Constructor Details

Trigger

public Trigger(SkriptEvent event)

Method Details

init

public boolean init(Expression<?>[] expressions,
 int matchedPattern,
 ParseContext parseContext)

Description copied from interface: SyntaxElement

Initializes this SyntaxElement before being used. This method is always called before all the others in an extending class, the only exception being CodeSection.loadSection(FileSection, ParserState, SkriptLogger).

Parameters:

expressions - an array of expressions representing all the expressions that are being passed to this syntax element. As opposed to Skript, elements of this array can't be null.

matchedPattern - the index of the pattern that was successfully matched. It corresponds to the order of the syntaxes in registration

parseContext - an object containing additional information about the parsing of this syntax element, like regex matches and parse marks

Returns:

true if the syntax element was initialized successfully, false otherwise.

See Also:

• SkriptRegistration
• ParseContext

loadSection

public boolean loadSection(FileSection section,
 ParserState parserState,
 SkriptLogger logger)

Description copied from class: CodeSection

This methods determines the logic of what is being done to the elements inside of this section. By default, this simply parses all items inside it, but this can be overridden. In case an extending class just needs to do some additional operations on top of what the default implementation already does, then call super.loadSection(section) before any such operations.

Overrides:

loadSection in class CodeSection

Parameters:

section - the FileSection representing this CodeSection

logger - the logger

Returns:

true if the items inside of the section were loaded properly, false if there was a problem

walk

public Optional<? extends Statement> walk(TriggerContext ctx)

Description copied from class: Statement

By default, runs Statement.run(TriggerContext) ; returns Statement.getNext() if it returns true, or null otherwise. Note that if this method is overridden, then the implementation of Statement.run(TriggerContext) doesn't matter.

Specified by:

walk in class CodeSection

Parameters:

ctx - the event

Returns:

the next item to be ran, or null if this is the last item to be executed

toString

public String toString(TriggerContext ctx,
 boolean debug)

Parameters:

ctx - the event

debug - whether to show additional information or not

Returns:

a String that should aim to resemble what is written in the script as closely as possible

getEvent

public SkriptEvent getEvent()