mirror of
https://github.com/AtlasMediaGroup/Scissors-Website.git
synced 2024-07-08 18:00:01 +00:00
456 lines
34 KiB
HTML
456 lines
34 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (17) -->
|
|
<title>MapMeta (Scissors-API 1.19.4-R0.1-SNAPSHOT API)</title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<meta name="description" content="declaration: package: org.bukkit.inventory.meta, interface: MapMeta">
|
|
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
|
|
<script type="text/javascript" src="../../../../script.js"></script>
|
|
<script type="text/javascript" src="../../../../script-dir/jquery-3.6.0.min.js"></script>
|
|
<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
|
|
</head>
|
|
<body class="class-declaration-page">
|
|
<script type="text/javascript">var evenRowColor = "even-row-color";
|
|
var oddRowColor = "odd-row-color";
|
|
var tableTab = "table-tab";
|
|
var activeTableTab = "active-table-tab";
|
|
var pathtoroot = "../../../../";
|
|
loadScripts(document, 'script');</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<div class="flex-box">
|
|
<header role="banner" class="flex-header">
|
|
<nav role="navigation">
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="top-nav" id="navbar-top">
|
|
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
<li><a href="../../../../index.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="nav-bar-cell1-rev">Class</li>
|
|
<li><a href="class-use/MapMeta.html">Use</a></li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../../index-all.html">Index</a></li>
|
|
<li><a href="../../../../help-doc.html#class">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="sub-nav">
|
|
<div>
|
|
<ul class="sub-nav-list">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method-summary">Method</a></li>
|
|
</ul>
|
|
<ul class="sub-nav-list">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method-detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
</header>
|
|
<div class="flex-content">
|
|
<main role="main">
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.bukkit.inventory.meta</a></div>
|
|
<h1 title="Interface MapMeta" class="title">Interface MapMeta</h1>
|
|
</div>
|
|
<section class="class-description" id="class-description">
|
|
<dl class="notes">
|
|
<dt>All Superinterfaces:</dt>
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Cloneable.html" title="class or interface in java.lang" class="external-link">Cloneable</a></code>, <code><a href="../../configuration/serialization/ConfigurationSerializable.html" title="interface in org.bukkit.configuration.serialization">ConfigurationSerializable</a></code>, <code><a href="ItemMeta.html" title="interface in org.bukkit.inventory.meta">ItemMeta</a></code>, <code><a href="../../persistence/PersistentDataHolder.html" title="interface in org.bukkit.persistence">PersistentDataHolder</a></code></dd>
|
|
</dl>
|
|
<hr>
|
|
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">MapMeta</span><span class="extends-implements">
|
|
extends <a href="ItemMeta.html" title="interface in org.bukkit.inventory.meta">ItemMeta</a></span></div>
|
|
<div class="block">Represents a map that can be scalable.</div>
|
|
</section>
|
|
<section class="summary">
|
|
<ul class="summary-list">
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<li>
|
|
<section class="method-summary" id="method-summary">
|
|
<h2>Method Summary</h2>
|
|
<div id="method-summary-table">
|
|
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated Methods</button></div>
|
|
<div id="method-summary-table.tabpanel" role="tabpanel">
|
|
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
|
<div class="table-header col-first">Modifier and Type</div>
|
|
<div class="table-header col-second">Method</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="MapMeta.html" title="interface in org.bukkit.inventory.meta">MapMeta</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#clone()" class="member-name-link">clone</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="../../Color.html" title="class in org.bukkit">Color</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getColor()" class="member-name-link">getColor</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Gets the map color that is set.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getLocationName()" class="member-name-link">getLocationName</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Gets the location name that is set.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code>int</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code><a href="#getMapId()" class="member-name-link">getMapId</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6">
|
|
<div class="block"><span class="deprecated-label">Deprecated.</span>
|
|
<div class="deprecation-comment">These methods are poor API: They rely on the caller to pass
|
|
in an only an integer property, and have poorly defined implementation
|
|
behavior if that integer is not a valid map (the current implementation
|
|
for example will generate a new map with a different ID).</div>
|
|
</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="../../map/MapView.html" title="interface in org.bukkit.map">MapView</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMapView()" class="member-name-link">getMapView</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Gets the map view that is associated with this map item.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#hasColor()" class="member-name-link">hasColor</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Checks for existence of a map color.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#hasLocationName()" class="member-name-link">hasLocationName</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Checks for existence of a location name.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code>boolean</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code><a href="#hasMapId()" class="member-name-link">hasMapId</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6">
|
|
<div class="block"><span class="deprecated-label">Deprecated.</span>
|
|
<div class="deprecation-comment">These methods are poor API: They rely on the caller to pass
|
|
in an only an integer property, and have poorly defined implementation
|
|
behavior if that integer is not a valid map (the current implementation
|
|
for example will generate a new map with a different ID).</div>
|
|
</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#hasMapView()" class="member-name-link">hasMapView</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Checks for existence of an associated map.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isScaling()" class="member-name-link">isScaling</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Checks to see if this map is scaling.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setColor(org.bukkit.Color)" class="member-name-link">setColor</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="../../Color.html" title="class in org.bukkit">Color</a> color)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Sets the map color.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setLocationName(java.lang.String)" class="member-name-link">setLocationName</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Sets the location name.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code>void</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code><a href="#setMapId(int)" class="member-name-link">setMapId</a><wbr>(int id)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6">
|
|
<div class="block"><span class="deprecated-label">Deprecated.</span>
|
|
<div class="deprecation-comment">These methods are poor API: They rely on the caller to pass
|
|
in an only an integer property, and have poorly defined implementation
|
|
behavior if that integer is not a valid map (the current implementation
|
|
for example will generate a new map with a different ID).</div>
|
|
</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setMapView(org.bukkit.map.MapView)" class="member-name-link">setMapView</a><wbr>(<a href="../../map/MapView.html" title="interface in org.bukkit.map">MapView</a> map)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Sets the associated map.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setScaling(boolean)" class="member-name-link">setScaling</a><wbr>(boolean value)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Sets if this map is scaling or not.</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-org.bukkit.configuration.serialization.ConfigurationSerializable">Methods inherited from interface org.bukkit.configuration.serialization.<a href="../../configuration/serialization/ConfigurationSerializable.html" title="interface in org.bukkit.configuration.serialization">ConfigurationSerializable</a></h3>
|
|
<code><a href="../../configuration/serialization/ConfigurationSerializable.html#serialize()">serialize</a></code></div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-org.bukkit.inventory.meta.ItemMeta">Methods inherited from interface org.bukkit.inventory.meta.<a href="ItemMeta.html" title="interface in org.bukkit.inventory.meta">ItemMeta</a></h3>
|
|
<code><a href="ItemMeta.html#addAttributeModifier(org.bukkit.attribute.Attribute,org.bukkit.attribute.AttributeModifier)">addAttributeModifier</a>, <a href="ItemMeta.html#addEnchant(org.bukkit.enchantments.Enchantment,int,boolean)">addEnchant</a>, <a href="ItemMeta.html#addItemFlags(org.bukkit.inventory.ItemFlag...)">addItemFlags</a>, <a href="ItemMeta.html#displayName()">displayName</a>, <a href="ItemMeta.html#displayName(net.kyori.adventure.text.Component)">displayName</a>, <a href="ItemMeta.html#getAsString()">getAsString</a>, <a href="ItemMeta.html#getAttributeModifiers()">getAttributeModifiers</a>, <a href="ItemMeta.html#getAttributeModifiers(org.bukkit.attribute.Attribute)">getAttributeModifiers</a>, <a href="ItemMeta.html#getAttributeModifiers(org.bukkit.inventory.EquipmentSlot)">getAttributeModifiers</a>, <a href="ItemMeta.html#getCanDestroy()">getCanDestroy</a>, <a href="ItemMeta.html#getCanPlaceOn()">getCanPlaceOn</a>, <a href="ItemMeta.html#getCustomModelData()">getCustomModelData</a>, <a href="ItemMeta.html#getCustomTagContainer()">getCustomTagContainer</a>, <a href="ItemMeta.html#getDestroyableKeys()">getDestroyableKeys</a>, <a href="ItemMeta.html#getDisplayName()">getDisplayName</a>, <a href="ItemMeta.html#getDisplayNameComponent()">getDisplayNameComponent</a>, <a href="ItemMeta.html#getEnchantLevel(org.bukkit.enchantments.Enchantment)">getEnchantLevel</a>, <a href="ItemMeta.html#getEnchants()">getEnchants</a>, <a href="ItemMeta.html#getItemFlags()">getItemFlags</a>, <a href="ItemMeta.html#getLocalizedName()">getLocalizedName</a>, <a href="ItemMeta.html#getLore()">getLore</a>, <a href="ItemMeta.html#getLoreComponents()">getLoreComponents</a>, <a href="ItemMeta.html#getPlaceableKeys()">getPlaceableKeys</a>, <a href="ItemMeta.html#hasAttributeModifiers()">hasAttributeModifiers</a>, <a href="ItemMeta.html#hasConflictingEnchant(org.bukkit.enchantments.Enchantment)">hasConflictingEnchant</a>, <a href="ItemMeta.html#hasCustomModelData()">hasCustomModelData</a>, <a href="ItemMeta.html#hasDestroyableKeys()">hasDestroyableKeys</a>, <a href="ItemMeta.html#hasDisplayName()">hasDisplayName</a>, <a href="ItemMeta.html#hasEnchant(org.bukkit.enchantments.Enchantment)">hasEnchant</a>, <a href="ItemMeta.html#hasEnchants()">hasEnchants</a>, <a href="ItemMeta.html#hasItemFlag(org.bukkit.inventory.ItemFlag)">hasItemFlag</a>, <a href="ItemMeta.html#hasLocalizedName()">hasLocalizedName</a>, <a href="ItemMeta.html#hasLore()">hasLore</a>, <a href="ItemMeta.html#hasPlaceableKeys()">hasPlaceableKeys</a>, <a href="ItemMeta.html#isUnbreakable()">isUnbreakable</a>, <a href="ItemMeta.html#lore()">lore</a>, <a href="ItemMeta.html#lore(java.util.List)">lore</a>, <a href="ItemMeta.html#removeAttributeModifier(org.bukkit.attribute.Attribute)">removeAttributeModifier</a>, <a href="ItemMeta.html#removeAttributeModifier(org.bukkit.attribute.Attribute,org.bukkit.attribute.AttributeModifier)">removeAttributeModifier</a>, <a href="ItemMeta.html#removeAttributeModifier(org.bukkit.inventory.EquipmentSlot)">removeAttributeModifier</a>, <a href="ItemMeta.html#removeEnchant(org.bukkit.enchantments.Enchantment)">removeEnchant</a>, <a href="ItemMeta.html#removeItemFlags(org.bukkit.inventory.ItemFlag...)">removeItemFlags</a>, <a href="ItemMeta.html#setAttributeModifiers(com.google.common.collect.Multimap)">setAttributeModifiers</a>, <a href="ItemMeta.html#setCanDestroy(java.util.Set)">setCanDestroy</a>, <a href="ItemMeta.html#setCanPlaceOn(java.util.Set)">setCanPlaceOn</a>, <a href="ItemMeta.html#setCustomModelData(java.lang.Integer)">setCustomModelData</a>, <a href="ItemMeta.html#setDestroyableKeys(java.util.Collection)">setDestroyableKeys</a>, <a href="ItemMeta.html#setDisplayName(java.lang.String)">setDisplayName</a>, <a href="ItemMeta.html#setDisplayNameComponent(net.md_5.bungee.api.chat.BaseComponent%5B%5D)">setDisplayNameComponent</a>, <a href="ItemMeta.html#setLocalizedName(java.lang.String)">setLocalizedName</a>, <a href="ItemMeta.html#setLore(java.util.List)">setLore</a>, <a href="ItemMeta.html#setLoreComponents(java.util.List)">setLoreComponents</a>, <a href="ItemMeta.html#setPlaceableKeys(java.util.Collection)">setPlaceableKeys</a>, <a href="ItemMeta.html#setUnbreakable(boolean)">setUnbreakable</a>, <a href="ItemMeta.html#setVersion(int)">setVersion</a></code></div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-org.bukkit.persistence.PersistentDataHolder">Methods inherited from interface org.bukkit.persistence.<a href="../../persistence/PersistentDataHolder.html" title="interface in org.bukkit.persistence">PersistentDataHolder</a></h3>
|
|
<code><a href="../../persistence/PersistentDataHolder.html#getPersistentDataContainer()">getPersistentDataContainer</a></code></div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="details">
|
|
<ul class="details-list">
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<li>
|
|
<section class="method-details" id="method-detail">
|
|
<h2>Method Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="hasMapId()">
|
|
<h3>hasMapId</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
|
|
</span><span class="return-type">boolean</span> <span class="element-name">hasMapId</span>()</div>
|
|
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
|
|
<div class="deprecation-comment">These methods are poor API: They rely on the caller to pass
|
|
in an only an integer property, and have poorly defined implementation
|
|
behavior if that integer is not a valid map (the current implementation
|
|
for example will generate a new map with a different ID). The xxxMapView
|
|
family of methods should be used instead.</div>
|
|
</div>
|
|
<div class="block">Checks for existence of a map ID number.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>true if this has a map ID number.</dd>
|
|
<dt>See Also:</dt>
|
|
<dd>
|
|
<ul class="see-list">
|
|
<li><a href="#hasMapView()"><code>hasMapView()</code></a></li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getMapId()">
|
|
<h3>getMapId</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
|
|
</span><span class="return-type">int</span> <span class="element-name">getMapId</span>()</div>
|
|
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
|
|
<div class="deprecation-comment">These methods are poor API: They rely on the caller to pass
|
|
in an only an integer property, and have poorly defined implementation
|
|
behavior if that integer is not a valid map (the current implementation
|
|
for example will generate a new map with a different ID). The xxxMapView
|
|
family of methods should be used instead.</div>
|
|
</div>
|
|
<div class="block">Gets the map ID that is set. This is used to determine what map is
|
|
displayed.
|
|
<p>
|
|
Plugins should check that hasMapId() returns <code>true</code> before
|
|
calling this method.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>the map ID that is set</dd>
|
|
<dt>See Also:</dt>
|
|
<dd>
|
|
<ul class="see-list">
|
|
<li><a href="#getMapView()"><code>getMapView()</code></a></li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="setMapId(int)">
|
|
<h3>setMapId</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
|
|
</span><span class="return-type">void</span> <span class="element-name">setMapId</span><wbr><span class="parameters">(int id)</span></div>
|
|
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
|
|
<div class="deprecation-comment">These methods are poor API: They rely on the caller to pass
|
|
in an only an integer property, and have poorly defined implementation
|
|
behavior if that integer is not a valid map (the current implementation
|
|
for example will generate a new map with a different ID). The xxxMapView
|
|
family of methods should be used instead.</div>
|
|
</div>
|
|
<div class="block">Sets the map ID. This is used to determine what map is displayed.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>id</code> - the map id to set</dd>
|
|
<dt>See Also:</dt>
|
|
<dd>
|
|
<ul class="see-list-long">
|
|
<li><a href="#setMapView(org.bukkit.map.MapView)"><code>setMapView(org.bukkit.map.MapView)</code></a></li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="hasMapView()">
|
|
<h3>hasMapView</h3>
|
|
<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">hasMapView</span>()</div>
|
|
<div class="block">Checks for existence of an associated map.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>true if this item has an associated map</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getMapView()">
|
|
<h3>getMapView</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
|
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="../../map/MapView.html" title="interface in org.bukkit.map">MapView</a></span> <span class="element-name">getMapView</span>()</div>
|
|
<div class="block">Gets the map view that is associated with this map item.
|
|
|
|
<p>
|
|
Plugins should check that hasMapView() returns <code>true</code> before
|
|
calling this method.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>the map view, or null if the item hasMapView(), but this map does
|
|
not exist on the server</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="setMapView(org.bukkit.map.MapView)">
|
|
<h3>setMapView</h3>
|
|
<div class="member-signature"><span class="return-type">void</span> <span class="element-name">setMapView</span><wbr><span class="parameters">(<a href="../../UndefinedNullability.html" title="annotation interface in org.bukkit">@UndefinedNullability</a>("implementation defined")
|
|
<a href="../../map/MapView.html" title="interface in org.bukkit.map">MapView</a> map)</span></div>
|
|
<div class="block">Sets the associated map. This is used to determine what map is displayed.
|
|
|
|
<p>
|
|
The implementation <b>may</b> allow null to clear the associated map, but
|
|
this is not required and is liable to generate a new (undefined) map when
|
|
the item is first used.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>map</code> - the map to set</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="isScaling()">
|
|
<h3>isScaling</h3>
|
|
<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isScaling</span>()</div>
|
|
<div class="block">Checks to see if this map is scaling.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>true if this map is scaling</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="setScaling(boolean)">
|
|
<h3>setScaling</h3>
|
|
<div class="member-signature"><span class="return-type">void</span> <span class="element-name">setScaling</span><wbr><span class="parameters">(boolean value)</span></div>
|
|
<div class="block">Sets if this map is scaling or not.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>value</code> - true to scale</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="hasLocationName()">
|
|
<h3>hasLocationName</h3>
|
|
<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">hasLocationName</span>()</div>
|
|
<div class="block">Checks for existence of a location name.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>true if this has a location name</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getLocationName()">
|
|
<h3>getLocationName</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
|
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getLocationName</span>()</div>
|
|
<div class="block">Gets the location name that is set.
|
|
<p>
|
|
Plugins should check that hasLocationName() returns <code>true</code>
|
|
before calling this method.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>the location name that is set</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="setLocationName(java.lang.String)">
|
|
<h3>setLocationName</h3>
|
|
<div class="member-signature"><span class="return-type">void</span> <span class="element-name">setLocationName</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div>
|
|
<div class="block">Sets the location name. A custom map color will alter the display of the
|
|
map in an inventory slot.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>name</code> - the name to set</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="hasColor()">
|
|
<h3>hasColor</h3>
|
|
<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">hasColor</span>()</div>
|
|
<div class="block">Checks for existence of a map color.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>true if this has a custom map color</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getColor()">
|
|
<h3>getColor</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
|
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="../../Color.html" title="class in org.bukkit">Color</a></span> <span class="element-name">getColor</span>()</div>
|
|
<div class="block">Gets the map color that is set. A custom map color will alter the display
|
|
of the map in an inventory slot.
|
|
<p>
|
|
Plugins should check that hasColor() returns <code>true</code> before
|
|
calling this method.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>the map color that is set</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="setColor(org.bukkit.Color)">
|
|
<h3>setColor</h3>
|
|
<div class="member-signature"><span class="return-type">void</span> <span class="element-name">setColor</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="../../Color.html" title="class in org.bukkit">Color</a> color)</span></div>
|
|
<div class="block">Sets the map color. A custom map color will alter the display of the map
|
|
in an inventory slot.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>color</code> - the color to set</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="clone()">
|
|
<h3>clone</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="MapMeta.html" title="interface in org.bukkit.inventory.meta">MapMeta</a></span> <span class="element-name">clone</span>()</div>
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code><a href="ItemMeta.html#clone()">clone</a></code> in interface <code><a href="ItemMeta.html" title="interface in org.bukkit.inventory.meta">ItemMeta</a></code></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
</main>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|