Class EvtScriptLoad

java.lang.Object

io.github.syst3ms.skriptparser.lang.event.SkriptEvent

io.github.syst3ms.skriptparser.event.EvtScriptLoad

All Implemented Interfaces:

StartOnLoadEvent, SyntaxElement

public class EvtScriptLoad
extends SkriptEvent
implements StartOnLoadEvent

The script loading event.

Since:

ALPHA

Constructor Summary

Constructors

Constructor	Description
EvtScriptLoad()

Method Summary

Modifier and Type	Method	Description
boolean	check(TriggerContext ctx)	Whether this event should trigger, given the TriggerContext
boolean	init(Expression<?>[] expressions, int matchedPattern, ParseContext parseContext)	Initializes this SyntaxElement before being used.
void	onInitialLoad(Trigger trigger)	Fired when a script is loaded.
String	toString(TriggerContext ctx, boolean debug)

Methods inherited from class SkriptEvent

addTrigger, clearTrigger, getAllowedSyntaxes, getLoadingPriority, getTriggers, isRestrictingExpressions, loadSection

Methods inherited from class Object

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

Constructor Details

EvtScriptLoad

public EvtScriptLoad()

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).

Specified by:

init in interface SyntaxElement

Overrides:

init in class SkriptEvent

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

check

public boolean check(TriggerContext ctx)

Description copied from class: SkriptEvent

Whether this event should trigger, given the TriggerContext

Specified by:

check in class SkriptEvent

Parameters:

ctx - the TriggerContext to check

Returns:

whether the event should trigger

toString

public String toString(TriggerContext ctx,
 boolean debug)

Specified by:

toString in interface SyntaxElement

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

onInitialLoad

public void onInitialLoad(Trigger trigger)

Description copied from interface: StartOnLoadEvent

Fired when a script is loaded.

Specified by:

onInitialLoad in interface StartOnLoadEvent

Parameters:

trigger - The trigger that is fired when the script is loaded