org.spongepowered.api.event.advancement.CriterionEvent 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
There is a newer version: 9.0.0
/*
 * 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.advancement;

import org.spongepowered.api.advancement.criteria.AdvancementCriterion;
import org.spongepowered.api.advancement.criteria.ScoreAdvancementCriterion;
import org.spongepowered.api.advancement.criteria.trigger.FilteredTrigger;
import org.spongepowered.api.advancement.criteria.trigger.FilteredTriggerConfiguration;
import org.spongepowered.api.event.Cancellable;
import org.spongepowered.api.event.Cause;
import org.spongepowered.api.event.GenericEvent;
import org.spongepowered.api.scoreboard.criteria.Criterion;

import java.time.Instant;

/**
 * A base event for {@link AdvancementCriterion} related events.
 */
public interface CriterionEvent extends AdvancementEvent {

    /**
     * Gets the {@link AdvancementCriterion} that was met.
     *
     * @return The criterion
     */
    AdvancementCriterion criterion();

    /**
     * Is called when a {@link AdvancementCriterion} is granted/unlocked.
     *
     * The {@link Cause} in vanilla minecraft may contain the {@link Trigger}
     * that caused this event to happen, other methods to trigger the event
     * are through commands or the api.
     */
    interface Grant extends CriterionEvent, Cancellable {

        /**
         * Gets the {@link Instant} at which the {@link AdvancementCriterion}
         * was unlocked.
         *
         * @return The time instant
         */
        Instant time();
    }

    /**
     * Is called when a {@link AdvancementCriterion} is revoked.
     */
    interface Revoke extends CriterionEvent, Cancellable {
    }

    /**
     * A base event for {@link ScoreAdvancementCriterion} related events.
     */
    interface Score extends CriterionEvent {

        @Override
        ScoreAdvancementCriterion criterion();

        /**
         * Is called when the score of a {@link ScoreAdvancementCriterion}
         * changes.
         */
        interface Change extends Score, Cancellable {

            /**
             * Gets the previous score.
             *
             * @return The previous score
             */
            int previousScore();

            /**
             * Gets the new score.
             *
             * @return The new score
             */
            int newScore();
        }

        /**
         * Is called when the score of a {@link ScoreAdvancementCriterion}
         * changes and results into granting the criterion.
         */
        interface Grant extends Change, CriterionEvent.Grant {
        }

        /**
         * Is called when the score of a {@link ScoreAdvancementCriterion}
         * changes and results into revoking the criterion.
         */
        interface Revoke extends Change, CriterionEvent.Revoke {
        }
    }

    /**
     * Is called when a {@link FilteredTrigger} is
     * being processed for a specific {@link Criterion}.
     */
    interface Trigger extends CriterionEvent, GenericEvent {

        /**
         * Gets the {@link FilteredTrigger}
         * that is being processed.
         *
         * @return The trigger
         */
        FilteredTrigger trigger();

        /**
         * Gets the result of the trigger event.
         *
         * @return The result
         */
        boolean result();

        /**
         * Sets the result of the trigger event.
         *
         * @param result The result
         */
        void setResult(boolean result);
    }
}