org.spongepowered.api.event.entity.ChangeEntityWorldEvent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spongeapi Show documentation
A plugin API for Minecraft: Java Edition
The newest version!
/*
 * This file is part of SpongeAPI, licensed under the MIT License (MIT).
 *
 * Copyright (c) SpongePowered 
 * Copyright (c) contributors
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.spongepowered.api.event.entity;

import org.spongepowered.api.entity.Entity;
import org.spongepowered.api.entity.living.player.server.ServerPlayer;
import org.spongepowered.api.event.Cancellable;
import org.spongepowered.api.event.Event;
import org.spongepowered.api.util.annotation.eventgen.AbsoluteSortPosition;
import org.spongepowered.api.world.server.ServerWorld;

/**
 * Called when an {@link Entity} is changing {@link ServerWorld worlds}.
 */
public interface ChangeEntityWorldEvent extends Event {

    /**
     * Gets the {@link Entity}.
     *
     * @return The entity
     */
    @AbsoluteSortPosition(1)
    Entity entity();

    /**
     * Gets the {@link ServerWorld world} the {@link Entity} is coming from.
     *
     * One thing to keep in mind is that an implementation may choose to unload worlds, for any reason.
     * Our API guarantees that the destination world will be loaded but we give no guarantee that the
     * origin world is. With that in mind, we highly recommend you check {@link ServerWorld#isLoaded()} before
     * interacting with this world in any manner.
     *
     * @return The world
     */
    @AbsoluteSortPosition(2)
    ServerWorld originalWorld();

    /**
     * Gets the {@link ServerWorld world} the {@link Entity} originally was going to.
     *
     * @return The world
     */
    @AbsoluteSortPosition(3)
    ServerWorld originalDestinationWorld();

    /**
     * Gets the {@link ServerWorld world} the {@link Entity} will be going to.
     *
     * @return The world
     */
    @AbsoluteSortPosition(4)
    ServerWorld destinationWorld();

    interface Pre extends ChangeEntityWorldEvent, Cancellable {

        /**
         * Sets the {@link ServerWorld world} this {@link Entity} will go to.
         *
         * @param world The world
         */
        void setDestinationWorld(ServerWorld world);
    }

    interface Reposition extends ChangeEntityWorldEvent, MoveEntityEvent {}

    interface Post extends ChangeEntityWorldEvent {}
}