Package dev.magicmq.pyspigot.bungee.event.custom

Class CustomEvent

java.lang.Object
net.md_5.bungee.api.plugin.Event
dev.magicmq.pyspigot.bungee.event.ScriptEvent
dev.magicmq.pyspigot.bungee.event.custom.CustomEvent
All Implemented Interfaces:
net.md_5.bungee.api.plugin.Cancellable
public class CustomEvent extends ScriptEvent implements net.md_5.bungee.api.plugin.Cancellable
A custom event that scripts may instantiate and call for other plugins/scripts to listen to.

  • Constructor Details

    • CustomEvent

      public CustomEvent(String name, PyObject data)

      Note: This class should be instantiated from scripts only!

      Parameters:
      name - The name of the event being created. Can be used to create subtypes of the generic custom event
      data - The data to attach to the event

  • Method Details

    • getName

      public String getName()
      Get the name of this event.
      Returns:
      The name of this event

    • getData

      public PyObject getData()
      Get the data attached to this event.
      Returns:
      The data attached to this event

    • getDataAsType

      public Object getDataAsType(String clazz)
      Attempt to convert the data attached to this event to a provided type.
      Parameters:
      clazz - The type that the data should be converted to
      Returns:
      An object of the specified type representing the converted data
      Throws:
      PyException - If the data could not be converted to the provided type

    • getDataAsType

      public <T> T getDataAsType(Class<T> clazz)
      Attempt to convert the data attached to this event to a provided type.
      Type Parameters:
      T - The type to which the data should be converted
      Parameters:
      clazz - The type that the data should be converted to
      Returns:
      An object of the specified type representing the converted data
      Throws:
      PyException - If the data could not be converted to the provided type

    • isCancelled

      public boolean isCancelled()
      Specified by:
      isCancelled in interface net.md_5.bungee.api.plugin.Cancellable

    • setCancelled

      public void setCancelled(boolean cancelled)
      Specified by:
      setCancelled in interface net.md_5.bungee.api.plugin.Cancellable