mirror of
https://github.com/BentoBoxWorld/BentoBox.git
synced 2025-02-13 19:01:28 +01:00
Updated some package-info javadocs
This commit is contained in:
parent
55daa72e55
commit
c8dc6188b9
@ -1,12 +1,20 @@
|
||||
/**
|
||||
* This package covers all addon-specific API
|
||||
* <p>
|
||||
* The Addon class and the associated Pladdon are like Bukkit plugins
|
||||
* but contain extra API specific for BentoBox games.
|
||||
* </p>
|
||||
* This package contains classes and interfaces related to BentoBox addons.
|
||||
*
|
||||
* Addons are modular extensions that enhance BentoBox functionality. Game-specific
|
||||
* addons (e.g., BSkyBlock, AcidIsland) as well as generic addons (e.g., Challenges, Warps)
|
||||
* are supported by this system. Developers can create custom addons to introduce
|
||||
* new features or gamemodes.
|
||||
*
|
||||
* Since BentoBox was created, server tech has changed and code remapping is done and that
|
||||
* is usually only applied when a Plugin is loaded, so developers should use Pladdons
|
||||
* which are a wrapper for Addons in a Plugin.
|
||||
*
|
||||
* Key components:
|
||||
* - AddonLoader: Manages the lifecycle of addons.
|
||||
* - AddonConfig: Handles addon-specific configurations.
|
||||
*
|
||||
* @since 1.0
|
||||
* @author tastybento
|
||||
*
|
||||
*/
|
||||
package world.bentobox.bentobox.api.addons;
|
@ -1,7 +1,9 @@
|
||||
/**
|
||||
* API for BentoBox commands
|
||||
*/
|
||||
/**
|
||||
* This package contains classes and handlers for BentoBox commands.
|
||||
*
|
||||
* Commands allow players and administrators to interact with BentoBox, including
|
||||
* managing islands, settings, and other in-game features. This package ensures
|
||||
* smooth integration and execution of commands within the plugin.
|
||||
* <p>
|
||||
* The workhorse class is the abstract class CompositeCommand. It provides all the functionality for
|
||||
* a command including automatic help, sub-commands, convenience methods, etc. See examples of how to use
|
||||
@ -13,6 +15,10 @@
|
||||
* their own custom help if required, but most of the time it is not.
|
||||
* </p>
|
||||
* @author tastybento
|
||||
*
|
||||
*
|
||||
* Key features:
|
||||
* - Command registration and parsing.
|
||||
* - Support for custom addon-specific commands.
|
||||
* - Error handling and permission validation.
|
||||
*/
|
||||
package world.bentobox.bentobox.api.commands;
|
@ -1,4 +1,6 @@
|
||||
/**
|
||||
* Contains API related to configurations.
|
||||
* Provides classes and interfaces for managing configuration settings within the BentoBox API.
|
||||
* This package enables the definition, access, and manipulation of configuration options,
|
||||
* facilitating the customization and extension of BentoBox's functionality.
|
||||
*/
|
||||
package world.bentobox.bentobox.api.configuration;
|
@ -1,7 +1,14 @@
|
||||
/**
|
||||
* API for all the events that BentoBox generates
|
||||
*/
|
||||
/**
|
||||
* This package defines events used within the BentoBox framework.
|
||||
*
|
||||
* Events are triggered during key gameplay actions, such as island creation,
|
||||
* deletion, or player interactions. Developers can use these events to customize
|
||||
* behaviors or respond to actions in their addons.
|
||||
*
|
||||
* Key features:
|
||||
* - Custom event classes (e.g., IslandCreateEvent, PlayerJoinEvent).
|
||||
* - Integration with Bukkit's event system.
|
||||
*
|
||||
* @author tastybento
|
||||
*
|
||||
*/
|
||||
|
10
src/main/java/world/bentobox/bentobox/api/package-info.java
Normal file
10
src/main/java/world/bentobox/bentobox/api/package-info.java
Normal file
@ -0,0 +1,10 @@
|
||||
/**
|
||||
* This package provides the core API for interacting with the BentoBox framework.
|
||||
*
|
||||
* It enables developers to integrate their custom plugins or addons with BentoBox,
|
||||
* offering simplified access to common functionalities like:
|
||||
* - Island management (creation, deletion, permissions).
|
||||
* - Player interactions within island-based games.
|
||||
* - Events and hooks for extending core behavior.
|
||||
*/
|
||||
package world.bentobox.bentobox.api;
|
14
src/main/java/world/bentobox/bentobox/package-info.java
Normal file
14
src/main/java/world/bentobox/bentobox/package-info.java
Normal file
@ -0,0 +1,14 @@
|
||||
/**
|
||||
* The core package for the BentoBox plugin.
|
||||
*
|
||||
* This package provides the foundational framework for island-based games like SkyBlock,
|
||||
* AcidIsland, and others. It manages core plugin features such as the addon system,
|
||||
* configuration, and APIs used by developers to create custom addons or extend
|
||||
* the functionality of BentoBox.
|
||||
*
|
||||
* Key features:
|
||||
* - A modular addon system to mix and match features and game modes.
|
||||
* - Comprehensive APIs for island protection, GUIs, team management, and more.
|
||||
* - Cross-compatibility with various game modes.
|
||||
*/
|
||||
package world.bentobox.bentobox;
|
@ -5,7 +5,13 @@
|
||||
* Look here before you write your own utility function. If it isn't here, but would be useful
|
||||
* the submit a PR so others can avoid duplicating code!
|
||||
* </p>
|
||||
*
|
||||
*
|
||||
* This package provides utility classes and helpers for common tasks within BentoBox.
|
||||
*
|
||||
* These utilities simplify repetitive tasks like file handling, configuration management,
|
||||
* and mathematical calculations. They are used throughout the framework and can be
|
||||
* leveraged by addon developers.
|
||||
*
|
||||
* @author various
|
||||
*
|
||||
*/
|
||||
|
Loading…
Reference in New Issue
Block a user