/*
 * Copyright (c) 2017, Adam <Adam@sigterm.info>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package net.runelite.api;

import javax.annotation.Nullable;
import net.runelite.api.coords.LocalPoint;

/**
 * Represents a projectile entity. (ie. cannonball, arrow)
 */
public interface Projectile extends Renderable
{
	/**
	 * Gets the ID of the projectile.
	 *
	 * @return the projectile ID
	 * @see GraphicID
	 */
	int getId();

	/**
	 * Gets the actor that is targeted by this projectile.
	 *
	 * @return the target actor, or null if this projectile is an AoE attack
	 */
	Actor getInteracting();

	/**
	 * Get the target point of the projectile. For projectiles with an actor target,
	 * this is updated each frame to the actor position.
	 *
	 * @return
	 */
	LocalPoint getTarget();

	/**
	 * Gets the original x-axis coordinate that this projectile started from.
	 *
	 * @return the original coordinate
	 */
	int getX1();

	/**
	 * Gets the original y-axis coordinate that this projectile started from.
	 *
	 * @return the original coordinate
	 */
	int getY1();

	/**
	 * Gets the plane that the projectile is on.
	 *
	 * @return the plane
	 */
	int getFloor();

	/**
	 * Gets the height of the projectile.
	 *
	 * @return the height
	 */
	int getHeight();

	/**
	 * Gets the ending height of the projectile.
	 *
	 * @return the ending height
	 */
	int getEndHeight();

	/**
	 * Gets the game cycle that the projectile begun movement at.
	 *
	 * @return the start game cycle
	 */
	int getStartCycle();

	/**
	 * Gets the game cycle that the projectile will reach its target at.
	 *
	 * @return the end game cycle
	 */
	int getEndCycle();

	/**
	 * Sets the game cycle the projectile will reach its target at. The
	 * projectile automatically despawns after this time, and setting the
	 * end cycle to a time in the past is an effective way of removing the
	 * projectile.
	 * @param cycle
	 */
	void setEndCycle(int cycle);

	/**
	 * Gets the remaining game cycles until the projectile reaches its
	 * target and despawns.
	 *
	 * @return the remaining game cycles
	 */
	int getRemainingCycles();

	/**
	 * Gets the slope of the projectile.
	 * <p>
	 * This value indicates how much arc the projectile can have. Projectiles
	 * with larger slopes have a more noticeable arc when thrown.
	 *
	 * @return the slope of the projectile
	 */
	int getSlope();

	/**
	 * Gets the starting height of the projectile.
	 *
	 * @return the starting height
	 */
	int getStartHeight();

	/**
	 * Gets the current x-axis coordinate of the projectile.
	 *
	 * @return the x-axis coordinate
	 */
	double getX();

	/**
	 * Gets the current y-axis coordinate of the projectile.
	 *
	 * @return the y-axis coordinate
	 */
	double getY();

	/**
	 * Gets the current z-axis coordinate of the projectile.
	 *
	 * @return the z-axis coordinate
	 */
	double getZ();

	/**
	 * Gets the scalar quantity (speed) at which the projectile is travelling.
	 *
	 * @return the scalar quantity
	 */
	double getScalar();

	/**
	 * Gets the x-axis velocity of the projectile.
	 *
	 * @return the x-axis velocity
	 */
	double getVelocityX();

	/**
	 * Gets the y-axis velocity of the projectile.
	 *
	 * @return the y-axis velocity
	 */
	double getVelocityY();

	/**
	 * Gets the z-axis velocity of the projectile.
	 *
	 * @return the z-axis velocity
	 */
	double getVelocityZ();

	/**
	 * The animation of the projectile
	 * @return
	 */
	@Nullable
	Animation getAnimation();

	/**
	 * The frame of the current animation
	 * @return
	 */
	int getAnimationFrame();
}
