com.pixelmonmod.pixelmon.api.events

Class TeleportItemEvent

java.lang.Object

net.minecraftforge.eventbus.api.Event

com.pixelmonmod.pixelmon.api.events.TeleportItemEvent

Direct Known Subclasses:

TeleportItemEvent.Post, TeleportItemEvent.Pre

public class TeleportItemEvent
extends net.minecraftforge.eventbus.api.Event

TeleportItemEvent is called when a TeleportItem is used, namely for things like Escape Rope, and the Ultra space and Drowned world teleporters

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TeleportItemEvent.Post Fired after the player has been teleported using an item
static class	TeleportItemEvent.Pre Fired before the teleport occurs, Level, Position and if the item is consumed can be set here to modify where the item teleports the player.

Nested classes/interfaces inherited from class net.minecraftforge.eventbus.api.Event

net.minecraftforge.eventbus.api.Event.HasResult, net.minecraftforge.eventbus.api.Event.Result

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	consumeItemStack
protected net.minecraft.item.ItemStack	itemStack
protected java.lang.String	level
protected net.minecraft.entity.player.PlayerEntity	player
protected net.minecraft.util.math.BlockPos	teleportPosition
protected boolean	teleportToSpawnpoint

Constructor Summary

Constructors

Constructor and Description
TeleportItemEvent(net.minecraft.item.ItemStack item, net.minecraft.entity.player.PlayerEntity player, java.lang.String level, net.minecraft.util.math.BlockPos teleportPosition, boolean consumeItemStack, boolean teleportToSpawnpoint)

Method Summary

Modifier and Type	Method and Description
net.minecraft.item.ItemStack	getItemStack()
java.lang.String	getLevel()
net.minecraft.entity.player.PlayerEntity	getPlayer()
net.minecraft.util.math.BlockPos	getTeleportPosition()
boolean	shouldConsumeItemStack()
boolean	shouldTeleportToSpawnpoint()

Methods inherited from class net.minecraftforge.eventbus.api.Event

getListenerList, getParentListenerList, getPhase, getResult, hasResult, isCancelable, isCanceled, setCanceled, setPhase, setResult, setup

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

itemStack

protected net.minecraft.item.ItemStack itemStack

player

protected net.minecraft.entity.player.PlayerEntity player

level

protected java.lang.String level

teleportPosition

protected net.minecraft.util.math.BlockPos teleportPosition

consumeItemStack

protected boolean consumeItemStack

teleportToSpawnpoint

protected boolean teleportToSpawnpoint

Constructor Detail

TeleportItemEvent

public TeleportItemEvent(net.minecraft.item.ItemStack item,
                         net.minecraft.entity.player.PlayerEntity player,
                         java.lang.String level,
                         net.minecraft.util.math.BlockPos teleportPosition,
                         boolean consumeItemStack,
                         boolean teleportToSpawnpoint)

Method Detail

getItemStack

public net.minecraft.item.ItemStack getItemStack()

Returns:

The itemstack causing the teleport

getPlayer

public net.minecraft.entity.player.PlayerEntity getPlayer()

Returns:

The player trying to be teleported

getLevel

public java.lang.String getLevel()

Returns:

The level the player is being teleported to

getTeleportPosition

public net.minecraft.util.math.BlockPos getTeleportPosition()

Returns:

The position in the world the player is being teleported to

shouldConsumeItemStack

public boolean shouldConsumeItemStack()

Returns:

If the itemstack should be consumed on use

shouldTeleportToSpawnpoint

public boolean shouldTeleportToSpawnpoint()

Returns:

If the player should be teleported to their spawnpoint instead - Overrides any position or world arguments.