Package net.gcnt.additionsplus.api.objects

Interface AdditionsEvent

public interface AdditionsEvent
Custom AdditionsPlus events class. This class can be called when firing a certain event to execute its actions.

  • Method Details

    • getAuthor

      String getAuthor()
      Get the author of this event.
      Returns:
      Author of this event.

    • getDescription

      String getDescription()
      Get the event description.
      Returns:
      Description of this event.

    • getPluginName

      String getPluginName()
      Get the plugin name of this event.
      Returns:
      Plugin name of this event.

    • getEventName

      String getEventName()
      Get the name of this event.
      Returns:
      Get the name of this event.

    • addPlaceholder

      AdditionsEvent addPlaceholder(String search, String replace)
      Add a placeholder to the replacement list.
      Parameters:
      search - String to search for.
      replace - String to replace with.
      Returns:
      Current AdditionsEvent instance.

    • removePlaceholder

      AdditionsEvent removePlaceholder(String key)
      Remove a placeholder from the replacement list.
      Parameters:
      key - Placeholder key to remove.
      Returns:
      Current AdditionsEvent instance.

    • loadData

      void loadData()
      Load the data of this event.

    • getIdentifier

      String getIdentifier()
      Get the identifier of this event.
      Returns:
      Identifier of this event.

    • getExtraOptions

      HashMap<String,Object> getExtraOptions()
      Get a HashMap of all extra options and their Object values.
      Returns:
      HashMap of options and their Object values

    • getExtraOption

      Object getExtraOption(String key)
      Get the value of any extra option.
      Parameters:
      key - Key to search for.
      Returns:
      Object value of the key when found, null otherwise.

    • perform

      void perform(AdditionsPlugin plugin, org.bukkit.entity.Player player)
      Perform the event.
      Parameters:
      plugin - Main AdditionsPlugin class to execute the event from.
      player - Player to execute the event for.