/*
 * Date: 12/14/2005
 * Time: 12:30 AM
 * 
 * Copyright 2005, Static Boy Productions
 */

using System;
using System.Drawing;

namespace Jessie
{
	/// <summary>
	/// A poll for all logics' VoteForActions are taken at the start of every turn that's available. The vote for the action with the heaviest weighting will "win" and steps will be taken to accomplish that goal.
	/// </summary>
	public class jtbvActionVote : IComparable
	{
		public string ActionName;
		public Point Location;
		public int Weight;
		public object[] Args;
		
		/// <summary>
		/// Creates a new jtbvActionVote with the parameters specified
		/// </summary>
		/// <param name="newActionName">The name of the action to run. This corresponds to the title of the action in the "Actions" scripts collection.</param>
		/// <param name="newLocation">The location that the action should take place at. Note that this can be null if the action can take place anywhere.</param>
		/// <param name="newWeight">The weight that this vote should have. It's an integer without much scale -- the scale is determined by the logic programmer. Generally, something like 0 - 100 is a good idea.</param>
		/// <param name="args">These are extra variables that may need to be passed into the action when it's performed (such as, the character handle of an item to dip into a fountain)</param>
		public jtbvActionVote(string newActionName, Point newLocation, int newWeight, params object[] newArgs)
		{
			ActionName = newActionName;
			Location = newLocation;
			Weight = newWeight;
			Args = newArgs;
		}
		
		public int CompareTo(object obj)
		{
			jtbvActionVote vote = obj as jtbvActionVote;
			
			if (vote != null)
			{
				return (this.Weight - vote.Weight);
			}
			
			return (-1);
		}
	}
}