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 Details

    • SkriptAddon

      public SkriptAddon(String name)

  • Method Details

    • getAddons

      @NotNull public static @NotNull List<SkriptAddon> getAddons()
      Returns an unmodifiable list of all SkriptAddons that are registered globally.
      Returns:
      SkriptAddons that are registered.

    • getAddon

      @Nullable public static @Nullable SkriptAddon getAddon(String name)
      Get a SkriptAddon by its name.
      Parameters:
      name - Name of addon to get
      Returns:
      SkriptAddon with the given name, or null if not found

    • getAddonName

      public final String getAddonName()

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

    • getSkriptRegistration

      public abstract SkriptRegistration getSkriptRegistration()
      Get the SkriptRegistration linked to this addon.
      Returns:
      SkriptRegistration linked to this addon

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