org.spongepowered.api.event.Order Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of spongeapi Show documentation
Show all versions of spongeapi Show documentation
A plugin API for Minecraft: Java Edition
/*
* 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;
/**
* Order that {@link Listener}d methods may be registered at.
*
* Event handlers are called the order given in the following table.
*
*
* Order Recommendations
* Order
* Recommendation PRE
* Initialisation and registration actions AFTER_PRE
* Immediate responses to actions in PRE FIRST
*
* Cancellation by protection plugins for informational purposes
*
* EARLY
* Standard actions that should happen before other plugins react to
* the event
* DEFAULT
* The default action order LATE
* Standard actions that should happen after other plugins react to
* the event
* LAST
* Final cancellation by protection plugins BEFORE_POST
* Actions that need to respond to cancelled events before POST
* POST
* Actions that need to react to the final and stable effects of
* event
*
*/
public enum Order {
/**
* The order point of PRE handles setting up things that need to be done
* before other things are handled.
*/
PRE,
/**
* The order point of AFTER_PRE handles things that need to be done after
* PRE.
*/
AFTER_PRE,
/**
* The order point of FIRST handles cancellation by protection plugins for
* informational responses.
*/
FIRST,
/**
* The order point of EARLY handles standard actions that need to be done
* before other plugins.
*/
EARLY,
/**
* The order point of DEFAULT handles just standard event handlings, you
* should use this unless you know you need otherwise.
*/
DEFAULT,
/**
* The order point of LATE handles standard actions that need to be done
* after other plugins.
*/
LATE,
/**
* The order point of LAST handles last minute cancellations by protection
* plugins.
*/
LAST,
/**
* The order point of BEFORE_POST handles preparation for things needing
* to be done in post.
*/
BEFORE_POST,
/**
* The order point of POST handles last minute things and monitoring
* of events for rollback or logging.
*/
POST
}