001/*
002 * Trident - A Multithreaded Server Alternative
003 * Copyright 2014 The TridentSDK Team
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * You may obtain a copy of the License at
008 *
009 *    http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package net.tridentsdk.effect;
018
019import net.tridentsdk.entity.living.Player;
020
021/**
022 * Represents all visual, sound, particle and entity effects
023 *
024 * @author The TridentSDK Team
025 * @since 0.4-alpha
026 */
027public interface Effect<T> {
028    /**
029     * Execute the effect at the given location
030     */
031    void apply();
032
033    /**
034     * Execute the effect at the given location for specified player
035     *
036     * @param player The player to send the effect to
037     */
038    void apply(Player player);
039
040    /**
041     * Execute the effect at the given location for all players except specified player
042     *
043     * @param player The player to not send the effect to
044     */
045    void applyToEveryoneExcept(Player player);
046
047    /**
048     * The type of the effect
049     *
050     * @return The type of the effect
051     */
052    T type();
053
054    /**
055     * Set the type of the effect
056     *
057     * @param type The type of the effect
058     */
059    void setType(T type);
060}