Upstream
/
AreaShop
mirror of https://github.com/NLthijs48/AreaShop.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add README.md files in a couple of packages, closes #128

This commit is contained in:
Thijs Wiefferink 2018-08-12 16:41:03 +02:00
parent 28d03a6a3a
commit 8c47ae9b3c
4 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
AreaShop/src/main/java/me/wiefferink/areashop/commands/README.md Normal file
View File

@ -0,0 +1,7 @@
# Commands
This module contains all AreaShop commands.
* `CommandAreaShop` is extended by all other classes, and implements some general functionality and defines which methods should be implemented.
* Other classes implement specific sub-commands, supply their help messages and tab completion.
* `CommandManager` class in the `managers` package handles incoming commands and dispatches them to the classes in this package.

7
AreaShop/src/main/java/me/wiefferink/areashop/events/README.md Normal file
View File

@ -0,0 +1,7 @@
# Events
This package contains event classes that allow other plugins to listen to events about AreaShop regions.
* `RegionEvent` class represents a generic event.
* `CancellableRegionEvent` represents an event that has a region and can be cancelled.
* `NotifyRegionEvent` represents events that are to inform only, and cannot be cancelled anymore (an `CancellableRegionEvent` would be sent first).

6
AreaShop/src/main/java/me/wiefferink/areashop/features/README.md Normal file
View File

@ -0,0 +1,6 @@
# Features
This package contains classes that represent a certain feature and implement it for all regions.
* `RegionFeature` represents a single feature, for each implementing class one instance is created without an assigned region, to listen for events etc, and an instance per region is created on-demand to handle region specific things.
* More features will be moved from `GeneralRegion` to these kind of classes, to keep all code for a feature together and cleanup `GeneralRegion`.

7
AreaShop/src/main/java/me/wiefferink/areashop/regions/README.md Normal file
View File

@ -0,0 +1,7 @@
# Regions
This package contains the `GeneralRegion` class which represents a region in AreaShop. Such a region is linked to a WorldGuard region and has its own configuration file at `/plugins/AreaShop/regions/<name>.yml`.
The `BuyRegion` and `RentRegion` classes represent buy and rental regions (mutually exclusive) and inherit from `GeneralRegion`.
To group regions there is `RegionGroup`, which allows configuring settings for a lot of regions at once.