io.github.nucleuspowered.nucleus.api.module.spawn.event

Interface NucleusSendToSpawnEvent

All Superinterfaces:

org.spongepowered.api.event.Cancellable, org.spongepowered.api.event.Event, org.spongepowered.api.event.user.TargetUserEvent

public interface NucleusSendToSpawnEvent
extends org.spongepowered.api.event.user.TargetUserEvent, org.spongepowered.api.event.Cancellable

Called when Nucleus has been requested to send a User to spawn, either now, or on their next login.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	NucleusSendToSpawnEvent.Type The type of the spawn event.

Method Summary

Modifier and Type	Method and Description
org.spongepowered.api.entity.Transform<org.spongepowered.api.world.World>	getOriginalTransformTo() The original Transform Nucleus was going to send the User to, in the event it's changed.
org.spongepowered.api.entity.living.player.User	getTargetUser() The User being spawned.
org.spongepowered.api.entity.Transform<org.spongepowered.api.world.World>	getTransformTo() The Transform to send the User to.
void	setCancelReason(java.lang.String reason) If cancelled, the reason to return to the requestee.
void	setTransformTo(org.spongepowered.api.entity.Transform<org.spongepowered.api.world.World> transform) The Transform to redirect the User to.

Methods inherited from interface org.spongepowered.api.event.Event

getCause, getContext, getSource

Methods inherited from interface org.spongepowered.api.event.Cancellable

isCancelled, setCancelled

Method Detail

getTransformTo

org.spongepowered.api.entity.Transform<org.spongepowered.api.world.World> getTransformTo()

The Transform to send the User to.

Returns:

The Transform

getOriginalTransformTo

org.spongepowered.api.entity.Transform<org.spongepowered.api.world.World> getOriginalTransformTo()

The original Transform Nucleus was going to send the User to, in the event it's changed.

Returns:

The Transform

setTransformTo

void setTransformTo(org.spongepowered.api.entity.Transform<org.spongepowered.api.world.World> transform)

The Transform to redirect the User to.

Parameters:

transform - The Transform

setCancelReason

void setCancelReason(java.lang.String reason)

If cancelled, the reason to return to the requestee.

Parameters:

reason - The reason for cancelling.

getTargetUser

org.spongepowered.api.entity.living.player.User getTargetUser()

The User being spawned.

Specified by:

getTargetUser in interface org.spongepowered.api.event.user.TargetUserEvent

Returns:

The User