Scissors-Website/public/javadoc/1.19.1/org/bukkit/persistence/PersistentDataHolder.html

144 lines
31 KiB
HTML
Raw Normal View History

2022-07-05 23:33:56 +00:00
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
2022-07-31 00:29:59 +00:00
<title>PersistentDataHolder (Scissors-API 1.19.1-R0.1-SNAPSHOT API)</title>
2022-07-05 23:33:56 +00:00
<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.persistence, interface: PersistentDataHolder">
<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.5.1.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>
2022-07-26 04:26:54 +00:00
<li><a href="class-use/PersistentDataHolder.html">Use</a></li>
2022-07-05 23:33:56 +00:00
<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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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>&nbsp;<a href="package-summary.html">org.bukkit.persistence</a></div>
<h1 title="Interface PersistentDataHolder" class="title">Interface PersistentDataHolder</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Known Subinterfaces:</dt>
<dd><code><a href="../entity/AbstractArrow.html" title="interface in org.bukkit.entity">AbstractArrow</a></code>, <code><a href="../entity/AbstractHorse.html" title="interface in org.bukkit.entity">AbstractHorse</a></code>, <code><a href="../entity/AbstractSkeleton.html" title="interface in org.bukkit.entity">AbstractSkeleton</a></code>, <code><a href="../entity/AbstractVillager.html" title="interface in org.bukkit.entity">AbstractVillager</a></code>, <code><a href="../entity/Ageable.html" title="interface in org.bukkit.entity">Ageable</a></code>, <code><a href="../entity/Allay.html" title="interface in org.bukkit.entity">Allay</a></code>, <code><a href="../entity/Ambient.html" title="interface in org.bukkit.entity">Ambient</a></code>, <code><a href="../entity/Animals.html" title="interface in org.bukkit.entity">Animals</a></code>, <code><a href="../entity/AreaEffectCloud.html" title="interface in org.bukkit.entity">AreaEffectCloud</a></code>, <code><a href="../entity/ArmorStand.html" title="interface in org.bukkit.entity">ArmorStand</a></code>, <code><a href="../../../com/destroystokyo/paper/inventory/meta/ArmorStandMeta.html" title="interface in com.destroystokyo.paper.inventory.meta">ArmorStandMeta</a></code>, <code><a href="../entity/Arrow.html" title="interface in org.bukkit.entity">Arrow</a></code>, <code><a href="../entity/Axolotl.html" title="interface in org.bukkit.entity">Axolotl</a></code>, <code><a href="../inventory/meta/AxolotlBucketMeta.html" title="interface in org.bukkit.inventory.meta">AxolotlBucketMeta</a></code>, <code><a href="../block/Banner.html" title="interface in org.bukkit.block">Banner</a></code>, <code><a href="../inventory/meta/BannerMeta.html" title="interface in org.bukkit.inventory.meta">BannerMeta</a></code>, <code><a href="../block/Barrel.html" title="interface in org.bukkit.block">Barrel</a></code>, <code><a href="../entity/Bat.html" title="interface in org.bukkit.entity">Bat</a></code>, <code><a href="../block/Beacon.html" title="interface in org.bukkit.block">Beacon</a></code>, <code><a href="../block/Bed.html" title="interface in org.bukkit.block">Bed</a></code>, <code><a href="../entity/Bee.html" title="interface in org.bukkit.entity">Bee</a></code>, <code><a href="../block/Beehive.html" title="interface in org.bukkit.block">Beehive</a></code>, <code><a href="../block/Bell.html" title="interface in org.bukkit.block">Bell</a></code>, <code><a href="../block/BlastFurnace.html" title="interface in org.bukkit.block">BlastFurnace</a></code>, <code><a href="../entity/Blaze.html" title="interface in org.bukkit.entity">Blaze</a></code>, <code><a href="../inventory/meta/BlockDataMeta.html" title="interface in org.bukkit.inventory.meta">BlockDataMeta</a></code>, <code><a href="../inventory/meta/BlockStateMeta.html" title="interface in org.bukkit.inventory.meta">BlockStateMeta</a></code>, <code><a href="../entity/Boat.html" title="interface in org.bukkit.entity">Boat</a></code>, <code><a href="../inventory/meta/BookMeta.html" title="interface in org.bukkit.inventory.meta">BookMeta</a></code>, <code><a href="../entity/Boss.html" title="interface in org.bukkit.entity">Boss</a></code>, <code><a href="../entity/Breedable.html" title="interface in org.bukkit.entity">Breedable</a></code>, <code><a href="../block/BrewingStand.html" title="interface in org.bukkit.block">BrewingStand</a></code>, <code><a href="../../../io/papermc/paper/entity/Bucketable.html" title="interface in io.papermc.paper.entity">Bucketable</a></code>, <code><a href="../inventory/meta/BundleMeta.html" title="interface in org.bukkit.inventory.meta">BundleMeta</a></code>, <code><a href="../block/Campfire.html" title="interface in org.bukkit.block">Campfire</a></code>, <code><a href="../entity/Cat.html" title="interface in org.bukkit.entity">Cat</a></code>, <code><a href="../entity/CaveSpider.html" title="interface in org.bukkit.entity">CaveSpider</a></code>, <code><a href="../block/Chest.html" title="interface in org.bukkit.block">Chest</a></code>, <code><a href="../entity/ChestBoat.html" title="interface in org.bukkit.entity">C
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">PersistentDataHolder</span></div>
<div class="block">The <a href="PersistentDataHolder.html" title="interface in org.bukkit.persistence"><code>PersistentDataHolder</code></a> interface defines an object that can store
custom persistent meta data on it.</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></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="PersistentDataContainer.html" title="interface in org.bukkit.persistence">PersistentDataContainer</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPersistentDataContainer()" class="member-name-link">getPersistentDataContainer</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Returns a custom tag container capable of storing tags on the object.</div>
</div>
</div>
</div>
</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="getPersistentDataContainer()">
<h3>getPersistentDataContainer</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="PersistentDataContainer.html" title="interface in org.bukkit.persistence">PersistentDataContainer</a></span>&nbsp;<span class="element-name">getPersistentDataContainer</span>()</div>
<div class="block">Returns a custom tag container capable of storing tags on the object.
Note that the tags stored on this container are all stored under their
own custom namespace therefore modifying default tags using this
<a href="PersistentDataHolder.html" title="interface in org.bukkit.persistence"><code>PersistentDataHolder</code></a> is impossible.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the persistent metadata container</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>