/*
 * Copyright (C) 2009  Manish Pandya, [manish at meetamanish dot com]
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
 * 
 */
package org.hooliguns.ninja.telnet;


/**
 * Interface that reports instantanious position and status of the Ninja unit.
 * 
 * @author Manish Pandya
 *
 */
public interface RealtimeStateReporter {
	/**
	 * Returns current X position.
	 * @return current X position
	 */
	public int getCurrentX();

	/**
	 * Returns current Y position.
	 * @return current Y position
	 */
	public int getCurrentY();

  /**
   * Returns current X velocity.
   * @return current X velocity
   */
  public int getVelocityX();

  /**
   * Returns current Y velocity.
   * @return current Y velocity
   */
  public int getVelocityY();

	/**
	 * Returns whether unit is in motion.
	 * @return true if in motion, false otherwise
	 */
	public boolean isInMotion();
}