Minestom/net/minestom/server/event/trait/PlayerInstanceEvent.html

129 lines
12 KiB
HTML

<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (21) -->
<title>PlayerInstanceEvent (minestom dev 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: net.minestom.server.event.trait, interface: PlayerInstanceEvent">
<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">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-3.6.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 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"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
<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="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>
<ul class="sub-nav-list-small">
<li>
<p>Summary:</p>
<ul>
<li>Nested</li>
<li>Field</li>
<li>Constr</li>
<li><a href="#method-summary">Method</a></li>
</ul>
</li>
<li>
<p>Detail:</p>
<ul>
<li>Field</li>
<li>Constr</li>
<li>Method</li>
</ul>
</li>
</ul>
</div>
<div class="sub-nav">
<div id="navbar-sub-list">
<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>Method</li>
</ul>
</div>
<div class="nav-list-search"><a href="../../../../../search.html">SEARCH</a>
<input type="text" id="search-input" disabled placeholder="Search">
<input type="reset" id="reset-button" disabled value="reset">
</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">net.minestom.server.event.trait</a></div>
<h1 title="Interface PlayerInstanceEvent" class="title">Interface PlayerInstanceEvent</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Superinterfaces:</dt>
<dd><code><a href="EntityEvent.html" title="interface in net.minestom.server.event.trait">EntityEvent</a></code>, <code><a href="EntityInstanceEvent.html" title="interface in net.minestom.server.event.trait">EntityInstanceEvent</a></code>, <code><a href="../Event.html" title="interface in net.minestom.server.event">Event</a></code>, <code><a href="InstanceEvent.html" title="interface in net.minestom.server.event.trait">InstanceEvent</a></code>, <code><a href="PlayerEvent.html" title="interface in net.minestom.server.event.trait">PlayerEvent</a></code></dd>
</dl>
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="../player/AdvancementTabEvent.html" title="class in net.minestom.server.event.player">AdvancementTabEvent</a></code>, <code><a href="../book/EditBookEvent.html" title="class in net.minestom.server.event.book">EditBookEvent</a></code>, <code><a href="../inventory/InventoryClickEvent.html" title="class in net.minestom.server.event.inventory">InventoryClickEvent</a></code>, <code><a href="../inventory/InventoryCloseEvent.html" title="class in net.minestom.server.event.inventory">InventoryCloseEvent</a></code>, <code><a href="../inventory/InventoryOpenEvent.html" title="class in net.minestom.server.event.inventory">InventoryOpenEvent</a></code>, <code><a href="../inventory/InventoryPreClickEvent.html" title="class in net.minestom.server.event.inventory">InventoryPreClickEvent</a></code>, <code><a href="../item/ItemDropEvent.html" title="class in net.minestom.server.event.item">ItemDropEvent</a></code>, <code><a href="../item/ItemUpdateStateEvent.html" title="class in net.minestom.server.event.item">ItemUpdateStateEvent</a></code>, <code><a href="../item/PickupExperienceEvent.html" title="class in net.minestom.server.event.item">PickupExperienceEvent</a></code>, <code><a href="../player/PlayerBlockBreakEvent.html" title="class in net.minestom.server.event.player">PlayerBlockBreakEvent</a></code>, <code><a href="../player/PlayerBlockInteractEvent.html" title="class in net.minestom.server.event.player">PlayerBlockInteractEvent</a></code>, <code><a href="../player/PlayerBlockPlaceEvent.html" title="class in net.minestom.server.event.player">PlayerBlockPlaceEvent</a></code>, <code><a href="../player/PlayerCancelDiggingEvent.html" title="class in net.minestom.server.event.player">PlayerCancelDiggingEvent</a></code>, <code><a href="../player/PlayerChangeHeldSlotEvent.html" title="class in net.minestom.server.event.player">PlayerChangeHeldSlotEvent</a></code>, <code><a href="../player/PlayerChatEvent.html" title="class in net.minestom.server.event.player">PlayerChatEvent</a></code>, <code><a href="../player/PlayerChunkLoadEvent.html" title="class in net.minestom.server.event.player">PlayerChunkLoadEvent</a></code>, <code><a href="../player/PlayerChunkUnloadEvent.html" title="class in net.minestom.server.event.player">PlayerChunkUnloadEvent</a></code>, <code><a href="../player/PlayerCommandEvent.html" title="class in net.minestom.server.event.player">PlayerCommandEvent</a></code>, <code><a href="../player/PlayerDeathEvent.html" title="class in net.minestom.server.event.player">PlayerDeathEvent</a></code>, <code><a href="../player/PlayerDisconnectEvent.html" title="class in net.minestom.server.event.player">PlayerDisconnectEvent</a></code>, <code><a href="../player/PlayerEatEvent.html" title="class in net.minestom.server.event.player">PlayerEatEvent</a></code>, <code><a href="../player/PlayerEntityInteractEvent.html" title="class in net.minestom.server.event.player">PlayerEntityInteractEvent</a></code>, <code><a href="../player/PlayerFinishDiggingEvent.html" title="class in net.minestom.server.event.player">PlayerFinishDiggingEvent</a></code>, <code><a href="../player/PlayerGameModeChangeEvent.html" title="class in net.minestom.server.event.player">PlayerGameModeChangeEvent</a></code>, <code><a href="../player/PlayerHandAnimationEvent.html" title="class in net.minestom.server.event.player">PlayerHandAnimationEvent</a></code>, <code><a href="../inventory/PlayerInventoryItemChangeEvent.html" title="class in net.minestom.server.event.inventory">PlayerInventoryItemChangeEvent</a></code>, <code><a href="../player/PlayerItemAnimationEvent.html" title="class in net.minestom.server.event.player">PlayerItemAnimationEvent</a></code>, <code><a href="../player/PlayerMoveEvent.html" title="class in net.minestom.server.event.player">PlayerMoveEvent</a></code>, <code><a href="../player/PlayerPacketEvent.html" title="class in net.minestom.server.event.player">PlayerPacketEvent</a></code>, <code><a href="../player/PlayerPluginMessageEvent.html" title="class in net.minestom.server.event.player">PlayerPluginMessageEvent</a></code>, <code><a href="../player/PlayerPreEatEvent.html" title="class in net.minestom.server.event.player">PlayerPreEatEvent</a></code>, <code><a href="../player/PlayerSpawnEvent.html" title="class in net.minestom.server.event.player">PlayerSpawnEvent</a></code>, <code><a href="../player/PlayerStartDiggingEvent.html" title="class in net.minestom.server.event.player">PlayerStartDiggingEvent</a></code>, <code><a href="../player/PlayerStartFlyingEvent.html" title="class in net.minestom.server.event.player">PlayerStartFlyingEvent</a></code>, <code><a href="../player/PlayerStartFlyingWithElytraEvent.html" title="class in net.minestom.server.event.player">PlayerStartFlyingWithElytraEvent</a></code>, <code><a href="../player/PlayerStartSneakingEvent.html" title="class in net.minestom.server.event.player">PlayerStartSneakingEvent</a></code>, <code><a href="../player/PlayerStartSprintingEvent.html" title="class in net.minestom.server.event.player">PlayerStartSprintingEvent</a></code>, <code><a href="../player/PlayerStopFlyingEvent.html" title="class in net.minestom.server.event.player">PlayerStopFlyingEvent</a></code>, <code><a href="../player/PlayerStopFlyingWithElytraEvent.html" title="class in net.minestom.server.event.player">PlayerStopFlyingWithElytraEvent</a></code>, <code><a href="../player/PlayerStopSneakingEvent.html" title="class in net.minestom.server.event.player">PlayerStopSneakingEvent</a></code>, <code><a href="../player/PlayerStopSprintingEvent.html" title="class in net.minestom.server.event.player">PlayerStopSprintingEvent</a></code>, <code><a href="../player/PlayerSwapItemEvent.html" title="class in net.minestom.server.event.player">PlayerSwapItemEvent</a></code>, <code><a href="../player/PlayerTickEvent.html" title="class in net.minestom.server.event.player">PlayerTickEvent</a></code>, <code><a href="../player/PlayerUseItemEvent.html" title="class in net.minestom.server.event.player">PlayerUseItemEvent</a></code>, <code><a href="../player/PlayerUseItemOnBlockEvent.html" title="class in net.minestom.server.event.player">PlayerUseItemOnBlockEvent</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="annotations">@Internal
@Experimental
</span><span class="modifiers">public interface </span><span class="element-name type-name-label">PlayerInstanceEvent</span><span class="extends-implements">
extends <a href="PlayerEvent.html" title="interface in net.minestom.server.event.trait">PlayerEvent</a>, <a href="EntityInstanceEvent.html" title="interface in net.minestom.server.event.trait">EntityInstanceEvent</a></span></div>
<div class="block">Represents an <a href="PlayerEvent.html" title="interface in net.minestom.server.event.trait"><code>PlayerEvent</code></a> which happen in <a href="../../entity/Entity.html#getInstance()"><code>Entity.getInstance()</code></a>.
Useful if you need to listen to player events happening in its instance.
<p>
Be aware that the player's instance must be non-null.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-net.minestom.server.event.trait.EntityInstanceEvent">Methods inherited from interface&nbsp;net.minestom.server.event.trait.<a href="EntityInstanceEvent.html" title="interface in net.minestom.server.event.trait">EntityInstanceEvent</a></h3>
<code><a href="EntityInstanceEvent.html#getInstance()">getInstance</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-net.minestom.server.event.trait.PlayerEvent">Methods inherited from interface&nbsp;net.minestom.server.event.trait.<a href="PlayerEvent.html" title="interface in net.minestom.server.event.trait">PlayerEvent</a></h3>
<code><a href="PlayerEvent.html#getEntity()">getEntity</a>, <a href="PlayerEvent.html#getPlayer()">getPlayer</a></code></div>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>