Upstream/PlotSquared
1
0
Fork 0
mirror of https://github.com/IntellectualSites/PlotSquared.git synced 2024-11-28 12:56:05 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated API Documentation (markdown)

NotMyFault 2020-02-16 17:12:28 +01:00
parent 164921b8c4
commit 5a2eba9c64
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
API-Documentation.md

@ -59,17 +59,17 @@ See: [MainUtil.java](https://github.com/IntellectualSites/PlotSquared/blob/v5/Co
#### Clusters #### Clusters
Clusters can be created within existing plot areas, or they can be created in a previously non-plot world, which will in turn create it's own plot area. Clusters can be created within existing plot areas, or they can be created in a previously non-plot world, which will in turn create it's own plot area.
See: [PlotCluster.java](https://github.com/IntellectualSites/PlotSquared/blob/v4/Core/src/main/java/com/github/intellectualsites/plotsquared/plot/object/PlotCluster.java) See: [PlotCluster.java](https://github.com/IntellectualSites/PlotSquared/blob/v5/Core/src/main/java/com/github/intellectualsites/plotsquared/plot/object/PlotCluster.java)
See: [PlotSquared.java](https://github.com/IntellectualSites/PlotSquared/blob/v4/Core/src/main/java/com/github/intellectualsites/plotsquared/plot/PlotSquared.java(...)) See: [PlotSquared.java](https://github.com/IntellectualSites/PlotSquared/blob/v5/Core/src/main/java/com/github/intellectualsites/plotsquared/plot/PlotSquared.java(...))
#### Road #### Road
A road is what separates each plot, and includes the wall around each plot. Attempting to get a plot at this location will return null. A road is what separates each plot, and includes the wall around each plot. Attempting to get a plot at this location will return null.
See: [Location.java](https://github.com/IntellectualSites/PlotSquared/blob/v4/Core/src/main/java/com/github/intellectualsites/plotsquared/plot/object/Location.java)#isPlotRoad(...) See: [Location.java](https://github.com/IntellectualSites/PlotSquared/blob/v5/Core/src/main/java/com/github/intellectualsites/plotsquared/plot/object/Location.java)#isPlotRoad(...)
#### Plot #### Plot
A plot can be claimed or unclaimed. Getting a plot at a location where one isn't claimed will return a new unowned plot object. A plot can be claimed or unclaimed. Getting a plot at a location where one isn't claimed will return a new unowned plot object.
See: [MainUtil.java](https://github.com/IntellectualSites/PlotSquared/blob/v4/Core/src/main/java/com/github/intellectualsites/plotsquared/plot/util/MainUtil.java)#getPlots(...) See: [MainUtil.java](https://github.com/IntellectualSites/PlotSquared/blob/v5/Core/src/main/java/com/github/intellectualsites/plotsquared/plot/util/MainUtil.java)#getPlots(...)
>If you have made a tutorial, or an addon for PlotSquared, and want us to link it here, please create a ticket. We'd really appreciate it! >If you have made a tutorial, or an addon for PlotSquared, and want us to link it here, please create an issue. We'd really appreciate it!