<dd><code><ahref="BlockState.html"title="interface in org.bukkit.block">BlockState</a></code>, <code><ahref="Lockable.html"title="interface in org.bukkit.block">Lockable</a></code>, <code><ahref="../metadata/Metadatable.html"title="interface in org.bukkit.metadata">Metadatable</a></code>, <code><ahref="../Nameable.html"title="interface in org.bukkit">Nameable</a></code>, <code><ahref="../persistence/PersistentDataHolder.html"title="interface in org.bukkit.persistence">PersistentDataHolder</a></code>, <code><ahref="TileState.html"title="interface in org.bukkit.block">TileState</a></code></dd>
extends <ahref="TileState.html"title="interface in org.bukkit.block">TileState</a>, <ahref="Lockable.html"title="interface in org.bukkit.block">Lockable</a>, <ahref="../Nameable.html"title="interface in org.bukkit">Nameable</a></span></div>
<divclass="block">Represents a captured state of a beacon.</div>
<divclass="block">Gets the effect range of this beacon.</div>
</div>
<divclass="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><ahref="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><ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html"title="class or interface in java.util"class="external-link">Collection</a><<ahref="../entity/LivingEntity.html"title="interface in org.bukkit.entity">LivingEntity</a>></code></div>
<divclass="block">Returns the list of players within the beacon's range of effect.</div>
</div>
<divclass="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><ahref="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><ahref="../potion/PotionEffect.html"title="class in org.bukkit.potion">PotionEffect</a></code></div>
<divclass="block">Returns the primary effect set on the beacon</div>
</div>
<divclass="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><ahref="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><ahref="../potion/PotionEffect.html"title="class in org.bukkit.potion">PotionEffect</a></code></div>
<divclass="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><ahref="#setPrimaryEffect(org.bukkit.potion.PotionEffectType)"class="member-name-link">setPrimaryEffect</a><wbr>(<ahref="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><ahref="../potion/PotionEffectType.html"title="class in org.bukkit.potion">PotionEffectType</a> effect)</code></div>
<divclass="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><ahref="#setSecondaryEffect(org.bukkit.potion.PotionEffectType)"class="member-name-link">setSecondaryEffect</a><wbr>(<ahref="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><ahref="../potion/PotionEffectType.html"title="class in org.bukkit.potion">PotionEffectType</a> effect)</code></div>
<divclass="block">Set the secondary effect on this beacon, or null to clear.</div>
</div>
</div>
</div>
</div>
<divclass="inherited-list">
<h3id="methods-inherited-from-class-org.bukkit.block.BlockState">Methods inherited from interface org.bukkit.block.<ahref="BlockState.html"title="interface in org.bukkit.block">BlockState</a></h3>
<h3id="methods-inherited-from-class-org.bukkit.block.Lockable">Methods inherited from interface org.bukkit.block.<ahref="Lockable.html"title="interface in org.bukkit.block">Lockable</a></h3>
<h3id="methods-inherited-from-class-org.bukkit.metadata.Metadatable">Methods inherited from interface org.bukkit.metadata.<ahref="../metadata/Metadatable.html"title="interface in org.bukkit.metadata">Metadatable</a></h3>
<h3id="methods-inherited-from-class-org.bukkit.Nameable">Methods inherited from interface org.bukkit.<ahref="../Nameable.html"title="interface in org.bukkit">Nameable</a></h3>
<h3id="methods-inherited-from-class-org.bukkit.block.TileState">Methods inherited from interface org.bukkit.block.<ahref="TileState.html"title="interface in org.bukkit.block">TileState</a></h3>
<divclass="member-signature"><spanclass="annotations"><ahref="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><spanclass="return-type"><ahref="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><ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html"title="class or interface in java.util"class="external-link">Collection</a><<ahref="../entity/LivingEntity.html"title="interface in org.bukkit.entity">LivingEntity</a>></span> <spanclass="element-name">getEntitiesInRange</span>()</div>
<divclass="block">Returns the list of players within the beacon's range of effect.
<p>
This will return an empty list if the block represented by this state is
no longer a beacon.</div>
<dlclass="notes">
<dt>Returns:</dt>
<dd>the players in range</dd>
<dt>Throws:</dt>
<dd><code><ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalStateException.html"title="class or interface in java.lang"class="external-link">IllegalStateException</a></code> - if this block state is not placed</dd>
<divclass="block">Returns the tier of the beacon pyramid (0-4). The tier refers to the
beacon's power level, based on how many layers of blocks are in the
pyramid. Tier 1 refers to a beacon with one layer of 9 blocks under it.</div>
<dlclass="notes">
<dt>Returns:</dt>
<dd>the beacon tier</dd>
</dl>
</section>
</li>
<li>
<sectionclass="detail"id="getPrimaryEffect()">
<h3>getPrimaryEffect</h3>
<divclass="member-signature"><spanclass="annotations"><ahref="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><spanclass="return-type"><ahref="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><ahref="../potion/PotionEffect.html"title="class in org.bukkit.potion">PotionEffect</a></span> <spanclass="element-name">getPrimaryEffect</span>()</div>
<divclass="block">Returns the primary effect set on the beacon</div>
<divclass="member-signature"><spanclass="return-type">void</span> <spanclass="element-name">setPrimaryEffect</span><wbr><spanclass="parameters">(<ahref="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>
<ahref="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><ahref="../potion/PotionEffectType.html"title="class in org.bukkit.potion">PotionEffectType</a> effect)</span></div>
<divclass="block">Set the primary effect on this beacon, or null to clear.</div>
<dlclass="notes">
<dt>Parameters:</dt>
<dd><code>effect</code> - new primary effect</dd>
</dl>
</section>
</li>
<li>
<sectionclass="detail"id="getSecondaryEffect()">
<h3>getSecondaryEffect</h3>
<divclass="member-signature"><spanclass="annotations"><ahref="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><spanclass="return-type"><ahref="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><ahref="../potion/PotionEffect.html"title="class in org.bukkit.potion">PotionEffect</a></span> <spanclass="element-name">getSecondaryEffect</span>()</div>
<divclass="block">Returns the secondary effect set on the beacon.</div>
<dlclass="notes">
<dt>Returns:</dt>
<dd>the secondary effect or null if no secondary effect</dd>
<divclass="member-signature"><spanclass="return-type">void</span> <spanclass="element-name">setSecondaryEffect</span><wbr><spanclass="parameters">(<ahref="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>
<ahref="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><ahref="../potion/PotionEffectType.html"title="class in org.bukkit.potion">PotionEffectType</a> effect)</span></div>
<divclass="block">Set the secondary effect on this beacon, or null to clear. Note that tier
must be >= 4 for this effect to be active.</div>
<divclass="block">Gets the effect range of this beacon.
A negative range value means the beacon is using its default range based on tier.</div>
<dlclass="notes">
<dt>Returns:</dt>
<dd>Either the custom range set with <ahref="#setEffectRange(double)"><code>setEffectRange(double)</code></a> or the range based on the beacon tier.</dd>