<divclass="inheritance"title="Inheritance Tree"><ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html"title="class or interface in java.lang"class="external-link">java.lang.Object</a>
<divclass="inheritance"><ahref="../../../../../org/bukkit/event/Event.html"title="class in org.bukkit.event">org.bukkit.event.Event</a>
<divclass="inheritance"><ahref="../../../../../org/bukkit/event/player/PlayerEvent.html"title="class in org.bukkit.event.player">org.bukkit.event.player.PlayerEvent</a>
<dd><code><ahref="../../../../../org/bukkit/event/Cancellable.html"title="interface in org.bukkit.event">Cancellable</a></code></dd>
</dl>
<hr>
<divclass="type-signature"><spanclass="modifiers">public class </span><spanclass="element-name type-name-label">PlayerSetSpawnEvent</span>
<spanclass="extends-implements">extends <ahref="../../../../../org/bukkit/event/player/PlayerEvent.html"title="class in org.bukkit.event.player">PlayerEvent</a>
implements <ahref="../../../../../org/bukkit/event/Cancellable.html"title="interface in org.bukkit.event">Cancellable</a></span></div>
<divclass="block">Called when a player's spawn is set, either by themselves or otherwise.<br>
Cancelling this event will prevent the spawn from being set.</div>
<divclass="col-second even-row-color"><code><ahref="PlayerSetSpawnEvent.Cause.html"class="type-name-link"title="enum class in com.destroystokyo.paper.event.player">PlayerSetSpawnEvent.Cause</a></code></div>
<divclass="col-last even-row-color"> </div>
</div>
<divclass="inherited-list">
<h2id="nested-classes-inherited-from-class-org.bukkit.event.Event">Nested classes/interfaces inherited from class org.bukkit.event.<ahref="../../../../../org/bukkit/event/Event.html"title="class in org.bukkit.event">Event</a></h2>
<code><ahref="../../../../../org/bukkit/event/Event.Result.html"title="enum class in org.bukkit.event">Event.Result</a></code></div>
</section>
</li>
<!-- =========== FIELD SUMMARY =========== -->
<li>
<sectionclass="field-summary"id="field-summary">
<h2>Field Summary</h2>
<divclass="inherited-list">
<h3id="fields-inherited-from-class-org.bukkit.event.player.PlayerEvent">Fields inherited from class org.bukkit.event.player.<ahref="../../../../../org/bukkit/event/player/PlayerEvent.html"title="class in org.bukkit.event.player">PlayerEvent</a></h3>
<divclass="col-constructor-name even-row-color"><code><ahref="#%3Cinit%3E(org.bukkit.entity.Player,com.destroystokyo.paper.event.player.PlayerSetSpawnEvent.Cause,org.bukkit.Location,boolean,boolean,net.kyori.adventure.text.Component)"class="member-name-link">PlayerSetSpawnEvent</a><wbr>(<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="../../../../../org/bukkit/entity/Player.html"title="interface in org.bukkit.entity">Player</a> who,
<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="PlayerSetSpawnEvent.Cause.html"title="enum class in com.destroystokyo.paper.event.player">PlayerSetSpawnEvent.Cause</a> cause,
<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="../../../../../org/bukkit/Location.html"title="class in org.bukkit">Location</a> location,
boolean forced,
boolean notifyPlayer,
<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://jd.adventure.kyori.net/api/4.11.0/net/kyori/adventure/text/Component.html"title="class or interface in net.kyori.adventure.text"class="external-link">Component</a> notification)</code></div>
<divclass="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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="PlayerSetSpawnEvent.Cause.html"title="enum class in com.destroystokyo.paper.event.player">PlayerSetSpawnEvent.Cause</a></code></div>
<divclass="block">Gets the cause of this event.</div>
</div>
<divclass="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <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="../../../../../org/bukkit/event/HandlerList.html"title="class in org.bukkit.event">HandlerList</a></code></div>
<divclass="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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="../../../../../org/bukkit/event/HandlerList.html"title="class in org.bukkit.event">HandlerList</a></code></div>
<divclass="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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="../../../../../org/bukkit/Location.html"title="class in org.bukkit">Location</a></code></div>
<divclass="block">Gets the location that the spawn is set to.</div>
</div>
<divclass="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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="https://jd.adventure.kyori.net/api/4.11.0/net/kyori/adventure/text/Component.html"title="class or interface in net.kyori.adventure.text"class="external-link">Component</a></code></div>
<divclass="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><ahref="#setLocation(org.bukkit.Location)"class="member-name-link">setLocation</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="../../../../../org/bukkit/Location.html"title="class in org.bukkit">Location</a> location)</code></div>
<divclass="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><ahref="#setNotification(net.kyori.adventure.text.Component)"class="member-name-link">setNotification</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="https://jd.adventure.kyori.net/api/4.11.0/net/kyori/adventure/text/Component.html"title="class or interface in net.kyori.adventure.text"class="external-link">Component</a> notification)</code></div>
<divclass="block">Gets if this action will notify the player their spawn
has been set.</div>
</div>
</div>
</div>
</div>
<divclass="inherited-list">
<h3id="methods-inherited-from-class-org.bukkit.event.player.PlayerEvent">Methods inherited from class org.bukkit.event.player.<ahref="../../../../../org/bukkit/event/player/PlayerEvent.html"title="class in org.bukkit.event.player">PlayerEvent</a></h3>
<h3id="methods-inherited-from-class-org.bukkit.event.Event">Methods inherited from class org.bukkit.event.<ahref="../../../../../org/bukkit/event/Event.html"title="class in org.bukkit.event">Event</a></h3>
<h3id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html"title="class or interface in java.lang"class="external-link">Object</a></h3>
<code><ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()"title="class or interface in java.lang"class="external-link">clone</a>, <ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)"title="class or interface in java.lang"class="external-link">equals</a>, <ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()"title="class or interface in java.lang"class="external-link">finalize</a>, <ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()"title="class or interface in java.lang"class="external-link">getClass</a>, <ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()"title="class or interface in java.lang"class="external-link">hashCode</a>, <ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()"title="class or interface in java.lang"class="external-link">notify</a>, <ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()"title="class or interface in java.lang"class="external-link">notifyAll</a>, <ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()"title="class or interface in java.lang"class="external-link">toString</a>, <ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()"title="class or interface in java.lang"class="external-link">wait</a>, <ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)"title="class or interface in java.lang"class="external-link">wait</a>, <ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)"title="class or interface in java.lang"class="external-link">wait</a></code></div>
<divclass="member-signature"><spanclass="modifiers">public</span> <spanclass="element-name">PlayerSetSpawnEvent</span><wbr><spanclass="parameters">(<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://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="../../../../../org/bukkit/entity/Player.html"title="interface in org.bukkit.entity">Player</a> who,
<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://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="PlayerSetSpawnEvent.Cause.html"title="enum class in com.destroystokyo.paper.event.player">PlayerSetSpawnEvent.Cause</a> cause,
<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="../../../../../org/bukkit/Location.html"title="class in org.bukkit">Location</a> location,
boolean forced,
boolean notifyPlayer,
<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="https://jd.adventure.kyori.net/api/4.11.0/net/kyori/adventure/text/Component.html"title="class or interface in net.kyori.adventure.text"class="external-link">Component</a> notification)</span></div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<sectionclass="method-details"id="method-detail">
<h2>Method Details</h2>
<ulclass="member-list">
<li>
<sectionclass="detail"id="getCause()">
<h3>getCause</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="modifiers">public</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="PlayerSetSpawnEvent.Cause.html"title="enum class in com.destroystokyo.paper.event.player">PlayerSetSpawnEvent.Cause</a></span> <spanclass="element-name">getCause</span>()</div>
<divclass="block">Gets the cause of this event.</div>
<dlclass="notes">
<dt>Returns:</dt>
<dd>the cause</dd>
</dl>
</section>
</li>
<li>
<sectionclass="detail"id="getLocation()">
<h3>getLocation</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="modifiers">public</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="../../../../../org/bukkit/Location.html"title="class in org.bukkit">Location</a></span> <spanclass="element-name">getLocation</span>()</div>
<divclass="block">Gets the location that the spawn is set to. The yaw
of this location is the spawn angle. Mutating this location
will change the resulting spawn point of the player. Use
<ahref="../../../../../org/bukkit/Location.html#clone()"><code>Location.clone()</code></a> to get a copy of this location.</div>
<dlclass="notes">
<dt>Returns:</dt>
<dd>the spawn location, or null if removing the location</dd>
<divclass="member-signature"><spanclass="modifiers">public</span> <spanclass="return-type">void</span> <spanclass="element-name">setLocation</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="../../../../../org/bukkit/Location.html"title="class in org.bukkit">Location</a> location)</span></div>
<divclass="block">Sets the location to be set as the spawn location. The yaw
of this location is the spawn angle.</div>
<dlclass="notes">
<dt>Parameters:</dt>
<dd><code>location</code> - the spawn location, or null to remove the spawn location</dd>
<divclass="block">Sets if this action will notify the player that their spawn
has been set.</div>
<dlclass="notes">
<dt>Parameters:</dt>
<dd><code>notifyPlayer</code> - true to notify</dd>
</dl>
</section>
</li>
<li>
<sectionclass="detail"id="getNotification()">
<h3>getNotification</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="modifiers">public</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="https://jd.adventure.kyori.net/api/4.11.0/net/kyori/adventure/text/Component.html"title="class or interface in net.kyori.adventure.text"class="external-link">Component</a></span> <spanclass="element-name">getNotification</span>()</div>
<divclass="block">Gets the notification message that will be sent to the player
if <ahref="#willNotifyPlayer()"><code>willNotifyPlayer()</code></a> returns true.</div>
<divclass="member-signature"><spanclass="modifiers">public</span> <spanclass="return-type">void</span> <spanclass="element-name">setNotification</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="https://jd.adventure.kyori.net/api/4.11.0/net/kyori/adventure/text/Component.html"title="class or interface in net.kyori.adventure.text"class="external-link">Component</a> notification)</span></div>
<divclass="block">Sets the notification message that will be sent to the player.</div>
<dlclass="notes">
<dt>Parameters:</dt>
<dd><code>notification</code> - null to send no message</dd>
<divclass="block"><spanclass="descfrm-type-label">Description copied from interface: <code><ahref="../../../../../org/bukkit/event/Cancellable.html#isCancelled()">Cancellable</a></code></span></div>
<divclass="block">Gets the cancellation state of this event. A cancelled event will not
be executed in the server, but will still pass to other plugins</div>
<dlclass="notes">
<dt>Specified by:</dt>
<dd><code><ahref="../../../../../org/bukkit/event/Cancellable.html#isCancelled()">isCancelled</a></code> in interface <code><ahref="../../../../../org/bukkit/event/Cancellable.html"title="interface in org.bukkit.event">Cancellable</a></code></dd>
<divclass="block"><spanclass="descfrm-type-label">Description copied from interface: <code><ahref="../../../../../org/bukkit/event/Cancellable.html#setCancelled(boolean)">Cancellable</a></code></span></div>
<divclass="block">Sets the cancellation state of this event. A cancelled event will not
be executed in the server, but will still pass to other plugins.</div>
<dlclass="notes">
<dt>Specified by:</dt>
<dd><code><ahref="../../../../../org/bukkit/event/Cancellable.html#setCancelled(boolean)">setCancelled</a></code> in interface <code><ahref="../../../../../org/bukkit/event/Cancellable.html"title="interface in org.bukkit.event">Cancellable</a></code></dd>
<dt>Parameters:</dt>
<dd><code>cancel</code> - true if you wish to cancel this event</dd>
</dl>
</section>
</li>
<li>
<sectionclass="detail"id="getHandlers()">
<h3>getHandlers</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="modifiers">public</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="../../../../../org/bukkit/event/HandlerList.html"title="class in org.bukkit.event">HandlerList</a></span> <spanclass="element-name">getHandlers</span>()</div>
<dlclass="notes">
<dt>Specified by:</dt>
<dd><code><ahref="../../../../../org/bukkit/event/Event.html#getHandlers()">getHandlers</a></code> in class <code><ahref="../../../../../org/bukkit/event/Event.html"title="class in org.bukkit.event">Event</a></code></dd>
</dl>
</section>
</li>
<li>
<sectionclass="detail"id="getHandlerList()">
<h3>getHandlerList</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="modifiers">public static</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="../../../../../org/bukkit/event/HandlerList.html"title="class in org.bukkit.event">HandlerList</a></span> <spanclass="element-name">getHandlerList</span>()</div>