Class SecCase

java.lang.Object

io.github.syst3ms.skriptparser.lang.Statement

io.github.syst3ms.skriptparser.lang.CodeSection

io.github.syst3ms.skriptparser.sections.SecCase

All Implemented Interfaces:

SyntaxElement

public class SecCase
extends CodeSection

This section is written underneath the switch section to match the given expression. The content of this section will only be executed if it matches the given expression. One may use 'or'-lists to match multiple expressions at once. The default part can be used to provide actions when no match was found. Note that you can only use one default statement.

Since:

ALPHA

See Also:

• SecSwitch

Field Summary

Fields inherited from class CodeSection

first, items, last

Fields inherited from class Statement

next, parent

Constructor Summary

Constructors

Constructor	Description
SecCase()

Method Summary

Modifier and Type	Method	Description
boolean	init(Expression<?>[] expressions, int matchedPattern, ParseContext parseContext)	Initializes this SyntaxElement before being used.
Statement	setNext(@Nullable Statement next)	Sets the Statement that is placed after this Statement in the file.
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, loadSection, run, setItems

Methods inherited from class Statement

getNext, getParent, runAll, setParent

Methods inherited from class Object

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

Constructor Details

SecCase

public SecCase()

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

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

setNext

public Statement setNext(@Nullable
 @Nullable Statement next)

Description copied from class: Statement

Sets the Statement that is placed after this Statement in the file. You can assume that the Statement.next statement of the next parameter is known if it has such a statement.

Overrides:

setNext in class Statement

Parameters:

next - the Statement that is following this one

Returns:

this statement

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