org.spongepowered.api.event.entity

Interface MoveEntityEvent.Teleport.Portal

All Superinterfaces:

Cancellable, Event, MoveEntityEvent, MoveEntityEvent.Teleport, TargetEntityEvent

Enclosing interface:

MoveEntityEvent.Teleport

public static interface MoveEntityEvent.Teleport.Portal
extends MoveEntityEvent.Teleport

Nested Class Summary

Nested classes/interfaces inherited from interface org.spongepowered.api.event.entity.MoveEntityEvent.Teleport

MoveEntityEvent.Teleport.Portal

Nested classes/interfaces inherited from interface org.spongepowered.api.event.entity.MoveEntityEvent

MoveEntityEvent.Position, MoveEntityEvent.Teleport

Method Summary

Modifier and Type	Method and Description
static MoveEntityEvent.Teleport.Portal	createMoveEntityEventTeleportPortal(Cause cause, Transform<World> fromTransform, Transform<World> toTransform, PortalAgent portalAgent, Entity targetEntity, boolean usePortalAgent) Deprecated.
PortalAgent	getPortalAgent() Gets the PortalAgent that will be responsible for teleporting the TargetEntityEvent.getTargetEntity() through a Portal.
boolean	getUsePortalAgent() Gets whether the PortalAgent will be used.
void	setPortalAgent(PortalAgent portalAgent) Sets the PortalAgent that will be responsible for teleporting the TargetEntityEvent.getTargetEntity() through a Portal.
void	setUsePortalAgent(boolean usePortalAgent) Sets whether the PortalAgent will be used.

Methods inherited from interface org.spongepowered.api.event.entity.MoveEntityEvent.Teleport

createMoveEntityEventTeleport, getKeepsVelocity, setKeepsVelocity

Methods inherited from interface org.spongepowered.api.event.entity.MoveEntityEvent

getFromTransform, getToTransform, setToTransform

Methods inherited from interface org.spongepowered.api.event.entity.TargetEntityEvent

getTargetEntity

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

setUsePortalAgent

void setUsePortalAgent(boolean usePortalAgent)

Sets whether the PortalAgent will be used.

If this is set to true, the PortalAgent will search for a portal at the MoveEntityEvent.getToTransform() location and will attempt to create one if not found.

If this is set to false, the TargetEntityEvent.getTargetEntity() will only be teleported to the MoveEntityEvent.getToTransform() location.

Parameters:

usePortalAgent - whether to use the portal agent

getUsePortalAgent

boolean getUsePortalAgent()

Gets whether the PortalAgent will be used.

If this is set to true, the PortalAgent will search for a Portal at the MoveEntityEvent.getToTransform() location, and will attempt to create one if not found.

If this is set to false, the TargetEntityEvent.getTargetEntity() will only be teleported to the MoveEntityEvent.getToTransform() location.

Returns:

whether to use the portal agent

getPortalAgent

PortalAgent getPortalAgent()

Gets the PortalAgent that will be responsible for teleporting the TargetEntityEvent.getTargetEntity() through a Portal.

Returns:

The portal agent

setPortalAgent

void setPortalAgent(PortalAgent portalAgent)

Sets the PortalAgent that will be responsible for teleporting the TargetEntityEvent.getTargetEntity() through a Portal.

Parameters:

portalAgent - The portal agent

createMoveEntityEventTeleportPortal

@Deprecated
static MoveEntityEvent.Teleport.Portal createMoveEntityEventTeleportPortal(Cause cause,
                                                                                       Transform<World> fromTransform,
                                                                                       Transform<World> toTransform,
                                                                                       PortalAgent portalAgent,
                                                                                       Entity targetEntity,
                                                                                       boolean usePortalAgent)

Deprecated.

This method exists solely to provide backwards-compatibility with existing plugins using the old Teleport event. It should not be called directly - instead, plugins should use SpongeEventFactory.createMoveEntityEventTeleportPortal(Cause, Transform, Transform, PortalAgent, Entity, boolean, boolean)

Parameters:

cause - The cause to use

fromTransform - The from transform

toTransform - The target transform

portalAgent - The portal agent to use

targetEntity - The entity being teleported

usePortalAgent - Whether to use the portal agent

Returns:

The event