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.visual;
018
019import net.tridentsdk.effect.RemoteEffect;
020
021/**
022 * Represents a visual effect
023 *
024 * @author The TridentSDK Team
025 * @since 0.4-alpha
026 */
027public interface VisualEffect extends RemoteEffect<VisualEffectType> {
028    /**
029     * Set the data of the effect<br>
030     * Only used for FIRE_SMOKE, BLOCK_BREAK and SPLASH_POTION<br>
031     * <br>
032     * FIRE_SMOKE requires direction of the smoke<br>
033     * 0 = South-East, 1 = South, 2 = South-West, 3 = East,<br>
034     * 4 = Up/Middle, 5 = West, 6 = North-East, 7 = North, 8 = North-West<br>
035     * <br>
036     * BLOCK_BREAK requires block ID<br>
037     * <br>
038     * SPLASH_POTION requires potion ID (refer to <a href="http://tridentsdk.net/potions.txt">This List</a>)
039     *
040     * @param data Data of the effect
041     */
042    void setData(int data);
043
044    /**
045     * Returns the data of the effect
046     *
047     * @return The data of the effect
048     */
049    int data();
050}