PlotSquared/doc/com/intellectualcrafters/plot/util/SchematicHandler.html

464 lines
24 KiB
HTML
Raw Normal View History

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:54 CET 2014 -->
<title>SchematicHandler</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 = "SchematicHandler";
}
//-->
</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><a href="../../../../com/intellectualcrafters/plot/util/RUtils.html"
title="class in com.intellectualcrafters.plot.util"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/intellectualcrafters/plot/util/SchematicHandler.DataCollection.html"
title="class in com.intellectualcrafters.plot.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/intellectualcrafters/plot/util/SchematicHandler.html" target="_top">Frames</a>
</li>
<li><a href="SchematicHandler.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><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&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>Field&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.util</div>
<h2 title="Class SchematicHandler" class="title">Class SchematicHandler</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.intellectualcrafters.plot.util.SchematicHandler</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">SchematicHandler</span>
extends java.lang.Object</pre>
<div class="block">Schematic Handler</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0"
summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/util/SchematicHandler.DataCollection.html"
title="class in com.intellectualcrafters.plot.util">SchematicHandler.DataCollection</a></strong></code>
<div class="block">Schematic Data Collection</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/util/SchematicHandler.Dimension.html"
title="class in com.intellectualcrafters.plot.util">SchematicHandler.Dimension</a></strong></code>
<div class="block">Schematic Dimensions</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/util/SchematicHandler.Schematic.html"
title="class in com.intellectualcrafters.plot.util">SchematicHandler.Schematic</a></strong></code>
<div class="block">Schematic Class</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/util/SchematicHandler.html#SchematicHandler()">SchematicHandler</a></strong>()</code>&nbsp;
</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>static <a
href="../../../../com/intellectualcrafters/jnbt/CompoundTag.html"
title="class in com.intellectualcrafters.jnbt">CompoundTag</a></code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/util/SchematicHandler.html#getCompoundTag(org.bukkit.World,%20com.intellectualcrafters.plot.object.PlotId)">getCompoundTag</a></strong>(org.bukkit.World&nbsp;world,
<a href="../../../../com/intellectualcrafters/plot/object/PlotId.html"
title="class in com.intellectualcrafters.plot.object">PlotId</a>&nbsp;id)</code>
<div class="block">Gets the schematic of a plot</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a
href="../../../../com/intellectualcrafters/plot/util/SchematicHandler.Schematic.html"
title="class in com.intellectualcrafters.plot.util">SchematicHandler.Schematic</a></code>
</td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/util/SchematicHandler.html#getSchematic(java.lang.String)">getSchematic</a></strong>(java.lang.String&nbsp;name)</code>
<div class="block">Get a schematic</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/util/SchematicHandler.html#paste(org.bukkit.Location,%20com.intellectualcrafters.plot.util.SchematicHandler.Schematic,%20com.intellectualcrafters.plot.object.Plot,%20int,%20int)">paste</a></strong>(org.bukkit.Location&nbsp;location,
<a href="../../../../com/intellectualcrafters/plot/util/SchematicHandler.Schematic.html"
title="class in com.intellectualcrafters.plot.util">SchematicHandler.Schematic</a>&nbsp;schematic,
<a href="../../../../com/intellectualcrafters/plot/object/Plot.html"
title="class in com.intellectualcrafters.plot.object">Plot</a>&nbsp;plot,
int&nbsp;x_offset,
int&nbsp;z_offset)</code>
<div class="block">Paste a schematic</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/util/SchematicHandler.html#pastePart(org.bukkit.World,%20com.intellectualcrafters.plot.util.SchematicHandler.DataCollection[],%20org.bukkit.Location,%20int,%20int,%20int,%20int,%20int,%20int)">pastePart</a></strong>(org.bukkit.World&nbsp;world,
<a href="../../../../com/intellectualcrafters/plot/util/SchematicHandler.DataCollection.html"
title="class in com.intellectualcrafters.plot.util">SchematicHandler.DataCollection</a>[]&nbsp;blocks,
org.bukkit.Location&nbsp;l1,
int&nbsp;x_offset,
int&nbsp;z_offset,
int&nbsp;i1,
int&nbsp;i2,
int&nbsp;WIDTH,
int&nbsp;LENGTH)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/util/SchematicHandler.html#save(com.intellectualcrafters.jnbt.CompoundTag,%20java.lang.String)">save</a></strong>(<a
href="../../../../com/intellectualcrafters/jnbt/CompoundTag.html"
title="class in com.intellectualcrafters.jnbt">CompoundTag</a>&nbsp;tag,
java.lang.String&nbsp;path)</code>
<div class="block">Saves a schematic to a file path</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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SchematicHandler()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SchematicHandler</h4>
<pre>public&nbsp;SchematicHandler()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="paste(org.bukkit.Location, com.intellectualcrafters.plot.util.SchematicHandler.Schematic, com.intellectualcrafters.plot.object.Plot, int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>paste</h4>
<pre>public static&nbsp;boolean&nbsp;paste(org.bukkit.Location&nbsp;location,
<a href="../../../../com/intellectualcrafters/plot/util/SchematicHandler.Schematic.html"
title="class in com.intellectualcrafters.plot.util">SchematicHandler.Schematic</a>&nbsp;schematic,
<a href="../../../../com/intellectualcrafters/plot/object/Plot.html"
title="class in com.intellectualcrafters.plot.object">Plot</a>&nbsp;plot,
int&nbsp;x_offset,
int&nbsp;z_offset)</pre>
<div class="block">Paste a schematic</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>location</code> - origin</dd>
<dd><code>schematic</code> - schematic to paste</dd>
<dd><code>plot</code> - plot to paste in</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>true if succeeded</dd>
</dl>
</li>
</ul>
<a name="getSchematic(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSchematic</h4>
<pre>public static&nbsp;<a
href="../../../../com/intellectualcrafters/plot/util/SchematicHandler.Schematic.html"
title="class in com.intellectualcrafters.plot.util">SchematicHandler.Schematic</a>&nbsp;getSchematic(java.lang.String&nbsp;name)</pre>
<div class="block">Get a schematic</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>name</code> - to check</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>schematic if found, else null</dd>
</dl>
</li>
</ul>
<a name="save(com.intellectualcrafters.jnbt.CompoundTag, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>save</h4>
<pre>public static&nbsp;boolean&nbsp;save(<a href="../../../../com/intellectualcrafters/jnbt/CompoundTag.html"
title="class in com.intellectualcrafters.jnbt">CompoundTag</a>&nbsp;tag,
java.lang.String&nbsp;path)</pre>
<div class="block">Saves a schematic to a file path</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>tag</code> - to save</dd>
<dd><code>path</code> - to save in</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>true if succeeded</dd>
</dl>
</li>
</ul>
<a name="getCompoundTag(org.bukkit.World, com.intellectualcrafters.plot.object.PlotId)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCompoundTag</h4>
<pre>public static&nbsp;<a href="../../../../com/intellectualcrafters/jnbt/CompoundTag.html"
title="class in com.intellectualcrafters.jnbt">CompoundTag</a>&nbsp;getCompoundTag(org.bukkit.World&nbsp;world,
<a href="../../../../com/intellectualcrafters/plot/object/PlotId.html"
title="class in com.intellectualcrafters.plot.object">PlotId</a>&nbsp;id)</pre>
<div class="block">Gets the schematic of a plot</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>world</code> - to check</dd>
<dd><code>id</code> - plot</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>tag</dd>
</dl>
</li>
</ul>
<a name="pastePart(org.bukkit.World, com.intellectualcrafters.plot.util.SchematicHandler.DataCollection[], org.bukkit.Location, int, int, int, int, int, int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>pastePart</h4>
<pre>public static&nbsp;boolean&nbsp;pastePart(org.bukkit.World&nbsp;world,
<a href="../../../../com/intellectualcrafters/plot/util/SchematicHandler.DataCollection.html"
title="class in com.intellectualcrafters.plot.util">SchematicHandler.DataCollection</a>[]&nbsp;blocks,
org.bukkit.Location&nbsp;l1,
int&nbsp;x_offset,
int&nbsp;z_offset,
int&nbsp;i1,
int&nbsp;i2,
int&nbsp;WIDTH,
int&nbsp;LENGTH)</pre>
</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><a href="../../../../com/intellectualcrafters/plot/util/RUtils.html"
title="class in com.intellectualcrafters.plot.util"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/intellectualcrafters/plot/util/SchematicHandler.DataCollection.html"
title="class in com.intellectualcrafters.plot.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/intellectualcrafters/plot/util/SchematicHandler.html" target="_top">Frames</a>
</li>
<li><a href="SchematicHandler.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><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&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>Field&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>