Package ch.njol.skript.lang

Class SelfRegisteringSkriptEvent

java.lang.Object
org.skriptlang.skript.lang.structure.Structure
ch.njol.skript.lang.SkriptEvent
ch.njol.skript.lang.SelfRegisteringSkriptEvent
All Implemented Interfaces:
Debuggable, SyntaxElement
@Deprecated(since="2.7.0", forRemoval=true) public abstract class SelfRegisteringSkriptEvent extends SkriptEvent
Deprecated, for removal: This API element is subject to removal in a future version.
Regular Structure methods should be used. See individual methods for their equivalents.

  • Constructor Details

    • SelfRegisteringSkriptEvent

      public SelfRegisteringSkriptEvent()
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • register

      @Deprecated(since="2.10.0", forRemoval=true) public abstract void register(Trigger t)
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method's functionality can be replaced by overriding postLoad(). Normally, that method would register the parsed trigger with SkriptEventHandler. A reference to the Trigger is available through SkriptEvent.trigger.
      This method is called after the whole trigger is loaded for events that fire themselves.
      Parameters:
      t - the trigger to register to this event

    • unregister

      @Deprecated(since="2.10.0", forRemoval=true) public abstract void unregister(Trigger t)
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method's functionality can be replaced by overriding unload(). Normally, that method would unregister the parsed trigger with SkriptEventHandler. A reference to the Trigger is available through SkriptEvent.trigger.
      This method is called to unregister this event registered through register(Trigger).
      Parameters:
      t - the same trigger which was registered for this event

    • unregisterAll

      @Deprecated(since="2.10.0", forRemoval=true) public abstract void unregisterAll()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method should no longer be used. Each trigger should be unregistered through unregister(Trigger).
      This method is called to unregister all events registered through register(Trigger). This is called on all registered events, thus it can also only unregister the event it is called on.

    • load

      public boolean load()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from class: SkriptEvent
      This method handles the loading of the Structure's syntax elements. Only override this method if you know what you are doing!
      Overrides:
      load in class SkriptEvent
      Returns:
      Whether loading was successful. An error should be printed prior to returning false to specify the cause.

    • postLoad

      public boolean postLoad()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from class: SkriptEvent
      This method handles the registration of this event with Skript and Bukkit. Only override this method if you know what you are doing!
      Overrides:
      postLoad in class SkriptEvent
      Returns:
      Whether postLoading was successful. An error should be printed prior to returning false to specify the cause.

    • unload

      public void unload()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from class: SkriptEvent
      This method handles the unregistration of this event with Skript and Bukkit. Only override this method if you know what you are doing!
      Overrides:
      unload in class SkriptEvent

    • check

      public final boolean check(org.bukkit.event.Event e)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from class: SkriptEvent
      Checks whether the given Event applies, e.g. the left-click event is only part of the PlayerInteractEvent, and this checks whether the player left-clicked or not. This method will only be called for events this SkriptEvent is registered for.
      Specified by:
      check in class SkriptEvent
      Returns:
      true if this is SkriptEvent is represented by the Bukkit Event or false if not

    • afterParse

      @Deprecated(since="2.7.0", forRemoval=true) public void afterParse(Config config)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use postLoad() instead.
      This method is called when this event is parsed. Overriding this is optional, and usually not needed.
      Parameters:
      config - Script that is being parsed

    • isEventPrioritySupported

      public boolean isEventPrioritySupported()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      isEventPrioritySupported in class SkriptEvent
      Returns:
      whether this SkriptEvent supports event priorities