mirror of https://github.com/Minestom/Minestom.git
172 lines
17 KiB
HTML
172 lines
17 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (21) -->
|
|
<title>EntityInstanceEvent (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: EntityInstanceEvent">
|
|
<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"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </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><a href="#method-detail">Method</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="sub-nav">
|
|
<div id="navbar-sub-list">
|
|
<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"><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> <a href="package-summary.html">net.minestom.server.event.trait</a></div>
|
|
<h1 title="Interface EntityInstanceEvent" class="title">Interface EntityInstanceEvent</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="../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></dd>
|
|
</dl>
|
|
<dl class="notes">
|
|
<dt>All Known Subinterfaces:</dt>
|
|
<dd><code><a href="PlayerInstanceEvent.html" title="interface in net.minestom.server.event.trait">PlayerInstanceEvent</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="../entity/EntityAttackEvent.html" title="class in net.minestom.server.event.entity">EntityAttackEvent</a></code>, <code><a href="../entity/EntityDamageEvent.html" title="class in net.minestom.server.event.entity">EntityDamageEvent</a></code>, <code><a href="../entity/EntityDeathEvent.html" title="class in net.minestom.server.event.entity">EntityDeathEvent</a></code>, <code><a href="../entity/EntityDespawnEvent.html" title="class in net.minestom.server.event.entity">EntityDespawnEvent</a></code>, <code><a href="../item/EntityEquipEvent.html" title="class in net.minestom.server.event.item">EntityEquipEvent</a></code>, <code><a href="../entity/EntityFireEvent.html" title="class in net.minestom.server.event.entity">EntityFireEvent</a></code>, <code><a href="../entity/EntityItemMergeEvent.html" title="class in net.minestom.server.event.entity">EntityItemMergeEvent</a></code>, <code><a href="../entity/EntityPotionAddEvent.html" title="class in net.minestom.server.event.entity">EntityPotionAddEvent</a></code>, <code><a href="../entity/EntityPotionRemoveEvent.html" title="class in net.minestom.server.event.entity">EntityPotionRemoveEvent</a></code>, <code><a href="../entity/EntityShootEvent.html" title="class in net.minestom.server.event.entity">EntityShootEvent</a></code>, <code><a href="../entity/EntitySpawnEvent.html" title="class in net.minestom.server.event.entity">EntitySpawnEvent</a></code>, <code><a href="../entity/EntityTickEvent.html" title="class in net.minestom.server.event.entity">EntityTickEvent</a></code>, <code><a href="../entity/EntityVelocityEvent.html" title="class in net.minestom.server.event.entity">EntityVelocityEvent</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="../item/PickupItemEvent.html" title="class in net.minestom.server.event.item">PickupItemEvent</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>, <code><a href="../entity/projectile/ProjectileCollideWithBlockEvent.html" title="class in net.minestom.server.event.entity.projectile">ProjectileCollideWithBlockEvent</a></code>, <code><a href="../entity/projectile/ProjectileCollideWithEntityEvent.html" title="class in net.minestom.server.event.entity.projectile">ProjectileCollideWithEntityEvent</a></code>, <code><a href="../entity/projectile/ProjectileUncollideEvent.html" title="class in net.minestom.server.event.entity.projectile">ProjectileUncollideEvent</a></code>, <code><a href="../instance/RemoveEntityFromInstanceEvent.html" title="class in net.minestom.server.event.instance">RemoveEntityFromInstanceEvent</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">EntityInstanceEvent</span><span class="extends-implements">
|
|
extends <a href="EntityEvent.html" title="interface in net.minestom.server.event.trait">EntityEvent</a>, <a href="InstanceEvent.html" title="interface in net.minestom.server.event.trait">InstanceEvent</a></span></div>
|
|
<div class="block">Represents an <a href="EntityEvent.html" title="interface in net.minestom.server.event.trait"><code>EntityEvent</code></a> which happen in <a href="../../entity/Entity.html#getInstance()"><code>Entity.getInstance()</code></a>.
|
|
Useful if you need to listen to entity events happening in its instance.
|
|
<p>
|
|
Be aware that the entity'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 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-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default Methods</button></div>
|
|
<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0">
|
|
<div class="summary-table three-column-summary">
|
|
<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-tab5"><code>default @NotNull <a href="../../instance/Instance.html" title="class in net.minestom.server.instance">Instance</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getInstance()" class="member-name-link">getInstance</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
|
|
<div class="block">Gets the instance.</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-net.minestom.server.event.trait.EntityEvent">Methods inherited from interface net.minestom.server.event.trait.<a href="EntityEvent.html" title="interface in net.minestom.server.event.trait">EntityEvent</a></h3>
|
|
<code><a href="EntityEvent.html#getEntity()">getEntity</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="getInstance()">
|
|
<h3>getInstance</h3>
|
|
<div class="member-signature"><span class="annotations">@NotNull
|
|
</span><span class="modifiers">default</span> <span class="return-type">@NotNull <a href="../../instance/Instance.html" title="class in net.minestom.server.instance">Instance</a></span> <span class="element-name">getInstance</span>()</div>
|
|
<div class="block"><span class="description-from-type-label">Description copied from interface: <code><a href="InstanceEvent.html#getInstance()">InstanceEvent</a></code></span></div>
|
|
<div class="block">Gets the instance.</div>
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code><a href="InstanceEvent.html#getInstance()">getInstance</a></code> in interface <code><a href="InstanceEvent.html" title="interface in net.minestom.server.event.trait">InstanceEvent</a></code></dd>
|
|
<dt>Returns:</dt>
|
|
<dd>instance</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
</main>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|