Class SkriptAddon

java.lang.Object

io.github.syst3ms.skriptparser.registration.SkriptAddon

Direct Known Subclasses:

Skript

public abstract class SkriptAddon
extends Object

The base for all addons, modules that hook into the API to register syntax and handle triggers.

Constructor Summary

Constructors

Constructor	Description
SkriptAddon()

Method Summary

Modifier and Type	Method	Description
final boolean	canHandleEvent(SkriptEvent event)	Checks to see whether the given event has been registered by this SkriptAddon ; a basic way to filter out triggers you aren't able to deal with in invalid reference SkriptAddon#handleTrigger(String,Trigger) .
void	finishedLoading()	Is called when all scripts have finished loading.
void	finishedLoading(@Nullable String scriptName)	Is called when a script has finished loading.
static List<SkriptAddon>	getAddons()	Returns unmodifiable list of all SkriptAddons that are registered globally.

Methods inherited from class Object

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

Constructor Details

SkriptAddon

public SkriptAddon()

Method Details

getAddons

public static List<SkriptAddon> getAddons()

Returns unmodifiable list of all SkriptAddons that are registered globally.

Returns:

SkriptAddons that are registered.

finishedLoading

public void finishedLoading(@Nullable
 @Nullable String scriptName)

Is called when a script has finished loading. Optionally overridable.

finishedLoading

public void finishedLoading()

Is called when all scripts have finished loading. Optionally overridable.

canHandleEvent

public final boolean canHandleEvent(SkriptEvent event)

Checks to see whether the given event has been registered by this SkriptAddon ; a basic way to filter out triggers you aren't able to deal with in

invalid reference

SkriptAddon#handleTrigger(String,Trigger)

. A simple example of application can be found in

invalid reference

Skript#handleTrigger(Trigger)

.

Parameters:

event - the event to check

Returns:

whether the event can be handled by the addon or not

See Also:

• invalid reference

  Skript#handleTrigger(Trigger)