Interface AdditionsAPI

Method Details

• getPlugin

  AdditionsPlugin getPlugin()

  Get the AdditionsPlugin main class.

  Returns:

  AdditionsPlugin main class.

• performActions

  void performActions(ActionSender sender, List<String> actions)

  Perform a list of actions for a specific sender.

  Parameters:

  sender - ActionSender who is the executor of the actions.

  actions - List of action strings to be executed.

• loadFiles

  void loadFiles()

  Load all AdditionsPlus data files.

• createCustomAction

  AdditionsAction createCustomAction(org.bukkit.plugin.Plugin plugin, String identifier, ActionType type, Consumer<QueuedAction> consumer)

  Create a new custom action. Please note that this purely creates the action object and does NOT register it.

  Parameters:

  plugin - JavaPlugin plugin

  identifier - Identifier of the action (must be unique).

  type - ActionType of the action.

  consumer - Consumer that is executed when the action is called.

  Returns:

  AdditionsAction with the entered data.

• createCustomAction

  AdditionsAction createCustomAction(org.bukkit.plugin.Plugin plugin, String identifier, ActionType type, Consumer<QueuedAction> consumer, boolean playersOnly, String... aliases)

  Create a new custom action. Please note that this purely creates the action object and does NOT register it.

  Parameters:

  plugin - JavaPlugin plugin

  identifier - Identifier of the action (must be unique).

  type - ActionType of the action.

  consumer - Consumer that is executed when the action is called.

  playersOnly - Whether only players can perform this action.

  aliases - Optional list of aliases for this action.

  Returns:

  AdditionsAction with the entered data.

• createCustomEvent

  AdditionsEvent createCustomEvent(AdditionsPlugin plugin, String pluginName, String eventName, String author, String description)

  Create a new custom event. Please note that this purely creates the event object and does NOT register it. The event identifier would be: : (all lowercase).

  Parameters:

  plugin - Main AdditionsPlus class.

  pluginName - Name of your plugin.

  eventName - Name of your event.

  author - Author of the event.

  description - Description of the event.

  Returns:

  AdditionsEvent with the entered data.

• registerCustomEvent

  boolean registerCustomEvent(AdditionsEvent event)

  Register a custom event.

  Parameters:

  event - AdditionsEvent instance to register.

  Returns:

  true when succeeded, false otherwise.

• registerCustomAction

  boolean registerCustomAction(AdditionsAction action)

  Register a custom action.

  Parameters:

  action - AdditionsAction instance to register.

  Returns:

  true when succeeded, false otherwise.

• getCustomActions

  List<AdditionsAction> getCustomActions()

  Get a List of AdditionsAction that were registered.

  Returns:

  A List of AdditionsAction.

• isCustomActionRegistered

  boolean isCustomActionRegistered(String identifier)

  Check if there is an action registered with the given identifier.

  Parameters:

  identifier - Identifier to look up.

  Returns:

  True when found, false otherwise.

• getUtils

  AdditionsUtils getUtils()

  Get the general AdditionsUtils.

  Returns:

  The general AdditionsUtils.

• getCommands

  List<AdditionsCommand> getCommands()

  Get a List of AdditionsCommand that were registered.

  Returns:

  A List of AdditionsCommand.

• getCommandByName

  AdditionsCommand getCommandByName(String name)

  Get a custom AdditionsCommand that matches the given name.

  Parameters:

  name - Name of the command.

  Returns:

  AdditionsCommand when found, null otherwise.

• getCommandByAlias

  AdditionsCommand getCommandByAlias(String alias)

  Get a custom AdditionsCommand that matches the given alias.

  Parameters:

  alias - Command alias to look up.

  Returns:

  AdditionsCommand when found, null otherwise.

• getActionSender

  ActionSender getActionSender(org.bukkit.command.CommandSender sender)

  Get an ActionSender wrapper class object for the given sender.

  Parameters:

  sender - Console sender / player.

  Returns:

  ActionSender with the given sender data.

• getSimilarCommands

  List<AdditionsCommand> getSimilarCommands(String name)

  Get a List of similar AdditionsCommand that match the given command name. Checks for custom command with the same command name (first word).

  Parameters:

  name - Name of the command.

  Returns:

  A List of similar AdditionsCommand.

• getCustomItems

  List<AdditionsItem> getCustomItems()

  Get a List of AdditionsItem that were registered.

  Returns:

  A List of AdditionsItem.

