EpicKnarvik97/PlotSquared
EpicKnarvik97/PlotSquared
1
0
Fork 0
mirror of https://github.com/IntellectualSites/PlotSquared.git synced 2024-11-23 13:46:45 +01:00
Code Issues Projects Releases Wiki Activity
8e6608d613
PlotSquared/doc/com/intellectualcrafters/plot/api/PlotAPI.html

1342 lines
56 KiB
HTML
Raw Normal View History

Moved folder
2014-11-16 11:14:40 +01:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="sv">
<head>
<!-- Generated by javadoc (version 1.7.0_67) on Sun Nov 16 11:09:55 CET 2014 -->
<title>PlotAPI</title>
<meta name="date" content="2014-11-16">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title = "PlotAPI";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/intellectualcrafters/plot/api/PlotAPI.html" target="_top">Frames</a>
</li>
<li><a href="PlotAPI.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if (window == top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.intellectualcrafters.plot.api</div>
<h2 title="Class PlotAPI" class="title">Class PlotAPI</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.intellectualcrafters.plot.api.PlotAPI</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">PlotAPI</span>
extends java.lang.Object</pre>
<div class="block">The plotMain api class.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0"
summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#ADMIN_PERMISSION">ADMIN_PERMISSION</a></strong></code>
<div class="block">Admin Permission</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0"
summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a
href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#PlotAPI(org.bukkit.plugin.java.JavaPlugin)">PlotAPI</a></strong>(org.bukkit.plugin.java.JavaPlugin&nbsp;plugin)</code>
<div class="block">Constructor.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0"
summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#addFlag(com.intellectualcrafters.plot.flag.AbstractFlag)">addFlag</a></strong>(<a
href="../../../../com/intellectualcrafters/plot/flag/AbstractFlag.html"
title="class in com.intellectualcrafters.plot.flag">AbstractFlag</a>&nbsp;flag)</code>
<div class="block">Register a flag for use in plots</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#addPlotWorld(java.lang.String,%20com.intellectualcrafters.plot.object.PlotWorld,%20com.intellectualcrafters.plot.object.PlotManager)">addPlotWorld</a></strong>(java.lang.String&nbsp;world,
<a href="../../../../com/intellectualcrafters/plot/object/PlotWorld.html"
title="class in com.intellectualcrafters.plot.object">PlotWorld</a>&nbsp;plotWorld,
<a href="../../../../com/intellectualcrafters/plot/object/PlotManager.html"
title="class in com.intellectualcrafters.plot.object">PlotManager</a>&nbsp;manager)</code>
<div class="block">Add a plotoworld</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#getAllowedPlots(org.bukkit.entity.Player)">getAllowedPlots</a></strong>(org.bukkit.entity.Player&nbsp;player)</code>
<div class="block">Get the allowed plot count for a player</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Set&lt;<a href="../../../../com/intellectualcrafters/plot/object/Plot.html"
title="class in com.intellectualcrafters.plot.object">Plot</a>&gt;
</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#getAllPlots()">getAllPlots</a></strong>()</code>
<div class="block">Get all plots</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>org.bukkit.Location</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#getBottomLocation(com.intellectualcrafters.plot.object.Plot)">getBottomLocation</a></strong>(<a
href="../../../../com/intellectualcrafters/plot/object/Plot.html"
title="class in com.intellectualcrafters.plot.object">Plot</a>&nbsp;p)</code>
<div class="block">Get Bottom Location</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/intellectualcrafters/plot/config/C.html"
title="enum in com.intellectualcrafters.plot.config">C</a></code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#getCaptions()">getCaptions</a></strong>()</code>
<div class="block">C class contains all the captions from the translations.yml file.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>org.bukkit.configuration.file.YamlConfiguration</code></td>
<td class="colLast"><code><strong><a href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#getConfig()">getConfig</a></strong>()</code>&nbsp;
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/intellectualcrafters/plot/flag/FlagManager.html"
title="class in com.intellectualcrafters.plot.flag">FlagManager</a></code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#getFlagManager()">getFlagManager</a></strong>()</code>
<div class="block">FlagManager class contains methods relating to plot flags</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/intellectualcrafters/plot/flag/AbstractFlag.html"
title="class in com.intellectualcrafters.plot.flag">AbstractFlag</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#getFlags()">getFlags</a></strong>()</code>
<div class="block">get all the currently registered flags</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>org.bukkit.Location</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#getHomeLocation(com.intellectualcrafters.plot.object.Plot)">getHomeLocation</a></strong>(<a
href="../../../../com/intellectualcrafters/plot/object/Plot.html"
title="class in com.intellectualcrafters.plot.object">Plot</a>&nbsp;p)</code>
<div class="block">Get home location</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>org.bukkit.Location[]</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#getLocations(com.intellectualcrafters.plot.object.Plot)">getLocations</a></strong>(<a
href="../../../../com/intellectualcrafters/plot/object/Plot.html"
title="class in com.intellectualcrafters.plot.object">Plot</a>&nbsp;p)</code>
<div class="block">Get plot locations</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/intellectualcrafters/plot/PlotMain.html"
title="class in com.intellectualcrafters.plot">PlotMain</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#getMain()">getMain</a></strong>()</code>
<div class="block">Get the main class for this plugin <br>
- Contains a lot of fields and methods - not very well organized <br>
Only use this if you really need it
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/intellectualcrafters/plot/util/PlayerFunctions.html"
title="class in com.intellectualcrafters.plot.util">PlayerFunctions</a></code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#getPlayerFunctions()">getPlayerFunctions</a></strong>()</code>
<div class="block">PlayerFunctions class contains useful methods relating to players - Some
player/plot methods are here as well
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#getPlayerPlotCount(org.bukkit.World,%20org.bukkit.entity.Player)">getPlayerPlotCount</a></strong>(org.bukkit.World&nbsp;world,
org.bukkit.entity.Player&nbsp;player)</code>
<div class="block">Get the player plot count</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Set&lt;<a href="../../../../com/intellectualcrafters/plot/object/Plot.html"
title="class in com.intellectualcrafters.plot.object">Plot</a>&gt;
</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#getPlayerPlots(org.bukkit.entity.Player)">getPlayerPlots</a></strong>(org.bukkit.entity.Player&nbsp;player)</code>
<div class="block">Return all plots for a player</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Set&lt;<a href="../../../../com/intellectualcrafters/plot/object/Plot.html"
title="class in com.intellectualcrafters.plot.object">Plot</a>&gt;
</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#getPlayerPlots(org.bukkit.World,%20org.bukkit.entity.Player)">getPlayerPlots</a></strong>(org.bukkit.World&nbsp;world,
org.bukkit.entity.Player&nbsp;player)</code>
<div class="block">Get a players plots</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/intellectualcrafters/plot/object/Plot.html"
title="class in com.intellectualcrafters.plot.object">Plot</a></code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#getPlot(org.bukkit.Location)">getPlot</a></strong>(org.bukkit.Location&nbsp;l)</code>
<div class="block">Get a plot based on the location</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/intellectualcrafters/plot/object/Plot.html"
title="class in com.intellectualcrafters.plot.object">Plot</a></code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#getPlot(org.bukkit.entity.Player)">getPlot</a></strong>(org.bukkit.entity.Player&nbsp;player)</code>
<div class="block">Get a plot based on the player location</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/intellectualcrafters/plot/object/Plot.html"
title="class in com.intellectualcrafters.plot.object">Plot</a></code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#getPlot(org.bukkit.World,%20int,%20int)">getPlot</a></strong>(org.bukkit.World&nbsp;world,
int&nbsp;x,
int&nbsp;z)</code>
<div class="block">Get a plot based on the ID</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/intellectualcrafters/plot/util/PlotHelper.html"
title="class in com.intellectualcrafters.plot.util">PlotHelper</a></code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#getPlotHelper()">getPlotHelper</a></strong>()</code>
<div class="block">PlotHelper class contains useful methods relating to plots.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/intellectualcrafters/plot/PlotMain.html"
title="class in com.intellectualcrafters.plot">PlotMain</a></code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#getPlotMain()">getPlotMain</a></strong>()</code>
<div class="block">Get the plotMain class</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/intellectualcrafters/plot/object/PlotManager.html"
title="class in com.intellectualcrafters.plot.object">PlotManager</a></code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#getPlotManager(java.lang.String)">getPlotManager</a></strong>(java.lang.String&nbsp;world)</code>
<div class="block">Get the plot manager for a world. - Contains useful low level methods for
plot merging, clearing, and tessellation
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/intellectualcrafters/plot/object/PlotManager.html"
title="class in com.intellectualcrafters.plot.object">PlotManager</a></code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#getPlotManager(org.bukkit.World)">getPlotManager</a></strong>(org.bukkit.World&nbsp;world)</code>
<div class="block">Get the plot manager for a world. - Most of these methods can be accessed
through the PlotHelper
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/intellectualcrafters/plot/object/Plot.html"
title="class in com.intellectualcrafters.plot.object">Plot</a>[]</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#getPlots(org.bukkit.World)">getPlots</a></strong>(org.bukkit.World&nbsp;world)</code>
<div class="block">Get all plots for the world</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/intellectualcrafters/plot/object/Plot.html"
title="class in com.intellectualcrafters.plot.object">Plot</a>[]</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#getPlots(org.bukkit.World,%20org.bukkit.entity.Player,%20boolean)">getPlots</a></strong>(org.bukkit.World&nbsp;world,
org.bukkit.entity.Player&nbsp;plr,
boolean&nbsp;just_owner)</code>
<div class="block">Get all plots for the player</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#getPlotWorlds()">getPlotWorlds</a></strong>()</code>
<div class="block">Get all plot worlds</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/intellectualcrafters/plot/util/SchematicHandler.html"
title="class in com.intellectualcrafters.plot.util">SchematicHandler</a></code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#getSchematicHandler()">getSchematicHandler</a></strong>()</code>
<div class="block">SchematicHandler class contains methods related to pasting schematics</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>org.bukkit.configuration.file.YamlConfiguration</code></td>
<td class="colLast"><code><strong><a href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#getStorage()">getStorage</a></strong>()</code>&nbsp;
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>org.bukkit.Location</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#getTopLocation(com.intellectualcrafters.plot.object.Plot)">getTopLocation</a></strong>(<a
href="../../../../com/intellectualcrafters/plot/object/Plot.html"
title="class in com.intellectualcrafters.plot.object">Plot</a>&nbsp;p)</code>
<div class="block">Get Top Location</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/intellectualcrafters/plot/object/PlotWorld.html"
title="class in com.intellectualcrafters.plot.object">PlotWorld</a></code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#getWorldSettings(java.lang.String)">getWorldSettings</a></strong>(java.lang.String&nbsp;world)</code>
<div class="block">Get the settings for a world (settings bundled in PlotWorld class)</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/intellectualcrafters/plot/object/PlotWorld.html"
title="class in com.intellectualcrafters.plot.object">PlotWorld</a></code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#getWorldSettings(org.bukkit.World)">getWorldSettings</a></strong>(org.bukkit.World&nbsp;world)</code>
<div class="block">Get the settings for a world (settings bundled in PlotWorld class) - You
will need to downcast for the specific settings a Generator has. e.g.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#hasPlot(org.bukkit.World,%20org.bukkit.entity.Player)">hasPlot</a></strong>(org.bukkit.World&nbsp;world,
org.bukkit.entity.Player&nbsp;player)</code>
<div class="block">Check whether or not a player has a plot</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#isInPlot(org.bukkit.entity.Player)">isInPlot</a></strong>(org.bukkit.entity.Player&nbsp;player)</code>
<div class="block">Check whether or not a player is in a plot</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#isPlotWorld(org.bukkit.World)">isPlotWorld</a></strong>(org.bukkit.World&nbsp;world)</code>
<div class="block">Get if plot world</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#registerCommand(com.intellectualcrafters.plot.commands.SubCommand)">registerCommand</a></strong>(<a
href="../../../../com/intellectualcrafters/plot/commands/SubCommand.html"
title="class in com.intellectualcrafters.plot.commands">SubCommand</a>&nbsp;c)</code>
<div class="block">Register a subcommand</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#sendConsoleMessage(com.intellectualcrafters.plot.config.C)">sendConsoleMessage</a></strong>(<a
href="../../../../com/intellectualcrafters/plot/config/C.html"
title="enum in com.intellectualcrafters.plot.config">C</a>&nbsp;c)</code>
<div class="block">Send a message to the console</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#sendConsoleMessage(java.lang.String)">sendConsoleMessage</a></strong>(java.lang.String&nbsp;msg)</code>
<div class="block">Send a message to the console. - Supports color codes</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#sendMessage(org.bukkit.entity.Player,%20com.intellectualcrafters.plot.config.C)">sendMessage</a></strong>(org.bukkit.entity.Player&nbsp;player,
<a href="../../../../com/intellectualcrafters/plot/config/C.html"
title="enum in com.intellectualcrafters.plot.config">C</a>&nbsp;c)</code>
<div class="block">Send a message to a player.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/api/PlotAPI.html#sendMessage(org.bukkit.entity.Player,%20java.lang.String)">sendMessage</a></strong>(org.bukkit.entity.Player&nbsp;player,
java.lang.String&nbsp;string)</code>
<div class="block">Send a message to a player. - Supports color codes</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="ADMIN_PERMISSION">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ADMIN_PERMISSION</h4>
<pre>public static final&nbsp;java.lang.String ADMIN_PERMISSION</pre>
<div class="block">Admin Permission</div>
<dl>
<dt><span class="strong">See Also:</span></dt>
<dd>
<a href="../../../../constant-values.html#com.intellectualcrafters.plot.api.PlotAPI.ADMIN_PERMISSION">Constant
Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="PlotAPI(org.bukkit.plugin.java.JavaPlugin)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PlotAPI</h4>
<pre>public&nbsp;PlotAPI(org.bukkit.plugin.java.JavaPlugin&nbsp;plugin)</pre>
<div class="block">Constructor. Insert any Plugin.
(Optimally the plugin that is accessing the method)
</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>plugin</code> - Plugin used to access this method</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getAllPlots()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllPlots</h4>
<pre>public&nbsp;java.util.Set&lt;<a href="../../../../com/intellectualcrafters/plot/object/Plot.html"
title="class in com.intellectualcrafters.plot.object">Plot</a>&gt;&nbsp;getAllPlots()</pre>
<div class="block">Get all plots</div>
<dl>
<dt><span class="strong">Returns:</span></dt>
<dd>all plots</dd>
</dl>
</li>
</ul>
<a name="getPlayerPlots(org.bukkit.entity.Player)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlayerPlots</h4>
<pre>public&nbsp;java.util.Set&lt;<a href="../../../../com/intellectualcrafters/plot/object/Plot.html"
title="class in com.intellectualcrafters.plot.object">Plot</a>&gt;&nbsp;getPlayerPlots(org.bukkit.entity.Player&nbsp;player)</pre>
<div class="block">Return all plots for a player</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>player</code> -</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>all plots that a player owns</dd>
</dl>
</li>
</ul>
<a name="addPlotWorld(java.lang.String, com.intellectualcrafters.plot.object.PlotWorld, com.intellectualcrafters.plot.object.PlotManager)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPlotWorld</h4>
<pre>public&nbsp;void&nbsp;addPlotWorld(java.lang.String&nbsp;world,
<a href="../../../../com/intellectualcrafters/plot/object/PlotWorld.html"
title="class in com.intellectualcrafters.plot.object">PlotWorld</a>&nbsp;plotWorld,
<a href="../../../../com/intellectualcrafters/plot/object/PlotManager.html"
title="class in com.intellectualcrafters.plot.object">PlotManager</a>&nbsp;manager)</pre>
<div class="block">Add a plotoworld</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>world</code> - World Name</dd>
<dd><code>plotWorld</code> - Plot World Object</dd>
<dd><code>manager</code> - World Manager</dd>
<dt><span class="strong">See Also:</span></dt>
<dd>
<a href="../../../../com/intellectualcrafters/plot/PlotMain.html#addPlotWorld(java.lang.String,%20com.intellectualcrafters.plot.object.PlotWorld,%20com.intellectualcrafters.plot.object.PlotManager)"><code>PlotMain.addPlotWorld(String,
com.intellectualcrafters.plot.object.PlotWorld,
com.intellectualcrafters.plot.object.PlotManager)</code></a></dd>
</dl>
</li>
</ul>
<a name="getConfig()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfig</h4>
<pre>public&nbsp;org.bukkit.configuration.file.YamlConfiguration&nbsp;getConfig()</pre>
<dl>
<dt><span class="strong">Returns:</span></dt>
<dd>main configuration</dd>
<dt><span class="strong">See Also:</span></dt>
<dd>
<a href="../../../../com/intellectualcrafters/plot/PlotMain.html#config"><code>PlotMain.config</code></a>
</dd>
</dl>
</li>
</ul>
<a name="getStorage()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStorage</h4>
<pre>public&nbsp;org.bukkit.configuration.file.YamlConfiguration&nbsp;getStorage()</pre>
<dl>
<dt><span class="strong">Returns:</span></dt>
<dd>storage configuration</dd>
<dt><span class="strong">See Also:</span></dt>
<dd><a href="../../../../com/intellectualcrafters/plot/PlotMain.html#storage"><code>PlotMain.storage</code></a>
</dd>
</dl>
</li>
</ul>
<a name="getMain()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMain</h4>
<pre>public&nbsp;<a href="../../../../com/intellectualcrafters/plot/PlotMain.html"
title="class in com.intellectualcrafters.plot">PlotMain</a>&nbsp;getMain()</pre>
<div class="block">Get the main class for this plugin <br>
- Contains a lot of fields and methods - not very well organized <br>
Only use this if you really need it
</div>
<dl>
<dt><span class="strong">Returns:</span></dt>
<dd>PlotMain PlotSquared Main Class</dd>
</dl>
</li>
</ul>
<a name="getPlotHelper()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlotHelper</h4>
<pre>public&nbsp;<a href="../../../../com/intellectualcrafters/plot/util/PlotHelper.html"
title="class in com.intellectualcrafters.plot.util">PlotHelper</a>&nbsp;getPlotHelper()</pre>
<div class="block">PlotHelper class contains useful methods relating to plots.</div>
<dl>
<dt><span class="strong">Returns:</span></dt>
<dd>PlotHelper</dd>
</dl>
</li>
</ul>
<a name="getPlayerFunctions()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlayerFunctions</h4>
<pre>public&nbsp;<a href="../../../../com/intellectualcrafters/plot/util/PlayerFunctions.html"
title="class in com.intellectualcrafters.plot.util">PlayerFunctions</a>&nbsp;getPlayerFunctions()</pre>
<div class="block">PlayerFunctions class contains useful methods relating to players - Some
player/plot methods are here as well
</div>
<dl>
<dt><span class="strong">Returns:</span></dt>
<dd>PlayerFunctions</dd>
</dl>
</li>
</ul>
<a name="getFlagManager()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFlagManager</h4>
<pre>public&nbsp;<a href="../../../../com/intellectualcrafters/plot/flag/FlagManager.html"
title="class in com.intellectualcrafters.plot.flag">FlagManager</a>&nbsp;getFlagManager()</pre>
<div class="block">FlagManager class contains methods relating to plot flags</div>
<dl>
<dt><span class="strong">Returns:</span></dt>
<dd>FlagManager</dd>
</dl>
</li>
</ul>
<a name="getSchematicHandler()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSchematicHandler</h4>
<pre>public&nbsp;<a href="../../../../com/intellectualcrafters/plot/util/SchematicHandler.html"
title="class in com.intellectualcrafters.plot.util">SchematicHandler</a>&nbsp;getSchematicHandler()</pre>
<div class="block">SchematicHandler class contains methods related to pasting schematics</div>
<dl>
<dt><span class="strong">Returns:</span></dt>
<dd>SchematicHandler</dd>
</dl>
</li>
</ul>
<a name="getCaptions()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCaptions</h4>
<pre>public&nbsp;<a href="../../../../com/intellectualcrafters/plot/config/C.html"
title="enum in com.intellectualcrafters.plot.config">C</a>&nbsp;getCaptions()</pre>
<div class="block">C class contains all the captions from the translations.yml file.</div>
<dl>
<dt><span class="strong">Returns:</span></dt>
<dd>C</dd>
</dl>
</li>
</ul>
<a name="getPlotManager(org.bukkit.World)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlotManager</h4>
<pre>public&nbsp;<a href="../../../../com/intellectualcrafters/plot/object/PlotManager.html"
title="class in com.intellectualcrafters.plot.object">PlotManager</a>&nbsp;getPlotManager(org.bukkit.World&nbsp;world)</pre>
<div class="block">Get the plot manager for a world. - Most of these methods can be accessed
through the PlotHelper
</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>world</code> -</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>PlotManager</dd>
</dl>
</li>
</ul>
<a name="getPlotManager(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlotManager</h4>
<pre>public&nbsp;<a href="../../../../com/intellectualcrafters/plot/object/PlotManager.html"
title="class in com.intellectualcrafters.plot.object">PlotManager</a>&nbsp;getPlotManager(java.lang.String&nbsp;world)</pre>
<div class="block">Get the plot manager for a world. - Contains useful low level methods for
plot merging, clearing, and tessellation
</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>world</code> -</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>PlotManager</dd>
</dl>
</li>
</ul>
<a name="getWorldSettings(org.bukkit.World)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWorldSettings</h4>
<pre>public&nbsp;<a href="../../../../com/intellectualcrafters/plot/object/PlotWorld.html"
title="class in com.intellectualcrafters.plot.object">PlotWorld</a>&nbsp;getWorldSettings(org.bukkit.World&nbsp;world)</pre>
<div class="block">Get the settings for a world (settings bundled in PlotWorld class) - You
will need to downcast for the specific settings a Generator has. e.g.
DefaultPlotWorld class implements PlotWorld
</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>world</code> - (to get settings of)</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>PlotWorld class for that world ! will return null if not a plot
world world
</dd>
</dl>
</li>
</ul>
<a name="getWorldSettings(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWorldSettings</h4>
<pre>public&nbsp;<a href="../../../../com/intellectualcrafters/plot/object/PlotWorld.html"
title="class in com.intellectualcrafters.plot.object">PlotWorld</a>&nbsp;getWorldSettings(java.lang.String&nbsp;world)</pre>
<div class="block">Get the settings for a world (settings bundled in PlotWorld class)</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>world</code> - (to get settings of)</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>PlotWorld class for that world ! will return null if not a plot
world world
</dd>
</dl>
</li>
</ul>
<a name="sendMessage(org.bukkit.entity.Player, com.intellectualcrafters.plot.config.C)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendMessage</h4>
<pre>public&nbsp;void&nbsp;sendMessage(org.bukkit.entity.Player&nbsp;player,
<a href="../../../../com/intellectualcrafters/plot/config/C.html"
title="enum in com.intellectualcrafters.plot.config">C</a>&nbsp;c)</pre>
<div class="block">Send a message to a player.</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>player</code> -</dd>
<dd><code>c</code> - (Caption)</dd>
</dl>
</li>
</ul>
<a name="sendMessage(org.bukkit.entity.Player, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendMessage</h4>
<pre>public&nbsp;void&nbsp;sendMessage(org.bukkit.entity.Player&nbsp;player,
java.lang.String&nbsp;string)</pre>
<div class="block">Send a message to a player. - Supports color codes</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>player</code> -</dd>
<dd><code>string</code> -</dd>
</dl>
</li>
</ul>
<a name="sendConsoleMessage(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendConsoleMessage</h4>
<pre>public&nbsp;void&nbsp;sendConsoleMessage(java.lang.String&nbsp;msg)</pre>
<div class="block">Send a message to the console. - Supports color codes</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>msg</code> -</dd>
</dl>
</li>
</ul>
<a name="sendConsoleMessage(com.intellectualcrafters.plot.config.C)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendConsoleMessage</h4>
<pre>public&nbsp;void&nbsp;sendConsoleMessage(<a href="../../../../com/intellectualcrafters/plot/config/C.html"
title="enum in com.intellectualcrafters.plot.config">C</a>&nbsp;c)</pre>
<div class="block">Send a message to the console</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>c</code> - (Caption)</dd>
</dl>
</li>
</ul>
<a name="addFlag(com.intellectualcrafters.plot.flag.AbstractFlag)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addFlag</h4>
<pre>public&nbsp;void&nbsp;addFlag(<a href="../../../../com/intellectualcrafters/plot/flag/AbstractFlag.html"
title="class in com.intellectualcrafters.plot.flag">AbstractFlag</a>&nbsp;flag)</pre>
<div class="block">Register a flag for use in plots</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>flag</code> -</dd>
</dl>
</li>
</ul>
<a name="getFlags()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFlags</h4>
<pre>public&nbsp;<a href="../../../../com/intellectualcrafters/plot/flag/AbstractFlag.html"
title="class in com.intellectualcrafters.plot.flag">AbstractFlag</a>[]&nbsp;getFlags()</pre>
<div class="block">get all the currently registered flags</div>
<dl>
<dt><span class="strong">Returns:</span></dt>
<dd>array of Flag[]</dd>
</dl>
</li>
</ul>
<a name="getPlot(org.bukkit.World, int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlot</h4>
<pre>public&nbsp;<a href="../../../../com/intellectualcrafters/plot/object/Plot.html"
title="class in com.intellectualcrafters.plot.object">Plot</a>&nbsp;getPlot(org.bukkit.World&nbsp;world,
int&nbsp;x,
int&nbsp;z)</pre>
<div class="block">Get a plot based on the ID</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>world</code> -</dd>
<dd><code>x</code> -</dd>
<dd><code>z</code> -</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>plot, null if ID is wrong</dd>
</dl>
</li>
</ul>
<a name="getPlot(org.bukkit.Location)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlot</h4>
<pre>public&nbsp;<a href="../../../../com/intellectualcrafters/plot/object/Plot.html"
title="class in com.intellectualcrafters.plot.object">Plot</a>&nbsp;getPlot(org.bukkit.Location&nbsp;l)</pre>
<div class="block">Get a plot based on the location</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>l</code> -</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>plot if found, otherwise it creates a temporary plot-</dd>
</dl>
</li>
</ul>
<a name="getPlot(org.bukkit.entity.Player)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlot</h4>
<pre>public&nbsp;<a href="../../../../com/intellectualcrafters/plot/object/Plot.html"
title="class in com.intellectualcrafters.plot.object">Plot</a>&nbsp;getPlot(org.bukkit.entity.Player&nbsp;player)</pre>
<div class="block">Get a plot based on the player location</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>player</code> -</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>plot if found, otherwise it creates a temporary plot</dd>
</dl>
</li>
</ul>
<a name="hasPlot(org.bukkit.World, org.bukkit.entity.Player)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasPlot</h4>
<pre>public&nbsp;boolean&nbsp;hasPlot(org.bukkit.World&nbsp;world,
org.bukkit.entity.Player&nbsp;player)</pre>
<div class="block">Check whether or not a player has a plot</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>player</code> -</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>true if player has a plot, false if not.</dd>
</dl>
</li>
</ul>
<a name="getPlots(org.bukkit.World, org.bukkit.entity.Player, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlots</h4>
<pre>public&nbsp;<a href="../../../../com/intellectualcrafters/plot/object/Plot.html"
title="class in com.intellectualcrafters.plot.object">Plot</a>[]&nbsp;getPlots(org.bukkit.World&nbsp;world,
org.bukkit.entity.Player&nbsp;plr,
boolean&nbsp;just_owner)</pre>
<div class="block">Get all plots for the player</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>plr</code> - to search for</dd>
<dd><code>just_owner</code> - should we just search for owner? Or with rights?</dd>
</dl>
</li>
</ul>
<a name="getPlots(org.bukkit.World)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlots</h4>
<pre>public&nbsp;<a href="../../../../com/intellectualcrafters/plot/object/Plot.html"
title="class in com.intellectualcrafters.plot.object">Plot</a>[]&nbsp;getPlots(org.bukkit.World&nbsp;world)</pre>
<div class="block">Get all plots for the world</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>world</code> - to get plots of</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>Plot[] - array of plot objects in world</dd>
</dl>
</li>
</ul>
<a name="getPlotWorlds()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlotWorlds</h4>
<pre>public&nbsp;java.lang.String[]&nbsp;getPlotWorlds()</pre>
<div class="block">Get all plot worlds</div>
<dl>
<dt><span class="strong">Returns:</span></dt>
<dd>World[] - array of plot worlds</dd>
</dl>
</li>
</ul>
<a name="isPlotWorld(org.bukkit.World)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPlotWorld</h4>
<pre>public&nbsp;boolean&nbsp;isPlotWorld(org.bukkit.World&nbsp;world)</pre>
<div class="block">Get if plot world</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>world</code> - (to check if plot world)</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>boolean (if plot world or not)</dd>
</dl>
</li>
</ul>
<a name="getLocations(com.intellectualcrafters.plot.object.Plot)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocations</h4>
<pre>public&nbsp;org.bukkit.Location[]&nbsp;getLocations(<a
href="../../../../com/intellectualcrafters/plot/object/Plot.html"
title="class in com.intellectualcrafters.plot.object">Plot</a>&nbsp;p)</pre>
<div class="block">Get plot locations</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>p</code> -</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>[0] = bottomLc, [1] = topLoc, [2] = home</dd>
</dl>
</li>
</ul>
<a name="getHomeLocation(com.intellectualcrafters.plot.object.Plot)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHomeLocation</h4>
<pre>public&nbsp;org.bukkit.Location&nbsp;getHomeLocation(<a
href="../../../../com/intellectualcrafters/plot/object/Plot.html"
title="class in com.intellectualcrafters.plot.object">Plot</a>&nbsp;p)</pre>
<div class="block">Get home location</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>p</code> -</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>plot bottom location</dd>
</dl>
</li>
</ul>
<a name="getBottomLocation(com.intellectualcrafters.plot.object.Plot)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBottomLocation</h4>
<pre>public&nbsp;org.bukkit.Location&nbsp;getBottomLocation(<a
href="../../../../com/intellectualcrafters/plot/object/Plot.html"
title="class in com.intellectualcrafters.plot.object">Plot</a>&nbsp;p)</pre>
<div class="block">Get Bottom Location</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>p</code> -</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>plot bottom location</dd>
</dl>
</li>
</ul>
<a name="getTopLocation(com.intellectualcrafters.plot.object.Plot)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTopLocation</h4>
<pre>public&nbsp;org.bukkit.Location&nbsp;getTopLocation(<a
href="../../../../com/intellectualcrafters/plot/object/Plot.html"
title="class in com.intellectualcrafters.plot.object">Plot</a>&nbsp;p)</pre>
<div class="block">Get Top Location</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>p</code> -</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>plot top location</dd>
</dl>
</li>
</ul>
<a name="isInPlot(org.bukkit.entity.Player)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isInPlot</h4>
<pre>public&nbsp;boolean&nbsp;isInPlot(org.bukkit.entity.Player&nbsp;player)</pre>
<div class="block">Check whether or not a player is in a plot</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>player</code> -</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>true if the player is in a plot, false if not-</dd>
</dl>
</li>
</ul>
<a name="registerCommand(com.intellectualcrafters.plot.commands.SubCommand)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerCommand</h4>
<pre>public&nbsp;void&nbsp;registerCommand(<a
href="../../../../com/intellectualcrafters/plot/commands/SubCommand.html"
title="class in com.intellectualcrafters.plot.commands">SubCommand</a>&nbsp;c)</pre>
<div class="block">Register a subcommand</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>c</code> -</dd>
</dl>
</li>
</ul>
<a name="getPlotMain()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlotMain</h4>
<pre>public&nbsp;<a href="../../../../com/intellectualcrafters/plot/PlotMain.html"
title="class in com.intellectualcrafters.plot">PlotMain</a>&nbsp;getPlotMain()</pre>
<div class="block">Get the plotMain class</div>
<dl>
<dt><span class="strong">Returns:</span></dt>
<dd>PlotMain Class</dd>
</dl>
</li>
</ul>
<a name="getPlayerPlotCount(org.bukkit.World, org.bukkit.entity.Player)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlayerPlotCount</h4>
<pre>public&nbsp;int&nbsp;getPlayerPlotCount(org.bukkit.World&nbsp;world,
org.bukkit.entity.Player&nbsp;player)</pre>
<div class="block">Get the player plot count</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>player</code> -</dd>
<dt><span class="strong">Returns:</span></dt>
<dd></dd>
</dl>
</li>
</ul>
<a name="getPlayerPlots(org.bukkit.World, org.bukkit.entity.Player)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlayerPlots</h4>
<pre>public&nbsp;java.util.Set&lt;<a href="../../../../com/intellectualcrafters/plot/object/Plot.html"
title="class in com.intellectualcrafters.plot.object">Plot</a>&gt;&nbsp;getPlayerPlots(org.bukkit.World&nbsp;world,
org.bukkit.entity.Player&nbsp;player)</pre>
<div class="block">Get a players plots</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>player</code> -</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>a set containing the players plots</dd>
</dl>
</li>
</ul>
<a name="getAllowedPlots(org.bukkit.entity.Player)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getAllowedPlots</h4>
<pre>public&nbsp;int&nbsp;getAllowedPlots(org.bukkit.entity.Player&nbsp;player)</pre>
<div class="block">Get the allowed plot count for a player</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>player</code> -</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>the number of allowed plots</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/intellectualcrafters/plot/api/PlotAPI.html" target="_top">Frames</a>
</li>
<li><a href="PlotAPI.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if (window == top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Reference in New Issue Copy Permalink