• getItemFromFile

  AdditionsItem getItemFromFile(YAMLSection configSection, String itemIdentifier)

  Get an AdditionsItem from a YAMLSection.

  Parameters:

  configSection - Section to get the item from.

  itemIdentifier - Identifier of the item.

  Returns:

  AdditionsItem when available, null otherwise.

• getConfig

  AdditionsConfig getConfig()

  Get the current config.yml file.

  Returns:

  Current config.yml file.

• setConfig

  void setConfig(AdditionsConfig config)

  Set current config.yml instance.

  Parameters:

  config - New AdditionsConfig to use.

• getEvents

  List<AdditionsEvent> getEvents()

  Get a List of AdditionsEvent that were registered.

  Returns:

  A List of AdditionsEvent.

• getEventById

  AdditionsEvent getEventById(String name)

  Get a registered AdditionsEvent by its identifier.

  Parameters:

  name - Identifier of the event.

  Returns:

  AdditionsEvent when found, null otherwise.

• getIntervalActions

  List<AdditionsInterval> getIntervalActions()

  Get a List of AdditionsInterval that were registered.

  Returns:

  A List of AdditionsInterval.

• getIntervalActionByName

  AdditionsInterval getIntervalActionByName(String name)

  Get an AdditionsInterval by its identifier.

  Parameters:

  name - Identifier of the interval.

  Returns:

  AdditionsInterval when found, null otherwise.

• getBooks

  List<AdditionsBook> getBooks()

  Get a List of AdditionsBook that were registered.

  Returns:

  A List of AdditionsBook.

• getBookByName

  AdditionsBook getBookByName(String name)

  Get a custom AdditionsBook by its identifier.

  Parameters:

  name - Identifier of the book.

  Returns:

  AdditionsBook when found, null otherwise.

• getSigns

  List<AdditionsSign> getSigns()

  Get a List of AdditionsSign that were registered.

  Returns:

  A List of AdditionsSign.

• getSignByName

  AdditionsSign getSignByName(String name)

  Get a custom AdditionsSign by its identifier.

  Parameters:

  name - Identifier of the sign.

  Returns:

  AdditionsSign when found, null otherwise.

• getSignByLocation

  AdditionsSign getSignByLocation(org.bukkit.Location location)

  Get a custom AdditionsSign by its location.

  Parameters:

  location - Location of the sign.

  Returns:

  AdditionsSign when found, null otherwise.

• getNMS

  NMS getNMS()

  Get the NMS manager used for version-specific code.

  Returns:

  NMS manager.

• getItems

  List<AdditionsItem> getItems()

  Get a List of AdditionsItem that were registered.

  Returns:

  a List of AdditionsItem.

• getItemByName

  AdditionsItem getItemByName(String name)

  Get a custom AdditionsItem by its identifier.

  Parameters:

  name - Identifier of the item.

  Returns:

  AdditionsItem when found, null otherwise.

• getMenus

  List<AdditionsMenu> getMenus()

  Get a List of AdditionsMenu that were registered.

  Returns:

  a List of AdditionsMenu.

• getMenuByName

  AdditionsMenu getMenuByName(String name)

  Get a custom AdditionsMenu by its identifier.

  Parameters:

  name - Identifier of the menu.

  Returns:

  An AdditionsMenu when found, null otherwise.

• getNameTags

  List<AdditionsNameTag> getNameTags()

  Get a List of AdditionsNameTag that were registered.

  Returns:

  A List of AdditionsNameTag.

• getNameTagByGroup

  AdditionsNameTag getNameTagByGroup(String group)

  Get an AdditionsNameTag by its group name.

  Parameters:

  group - Group name to look up.

  Returns:

  AdditionsNameTag when found, null otherwise.

• getCommandManager

  CommandManager getCommandManager()

  Get the CommandManager used to check and set cooldowns and perform the custom commands.

  Returns:

  The CommandManager.

• getFilesAPI

  AdditionsFileAPI getFilesAPI()

  Get the AdditionsFileAPI that contains every data file and its data.

  Returns:

  The AdditionsFileAPI.

• getSortedTablist

  @Deprecated org.bukkit.scoreboard.Scoreboard getSortedTablist()

  Deprecated.

  Get the sorted scoreboard used for tablists.

  Returns:

  Sorted tablist Scoreboard.

• getAnimationManager

  AnimationManager getAnimationManager()

  Get the AnimationManager that allows you to register animations.

  Returns:

  The AnimationManager.

  Since:

  1.0.3